Jobs
POST /insightservices/rest/v1/data/execution
Request Body
application/json
Type: ExecutionRequestV1
job
Responses
application/json
- 200 OK
-
Type: ExecutionStatusV1
OK
POST /insightservices/rest/v1/data/execution/
Request Body
application/json
Type: ExecutionRequestV1
job
Responses
application/json
- 200 OK
-
Type: ExecutionStatusV1
OK
GET /insightservices/rest/v1/data/execution/{id}
Request Parameters
| Name | Description | Type | Data Type | |
|---|---|---|---|---|
| id | id |
path | string (uuid) | required |
Responses
application/json
- 200 OK
-
Type: ExecutionStatusV1
OK
DELETE /insightservices/rest/v1/data/execution/{id}
Request Parameters
| Name | Description | Type | Data Type | |
|---|---|---|---|---|
| id | id |
path | string (uuid) | required |
Responses
application/json
- 200 OK
-
Type: ExecutionStatusV1
OK
GET /insightservices/rest/v1/data/execution/{jobId}/debugSession
Request Parameters
| Name | Description | Type | Data Type | |
|---|---|---|---|---|
| jobId | jobId |
path | string (uuid) | required |
Responses
application/json
- 200 OK
-
Type: JobDebugSessionDto
OK
GET /insightservices/rest/v1/data/execution/{jobId}/jobMetrics
Request Parameters
| Name | Description | Type | Data Type | |
|---|---|---|---|---|
| jobId | jobId |
path | string (uuid) | required |
Responses
application/json
- 200 OK
-
Type: JobMetricsDto
OK
GET /insightservices/rest/v1/data/execution/{jobId}/message/{appMessageId}/file
Request Parameters
| Name | Description | Type | Data Type | |
|---|---|---|---|---|
| appMessageId | appMessageId |
path | string (uuid) | required |
| jobId | jobId |
path | string (uuid) | required |
Responses
application/json
- 200 OK
-
Type: InputStreamResource
Binary stream of file contents
- 404 Not Found
-
Job or App Message not found
GET /insightservices/rest/v1/data/execution/{jobId}/runLog
Request Parameters
| Name | Description | Type | Data Type | |
|---|---|---|---|---|
| jobId | jobId |
path | string (uuid) | required |
Responses
application/json
- 200 OK
-
Type: InputStreamResource
OK
GET /insightservices/rest/v1/data/execution/{jobId}/runlog
Request Parameters
| Name | Description | Type | Data Type | |
|---|---|---|---|---|
| jobId | jobId |
path | string (uuid) | required |
Responses
application/json
- 200 OK
-
Type: InputStreamResource
OK
POST /insightservices/rest/v1/data/job
Request Body
application/json
Type: ExecutionRequestV1
job
Responses
application/json
- 200 OK
-
Type: ExecutionStatusV1
OK
POST /insightservices/rest/v1/data/job/
Request Body
application/json
Type: ExecutionRequestV1
job
Responses
application/json
- 200 OK
-
Type: ExecutionStatusV1
OK
GET /insightservices/rest/v1/data/job/{id}
Request Parameters
| Name | Description | Type | Data Type | |
|---|---|---|---|---|
| id | id |
path | string (uuid) | required |
Responses
application/json
- 200 OK
-
Type: ExecutionStatusV1
OK
DELETE /insightservices/rest/v1/data/job/{id}
Request Parameters
| Name | Description | Type | Data Type | |
|---|---|---|---|---|
| id | id |
path | string (uuid) | required |
Responses
application/json
- 200 OK
-
Type: ExecutionStatusV1
OK
GET /insightservices/rest/v1/data/job/{jobId}/debugSession
Request Parameters
| Name | Description | Type | Data Type | |
|---|---|---|---|---|
| jobId | jobId |
path | string (uuid) | required |
Responses
application/json
- 200 OK
-
Type: JobDebugSessionDto
OK
GET /insightservices/rest/v1/data/job/{jobId}/jobMetrics
Request Parameters
| Name | Description | Type | Data Type | |
|---|---|---|---|---|
| jobId | jobId |
path | string (uuid) | required |
Responses
application/json
- 200 OK
-
Type: JobMetricsDto
OK
GET /insightservices/rest/v1/data/job/{jobId}/message/{appMessageId}/file
Request Parameters
| Name | Description | Type | Data Type | |
|---|---|---|---|---|
| appMessageId | appMessageId |
path | string (uuid) | required |
| jobId | jobId |
path | string (uuid) | required |
Responses
application/json
- 200 OK
-
Type: InputStreamResource
Binary stream of file contents
- 404 Not Found
-
Job or App Message not found
GET /insightservices/rest/v1/data/job/{jobId}/runLog
Request Parameters
| Name | Description | Type | Data Type | |
|---|---|---|---|---|
| jobId | jobId |
path | string (uuid) | required |
Responses
application/json
- 200 OK
-
Type: InputStreamResource
OK
GET /insightservices/rest/v1/data/job/{jobId}/runlog
Request Parameters
| Name | Description | Type | Data Type | |
|---|---|---|---|---|
| jobId | jobId |
path | string (uuid) | required |
Responses
application/json
- 200 OK
-
Type: InputStreamResource
OK
Properties
- jobType: string
-
The optional execution mode of (standard or user-defined) of the job being submitted
- objectType: string , x ∈ { EXECUTION_REQUEST }
-
- ownerId: string
-
The id of the user that owns this item
Example: "d26d907d-941b-45dd-aabc-b7cf5a53caa7" - 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" - project: SimpleReferenceV1
-
The app that this item belongs to, if applicable - must have objectType PROJECT
- shareStatus: string , x ∈ { PRIVATE , READONLY , FULLACCESS }
-
The share status of this item, if applicable
- 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
- causeOfFailure: string
-
- executionAttempts: integer (int32)
-
- executionMode: string
-
- executionService: string
-
- executionTime: integer (int32)
-
- executionWorker: string
-
- failureCount: integer (int32)
-
- gap: number (double)
-
- jobType: string , x ∈ { RUN , LOAD }
-
- modelName: string
-
- modelStatus: string
-
- numberOfSolutions: integer (int32)
-
- numberOfThreads: integer (int32)
-
- objectType: string , x ∈ { EXECUTION_STATUS }
-
- objective: number (double)
-
- optimizationService: string
-
- ownerId: string
-
The id of the user that owns this item
Example: "d26d907d-941b-45dd-aabc-b7cf5a53caa7" - 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" - prettyStatus: string
-
- project: SimpleReferenceV1
-
The app that this item belongs to, if applicable - must have objectType PROJECT
- scenario: ReferenceV1
-
- scenarioName: string
-
- scenarioOwner: string
-
- shareStatus: string , x ∈ { PRIVATE , READONLY , FULLACCESS }
-
The share status of this item, if applicable
- solverStatus: string
-
- status: string
-
- 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
- duration: integer (int64)
-
- execution: JobStageDto
-
- queued: JobStageDto
-
- startTime: integer (int64)
-
- version: integer (int64)
-
- worker: JobStageDto
-
Properties
- duration: integer (int64)
-
- metrics: object
- phase: string
-
- startTime: integer (int64)
-
Properties
- count: integer (int32)
-
- dataSize: integer (int64)
-
- duration: integer (int64)
-
- recordingStartTime: integer (int64)
-
Properties
- duration: integer (int64)
-
- phases: object[]
-
Array of JobPhaseDto - startTime: integer (int64)
-
Properties
- ownerId: string
-
The id of the user that owns this item
Example: "d26d907d-941b-45dd-aabc-b7cf5a53caa7" - 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" - project: SimpleReferenceV1
-
The app that this item belongs to, if applicable - must have objectType PROJECT
- shareStatus: string , x ∈ { PRIVATE , READONLY , FULLACCESS }
-
The share status of this item, if applicable
- 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
- 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"