Versions Compared

Old Version 3

changes.mady.by.user Chandresh Patel

Saved on

compared with

New Version 4

changes.mady.by.user Keith Ecker (Unlicensed)

Saved on

Key

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

Anchor
Top
Top

...

AttributesTypeDescription
environmentIdsList<Long>The list of environment Ids associated with the deployment permissions
deployAllEnvironmentsBooleanThe boolean representing whether the group is able to deploy all environments or not.

GET

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

...

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

When we run a GET request at the following URL

...

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

Back to Top

GET (Using Query Parameters)

This GET service will return a list of groups in the form of JSON objects based on the query parameters group name. Groups are only returned if they match all of the specified query parameters. If no query parameters are given this request will return the entire list of groups.

Info
titleAPI URLs

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

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

groupname={groupname}

Examples:
To search by group name:

http://host:port/flexdeploy/rest/topology/administration/security/group?groupname=read

...

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

When we run a GET request at the following URL

...

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


Back to Top

...

POST

This POST service will create a new group with the same attributes as the given JSON object.

...

Code Block
themeEclipse
titleGroup - 10000
{
   "description": "This is a simple group with no permissions.",
   "groupName": "Simple Group",
   "isActive": true,
   "isFDAdmin": false,
   "deploymentPermissions": {"environmentIds": [],
   "deployAllEnvironments":false
	},
   "globalPermissions":    [
            {
         "actionType": "UPDATE",
         "objectType": "APPROVAL"
      },
            {
         "actionType": "READ",
         "objectType": "NOTIFICATION"
      },
            {
         "actionType": "READ",
         "objectType": "SCHEDULEDTASK"
      },
            {
         "actionType": "READ",
         "objectType": "WORKFLOW"
      }
   ]
}

...

Code Block
themeEclipse
titleGroup - 10000
{
   "description": "This is a simple group with permissions.",
   "groupId": 10000,
   "groupName": "Simple Group",
   "isActive": true,
   "isFDAdmin": false,
   "deploymentPermissions": {"environmentIds"environmentIds": [],
   "deployAllEnvironments":false
[]  	},
   "globalPermissions":    [
            {
         "actionType": "UPDATE",
         "objectType": "APPROVAL"
      },
            {
         "actionType": "READ",
         "objectType": "NOTIFICATION"
      },
            {
         "actionType": "READ",
         "objectType": "SCHEDULEDTASK"
      },
            {
         "actionType": "READ",
         "objectType": "WORKFLOW"
      }
   ]
}

...

Code Block
themeEclipse
titleGroup - 10000
{
   "description": "This is a simple group with no permissions.",
   "groupName": "Simple Group",
   "isActive": true,
   "isFDAdmin": false,
   "deploymentPermissions": {"environmentIds": [],
   "deployAllEnvironments":false
	},
   "globalPermissions":    [
            {
         "actionType": "UPDATE",
         "objectType": "APPROVAL"
      },
            {
         "actionType": "READ",
         "objectType": "NOTIFICATION"
      },
            {
         "actionType": "READ",
         "objectType": "SCHEDULEDTASK"
      },
            {
         "actionType": "READ",
         "objectType": "WORKFLOW"
      }
   ]
}

...

Code Block
themeEclipse
titleEnvironment PUT Receive JSON
{
   "description": "This is an updated group.",
   "groupName": "Simple Group Put",
   "isActive": true,
   "isFDAdmin": false,
   "deploymentPermissions": {"environmentIds": [11001],
   "deployAllEnvironments":false
	},
   "globalPermissions":    [
            {
         "actionType": "UPDATE",
         "objectType": "APPROVAL"
      },
            {
         "actionType": "READ",
         "objectType": "NOTIFICATION"
      }
   ]
}

...

Code Block
themeEclipse
titleGroup - 10000
{
   "description": "This is an updated group.",
   "groupName": "Simple Group Put",
   "isActive": true,
   "isFDAdmin": false,
   "deploymentPermissions": {"environmentIds": [11001],
   "deployAllEnvironments":false
	},
   "globalPermissions":    [
            {
         "actionType": "UPDATE",
         "objectType": "APPROVAL"
      },
            {
         "actionType": "READ",
         "objectType": "NOTIFICATION"
      }
   ]
}

...

Back to Top

...

PATCH

This PATCH service will update an existing group with the information passed through a JSON object. If an attribute of the JSON is null it will not be updated in the group.

Info
titleAPI URL

http://host:port/flexdeploy/administration/security/group/{Id}

...

Code Block
themeEclipse
titleGroup - 10000
{
   "description": "This is a simple group with no permissions.",
   "groupName": "Simple Group",
   "isActive": true,
   "isFDAdmin": false,
   "deploymentPermissions": {"environmentIds": [],
   "deployAllEnvironments":false
	},
   "globalPermissions":    [
            {
         "actionType": "UPDATE",
         "objectType": "APPROVAL"
      },
            {
         "actionType": "READ",
         "objectType": "NOTIFICATION"
      },
            {
         "actionType": "READ",
         "objectType": "SCHEDULEDTASK"
      },
            {
         "actionType": "READ",
         "objectType": "WORKFLOW"
      }
   ]
}

...

Code Block
themeEclipse
titleGroup - 10000
{
   "description": "This is an patched group.",
   "groupName": "Simple Group Patch",
   "isActive": true,
   "isFDAdmin": false,
   "deploymentPermissions": {"environmentIds": [],
   "deployAllEnvironments":false
	},
   "globalPermissions":    [
            {
         "actionType": "UPDATE",
         "objectType": "APPROVAL"
      },
            {
         "actionType": "READ",
         "objectType": "NOTIFICATION"
      },
            {
         "actionType": "READ",
         "objectType": "SCHEDULEDTASK"
      },
            {
         "actionType": "READ",
         "objectType": "WORKFLOW"
      }
   ]
}

...