Get all Pick Lists available to the authenticated user. Details for each list are returned along with a List ID that can be used to get full details of a single list.
GET List Pick Lists
Get information about all lists. The response contains a href link for each list, these can be used to make requests and fetch the complete data of a single list.
Notes
The default rate limit is 30 requests per minute, which is shown through the response headers X-RateLimit-Limit and X-RateLimit-Remaining.
API keys and secrets are generated in The Data Standards Cloud UI, and they are given the same permissions as the user who created them. Talk to your CSM for additional information.
Use Case Example - Steps to build a List Values Export File
This use case offer steps to build a List Values Export File using the Claravine API, containing all configured lists, and build a CSV file.
A customer can follow these steps at an interval based on desired business frequency (weekly, monthly)
- Retrieve Data
- Use the "List Pick Lists" endpoint (
GET /v1/lists/) endpoint to retrieve all lists. - For each list returned above, use the "Get Pick List" endpoint (
GET /v1/lists/{listId}) endpoint to get each list information in a JSON format. - Process Lists
- Combine the JSON responses from the lists above into a single CSV file.
- The CSV can contain all lists key/value pairs, or segmented based on your business, ex. by region, etc.
- Upload file to a central location
- Upload the generated CSV file to Cloud Storage, or where your team can access globally, or where your workflow/application can consume it.