Site rules¶
Managing site rules¶
In the following reference, {site-rule-entity}
is one of the following:
/item
/item/{item-id}
/collection
/collection/{collection-id}
/library
/library/{library-id}
/user
/user/{username}
/group
/group/{group-name}
Retrieve site rules for a specific entity¶
-
GET
{site-rule-entity}/site-rule
¶ Retrieves all site rules for the given entity/entities.
Produces: - application/xml, application/json – SiteRuleListDocument
Role: _site_rule_read
Example¶
GET /item/VX-62/site-rule
<SiteRuleListDocument xmlns="http://xml.vidispine.com/schema/vidispine">
<siteRule>
<site>VY</site>
<metadata>true</metadata>
<access>true</access>
<shape>original</shape>
</siteRule>
<siteRule>
<site>VZ</site>
<metadata>true</metadata>
<access>true</access>
<shape>lowres</shape>
<shape>original</shape>
</siteRule>
</SiteRuleListDocument>
Create a site rule¶
-
POST
{site-rule-entity}/site-rule/
¶ Creates a new site rule for an entity.
Status Codes: - 200 OK – Rule set successfully.
- 400 Bad request – The request was malformed.
- 404 Not found – Could not find the specified entity.
Accepts: - application/xml, application/json – SiteRuleDocument
Produces: - application/xml, application/json – SiteRuleDocument
Role: _site_rule_write
Example¶
POST /item/VX-67/site-rule/
Content-Type: application/xml
<SiteRuleDocument xmlns="http://xml.vidispine.com/schema/vidispine">
<site>VY</site>
<metadata>true</metadata>
<access>true</access>
<shape>original</shape>
<shape>lowres</shape>
</SiteRuleDocument>
Set the site rule for users.
POST /user/site-rule/
Content-Type: application/xml
<SiteRuleDocument xmlns="http://xml.vidispine.com/schema/vidispine">
<site>VY</site>
</SiteRuleDocument>
Set the site rule for groups. Setting a generic site rule for groups will also enable syncing of all users.
POST /group/site-rule/
Content-Type: application/xml
<SiteRuleDocument xmlns="http://xml.vidispine.com/schema/vidispine">
<site>VY</site>
</SiteRuleDocument>
Retrieve a site rule¶
-
GET
{site-rule-entity}/site-rule/
(id)¶ Retrieves a specific site rule.
Produces: - application/xml, application/json – SiteRuleDocument
Role: _site_rule_read
Update a site rule¶
-
PUT
{site-rule-entity}/site-rule/
(id)¶ Updates a site rule.
Status Codes: - 200 OK – Rule set successfully.
- 400 Bad request – The request was malformed.
- 404 Not found – Could not find the specified rule.
Accepts: - application/xml, application/json – SiteRuleDocument
Produces: - application/xml, application/json – SiteRuleDocument
Role: _site_rule_write