Folder

Create Folder

Use this API to create a project folder in the project tree. You provide the name for the new folder and specify its parent folder (or leave an empty value for parentFolderId to place the new folder under the project-tree root).

Request

header Parameters

Authorization

required

string

Default:

Bearer JWT Token

Example: Bearer JWT_TOKEN

Request Body schema: application/json

To create a folder, folderName is required and parentFolderId is optional.

name required	string [ 1 .. 255 ] characters name
parentFolderId	integer <int32> >= 1 parentFolderId

Responses

201

Created

400

Bad Request

401

Unauthorized

500

Internal Server Error

post/folders

Request samples

Payload

application/json

{"name": "SCA",
"parentFolderId": "1"
}

Get Folders Based on the Name Provided

This API returns a set of project folders based on the name string you provide.

Request

query Parameters

folderName	string Search happens based on the name given
offset	integer <int32> Default: 1 Index of the page to start with Example: offset=1 \| default: 1
limit	integer <int32> Default: 25 Number of records to fetch Example: limit=25 \| default: 25

header Parameters

Authorization

required

string

Default:

Bearer JWT Token

Example: Bearer JWT_TOKEN

Responses

200

400

Bad Request

401

Unauthorized

500

Internal Server Error

get/folders/search

Get Folder by ID

This API returns details about an existing project folder (identified by its folderId) in the project tree. Details include the folder’s creator and the ID and name of its parent folder.

Request

path Parameters

folderId

required

integer <int32>

header Parameters

Authorization

required

string

Default:

Bearer JWT Token

Example: Bearer JWT_TOKEN

Responses

200

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

get/folders/{folderId}

Update Folder Details

This API returns update folder details for the given folderId.

Request

path Parameters

folderId

required

integer <int32>

header Parameters

Authorization

required

string

Default:

Bearer JWT Token

Example: Bearer JWT_TOKEN

Request Body schema: application/json

Update details of a folder.

name required	string [ 1 .. 255 ] characters name
parentFolderId	integer <int32> >= 1 parentFolderId

Responses

200

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

put/folders/{folderId}

Request samples

Payload

application/json

{"name": "SCA",
"parentFolderId": "1"
}

Delete a Folder

Use this API to delete an existing project folder (identified by its folderId) in the project tree. This process will delete the folder and all its subfolders. All projects directly under the folder and under each of its subfolders will be placed directly under the folder’s parent folder.

Request

path Parameters

folderId

required

integer <int32>

ID of the folder

Example: 1

header Parameters

Authorization

required

string

Default:

Bearer JWT Token

Example: Bearer JWT_TOKEN

Responses

200

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

delete/folders/{folderId}

➔ Next to Inventory API