Resources¶
Resource types¶
Retrieve list of resource types¶
-
GET
/resource
¶ Retrieves the available resource types.
Produces: - application/xml, application/json – ResourceTypeListDocument
- text/plain – CRLF-delimited list of resource type URLs (
/resource/
{ resource-type })
Role: _resource_read
Resources¶
Retrieve list of resources¶
-
GET
/resource/
(resource-type)¶ Retrieves the resources of the given type that have been configured.
Produces: - application/xml, application/json – ResourceListDocument
- text/plain – CRLF-delimited list of resource URLs (
/resource/
{ resource-type }/
{ resource-id })
Role: _resource_read
Create resources¶
-
POST
/resource
¶ -
POST
/resource/
(resource-type)¶ Create a new resource.
Accepts: - application/xml, application/json – ResourceDocument
Produces: - application/xml, application/json – ResourceDocument
- text/plain – Resource URL
Role: _resource_write
Modify resource¶
-
PUT
/resource/
(resource-type)/
(resource-id)¶ Updates an existing resource.
Accepts: - application/xml, application/json – ResourceDocument
Produces: - application/xml, application/json – ResourceDocument
- text/plain – Resource URL
Role: _resource_write
Status Codes: - 400 Invalid Input – The resource type is not correct.
Get resource¶
-
GET
/resource/
(resource-type)/
(resource-id)¶ Retrieves information on a specific resource.
Produces: - application/xml, application/json – ResourceDocument
Role: _resource_read
Status Codes: - 400 Invalid Input – The resource type is not correct.
Delete resource¶
-
DELETE
/resource/
(resource-type)/
(resource-id)¶ Deletes the resource. All connection from other resources to the resource will become invalid.
Role: _resource_write
Status Codes: - 400 Invalid Input – The resource type is not correct.
Changed in version 4.10: It is now validated that the resource type matches the type of the resource.
Resource status¶
Get resource status¶
-
GET
/resource/
(resource-type)/
(resource-id)/status
¶ Retrieves the status of a specific resource.
Produces: - text/plain – Status string
Status Codes: - 400 – If the resource does not have a status.
Role: _resource_read