CampusAPI Ontology Services API documentation version 1.0.2
Based on OSID version 3.0.0
https://base.url/ontology
Overview
The Ontology package defines auxiliary services used to manage subject matter that can be related to other entities. Ontologies are an alternative to tagging where structure, restricted vocabulary, or localization of topic names are desired.
This package includes the following entities:
Subjects
Subjects are used to represent a topic and can be organized in a hierarchy to form an ontology.
| Field | Description | Type |
|---|---|---|
| id(read‑only) | The unique id of this subject, provided by system. | string(osid‑id) |
| uri(read‑only) | The uri of this subject, provided by system. | string(uri) |
| displayName | The name of this subject for display. | string |
| description | The description of this subject. | string |
| genusTypeId (read‑only) | Id of the immutable type of this subject. Default type set by system unless specified in query parameter. | string(osid‑id) |
| recordTypeIds (read‑only) | 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. | string(osid‑id)[] |
Relevancies
Subjects are related to other things through a Relevancy. A Relevancy is simply a relationship between a Subject and any other entity.
| Field | Description | Type |
|---|---|---|
| id(read‑only) | The unique id of this relevancy, provided by system. | string(osid‑id) |
| uri(read‑only) | The uri of this relevancy, provided by system. | string(uri) |
| displayName | The name of this relevancy for display. | string |
| description | The description of this relevancy. | string |
| genusTypeId (read‑only) | Id of the immutable type of this relevancy. Default type set by system unless specified in query parameter. | string(osid‑id) |
| recordTypeIds (read‑only) | 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. | string(osid‑id)[] |
| startDate | The starting date of this relevancy. | string(date‑time) |
| endDate | The ending date of this relevancy. | string(date‑time) |
| endReasonId | The reason this relevancy ended. References a process.State object. | string(osid‑id) |
| subjectId (read‑only) | The subject associated with this relevancy. References an ontology.Subject object. | string(osid‑id) |
| mappedId (read‑only) | The mapped associated with this relevancy. References an id.Id object. | string(osid‑id) |
Ontologies
Subjects and Relevancies are organized into Ontology catalogs.
An external id may be mapped to an Ontology. This mapping allows catalogs to relate to a specific and sharable Ontology to constrain a set of Subjects that may be relevant to a collection of external objects.
| Field | Description | Type |
|---|---|---|
| id(read‑only) | The unique id of this ontology, provided by system. | string(osid‑id) |
| uri(read‑only) | The uri of this ontology, provided by system. | string(uri) |
| displayName | The name of this ontology for display. | string |
| description | The description of this ontology. | string |
| genusTypeId (read‑only) | Id of the immutable type of this ontology. Default type set by system unless specified in query parameter. | string(osid‑id) |
| recordTypeIds (read‑only) | 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. | string(osid‑id)[] |
| providerId | The provider of this ontology. References a resource.Resource object. | string(osid‑id) |
| brandingIds | The branding of this ontology. References repository.Asset objects. | string(osid‑id)[] |
| license | The licensing that applies to this ontology. | string |
License
CampusAPI REST Documentation Copyright 2020 DXtera Institute. Based on the Open Service Interface Defitions: http://osid.org
/subjects
Collection of subjects in a system, federation of systems, or in a default ontology.
Get all subjects in the system or default ontology.
Create a new subject in the default ontology.
get /subjects
Get all subjects in the system or default 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 - 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
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
[
{
"id": "ontology.Subject:2166@base.url",
"uri": "http://base.url/open/campusapi/ontology/subject/ontology.Subject%3A2166%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" }
post /subjects
Create a new subject in the default ontology.
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"
}
Entity representing a subject form metadata.
Get form metadata for creating a new subject.
get /subjects/metadata
Get form metadata for creating a new subject.
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:
{
"$schema": "http://json-schema.org/draft/2019-9/schema#",
"title": "Subject",
"type": "object",
"required": ["displayName"],
"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",
"read-only": false,
"minLength": 1,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Subject.Subject:displayName@base.url",
"existingValue": "The Existing Name",
"elementLabel": "Name",
"instructions": "Enter a name for this subject",
"linked": false
},
"description": {
"description": "The description of this subject.",
"type": "string",
"read-only": false,
"minLength": 0,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Subject.Subject:displayName@demo.base.url",
"existingValue": "The Existing Description",
"elementLabel": "Description",
"instructions": "Enter a description for this subject",
"linked": false
},
"genusTypeId": {
"description": "Id of the immutable type of this subject. 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 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
}
}
}
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
The root subjects in the subject hierarchy. A node with no parents is an orphan. While all subject Ids are known to the hierarchy, an orphan does not appear in the hierarchy unless explicitly added as a root node or child of another node.
Get all root root-subjects
get /subjects/root-subjects
Get all root root-subjects
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
[
{
"id": "ontology.Subject:2166@base.url",
"uri": "http://base.url/open/campusapi/ontology/subject/ontology.Subject%3A2166%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" }
Add the given subject as a root in the subject hierarchy
Remove the given subject as a root in the subject hierarchy.
put /subjects/root-subjects/{subjectId}
Add the given subject as a root in the subject hierarchy
URI Parameters
- subjectId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "The subject has been added as a root" }
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{ "message": "subject not found" }
delete /subjects/root-subjects/{subjectId}
Remove the given subject as a root in the subject hierarchy.
URI Parameters
- subjectId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "The subject has been removed as a root from the hierarchy" }
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{ "message": "subject not found" }
Entity representing a subject
Get a subject given its id.
Update a given subject.
Delete a given subject.
get /subjects/{subjectId}
Get a subject given its id.
URI Parameters
- subjectId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"id": "ontology.Subject:2166@base.url",
"uri": "http://base.url/open/campusapi/ontology/subject/ontology.Subject%3A2166%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" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{"message": "subject not found" }
put /subjects/{subjectId}
Update a given subject.
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"
}
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "The subject has been updated" }
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{"message": "subject not found" }
delete /subjects/{subjectId}
Delete a given subject.
URI Parameters
- subjectId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "The subject has been deleted" }
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{"message": "subject not found" }
Entity representing a subject form metadata for update
Get form metadata for updating an existing subject.
get /subjects/{subjectId}/metadata
Get form metadata for updating an existing subject.
URI Parameters
- subjectId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"$schema": "http://json-schema.org/draft/2019-9/schema#",
"title": "Subject",
"type": "object",
"required": ["displayName"],
"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",
"read-only": false,
"minLength": 1,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Subject.Subject:displayName@base.url",
"existingValue": "The Existing Name",
"elementLabel": "Name",
"instructions": "Enter a name for this subject",
"linked": false
},
"description": {
"description": "The description of this subject.",
"type": "string",
"read-only": false,
"minLength": 0,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Subject.Subject:displayName@demo.base.url",
"existingValue": "The Existing Description",
"elementLabel": "Description",
"instructions": "Enter a description for this subject",
"linked": false
},
"genusTypeId": {
"description": "Id of the immutable type of this subject. 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 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
}
}
}
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{"message": "subject not found" }
Get child subjects for the given subject in the hierarchy.
get /subjects/{subjectId}/children
Get child subjects for the given subject in the hierarchy.
URI Parameters
- subjectId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
[
{
"id": "ontology.Subject:2166@base.url",
"uri": "http://base.url/open/campusapi/ontology/subject/ontology.Subject%3A2166%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" }
Add subject as child of the given subject in the hierarchy.
Remove the given subject as a child of the given subject in the hierarchy.
put /subjects/{subjectId}/children/{childId}
Add subject as child of the given subject in the hierarchy.
URI Parameters
- subjectId: required(string)
- childId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "The child subject has been added to the hierarchy" }
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{ "message": "subject not found" }
delete /subjects/{subjectId}/children/{childId}
Remove the given subject as a child of the given subject in the hierarchy.
URI Parameters
- subjectId: required(string)
- childId: required(string)
Get parent subjects for the given subject in the hierarchy.
get /subjects/{subjectId}/parents
Get parent subjects for the given subject in the hierarchy.
URI Parameters
- subjectId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
[
{
"id": "ontology.Subject:2166@base.url",
"uri": "http://base.url/open/campusapi/ontology/subject/ontology.Subject%3A2166%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" }
/relevancies
Collection of relevancies in a system, federation of systems, or in a default ontology.
Get all relevancies in the system or default ontology.
Create a new relevancy in the default ontology.
get /relevancies
Get all relevancies in the system or default 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 - 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
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
[
{
"id": "ontology.Relevancy:9642@base.url",
"uri": "http://base.url/open/campusapi/ontology/relevancy/ontology.Relevancy%3A9642%40base.url",
"displayName": "Display Name of this Relevancy",
"description": "The description of this Relevancy",
"genusTypeId": "type.Type:defaultRelevancyType@base.url",
"recordTypeIds": [ "type.Type:exampleRelevancyRecordType@campusapi.org", "..."],
"startDate": "2020-10-03T06:30:00.000Z",
"endDate": "2020-12-18T19:30:00.000Z",
"endReasonId": "process.State:9642@base.url",
"subjectId": "ontology.Subject:6132@base.url",
"mappedId": "id.Id:3425@base.url"
},
{
"...": "..."
}
]
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
post /relevancies
Create a new relevancy in the default ontology.
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:953@base.url"
}
Entity representing a relevancy form metadata.
Get form metadata for creating a new relevancy.
get /relevancies/metadata
Get form metadata for creating a new relevancy.
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
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"$schema": "http://json-schema.org/draft/2019-9/schema#",
"title": "Relevancy",
"type": "object",
"required": ["displayName"],
"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",
"read-only": false,
"minLength": 1,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Relevancy.Relevancy:displayName@base.url",
"existingValue": "The Existing Name",
"elementLabel": "Name",
"instructions": "Enter a name for this relevancy",
"linked": false
},
"description": {
"description": "The description of this relevancy.",
"type": "string",
"read-only": false,
"minLength": 0,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Relevancy.Relevancy:displayName@demo.base.url",
"existingValue": "The Existing Description",
"elementLabel": "Description",
"instructions": "Enter a description for this relevancy",
"linked": false
},
"genusTypeId": {
"description": "Id of the immutable type of this relevancy. 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 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",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Relevancy.Relevancy:startDate@base.url",
"existingValue": "2020-10-03T08:00:00.000Z",
"elementLabel": "Start Date",
"instructions": "Enter a starting date for this relevancy",
"linked": false
},
"endDate": {
"description": "The ending date of this relevancy.",
"type": "string",
"format": "date-time",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Relevancy.Relevancy:endDate@base.url",
"existingValue": "2020-12-18T17:00:00.000Z",
"elementLabel": "End Date",
"instructions": "Enter an ending date for this relevancy",
"linked": false
},
"endReasonId": {
"description": "The reason this relevancy ended. A process/State object.",
"type": "string",
"format": "osid-id",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Relevancy.Relevancy:endReason@base.url",
"existingValue": "process.State:1860@base.url",
"elementLabel": "End Reason",
"instructions": "Select the reason this relevancy ended",
"linked": false
}
}
}
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
Entity representing a relevancy
Get a relevancy given its id.
Update a given relevancy.
Delete a given relevancy.
get /relevancies/{relevancyId}
Get a relevancy given its id.
URI Parameters
- relevancyId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"id": "ontology.Relevancy:9642@base.url",
"uri": "http://base.url/open/campusapi/ontology/relevancy/ontology.Relevancy%3A9642%40base.url",
"displayName": "Display Name of this Relevancy",
"description": "The description of this Relevancy",
"genusTypeId": "type.Type:defaultRelevancyType@base.url",
"recordTypeIds": [ "type.Type:exampleRelevancyRecordType@campusapi.org", "..."],
"startDate": "2020-10-03T06:30:00.000Z",
"endDate": "2020-12-18T19:30:00.000Z",
"endReasonId": "process.State:9642@base.url",
"subjectId": "ontology.Subject:6132@base.url",
"mappedId": "id.Id:3425@base.url"
}
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{"message": "relevancy not found" }
put /relevancies/{relevancyId}
Update a given relevancy.
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:953@base.url"
}
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "The relevancy has been updated" }
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{"message": "relevancy not found" }
delete /relevancies/{relevancyId}
Delete a given relevancy.
URI Parameters
- relevancyId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "The relevancy has been deleted" }
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{"message": "relevancy not found" }
Entity representing a relevancy form metadata for update
Get form metadata for updating an existing relevancy.
get /relevancies/{relevancyId}/metadata
Get form metadata for updating an existing relevancy.
URI Parameters
- relevancyId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"$schema": "http://json-schema.org/draft/2019-9/schema#",
"title": "Relevancy",
"type": "object",
"required": ["displayName"],
"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",
"read-only": false,
"minLength": 1,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Relevancy.Relevancy:displayName@base.url",
"existingValue": "The Existing Name",
"elementLabel": "Name",
"instructions": "Enter a name for this relevancy",
"linked": false
},
"description": {
"description": "The description of this relevancy.",
"type": "string",
"read-only": false,
"minLength": 0,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Relevancy.Relevancy:displayName@demo.base.url",
"existingValue": "The Existing Description",
"elementLabel": "Description",
"instructions": "Enter a description for this relevancy",
"linked": false
},
"genusTypeId": {
"description": "Id of the immutable type of this relevancy. 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 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",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Relevancy.Relevancy:startDate@base.url",
"existingValue": "2020-10-03T08:00:00.000Z",
"elementLabel": "Start Date",
"instructions": "Enter a starting date for this relevancy",
"linked": false
},
"endDate": {
"description": "The ending date of this relevancy.",
"type": "string",
"format": "date-time",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Relevancy.Relevancy:endDate@base.url",
"existingValue": "2020-12-18T17:00:00.000Z",
"elementLabel": "End Date",
"instructions": "Enter an ending date for this relevancy",
"linked": false
},
"endReasonId": {
"description": "The reason this relevancy ended. A process/State object.",
"type": "string",
"format": "osid-id",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Relevancy.Relevancy:endReason@base.url",
"existingValue": "process.State:1860@base.url",
"elementLabel": "End Reason",
"instructions": "Select the reason this relevancy ended",
"linked": false
}
}
}
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{"message": "relevancy not found" }
/ontologies
Collection of ontologies in a system or federation of systems.
Get all ontologies.
Create a new ontology.
get /ontologies
Get all ontologies.
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 - 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
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
[
{
"id": "ontology.Ontology:8202@base.url",
"uri": "http://base.url/open/campusapi/ontology/ontology/ontology.Ontology%3A8202%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" }
post /ontologies
Create a new ontology.
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"
}
Entity representing a ontology form metadata.
Get form metadata for creating a new ontology.
get /ontologies/metadata
Get form metadata for creating a new ontology.
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" }
The root ontologies in the ontology hierarchy. A node with no parents is an orphan. While all ontology Ids are known to the hierarchy, an orphan does not appear in the hierarchy unless explicitly added as a root node or child of another node.
Get all root root-ontology
get /ontologies/root-ontology
Get all root root-ontology
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
[
{
"id": "ontology.Ontology:8202@base.url",
"uri": "http://base.url/open/campusapi/ontology/ontology/ontology.Ontology%3A8202%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" }
Entity representing a ontology
Get a ontology given its id.
Update a given ontology.
Delete a given ontology.
get /ontologies/{ontologyId}
Get a ontology given its id.
URI Parameters
- ontologyId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"id": "ontology.Ontology:8202@base.url",
"uri": "http://base.url/open/campusapi/ontology/ontology/ontology.Ontology%3A8202%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" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{"message": "ontology not found" }
put /ontologies/{ontologyId}
Update a given ontology.
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"
}
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "The ontology has been updated" }
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{"message": "ontology not found" }
delete /ontologies/{ontologyId}
Delete a given ontology.
URI Parameters
- ontologyId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "The ontology has been deleted" }
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{"message": "ontology not found" }
Entity representing a ontology form metadata for update
Get form metadata for updating an existing ontology.
get /ontologies/{ontologyId}/metadata
Get form metadata for updating an existing ontology.
URI Parameters
- ontologyId: required(string)
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 404
Body
Media type: application/json
Type: any
Example:
{"message": "ontology not found" }
Get child ontologies for the given ontology in the hierarchy.
get /ontologies/{ontologyId}/children
Get child ontologies for the given ontology in the hierarchy.
URI Parameters
- ontologyId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
[
{
"id": "ontology.Ontology:8202@base.url",
"uri": "http://base.url/open/campusapi/ontology/ontology/ontology.Ontology%3A8202%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" }
Add ontology as child of the given ontology in the hierarchy.
Remove the given ontology as a child of the given ontology in the hierarchy.
put /ontologies/{ontologyId}/children/{childId}
Add ontology as child of the given ontology in the hierarchy.
URI Parameters
- ontologyId: required(string)
- childId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "The child ontology has been added to the hierarchy" }
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{ "message": "ontology not found" }
delete /ontologies/{ontologyId}/children/{childId}
Remove the given ontology as a child of the given ontology in the hierarchy.
URI Parameters
- ontologyId: required(string)
- childId: required(string)
Get parent ontologies for the given ontology in the hierarchy.
get /ontologies/{ontologyId}/parents
Get parent ontologies for the given ontology in the hierarchy.
URI Parameters
- ontologyId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
[
{
"id": "ontology.Ontology:8202@base.url",
"uri": "http://base.url/open/campusapi/ontology/ontology/ontology.Ontology%3A8202%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" }
Get all subjects in this ontology
get /ontologies/{ontologyId}/subjects
Get all subjects in this ontology
URI Parameters
- ontologyId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
[
{
"id": "ontology.Subject:2166@base.url",
"uri": "http://base.url/open/campusapi/ontology/subject/ontology.Subject%3A2166%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" }
Add the given subject to this ontology
Remove the given subject from the ontology.
put /ontologies/{ontologyId}/subjects/{subjectId}
Add the given subject to this ontology
URI Parameters
- ontologyId: required(string)
- subjectId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "subject has been added to ontology" }
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{ "message": "subject not found" }
delete /ontologies/{ontologyId}/subjects/{subjectId}
Remove the given subject from the ontology.
URI Parameters
- ontologyId: required(string)
- subjectId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "subject has been removed" }
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{ "message": "subject not found" }
Get all relevancies in this ontology
get /ontologies/{ontologyId}/relevancies
Get all relevancies in this ontology
URI Parameters
- ontologyId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
[
{
"id": "ontology.Relevancy:9642@base.url",
"uri": "http://base.url/open/campusapi/ontology/relevancy/ontology.Relevancy%3A9642%40base.url",
"displayName": "Display Name of this Relevancy",
"description": "The description of this Relevancy",
"genusTypeId": "type.Type:defaultRelevancyType@base.url",
"recordTypeIds": [ "type.Type:exampleRelevancyRecordType@campusapi.org", "..."],
"startDate": "2020-10-03T06:30:00.000Z",
"endDate": "2020-12-18T19:30:00.000Z",
"endReasonId": "process.State:9642@base.url",
"subjectId": "ontology.Subject:6132@base.url",
"mappedId": "id.Id:3425@base.url"
},
{
"...": "..."
}
]
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
Add the given relevancy to this ontology
Remove the given relevancy from the ontology.
put /ontologies/{ontologyId}/relevancies/{relevancyId}
Add the given relevancy to this ontology
URI Parameters
- ontologyId: required(string)
- relevancyId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "relevancy has been added to ontology" }
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{ "message": "relevancy not found" }
delete /ontologies/{ontologyId}/relevancies/{relevancyId}
Remove the given relevancy from the ontology.
URI Parameters
- ontologyId: required(string)
- relevancyId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "relevancy has been removed" }
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{ "message": "relevancy not found" }