General Control List
Summary
The list of REST-API services below contains some of the most important general control lists identified by the Management Information Systems during the Annual Reporting process and that can also be used to standardize and provide interoperability across any other CGIAR platforms.
Methods
/cgiar-entities
Functionality
This list contains the official list of CGIAR Centers, CGIAR Research Programs (CRPs), and CGIAR Platforms (PTFs). It also contains the list of Entities that are no longer active now.
Parameters
| Name | Description |
|---|---|
| typeId integer($int64) |
CGIAR entity type Code |
|
Request URL: https://clarisatest.ciat.cgiar.org/api/cgiar-entities |
|
State code: 200: OK
[
{
"acronym" : "string",
"cgiarEntityTypeDTO": {
"code" : 0,
"name" : "string"
} ,
"code" : 0,
"name" : "string"
}
]
State code: 400
Bad Request
State code: 401
Unauthorized
State code: 403
Forbidden
State code: 404
Not Found
/cgiar-entity-types
Functionality
This list contains the types of entities we have currently in the CGIAR. So far, we have the CGIAR Research Programs, platforms, and Centers.
Parameters
No parameters
|
Request URL: https://clarisatest.ciat.cgiar.org/api/cgiar-entity-types |
|
State code: 200: OK
[
{
"code" : 0,
"name" : "string"
}
]
State code: 400
Bad Request
State code: 401
Unauthorized
State code: 403
Forbidden
State code: 404
Not Found
/countries
Functionality
This list contains all the countries and is following the ISO-3166 standard. The data includes the country names in English, alpha-2 code, and the associated Region according to the UN49 standard.
Parameters
No parameters
|
Request URL: https://clarisatest.ciat.cgiar.org/api/countries |
|
State code: 200: OK
[
{
"code" : 0,
"isoAlpha2" : "string",
"name" : "string",
"regionDTO" : {
"um49Code" : 0,
"name" : "string",
"parentRegion" : {
"um49Code" : 0,
"name" : "string"
}
}
}
]
State code: 400
Bad Request
State code: 401
Unauthorized
State code: 403
Forbidden
State code: 404
Not Found
/un-regions
Functionality
Although there are several standards for the list of regions, we decided to adopt the UN49 standard.
Parameters
No parameters
|
Request URL: https://clarisatest.ciat.cgiar.org/api/un-regions |
|
State code: 200: OK
[
{
"um49Code" : 0,
"name" : "string",
"parentRegion" : {
"um49Code" : 0,
"name" : "string"
}
}
]
State code: 400
Bad Request
State code: 401
Unauthorized
State code: 403
Forbidden
State code: 404
Not Found
/OneCGIARRegions
Functionality
According to the One CGIAR Strategy, the CGIAR works in six regions: Central and West Asia and North Africa, Latin America and the Caribbean, West and Central Africa, East and Southern Africa, South Asia, Southeast Asia, and Pacific (see here).
Parameters
No parameters
|
Request URL: https://clarisatest.ciat.cgiar.org/api/OneCGIARRegions |
|
State code: 200: OK
[
{
"code" : 0,
"name" : "string",
"acronym" : "string",
"countries" : [
{
"code" : 0,
"name" : "string",
"isoAlpha2" : "string"
}
]
}
]
State code: 400
Bad Request
State code: 401
Unauthorized
State code: 403
Forbidden
State code: 404
Not Found
/acronyms
Functionality
View all CGIAR Acronyms.
Parameters
No parameters
|
Request URL: https://clarisatest.ciat.cgiar.org/api/acronyms |
|
State code: 200: OK
[
{
"code" : 0,
"acronym" : "string",
"description" : string
}
]
State code: 400
Bad Request
State code: 401
Unauthorized
State code: 403
Forbidden
State code: 404
Not Found
/glossary
Functionality
View Glossary of terms.
Parameters
No parameters
|
Request URL: https://clarisatest.ciat.cgiar.org/api/glossary |
|
State code: 200: OK
[
{
"term" : "string",
"definition" : "string"
}
]
State code: 400
Bad Request
State code: 401
Unauthorized
State code: 403
Forbidden
State code: 404
Not Found
Institutions
Summary
Methods
/institutions
Functionality
This is a worldwide list of institutions that have been related to CGIAR activities as funders, leaders, partners, and/or contributors. This list reflects the information consolidated by some of the CGIAR Management Information Systems and external sources (i.e. MARLO and MEL).
Parameters
No parameters
|
Request URL: https://clarisatest.ciat.cgiar.org/api/institutions |
|
State code: 200: OK
[
{
"acronym" : "string",
"added" : "2020-10-09",
"code" : 0,
"countryOfficeDTO": [
"countryOfficeDTO": {
"code" : 0,
"isHeadquarter" : "string",
"isoAlpha2" : "string",
"name" : "string",
"regionDTO" : {
"um49Code" : 0,
"name" : "string",
"parentRegion" : {
"um49Code" : 0,
"name" : "string"
}
}
}
],
"institutionType": {
"code" : 0,
"name" : "string"
},
"name" : "string",
"websiteLink" : "string"
}
]
State code: 400
Bad Request
State code: 401
Unauthorized
State code: 403
Forbidden
State code: 404
Not Found
/institutionsSimpleRelated
Functionality
Parameters
No parameters
|
Request URL: https://clarisatest.ciat.cgiar.org/api/institutionsSimpleRelated |
|
State code: 200: OK
[
{
"code" : 0,
"name" : "string",
"acronym" : "string",
"websiteLink" : "string",
"institutionTypeId" : 0,
"institutionType" : "string",
"hqLocation" : "string",
"hqLocationISOalpha2" : "string",
"institutionRelatedList": [
}
"source" : "string",
"clarisaId" : "string",
"clarisaInstitutionName" : "string",
"institutionName" : "string",
"institutionCode" : "string"
}
]
}
]
State code: 400
Bad Request
State code: 401
Unauthorized
State code: 403
Forbidden
State code: 404
Not Found
/institution-types
Functionality
Parameters
No parameters
|
Request URL: https://clarisatest.ciat.cgiar.org/api/institution-types |
|
State code: 200: OK
[
{
"code" : 0,
"name" : "string"
}
]
State code: 400
Bad Request
State code: 401
Unauthorized
State code: 403
Forbidden
State code: 404
Not Found
Research Strategy 2030
Summary
methods
/action-areas
Functionality
Test funtionality.
Parameters
No parameters
|
Request URL: https://clarisatest.ciat.cgiar.org/api/action-areas |
|
State code: 200: OK
[
{
"id" : "long",
"name" : "String",
"description" : "String"
}
]
State code: 400
Bad Request
State code: 401
Unauthorized
State code: 403
Forbidden
State code: 404
Not Found
methods
/impact-areas
Functionality
Test funtionality.
Parameters
No parameters
|
Request URL: https://clarisatest.ciat.cgiar.org/api/impact-areas |
|
State code: 200: OK
[
{
"id" : "long",
"name" : "String",
"description" : "String"
}
]
State code: 400
Bad Request
State code: 401
Unauthorized
State code: 403
Forbidden
State code: 404
Not Found
methods
/impact-areas-indicators
Functionality
Test funtionality.
Parameters
No parameters
|
Request URL: https://clarisatest.ciat.cgiar.org/api/impact-areas-indicators |
|
State code: 200: OK
[
{
"indicatorId" : "long",
"indicatorStatement" : "String",
"impactAreaId" : "long",
"impactAreaName" : "String",
"targetYear" : "Long",
"targetUnit" : "String",
"value" : "String"
}
]
State code: 400
Bad Request
State code: 401
Unauthorized
State code: 403
Forbidden
State code: 404
Not Found
methods
/allSDG
Functionality
Test funtionality.
Parameters
No parameters
|
Request URL: https://clarisatest.ciat.cgiar.org/api/allSDG |
|
State code: 200: OK
[
{
"usndCode" : "long",
"shortName" : "String",
"fullName" : "String"
}
]
State code: 400
Bad Request
State code: 401
Unauthorized
State code: 403
Forbidden
State code: 404
Not Found
methods
/allSDGTargets
Functionality
Test funtionality.
Parameters
No parameters
|
Request URL: https://clarisatest.ciat.cgiar.org/api/allSDGTargets |
|
State code: 200: OK
[
{
"ID" : "long",
"SDG Target Code" : "String",
"SDG Target" : "String",
"SDG code" : "String",
"SDG Name" : "String"
}
]
State code: 400
Bad Request
State code: 401
Unauthorized
State code: 403
Forbidden
State code: 404
Not Found
methods
/allSDGIndicators
Functionality
Test funtionality.
Parameters
No parameters
|
Request URL: https://clarisatest.ciat.cgiar.org/api/allSDGIndicators |
|
State code: 200: OK
[
{
"ID" : "long",
"UNSD Indicator Code" : "String",
"SDG Indicator Code" : "String,"
"SDG Indicator Name" : "String,"
"SDG Target Code" : "String,"
"SDG Target" : "String"
}
]
State code: 400
Bad Request
State code: 401
Unauthorized
State code: 403
Forbidden
State code: 404
Not Found
methods
/allInitiatives
Functionality
Test funtionality.
Parameters
No parameters
|
Request URL: https://clarisatest.ciat.cgiar.org/api/allInitiatives |
|
State code: 200: OK
[
{
"Id" : "long",
"official_code" : "String",
"name" : "String",
"short_name" : "String",
"status" : "String",
"action_area_id" : "String",
"action_area_description" : "String",
"active" : "long",
"stageId" : "String",
"description" : "String",
"stages :"[
{
"id" : "long",
"initvStgId" : "long",
"stageId" : "long",
"active" : "long"
}
]
}
]
State code: 400
Bad Request
State code: 401
Unauthorized
State code: 403
Forbidden
State code: 404
Not Found
methods
/actionAreaOutcomes
Functionality
Test funtionality.
Parameters
No parameters
|
Request URL: https://clarisatest.ciat.cgiar.org/api/actionAreaOutcomes |
|
State code: 200: OK
[
{
"actionAreaId" : "long",
"actionAreaName" : "String",
"outcomeId" : "long",
"outcomeSMOcode" : "String",
"outcomeStatement" : "String",
}
]
State code: 400
Bad Request
State code: 401
Unauthorized
State code: 403
Forbidden
State code: 404
Not Found
methods
/actionAreaOutcomeIndicators
Functionality
Test funtionality.
Parameters
No parameters
|
Request URL: https://clarisatest.ciat.cgiar.org/api/actionAreaOutcomeIndicators |
|
State code: 200: OK
[
{
"actionAreaId" : "long",
"actionAreaName" : "String",
"outcomeId" : "long",
"outcomeSMOcode" : "String",
"outcomeStatement" : "String",
"outcomeIndicatorId" : "long",
"outcomeIndicatorSMOcode" : "String",
"outcomeIndicatorStatement" : "String"
}
]
State code: 400
Bad Request
State code: 401
Unauthorized
State code: 403
Forbidden
State code: 404
Not Found
methods
/workpackages
Functionality
Test funtionality.
Parameters
No parameters
|
Request URL: https://clarisatest.ciat.cgiar.org/api/workpackages |
|
State code: 200: OK
[
{
"wp_id" : "long",
"acronym" : "String",
"name" : "String",
"initiative_id" : "long",
"initiative_offical_code" : "String",
"stage_id" : "long",
"results" : "String",
"pathway_content" : "String",
"wp_official_code" : "long",
"initiative_status" : "long"
}
]
State code: 400
Bad Request
State code: 401
Unauthorized
State code: 403
Forbidden
State code: 404
Not Found
methods
/MELIA/study-types
Functionality
Gives a list with MELIA study types from OneCGIAR.
Parameters
No parameters
|
Request URL: https://clarisatest.ciat.cgiar.org/api/MELIA/study-types |
|
State code: 200: OK
[
{
"Id" : "long",
"name" : "String"
}
]
State code: 400
Bad Request
State code: 401
Unauthorized
State code: 403
Forbidden
State code: 404
Not Found
methods
/business-category
Functionality
Test funtionality.
Parameters
No parameters
|
Request URL: https://clarisatest.ciat.cgiar.org/api/business-categories |
|
State code: 200: OK
[
{
"id" : "long",
"name" : "String"
}
]
State code: 400
Bad Request
State code: 401
Unauthorized
State code: 403
Forbidden
State code: 404
Not Found
methods
/technical-field
Functionality
Test funtionality.
Parameters
No parameters
|
Request URL: https://clarisatest.ciat.cgiar.org/api/technical-fields |
|
State code: 200: OK
[
{
"id" : "long",
"name" : "String"
}
]
State code: 400
Bad Request
State code: 401
Unauthorized
State code: 403
Forbidden
State code: 404
Not Found
methods
/innovation-type
Functionality
Test funtionality.
Parameters
No parameters
|
Request URL: https://clarisatest.ciat.cgiar.org/api/type-of-innovations |
|
State code: 200: OK
[
{
"id" : "long",
"name" : "String"
}
]
State code: 400
Bad Request
State code: 401
Unauthorized
State code: 403
Forbidden
State code: 404
Not Found
methods
/governance-type
Functionality
Test funtionality.
Parameters
No parameters
|
Request URL: https://clarisatest.ciat.cgiar.org/api/governance-types |
|
State code: 200: OK
[
{
"id" : "long",
"name" : "String"
}
]
State code: 400
Bad Request
State code: 401
Unauthorized
State code: 403
Forbidden
State code: 404
Not Found
methods
/environmental-benefits
Functionality
Test funtionality.
Parameters
No parameters
|
Request URL: https://clarisatest.ciat.cgiar.org/api/environmental-benefits |
|
State code: 200: OK
[
{
"id" : "long",
"name" : "String"
}
]
State code: 400
Bad Request
State code: 401
Unauthorized
State code: 403
Forbidden
State code: 404
Not Found
methods
/technology-development-stage
Functionality
Test funtionality.
Parameters
No parameters
|
Request URL: https://clarisatest.ciat.cgiar.org/api/technology-development-stages |
|
State code: 200: OK
[
{
"id" : "long",
"officialCode" : "String",
"name" : "String"
}
]
State code: 400
Bad Request
State code: 401
Unauthorized
State code: 403
Forbidden
State code: 404
Not Found
methods
/innovation-readiness-levels
Functionality
Test funtionality.
Parameters
No parameters
|
Request URL: https://clarisatest.ciat.cgiar.org/api/innovation-readiness-levels |
|
State code: 200: OK
[
{
"id" : "long",
"name" : "String"
}
]
State code: 400
Bad Request
State code: 401
Unauthorized
State code: 403
Forbidden
State code: 404
Not Found
methods
/administrative-scale
Functionality
Test funtionality.
Parameters
No parameters
|
Request URL: https://clarisatest.ciat.cgiar.org/api/administrative-scale |
|
State code: 200: OK
[
{
"id" : "long",
"name" : "String"
}
]
State code: 400
Bad Request
State code: 401
Unauthorized
State code: 403
Forbidden
State code: 404
Not Found
methods
/users
Functionality
Test funtionality.
Parameters
No parameters
|
Request URL: https://clarisatest.ciat.cgiar.org/api/users |
|
State code: 200: OK
[
{
"id" : "long",
"name" : "String"
}
]
State code: 400
Bad Request
State code: 401
Unauthorized
State code: 403
Forbidden
State code: 404
Not Found
methods
/beneficiaries
Functionality
Test funtionality.
Parameters
No parameters
|
Request URL: https://clarisatest.ciat.cgiar.org/api/beneficiaries |
|
State code: 200: OK
[
{
"id" : "long",
"name" : "String"
}
]
State code: 400
Bad Request
State code: 401
Unauthorized
State code: 403
Forbidden
State code: 404
Not Found
methods
/investment-type
Functionality
Test funtionality.
Parameters
No parameters
|
Request URL: https://clarisatest.ciat.cgiar.org/api/investment-types |
|
State code: 200: OK
[
{
"id" : "long",
"name" : "String"
}
]
State code: 400
Bad Request
State code: 401
Unauthorized
State code: 403
Forbidden
State code: 404
Not Found
methods
/innovation-use-levels
Functionality
Test funtionality.
Parameters
No parameters
|
Request URL: https://clarisatest.ciat.cgiar.org/api/innovation-use-levels |
|
State code: 200: OK
[
{
"id" : "long",
"name" : "String"
}
]
State code: 400
Bad Request
State code: 401
Unauthorized
State code: 403
Forbidden
State code: 404
Not Found