Access Metadata
You can use the GET method to retrieve
metadata about REST API resources from their /describe
endpoints. Each REST
API resource's metadata contains a comprehensive description, including
the object resource URIs, attributes, supported actions, child resources,
and list-of-value (LOV) resources.
Retrieving Metadata for a Specific Resource
Perform the GET operation on the resource using the following request URL syntax:
https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/<version>/<resource>/describe
Let's say you want to get the metadata for the fee items resource. Perform the GET operation using the following request URL:
https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/publicSectorFeeItems
You can use this cURL command to complete the operation:
curl -X GET -u <username:password> https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/publicSectorFeeItems HTTP/1.1 -H 'content-type: application/vnd.oracle.adf.resourceitem+json' | json_pp
Retrieving Metadata for All Resources in an Application
To access the metadata for all resources hosted in an application, perform the GET operation using the following request URL:
https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/<version>/describe
You can use this cURL command to complete the operation:
curl -X GET -u <username:password> https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/describe HTTP/1.1 -H 'content-type: application/vnd.oracle.adf.resourceitem+json' | json_pp
Such a request might return a very large result, but there might be times when you need to inventory all available resources.