Schema for CPP
This section provides an overview of the schemas related to the Community Protocols and Procedures and Customary Laws (CPP). Each schema details the structure and fields required for the CP-related requests and responses.
NOTE
When making an API request using the Community Protocols and Procedures and Customary Laws (CPP) schema, it is crucial to include the correct schema identifier. The schema parameter must be set to "communityProtocol" to ensure that the request is processed correctly and targets the appropriate data structure. Failure to provide the correct schema may result in an error or unexpected behavior in the response.
| Title | Field | Mandatory | Type | Example |
|---|---|---|---|---|
| header | Eheader | { "identifier": "48478B9A-EF10-B9A3-008A-A1E149A078C4", "schema": "communityProtocol", "languages": ["en"] } | ||
| Title | title | TRUE | lstring | { "en": "Test Info" } |
| Type of resource | resourceTypes | TRUE | Eterm[] | [{ "identifier": "2F193E6A-FE21-447F-8270-BAED8AD0DD5A" }, { "identifier": "5DDFFC34-4278-42B3-83D6-449862EC1C16" }] |
| Author(s) | authors | TRUE | lstring | { "en": "Test Info" } |
| Reference to the authoring organization(s) | organizations | TRUE | Ereference[] | [{ "identifier": "DECLARE-ORGANISATION_25562_20241111131557173@1" }] |
| Publisher | publisher | lstring | { "en": "Test Info" } | |
| Source | source | lstring | { "en": "Test Info" } | |
| Publication Date | publicationDate | TRUE | string | 2024-12 |
| Rights | rights | lstring | { "en": "Test Info" } | |
| Link to the resource(s) | resourceLinks | TRUE | Elink[] | [{ "url": "https://www.google.com", "name": "Google", "language": "en" }] |
| Cover image(s) | covers | Elink[] | [{ "url": "/api/v2013/documents/48478B9A-EF10-B9A3-008A-A1E149A078C4/attachments/616113/image.jpg", "name": "image.jpg", "tag": "Test Tag", "language": "en" }] | |
| Summary, abstract or table of contents (max 300 words) | summary | TRUE | lstring | { "en": "Test Info" } |
| Geographical or political/economic group(s) | countryRegions | Eterm[] | [{ "identifier": "af" }, { "identifier": "A23DD6C0-44C5-418D-83B5-461D79D2721A" }] | |
| gbfTargets | Eterm[] | [{ "identifier": "GBF-TARGET-01" }] | ||
| Aichi Targets | aichiTargets | Eterm[] | ||
| CBD Subject Areas | cbdSubjects | Eterm[] | [{ "identifier": "CBD-SUBJECT-DSHL" }, { "identifier": "CBD-SUBJECT-CC" }] | |
| nagoya | Nagoya | |||
| ABS Thematic Areas | nagoya.subjects | TRUE | Eterm[] | [{ "identifier": "EC94899F15EE40C6A0F7D0B1F774A521" }, ... ] |
| Key areas and strategic measures for capacity-building and development addressed by the resource | nagoya.keyAreas | Eterm[] | [{ "identifier": "0DCF8438-9479-4F6B-B356-FDFCB0C4D564" }] | |
| "Please select the relevant keywords for describing the content of the code of conduct, guidelines and best practices and/or standards being submitted | nagoya.mccKeywords | Eterm[] | ||
| biosafety | Biosafety | |||
| Biosafety Thematic Areas | biosafety.subjects | Eterm[] | ||
| biosafety.raRecommend | bool | |||
| biosafety.raAuthorAffiliation | Eterm[] | |||
| biosafety.raSubjects | Eterm[] | |||
| Does this resource address one or more specific LMOs? | biosafety.addressModifiedOrganisms | bool | ||
| LMO(s) identification | biosafety.modifiedOrganisms | Ereference[] | ||
| Does this resource address one or more specific organisms? | biosafety.addressOrganisms | bool | ||
| Organism(s) identification | biosafety.organisms | Ereference[] | ||
| Does this resource address one or more specific genetic elements? | biosafety.addressGenes | bool | ||
| Genetic element(s) identification | biosafety.genes | Ereference[] | ||
| tags | lstring[] | |||
| adminTags | string[] | |||
| Any other relevant information | relevantInformation | lstring | { "en": "<div><!--block-->Test Info</div>" } | |
| Any other relevant documents | relevantDocuments | Elink[] | [{ "url": "https://www.google.com", "name": "Google", "language": "en" }] |