CGIAR Entities
Summary
The list of REST-API services below contains some of the most important general control lists for SMO Finance and operation group and that can also be used to standardize and provide interoperability across any other CGIAR platforms.
Methods
/onecgiar-entities
Functionality
This list contains the official list of CGIAR Centers, CGIAR Research Programs (CRPs),CGIAR Platforms (PTFs), And Office(SMO).
Parameters
No parameters
| <> | |
|
Request URL: https://clarisatest.ciat.cgiar.org/api/onecgiar-entities |
|
State code: 200: OK
[
{
"acronym" : "string",
"financialCode" : "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
CGIAR Accounts
Summary
/accounts
Functionality
Parameters
No parameters
|
Request URL: https://clarisatest.ciat.cgiar.org/api/accounts |
|
State code: 200: OK
[
{
"code" : 0,
"description" : "string",
"financialCode" : "string",
"accountType" : {
"id" : 0,
"name" : "string"
}
"parent" : {
"code" : 0,
"description" : "string"
}
}
]
State code: 400
Bad Request
State code: 401
Unauthorized
State code: 403
Forbidden
State code: 404
Not Found
/accountTypes
Functionality
Parameters
No parameters
|
Request URL: https://clarisatest.ciat.cgiar.org/api/accountTypes |
|
State code: 200: OK
[
{
"id" : 0,
"name" : "string"
}
]
State code: 400
Bad Request
State code: 401
Unauthorized
State code: 403
Forbidden
State code: 404
Not Found
CGIAR Science Groups
Summary
/scienceGroups
Functionality
Parameters
No parameters
|
Request URL: https://clarisatest.ciat.cgiar.org/api/scienceGroups |
|
State code: 200: OK
[
{
"code" : 0,
"financialCode" : "string",
"description" : "string",
"parent" : {
"code" : 0,
"description" : "string"
}
}
]
State code: 400
Bad Request
State code: 401
Unauthorized
State code: 403
Forbidden
State code: 404
Not Found
CGIAR Units
Summary
/units
Functionality
Parameters
No parameters
|
Request URL: https://clarisatest.ciat.cgiar.org/api/units |
|
State code: 200: OK
[
{
"code" : 0,
"financialCode" : "string",
"description" : "string",
"unitType" : {
"code" : 0,
"acronym" : "string",
"description" : "string"
}
"parent" : {
"code" : 0,
"description" : "string"
}
"scienceGroup" : {
"code" : 0,
"description" : "string"
}
}
]
State code: 400
Bad Request
State code: 401
Unauthorized
State code: 403
Forbidden
State code: 404
Not Found
Funding Sources
Coming Soon
Impact Areas
Summary
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",
"financialCode" : "String"
}
]
State code: 400
Bad Request
State code: 401
Unauthorized
State code: 403
Forbidden
State code: 404
Not Found
/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",
"financialCode" : "String"
}
]
State code: 400
Bad Request
State code: 401
Unauthorized
State code: 403
Forbidden
State code: 404
Not Found