This page will help you get started with Claravine's Data Standards Cloud API
The API is intended to manage data in Claravine's platform, The Data Standards Cloud. In the future, there will be additional API endpoints for other Claravine features.
For access to the API, you will need to contact your Customer Success Manager and assign a user account to be granted API access.
Contacting Claravine
Available Endpoints:
Datasets endpoints:
List Datasets:
Get all datasets available to the authenticated user. In The Data Standards Cloud UI, these are templates. All returned fields can have values submitted to them. There are other fields on the datasets, but they are read-only and not made visible through this endpoint.
Get Dataset Definition:
Get the definition of a Dataset using the Dataset UUID (available from the List Datasets API) as an input. The dataset definition provides a full overview of all fields included in the dataset and can be used as a reference when calling the "Create Transaction" endpoint.
Get Dataset Rows by Generated Pattern:
Get dataset rows that match a specific Claravine Pattern (sometimes referred to as trackings codes).There should normally be 1 or 0 results. In the event of multiple matches, up to 100 results may be returned.
Transactions endpoints:
List Dataset Transactions:
Get a list of transactions (including submissions through the UI) associated with a dataset. Each of these transaction UUIDs may be used to fetch specific data associated with that transaction.
Get Transaction Data:
Get the data of a completed transaction (not available before the transaction has been completed). Returns all available fields and data associated with each field, including read-only fields and data.
Get Dataset Transaction:
Get the data of a completed transaction (not available before the transaction has been completed). Returns all available fields and data associated with each field, including read-only fields and data.
Create Transaction:
Post data to a specific dataset. Data will be processed according to Governance Rules defined in the related dataset (template in The Data Standards Cloud UI). If any data fails when tested against Governance Rules, the entire dataset will be moved into the draft/pending state, and no attached integrations will be run. If no data fails, integrations will be executed as defined in the dataset (template in The Data Standards Cloud UI).
Get Transaction Status:
Get the current status of a transaction. May return a status of 'Pending', 'Complete', or 'Failed'.
Pick Lists endpoints (Beta):
List Pick Lists:
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 Pick List:
Get all details of a Pick List using the List UUID (available from the List Pick Lists API) as an input. The List API response includes the List definition and a full overview of all columns and rows of data included in the List.
Update Pick List:
Existing non-powered Pick Lists can be updated using the Update Pick List endpoint. This endpoint requires a List ID and a JSON payload. The Get Pick List endpoint can be used to retrieve the JSON payload in the correct format. Modifications are made to the JSON payload and submitted to the Update Pick List endpoint to apply the updates to the List.
Notes
The default rate limit is 100 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.