Folders
| Operation | Description |
|---|---|
| POST /insightservices/rest/v1/data/folder | Create a new folder |
| GET /insightservices/rest/v1/data/folder/{folderId} | Get a folder |
| POST /insightservices/rest/v1/data/folder/{folderId} | Update a folder |
| DELETE /insightservices/rest/v1/data/folder/{folderId} | Delete a folder |
| GET /insightservices/rest/v1/data/folder/{folderId}/children | Get the contents of a folder |
| POST /insightservices/rest/v1/data/folder/{folderId}/children | Move an existing folder or scenario to a folder |
POST /insightservices/rest/v1/data/folder
The payload specifies the attributes of the new folder. The parent attribute specifies the folder or app the folder will be created within. It must be an app or a folder and must declare its objectType and id.The displayName attribute specifies the preferred name for the folder; a suffix will be applied to ensure its name is unique among its siblings. The objectType attribute is optional but must be FOLDER if supplied. All other attributes are ignored. Security: FOLDER_NEW is required to create a new folder and the user must have permission to modify the contents of the parent folder or app.
Request Body
application/json
Type: FolderV1
the folder to create
Responses
application/json
- 200 OK
-
Type: FolderV1
Responds with the successfully created folder, along with its assigned name.
- 403 Forbidden
-
The current user is not authorized to create this folder
- 404 Not Found
-
The app or parent folder are unavailable to the current user
GET /insightservices/rest/v1/data/folder/{folderId}
Request Parameters
| Name | Description | Type | Data Type | |
|---|---|---|---|---|
| folderId | the id of the folder |
path | string (uuid) |
Responses
application/json
- 200 OK
-
Type: FolderV1
Responds with the retrieved folder
- 404 Not Found
-
The folder is unavailable to the current user
POST /insightservices/rest/v1/data/folder/{folderId}
The payload contains the updates to apply to the folder. They are all optional. The displayName attribute specifies the new preferred name for the folder; a suffix will be applied to ensure its name is unique among its siblings. The share status and owner attributes control visibility of the folder. When the share status is set to PRIVATE and no owner is supplied then the current user becomes the owner to ensure they do not lose access to the folder. The folder id attribute is optional, but if it is supplied then it must match the id in the URL. The objectType is optional, but if it is supplied then it must be FOLDER. All other attributes are ignored. Security: FOLDER_EDIT is required to change the folder name, FOLDER_SHARE is required to change the share status, and FOLDER_OWNER is required to change the owner, and the user must have write access to the folder.
Request Body
application/json
Type: FolderV1
the updates to apply
Request Parameters
| Name | Description | Type | Data Type | |
|---|---|---|---|---|
| cascadeOwner | change the owner of all descendants to be the same as this folder's |
query | boolean | |
| cascadeShareStatus | change the share status of all descendants to be the same as this folder's |
query | boolean | |
| folderId | the id of the folder |
path | string (uuid) |
Responses
application/json
- 200 OK
-
Type: FolderV1
Responds with the successfully updated folder
- 403 Forbidden
-
The current user is not authorized to update this folder
- 404 Not Found
-
The folder is unavailable to the current user
- 422 Unprocessable Entity
-
Validation of the requested changes failed. e.g. the displayName was too long.
DELETE /insightservices/rest/v1/data/folder/{folderId}
This operation will delete the folder and all of its contents. Security: FOLDER_DELETE is required to delete the folder.
Request Parameters
| Name | Description | Type | Data Type | |
|---|---|---|---|---|
| folderId | the id of the folder |
path | string (uuid) |
Responses
application/json
- 204 No Content
-
Responds with success if the folder was deleted
- 403 Forbidden
-
The current user is not authorized to delete this folder
- 404 Not Found
-
The folder is unavailable to the current user
GET /insightservices/rest/v1/data/folder/{folderId}/children
Request Parameters
| Name | Description | Type | Data Type | |
|---|---|---|---|---|
| folderId | the id of the folder |
path | string (uuid) |
Responses
application/json
- 200 OK
-
Type: WebServiceBeanListV1«ReferenceV1»
Responds with the folder's contents as a list, both folders and scenarios, sorted by name
- 404 Not Found
-
The folder is unavailable to the current user
POST /insightservices/rest/v1/data/folder/{folderId}/children
Request Body
application/json
Type: SimpleReferenceV1
the item to move, with its ID and object type
Request Parameters
| Name | Description | Type | Data Type | |
|---|---|---|---|---|
| folderId | the ID of the new parent |
path | string (uuid) |
Responses
application/json
- 200 OK
-
Type: ReferenceV1
Responds with the moved item
- 403 Forbidden
-
The current user is not authorized to move the item to this folder
- 404 Not Found
-
The item is unavailable to the current user
- 422 Unprocessable Entity
-
The user is trying to move some other type of object (not a folder or scenario), or the item is unavailable to the current user
Folders live in projects and can contain scenarios and other folders.
Properties
- displayName: string
-
Example: "Folder name" - id: string
-
The id of this folder
Example: "9b70bd59-9499-4848-9b5b-75aaa0c26f35" - objectType: string , x ∈ { FOLDER }
-
- ownerId: string
-
The id of the user that owns this item
Example: "d26d907d-941b-45dd-aabc-b7cf5a53caa7" - parent: SimpleReferenceV1
-
The parent of this folder - 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
- url: string
-
The URL of this folder
Example: "/insightservices/rest/v1/admin/folder/9b70bd59-9499-4848-9b5b-75aaa0c26f35"
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"
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