Auto-projection rules¶
Working with automatic projection rules¶
Create an automatic projection rule¶
- PUT /auto-projection/(name)¶
Creates a new projection rule based on the information in the AutoProjectionRuleDocument.
Accepts: - application/xml, application/json – AutoProjectionRuleDocument
Produces: - application/xml, application/json – AutoProjectionRuleDocument
Role: _auto_projection_write
Example¶
PUT /auto-projection/testProjection
Content-Type: application/xml
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<AutoProjectionRuleDocument xmlns="http://xml.vidispine.com/schema/vidispine">
<step>
<order>1</order>
<description>step1 description</description>
<script>...</script>
</step>
<step>
<order>2</order>
<description>step2 description</description>
<script>...</script>
</step>
<description>rule description</description>
<inputFilters>
<inputFilter>oldMetadata</inputFilter>
<inputFilter>shapeDocument</inputFilter>
<bulkyMetadataKeysRegex>.*</bulkyMetadataKeysRegex>
</inputFilters>
<triggers>
<trigger>itemMetadata</trigger>
<trigger>shapeMetadata</trigger>
</triggers>
</AutoProjectionRuleDocument>
Delete an automatic projection rule¶
- DELETE /auto-projection/(name)¶
Role: _auto_projection_write
Disable an automatic projection rule¶
- PUT /auto-projection/(name)/disable¶
Role: _auto_projection_write
Enable an automatic projection rule¶
- PUT /auto-projection/(name)/enable¶
Role: _auto_projection_write
Retrieve all disabled automatic projection rules¶
- GET /auto-projection/disable¶
Role: _auto_projection_read
Retrieve all enabled automatic projection rules¶
- GET /auto-projection/enable¶
Role: _auto_projection_read
Retrieve all automatic projection rules¶
- GET /auto-projection¶
Role: _auto_projection_read