logo
logo

Response Codes

CodeDescription
200OK. The request was handled, and the body contains the response content.
201Created. The resource is created, the header will contain a Location, which contains the URL of the newly created resource, and a X-Global-Identifier, which contains the GLOBAL IDENTIFIER of the newly created resource.
204No Content. The request was handled. No content was returned (e.g. PUT or DELETE requests.
304Not Modified. When an If-None-Match header was specified in the request and there was a match, the content is not returned and the client should use its cached copy.
400Bad Request. This means that the server did not understand the request,e.g. because of syntax errors in the supplied JSON format or missing elements in the representation. Usually, an error object is included in the response detailing the reason why the request was considered bad.
401Authentication Required. Access to the specified resource is restricted and the Client must provide adequate credentials.
403Forbidden. The Service understood but refused the request. This is usually because of a validation error, or an access violation. Usually, an error object is included in the response detailing the reason why the request was refused.
404Not Found. The requested resource is not found. It either does not exist, or was deleted, or is in some other way unavailable to the Client.
405Method Not Allowed. The addressed resource does not support the requested method.
409Conflict. The request could not be handled because of a conflict. For example, an Entity Definition with the desired name already exists.
429Too Many Requests. The number of requests sent exceeded the rate limit of 15 requests per second.
500Internal Server Error. There was a critical error in the Service, and the request cannot be handled. The server may respond with an error object but the details may be hidden for the Client.
Note

Other response codes may be returned by the Service.

Can we improve this article ? Provide feedback