Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Panel
panelIconIdatlassian-info
panelIcon:info:
bgColor#F4F5F7

Ondato APIs use conventional HTTP response codes to indicate if the request was a success or a failure. These responses are unified; therefore, the format of the response will always be the same across all APIs.

...

🗒️ HTTP status code summary

Code

Description

Description

Example value

400

Bad Request

The request was unacceptable, which indicates that the given request parameters are invalid or missing required parameters.

Code Block
languagejson
"reason": "ValidationFailed",
"message": "The request is invalid.",
"params": {
  "additionalProp1": [
    {
     "reason": "Required",
     "message": "Property should not be empty."
    }
  ]
}

401

Unauthorised

No valid access token provided.

Code Block
languagejson
"reason": "AuthenticationFailed",
"message": "The access token is missing, invalid, or is revoked."

403

Forbidden

The access token doesn't have permissions to perform the request.

Code Block
languagejson
"reason": "AuthorizationFailed",
"message": "The subject of the token does not have the permissions that are required to access the resource."

404

Not Found

The requested resource does not exist.

Code Block
languagejson
"reason": "NotFound",
"message": "The requested resource doesn't exist.."

...