Create/modify existing API Endpoint to lookup model objects by name, code or id.

Options
scott.smith
scott.smith Member, ALL USERS, Employee Posts: 5 Expert
in Extensibility

The current method to find the system id of a model object (list, module, line item, etc) is to pull the entire list down with a get call and then loop through that response checking each member for the name/code/id that you are looking for.  

 

I would like to see a new endpoint in which we can pass a name or code and get the name, id and code(where applicable) back:  For example:

 

curl --request POST 'https://api.anaplan.com/2/0/workspaces/8a81b0136ee24d0e01700b1ef6e70bfb/models/CAB05B47EE054D2591F27D2150B0B219/files/' --header 'Authorization: AnaplanAuthToken ' --header 'Content-Type: application/json' --header 'Accept: application/json' --data-raw '{
"name": "CreditView.txt"
}
Response would look something like: 
{
"id": "113000000022",
"name": "CreditView.txt"
}
 
 
Alternately, alter the existing GET call to be able include a filter.
 
curl --request GET 'https://api.anaplan.com/2/0/workspaces/8a81b0136ee24d0e01700b1ef6e70bfb/models/CAB05B47EE054D2591F27D2150B0B219/files?filter=name eq "CreditView.txt"' --header 'Authorization: AnaplanAuthToken' --header 'Content-Type: application/json'
 
Response would look the same, something like: 
{
"id": "113000000022",
"name": "CreditView.txt"
}
 
 
Tagged:

Categories