Resource Endpoints
API Documentation
Resource Endpoints
1. Accessing Metadata of the Resource
Return the metadata of a resource.
Endpoint: /resource_show
Method: GET
Authorisation: not required.
Parameters:
- id (string)(required) – the id of the resource
- include_tracking (bool)(optional) – add tracking information to dataset and resources. Default: False
Examples:
- Case 1: Get metadata of the resource by id “5bb87c44-d6dc-4ef4-84a2-487ed05f84e2”. https://iatiregistry.org/api/action/resource_show?id=5bb87c44-d6dc-4ef4-84a2-487ed05f84e2
- Case 2: Get metadata of the resource by id “4f4db760-77bf-4574-bf95-ec90f330f2d6“. https://iatiregistry.org/api/action/resource_show?id=4f4db760-77bf-4574-bf95-ec90f330f2d6
2. Updating a Resource
To update a resource use package_update with resources list.
Endpoint: /package_update
Method: POST
3. Patch a Resource
Patch a resource use package_patch with resources list.
Endpoint: /package_patch
Method: POST
4. Delete a Resource
IATI dataset has only one resource in every package, hence to delete a resource please use package_delete.
Endpoint: /package_delete
Method: POST