Apps
GET /insightservices/rest/v1/data/project
Responses
application/json
- 200 OK
-
Type: WebServiceBeanListV1«AppV1»
OK
GET /insightservices/rest/v1/data/project/{appId}
Request Parameters
| Name | Description | Type | Data Type | |
|---|---|---|---|---|
| appId | appId |
path | string (uuid) | required |
Responses
application/json
- 200 OK
-
Type: AppV1
OK
GET /insightservices/rest/v1/data/project/{appId}/attachments
Request Parameters
| Name | Description | Type | Data Type | |
|---|---|---|---|---|
| appId | appId |
path | string (uuid) | required |
Responses
application/json
- 200 OK
-
Type: WebServiceBeanListV1«AttachmentV1»
Returns a WebServicesBeanList of Attachments
- 404 Not Found
-
App not found
POST /insightservices/rest/v1/data/project/{appId}/attachments
The attachment filename must conform to the following rules:
- length between 1 and 255 characters (in UTF-16)
- must not begin or end with a whitespace character
- must not contain any ISO Control Characters
- must not contain any of the characters \/?*:|<>"
Request Body
multipart/form-data
Request Parameters
| Name | Description | Type | Data Type | |
|---|---|---|---|---|
| appId | appId |
path | string (uuid) | required |
| attachment | formData | object | ||
| fileSize | formData | object | ||
| filename | formData | object | ||
| originalFilename | formData | object | ||
| overwrite | formData | object | ||
| tagName | formData | object |
Responses
application/json
- 200 OK
-
Type: AttachmentV1
an Attachment is returned (with an existing ID if an attachment was overwritten)
- 400 Bad Request
-
request is not well-formed
- 403 Forbidden
-
user does not have write access to the app
- 404 Not Found
-
user does not have access to the app
- 413 Request Entity Too Large
-
uploaded file is too large
- 422 Unprocessable Entity
-
request is not well-formed
POST /insightservices/rest/v1/data/project/{appId}/attachments/data
The successful response depends on the number of attachments requested:
- No attachments: returns a 204 NO_CONTENT response
- One attachment: downloads that one attachment (type application/octet-stream)
- More than one attachment: downloads all the files together as a zip in a file named after the app
Request Body
application/x-www-form-urlencoded
Request Parameters
| Name | Description | Type | Data Type | |
|---|---|---|---|---|
| appId | appId |
path | string (uuid) | required |
| attachmentIds | IDs of attachments to download |
formData | string | |
| attachmentUuids | formData | string[] , multiple parameters (attachmentUuids=aaa&attachmentUuids=bbb) |
Responses
application/json application/octet-stream application/zip
- 200 OK
-
Binary stream of file contents (single file or zip)
- 204 No Content
-
No attachments requested
- 403 Forbidden
-
Access denied
- 404 Not Found
-
App or attachment not found
GET /insightservices/rest/v1/data/project/{appId}/attachments/editors
Request Parameters
| Name | Description | Type | Data Type | |
|---|---|---|---|---|
| appId | appId |
path | string (uuid) | required |
Responses
application/json
- 200 OK
-
Type: WebServiceBeanListV1«EditorV1»
List of attachment editors available for the app
POST /insightservices/rest/v1/data/project/{appId}/attachments/new
Request Body
application/json
Type: AttachmentWithEditorDataV1
attachmentWithEditorData
Request Parameters
| Name | Description | Type | Data Type | |
|---|---|---|---|---|
| appId | appId |
path | string (uuid) | required |
Responses
application/json
- 200 OK
-
Type: AttachmentV1
Returns a new attachment
- 403 Forbidden
-
Access denied
- 404 Not Found
-
App not found
- 422 Unprocessable Entity
-
request is not well-formed
POST /insightservices/rest/v1/data/project/{appId}/attachments/trash
Request Body
application/json
Type:
attachmentIds
Request Parameters
| Name | Description | Type | Data Type | |
|---|---|---|---|---|
| appId | appId |
path | string (uuid) | required |
Responses
application/json
- 200 OK
-
Type: AttachmentsDeleteResponseV1
Returns a list of successes and failures
- 403 Forbidden
-
Access denied
- 404 Not Found
-
App not found
GET /insightservices/rest/v1/data/project/{appId}/attachments/{attachmentId}
Request Parameters
| Name | Description | Type | Data Type | |
|---|---|---|---|---|
| appId | appId |
path | string (uuid) | required |
| attachmentId | attachmentId |
path | string (uuid) | required |
Responses
application/json
- 200 OK
-
Type: AttachmentV1
Single Attachment
- 404 Not Found
-
App or attachment not found
POST /insightservices/rest/v1/data/project/{appId}/attachments/{attachmentId}
Request Body
application/json
Type: AttachmentV1
attachment
Request Parameters
| Name | Description | Type | Data Type | |
|---|---|---|---|---|
| appId | appId |
path | string (uuid) | required |
| attachmentId | attachmentId |
path | string (uuid) | required |
Responses
application/json
- 200 OK
-
Type: AttachmentV1
OK
DELETE /insightservices/rest/v1/data/project/{appId}/attachments/{attachmentId}
Request Parameters
| Name | Description | Type | Data Type | |
|---|---|---|---|---|
| appId | appId |
path | string (uuid) | required |
| attachmentId | attachmentId |
path | string (uuid) | required |
Responses
application/json
- 204 No Content
-
Returns no content if successful
- 403 Forbidden
-
Access denied
- 404 Not Found
-
App or attachment not found
GET /insightservices/rest/v1/data/project/{appId}/attachments/{attachmentId}/data
Request Parameters
| Name | Description | Type | Data Type | |
|---|---|---|---|---|
| appId | appId |
path | string (uuid) | required |
| attachmentId | attachmentId |
path | string (uuid) | required |
Responses
application/json
- 200 OK
-
Type: InputStreamResource
Binary stream of file contents
- 403 Forbidden
-
Access denied
- 404 Not Found
-
App or attachment not found
GET /insightservices/rest/v1/data/project/{appId}/attachments/{attachmentId}/editor
Request Parameters
| Name | Description | Type | Data Type | |
|---|---|---|---|---|
| appId | appId |
path | string (uuid) | required |
| attachmentId | attachmentId |
path | string (uuid) | required |
| editorId | editorId |
path | string |
Responses
application/json
- 200 OK
-
Type: AttachmentEditorDetailsV1
Returns attachment editor details
- 404 Not Found
-
App, attachment or editor not found
GET /insightservices/rest/v1/data/project/{appId}/attachments/{attachmentId}/editor/{editorId}
Request Parameters
| Name | Description | Type | Data Type | |
|---|---|---|---|---|
| appId | appId |
path | string (uuid) | required |
| attachmentId | attachmentId |
path | string (uuid) | required |
| editorId | editorId |
path | string | required |
Responses
application/json
- 200 OK
-
Type: AttachmentEditorDetailsV1
Returns attachment editor details
- 404 Not Found
-
App, attachment or editor not found
POST /insightservices/rest/v1/data/project/{appId}/attachments/{attachmentId}/editor/{editorId}
Request Body
application/json
editorPropertiesJson
Request Parameters
| Name | Description | Type | Data Type | |
|---|---|---|---|---|
| appId | appId |
path | string (uuid) | required |
| attachmentId | attachmentId |
path | string (uuid) | required |
| editorId | editorId |
path | string | required |
Responses
application/json
- 200 OK
-
Type: AttachmentEditorProperties
Returns new attachment editor properties
- 404 Not Found
-
Scenario, attachment or editor not found
GET /insightservices/rest/v1/data/project/{appId}/children
Request Parameters
| Name | Description | Type | Data Type | |
|---|---|---|---|---|
| appId | appId |
path | string (uuid) | required |
Responses
application/json
- 200 OK
-
Type: WebServiceBeanListV1«ReferenceV1»
OK
POST /insightservices/rest/v1/data/project/{appId}/children
Request Body
application/json
Type: SimpleReferenceV1
the item, with its ID and object type
Request Parameters
| Name | Description | Type | Data Type | |
|---|---|---|---|---|
| appId | the ID of the app |
path | string (uuid) |
Responses
application/json
- 200 OK
-
Type: ReferenceV1
Responds with the moved scenario
- 403 Forbidden
-
The current user is not authorized to move the scenario
- 404 Not Found
-
The app is unavailable to the current user
- 422 Unprocessable Entity
-
The user is trying to move some other type of object (not a scenario), or the scenario is unavailable to the current user
GET /insightservices/rest/v1/data/project/{appId}/users
Request Parameters
| Name | Description | Type | Data Type | |
|---|---|---|---|---|
| appId | appId |
path | string (uuid) | required |
Responses
application/json
- 200 OK
-
Type: WebServiceBeanListV1«User»
OK
GET /insightservices/rest/v1/data/project/{appId}/views
Request Parameters
| Name | Description | Type | Data Type | |
|---|---|---|---|---|
| appId | appId |
path | string (uuid) | required |
Responses
application/json
- 200 OK
-
Type: WebServiceBeanListV1
OK
App details
Properties
- executionModes: object
- extendedProjectInfo: ExtendedProjectInfo
-
- hasDataSource: boolean
-
- helpUrl: string
-
- modelDataVersion: integer (int32)
-
- onlyDefaultTypes: boolean
-
- 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
- scenarioTypes: object
- shareStatus: string , x ∈ { PRIVATE , READONLY , FULLACCESS }
-
The share status of this item, if applicable
- state: string
-
- type: AppTypeV1
-
- useProjectNameForAppTitle: boolean
-
- 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
- properties: AttachmentEditorProperties
-
- url: string
-
Properties
- description: string
-
- mandatory: boolean
-
- name: string
-
- usage: string , x ∈ { SINGLE_FILE , MULTI_FILE }
-
Properties
- dataUrl: string
-
The URL from which the attachment contents can be downloaded
- description: string
-
A description of this attachment
- editors: object[]
-
This attachment's editors
Array of EditorV1 - filename: string
-
The file name of this attachment
- hidden: boolean
-
Whether the attachment is hidden
- lastModifiedDate: string (date-time)
-
The timestamp of when the attachment contents were last modified
- lastModifiedUser: string
-
- objectType: string , x ∈ { ATTACHMENT }
-
- ownerId: string
-
The id of the user that owns this item
Example: "d26d907d-941b-45dd-aabc-b7cf5a53caa7" - parent: SimpleReferenceV1
-
The parent of this attachment - must have objectType of either PROJECT or SCENARIO
- 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
- size: integer (int64)
-
The size this attachment data in bytes
- tags: string[]
-
The tags which are present on this attachment
Array of 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
- attachmentEditorPropertiesJson: string
-
- attachmentInfo: AttachmentV1
-
- editorId: string
-
Response from a multi-attachment deletion operation
Properties
- failed: object
-
A map, indexed by attachment ID, of the failed delete operations
- success: string[]
-
The IDs of attachments that were successfully deleted
Array of string
Properties
- badExtensions: string[]
-
Array of string - canCreateNewFiles: boolean
-
- displayName: string
-
- goodExtensions: string[]
-
Array of string - hasDirtyFlag: boolean
-
- id: string
-
- url: string
-
Properties
- clearsInputData: boolean
-
- description: string
-
- name: string
-
- numberOfThreads: integer (int32)
-
Properties
- workbooks: object
Details a failed attempt to delete an attachment
Properties
- message: string
-
The error message produced by the failed delete operation
- status: string
-
The HTTP status code of the failed delete operation
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
- icons: object
-
string - id: string
-
- name: string
-
- operations: object
-
boolean - style: object
-
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"
Properties
- authorities: string[]
-
Array of string - authorityGroups: string[]
-
Array of string - displayName: string
-
- email: string
-
- evaluationUser: boolean
-
- firstName: string
-
- id: string
-
- lastName: 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 }
-
- ownerId: string
-
- path: string
-
- shareStatus: string
-
- url: string
-
- username: string
-
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 object
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 AppV1
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 AttachmentTagV1
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 AttachmentV1
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 EditorV1
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 ReferenceV1
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 User
© 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.