Skip to main content
English (US) Nederlands

Assets Server REST API - error handling

  • Updated

Info: The sendServiceErrorAsJson option described in this article has been deprecated and cannot be used anymore. For error reporting, use the returnStatusOkOnErrorForServicesApi option on the Cluster properties page of the Management Console instead. For details, see the comments of that option.

Since HTTP error codes do not work with cross-domain AJAX calls and JSONP requests, errors are returned in JSON format with a normal HTTP 200 status.

Note: For security reasons, JSONP is not supported in Assets Server.

If you want your server to produce errors as normal HTTP status codes instead of the JSON error object, set sendServiceErrorAsJson=false in your server config.

JSON error response

  • errorcode The error code. This is the value that would have been returned as http status code.
  • message A short message indicating why the operation failed.
{
  "errorcode" : 401,
  "message" : "Not logged in"
}

Related articles

Comment

Do you have corrections or additional information about this article? Leave a comment!
Do you have a question about what is described in this article? Please contact Support.


2 comments

Date Votes
  • Tim Strehle

    I think it would be helpful to document the recently-added returnStatusOkOnErrorForServicesApi cluster property on this page:

    # Historically, the Assets Server REST API under /services/* returned 200 OK on
# error to enable legacy browsers to connect across cross-domain. URLs outside
# /services will return non-200 status codes in case of errors.
#
# The following settings are supported:
#
# true   = return 200 OK on error, with JSON errorcode in the body.
# false  = return non-200 status codes (4xx, 5xx), with same JSON errorcode
#          in the body.
# 403    = only return 403 status code, but return 200 OK for errorcodes
#          other than 403 (403 reported for CSRF errors).
#
# This setting only affects APIs under /services/*
    1
  • Maarten van Kleinwee

    Hi Tim,

    Thank you for the feedback. I passed it on to the developers and it turns out that the sendServiceErrorAsJson option described in this article has actually been deprecated and cannot be used anymore. I have added a note to this article to point this out and to refer to the returnStatusOkOnErrorForServicesApi option.

    Best regards,

    Maarten van Kleinwee
    Senior Technical Writer, WoodWing Software 

    1

Please sign in to leave a comment.