Error handling

Initial parameter checks

An initial check of the payload is carried out for each command. This includes syntax checks, ensuring completeness of the data and verifying parameter constraints. If these checks fail, the entire command will not be executed and responds with error code 422 and messages about the error cause.

General state handling

Adding or changing data in the catalog is not always allowed. Data cannot be modified while an import is running. In that case, endpoints that would create, update, or delete data will not be executed and respond with error code 422 and message "Catalog is not writeable - an import is running".

See section Managing the catalog to learn about the data lifecycle and the overall state of the catalog.

Standard responses

After the initial checks have been passed, the commands will be executed. Because in general the endpoints allow bulk operations, they respond with information about the actions taken. It can happen that individual actions in the bulk operation have failed. In that case, the response contains information about that failed actions.

Standard response of create/update requests

Repsonse field	Value
created	Contains a list of ids of objects that have been created by the request
updated	Contains a list of ids of objects that have been updated by the request
errors	A dictionary of objects, which could not be created or updated with corresponding error messages

Structure of the response:

{
  "created": [
    "id1",
    "id2"
  ],
  "updated": [
    "id3"
  ],
  "errors": {
    "id4": [
      "error message 1",
      "error message 2"
    ]
  }
}

Standard response of delete requests

Repsonse field	Value
deleted	Contains a list of ids of objects that have been deleted by the request
errors	A dictionary of objects, which could not be deleted with corresponding error messages

Structure of the response:

{
  "deleted": [
    "id1",
    "id2"
  ],
  "errors": {
    "id3": [
      "error message 1",
      "error message 2"
    ]
  }
}