Powered by Redocly

Folder

Create Folder

Creates a folder for the given name and returns folderId with success message.

Request
header Parameters
Authorization
required
string
Default:

Bearer JWT Token

Example: E.g. 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
application/json
{
  • "name": "SCA",
  • "parentFolderId": "1"
}

Get folders based on the name provided

Return folders based on the name provided

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=E.g. 1 | default: 1
limit
integer <int32>
Default: 25

Number of records to fetch

Example: limit=E.g. 25 | default: 25
header Parameters
Authorization
required
string
Default:

Bearer JWT Token

Example: E.g. Bearer JWT_TOKEN
Responses
200

OK

400

Bad Request

401

Unauthorized

500

Internal Server Error

get/folders/search

Get Folder By Id

Get existing folder by folderId

Request
path Parameters
folderId
required
integer <int32>
header Parameters
Authorization
required
string
Default:

Bearer JWT Token

Example: E.g. Bearer JWT_TOKEN
Responses
200

OK

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

get/folders/{folderId}

Update folder details

Update folder details for the given folderId.

Request
path Parameters
folderId
required
integer <int32>
header Parameters
Authorization
required
string
Default:

Bearer JWT Token

Example: E.g. 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

OK

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

put/folders/{folderId}
Request samples
application/json
{
  • "name": "SCA",
  • "parentFolderId": "1"
}

Delete a folder

Deleting a folder will delete all subfolders, contained projects will be associated wih the parent folder(Projects(0)).

Request
path Parameters
folderId
required
integer <int32>

ID of the folder

Example: E.g. 1
header Parameters
Authorization
required
string
Default:

Bearer JWT Token

Example: E.g. Bearer JWT_TOKEN
Responses
200

OK

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

delete/folders/{folderId}
➔ Next to Inventory API