Metadata locks¶
A locking container is a stateful resource that holds locks for any number of fields of the metadata of an item.
Get all containers¶
-
GET
/item/
(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 specific container¶
-
GET
/item/
(id)/metadata-lock/
(lock-id)¶ Returns information about specified locking container.
Produces: - application/xml, application/json – MetadataLockDocument
Role: _metadata_lock_read
Create locking container¶
-
POST
/item/
(id)/metadata-lock
¶ Creates a new locking container, optionally with initial locks.
Query Parameters: - field – Optional comma-separated list of fields to lock.
- timeout – Optional integer for time-out in seconds. Default is no time-out.
Produces: - application/xml, application/json – MetadataLockDocument
- text/plain – Locking id
Role: _metadata_lock_write
Add fields to locking container¶
-
PUT
/item/
(id)/metadata-lock/
(lock-id)¶ Add new fields to the locking container and/or updates the expiry time.
Query Parameters: - field – Optional comma-separated list of fields to lock.
- timeout – Optional integer for time-out in seconds. Default is no time-out.
Produces: - application/xml, application/json – MetadataLockDocument
- text/plain – Locking id
Role: _metadata_lock_write