Draft Locks

A draft is locked while a workflow runs against it. These endpoints inspect and manage those locks.

Lock a draft

PUT/api/v2013/documents/{uid}/versions/draft/locks/{lockID}

This playground connects to the production environment (api.cbd.int). Requests made here affect real, live data.

This is a protected route. To access this content, you need to be logged in. Logging in will provide you with an authentication token, which is required for making API calls.

Swagger playground is loading, please wait...

An error occurred while loading Swagger playground, please refresh the page.

Unlock a draft

DELETE/api/v2013/documents/{uid}/versions/draft/locks/{lockID}

This playground connects to the production environment (api.cbd.int). Requests made here affect real, live data.

This is a protected route. To access this content, you need to be logged in. Logging in will provide you with an authentication token, which is required for making API calls.

Swagger playground is loading, please wait...

An error occurred while loading Swagger playground, please refresh the page.

Get a draft lock

GET/api/v2013/documents/{uid}/versions/draft/locks/{lockID}

This playground connects to the production environment (api.cbd.int). Requests made here affect real, live data.

Swagger playground is loading, please wait...

An error occurred while loading Swagger playground, please refresh the page.

List draft locks

GET/api/v2013/documents/{uid}/versions/draft/locks

This playground connects to the production environment (api.cbd.int). Requests made here affect real, live data.

This is a protected route. To access this content, you need to be logged in. Logging in will provide you with an authentication token, which is required for making API calls.

Swagger playground is loading, please wait...

An error occurred while loading Swagger playground, please refresh the page.

Check a draft lock exists

HEAD/api/v2013/documents/{uid}/versions/draft/locks/{lockID}

This playground connects to the production environment (api.cbd.int). Requests made here affect real, live data.

Swagger playground is loading, please wait...

An error occurred while loading Swagger playground, please refresh the page.