ExecutionResource
Exposes the Xpress-Insight execution queue. Each ExecutionStatus represents a job in the execution queue and they can be listed via this ExecutionResource.
POSTing a Scenario to the ExecutionResource schedules it for execution and creates a new ExecutionStatus to represent its state. DELETEing an ExecutionStatus initiates the cancellation of the scenario's execution.The following resources are part of this group:
/v1/data/execution
GET
Lists the ExecutionStatus of each scenario in the Xpress-Insight execution queue.
The id of each ExecutionStatus is the same as the id of the Scenario it represents.Parameters
| name | description | type | default |
|---|---|---|---|
| start | Start at this position in the list | query | 0 |
| maxResults | The maximum number of items to return | query | 50 |
Response Body
| element: | webServiceBeanList |
| media types: | application/json |
A paginated list containing ExecutionStatus items
POST
Queues a Scenario for execution and creates an associated ExecutionStatus to represent its state in the execution queue. This service can be used either to load or to run a scenario (or to use a custom Execution Mode), depending on the jobType property of the ExecutionRequest.
For compatibility reasons, this also accepts objects with an objectType of EXECUTION_STATUS or SCENARIO, but EXECUTION_REQUEST is the preferred value. The response code indicates the following:- 200 OK: successful
- 404 Not Found: the scenario does not exist
- 423 Locked: the scenario is currently locked and cannot be scheduled for execution at this time
Request Body
| element: | executionRequest |
| media types: | application/json |
The ExecutionRequest to create
Response Body
| element: | (custom) |
| media types: | application/json |
An empty response, see above for the return codes.
/v1/data/execution/{id}
GET
Reads an ExecutionStatus.
Parameters
| name | description | type | default |
|---|---|---|---|
| id | The id of the ExecutionStatus to read; the same as the id of the Scenario it represents | path |
Response Body
| element: | executionStatus |
| media types: | application/json |
The ExecutionStatus, or a 404 Not Found if the ExecutionStatus could not be found.
DELETE
Deletes the ExecutionStatus and initiates cancelling the scenario's execution. The ExecutionStatus is deleted once the cancellation has completed.
The response code indicates the following:- 200 OK: successfully initiated the cancel
- 404 Not Found: the scenario does not exist or is not currently queued
- 423 Locked: the scenario is currently locked and cannot be scheduled for execution at this time
Parameters
| name | description | type | default |
|---|---|---|---|
| id | The id of the ExecutionStatus to delete, the same as the scenario id it represents | path |
Response Body
| element: | (custom) |
| media types: | application/json |
An empty response, see above for the return codes.
/v1/data/execution/{id}/runlog
GET
Reads the run log for a specific scenario
Parameters
| name | description | type | default |
|---|---|---|---|
| id | The id of the scenario whose run log to read | path |
Response Body
| element: | (custom) |
| media types: | text/plain |
The list of run log lines or 404 Not Found if the scenario could not be found.
© 2001-2020 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.