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

Authentication - Use Basic Authentication for this API.

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.

API URLs

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

Request

Parameter	Required	Type	Description
id	Yes	URL	This is a URL path parameter for the id which is used to find a folder.

Response

Attributes	Type	Description
folderName	String	This is the name of the folder.
folderId	String	This is the type of the folder.
parentFolderId	Long	This is the Id of the parent folder of this folder.
description	String	This is a description of this folder.
isActive	Boolean	This Boolean indicates whether or not this folder is marked as active.
subFolders	List<Long>	This List contains the Id's of the active Folders in this Folder.
applications	List<Long>	This List contains the Id's of the active Applications in this Folder.

Response Codes

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

Example

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

Folder - "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

GET JSON Response

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

Get(Using Query Parameters)

This GET service will find a folder by querying based on a folder name and return the JSON representations of the objects satisfying the query. If no query parameters are given this request will return the entire list of folders.

API 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

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

Request

Parameter	Required	Type	Description
folderName	No	Query - 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.

Parameter

Required

Type

Description

folderName

Query - 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.

Response

Attributes	Type	Description
folderName	String	This is the name of the folder.
folderId	String	This is the type of the folder.
parentFolderId	Long	This is the Id of the parent folder of this folder.
description	String	This is a description of this folder.
isActive	Boolean	This Boolean indicates whether or not this folder is marked as active.
subFolders	List<Long>	This List contains the Id's of the active Folders in this Folder.
applications	List<Long>	This List contains the Id's of the active Applications in this Folder.

Response Codes

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

Example

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

Folder - "Folder1"

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

Folder - "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

Search By folderName=folder1

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

Browser not supported