Resources¶
Manage external resources, such as transcoders or Vidinet services.
Resource types¶
List all 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/
{ type })
Role: _resource_read
Resources¶
List all resources¶
-
GET
/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/
{ type }/
{ resource-id })
Role: _resource_read
Create a resource¶
-
POST
/resource
¶ -
POST
/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 a resource¶
-
PUT
/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.
Retrieve a resource¶
-
GET
/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 a resource¶
-
DELETE
/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.
Resource status¶
View resource status¶
-
GET
/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
Resource configuration¶
Pre-check configuration¶
-
GET
/resource/
(type)/
(resource-id)/configuration/pre-check
¶ New in version 21.3.
Perform a pre-check configuration of this resource. Only possible for VidiNet resources.
Query Parameters: - displayData (boolean) –
true
- Include detailed data of what will be changed during configuration.false
(default) - Do not include detailed data.
Produces: - application/xml, application/json – ServiceConfigurationResultDocument
Role: _administrator
- displayData (boolean) –
Apply configuration¶
-
PUT
/resource/
(type)/
(resource-id)/configuration
¶ New in version 21.3.
Apply configuration for this resource. Only possible for VidiNet resources.
Query Parameters: - displayData (boolean) –
true
- Include detailed data of what will be changed during configuration.false
(default) - Do not include detailed data.
Produces: - application/xml, application/json – ServiceConfigurationResultDocument
Role: _administrator
- displayData (boolean) –