Metadata field access controls [VC 21.3 GEN]

Field access controls can be used to control who is able to view and edit certain metadata fields in the metadata of items and collections.

In the following reference, {field-access-resource} is one of the following:

/metadata-field/{field-name}/access
/metadata-field/field-group/{group-name}/access

Managing metadata field access controls

Retrieve an access control list

GET {field-access-resource} Returns the access control list that is applied to the specified field or group. Produces: application/xml, application/json – MetadataFieldAccessControlListDocument Role: _administrator

Example

GET /metadata-field/title/access

<MetadataFieldAccessControlListDocument xmlns="http://xml.vidispine.com/schema/vidispine">
  <access>
    <id>VX-10</id>
    <field>title</field>
    <group>mygroup</group>
    <permission>READ</permission>
  </access>
  <access>
    <id>VX-5</id>
    <field>title</field>
    <user>myuser</user>
    <permission>DELETE</permission>
  </access>
</MetadataFieldAccessControlListDocument>

Create an access control entry

POST {field-access-resource} Creates an entry in the access control list and returns the created entry together with its id. Accepts: application/xml, application/json – MetadataFieldAccessControlDocument Produces: application/xml, application/json – MetadataFieldAccessControlDocument Role: _administrator

Examples

POST /metadata-field/title/access
Content-Type: application/xml

<MetadataFieldAccessControlDocument xmlns="http://xml.vidispine.com/schema/vidispine">
    <user>admin</user>
    <permission>DELETE</permission>
</MetadataFieldAccessControlDocument>

<MetadataFieldAccessControlDocument xmlns="http://xml.vidispine.com/schema/vidispine">
    <id>VX-11</id>
    <user>admin</user>
    <permission>DELETE</permission>
</MetadataFieldAccessControlDocument>

Delete an access control entry

DELETE {field-access-resource}/(access-id) Removes the access control entry with the specified id. Role: _administrator

Examples

DELETE /metadata-field/title/access/VX-11

200 OK