Versions Compared

Key

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

Anchor
Top
Top

...

Table of Contents
maxLevel2

Back to Top

...

GET

GET by ID

This GET service will find a group with the given Id and return the JSON representation of the object. 

Info
titleAPI URL

http://host:port/flexdeploy/rest/administration/resourcetypes/{Id}

Parameters

Parameter

Type

Required

Description

Id

URLYesThis is a URL parameter for the Id which is used to find and return a resource type

Example

If we had a resource type in our database with an Id of 10000 and had the following attributes

Code Block
themeEclipse
titleResource Type - 10000
{
   "description": "test",
   "isFDAdmin": false,
   "groupId": 10000,
   "groupName": "test",
   "isActive": true,
   "globalPermissions": [   {
      "objectType": "WORKFLOW",
      "actionType": "READ"
   }],
   "deploymentPermissions": {"environmentIds":    [
      18605,
      20610
   ]}
}

When we run a GET request at the following URL

http://host:port/flexdeploy/rest/administration/security/group/10000

The GET request would return the following JSON group object

Code Block
themeEclipse
titleGroup - 10000
{
   "description": "test",
   "isFDAdmin": false,
   "groupId": 10000,
   "groupName": "test",
   "isActive": true,
   "globalPermissions": [   {
      "objectType": "WORKFLOW",
      "actionType": "READ"
   }],
   "deploymentPermissions": {"environmentIds":    [
      18605,
      20610
   ]}
}

Back to Top

GET (Using Query Parameters)

This GET service will return a list of resource types in the form of JSON objects based on a query parameter for the display name. Resource Types are only returned if they contain the specified parameter. If no query parameters are given this request will return the entire list of resource types.

Info
titleAPI URLs

http://host:port/flexdeploy/rest/administration/resourcetypes?

Append the following character sequences to the above URL to specify Query parameters.

resourceTypeName={resourceTypeName}

Examples:
To return all of the resource types:

http://host:port/flexdeploy/rest/administration/resourcetypes

To search by name only:

http://host:port/flexdeploy/rest/administration/resourcetypes?resourceTypeName={resourceTypeName}

...

Tip

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

Parameters

Parameter

Type

Required

Description

resourceTypeNameURLNoThis is a URL query parameter for the name which is used to search the resource types.

Example

If we had a resource types in our database with the following attributes

...