Versions Compared

Key

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

Anchor
Top
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: 

groupnamegroupName={groupname}

Examples:
To search by group name:

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

* searching by group name returns all groups that contain the specified string in their group name

Tip

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

Parameters

AttributesTypeRequiredDescription
groupnamegroupNameStringNoThe name of the group.

...

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}

...