In case a request to our API fails, the return value of the endpoints follows standard HTTP status code conventions.
A detailed reason can be found in the response. Common codes indicating a client error are 400 (Bad Request) & 404 (Not Found).
To give some further information on the cause of the error, the API also returns a standardized error object in the response body.
"description": "The model sent in the request is invalid. See the validation errors for details.",
"Some more details about the error can go here.",
"message": "'Name' should not be empty."
- Description: A human-readable explanation for the cause of the error. For example:
- Identity cannot be invited to this workspace. The identity is already part of the workspace.
- The password is too simple
- Link: A link to the corresponding documentation.
- Details: Further explanations or hints on fixing the request.
- ValidationErrors: If the model validation failed, all violations are listed here.
On each request to our API, you will receive a response with a HTTP status code that indicates if it was successful.
GET 200 (OK) including the object(s)
POST 200 (OK) including the newly created object
202 (Accepted) for batch or background operations
204 (No Content) for business operations without a return value
PUT 200 (OK) including the updated object
DELETE 204 (No Content)
400 (Bad Request) When the request model is invalid or the operation is not allowed
401 (Unauthorized) When the requesting user is lacking the necessary permissions for the request
404 (Not Found) When a requested resource does not exist