CampusAPI Resource Services API documentation version 0.0.4 (OSID v3.0.0)
https://demo.dxtera.org/open/campusapi/resource
Overview
Resources may represent people, places or a set or arbitrary entities that are used throughout other CampusAPI services as references to indirect objects. Resource genus Types may define extra data to define an employee, organizational unit or an inventory item.
When referenced in another service area, the abstraction level of this service provides a consistent interface with which to access and manage object references not directly pertinent to the service in play. For example, a Repository service may reference Resources as authors or a Course service may reference Resources for students and instructors. Each of these services may orchestrate a Resource to provide management of the set of referenced resources.
A Resource genus Type may be used to provide a label the kind of resource. This service offers the flexibility that the producer of a film may be a person, a production company, or a fire hydrant. While genus Types may be used to constrain the kinds of Resources that may be related to various objects if necessary, Consumers are expected to simply use the Resource as a reference. If an consumer wishes to provide a mechanism for updating a Resource referenced, it should use an orchestrated Resource service.
This package includes the following entities:
Resources
A Resource represents an arbitrary entity. Resources are used to define an object to accompany an OSID Id used in other OSIDs. A resource may be used to represent a meeting room in the Scheduling service, or a student in the Course service.
A Resource may also represent a group or organization. A service provider may present such a group in an opaque manner through a single resource definition, or the provider may expose the resource collection for examination or manipulation. If such a resource collection is visible, isGroup is true and can be used in the group functions available in this service area.
| Field | Description | Type |
|---|---|---|
| id(read‑only) | The unique id of this resource, provided by system. | string(osid‑id) |
| uri(read‑only) | The uri of this resource, provided by system. | string(uri) |
| displayName | The name of this resource for display. | string |
| description | The description of this resource. | string |
| genusType (read‑only) | The immutable type of this resource. Default type set by system unless specified in query parameter. | string(osid‑type) |
| group | Tests if this resource is a group. | boolean |
| avatarId | The asset. References a repository.Asset object | string(osid‑id) |
ResourceRelationships
For kicks, Resources may have arbitrrary relationships to other Resources using the ResourceRelationship interface. Resource relationships may also be used to provide a place to describe in more detail, or hang data, on a member to group relationship.
| Field | Description | Type |
|---|---|---|
| id(read‑only) | The unique id of this resource relationship, provided by system. | string(osid‑id) |
| uri(read‑only) | The uri of this resource relationship, provided by system. | string(uri) |
| displayName | The name of this resource relationship for display. | string |
| description | The description of this resource relationship. | string |
| genusType (read‑only) | The immutable type of this resource relationship. Default type set by system unless specified in query parameter. | string(osid‑type) |
| startDate | The starting date of this resource relationship. | string(date‑time) |
| endDate | The ending date of this resource relationship. | string(date‑time) |
| endReasonId | The reason this resource relationship ended. References a process.State object. | string(osid‑id) |
| sourceResourceId (read‑only) | The source resource associated with this resource relationship. | string(osid‑id) |
| destinationResourceId (read‑only) | The destination resource associated with this resource relationship. | string(osid‑id) |
Bins
Resources may be mapped into hierarchial Bins for the purpose of cataloging or federation.
| Field | Description | Type |
|---|---|---|
| id(read‑only) | The unique id of this bin, provided by system. | string(osid‑id) |
| uri(read‑only) | The uri of this bin, provided by system. | string(uri) |
| displayName | The name of this bin for display. | string |
| description | The description of this bin. | string |
| genusType (read‑only) | The immutable type of this bin. Default type set by system unless specified in query parameter. | string(osid‑type) |
| providerId | The provider of this bin. References a resource.Resource object. | string(osid‑id) |
| brandingIds | The branding of this bin. References repository.Asset objects. | string(osid‑id)[] |
| license | The licensing that applies to this bin. | string |
License Agreement
CampusAPI Copyright 2020 DXtera Institute Licensed under the Educational Community License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
https://opensource.org/licenses/ECL-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
All CampusAPI services are derived from the specifications of the Open Service Interface Definitions - http://osid.org
/resources
Collection of resources in a system, federation of systems, or in a default bin.
Get all resources in the system or default bin.
Create a new resource in the default bin.
get /resources
Get all resources in the system or default bin.
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 - genusType: (string)
The id string to match a genusType
Example:
type.Type%3AexampleResourceType%40dxtera.org - parentGenusType: (string)
The id string to match a parent genusType
Example:
type.Type%3AparentTypeExampleResourceType%40dxtera.org - binId: (string)
The id string to match a bin
Example:
resource.Bin%3A8374%40demo.dxtera.org
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
[
{
"id": "resource.Resource:1344@demo.dxtera.org",
"uri": "http://demo.dxtera.org/open/campusapi/resource/resource/resource.Resource%3A31415%40demo.dxtera.org",
"displayName": "Display Name of this Resource",
"description": "The description of this Resource",
"genusType": "type.Type:defaultResourceType@dxtera.org",
"group": true,
"avatarId": "repository.Asset:8475@demo.dxtera.org"
},
{
"...": "..."
}
]
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
post /resources
Create a new resource in the default bin.
Query Parameters
- genusType: (string)
specify a particular resource type to create
Example:
type.Type%3AexampleResourceType%40dxtera.org - binId: (string)
specify in which bin to create this resource
Example:
resource.Bin%3A8374%40demo.dxtera.org
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Resource",
"type": "object",
"properties": {
"id": {
"description": "The unique id of this resource, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this resource, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this resource for display.",
"type": "string"
},
"description": {
"description": "The description of this resource.",
"type": "string"
},
"genusType": {
"description": "The immutable type of this resource. Default type set by system unless specified in query parameter.",
"type": "string",
"format": "osid-type",
"readOnly": true
},
"group": {
"description": "Tests if this resource is a group.",
"type": "boolean"
},
"avatarId": {
"description": "The asset.",
"type": "string",
"format": "osid-id"
}
}
}Example:
{
"id": "resource.Resource:4955@demo.dxtera.org",
"uri": "http://demo.dxtera.org/open/campusapi/resource/resource/resource.Resource%3A31415%40demo.dxtera.org",
"displayName": "Display Name of this Resource",
"description": "The description of this Resource",
"group": true,
"avatarId": "repository.Asset:4495@demo.dxtera.org"
}
Entity representing a resource form metadata.
Get form metadata for creating a new resource.
get /resources/metadata
Get form metadata for creating a new resource.
Query Parameters
- genusType: (string)
specify a particular resource type to create
Example:
type.Type%3AexampleResourceType%40dxtera.org - binId: (string)
specify in which bin to create this resource
Example:
resource.Bin%3A8374%40demo.dxtera.org
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"$schema": "http://json-schema.org/draft/2019-9/schema#",
"title": "Resource",
"type": "object",
"required": ["displayName"],
"properties": {
"id": {
"description": "The unique id of this resource, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this resource, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this resource for display.",
"type": "string",
"read-only": false,
"minLength": 1,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Resource.Resource:displayName@demo.dxtera.org",
"existingValue": "The Existing Name",
"elementLabel": "Name",
"instructions": "Enter a name for this resource",
"linked": false
},
"description": {
"description": "The description of this resource.",
"type": "string",
"read-only": false,
"minLength": 0,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Resource.Resource:displayName@demo.demo.dxtera.org",
"existingValue": "The Existing Description",
"elementLabel": "Description",
"instructions": "Enter a description for this resource",
"linked": false
},
"genusType": {
"description": "The immutable type of this resource. Default type set by system unless specified in query parameter.",
"type": "string",
"format": "osid-type",
"readOnly": true
},
"group": {
"description": "Tests if this resource is a group.",
"type": "boolean",
"elementId": "resource.Resource:group@dxtera.org",
"existingValue": false,
"elementLabel": "Group",
"instructions": "Enter true or false.",
"linked": false
},
"avatarId": {
"description": "The asset.",
"type": "string",
"type": "string",
"format": "osid-id",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "resource.Resource:avatar@dxtera.org",
"existingValue": null,
"elementLabel": "Avatar",
"instructions": "Enter the Id of the avatar for this resource.",
"linked": false
}
}
}
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
Entity representing a resource
Get a resource given its id.
Update a given resource.
Delete a given resource.
get /resources/{resourceId}
Get a resource given its id.
URI Parameters
- resourceId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"id": "resource.Resource:1344@demo.dxtera.org",
"uri": "http://demo.dxtera.org/open/campusapi/resource/resource/resource.Resource%3A31415%40demo.dxtera.org",
"displayName": "Display Name of this Resource",
"description": "The description of this Resource",
"genusType": "type.Type:defaultResourceType@dxtera.org",
"group": true,
"avatarId": "repository.Asset:8475@demo.dxtera.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": "resource not found" }
put /resources/{resourceId}
Update a given resource.
URI Parameters
- resourceId: required(string)
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Resource",
"type": "object",
"properties": {
"id": {
"description": "The unique id of this resource, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this resource, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this resource for display.",
"type": "string"
},
"description": {
"description": "The description of this resource.",
"type": "string"
},
"genusType": {
"description": "The immutable type of this resource. Default type set by system unless specified in query parameter.",
"type": "string",
"format": "osid-type",
"readOnly": true
},
"group": {
"description": "Tests if this resource is a group.",
"type": "boolean"
},
"avatarId": {
"description": "The asset.",
"type": "string",
"format": "osid-id"
}
}
}Example:
{
"id": "resource.Resource:4955@demo.dxtera.org",
"uri": "http://demo.dxtera.org/open/campusapi/resource/resource/resource.Resource%3A31415%40demo.dxtera.org",
"displayName": "Display Name of this Resource",
"description": "The description of this Resource",
"group": true,
"avatarId": "repository.Asset:4495@demo.dxtera.org"
}
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "The resource 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": "resource not found" }
delete /resources/{resourceId}
Delete a given resource.
URI Parameters
- resourceId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "The resource 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": "resource not found" }
Entity representing a resource form metadata for update
Get form metadata for updating an existing resource.
get /resources/{resourceId}/metadata
Get form metadata for updating an existing resource.
URI Parameters
- resourceId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"$schema": "http://json-schema.org/draft/2019-9/schema#",
"title": "Resource",
"type": "object",
"required": ["displayName"],
"properties": {
"id": {
"description": "The unique id of this resource, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this resource, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this resource for display.",
"type": "string",
"read-only": false,
"minLength": 1,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Resource.Resource:displayName@demo.dxtera.org",
"existingValue": "The Existing Name",
"elementLabel": "Name",
"instructions": "Enter a name for this resource",
"linked": false
},
"description": {
"description": "The description of this resource.",
"type": "string",
"read-only": false,
"minLength": 0,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Resource.Resource:displayName@demo.demo.dxtera.org",
"existingValue": "The Existing Description",
"elementLabel": "Description",
"instructions": "Enter a description for this resource",
"linked": false
},
"genusType": {
"description": "The immutable type of this resource. Default type set by system unless specified in query parameter.",
"type": "string",
"format": "osid-type",
"readOnly": true
},
"group": {
"description": "Tests if this resource is a group.",
"type": "boolean",
"elementId": "resource.Resource:group@dxtera.org",
"existingValue": false,
"elementLabel": "Group",
"instructions": "Enter true or false.",
"linked": false
},
"avatarId": {
"description": "The asset.",
"type": "string",
"type": "string",
"format": "osid-id",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "resource.Resource:avatar@dxtera.org",
"existingValue": null,
"elementLabel": "Avatar",
"instructions": "Enter the Id of the avatar for this resource.",
"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": "resource not found" }
/resourceRelationships
Collection of resourceRelationships in a system, federation of systems, or in a default bin.
Get all resourceRelationships in the system or default bin.
Create a new resourceRelationship in the default bin.
get /resourceRelationships
Get all resourceRelationships in the system or default bin.
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 - genusType: (string)
The id string to match a genusType
Example:
type.Type%3AexampleResourceRelationshipType%40dxtera.org - parentGenusType: (string)
The id string to match a parent genusType
Example:
type.Type%3AparentTypeExampleResourceRelationshipType%40dxtera.org - fromDate: (string)
Get all resourceRelationships from this date inclusive. Use with toDate to define date range query.
Example:
2020-10-03 - toDate: (string)
Get all resourceRelationships for student up to this date inclusive. Use with fromDate to define date range query.
Example:
2020-12-18 - sourceResourceId: (string)
the id string to match a source-resource.
Example:
resource.Source_Resource%3A2400%40demo.dxtera.org - destinationResourceId: (string)
the id string to match a destination-resource.
Example:
resource.Destination_Resource%3A3200%40demo.dxtera.org - binId: (string)
The id string to match a bin
Example:
resource.Bin%3A8374%40demo.dxtera.org
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
[
{
"id": "resource.ResourceRelationship:939@demo.dxtera.org",
"uri": "http://demo.dxtera.org/open/campusapi/resource/resourceRelationship/resource.ResourceRelationship%3A31415%40demo.dxtera.org",
"displayName": "Display Name of this ResourceRelationship",
"description": "The description of this ResourceRelationship",
"genusType": "type.Type:defaultResourceRelationshipType@dxtera.org",
"startDate": "2020-10-03T06:30:00.000Z",
"endDate": "2020-12-18T19:30:00.000Z",
"endReasonId": "process.State:939@demo.dxtera.org",
"sourceResourceId": "resource.Resource:284@demo.dxtera.org",
"destinationResourceId": "resource.Resource:8358@demo.dxtera.org"
},
{
"...": "..."
}
]
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
post /resourceRelationships
Create a new resourceRelationship in the default bin.
Query Parameters
- sourceResourceId: required(string)
the source-resource of this resourceRelationship.
Example:
resource.Source_Resource%3A2400%40demo.dxtera.org - destinationResourceId: required(string)
the destination-resource of this resourceRelationship.
Example:
resource.Destination_Resource%3A3200%40demo.dxtera.org - genusType: (string)
specify a particular resourceRelationship type to create
Example:
type.Type%3AexampleResourceRelationshipType%40dxtera.org - binId: (string)
specify in which bin to create this resourceRelationship
Example:
resource.Bin%3A8374%40demo.dxtera.org
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "ResourceRelationship",
"type": "object",
"properties": {
"id": {
"description": "The unique id of this resource relationship, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this resource relationship, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this resource relationship for display.",
"type": "string"
},
"description": {
"description": "The description of this resource relationship.",
"type": "string"
},
"genusType": {
"description": "The immutable type of this resource relationship. Default type set by system unless specified in query parameter.",
"type": "string",
"format": "osid-type",
"readOnly": true
},
"startDate": {
"description": "The starting date of this resource relationship.",
"type": "string",
"format": "date-time"
},
"endDate": {
"description": "The ending date of this resource relationship.",
"type": "string",
"format": "date-time"
},
"endReasonId": {
"description": "The reason this resource relationship ended.",
"type": "string",
"format": "osid-id"
},
"sourceResourceId": {
"description": "The source resource associated with this resource relationship.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"destinationResourceId": {
"description": "The destination resource associated with this resource relationship.",
"type": "string",
"format": "osid-id",
"readOnly": true
}
}
}Example:
{
"id": "resource.ResourceRelationship:4454@demo.dxtera.org",
"uri": "http://demo.dxtera.org/open/campusapi/resource/resourceRelationship/resource.ResourceRelationship%3A31415%40demo.dxtera.org",
"displayName": "Display Name of this ResourceRelationship",
"description": "The description of this ResourceRelationship",
"startDate": "2020-10-03T06:30:00.000Z",
"endDate": "2020-12-18T19:30:00.000Z",
"endReasonId": "process.State:4454@demo.dxtera.org"
}
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "The resourceRelationship has been created",
"resourceRelationshipId": "resource.ResourceRelationship:9876@demo.dxtera.org"}
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
Entity representing a resourceRelationship form metadata.
Get form metadata for creating a new resourceRelationship.
get /resourceRelationships/metadata
Get form metadata for creating a new resourceRelationship.
Query Parameters
- sourceResourceId: required(string)
the source-resource of this metadatum.
Example:
resource.Source_Resource%3A2400%40demo.dxtera.org - destinationResourceId: required(string)
the destination-resource of this metadatum.
Example:
resource.Destination_Resource%3A3200%40demo.dxtera.org - genusType: (string)
specify a particular resourceRelationship type to create
Example:
type.Type%3AexampleResourceRelationshipType%40dxtera.org - binId: (string)
specify in which bin to create this resourceRelationship
Example:
resource.Bin%3A8374%40demo.dxtera.org
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"$schema": "http://json-schema.org/draft/2019-9/schema#",
"title": "ResourceRelationship",
"type": "object",
"required": ["displayName"],
"properties": {
"id": {
"description": "The unique id of this resource relationship, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this resource relationship, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this resource relationship for display.",
"type": "string",
"read-only": false,
"minLength": 1,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "ResourceRelationship.ResourceRelationship:displayName@demo.dxtera.org",
"existingValue": "The Existing Name",
"elementLabel": "Name",
"instructions": "Enter a name for this resource relationship",
"linked": false
},
"description": {
"description": "The description of this resource relationship.",
"type": "string",
"read-only": false,
"minLength": 0,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "ResourceRelationship.ResourceRelationship:displayName@demo.demo.dxtera.org",
"existingValue": "The Existing Description",
"elementLabel": "Description",
"instructions": "Enter a description for this resource relationship",
"linked": false
},
"genusType": {
"description": "The immutable type of this resource relationship. Default type set by system unless specified in query parameter.",
"type": "string",
"format": "osid-type",
"readOnly": true
},
"startDate": {
"description": "The starting date of this resource relationship.",
"type": "string",
"format": "date-time",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "ResourceRelationship.ResourceRelationship:startDate@demo.dxtera.org",
"existingValue": "2020-10-03T08:00:00.000Z",
"elementLabel": "Start Date",
"instructions": "Enter a starting date for this resource relationship",
"linked": false
},
"endDate": {
"description": "The ending date of this resource relationship.",
"type": "string",
"format": "date-time",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "ResourceRelationship.ResourceRelationship:endDate@demo.dxtera.org",
"existingValue": "2020-12-18T17:00:00.000Z",
"elementLabel": "End Date",
"instructions": "Enter an ending date for this resource relationship",
"linked": false
},
"endReasonId": {
"description": "The reason this resource relationship ended. A process/State object.",
"type": "string",
"format": "osid-id",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "ResourceRelationship.ResourceRelationship:endReason@demo.dxtera.org",
"existingValue": "process.State:1860@demo.dxtera.org",
"elementLabel": "End Reason",
"instructions": "Select the reason this resource relationship ended",
"linked": false
}
}
}
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
Entity representing a resourceRelationship
Get a resourceRelationship given its id.
Update a given resourceRelationship.
Delete a given resourceRelationship.
get /resourceRelationships/{resourceRelationshipId}
Get a resourceRelationship given its id.
URI Parameters
- resourceRelationshipId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"id": "resource.ResourceRelationship:939@demo.dxtera.org",
"uri": "http://demo.dxtera.org/open/campusapi/resource/resourceRelationship/resource.ResourceRelationship%3A31415%40demo.dxtera.org",
"displayName": "Display Name of this ResourceRelationship",
"description": "The description of this ResourceRelationship",
"genusType": "type.Type:defaultResourceRelationshipType@dxtera.org",
"startDate": "2020-10-03T06:30:00.000Z",
"endDate": "2020-12-18T19:30:00.000Z",
"endReasonId": "process.State:939@demo.dxtera.org",
"sourceResourceId": "resource.Resource:284@demo.dxtera.org",
"destinationResourceId": "resource.Resource:8358@demo.dxtera.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": "resourceRelationship not found" }
put /resourceRelationships/{resourceRelationshipId}
Update a given resourceRelationship.
URI Parameters
- resourceRelationshipId: required(string)
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "ResourceRelationship",
"type": "object",
"properties": {
"id": {
"description": "The unique id of this resource relationship, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this resource relationship, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this resource relationship for display.",
"type": "string"
},
"description": {
"description": "The description of this resource relationship.",
"type": "string"
},
"genusType": {
"description": "The immutable type of this resource relationship. Default type set by system unless specified in query parameter.",
"type": "string",
"format": "osid-type",
"readOnly": true
},
"startDate": {
"description": "The starting date of this resource relationship.",
"type": "string",
"format": "date-time"
},
"endDate": {
"description": "The ending date of this resource relationship.",
"type": "string",
"format": "date-time"
},
"endReasonId": {
"description": "The reason this resource relationship ended.",
"type": "string",
"format": "osid-id"
},
"sourceResourceId": {
"description": "The source resource associated with this resource relationship.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"destinationResourceId": {
"description": "The destination resource associated with this resource relationship.",
"type": "string",
"format": "osid-id",
"readOnly": true
}
}
}Example:
{
"id": "resource.ResourceRelationship:4454@demo.dxtera.org",
"uri": "http://demo.dxtera.org/open/campusapi/resource/resourceRelationship/resource.ResourceRelationship%3A31415%40demo.dxtera.org",
"displayName": "Display Name of this ResourceRelationship",
"description": "The description of this ResourceRelationship",
"startDate": "2020-10-03T06:30:00.000Z",
"endDate": "2020-12-18T19:30:00.000Z",
"endReasonId": "process.State:4454@demo.dxtera.org"
}
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "The resourceRelationship 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": "resourceRelationship not found" }
delete /resourceRelationships/{resourceRelationshipId}
Delete a given resourceRelationship.
URI Parameters
- resourceRelationshipId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "The resourceRelationship 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": "resourceRelationship not found" }
Entity representing a resourceRelationship form metadata for update
Get form metadata for updating an existing resourceRelationship.
get /resourceRelationships/{resourceRelationshipId}/metadata
Get form metadata for updating an existing resourceRelationship.
URI Parameters
- resourceRelationshipId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"$schema": "http://json-schema.org/draft/2019-9/schema#",
"title": "ResourceRelationship",
"type": "object",
"required": ["displayName"],
"properties": {
"id": {
"description": "The unique id of this resource relationship, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this resource relationship, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this resource relationship for display.",
"type": "string",
"read-only": false,
"minLength": 1,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "ResourceRelationship.ResourceRelationship:displayName@demo.dxtera.org",
"existingValue": "The Existing Name",
"elementLabel": "Name",
"instructions": "Enter a name for this resource relationship",
"linked": false
},
"description": {
"description": "The description of this resource relationship.",
"type": "string",
"read-only": false,
"minLength": 0,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "ResourceRelationship.ResourceRelationship:displayName@demo.demo.dxtera.org",
"existingValue": "The Existing Description",
"elementLabel": "Description",
"instructions": "Enter a description for this resource relationship",
"linked": false
},
"genusType": {
"description": "The immutable type of this resource relationship. Default type set by system unless specified in query parameter.",
"type": "string",
"format": "osid-type",
"readOnly": true
},
"startDate": {
"description": "The starting date of this resource relationship.",
"type": "string",
"format": "date-time",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "ResourceRelationship.ResourceRelationship:startDate@demo.dxtera.org",
"existingValue": "2020-10-03T08:00:00.000Z",
"elementLabel": "Start Date",
"instructions": "Enter a starting date for this resource relationship",
"linked": false
},
"endDate": {
"description": "The ending date of this resource relationship.",
"type": "string",
"format": "date-time",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "ResourceRelationship.ResourceRelationship:endDate@demo.dxtera.org",
"existingValue": "2020-12-18T17:00:00.000Z",
"elementLabel": "End Date",
"instructions": "Enter an ending date for this resource relationship",
"linked": false
},
"endReasonId": {
"description": "The reason this resource relationship ended. A process/State object.",
"type": "string",
"format": "osid-id",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "ResourceRelationship.ResourceRelationship:endReason@demo.dxtera.org",
"existingValue": "process.State:1860@demo.dxtera.org",
"elementLabel": "End Reason",
"instructions": "Select the reason this resource relationship 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": "resourceRelationship not found" }
/bin
Collection of bin in a system or federation of systems.
Get all bin.
Create a new bin.
get /bin
Get all bin.
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 - genusType: (string)
The id string to match a genusType
Example:
type.Type%3AexampleBinType%40dxtera.org - parentGenusType: (string)
The id string to match a parent genusType
Example:
type.Type%3AparentTypeExampleBinType%40dxtera.org - providerId: (string)
Id string to match provider.
Example:
resource.Resource%3A3007%40demo.dxtera.org - resourceId: (string)
Get bin mapped to this resource.
Example:
resource.Resource%3A192%40demo.dxtera.org - resourceRelationshipId: (string)
Get bin mapped to this resource-relationship.
Example:
resource.ResourceRelationship%3A504%40demo.dxtera.org
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
[
{
"id": "resource.Bin:255@demo.dxtera.org",
"uri": "http://demo.dxtera.org/open/campusapi/resource/bin/resource.Bin%3A31415%40demo.dxtera.org",
"displayName": "Display Name of this Bin",
"description": "The description of this Bin",
"genusType": "type.Type:defaultBinType@dxtera.org",
"providerId": "resource.Resource:123@demo.dxtera.org",
"brandingId": "asset.Asset:Bin@demo.dxtera.org",
"license": "The license that applies to this Bin"
},
{
"...": "..."
}
]
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
post /bin
Create a new bin.
Query Parameters
- genusType: (string)
specify a particular bin type to create
Example:
type.Type%3AexampleBinType%40dxtera.org
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Bin",
"type": "object",
"properties": {
"id": {
"description": "The unique id of this bin, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this bin, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this bin for display.",
"type": "string"
},
"description": {
"description": "The description of this bin.",
"type": "string"
},
"genusType": {
"description": "The immutable type of this bin. Default type set by system unless specified in query parameter.",
"type": "string",
"format": "osid-type",
"readOnly": true
},
"providerId": {
"description": "The provider of this bin.",
"type": "string",
"format": "osid-id"
},
"brandingIds": {
"description": "The branding of this bin. A collection of Assets.",
"type": "array",
"items" : {
"type": "string",
"format": "osid-id"
}
},
"license": {
"description": "The licensing that applies to this bin.",
"type": "string"
}
}
}Example:
{
"id": "resource.Bin:9392@demo.dxtera.org",
"uri": "http://demo.dxtera.org/open/campusapi/resource/bin/resource.Bin%3A31415%40demo.dxtera.org",
"displayName": "Display Name of this Bin",
"description": "The description of this Bin",
"providerId": "resource.Resource:123@demo.dxtera.org",
"brandingId": "asset.Asset:Bin@demo.dxtera.org",
"license": "The license that applies to this Bin"
}
Entity representing a bin form metadata.
Get form metadata for creating a new bin.
get /bin/metadata
Get form metadata for creating a new bin.
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"$schema": "http://json-schema.org/draft/2019-9/schema#",
"title": "Bin",
"type": "object",
"required": ["displayName"],
"properties": {
"id": {
"description": "The unique id of this bin, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this bin, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this bin for display.",
"type": "string",
"read-only": false,
"minLength": 1,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Bin.Bin:displayName@demo.dxtera.org",
"existingValue": "The Existing Name",
"elementLabel": "Name",
"instructions": "Enter a name for this bin",
"linked": false
},
"description": {
"description": "The description of this bin.",
"type": "string",
"read-only": false,
"minLength": 0,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Bin.Bin:displayName@demo.demo.dxtera.org",
"existingValue": "The Existing Description",
"elementLabel": "Description",
"instructions": "Enter a description for this bin",
"linked": false
},
"genusType": {
"description": "The immutable type of this bin. Default type set by system unless specified in query parameter.",
"type": "string",
"format": "osid-type",
"readOnly": true
},
"providerId": {
"description": "The provider of this bin.",
"type": "string",
"format": "osid-id",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Bin.Bin:provider@demo.dxtera.org",
"existingValue": "",
"elementLabel": "Provider",
"instructions": "Enter the provider of this bin",
"linked": false
},
"brandingIds": {
"description": "The branding of this bin. A list of Assets.",
"type": "array",
"items" : {
"type": "string",
"format": "osid-id",
"pattern": "",
"enum": []
},
"read-only": false,
"default": [],
"elementId": "Bin.Bin:branding@demo.dxtera.org",
"existingValue": "",
"elementLabel": "Branding",
"instructions": "Enter the branding images for this bin",
"linked": false
},
"license": {
"description": "The licensing that applies to this bin.",
"type": "string",
"read-only": false,
"minLength": 0,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Bin.Bin:license@demo.dxtera.org",
"existingValue": "The Existing License",
"elementLabel": "License",
"instructions": "Include a license for this bin",
"linked": false
}
}
}
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
The root bins in the bin hierarchy. A node with no parents is an orphan. While all bin 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 rootBin
get /bin/rootBin
Get all root rootBin
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
[
{
"id": "resource.Bin:255@demo.dxtera.org",
"uri": "http://demo.dxtera.org/open/campusapi/resource/bin/resource.Bin%3A31415%40demo.dxtera.org",
"displayName": "Display Name of this Bin",
"description": "The description of this Bin",
"genusType": "type.Type:defaultBinType@dxtera.org",
"providerId": "resource.Resource:123@demo.dxtera.org",
"brandingId": "asset.Asset:Bin@demo.dxtera.org",
"license": "The license that applies to this Bin"
},
{
"...": "..."
}
]
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
Entity representing a bin
Get a bin given its id.
Update a given bin.
Delete a given bin.
get /bin/{binId}
Get a bin given its id.
URI Parameters
- binId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"id": "resource.Bin:255@demo.dxtera.org",
"uri": "http://demo.dxtera.org/open/campusapi/resource/bin/resource.Bin%3A31415%40demo.dxtera.org",
"displayName": "Display Name of this Bin",
"description": "The description of this Bin",
"genusType": "type.Type:defaultBinType@dxtera.org",
"providerId": "resource.Resource:123@demo.dxtera.org",
"brandingId": "asset.Asset:Bin@demo.dxtera.org",
"license": "The license that applies to this Bin"
}
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": "bin not found" }
put /bin/{binId}
Update a given bin.
URI Parameters
- binId: required(string)
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Bin",
"type": "object",
"properties": {
"id": {
"description": "The unique id of this bin, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this bin, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this bin for display.",
"type": "string"
},
"description": {
"description": "The description of this bin.",
"type": "string"
},
"genusType": {
"description": "The immutable type of this bin. Default type set by system unless specified in query parameter.",
"type": "string",
"format": "osid-type",
"readOnly": true
},
"providerId": {
"description": "The provider of this bin.",
"type": "string",
"format": "osid-id"
},
"brandingIds": {
"description": "The branding of this bin. A collection of Assets.",
"type": "array",
"items" : {
"type": "string",
"format": "osid-id"
}
},
"license": {
"description": "The licensing that applies to this bin.",
"type": "string"
}
}
}Example:
{
"id": "resource.Bin:9392@demo.dxtera.org",
"uri": "http://demo.dxtera.org/open/campusapi/resource/bin/resource.Bin%3A31415%40demo.dxtera.org",
"displayName": "Display Name of this Bin",
"description": "The description of this Bin",
"providerId": "resource.Resource:123@demo.dxtera.org",
"brandingId": "asset.Asset:Bin@demo.dxtera.org",
"license": "The license that applies to this Bin"
}
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "The bin 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": "bin not found" }
delete /bin/{binId}
Delete a given bin.
URI Parameters
- binId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "The bin 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": "bin not found" }
Entity representing a bin form metadata for update
Get form metadata for updating an existing bin.
get /bin/{binId}/metadata
Get form metadata for updating an existing bin.
URI Parameters
- binId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"$schema": "http://json-schema.org/draft/2019-9/schema#",
"title": "Bin",
"type": "object",
"required": ["displayName"],
"properties": {
"id": {
"description": "The unique id of this bin, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this bin, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this bin for display.",
"type": "string",
"read-only": false,
"minLength": 1,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Bin.Bin:displayName@demo.dxtera.org",
"existingValue": "The Existing Name",
"elementLabel": "Name",
"instructions": "Enter a name for this bin",
"linked": false
},
"description": {
"description": "The description of this bin.",
"type": "string",
"read-only": false,
"minLength": 0,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Bin.Bin:displayName@demo.demo.dxtera.org",
"existingValue": "The Existing Description",
"elementLabel": "Description",
"instructions": "Enter a description for this bin",
"linked": false
},
"genusType": {
"description": "The immutable type of this bin. Default type set by system unless specified in query parameter.",
"type": "string",
"format": "osid-type",
"readOnly": true
},
"providerId": {
"description": "The provider of this bin.",
"type": "string",
"format": "osid-id",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Bin.Bin:provider@demo.dxtera.org",
"existingValue": "",
"elementLabel": "Provider",
"instructions": "Enter the provider of this bin",
"linked": false
},
"brandingIds": {
"description": "The branding of this bin. A list of Assets.",
"type": "array",
"items" : {
"type": "string",
"format": "osid-id",
"pattern": "",
"enum": []
},
"read-only": false,
"default": [],
"elementId": "Bin.Bin:branding@demo.dxtera.org",
"existingValue": "",
"elementLabel": "Branding",
"instructions": "Enter the branding images for this bin",
"linked": false
},
"license": {
"description": "The licensing that applies to this bin.",
"type": "string",
"read-only": false,
"minLength": 0,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Bin.Bin:license@demo.dxtera.org",
"existingValue": "The Existing License",
"elementLabel": "License",
"instructions": "Include a license for this bin",
"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": "bin not found" }
Get children bins for the given bin in the hierarchy.
get /bin/{binId}/children
Get children bins for the given bin in the hierarchy.
URI Parameters
- binId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
[
{
"id": "resource.Bin:255@demo.dxtera.org",
"uri": "http://demo.dxtera.org/open/campusapi/resource/bin/resource.Bin%3A31415%40demo.dxtera.org",
"displayName": "Display Name of this Bin",
"description": "The description of this Bin",
"genusType": "type.Type:defaultBinType@dxtera.org",
"providerId": "resource.Resource:123@demo.dxtera.org",
"brandingId": "asset.Asset:Bin@demo.dxtera.org",
"license": "The license that applies to this Bin"
},
{
"...": "..."
}
]
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
Add bin as child of the given bin in the hierarchy.
Remove the given bin as a child of the given bin in the hierarchy.
put /bin/{binId}/children/{childId}
Add bin as child of the given bin in the hierarchy.
URI Parameters
- binId: required(string)
- childId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "The child bin has been added" }
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": "bin not found" }
delete /bin/{binId}/children/{childId}
Remove the given bin as a child of the given bin in the hierarchy.
Get all resources in this bin
get /bin/{binId}/resources
Get all resources in this bin
URI Parameters
- binId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
[
{
"id": "resource.Resource:1344@demo.dxtera.org",
"uri": "http://demo.dxtera.org/open/campusapi/resource/resource/resource.Resource%3A31415%40demo.dxtera.org",
"displayName": "Display Name of this Resource",
"description": "The description of this Resource",
"genusType": "type.Type:defaultResourceType@dxtera.org",
"group": true,
"avatarId": "repository.Asset:8475@demo.dxtera.org"
},
{
"...": "..."
}
]
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
Add the given resource to this bin
Remove the given resource from the bin.
put /bin/{binId}/resources/{resourcesId}
Add the given resource to this bin
URI Parameters
- binId: required(string)
- resourcesId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "resource has been added to bin" }
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": "resource not found" }
delete /bin/{binId}/resources/{resourcesId}
Remove the given resource from the bin.
URI Parameters
- binId: required(string)
- resourcesId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "resource 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": "resource not found" }
Get all resourceRelationships in this bin
get /bin/{binId}/resourceRelationships
Get all resourceRelationships in this bin
URI Parameters
- binId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
[
{
"id": "resource.ResourceRelationship:939@demo.dxtera.org",
"uri": "http://demo.dxtera.org/open/campusapi/resource/resourceRelationship/resource.ResourceRelationship%3A31415%40demo.dxtera.org",
"displayName": "Display Name of this ResourceRelationship",
"description": "The description of this ResourceRelationship",
"genusType": "type.Type:defaultResourceRelationshipType@dxtera.org",
"startDate": "2020-10-03T06:30:00.000Z",
"endDate": "2020-12-18T19:30:00.000Z",
"endReasonId": "process.State:939@demo.dxtera.org",
"sourceResourceId": "resource.Resource:284@demo.dxtera.org",
"destinationResourceId": "resource.Resource:8358@demo.dxtera.org"
},
{
"...": "..."
}
]
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
Add the given resourceRelationship to this bin
Remove the given resourceRelationship from the bin.
put /bin/{binId}/resourceRelationships/{resourceRelationshipsId}
Add the given resourceRelationship to this bin
URI Parameters
- binId: required(string)
- resourceRelationshipsId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "resourceRelationship has been added to bin" }
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": "resourceRelationship not found" }
delete /bin/{binId}/resourceRelationships/{resourceRelationshipsId}
Remove the given resourceRelationship from the bin.
URI Parameters
- binId: required(string)
- resourceRelationshipsId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "resourceRelationship 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": "resourceRelationship not found" }