Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Folders can be accessed through this API using the GET service.

Include Page
REST V1 Authentication
REST V1 Authentication

Table of Contents
maxLevel2

GET

There are two implementations of GET. One will find a Folder with the given Id and return the JSON representation of the Folder. The other will find a list of Folders matching the parameters supplied to it.

GET (Using Id)

This GET service will find a Folder by Id and return a JSON representation of it.

Info
titleAPI URLs

http://host:port/flexdeploy/rest/v1/folder/{id}

Request

Parameter
Required
Type
Description
idYesURLThis is a URL path parameter for the id which is used to find a folder.
Include Page
REST V1 Folder Response
REST V1 Folder Response

Response Codes

HTTP CodeDescription
200Folder found and returned
400Bad request
401UnauthorizedAuthentication failure
403Authorization failure (no access to resource)
404Folder not found
500Unexpected internal server error

Example

If we had a Folder in our database with the name '' with the following attributes:

Code Block
themeEclipse
titleFolder - "Folder1"
{
   "folderId": 12709,
   "parentFolderId": 99,
   "folderName": "Folder1",
   "isActive": true,
   "subFolders": [
		12343,
		15467,
		90234
	],
   "applications": [],
   "description": "This is a folder"
}

When we run a GET request at the following URL:

http://{host:port}/flexdeploy/rest/v1/folder/12709

The GET request would return the  following JSON Folder object

Code Block
themeEclipse
titleGET JSON Response
{
   "folderId": 12709,
   "parentFolderId": 99,
   "folderName": "Folder1",
   "isActive": true,
   "subFolders": [
		12343,
		15467,
		90234
	],
   "applications": [],
   "description": "This is a folder"
}

Get(Using Query Parameters)

...

Info
titleAPI URLs

http://host:port/flexdeploy/rest/v1/folder?

Append the following character sequences to the above URL to specify Query parameters.
Use '&' between successive query parameters: 

folderName={name}

Examples:
To search by name only:

http://host:port/flexdeploy/rest/v1/folder?folderName={name}

To search for all Folders:

http://host:port/flexdeploy/rest/v1/folder


Tip

The query parameters are not case sensitive. Searching by folderName=NAME is the same as searching by folderName=name.

Request

Parameter
Required
Type
Description
folderNameNoQuery - String

This is a URL query parameter for the name which is used to query Folders with.

Contains ignore case search for folder name. Application is special type of folder, but this API will only return folders that are not applications.

Include Page
REST V1 Folder Response
REST V1 Folder Response

Response Codes

HTTP Code
Description
200
Folders were found
Search successful and results returned
400Bad request
401
Unauthorized
Authentication failure
403Authorization failure (no access to resource)
500Unexpected internal server error

Example

If we had Folders in our database with the names 'Folder1' and 'Folder2' and the following attributes:

Code Block
themeEclipse
titleFolder - "Folder1"
{
   "folderId": 12709,
   "parentFolderId": 99,
   "folderName": "Folder1",
   "isActive": true,
   "subFolders": [
		12343,
		15467,
		90234
	],
   "applications": [],
   "description": "This is a folder"
}


Code Block
titleFolder - "Folder2"
{
   "folderId": 15467,
   "parentFolderId": 12709,
   "folderName": "Folder2",
   "isActive": true,
   "subFolders": [
		12991
	],
   "applications": [
		43271
	],
   "description": "This is another folder"
}

When we run a GET request at the following URL

http://host:port/flexdeploy/rest/v1/folder?folderName=Folder1

The GET request would return the  following JSON workflow object

Code Block
titleSearch By folderName=folder1
[ 
 {
   "folderId": 12709,
   "parentFolderId": 99,
   "folderName": "Folder1",
   "isActive": true,
   "subFolders": [
		12343,
		15467,
		90234
	],
   "applications": [],
   "description": "This is a folder"
 }
]