Document Securities
Can Create
Overview
This API endpoint allows clients to determine if a document can be created given the provided metadata. It performs a security check to verify if the document creation is permitted based on the supplied metadata. This is particularly useful for validating permissions and ensuring that the document meets all necessary requirements before attempting to create it. The endpoint evaluates security access controls and returns a response indicating whether the creation operation is authorized.
Request URL
GET /api/v2013/documents/{uid}/securities/create
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 format or schema of the document being posted. This field specifies the type and structure of the document to ensure it conforms to a predefined format or standard. It helps the system interpret and validate the incoming data correctly. The value for schema typically corresponds to a specific schema definition that outlines the required fields, data types, and constraints for the document. This ensures that the document adheres to the expected structure and is compatible with the system's processing rules. |
| metadata | Object | Optional. Contains additional information about the document that can be used to determine security access and other attributes. The metadata object can include various parameters depending on the document type and its requirements. This may encompass information such as access permissions, document classification, or other contextual data that helps manage the document effectively. The structure and content of metadata may vary based on the specific needs and configuration of the document type. |
| government | String | Optional. Specifies the government code associated with the record for national records. The value should adhere to the "ISO 3166-1 alpha-2" standard, which uses two-letter country codes to represent different countries. This field is used to assign or categorize the record under a specific national jurisdiction or government entity. For records that are not tied to a national context, this field may be omitted or left blank. |
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
Swagger playground is loading, please wait...
Can Delete
Overview
This API endpoint allows clients to check if a specific document can be deleted. It verifies whether the user has the necessary permissions to perform the delete operation on the document identified by the provided uid. This check ensures that the user is authorized to delete the document and that the operation complies with the system's security and access control policies. The endpoint helps prevent unauthorized deletion of documents by validating access rights before the actual delete operation is executed.
Endpoint
GET /api/v2013/documents/{uid}/securities/delete
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
Swagger playground is loading, please wait...
Can Update
Overview
This API endpoint allows clients to determine whether a specific document can be updated based on the provided metadata. It performs a security check to ensure that the user has the necessary permissions to update the document identified by the uid. This endpoint is crucial for validating authorization and access rights before making any changes to the document. It helps in ensuring that updates are only made if the user or system has the appropriate privileges and that the document meets all necessary conditions for the update.
Endpoint
GET /api/v2013/documents/{uid}/securities/update
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 |
|---|---|---|
| metadata | Object | Optional. Contains metadata associated with the document, which may be used for determining access controls, categorization, and other contextual information. This object can include various parameters such as access permissions, document classification levels, or other attributes relevant to security and management. The structure and content of metadata depend on the document type and its specific requirements, and it helps in managing and securing the document based on its associated metadata. |
| government | String | Optional. Represents the government or national code to which the record should be assigned. This is applicable only for records that fall under national jurisdictions. The code should conform to the "ISO 3166-1 alpha-2" standard, which uses two-letter country codes to identify countries. This field ensures that the record is categorized under the appropriate national or governmental entity, which is essential for records that are relevant to specific countries or regions. If the record does not pertain to a national context, this field may be omitted. |
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
Swagger playground is loading, please wait...