Checkpoint Communique - Update

Overview

Updates an existing Checkpoint Communique record in the ABS Clearing-House and re-runs the publishing workflow — identifier check, securities, validation, draft and workflow — in a single call.

Endpoint

PUT /api/v2023/documents/schemas/absCheckpointCommunique/:identifier

Headers

Header	Required	Description
Content-Type	Yes	Media type of the request body. The allowed value is application/json.
Authorization	Yes	Bearer token authenticating the request (Bearer <token>). Obtain it from the User - Authentication endpoint.
Accept	No	Format the client expects in the response. The allowed value is application/json.
Realm	No	The Clearing-House context. May be sent here instead of the realm query parameter.

Path Parameters

Parameter	Description
schema	The record type being updated: absCheckpointCommunique.
identifier	The record's unique identifier. Must match the document's header.identifier.

Query Parameters

Parameter	Required	Description
realm	Yes	The Clearing-House context. For this application and environment: abs. May alternatively be sent as the Realm HTTP header.

Request Body

The request body is a JSON object with three top-level fields:

Field	Type	Required	Description
document	Object	Yes	The record itself — the fields listed below, wrapped in a document object (its header plus the record-type fields).
additionalInfo	String	No	Up to 1000 characters. Available only when a user with the NAU role submits a request to the Publishing Authority (PA) to publish a record.
batchId	String	No	Up to 100 characters. Batches multiple records together for publishing.

The fields of the document object are below.

Title	Field	Mandatory	Type	Example
	header		Header	{ "identifier": "068C83BA-995F-08C3-50CE-AD43545B3EB5", "schema": "absCheckpointCommunique", "languages": ["en"] }
Title of this checkpoint communique	title	True	lstring	{"en":"Test Title"}
Country issuing this checkpoint communique	government	True	Term	{"identifier":"af"}
Links to internationally recognized certificate(s) of compliance (IRCC) that relate to this communique	absIRCCs	True	Reference[]	[{"identifier":"CB51626B-CF45-2AA0-3A24-459669DDCC34@1"}]
Checkpoint/s that collected or received the information	absCheckpoints	True	Reference[]	[{"identifier":"3E387C20-E70C-997B-EABB-BC4C9A1E142F@1"}]
The internationally recognized certificate of compliance (IRCC) is not available	absIRCCsNotAvailable		Boolean	true
Source of the genetic resource	sourceCountries		Term[]	[{"identifier":"af"}]
Person or entity who granted prior informed consent (PIC)	entityWhoGrantedPIC		Reference	{"identifier":"DECLARE-ORGANISATION_19584_20241007134350919@1"}
Subject-matter or genetic resources relevant to the information collected or received	subjectMatter		lstring	{"en":"<div><!--block-->Test Info</div>"}
Specimen data	specimens		Link[]	[{"url":"https://www.google.com","name":"Google","language":"en"}]
Taxonomy	taxonomies		Link[]	[{"url":"https://www.google.com","name":"Google","language":"en"}]
Geographic coordinates	gisFiles		Link[]	[{"url":"/api/v2013/documents/63B9CA56-9D43-E877-2A96-2C95986522D5/attachments/615856/test.json","name":"test.json","tag":"Test Tag","language":"en"}]
	gisMapCenter		MapLocation
Person or entity making information available to the checkpoint on the utilization of the genetic resource	personsAtCheckpoint		Reference[]	[{"identifier":"DECLARE-ORGANISATION_19584_20241007134350919@1"}]
Reference or evidence of prior informed consent (PIC)	evidenceOfPIC		lstring	{"en":"<div><!--block-->Test Info</div>"}
Reference or evidence of establishment of mutually agreed terms (MAT)	evidenceOfMAT		lstring	{"en":"<div><!--block-->Test Info</div>"}
Person or entity to whom prior informed consent (PIC) was granted	entityToWhomPICGranted		Reference	{"identifier":"DECLARE-ORGANISATION_19584_20241007134350919@1"}
Short description of the information collected or received by the checkpoint relevant to the utilization of genetic resources, including the type of use	description	True	lstring	{"en":"<div><!--block-->Test Info</div>"}
Date of access to the genetic resources	dateOfAccess		DateTime
Date on which the information was collected or received at the checkpoint	dateCollected		DateTime
FROM	dateCollectedFrom		DateTime
TO	dateCollectedTo		DateTime
Additional Information	relevantInformation		lstring	{"en":"<div><!--block-->Test Info</div>"}
Other relevant website addresses and/or attached documents	relevantDocuments		Link[]	[{"url":"https://www.google.com","name":"Google","language":"en"}]
Keywords to describe the subject-matter or genetic resource(s) covered by the permit or its equivalent	keywords		Term[]	[{"identifier":"term-id-1"},{"identifier":"term-id-2"}]
Other keywords	keywordOther		lstring	{"en":"Test Keywords"}

Response

A successful call returns the saved draft and the publishing workflow that was started. Validation failures also return HTTP 200, with an errors array in the body instead — always check the response body, not just the status code.

When the document fails validation, the issues are returned in the errors property of the response (with HTTP 200). Each entry names the error code and the property it applies to:

{
  "identifier": "DECLARE-ORGANISATION_5885_20241031144831187",
  "errors": [
    { "code": "Error.Mandatory", "property": "government" }
  ]
}

Error Type	Description
Error.Mandatory	A required field is missing.
Error.MandatoryAnyOf	At least one field from a set of mandatory fields is missing.
Error.InvalidValue	The provided value is not valid according to the schema.
Error.InvalidProperty	An invalid property or field name.
Error.UnspecifiedLocale	A locale or language code is missing or invalid.
Error.UnexpectedTerm	An unexpected term or parameter.
Error.InvalidType	The provided data type is not valid.

Errors

The following error conditions may occur while interacting with the API. Each entry describes a specific error status code, along with an error message explaining the issue and any additional requirements for successful execution.

Status Code	Description
400	realm param is missing, please provide valid realm in querystring or httpHeaders.
400	Realm is not configured, please provide valid realm.
400	Schema not configured for the given realm.
400	A document with the identifier exists, please use a different identifier.
400	A document with the identifier does not exist, please provide correct identifier to update.
400	The record is locked for workflow, cannot proceed.
403	Insufficient rights to create a draft record.
403	Insufficient rights to update the draft record.
403	Authorization required, user is anonymous.

Playground

This playground connects to the production environment (api.cbd.int). Requests made here affect real, live data.

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.

Legacy alternative. Publishing through the legacy v2013 API uses the Save Draft endpoint plus a workflow call; new integrations should use this single v2023 call instead. The record's other draft operations (drafts, locks, securities, validation, versions) are documented under Draft Operations.