Scenarios folders

Scenarios can be grouped into folders for better organization. The following endpoints allow you to create and manage scenarios folders.

List scenario folders

get
/scenarios-folders

Retrieves a collection of all scenarios folders for a team with a given ID. Returned folders are sorted by name in ascending order.

Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Query parameters
teamIdintegerRequired

Unique ID of the Team.

Example: 1
Responses
200

Successful response

application/json
get
/scenarios-folders
200

Successful response

Create scenario folder

post
/scenarios-folders

Creates a new scenario folder with data passed in the request body. As the response, it returns all details of the created scenario folder.

Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Body
namestringRequired

The name of the scenario folder. The name must be at most 100 characters long and does not need to be unique.

teamIdintegerRequired

The unique ID of the team in which the scenario folder will be created.

Responses
200

Created a Folder

application/json
post
/scenarios-folders
200

Created a Folder

Delete scenario folder

delete
/scenarios-folders/{folderId}

Deletes a scenario folder with a given ID and returns the ID in the response.

Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Path parameters
folderIdintegerRequired

The unique ID of the scenario folder. It can be retrieved from the List scenarios folders endpoint.

Example: 1
Responses
200

Successful response

application/json
delete
/scenarios-folders/{folderId}
200

Successful response

Update scenario folder

patch
/scenarios-folders/{folderId}

Updates a scenario folder with a given ID by passing new values in the request body. Any property that is not provided will be left unchanged. In the response, it returns all details of the updated folder including properties that were not changed.

Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Path parameters
folderIdintegerRequired

The unique ID of the scenario folder. It can be retrieved from the List scenarios folders endpoint.

Example: 1
Query parameters
Body
namestringOptional

The name for the updated scenario folder. The name must be at most 100 characters long and does not need to be unique.

Responses
200

Folder updated

application/json
patch
/scenarios-folders/{folderId}
200

Folder updated

Last updated