Auto-projection rules¶
Automatic projection rules.
- Working with automatic projection rules
- List all automatic projection rules
- List all disabled automatic projection rules
- List all enabled automatic projection rules
- Retrieve an automatic projection rule
- Create an automatic projection rule
- Delete an automatic projection rule
- Disable an automatic projection rule
- Enable an automatic projection rule
Working with automatic projection rules¶
List all automatic projection rules¶
-
GET
/auto-projection
¶ Retrieves all automatic projection rules.
Produces: - application/xml, application/json – URIListDocument
- text/plain – CRLF-delimited list of names
Role: _auto_projection_read
List all disabled automatic projection rules¶
-
GET
/auto-projection/disable
¶ Retrieves all disabled automatic projection rules.
Produces: - application/xml, application/json – URIListDocument
- text/plain – CRLF-delimited list of names
Role: _auto_projection_read
List all enabled automatic projection rules¶
-
GET
/auto-projection/enable
¶ Retrieves all enabled automatic projection rules.
Produces: - application/xml, application/json – URIListDocument
- text/plain – CRLF-delimited list of names
Role: _auto_projection_read
Retrieve an automatic projection rule¶
-
GET
/auto-projection/
(name)¶ Retrieves a specific projection rule.
Produces: - application/xml, application/json – AutoProjectionRuleDocument
Role: _auto_projection_read
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
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)¶ Deletes the automatic projection rule.
Role: _auto_projection_write
Disable an automatic projection rule¶
-
PUT
/auto-projection/
(name)/disable
¶ Disables the automatic projection rule.
Role: _auto_projection_write
Enable an automatic projection rule¶
-
PUT
/auto-projection/
(name)/enable
¶ Enables the automatic projection rule.
Role: _auto_projection_write