Draft Locks

Exists

Overview

The "Exists" endpoint checks whether a specific lock associated with a draft version of a document exists in the system. This endpoint is crucial for managing document locks and ensuring that only authorized operations are performed on locked documents. Locks are used to prevent concurrent modifications and ensure that the document is not edited by multiple users simultaneously.

Endpoint

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

Headers

The request must include the following headers:

Field	Type	Description
Content-Type	String	Indicates the format of the data being sent in the request body. This header specifies the media type and encoding of the request payload. The allowed value is application/json, meaning that the request body is formatted as JSON. This helps the server understand how to parse and interpret the incoming data.
Realm	String	Defines the specific context or domain within which the Clearing-House request is being made. This header determines the environment or operational scope for the request. Allowed values include abs (Access and Benefit-sharing Clearing-House), chm (Central Clearing-House Mechanism), and bch (Biosafety Clearing-House). Each value represents a different area of functionality or service.
Accept	String	Specifies the format in which the client prefers to receive the response data. This header informs the server of the desired response format to ensure compatibility with the client’s data processing. The allowed value is application/json, indicating that the client expects the response to be formatted in JSON. This ensures the response data is structured in a way that the client can properly handle and interpret.

Realm Values for Development:

• abs-dev: Represents the development environment for ABS (Access and Benefit-sharing Clearing-House). Use this value when testing or developing features related to ABS in a non-production setting.
• bch-dev: Indicates the development environment for BCH (Biosafety Clearing-House). This value is used for testing or development purposes related to BCH functionalities.
• chm-dev: Specifies the development environment for CHM (Central Clearing-House Mechanism). This realm is used when working on features or testing in the CHM context within a development environment.

URL Parameters

The following URL parameter is required:

Field	Type	Description
uid	String	A unique identifier for the document. This value is case-sensitive and must match the regular expression /^[A-Za-z0-9\-_]{11,128}$/. This means it can include uppercase and lowercase letters, numbers, hyphens, and underscores, with a length ranging from 11 to 128 characters. The uid is used to uniquely identify and retrieve a specific document, ensuring that each document can be individually referenced and managed.
lockID	String	A unique identifier for a lock associated with the document. This value is used to track and manage locks, which may be used for document access control or synchronization. The lockID helps in identifying the specific lock instance and ensuring that operations on the document are coordinated properly, preventing conflicts and ensuring consistency in access.

Playground

Swagger playground is loading, please wait...

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

Get

Overview

The "Get" endpoint retrieves information about a specific lock associated with a draft version of a document. This endpoint provides details about the lock, including its status and any associated metadata. It is useful for understanding the current state of a lock, including who holds the lock and when it was set.

Endpoint

GET /api/v2013/documents/:uid/versions/draft/locks/:lockID

Headers

The request must include the following headers:

Field	Type	Description
Content-Type	String	Indicates the format of the data being sent in the request body. This header specifies the media type and encoding of the request payload. The allowed value is application/json, meaning that the request body is formatted as JSON. This helps the server understand how to parse and interpret the incoming data.
Realm	String	Defines the specific context or domain within which the Clearing-House request is being made. This header determines the environment or operational scope for the request. Allowed values include abs (Access and Benefit-sharing Clearing-House), chm (Central Clearing-House Mechanism), and bch (Biosafety Clearing-House). Each value represents a different area of functionality or service.
Accept	String	Specifies the format in which the client prefers to receive the response data. This header informs the server of the desired response format to ensure compatibility with the client’s data processing. The allowed value is application/json, indicating that the client expects the response to be formatted in JSON. This ensures the response data is structured in a way that the client can properly handle and interpret.

Realm Values for Development:

• abs-dev: Represents the development environment for ABS (Access and Benefit-sharing Clearing-House). Use this value when testing or developing features related to ABS in a non-production setting.
• bch-dev: Indicates the development environment for BCH (Biosafety Clearing-House). This value is used for testing or development purposes related to BCH functionalities.
• chm-dev: Specifies the development environment for CHM (Central Clearing-House Mechanism). This realm is used when working on features or testing in the CHM context within a development environment.

URL Parameters

The following URL parameter is required:

Field	Type	Description
uid	String	A unique identifier for the document. This value is case-sensitive and must match the regular expression /^[A-Za-z0-9\-_]{11,128}$/. This means it can include uppercase and lowercase letters, numbers, hyphens, and underscores, with a length ranging from 11 to 128 characters. The uid is used to uniquely identify and retrieve a specific document, ensuring that each document can be individually referenced and managed.
lockID	String	A unique identifier for a lock associated with the document. This value is used to track and manage locks, which may be used for document access control or synchronization. The lockID helps in identifying the specific lock instance and ensuring that operations on the document are coordinated properly, preventing conflicts and ensuring consistency in access.

Playground

Swagger playground is loading, please wait...

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

List

Overview

The "List" endpoint retrieves a collection of locks associated with the draft version of a specific document. This endpoint is essential for managing and monitoring document locks within a draft workflow. It provides a comprehensive view of all active and relevant locks for a given document, helping users understand the current lock status and resolve any conflicts that may arise during document editing.

Endpoint

GET /api/v2013/documents/:uid/versions/draft/locks

Headers

The request must include the following headers:

Field	Type	Description
Content-Type	String	Specifies the media type of the request body. This header indicates the format of the data being sent to the server. The allowed value is application/json, which means the request body is formatted as JSON. This helps the server understand how to parse and process the incoming data.
Authorization	String	Provides the token used to authenticate the request. This header is essential for identifying and verifying the client making the request. The token should be included in the header to gain access to protected resources or services. Ensure that the token is kept secure and is valid for the requested operation.
Realm	String	Defines the specific context or environment in which the Clearing-House request is being made. The allowed values are abs, chm, and bch, each representing different operational contexts. This helps the server route the request appropriately based on the specified realm.
Accept	String	Specifies the format in which the client expects the server to return the response data. The allowed value is application/json, indicating that the client prefers the response in JSON format. This informs the server of the desired response format, ensuring that the client receives data in a readable and expected format.

Realm Values for Development:

• abs-dev: Represents the development environment for ABS (Access and Benefit-sharing Clearing-House). Use this value when testing or developing features related to ABS in a non-production setting.
• bch-dev: Indicates the development environment for BCH (Biosafety Clearing-House). This value is used for testing or development purposes related to BCH functionalities.
• chm-dev: Specifies the development environment for CHM (Central Clearing-House Mechanism). This realm is used when working on features or testing in the CHM context within a development environment.

Headers required to authenticate and define the context and format of the request and response. The Authorization header must contain a valid token, while the Content-Type and Accept headers specify the format of the document and response, respectively. Here are the steps to get the Authorization token.

URL Parameters

The following URL parameter is required:

Field	Type	Description
uid	String	A unique identifier for the document. This value is case-sensitive and must conform to the regular expression /^[A-Za-z0-9\-_]{11,128}$/. This pattern allows for a combination of uppercase and lowercase letters, numbers, hyphens, and underscores, with a length ranging from 11 to 128 characters. The uid is crucial for uniquely identifying and retrieving the document within the system, ensuring that each document can be distinctly referenced and managed. It plays a key role in operations such as fetching, updating, or deleting the document, as well as in maintaining the integrity of document management processes.

Playground

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 playgroud, please refresh the page.

Lock

Overview

The "Lock" endpoint is used to apply or update a lock on the draft version of a specific document. Locking a document prevents other users from making concurrent modifications, thus ensuring that changes are managed and synchronized effectively. This is particularly important in collaborative environments where multiple users may be working on the same document.

Endpoint

PUT /api/v2013//api/v2013/documents/:uid/versions/draft/locks/:lockID

Headers

The request must include the following headers:

Field	Type	Description
Content-Type	String	Specifies the media type of the request body. This header indicates the format of the data being sent to the server. The allowed value is application/json, which means the request body is formatted as JSON. This helps the server understand how to parse and process the incoming data.
Authorization	String	Provides the token used to authenticate the request. This header is essential for identifying and verifying the client making the request. The token should be included in the header to gain access to protected resources or services. Ensure that the token is kept secure and is valid for the requested operation.
Realm	String	Defines the specific context or environment in which the Clearing-House request is being made. The allowed values are abs, chm, and bch, each representing different operational contexts. This helps the server route the request appropriately based on the specified realm.
Accept	String	Specifies the format in which the client expects the server to return the response data. The allowed value is application/json, indicating that the client prefers the response in JSON format. This informs the server of the desired response format, ensuring that the client receives data in a readable and expected format.

Realm Values for Development:

• abs-dev: Represents the development environment for ABS (Access and Benefit-sharing Clearing-House). Use this value when testing or developing features related to ABS in a non-production setting.
• bch-dev: Indicates the development environment for BCH (Biosafety Clearing-House). This value is used for testing or development purposes related to BCH functionalities.
• chm-dev: Specifies the development environment for CHM (Central Clearing-House Mechanism). This realm is used when working on features or testing in the CHM context within a development environment.

Headers required to authenticate and define the context and format of the request and response. The Authorization header must contain a valid token, while the Content-Type and Accept headers specify the format of the document and response, respectively. Here are the steps to get the Authorization token.

URL Parameters

The following URL parameter is required:

Field	Type	Description
uid	String	A unique identifier for the document. This value is case-sensitive and must match the regular expression /^[A-Za-z0-9\-_]{11,128}$/. This means it can include uppercase and lowercase letters, numbers, hyphens, and underscores, with a length ranging from 11 to 128 characters. The uid is used to uniquely identify and retrieve a specific document, ensuring that each document can be individually referenced and managed.
lockID	String	A unique identifier for a lock associated with the document. This value is used to track and manage locks, which may be used for document access control or synchronization. The lockID helps in identifying the specific lock instance and ensuring that operations on the document are coordinated properly, preventing conflicts and ensuring consistency in access.

Playground

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 playgroud, please refresh the page.

Unlock

Overview

The "Unlock" endpoint is used to remove or release a lock from the draft version of a specific document. This operation is essential for managing document access and ensuring that locks on documents are properly released when they are no longer needed. By unlocking a document, you allow other users to gain access and make changes to the draft version.

Endpoint

DELETE /api/v2013//api/v2013/documents/:uid/versions/draft/locks/:lockID

Headers

The request must include the following headers:

Field	Type	Description
Content-Type	String	Specifies the media type of the request body. This header indicates the format of the data being sent to the server. The allowed value is application/json, which means the request body is formatted as JSON. This helps the server understand how to parse and process the incoming data.
Authorization	String	Provides the token used to authenticate the request. This header is essential for identifying and verifying the client making the request. The token should be included in the header to gain access to protected resources or services. Ensure that the token is kept secure and is valid for the requested operation.
Realm	String	Defines the specific context or environment in which the Clearing-House request is being made. The allowed values are abs, chm, and bch, each representing different operational contexts. This helps the server route the request appropriately based on the specified realm.
Accept	String	Specifies the format in which the client expects the server to return the response data. The allowed value is application/json, indicating that the client prefers the response in JSON format. This informs the server of the desired response format, ensuring that the client receives data in a readable and expected format.

Realm Values for Development:

• abs-dev: Represents the development environment for ABS (Access and Benefit-sharing Clearing-House). Use this value when testing or developing features related to ABS in a non-production setting.
• bch-dev: Indicates the development environment for BCH (Biosafety Clearing-House). This value is used for testing or development purposes related to BCH functionalities.
• chm-dev: Specifies the development environment for CHM (Central Clearing-House Mechanism). This realm is used when working on features or testing in the CHM context within a development environment.

Headers required to authenticate and define the context and format of the request and response. The Authorization header must contain a valid token, while the Content-Type and Accept headers specify the format of the document and response, respectively. Here are the steps to get the Authorization token.

URL Parameters

The following URL parameter is required:

Field	Type	Description
uid	String	A unique identifier for the document. This value is case-sensitive and must match the regular expression /^[A-Za-z0-9\-_]{11,128}$/. This means it can include uppercase and lowercase letters, numbers, hyphens, and underscores, with a length ranging from 11 to 128 characters. The uid is used to uniquely identify and retrieve a specific document, ensuring that each document can be individually referenced and managed.
lockID	String	A unique identifier for a lock associated with the document. This value is used to track and manage locks, which may be used for document access control or synchronization. The lockID helps in identifying the specific lock instance and ensuring that operations on the document are coordinated properly, preventing conflicts and ensuring consistency in access.

Playground

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 playgroud, please refresh the page.