Import settings¶
Managing import settings¶
Create a new settings profile¶
-
POST
/import/settings
¶ Creates a new settings profile with the given settings.
Accepts: - application/xml, application/json – An ImportSettingsDocument containing the settings profile.
Produces: - application/xml, application/json – An ImportSettingsDocument containing the the settings profile together with its id.
Role: _import
Example¶
POST /import/settings
Content-Type: application/xml
<ImportSettingsDocument xmlns="http://xml.vidispine.com/schema/vidispine">
<access>
<permission>READ</permission>
<user>myuser</user>
</access>
</ImportSettingsDocument>
<ImportSettingsDocument xmlns="http://xml.vidispine.com/schema/vidispine">
<id>VX-4</id>
<access>
<permission>READ</permission>
<user>myuser</user>
</access>
</ImportSettingsDocument>
List the ids of all profiles¶
-
GET
/import/settings
¶ Retrieves a list of all profiles.
Produces: - application/xml, application/json – A URIListDocument containing the ids of all profiles.
- text/plain – CRLF-delimited list of ids
Role: _import
Example¶
GET /import/settings
<URIListDocument xmlns="http://xml.vidispine.com/schema/vidispine">
<uri>VX-1</uri>
<uri>VX-2</uri>
<uri>VX-3</uri>
<uri>VX-4</uri>
</URIListDocument>
Retrieve a specific settings profile¶
-
GET
/import/settings/
(settings-id)¶ Retrieves the settings specified by a certain profile.
Produces: - application/xml, application/json – An ImportSettingsDocument containing the settings of the profile.
Role: _import
Example¶
GET /import/settings/VX-4
<ImportSettingsDocument xmlns="http://xml.vidispine.com/schema/vidispine">
<id>VX-4</id>
<access>
<permission>READ</permission>
<user>myuser</user>
</access>
</ImportSettingsDocument>
Change the settings of a profile¶
-
PUT
/import/settings/
(settings-id)¶ Changes the settings of the specified profile.
Accepts: - application/xml, application/json – An ImportSettingsDocument with the new settings.
Role: _import
Example¶
PUT /import/settings/VX-4
Content-Type: application/xml
<ImportSettingsDocument xmlns="http://xml.vidispine.com/schema/vidispine">
<access>
<permission>WRITE</permission>
<user>myuser</user>
</access>
</ImportSettingsDocument>
200 OK