Schema for CDI
This section provides an overview of the schemas related to the Capacity Development Initiatives (CDI). Each schema details the structure and fields required for the CDI-related requests and responses.
NOTE
When making an API request using the Capacity Development Initiatives (CDI) schema, it is crucial to include the correct schema identifier. The schema parameter must be set to "capacityBuildingInitiative"
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": "EBC2DAD5-04C8-0530-6D58-C949CAECD809", "schema": "capacityBuildingInitiative", "languages": [ "en" ] } | ||
libraries | Eterm[] | |||
Title of the initiative | title | True | lstring | { "en": "Test Info" } |
Please provide any project number, identifier or reference number, if applicable. | projectNumber | lstring | { "en": "Test Info" } | |
Website address(es) | projectDocument | Elink[] | [ { "url": "https://www.google.com", "name": "Google", "language": "en" } ] | |
Contact person | contacts | True | Ereference[] | [ { "identifier": "SIMP-A1D0D0A8-65B1-B8D5-FF9F-B7B6B95CDDEB@1" } ] |
Geographic scope | geographicScope | True | Eterm | { "identifier": "528B1187-F1BD-4479-9FB3-ADBD9076D361" } |
Geographical or political/economic group(s) | countryRegions | Eterm[] | ||
Status | status | True | Eterm | { "identifier": "73E2AC27-D964-487C-A4E6-0997BB27AF01" } |
Start date | startDate | True | DateTime | 2024-11-04 |
End date | endDate | True | DateTime | 2024-12-27 |
Duration period | durationPeriod | True | int | 2 |
Duration period in day(s)/month(s)/year(s) | durationText | True | string | Months |
Type of capacity development initiative | activityScope | Eterm | { "identifier": "2DFCDD0B-5D62-4016-829F-8E70E767875A" } | |
Is this part of a larger project or programme? | isProjectProgramme | True | bool | True |
Please specify the name of project or programme. | projectProgrammeName | lstring | { "en": "Test Info" } | |
Please link to a clearing-house record about this project or programme. | broaderProjects | Ereference[] | [ { "identifier": "A75D346C-E205-A4B9-EE94-2B1CEADB7945@1" } ] | |
Implementing agency(ies) or organization(s) | isImplementedByAgencies | bool | True | |
Please select the implementing agency(ies) or organization(s) | implementingAgencies | Ereference[] | [ { "identifier": "2C86F905-B244-8FDD-4988-5088C023BDE9@1" } ] | |
Executing agency(ies) or organization(s) | isExecutededByAgencies | bool | True | |
executingAgencies | Please select the executing agency(ies) or organization(s) | Ereference[] | [{ "identifier": "2C86F905-B244-8FDD-4988-5088C023BDE9@1" }] | |
isCollaboratededByPartners | Collaborating partner(s) | bool | True | |
description | Short description of the initiative, including its goals and objectives (max 150 words) | lstring | { "en": "Test Info" } | |
categories | Category(ies) of capacity development activities | Eterm[] | [ { "identifier": "FE6EC4EA-55E7-4E90-80AD-FE4B54707B73" }, { "identifier": "5B6177DD-5E5E-434E-8CB7-D63D67D5EBED", "customValue": { "en": "Test Info" } } ] | |
targetGroups | Main target group(s)/beneficiary(ies) | Eterm[] | [ { "identifier": "D8862526-B776-4FD2-8C62-6DF9D5E92166" }, { "identifier": "5B6177DD-5E5E-434E-8CB7-D63D67D5EBED", "customValue": { "en": "Test Info" } } ] | |
cbdSubjects | Related CBD subject areas | Eterm[] | [{ "identifier": "CBD-SUBJECT-FOR" }] | |
gbfTargets | Eterm[] | [{ "identifier": "GBF-TARGET-17" }] | ||
aichiTargets | Eterm[] | |||
absKeyAreas | Key areas and strategic measures for capacity-building and development | Eterm[] | [{ "identifier": "9096451F-09FF-4E70-8345-3C7D84DEF545" }] | |
cpbThematicAreas | Biosafety Thematic Areas | Eterm[] | [ { "identifier": "1D4567E7-C615-4A49-BD1A-7CF6AD25CC63" }, { "identifier": "5B6177DD-5E5E-434E-8CB7-D63D67D5EBED", "customValue": { "en": "Test Info" } } ] | |
fundingSourceTypes | Type(s) of funding source(s) | Eterm[] | [{ "identifier": "74EBA28E-1F0C-4157-BD47-C8492487AD70" }] | |
coreFundingSources | Primary funding source(s) | Ereference[] | [{ "identifier": "2C86F905-B244-8FDD-4988-5088C023BDE9@1" }] | |
coFinancingSources | Co-funding source(s) | Ereference[] | [{ "identifier": "2C86F905-B244-8FDD-4988-5088C023BDE9@1" }] | |
totalBudget | Total budget (amount, in US dollars) | string | 1234 | |
resultsAchievements | Main achievements | lstring | { "en": " | |
resultsOutputs | Main outputs | Elink[] | [{ "url": "https://www.google.com", "name": "Google", "language": "en" }] | |
resultsReference | Please select the virtual library record number containing relevant information. | Ereference[] | [{ "identifier": "2E055D01-C58F-3195-D1C1-E53F0FF352AD@1" }] | |
bestPractices | Good practices and lessons learned | lstring | { "en": " | |
tags | lstring[] | |||
adminTags | string[] | |||
relevantInformation | Any other relevant information | lstring | { "en": " | |
relevantDocuments | Any other relevant documents | Elink[] | [{ "url": "https://www.google.com", "name": "Google", "language": "en" }] |