Stakeholder Commitment - Delete

Overview

This endpoint is used to delete a specific document from the system using its unique identifier (uid). This operation removes the document from the database and can be useful for managing and maintaining the document repository, ensuring that outdated or irrelevant documents are removed as needed.

Endpoint

DELETE /api/v2013/documents/:uid

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.

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.

Realm Values:

Applications	Development Realm	Production Realm
Online Reporting Tool	ort-dev	ort

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 record being posted. This field specifies the type of record 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 record 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 record.

URL Parameters

The following URL parameter is required:

Field	Type	Description
uid	String	A unique identifier for the record. 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 record within the system, ensuring that each record can be distinctly referenced and managed. It plays a key role in operations such as fetching, updating, or deleting the record, as well as in maintaining the integrity of record management processes.

Environment URLs

This API has two different endpoints for production and development environments. Use the appropriate endpoint based on your current environment.

• PROD Endpoint: https://api.cbd.int/

  • This endpoint is used for accessing the production environment of the API. Use this endpoint for all live, real-world applications where you need to interact with the actual production data.

• DEV Endpoint: https://api.cbddev.xyz/

  • This endpoint is for the development environment. Use this for testing, development, and staging purposes. It allows you to safely test your applications without affecting the live production data.

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