Help Contents

 

Group

Resource: Group ( /api/group/{id} )

Allows the retrieval of details for an individual group.

This resource supports the following methods: DELETE, GET, PUT

Methods

DELETE


Deletes an existing group

Required Permissions

  • Administration/Organisation/ManageUserAndGroupSecurity

Status Codes

These are the expected status codes returned by the service. In addition, some other status codes may be returned if either an internal error occurs or there is an authentication issue (such as an expired OAuth token).

StatusDescription
200 - OKReturned if the request was completed successfully.
403 - ForbiddenReturned if request could not be completed.
404 - NotFoundReturned if group does not exists.

Example - Delete Group

Example of deleting a group.

Request Headers

KeyValueDescription
Acceptapplication/json

Request Parameters

KeyValueDescription
{id}9e1ee34b-f96f-4005-9f7a-1457df86256d

Response Headers

KeyValueDescription
Content-Typeapplication/json; charset=utf-8

Status Code

200 - OK

GET


Retrieves a single group by ID.

Supported Expansions

For more details on expansions, please see the Expand help topic.

Status Codes

These are the expected status codes returned by the service. In addition, some other status codes may be returned if either an internal error occurs or there is an authentication issue (such as an expired OAuth token).

StatusDescription
200 - OKReturned if the request was completed successfully.
404 - NotFoundReturned if user does not exists.

Example - Get Group

Example of fetching a group

Request Headers

KeyValueDescription
Acceptapplication/json

Request Parameters

KeyValueDescription
{id}9e1ee34b-f96f-4005-9f7a-1457df86256d

Response Headers

KeyValueDescription
Content-Typeapplication/json; charset=utf-8

Response Body

{
  "Id": "9e1ee34b-f96f-4005-9f7a-1457df86256d",
  "Name": "QA",
  "Description": "QA Team (Testers + Test Managers)",
  "Self": "http://localhost/api/group/9e1ee34b-f96f-4005-9f7a-1457df86256d",
  "Links": [
    {
      "Title": "Members",
      "Href": "http://localhost/api/group/9e1ee34b-f96f-4005-9f7a-1457df86256d/users",
      "Rel": "Users"
    },
    {
      "Href": "http://localhost/api/group/9e1ee34b-f96f-4005-9f7a-1457df86256d/permissions/global",
      "Rel": "GlobalPermissions"
    },
    {
      "Href": "http://localhost/api/group/9e1ee34b-f96f-4005-9f7a-1457df86256d/permissions/projects",
      "Rel": "ProjectPermissions"
    }
  ]
}

Status Code

200 - OK

PUT


Updates an existing group

Required Permissions

  • Administration/Organisation/ManageUserAndGroupSecurity

Status Codes

These are the expected status codes returned by the service. In addition, some other status codes may be returned if either an internal error occurs or there is an authentication issue (such as an expired OAuth token).

StatusDescription
200 - OKReturned if the request was completed successfully.
403 - ForbiddenReturned if request contained invalid data or would cause a conflict with an existing group record.
404 - NotFoundReturned if group does not exists.

Example - Update Group

Example of updating group.

Request Headers

KeyValueDescription
Acceptapplication/json

Request Parameters

KeyValueDescription
{id}9e1ee34b-f96f-4005-9f7a-1457df86256d

Request Body

{
  "Id": null,
  "Name": "QA",
  "Description": "QA Team (Testers + Test Managers)"
}

Response Headers

KeyValueDescription
Content-Typeapplication/json; charset=utf-8

Response Body

{
  "Id": "9e1ee34b-f96f-4005-9f7a-1457df86256d",
  "Name": "QA",
  "Description": "QA Team (Testers + Test Managers)",
  "Self": "http://localhost/api/group/9e1ee34b-f96f-4005-9f7a-1457df86256d",
  "Links": [
    {
      "Title": "Members",
      "Href": "http://localhost/api/group/9e1ee34b-f96f-4005-9f7a-1457df86256d/users",
      "Rel": "Users"
    },
    {
      "Href": "http://localhost/api/group/9e1ee34b-f96f-4005-9f7a-1457df86256d/permissions/global",
      "Rel": "GlobalPermissions"
    },
    {
      "Href": "http://localhost/api/group/9e1ee34b-f96f-4005-9f7a-1457df86256d/permissions/projects",
      "Rel": "ProjectPermissions"
    }
  ]
}

Status Code

200 - OK