Initializing help system before first use

Request Responses

The possible responses to a request submission are detailed in this topic.
200 Job submitted successfully. The response body contains a description of the job which is equivalent to that returned by the GET endpoint.
4xx Request has been rejected and the job will not have been created.
Possible reasons include
  • 401: Unauthorized (e.g. cannot create scenario / execute scenario etc)
  • 404: Compute app not found / no access
  • 403: Forbidden
  • 422: Validation failed
5xx Server or network error. The job may or may not have been created. Call the GET endpoint to find out whether job was created.
Note: The API will return the connection id in the header during the handshake process. Accessing these headers is not supported when using some web socket libraries. As an alternative, after starting a job you can send a subscribe message as described in step 3 of the later section Subscribing to Messages from Running Jobs following Disconnection.

© 2001-2025 Fair Isaac Corporation. All rights reserved. This documentation is the property of Fair Isaac Corporation (“FICO”). Receipt or possession of this documentation does not convey rights to disclose, reproduce, make derivative works, use, or allow others to use it except solely for internal evaluation purposes to determine whether to purchase a license to the software described in this documentation, or as otherwise set forth in a written software license agreement between you and FICO (or a FICO affiliate). Use of this documentation and the software described in it must conform strictly to the foregoing permitted uses, and no other use is permitted.