Dictionary updating in services
POST /api/v1/dictionaries/update
You can update only dictionaries in dictionary resources of the table type.
Access: General administrator, Tenant administrator, Tier 2 analyst for all tenants except the Shared tenant; General administrator for the Shared tenant; Tier 1 analyst — only their own.
Query parameters (URL Query)
Name | Data type | Mandatory | Description | Value example |
dictionaryID | string | Yes | ID of the dictionary that will be updated. | 00000000-0000-0000-0000-000000000000 |
The update affects all services where the specified dictionary is used. If an update in one of the services ends with an error, this does not interrupt updates in the other services.
Request body
Multipart field name | Data type | Mandatory | Description | Value example |
file | CSV file | Yes | The request contains a CSV file. Data of the existing dictionary is being replaced with data from this file. The first line of the CSV file containing the column names must not be changed. | key columns,column1,column2 key1,k1col1,k1col2 key2,k2col1,k2col2 |
Response
HTTP code: 200
Format: JSON
type Response struct { ServicesFailedToUpdate []UpdateError `json:"servicesFailedToUpdate"` } type UpdateError struct { ID string `json:"id"` Err error `json:"err"` } |
Returns only errors for services in which the dictionaries have not been updated.
Possible errors
HTTP code | Description | message field value | details field value |
400 | Invalid request body | request body decode failed | Error |
400 | Null count of dictionary lines | request body required |
|
400 | Dictionary ID not specified | invalid value | dictionaryID |
400 | Incorrect value of dictionary line | invalid value | rows or rows[i] |
400 | Dictionary with the specified ID has an invalid type (not table) | can only update table dictionary |
|
400 | Attempt to change dictionary columns | columns must not change with update |
|
403 | No access to requested resource | access denied |
|
404 | Service not found | service not found |
|
404 | Dictionary not found | dictionary not found | Service ID |
500 | Any other internal errors | variable | variable |
