Resource: Groups Search ( /api/groupssearch )

Allows the searching of groups by partial match.

Root Relation: GroupsSearch

This resource supports the following methods: GET, POST

Methods

GET

Searches for groups by partial name match

Required Permissions

  • TestManagement/ManageExecutions/View
  • TestManagement/ManageScripts/View
  • TestManagement/ManageIncidents/View
  • TestManagement/ManageRequirements/View

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 group request was able to be satisfied.

Example - Search for groups

An example of fetching all groups.

Request Headers

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

Request Parameters

KeyValueDescription
{id}8E064E7A-847F-4853-AFFF-2CD1803664D7The ID of the user to fetch group membership for
queryadPartial name to search for

Response Headers

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

Response Body

{
  "Skip": 0,
  "Top": 25,
  "Total": 1,
  "Items": [
    {
      "Id": "9e1ee34b-f96f-4005-9f7a-1457df86256d",
      "Name": "Admins",
      "Description": "System Administrators",
      "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

POST

Searches for groups by partial name match (using POST to allow large existing value queries)

Required Permissions

  • TestManagement/ManageExecutions/View
  • TestManagement/ManageScripts/View
  • TestManagement/ManageIncidents/View
  • TestManagement/ManageRequirements/View

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 group request was able to be satisfied.

Example - Search for groups

An example of fetching all groups.

Request Headers

KeyValueDescription
Content-Typeapplication/x-www-form-urlencoded

Request Parameters

KeyValueDescription
{id}8E064E7A-847F-4853-AFFF-2CD1803664D7The ID of the user to fetch group membership for
queryadPartial name to search for

Response Headers

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

Response Body

{
  "Skip": 0,
  "Top": 25,
  "Total": 1,
  "Items": [
    {
      "Id": "9e1ee34b-f96f-4005-9f7a-1457df86256d",
      "Name": "Admins",
      "Description": "System Administrators",
      "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

  • No labels