Metadata projections¶
Get information about projections¶
Get list of projections¶
- GET /projection¶
Returns a list of all defined projections.
Query Parameters: - url –
- true - Return list of URLs.
- false (default) - Return list of ids.
Produces: - application/xml, application/json – URIListDocument
- text/plain – CRLF-delimited list of ids or URLs
Role: _projection_read
- url –
Get outgoing projection¶
- GET /projection/(projection-id)/outgoing¶
Returns the projection use to transform information from the Vidispine API, GET metadata.
Status Codes: - 404 Not found – Could not find the projection identified by projection-id.
Produces: - application/xml – XML, XSLT stylesheet
Role: _projection_read
Get incoming projection¶
- GET /projection/(projection-id)/incoming¶
Returns the projection use to transform information to the Vidispine API, PUT metadata.
Status Codes: - 404 Not found – Could not find the projection identified by projection-id.
Produces: - application/xml – XML, XSLT stylesheet
Role: _projection_read
Create/modify/delete projections¶
Note
Please note that the projection result must be an valid XML document.
Create projection/set outgoing projection¶
- PUT /projection/(projection-id)/outgoing¶
Creates a new projection if not defined earlier, and sets the outgoing projection to the specified stylesheet. If a new projection is created, the incoming transformation is set to be the identity transform.
Accepts: - application/xml – XML, XSLT stylesheet
Produces: - application/xml – XML, XSLT stylesheet
Role: _projection_write
Create projection/set incoming projection¶
- PUT /projection/(projection-id)/incoming¶
Creates a new projection if not defined earlier, and sets the incoming projection to the specified stylesheet. If a new projection is created, the outgoing transformation is set to be the identity transform.
Accepts: - application/xml – XML, XSLT stylesheet
Produces: - application/xml – XML, XSLT stylesheet
Role: _projection_write
Remove projection¶
- DELETE /projection/(projection-id)¶
Removes the projection.
Status Codes: - 200 OK – The projection was deleted successfully.
- 404 Not found – Could not find the projection identified by projection-id.
Role: _projection_write