Versions Compared

Key

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

...

XML

JSON


Expand
titleXML


Code Block
languagetext
Expand
titleJSON
Code Block
languagetext

...

Delete a Group

...

Description

...

URI

...

HTTP Method

...

DELETE

...

Description

...

Deletes a Group.

...

URI Parameters

...

See Group Delete a Group URI Parameters, below.

...

Example URI

...

...

Example Response

...

  • Status 200 /OK
    User group {groupname} deleted successfully.
  • Status 400 /Bad Request
    Mutual exclusion violation. Cannot specify groupid and groupname at the same time.
  • Status 404 /Not Found
    User group with {groupname/groupid} does not exist.

...

Delete a Group: URI Parameters

...

Parameter

...

Description

...

Specifications

...

Required

...

Mutually Exclusive With

...

groupid

...

ID used within the Controller to identify this group.

...

String; URI parameter.

...

Y (unless groupname is specified)

...

groupname

...

groupname

...

Name used within the Controller to identify this group.

...

String; URI parameter.

...

Y (unless groupid is specified)

...

groupid

...

List Groups

...

Description

...

URI

...

HTTP Method

...

GET

...

Description

...

Retrieves information on all Groups.

...

Example URI

...

Authentication

...

HTTP Basic

...

Produces Content-Type

...

application/xml, application/json

...

Example

...

See Read a Group: XML and JSON Examples.

...

Group Properties

...

See Group Properties.

...

Group Member Properties

...

See Group Member Properties.

...

Group Permission Properties

...

See Group Permission Properties.

...

Group Role Properties

...

See Group Role Properties.

...

List Groups XML and JSON Examples

XML

JSON

Expand
titleXML
Code Block
languagetext
<userGroups>
   <userGroup retainSysIds="true">
   <ctrlNavigationVisibility>false</ctrlNavigationVisibility>
   <description/>
   <email/>
   <groupMembers>
       <groupMember><userGroup retainSysIds="true">
    <ctrlNavigationVisibility>false</ctrlNavigationVisibility>
    <description />
    <email />
    <groupMembers>
        <groupMember>
            <sysId>386bf68d82a74a9e94eab18c1b1844c2</sysId>
            <user name="stone b branch">stonebranch-user-02</user>
        </groupMember>
        <groupMember>
            <sysId>792aa1dc1a1b4decb0b02d82ed7e9422</sysId>
            <user name="stone c branch">stonebranch-user-03</user>
        </groupMember>
        <groupMember>
            <sysId>b78079e1166d4c5180d7e42443de44a0</sysId>
            <user name="stone a branch">stonebranch-user-01</user>
        </groupMember>
    </groupMembers>
    <groupRoles>
        <groupRole>
            <role description="The administrator role.">ops_admin</role>
            <sysId>b80e78a42589435f92f3e176af6dc542</sysId>
        </groupRole>
    </groupRoles>
    <manager />
    <name>stonebranch-group-01</name>
    <navigationVisibility/>
    <parent />
    <permissions>
        <permission>
            <allGroups>true</allGroups>
            <commands />
            <defaultGroup>true</defaultGroup>
            <nameWildcard>*</nameWildcard>
            <notGroups>false</notGroups>
            <opCreate>false</opCreate>
            <opDelete>false</opDelete>
            <opExecute>false</opExecute>
            <opRead>true</opRead>
            <sysId>386bf68d82a74a9e94eab18c1b1844c2<<opUpdate>false</sysId>opUpdate>
       <user name="stone b branch">stonebranch-user-02</user>        </groupMember><opswiseGroups/>
       <groupMember>     <permissionType>Task Instance</permissionType>
 <sysId>792aa1dc1a1b4decb0b02d82ed7e9422</sysId>        <user name="stone c branch">stonebranch-user-03</user> <sysId>59e5565c9f6a45ed8633d05a91ac1019</sysId>
        </groupMember>permission>
    </permissions>
  <groupMember>  <sysId>b39b2b8eac644e068a68f92f325b0c74</sysId>
</userGroup>



...

Read a Group

...

Description

...

URI

...

HTTP Method

...

GET

...

Description

...

Retrieves information on a specific Group.

...

URI Parameters

...

See Read a Group: URI Parameters, below.

...

Example URI

...

...

Authentication

...

HTTP Basic

...

Consumes Content-Type

...

n/a

...

Produces Content-Type

...

application/xml, application/json

...

Example Response

...

...

Response Group Member Properties

...

See Group Member Properties.

...

Response Group Permission Properties

...

See Group Permission Properties.

...

Response Group Role Properties

...

See Group Role Properties.

...

Read a Group: URI Parameters

Parameter

Description

Specifications

Required

Mutually Exclusive With

groupid

ID used within the Controller to identify this group.

String; URI parameter.

Y (unless groupname is specified)

groupname

groupname

Name


Expand
titleJSON


Code Block
languagetext
{
  "ctrlNavigationVisibility" : <sysId>b78079e1166d4c5180d7e42443de44a0</sysId>false,
  "description" :  null,
 <user name="stone a branch">stonebranch-user-01</user>
 "email" : null,
  "groupMembers" : [ </groupMember>{
   </groupMembers> "sysId" : "386bf68d82a74a9e94eab18c1b1844c2",
<groupRoles>    "user" : {
 <groupRole>        <role description="The administrator role.">ops_admin</role>"name" : "stone b branch",
       <sysId>b80e78a42589435f92f3e176af6dc542</sysId>
"value" : "stonebranch-user-02"
    }
 </groupRole> }, {
 </groupRoles>    <manager/>
"sysId" : "792aa1dc1a1b4decb0b02d82ed7e9422",
  <name>stonebranch-group-01</name>  "user" : <navigationVisibility/>{
   <parent/>   "name" <permissions>: "stone c branch",
    <permission>  "value" : "stonebranch-user-03"
   <allGroups>true</allGroups> }
  }, {
  <commands/>  "sysId" : "b78079e1166d4c5180d7e42443de44a0",
   <defaultGroup>true</defaultGroup> "user" : {
    <nameWildcard>*</nameWildcard>  "name" : "stone a branch",
 <notGroups>false</notGroups>     "value"   <opCreate>false</opCreate>: "stonebranch-user-01"
    }
  <opDelete>false</opDelete>} ],
  "groupRoles" : [ {
<opExecute>false</opExecute>    "role" : {
 <opRead>true</opRead>     "description" : "The <opUpdate>false</opUpdate>
administrator role.",
      <opswiseGroups/>
 "value" : "ops_admin"
    },
<permissionType>Task Instance</permissionType>   "sysId" : "b80e78a42589435f92f3e176af6dc542"
  <sysId>59e5565c9f6a45ed8633d05a91ac1019</sysId>} ],
  "manager" : null,
 </permission> "name"   </permissions>: "stonebranch-group-01",
  "navigationVisibility" : [ ],
   <sysId>b39b2b8eac644e068a68f92f325b0c74</sysId>
"parent" : null,
  </userGroup>
</userGroups>
Expand
titleJSON

...

Modify a Group

...

Description

...

URI

...

HTTP Method

...

PUT

...

Description

...

Modifies the Group specified by the sysId in the request.
 
To modify Group properties without modifying related records, see the excludeRelated property, below.

...

Example URI

...

Consumes Content-Type

...

application/xml, application/json

...

Produces Content-Type

...

n/a

...

Example Request

...

See Create and Modify a Group: XML and JSON Examples.

...

Group Properties

...

See Group Properties.

...

Group Member Properties

...

See Group Member Properties.

...

Group Permission Properties

...

See Group Permission Properties.

...

Group Role Properties

...

See Group Role Properties.

...

Example Response

...

  • Status 200 /OK
    Successfully updated the user group with sysId <sysId>.
"permissions" : [ {
    "allGroups" : true,
    "commands" : null,
    "defaultGroup" : true,
    "nameWildcard" : "*",
    "notGroups" : false,
    "opCreate" : false,
    "opDelete" : false,
    "opExecute" : false,
    "opRead" : true,
    "opUpdate" : false,
    "opswiseGroups" : [ ],
    "permissionType" : "Task Instance",
    "sysId" : "59e5565c9f6a45ed8633d05a91ac1019"
  } ],
  "retainSysIds" : true,
  "sysId" : "b39b2b8eac644e068a68f92f325b0c74"
}



Anchor
Delete a Group
Delete a Group

Delete a Group


Description

URI

http://host_name/uc/resources/usergroup

HTTP Method

DELETE

Description

Deletes a Group.

URI Parameters

See Group Delete a Group URI Parameters, below.

Example URI

Example Response

  • Status 200 /OK
    User group {groupname} deleted successfully.
  • Status 400 /Bad Request
    Mutual exclusion violation. Cannot specify groupid and groupname at the same time.
  • Status 404 /Not Found
    User group with {groupname/groupid} does not exist.

Anchor
Delete a Group URI Parameters
Delete a Group URI Parameters

Delete a Group: URI Parameters

Parameter

Description

Specifications

Required

Mutually Exclusive With

groupid

ID used within the Controller to identify this group.

String; URI parameter.

Y (unless groupid groupname is specified)groupid

groupname

...

Read a Group XML and JSON Examples

The retainSysIds property is specified as an attribute in the <userGroup> element of the XML response.
 

XML

JSON

Expand
titleXML
Code Block
languagetext
<userGroup retainSysIds="true">
   <ctrlNavigationVisibility>false</ctrlNavigationVisibility>
   <description/>
   <email/>
   <groupMembers>
     <groupMember>
      <sysId>386bf68d82a74a9e94eab18c1b1844c2</sysId>
      <user name="stone b branch">stonebranch-user-02</user>
     </groupMember>
     <groupMember>
      <sysId>792aa1dc1a1b4decb0b02d82ed7e9422</sysId>
      <user name="stone c branch">stonebranch-user-03</user>
     </groupMember>
     <groupMember>
      <sysId>b78079e1166d4c5180d7e42443de44a0</sysId>
      <user name="stone a branch">stonebranch-user-01</user>
     </groupMember>
   </groupMembers>
   <groupRoles>
     <groupRole>
      <role description="The administrator role.">ops_admin</role>
      <sysId>b80e78a42589435f92f3e176af6dc542</sysId>
     </groupRole>
   </groupRoles>
   <manager/>
   <name>stonebranch-group-01</name>
   <navigationVisibility/>
   <parent/>
   <permissions>
     <permission>
      <allGroups>true</allGroups>
      <commands/>
      <defaultGroup>true</defaultGroup>
      <nameWildcard>*</nameWildcard>
      <notGroups>false</notGroups>
      <opCreate>false</opCreate>
      <opDelete>false</opDelete>
      <opExecute>false</opExecute>
      <opRead>true</opRead>
      <opUpdate>false</opUpdate>
      <opswiseGroups/>
      <permissionType>Task Instance</permissionType>
      <sysId>59e5565c9f6a45ed8633d05a91ac1019</sysId>
     </permission>
   </permissions>
   <sysId>b39b2b8eac644e068a68f92f325b0c74</sysId>
 </userGroup>883b1b5e1</sysId>
</userGroup>
Expand
titleJSON
Code Blocklanguagetext

groupname

Name used within the Controller to identify this group.

String; URI parameter.

Y (unless groupid is specified)

groupid

Anchor
List Groups
List Groups

List Groups


Description

URI

http://host_name/uc/resources/usergroup/list

HTTP Method

GET

Description

Retrieves information on all Groups.

Example URI

http://localhost:8080/uc/resources/usergroup/list

Authentication

HTTP Basic

Produces Content-Type

application/xml, application/json

Example

See Read a Group: XML and JSON Examples.

Group Properties

See Group Properties.

Group Member Properties

See Group Member Properties.

Group Permission Properties

See Group Permission Properties.

Group Role Properties

See Group Role Properties.

Anchor
List Groups XML and JSON Examples
List Groups XML and JSON Examples

List Groups XML and JSON Examples

XML

JSON


Expand
titleXML


Code Block
languagetext
<userGroups>
    <userGroup>
        <ctrlNavigationVisibility>false</ctrlNavigationVisibility>
        <description/>
        <email/>
        <groupMembers>
            <groupMember>
                <sysId>386bf68d82a74a9e94eab18c1b1844c2</sysId>
                <user name="stone b branch">stonebranch-user-02</user>
            </groupMember>
            <groupMember>
                <sysId>792aa1dc1a1b4decb0b02d82ed7e9422</sysId>
                <user name="stone c branch">stonebranch-user-03</user>
            </groupMember>
            <groupMember>
                <sysId>b78079e1166d4c5180d7e42443de44a0</sysId>
                <user name="stone a branch">stonebranch-user-01</user>
            </groupMember>
        </groupMembers>
        <groupRoles>
            <groupRole>
                <role description="The administrator role.">ops_admin</role>
                <sysId>b80e78a42589435f92f3e176af6dc542</sysId>
            </groupRole>
        </groupRoles>
        <manager />
        <name>stonebranch-group-01</name>
        <navigationVisibility/>
        <parent />
        <permissions>
            <permission>
                <allGroups>true</allGroups>
                <commands/>
                <defaultGroup>true</defaultGroup>
                <nameWildcard>*</nameWildcard>
                <notGroups>false</notGroups>
                <opCreate>false</opCreate>
                <opDelete>false</opDelete>
                <opExecute>false</opExecute>
                <opRead>true</opRead>
                <opUpdate>false</opUpdate>
                <opswiseGroups/>
                <permissionType>Task Instance</permissionType>
                <sysId>59e5565c9f6a45ed8633d05a91ac1019</sysId>
            </permission>
        </permissions>
        <sysId>b39b2b8eac644e068a68f92f325b0c74</sysId>
    </userGroup>
<userGroups>




Expand
titleJSON


Code Block
languagetext
[ {
  "ctrlNavigationVisibility" : false,
  "description" : null,
  "email" : null,
  "groupMembers" : [ {
    "sysId" : "386bf68d82a74a9e94eab18c1b1844c2",
    "user" : {
      "name" : "stone b branch",
      "value" : "stonebranch-user-02"
    }
  }, {
    "sysId" : "792aa1dc1a1b4decb0b02d82ed7e9422",
    "user" : {
      "name" : "stone c branch",
      "value" : "stonebranch-user-03"
    }
  }, {
    "sysId" : "b78079e1166d4c5180d7e42443de44a0",
    "user" : {
      "name" : "stone a branch",
      "value" : "stonebranch-user-01"
    }
  } ],
  "groupRoles" : [ {
    "role" : {
      "description" : "The administrator role.",
      "value" : "ops_admin"
    },
    "sysId" : "b80e78a42589435f92f3e176af6dc542"
  } ],
  "manager" : null,
  "name" : "stonebranch-group-01",
  "navigationVisibility" : [ ],
  "parent" : null,
  "permissions" : [ {
    "allGroups" : true,
    "commands" : null,
    "defaultGroup" : true,
    "nameWildcard" : "*",
    "notGroups" : false,
    "opCreate" : false,
    "opDelete" : false,
    "opExecute" : false,
    "opRead" : true,
    "opUpdate" : false,
    "opswiseGroups" : [ ],
    "permissionType" : "Task Instance",
    "sysId" : "59e5565c9f6a45ed8633d05a91ac1019"
  } ],
  "sysId" : "b39b2b8eac644e068a68f92f325b0c74"
} ]



Anchor
Modify a Group
Modify a Group

Modify a Group


Description

URI

http://host_name/uc/resources/usergroup

HTTP Method

PUT

Description

Modifies the Group specified by the sysId in the request.
 
To modify Group properties without modifying related records, see the excludeRelated property, below.

Example URI

http://localhost:8080/uc/resources/usergroup

Consumes Content-Type

application/xml, application/json

Produces Content-Type

n/a

Example Request

See Create and Modify a Group: XML and JSON Examples.

Group Properties

See Group Properties.

Group Member Properties

See Group Member Properties.

Group Permission Properties

See Group Permission Properties.

Group Role Properties

See Group Role Properties.

Example Response

  • Status 200 /OK
    Successfully updated the user group with sysId <sysId>.

Anchor
Read a Group
Read a Group

Read a Group


Description

URI

http://host_name/uc/resources/usergroup

HTTP Method

GET

Description

Retrieves information on a specific Group.

URI Parameters

See Read a Group: URI Parameters, below.

Example URI

Authentication

HTTP Basic

Consumes Content-Type

n/a

Produces Content-Type

application/xml, application/json

Example Response

Response Group Member Properties

See Group Member Properties.

Response Group Permission Properties

See Group Permission Properties.

Response Group Role Properties

See Group Role Properties.

Anchor
Read a Group URI Parameters
Read a Group URI Parameters

Read a Group: URI Parameters

Parameter

Description

Specifications

Required

Mutually Exclusive With

groupid

ID used within the Controller to identify this group.

String; URI parameter.

Y (unless groupname is specified)

groupname

groupname

Name used within the Controller to identify this group.

String; URI parameter.

Y (unless groupid is specified)

groupid

Anchor
Read a Group XML and JSON Examples
Read a Group XML and JSON Examples

Read a Group XML and JSON Examples

The retainSysIds property is specified as an attribute in the <userGroup> element of the XML response.
 

XML

JSON


Expand
titleXML


Code Block
languagetext
<userGroup retainSysIds="true">
    <ctrlNavigationVisibility>false</ctrlNavigationVisibility>
    <description />
    <email />
    <groupMembers>
        <groupMember>
            <sysId>386bf68d82a74a9e94eab18c1b1844c2</sysId>
            <user name="stone b branch">stonebranch-user-02</user>
        </groupMember>
        <groupMember>
            <sysId>792aa1dc1a1b4decb0b02d82ed7e9422</sysId>
            <user name="stone c branch">stonebranch-user-03</user>
        </groupMember>
        <groupMember>
            <sysId>b78079e1166d4c5180d7e42443de44a0</sysId>
            <user name="stone a branch">stonebranch-user-01</user>
        </groupMember>
    </groupMembers>
    <groupRoles>
        <groupRole>
            <role description="The administrator role.">ops_admin</role>
            <sysId>b80e78a42589435f92f3e176af6dc542</sysId>
        </groupRole>
    </groupRoles>
    <manager />
    <name>stonebranch-group-01</name>
    <navigationVisibility/>
    <parent />
    <permissions>
        <permission>
            <allGroups>true</allGroups>
            <commands />
            <defaultGroup>true</defaultGroup>
            <nameWildcard>*</nameWildcard>
            <notGroups>false</notGroups>
            <opCreate>false</opCreate>
            <opDelete>false</opDelete>
            <opExecute>false</opExecute>
            <opRead>true</opRead>
            <opUpdate>false</opUpdate>
            <opswiseGroups/>
            <permissionType>Task Instance</permissionType>
            <sysId>59e5565c9f6a45ed8633d05a91ac1019</sysId>
        </permission>
    </permissions>
    <sysId>b39b2b8eac644e068a68f92f325b0c74</sysId>
</userGroup>




Expand
titleJSON


Code Block
languagetext
{
  "ctrlNavigationVisibility" : false,
  "description" : null,
  "email" : null,
  "groupMembers" : [ {
    "sysId" : "386bf68d82a74a9e94eab18c1b1844c2",
    "user" : {
      "name" : "stone b branch",
      "value" : "stonebranch-user-02"
    }
  }, {
    "sysId" : "792aa1dc1a1b4decb0b02d82ed7e9422",
    "user" : {
      "name" : "stone c branch",
      "value" : "stonebranch-user-03"
    }
  }, {
    "sysId" : "b78079e1166d4c5180d7e42443de44a0",
    "user" : {
      "name" : "stone a branch",
      "value" : "stonebranch-user-01"
    }
  } ],
  "groupRoles" : [ {
    "role" : {
      "description" : "The administrator role.",
      "value" : "ops_admin"
    },
    "sysId" : "b80e78a42589435f92f3e176af6dc542"
  } ],
  "manager" : null,
  "name" : "stonebranch-group-01",
  "navigationVisibility" : [ ],
  "parent" : null,
  "permissions" : [ {
    "allGroups" : true,
    "commands" : null,
    "defaultGroup" : true,
    "nameWildcard" : "*",
    "notGroups" : false,
    "opCreate" : false,
    "opDelete" : false,
    "opExecute" : false,
    "opRead" : true,
    "opUpdate" : false,
    "opswiseGroups" : [ ],
    "permissionType" : "Task Instance",
    "sysId" : "59e5565c9f6a45ed8633d05a91ac1019"
  } ],
  "retainSysIds" : true,
  "sysId" : "b39b2b8eac644e068a68f92f325b0c74"
}



Anchor
Properties
Properties

...