Sites¶
Managing sites¶
Retrieve configured sites¶
- GET /site¶
Retrieves the ids of the sites that have been configured.
Query Parameters: - type –
- all (default) - Return the ids of all added sites.
- current - Return the id of the current site.
Produces: - application/xml, application/json – URIListDocument
- type –
Add a new site¶
- PUT /site/(site-id)¶
Accepts: - application/xml, application/json – SiteDefinitionDocument
Produces: - application/xml, application/json – SiteDefinitionDocument
Example¶
PUT /site/VY
Content-Type: application/xml
<SiteDefinitionDocument xmlns="http://xml.vidispine.com/schema/vidispine">
<url>http://10.1.2.3:8080/API/</url>
<username>site-manager</username>
<password>p4ssw0rd</password>
<syncPolicy>ONDEMAND</syncPolicy>
</SiteDefinitionDocument>
The only supported value for syncPolicy is currently ONDEMAND.
Retrieve a site¶
- GET /site/(site-id)¶
Retrieves the definition for a specific site.
Produces: - application/xml, application/json – SiteDefinitionDocument
Role: _site_manager