Compute Job Controller
| Operation | Description |
|---|---|
| POST /insightservices/rest/v1/compute | Submits a compute job |
| POST /insightservices/rest/v1/compute/ | Submits a compute job |
| GET /insightservices/rest/v1/compute/{id} | Returns details of the compute job for the given id. |
| DELETE /insightservices/rest/v1/compute/{id} | Deletes the compute job with the given id. |
POST /insightservices/rest/v1/compute
The payload specifies the attributes of the compute job. The id attribute specifies the unique identifier for your compute job; this is a unique string. It must be between 1 and 60 characters and can contain alpha numeric characters plus _ and - characters. The type attribute specifies the type of compute job. Supported types are: MOSEL. The optional displayName attribute specifies the name that is displayed in the user interface. If supplied it must be between 1 and 255 characters after whitespace trimming and does not contain any ISO Control Characters The optional payload attribute is a zip that holds the compiled Mosel file with the name main.bim + any other files that are needed for the completion of the compute job
Request Body
multipart/form-data
Request Parameters
| Name | Description | Type | Data Type | |
|---|---|---|---|---|
| computeJob | computeJob |
formData | object | required |
| fileSize | formData | object | ||
| filename | formData | object | ||
| originalFilename | formData | object | ||
| payload | formData | object |
Responses
application/json
- 200 OK
-
Type: ComputeJobV1
Responds with the initial ComputeExecutionStatus
POST /insightservices/rest/v1/compute/
The payload specifies the attributes of the compute job. The id attribute specifies the unique identifier for your compute job; this is a unique string. It must be between 1 and 60 characters and can contain alpha numeric characters plus _ and - characters. The type attribute specifies the type of compute job. Supported types are: MOSEL. The optional displayName attribute specifies the name that is displayed in the user interface. If supplied it must be between 1 and 255 characters after whitespace trimming and does not contain any ISO Control Characters The optional payload attribute is a zip that holds the compiled Mosel file with the name main.bim + any other files that are needed for the completion of the compute job
Request Body
multipart/form-data
Request Parameters
| Name | Description | Type | Data Type | |
|---|---|---|---|---|
| computeJob | computeJob |
formData | object | required |
| fileSize | formData | object | ||
| filename | formData | object | ||
| originalFilename | formData | object | ||
| payload | formData | object |
Responses
application/json
- 200 OK
-
Type: ComputeJobV1
Responds with the initial ComputeExecutionStatus
GET /insightservices/rest/v1/compute/{id}
Request Parameters
| Name | Description | Type | Data Type | |
|---|---|---|---|---|
| id | id |
path | string | required |
Responses
application/json
- 200 OK
-
Type: ComputeJobV1
Compute job state.
- 404 Not Found
-
Compute Job not found.
DELETE /insightservices/rest/v1/compute/{id}
Request Parameters
| Name | Description | Type | Data Type | |
|---|---|---|---|---|
| id | id |
path | string | required |
Responses
application/json
- 204 No Content
-
Returns no content if successful
- 403 Forbidden
-
Access denied
- 404 Not Found
-
Compute job not found
Properties
- computeJobType: string
-
The compute job type
Example: "MOSEL|SOLVER" - dependency: string
-
Name of a dependency zip. Must match the name of a dependency uploaded to the compute app.
Example: "mydependency.zip" - metricsUrl: string
-
- modelStatus: string
-
- mosel: ComputeMoselV1
-
Specify any mosel specific options if the type of the job is MOSEL
- ownerId: string
-
The id of the user that owns this item
Example: "d26d907d-941b-45dd-aabc-b7cf5a53caa7" - ownerName: string
-
- parent: SimpleReferenceV1
-
The parent of this item, if applicable - must have objectType PROJECT or FOLDER
- path: string
-
The path within the repository, if applicable
Example: "app-name/folder-1-name/folder-2-name" - payloadUrl: string
-
- prettyStatus: string
-
- project: SimpleReferenceV1
-
The app that this item belongs to, if applicable - must have objectType PROJECT
- resultUrl: string
-
- runLogMessages: boolean
-
True indicates that incremental run log messages should be sent to the web socket for the client that submitted this request.
- runlogUrl: string
-
- shareStatus: string , x ∈ { PRIVATE , READONLY , FULLACCESS }
-
The share status of this item, if applicable
- solver: ComputeSolverV1
-
Specify any solver specific options if the type of the job is SOLVER
- status: string
-
- objectType: string , x ∈ { SCENARIO , PROJECT , MODEL_SCHEMA , USER , PROJECT_USER , VIRTUAL_SCENARIO_GROUP , EXECUTION_STATUS , EXECUTION_REQUEST , FOLDER , VIEW , TABLEAU_WORKBOOK , SCENARIO_RUN_LOG , ATTACHMENT , EXECUTION_WORKER , EXECUTION_SERVICE , EXECUTION_WORKER_MAPPING , AUTHORITY_GROUP , USER_PROFILE , PORTATION , MIRROR_REQUEST , MIRROR_REQUEST_STATUS , MIRROR_DESCRIPTOR_STATUS , COMPUTE_JOB }
-
The type of object
Example: "SCENARIO" - id: string
-
The id of this item
Example: "21384a4b-2c4a-4ce2-9f78-87c967ebe06e" - displayName: string
-
The name of this item
Example: "Item name" - url: string
-
The URL of this item
Example: "/insightservices/rest/v1/item/21384a4b-2c4a-4ce2-9f78-87c967ebe06e"
Properties
- action: string
-
- callbacks: string[]
-
Array of string - controls: object
-
string - flags: string[]
-
Array of string - problemType: string
-
- resultsToInclude: string[]
-
Array of string
Properties
- objectType: string , x ∈ { SCENARIO , PROJECT , MODEL_SCHEMA , USER , PROJECT_USER , VIRTUAL_SCENARIO_GROUP , EXECUTION_STATUS , EXECUTION_REQUEST , FOLDER , VIEW , TABLEAU_WORKBOOK , SCENARIO_RUN_LOG , ATTACHMENT , EXECUTION_WORKER , EXECUTION_SERVICE , EXECUTION_WORKER_MAPPING , AUTHORITY_GROUP , USER_PROFILE , PORTATION , MIRROR_REQUEST , MIRROR_REQUEST_STATUS , MIRROR_DESCRIPTOR_STATUS , COMPUTE_JOB }
-
The type of object
Example: "SCENARIO" - id: string
-
The id of this item
Example: "21384a4b-2c4a-4ce2-9f78-87c967ebe06e" - displayName: string
-
The name of this item
Example: "Item name" - url: string
-
The URL of this item
Example: "/insightservices/rest/v1/item/21384a4b-2c4a-4ce2-9f78-87c967ebe06e"