Metadata locks [VC 21.3 GEN]

New in version 4.17: Collection metadata support

A locking container is a stateful resource that holds locks for any number of fields of the metadata of an item or collection.

Operations on metadata locks uses {metadata-resource} which is either of

List all locking containers

GET {metadata-resource}/(id)/metadata-lock

Returns all locking containers.

Produces:	application/xml, application/json – MetadataLockListDocument text/plain – CRLF-delimited list of locking ids
Role:	_metadata_lock_read

GET {metadata-resource}/(id)/metadata-lock/(lock-id)

Returns information about specified locking container.

Produces:	application/xml, application/json – MetadataLockDocument
Role:	_metadata_lock_read

POST {metadata-resource}/(id)/metadata-lock

Creates a new locking container, optionally with initial locks.

Query Parameters:	field (string) – Comma-separated list of fields to lock. timeout (integer) – Time-out in seconds. Default is `60`.
Produces:	application/xml, application/json – MetadataLockDocument text/plain – Locking id
Role:	_metadata_lock_write

PUT {metadata-resource}/(id)/metadata-lock/(lock-id)

Add new fields to the locking container and/or updates the expiry time.

Query Parameters:	field (string) – Comma-separated list of fields to lock. timeout (integer) – Time-out in seconds. Default is `60`.
Produces:	application/xml, application/json – MetadataLockDocument text/plain – Locking id
Role:	_metadata_lock_write

DELETE {metadata-resource}/(id)/metadata-lock/(lock-id)

Remove the locking container and all locks associated with it.

Role:

_metadata_lock_write