Versions Compared

Old Version 4

changes.mady.by.user Karl Henselin

Saved on

compared with

New Version 5

changes.mady.by.user Chandresh Patel

Saved on

Key

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

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

...

Include Page

...

titleBase URL for Folder REST API

...

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

REST V1 Authentication
REST V1 Authentication

Table of Contents
maxLevel2

Each function returns JSON Folder objects. The Folder Object is an object that has these attributes,

AttributesTypeDescriptionfolderNameStringThis is the name of the folder.folderIdStringThis is the type of the folder.parentFolderIdLongThis is the Id of the parent folder of this folder.descriptionStringThis is a description of this folder.isActiveBooleanThis Boolean indicates whether or not this folder is marked as active.subFoldersList<Long>This List contains the Id's of the active Folders in this Folder.applicationsList<Long>This List contains the Id's of the active Applications in this Folder.

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 Reponse
REST V1 Folder Reponse

Response Codes

HTTP CodeDescription
200Folder found and returned
400Bad request
401Unauthorized
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.

Parameters

Parameter
Required
Type
Description
folderNameNoURL(query)This is a URL query parameter for the name which is used to query Folders with.

Response Codes

HTTP Code
Description
200Folders were found and returned
400Bad request
401Unauthorized
500Unexpected internal server error

Example

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

...