CampusAPI Ontology Services API documentation version 1.0.5
Based on OSID version 3.0.0

Query Parameters

• offset: (integer - default: 0)

  Skip over a number of elements by specifying an offset value for the query

  Example:

  20

• limit: (integer - default: 10)

  Limit the number of elements on the response

  Example:

  80

• expand: (string)

  Expand object or type for named attribute: "genusType", "recordType", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

• genusTypeId: (string)

  The id string to match a genusType

  Example:

  type.Type%3AexampleSubjectType%40dxtera.org

• parentGenusTypeId: (string)

  The id string to match a parent genusType

  Example:

  type.Type%3AparentTypeExampleSubjectType%40dxtera.org

• recordTypeId: (string)

  The id string to match a recordType

  Example:

  type.Type%3AexampleSubjectType%40campusapi.org

• ontologyId: (string)

  The id string to match a ontology

  Example:

  ontology.Ontology%3A8374%40base.url

Query Parameters

• genusType: (string)

  specify a particular subject type to create

  Example:

  type.Type%3AexampleSubjectType%40dxtera.org

• recordType: (array of )

  specify support for one or more subject record types

  Example:

  [
    "type.Type%3AexampleSubjectRecordType%40campusapi.org",
    "..."
  ]

• ontologyId: (string)

  specify in which ontology to create this subject

  Example:

  ontology.Ontology%3A8374%40base.url

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Subject",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this subject, provided by system.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this subject, provided by system.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this subject for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this subject.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this subject. Default type set by system unless specified in query parameter.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "recordTypeIds": {
      "description": "Type Ids of record types available on this subject. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      },
      "readOnly": true
    }
  }
}

Example:

{
  "displayName": "Display Name of this Subject",
  "description": "The description of this Subject"
}

Query Parameters

• offset: (integer - default: 0)

  Skip over a number of elements by specifying an offset value for the query

  Example:

  20

• limit: (integer - default: 10)

  Limit the number of elements on the response

  Example:

  80

• expand: (string)

  Expand object or type for named attribute: "genusType", "recordType", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "SubjectQuery",
  "type": "object",
  "properties": {
    "matchIds": {
      "description": "List of Ids to match. Boolean OR performed among multiple Ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchKeywords": {
      "description": "List keywords to match. Multiple keywords can be added to perform a boolean OR among them. A keyword may be applied to any of the elements defined in this object such as the display name, description or any attribute defined in or implemented by this object.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "keyword": {
            "description": "keyword to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchDisplayNames": {
      "description": "List of displayName strings to match. Boolean OR performed among multiple displayNames.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "displayName": {
            "description": "displayName to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchDescriptions": {
      "description": "List of discription strings to match. Boolean OR performed among multiple descriptions.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "description": {
            "description": "description to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchGenusTypeIds": {
      "description": "List of genus type ids to match. Boolean OR performed among multiple ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "genusTypeid": {
            "description": "genus type id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchRecordTypeIds": {
      "description": "List of record type ids to match. Boolean OR performed among multiple ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "genusTypeid": {
            "description": "record type id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchOntologyIds": {
      "description": "List of Ontology Id's to match.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "ontologyId": {
            "description": "Ontology id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "ontologyQueries": {
      "description": "OntologyQueries to match Ontology. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    }
  }
}

Example:

{
  "matchDisplayNames": [
    {
      "displayName": "string to exclude",
      "match": false
    }
  ]
}

Query Parameters

• genusType: (string)

  specify a particular subject type to create

  Example:

  type.Type%3AexampleSubjectType%40dxtera.org

• recordType: (array of )

  specify support for one or more subject record types

  Example:

  [
    "type.Type%3AexampleSubjectRecordType%40campusapi.org",
    "..."
  ]

• ontologyId: (string)

  specify in which ontology to create this subject

  Example:

  ontology.Ontology%3A8374%40base.url

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

[
  {
    "id": "ontology.Subject:64@base.url",
    "uri": "http://base.url/open/campusapi/ontology/subject/ontology.Subject%3A64%40base.url",
    "displayName": "Display Name of this Subject",
    "description": "The description of this Subject",
    "genusTypeId": "type.Type:defaultSubjectType@base.url",
    "recordTypeIds": [ "type.Type:exampleSubjectRecordType@campusapi.org", "..."]
  },
  {
    "...": "..."
  }
]

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

URI Parameters

• subjectId: required(string)

URI Parameters

• subjectId: required(string)

URI Parameters

• subjectId: required(string)

URI Parameters

• subjectId: required(string)

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Subject",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this subject, provided by system.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this subject, provided by system.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this subject for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this subject.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this subject. Default type set by system unless specified in query parameter.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "recordTypeIds": {
      "description": "Type Ids of record types available on this subject. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      },
      "readOnly": true
    }
  }
}

Example:

{
  "displayName": "Display Name of this Subject",
  "description": "The description of this Subject"
}

URI Parameters

• subjectId: required(string)

URI Parameters

• subjectId: required(string)

URI Parameters

• subjectId: required(string)

URI Parameters

• subjectId: required(string)
• childId: required(string)

URI Parameters

• subjectId: required(string)
• childId: required(string)

URI Parameters

• subjectId: required(string)

Query Parameters

• offset: (integer - default: 0)

  Skip over a number of elements by specifying an offset value for the query

  Example:

  20

• limit: (integer - default: 10)

  Limit the number of elements on the response

  Example:

  80

• expand: (string)

  Expand object or type for named attribute: "genusType", "recordType", "endReason", "subject", "mapped", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

• genusTypeId: (string)

  The id string to match a genusType

  Example:

  type.Type%3AexampleRelevancyType%40dxtera.org

• parentGenusTypeId: (string)

  The id string to match a parent genusType

  Example:

  type.Type%3AparentTypeExampleRelevancyType%40dxtera.org

• recordTypeId: (string)

  The id string to match a recordType

  Example:

  type.Type%3AexampleRelevancyType%40campusapi.org

• fromDate: (string)

  Get all relevancies from this date inclusive. Use with toDate to define date range query.

  Example:

  2020-10-03

• toDate: (string)

  Get all relevancies up to this date inclusive. Use with fromDate to define date range query.

  Example:

  2020-12-18

• subjectId: (string)

  the id string to match a subject.

  Example:

  ontology.Subject%3A504%40base.url

• mappedId: (string)

  the id string to match a mapped.

  Example:

  resource.Resource%3A432%40base.url

• ontologyId: (string)

  The id string to match a ontology

  Example:

  ontology.Ontology%3A8374%40base.url

Query Parameters

• subjectId: required(string)

  the subject of this relevancy.

  Example:

  ontology.Subject%3A504%40base.url

• mappedId: required(string)

  the mapped of this relevancy.

  Example:

  resource.Resource%3A432%40base.url

• genusType: (string)

  specify a particular relevancy type to create

  Example:

  type.Type%3AexampleRelevancyType%40dxtera.org

• recordType: (array of )

  specify support for one or more relevancy record types

  Example:

  [
    "type.Type%3AexampleRelevancyRecordType%40campusapi.org",
    "..."
  ]

• ontologyId: (string)

  specify in which ontology to create this relevancy

  Example:

  ontology.Ontology%3A8374%40base.url

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Relevancy",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this relevancy, provided by system.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this relevancy, provided by system.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this relevancy for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this relevancy.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this relevancy. Default type set by system unless specified in query parameter.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "recordTypeIds": {
      "description": "Type Ids of record types available on this relevancy. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      },
      "readOnly": true
    },
    "startDate": {
      "description": "The starting date of this relevancy.",
      "type": "string",
      "format": "date-time"
    },
    "endDate": {
      "description": "The ending date of this relevancy.",
      "type": "string",
      "format": "date-time"
    },
    "endReasonId": {
      "description": "The reason this relevancy ended.",
      "type": "string",
      "format": "osid-id"
    },
    "subjectId": {
      "description": "The subject associated with this relevancy.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "mappedId": {
      "description": "The mapped associated with this relevancy.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    }
  }
}

Example:

{
  "displayName": "Display Name of this Relevancy",
  "description": "The description of this Relevancy",
  "startDate": "2020-10-03T06:30:00.000Z",
  "endDate": "2020-12-18T19:30:00.000Z",
  "endReasonId": "process.State:2791@base.url"
}

Query Parameters

• offset: (integer - default: 0)

  Skip over a number of elements by specifying an offset value for the query

  Example:

  20

• limit: (integer - default: 10)

  Limit the number of elements on the response

  Example:

  80

• expand: (string)

  Expand object or type for named attribute: "genusType", "recordType", "endReason", "subject", "mapped", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "RelevancyQuery",
  "type": "object",
  "properties": {
    "matchIds": {
      "description": "List of Ids to match. Boolean OR performed among multiple Ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchKeywords": {
      "description": "List keywords to match. Multiple keywords can be added to perform a boolean OR among them. A keyword may be applied to any of the elements defined in this object such as the display name, description or any attribute defined in or implemented by this object.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "keyword": {
            "description": "keyword to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchDisplayNames": {
      "description": "List of displayName strings to match. Boolean OR performed among multiple displayNames.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "displayName": {
            "description": "displayName to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchDescriptions": {
      "description": "List of discription strings to match. Boolean OR performed among multiple descriptions.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "description": {
            "description": "description to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchGenusTypeIds": {
      "description": "List of genus type ids to match. Boolean OR performed among multiple ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "genusTypeid": {
            "description": "genus type id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchRecordTypeIds": {
      "description": "List of record type ids to match. Boolean OR performed among multiple ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "genusTypeid": {
            "description": "record type id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchEffective": {
      "description": "Match effective objects where the current date falls within the start and end dates inclusive. true to match any effective, false to match ineffective",
      "type": "boolean"
    },
    "matchStartDate": {
      "description": "Matches temporals whose start date falls in between the given dates inclusive.",
      "type": "object",
      "properties": {
        "start": {
          "description": "start of date range",
          "type": "string",
          "format": "date-time"
        },
        "end": {
          "description": "end of date range",
          "type": "string",
          "format": "date-time"
        },
        "match": {
          "description": "true if a positive match, false for negative match",
          "type": "boolean"
        }
      }
    },
    "matchEndDate": {
      "description": "Matches temporals whose end date falls in between the given dates inclusive.",
      "type": "object",
      "properties": {
        "start": {
          "description": "start of date range",
          "type": "string",
          "format": "date-time"
        },
        "end": {
          "description": "end of date range",
          "type": "string",
          "format": "date-time"
        },
        "match": {
          "description": "true if a positive match, false for negative match",
          "type": "boolean"
        }
      }
    },
    "matchEndReasonIds": {
      "description": "List of end reason Id's to match.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "stateId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "endReasonQueries": {
      "description": "process.StateQueries to match end reason state. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "matchAnyEndReason": {
      "description": "Match end reasons with any value. true to match Relevancies with any end reason, false to match Relevancies with no end reason",
      "type": "boolean"
    },
    "matchSubjectIds": {
      "description": "List of subject Ids for this query to match relevancy that have a related subject.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "ruleId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "subjectQueries": {
      "description": "SubjectQueries to match the subject. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "matchMappedIds": {
      "description": "List of mapped Ids for this query to match relevancy that have a related mapped.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "ruleId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "mappedQueries": {
      "description": "MappedQueries to match the mapped. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "matchOntologyIds": {
      "description": "List of Ontology Id's to match.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "ontologyId": {
            "description": "Ontology id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "ontologyQueries": {
      "description": "OntologyQueries to match Ontology. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    }
  }
}

Example:

{
  "matchDisplayNames": [
    {
      "displayName": "string to exclude",
      "match": false
    }
  ]
}

Query Parameters

• subjectId: required(string)

  the subject of this metadatum.

  Example:

  ontology.Subject%3A504%40base.url

• mappedId: required(string)

  the mapped of this metadatum.

  Example:

  resource.Resource%3A432%40base.url

• genusType: (string)

  specify a particular relevancy type to create

  Example:

  type.Type%3AexampleRelevancyType%40dxtera.org

• recordType: (array of )

  specify support for one or more relevancy record types

  Example:

  [
    "type.Type%3AexampleRelevancyRecordType%40campusapi.org",
    "..."
  ]

• ontologyId: (string)

  specify in which ontology to create this relevancy

  Example:

  ontology.Ontology%3A8374%40base.url

URI Parameters

• relevancyId: required(string)

Query Parameters

• expand: (string)

  Expand object or type for named attribute: "genusType", "recordType", "endReason", "subject", "mapped", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

URI Parameters

• relevancyId: required(string)

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Relevancy",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this relevancy, provided by system.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this relevancy, provided by system.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this relevancy for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this relevancy.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this relevancy. Default type set by system unless specified in query parameter.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "recordTypeIds": {
      "description": "Type Ids of record types available on this relevancy. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      },
      "readOnly": true
    },
    "startDate": {
      "description": "The starting date of this relevancy.",
      "type": "string",
      "format": "date-time"
    },
    "endDate": {
      "description": "The ending date of this relevancy.",
      "type": "string",
      "format": "date-time"
    },
    "endReasonId": {
      "description": "The reason this relevancy ended.",
      "type": "string",
      "format": "osid-id"
    },
    "subjectId": {
      "description": "The subject associated with this relevancy.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "mappedId": {
      "description": "The mapped associated with this relevancy.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    }
  }
}

Example:

{
  "displayName": "Display Name of this Relevancy",
  "description": "The description of this Relevancy",
  "startDate": "2020-10-03T06:30:00.000Z",
  "endDate": "2020-12-18T19:30:00.000Z",
  "endReasonId": "process.State:2791@base.url"
}

URI Parameters

• relevancyId: required(string)

URI Parameters

• relevancyId: required(string)

Query Parameters

• offset: (integer - default: 0)

  Skip over a number of elements by specifying an offset value for the query

  Example:

  20

• limit: (integer - default: 10)

  Limit the number of elements on the response

  Example:

  80

• expand: (string)

  Expand object or type for named attribute: "genusType", "recordType", "provider", "branding", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

• genusTypeId: (string)

  The id string to match a genusType

  Example:

  type.Type%3AexampleOntologyType%40dxtera.org

• parentGenusTypeId: (string)

  The id string to match a parent genusType

  Example:

  type.Type%3AparentTypeExampleOntologyType%40dxtera.org

• recordTypeId: (string)

  The id string to match a recordType

  Example:

  type.Type%3AexampleOntologyType%40campusapi.org

• providerId: (string)

  Id string to match provider.

  Example:

  resource.Resource%3A3007%40demo.dxtera.org

• subjectId: (string)

  Get ontologies mapped to this subject.

  Example:

  ontology.Subject%3A448%40demo.dxtera.org

• relevancyId: (string)

  Get ontologies mapped to this relevancy.

  Example:

  ontology.Relevancy%3A576%40demo.dxtera.org

Query Parameters

• genusType: (string)

  specify a particular ontology type to create

  Example:

  type.Type%3AexampleOntologyType%40dxtera.org

• recordType: (array of )

  specify support for one or more ontology record types

  Example:

  [
    "type.Type%3AexampleOntologyRecordType%40campusapi.org",
    "..."
  ]

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Ontology",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this ontology, provided by system.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this ontology, provided by system.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this ontology for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this ontology.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this ontology. Default type set by system unless specified in query parameter.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "recordTypeIds": {
      "description": "Type Ids of record types available on this ontology. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      },
      "readOnly": true
    },
    "providerId": {
      "description": "The provider of this ontology.",
      "type": "string",
      "format": "osid-id"
    },
    "brandingIds": {
      "description": "The branding of this ontology. A collection of Assets.",
      "type": "array",
      "items" : {
        "type": "string",
        "format": "osid-id"
      }
    },
    "license": {
      "description": "The licensing that applies to this ontology.",
      "type": "string"
    }
  }
}

Example:

{
  "displayName": "Display Name of this Ontology",
  "description": "The description of this Ontology",
  "providerId": "resource.Resource:123@base.url",
  "brandingId": "asset.Asset:Ontology@base.url",
  "license": "The license that applies to this Ontology"
}

Query Parameters

• offset: (integer - default: 0)

  Skip over a number of elements by specifying an offset value for the query

  Example:

  20

• limit: (integer - default: 10)

  Limit the number of elements on the response

  Example:

  80

• expand: (string)

  Expand object or type for named attribute: "genusType", "recordType", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "OntologyQuery",
  "type": "object",
  "properties": {
    "matchIds": {
      "description": "List of Ids to match. Boolean OR performed among multiple Ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchKeywords": {
      "description": "List keywords to match. Multiple keywords can be added to perform a boolean OR among them. A keyword may be applied to any of the elements defined in this object such as the display name, description or any attribute defined in or implemented by this object.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "keyword": {
            "description": "keyword to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchDisplayNames": {
      "description": "List of displayName strings to match. Boolean OR performed among multiple displayNames.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "displayName": {
            "description": "displayName to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchDescriptions": {
      "description": "List of discription strings to match. Boolean OR performed among multiple descriptions.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "description": {
            "description": "description to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchGenusTypeIds": {
      "description": "List of genus type ids to match. Boolean OR performed among multiple ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "genusTypeid": {
            "description": "genus type id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchRecordTypeIds": {
      "description": "List of record type ids to match. Boolean OR performed among multiple ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "genusTypeid": {
            "description": "record type id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchProviderIds": {
      "description": "List of provider Ids to match.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "stateId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "providerQueries": {
      "description": "resource.ResourceQuery for provider. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
    },
    "matchAnyProvider": {
      "description": "Match providers with any value. true to match Ontology with any provider, false to match Ontology with no provider",
      "type": "boolean"
      }
    },
    "matchBrandingIds": {
      "description": "List of branding asset Ids to match.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "stateId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "brandingQueries": {
      "description": "repository.AssetQuery for branding. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "matchAnyBranding": {
      "description": "Match brandingss with any value. true to match Ontology with any branding, false to match Ontology with no branding",
      "type": "boolean"
    },
    "matchlicenses": {
      "description": "List of license strings to match. Boolean OR performed among multiple descriptions.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "license": {
            "description": "license to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchOntologyIds": {
      "description": "List of Ontology Id's to match.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "ontologyId": {
            "description": "Ontology id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "ontologyQueries": {
      "description": "OntologyQueries to match Ontology. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    }
  }
}

Example:

{
  "matchDisplayNames": [
    {
      "displayName": "string to exclude",
      "match": false
    }
  ]
}

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{
  "$schema": "http://json-schema.org/draft/2019-9/schema#",
  "title": "Ontology",
  "type": "object",
  "required": ["displayName"],
  "properties": {
    "id": {
      "description": "The unique id of this ontology, provided by system.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this ontology, provided by system.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this ontology for display.",
      "type": "string",
      "read-only": false,
      "minLength": 1,
      "maxLength": 128,
      "pattern": "",
      "default": "",
      "enum": [],
      "elementId": "Ontology.Ontology:displayName@base.url",
      "existingValue": "The Existing Name",
      "elementLabel": "Name",
      "instructions": "Enter a name for this ontology",
      "linked": false
    },
    "description": {
      "description": "The description of this ontology.",
      "type": "string",
      "read-only": false,
      "minLength": 0,
      "maxLength": 128,
      "pattern": "",
      "default": "",
      "enum": [],
      "elementId": "Ontology.Ontology:displayName@demo.base.url",
      "existingValue": "The Existing Description",
      "elementLabel": "Description",
      "instructions": "Enter a description for this ontology",
      "linked": false
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this ontology. Default type set by system unless specified in query parameter on initial post.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "recordTypeIds": {
      "description": "Type Ids of record types available on this ontology. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      },
      "readOnly": true
    },
    "providerId": {
      "description": "The provider of this ontology.",
      "type": "string",
      "format": "osid-id",
      "read-only": false,
      "pattern": "",
      "default": "",
      "enum": [],
      "elementId": "Ontology.Ontology:provider@base.url",
      "existingValue": "",
      "elementLabel": "Provider",
      "instructions": "Enter the provider of this ontology",
      "linked": false
    },
    "brandingIds": {
      "description": "The branding of this ontology. A list of Assets.",
      "type": "array",
      "items" : {
        "type": "string",
        "format": "osid-id",
        "pattern": "",
        "enum": []
      },
      "read-only": false,
      "default": [],
      "elementId": "Ontology.Ontology:branding@base.url",
      "existingValue": "",
      "elementLabel": "Branding",
      "instructions": "Enter the branding images for this ontology",
      "linked": false
    },
    "license": {
      "description": "The licensing that applies to this ontology.",
      "type": "string",
      "read-only": false,
      "minLength": 0,
      "maxLength": 128,
      "pattern": "",
      "default": "",
      "enum": [],
      "elementId": "Ontology.Ontology:license@base.url",
      "existingValue": "The Existing License",
      "elementLabel": "License",
      "instructions": "Include a license for this ontology",
      "linked": false
    }
  }
}

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

[
  {
    "id": "ontology.Ontology:58@base.url",
    "uri": "http://base.url/open/campusapi/ontology/ontology/ontology.Ontology%3A58%40base.url",
    "displayName": "Display Name of this Ontology",
    "description": "The description of this Ontology",
    "genusTypeId": "type.Type:defaultOntologyType@base.url",
    "recordTypeIds": [ "type.Type:exampleOntologyRecordType@campusapi.org", "..."],
    "providerId": "resource.Resource:123@base.url",
    "brandingId": "asset.Asset:Ontology@base.url",
    "license": "The license that applies to this Ontology"
  },
  {
    "...": "..."
  }
]

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

URI Parameters

• ontologyId: required(string)

URI Parameters

• ontologyId: required(string)

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Ontology",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this ontology, provided by system.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this ontology, provided by system.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this ontology for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this ontology.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this ontology. Default type set by system unless specified in query parameter.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "recordTypeIds": {
      "description": "Type Ids of record types available on this ontology. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      },
      "readOnly": true
    },
    "providerId": {
      "description": "The provider of this ontology.",
      "type": "string",
      "format": "osid-id"
    },
    "brandingIds": {
      "description": "The branding of this ontology. A collection of Assets.",
      "type": "array",
      "items" : {
        "type": "string",
        "format": "osid-id"
      }
    },
    "license": {
      "description": "The licensing that applies to this ontology.",
      "type": "string"
    }
  }
}

Example:

{
  "displayName": "Display Name of this Ontology",
  "description": "The description of this Ontology",
  "providerId": "resource.Resource:123@base.url",
  "brandingId": "asset.Asset:Ontology@base.url",
  "license": "The license that applies to this Ontology"
}

URI Parameters

• ontologyId: required(string)

URI Parameters

• ontologyId: required(string)

URI Parameters

• ontologyId: required(string)

URI Parameters

• ontologyId: required(string)
• childId: required(string)

URI Parameters

• ontologyId: required(string)
• childId: required(string)

URI Parameters

• ontologyId: required(string)

URI Parameters

• ontologyId: required(string)

Query Parameters

• offset: (integer - default: 0)

  Skip over a number of elements by specifying an offset value for the query

  Example:

  20

• limit: (integer - default: 10)

  Limit the number of elements on the response

  Example:

  80

• expand: (string)

  Expand object or type for named attribute: "genusType", "recordType", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

• genusTypeId: (string)

  The id string to match a genusType

  Example:

  type.Type%3AexampleSubjectType%40dxtera.org

• parentGenusTypeId: (string)

  The id string to match a parent genusType

  Example:

  type.Type%3AparentTypeExampleSubjectType%40dxtera.org

• recordTypeId: (string)

  The id string to match a recordType

  Example:

  type.Type%3AexampleSubjectType%40campusapi.org

URI Parameters

• ontologyId: required(string)
• subjectId: required(string)

URI Parameters

• ontologyId: required(string)
• subjectId: required(string)

URI Parameters

• ontologyId: required(string)

Query Parameters

• offset: (integer - default: 0)

  Skip over a number of elements by specifying an offset value for the query

  Example:

  20

• limit: (integer - default: 10)

  Limit the number of elements on the response

  Example:

  80

• expand: (string)

  Expand object or type for named attribute: "genusType", "recordType", "endReason", "subject", "mapped", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

• genusTypeId: (string)

  The id string to match a genusType

  Example:

  type.Type%3AexampleRelevancyType%40dxtera.org

• parentGenusTypeId: (string)

  The id string to match a parent genusType

  Example:

  type.Type%3AparentTypeExampleRelevancyType%40dxtera.org

• recordTypeId: (string)

  The id string to match a recordType

  Example:

  type.Type%3AexampleRelevancyType%40campusapi.org

URI Parameters

• ontologyId: required(string)
• relevancyId: required(string)

URI Parameters

• ontologyId: required(string)
• relevancyId: required(string)