/api/space/group-management/groups/{id}

The following operations are supported on this resource:

  • GET - Get a single group details
  • PUT - Update group details
  • DELETE - Deletes the group
GET /groups/{id}Version 1

Get a single group details.

Sample Usage

GET /groups/{id}


  • Parameters:
    NameTypeURI TypeDescriptionRequired
    idIntegerPathID Y
  • Sample Output XML:
    <group href="/api/space/group-management/group/17" uri="/api/space/group-management/group/17">
         <name>Test Group</name>
         <description>It is a test group</description>
    </group>

  • Sample Output JSON:
    {
       "group" : {
         "@href" : "/api/space/group-management/group/17" ,
         "@uri" : "/api/space/group-management/group/17" ,
         "name" : Test Group ,
         "description" : It is a test group ,
       }
    }

  • Access Control

    The following capabilities are required to access this API: DefaultRead

    PUT /groups/{id}Version 1

    Update group details.

    Sample Usage

    PUT /groups/{id}


    • Parameters:
      NameTypeURI TypeDescriptionRequired
      groupIntegerPath   Y
  • Sample Input XML:
    <group>
        <description>Test group</description>
        <name>test</name>
    </group>

  • Sample Output XML:
    <group href="/api/space/group-management/groups/65537" uri="/api/space/group-management/groups/65537">
        <description>Test group</description>
        <users href="/api/space/group-management/groups/65537/users" />
        <id>65537</id>
        <name>test</name>
        <no-of-assigned-users>1</no-of-assigned-users>
    </group>

  • Sample Input JSON:
    {
        "group":{
            "name":"test",
            "description":"Test group",
        }
    }

  • Sample Output JSON:
    {
        "group":{
            "@uri":"/api/space/group-management/groups/65537",
            "@href":"/api/space/group-management/groups/65537",
            "id":65537,
            "description":"Test group",
            "name":"test",
            "no-of-assigned-users":1,
            "users":{
                "@href":"/api/space/group-management/groups/65537/users"
            }
        }
    }

  • Access Control

    The following capabilities are required to access this API: ModifyUserGroup

    DELETE /groups/{id}Version 1

    Deletes the group and returns the status.

    Sample Usage

    DELETE /groups/{id}


    • Parameters:
      NameTypeURI TypeDescriptionRequired
      group-idIntegerPathgroup ID Y

    Access Control

    The following capabilities are required to access this API: DeleteUserGroup