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.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
POST Update Pick List
Upload a JSON file to update a non-powered pick list (only "dependent", "drill-down" and "drop-down" list types are supported).
The following list fields can be updated:
- name
- notes
- headers (change column names and/or precedence)
- rows (overwrite list rows with new values)
NotesIn case the uploaded JSON file is bigger than 4.0MB the request will return a 400 error.
In case the request is successful, the current list rows will be overwritten with the row values present in the uploaded file.
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.
Column UUIDs.
col_uuidis optional, but if you use it, use it consistently: sendcol_uuidon every cell in the file, or on none. A file that mixes cells with and withoutcol_uuidis rejected, because the cells without one cannot be matched to a column. When no cell carries acol_uuid, cells are matched to headers by position instead.Adding a column. A new column cannot receive values in the same upload — its
col_uuiddoes not exist until the column has been created, so no cell can reference it. Add the column in one request, then populate it in a second.Partial rows. A row's
row_datadoes not have to cover every header, but any column it does not cover is written empty for that row, because the upload replaces the entire list.
Example of a valid JSON file that can be used to update a list:
{
"name": "New Name",
"type": "drill-down",
"notes": "Updated from the Data Standards Cloud API",
"headers": [
{
"col_uuid": "81cd48c6-862e-467c-8b46-8d9e433afbfa",
"name": "First Column"
},
{
"col_uuid": "98a348c6-862e-467c-8b46-8d9e433az34sd",
"name": "Second Column"
}
],
"rows": [
{
"row_data": [
{
"col_uuid": "81cd48c6-862e-467c-8b46-8d9e433afbfa",
"value": "New Value"
},
{
"col_uuid": "98a348c6-862e-467c-8b46-8d9e433az34sd",
"value": "World"
}
]
},
{
"row_data": [
{
"col_uuid": "81cd48c6-862e-467c-8b46-8d9e433afbfa",
"value": "Claravine"
},
{
"col_uuid": "98a348c6-862e-467c-8b46-8d9e433az34sd",
"value": "Lorem Ipsum"
}
]
}
]
}