Retrieve resource id for a resource with a specific name
Amorphic users can retrieve the resource Id based on the specific resource name using the below API call.
Property | Value |
---|---|
Http Method | GET |
API | <API_GW_URL/environment>/resourcetypes/{resource_type}/resources/{resource_name} |
Example:
Lets say user has a dataset 'Test_Dataset'
https://1abcdefghi.execute-api.us-west-2.amazonaws.com/dev/resourcetypes/datasets/resources/Test_Dataset
If user has more than one dataset in the environment with the same name (in different domains) then user should include the domain name in the API as <domainName>::<datasetName>
Ex: /resourcetypes/datasets/resources/testdomain::Test_Dataset
Similarly for views, if user has more than one view in the environment with the same name (in different domains) then user should include the domain name in the API as <domainName>::<viewName>
List of resources that can be used in this API:
datasets, dashboards, jobs, notebooks, schedules, models, views, jobslibs, deepsearch-indices, data-quality-checks, workflows, insights, streams, connections, connections-apps, roles, notebooks-lifecycle-configurations
Response of the APIs will be returned as a JSON object described as below:
{
"ResourceId": "UUID",
"ResourceName": "string"
}