Execution services
GET /insightservices/rest/v1/admin/execution/modes
Responses
*/*
- 200 OK
POST /insightservices/rest/v1/admin/execution/modes/{appId}/{executionModeName}
Request Body
application/json
Type: AppExecutionModeV1
appExecutionMode
Request Parameters
| Name | Description | Type | Data Type | |
|---|---|---|---|---|
| appId | appId |
path | string (uuid) | required |
| executionModeName | executionModeName |
path | string | required |
Responses
application/json
- 200 OK
-
Type: AppExecutionModeV1
OK
GET /insightservices/rest/v1/admin/execution/service
Responses
application/json
- 200 OK
POST /insightservices/rest/v1/admin/execution/service
Request Body
application/json
Type: ExecutionServiceV1
executionService
Responses
application/json
- 200 OK
-
Type: ExecutionServiceV1
OK
GET /insightservices/rest/v1/admin/execution/service/worker-mapping
Responses
application/json
- 200 OK
GET /insightservices/rest/v1/admin/execution/service/{id}
Request Parameters
| Name | Description | Type | Data Type | |
|---|---|---|---|---|
| id | id |
path | string (uuid) | required |
Responses
application/json
- 200 OK
-
Type: ExecutionServiceV1
OK
POST /insightservices/rest/v1/admin/execution/service/{id}
Request Body
application/json
Type: ExecutionServiceV1
executionService
Request Parameters
| Name | Description | Type | Data Type | |
|---|---|---|---|---|
| id | id |
path | string (uuid) | required |
Responses
application/json
- 200 OK
-
Type: ExecutionServiceV1
OK
DELETE /insightservices/rest/v1/admin/execution/service/{id}
Request Parameters
| Name | Description | Type | Data Type | |
|---|---|---|---|---|
| id | id |
path | string (uuid) | required |
Responses
application/json
- 200 OK
-
Type: SimpleReferenceV1
OK
POST /insightservices/rest/v1/admin/execution/service/{serviceId}/worker-mapping
Request Body
application/json
Type: ExecutionWorkerMappingV1
executionWorkerMapping
Request Parameters
| Name | Description | Type | Data Type | |
|---|---|---|---|---|
| serviceId | serviceId |
path | string (uuid) | required |
Responses
application/json
- 200 OK
-
Type: ExecutionWorkerMappingV1
OK
GET /insightservices/rest/v1/admin/execution/service/{serviceId}/worker-mapping/{workerId}
Request Parameters
| Name | Description | Type | Data Type | |
|---|---|---|---|---|
| serviceId | serviceId |
path | string (uuid) | required |
| workerId | workerId |
path | string (uuid) | required |
Responses
application/json
- 200 OK
-
Type: ExecutionWorkerMappingV1
OK
POST /insightservices/rest/v1/admin/execution/service/{serviceId}/worker-mapping/{workerId}
Request Body
application/json
Type: ExecutionWorkerMappingV1
executionWorkerMapping
Request Parameters
| Name | Description | Type | Data Type | |
|---|---|---|---|---|
| serviceId | serviceId |
path | string (uuid) | required |
| workerId | workerId |
path | string (uuid) | required |
Responses
application/json
- 200 OK
-
Type: ExecutionWorkerMappingV1
OK
DELETE /insightservices/rest/v1/admin/execution/service/{serviceId}/worker-mapping/{workerId}
Request Parameters
| Name | Description | Type | Data Type | |
|---|---|---|---|---|
| serviceId | serviceId |
path | string (uuid) | required |
| workerId | workerId |
path | string (uuid) | required |
Responses
*/*
- 204 No Content
-
No Content
GET /insightservices/rest/v1/admin/execution/worker
Responses
application/json
- 200 OK
POST /insightservices/rest/v1/admin/execution/worker
Request Body
application/json
Type: ExecutionWorkerV1
executionWorker
Responses
application/json
- 200 OK
-
Type: ExecutionWorkerV1
OK
GET /insightservices/rest/v1/admin/execution/worker/{id}
Request Parameters
| Name | Description | Type | Data Type | |
|---|---|---|---|---|
| id | id |
path | string (uuid) | required |
Responses
application/json
- 200 OK
-
Type: ExecutionWorkerV1
OK
POST /insightservices/rest/v1/admin/execution/worker/{id}
Request Body
application/json
Type: ExecutionWorkerV1
executionWorker
Request Parameters
| Name | Description | Type | Data Type | |
|---|---|---|---|---|
| id | id |
path | string (uuid) | required |
Responses
application/json
- 200 OK
-
Type: ExecutionWorkerV1
OK
DELETE /insightservices/rest/v1/admin/execution/worker/{id}
Request Parameters
| Name | Description | Type | Data Type | |
|---|---|---|---|---|
| id | id |
path | string (uuid) | required |
Responses
application/json
- 200 OK
-
Type: SimpleReferenceV1
OK
Properties
- app: SimpleReferenceV1
-
- clearInput: boolean
-
- description: string
-
- name: string
-
- numberOfThreads: integer (int32)
-
- preferredExecutionService: SimpleReferenceV1
-
- preferredExecutionServiceName: string
-
- unlimitedThreads: boolean
-
- url: string
-
Properties
- defaultService: boolean
-
- enabled: boolean
-
- objectType: string , x ∈ { EXECUTION_SERVICE }
-
- 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
- enabled: boolean
-
- jobCapacity: integer (int32)
-
- objectType: string , x ∈ { EXECUTION_WORKER_MAPPING }
-
- service: SimpleReferenceV1
-
- threadCapacity: integer (int32)
-
- unlimitedJobs: boolean
-
- unlimitedThreads: boolean
-
- worker: SimpleReferenceV1
-
- 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
- enabled: boolean
-
- jobCapacity: integer (int32)
-
- objectType: string , x ∈ { EXECUTION_WORKER }
-
- status: string
-
- statusLastModified: integer (int64)
-
- statusMessage: string
-
- threadCapacity: integer (int32)
-
- unlimitedThreads: boolean
-
- version: string
-
- workerUrl: 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
- 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
- start: integer (int32)
-
The start position of this list
Example: 2 - maxResults: integer (int32)
-
The maximum number of items to include in this list
Example: 7 - items: object[]
-
The items in this list
Array of AppExecutionModeV1
Properties
- start: integer (int32)
-
The start position of this list
Example: 2 - maxResults: integer (int32)
-
The maximum number of items to include in this list
Example: 7 - items: object[]
-
The items in this list
Array of ExecutionServiceV1
Properties
- start: integer (int32)
-
The start position of this list
Example: 2 - maxResults: integer (int32)
-
The maximum number of items to include in this list
Example: 7 - items: object[]
-
The items in this list
Array of ExecutionWorkerMappingV1
Properties
- start: integer (int32)
-
The start position of this list
Example: 2 - maxResults: integer (int32)
-
The maximum number of items to include in this list
Example: 7 - items: object[]
-
The items in this list
Array of ExecutionWorkerV1
© 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.