Drafts

Delete

Overview

The "Delete" API endpoint allows clients to remove a draft version of a document from the system. This endpoint is used when a draft document needs to be deleted before it is finalized or published. It ensures that only draft versions, which are in the process of being created or reviewed, are deleted, while finalized or published versions remain intact.

Endpoint

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

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.

Exists

Overview

The "Exists" API endpoint checks whether a draft version of a document exists in the system based on the provided document identifier (uid). This endpoint allows clients to verify the presence of a draft version without retrieving its full content. It is particularly useful for determining if a draft document is available before attempting further operations such as updates or deletions.

Endpoint

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

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.

Get Info

Overview

The "Get Info" API endpoint retrieves detailed information about the draft version of a document based on the provided document identifier (uid). This endpoint provides metadata and other relevant details about the draft version, which can be useful for reviewing the document's status, checking its attributes, or preparing for further actions such as updates or finalizations.

Endpoint

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

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.

Get

Overview

The "Get" API endpoint retrieves the draft version of a document based on the provided document identifier (uid). This endpoint is used to fetch the full content of the draft version, which includes all its details and attributes. It is particularly useful for reviewing or working with the draft before making any updates or finalizing the document.

Endpoint

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

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.

List

Overview

The "List" API endpoint retrieves a paginated list of document drafts based on the provided query parameters. This endpoint allows clients to obtain a comprehensive overview of all drafts associated with the user's account or specified collection. It supports filtering, sorting, and pagination to manage and view a large number of drafts efficiently.

Endpoint

GET /api/v2013/document-drafts

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.

Query Parameters

The following query parameters can be used to refine the request:

Field	Type	Description
collection	String	Optional. Specifies the collection or category of resources to query. This option allows clients to target specific sets of resources. The allowed values are my for a personal collection and mydrafts for draft items or documents. This helps in narrowing down the search to particular subsets of resources based on their classification or status.
$filter	String	Optional. The $filter system query option allows clients to apply conditions to filter the results of a query. By using $filter, clients can retrieve only those resources that meet specific criteria, such as matching certain values or falling within a certain range. For detailed usage and examples, see the OData $filter documentation.
$orderby	String	Optional. The $orderby system query option allows clients to specify the order in which resources should be returned. This enables sorting of results based on one or more properties, such as sorting by date, name, or other attributes. The specified sorting order helps in organizing the results in a meaningful way. For detailed usage and examples, see the OData $orderby documentation.
$top	String	Optional. The $top system query option limits the number of items returned in the query result. This is useful for controlling the size of the result set, particularly for pagination or for retrieving a specific subset of items. For example, setting $top=10 would return only the top 10 items from the query result. For detailed usage and examples, see the OData $top documentation.
$skip	String	Optional. The $skip system query option specifies the number of items to be skipped from the beginning of the result set. This is often used in combination with $top to implement pagination, where $skip determines how many items to ignore before starting to include results. For example, setting $skip=20 would skip the first 20 items and start returning results from the 21st item onward. For detailed usage and examples, see the OData $skip documentation.

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.

Save

Overview

The "Save" API endpoint is used to update or create a draft version of a document in the system. This endpoint allows clients to submit the latest changes or create a new draft for a specified document by providing the document's unique identifier (uid). This operation is crucial for managing document versions, allowing users to save changes to a draft before finalizing or publishing the document.

Endpoint

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

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.

Query Parameters

The following query parameters can be used to refine the request:

Field	Type	Description
schema	String	Defines the schema or format of the document being posted. This field specifies the type of document and the structure it adheres to. The schema value helps the system understand how to interpret and validate the incoming data. It ensures that the document conforms to a predefined format or standard, facilitating consistency and compatibility across different parts of the system. The schema value typically corresponds to a specific schema definition or type that dictates the required fields, data types, and constraints for the document.

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.