Document Versions
Exists
Overview
This API endpoint is used to determine whether a specific revision of a document has been published and is available in the system. By providing the document identifier (uid) and the revision number, clients can check if that particular version of the document exists. This check is crucial for scenarios where you need to verify the presence of a specific version before performing operations such as viewing, updating, or deleting the document.
Endpoint
HEAD /api/v2013/documents/:uid/versions/:revision
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 adhere to the pattern /^[A-Za-z0-9\-_]{11,128}$/, which allows uppercase and lowercase letters, numbers, hyphens, and underscores, with a length between 11 and 128 characters. The uid ensures that each document can be uniquely identified and referenced within the system, allowing for precise document retrieval and management. |
| revision | Number | The revision number of the document, used to track changes and updates. This number must be a positive integer (1 or greater). Each revision represents a different version of the document, enabling version control and history tracking. The revision field helps in managing document updates, ensuring that users and systems can identify and work with specific versions of the document. |
Playground
Swagger playground is loading, please wait...
Get Info
Overview
The "Get Info" API endpoint retrieves detailed information about a specific revision of a document. By specifying the document identifier (uid) and the revision number, this endpoint provides metadata and other relevant details about the specified version of the document. This can include information such as the creation date, last modified date, author, document status, and any other metadata associated with that particular revision.
Endpoint
GET /api/v2013/documents/:uid/versions/:revision/info
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 adhere to the pattern /^[A-Za-z0-9\-_]{11,128}$/, which allows uppercase and lowercase letters, numbers, hyphens, and underscores, with a length between 11 and 128 characters. The uid ensures that each document can be uniquely identified and referenced within the system, allowing for precise document retrieval and management. |
| revision | Number | The revision number of the document, used to track changes and updates. This number must be a positive integer (1 or greater). Each revision represents a different version of the document, enabling version control and history tracking. The revision field helps in managing document updates, ensuring that users and systems can identify and work with specific versions of the document. |
Playground
Swagger playground is loading, please wait...
Get
Overview
The "Get" API endpoint is used to retrieve the content of a specific revision of a document. By providing the document identifier (uid) and the revision number, this endpoint allows clients to access the full content of the document for that particular version. This functionality is essential for document retrieval and viewing, enabling users to fetch and display the exact version of a document they are interested in.
Endpoint
GET /api/v2013/documents/:uid/versions/:revision
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 adhere to the pattern /^[A-Za-z0-9\-_]{11,128}$/, which allows uppercase and lowercase letters, numbers, hyphens, and underscores, with a length between 11 and 128 characters. The uid ensures that each document can be uniquely identified and referenced within the system, allowing for precise document retrieval and management. |
| revision | Number | The revision number of the document, used to track changes and updates. This number must be a positive integer (1 or greater). Each revision represents a different version of the document, enabling version control and history tracking. The revision field helps in managing document updates, ensuring that users and systems can identify and work with specific versions of the document. |
Playground
Swagger playground is loading, please wait...
List
Overview
The "List" API endpoint retrieves a list of all available revisions for a specific document. By specifying the document identifier (uid), this endpoint returns information about all the versions of the document stored in the system. This includes metadata and version details for each revision, providing a comprehensive overview of the document’s version history.
Endpoint
GET /api/v2013/documents/:uid/versions
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 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. |
Query String Parameters
The following query parameters can be used to refine the request:
| Field | Type | Description |
|---|---|---|
| filter | String | Optional. The $filter system query option enables clients to specify criteria for filtering the results of a query. This allows for retrieving only those resources that meet certain conditions or constraints. For example, you can use $filter to return only items that have a specific property value or that fall within a certain range. For detailed usage and examples, refer to the OData $filter documentation. |
| orderby | String | Optional. The $orderby system query option allows clients to sort the results of a query based on one or more properties. By specifying this option, you can control the order in which resources are returned, such as sorting by date, name, or any other attribute. This helps in organizing the results in a meaningful way according to the specified criteria. For detailed usage and examples, refer to the OData $orderby documentation. |
| top | String | Optional. The $top system query option limits the number of items returned in the result set. This is useful for pagination or for retrieving a subset of the total results, such as getting the top N records. For example, specifying $top=10 would return only the first 10 items of the queried collection. For detailed usage and examples, refer to 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 commonly used in conjunction with $top to implement pagination, where you can skip a certain number of records and then return the next set. For example, specifying $skip=20 would skip the first 20 items and return the subsequent items from the query. For detailed usage and examples, refer to the OData $skip documentation. |
Playground
Swagger playground is loading, please wait...