FolderResource
Exposes Folder to a REST API
The following resources are part of this group:
/v1/data/folder
POST
Creates a new folder.
Request Body
| element: | reference |
| media types: | application/json |
the parameters for creating a folder.
Response Body
| element: | (custom) |
| media types: | application/json |
the created folder
- 400 Bad Request if parameters could not be parsed somehow
- 404 Not Found if the parent folder could not be found
- 403 Forbidden when not authorized to access the resource
/v1/data/folder/{id}
The following operations are supported on this resource:
GET
Reads a folder.
Parameters
| name | description | type | default |
|---|---|---|---|
| id | the GUID of the folder to read | path |
Response Body
| element: | folder |
| media types: | application/json |
a resource representation of the folder or
- 404 Not Found if the folder could not be found
- 403 Forbidden when not authorized to access the resource
POST
Updates a folder. The URL accepts the following query parameters.
Parameters
| name | description | type | default |
|---|---|---|---|
| id | the GUID of the folder to update | path | |
| cascadeShareStatus | when set to true the folder contents and all descendants will be set to the provided share status | query | |
| cascadeOwner | when set to true the folder contents and all descendants will be set to the provided owner | query |
Request Body
| element: | folder |
| media types: | application/json |
a bean representation of the latest state of the folder as sent by the client
Response Body
| element: | (custom) |
| media types: | application/json |
a 200 OK response with the updated folder reference
- 404 Not Found if the folder could not be found
- 403 Forbidden when not authorized to access the resource (and/or one or more of its contents or descendants if the cascade option(s) are set).
DELETE
Deletes a folder.
Parameters
| name | description | type | default |
|---|---|---|---|
| id | the GUID of the folder to delete | path |
Response Body
| element: | (custom) |
| media types: | application/json |
a 200 empty response or
- 404 Not Found if the folder could not be found
- 403 Forbidden when not authorized to access the resource
/v1/data/folder/{id}/children
GET
Lists the children (folder items/refs) of a folder.
Response codes indicate the following:- 200 OK: Operation successful
- 400 Bad Request: One or more of the provided parameters are invalid
- 404 Not found: The project or VSG could not be found
- 403 Forbidden: The user does not have authorit to access the project and/or the VSG
Parameters
| name | description | type | default |
|---|---|---|---|
| id | The id of the folder | path | |
| start | Start at this position in the list | query | 0 |
| maxResults | The maximum number of items to return | query | 50 |
Response Body
| element: | webServiceBeanList |
| media types: | application/json |
A paginated list of references
POST
Moves a Folder or Scenario into this destination folder.
The response code indicates the following:- 200 OK: folder or scenario successfully moved
- 403 Forbidden: insufficient rights to move the folder or scenario
- 404 Not Found: the folder or scenario does not exist, or this folder does not exist
- 409 Conflict: the destination path, if specified, does not match this folder's path
- 500 Internal Server Error: failed to perform move
Parameters
| name | description | type | default |
|---|---|---|---|
| id | the id of the this destination folder | path | |
| destinationPath | the path of the destination folder | query |
Request Body
| element: | reference |
| media types: | application/json |
the folder or scenario to move
Response Body
| element: | (custom) |
| media types: | application/json |
the current folder or scenario data
/v1/data/folder/{id}/export
GET
Export a folder and its contents recursively.
Parameters
| name | description | type | default |
|---|---|---|---|
| id | The id of the folder to export | path |
Response Body
| element: | (custom) |
| media types: | application/octet-stream |
The export file