Date: Thu, 28 Mar 2024 23:22:41 +0000 (UTC) Message-ID: <793123887.9995.1711668161498@catch-kbase-p> Subject: Exported From Confluence MIME-Version: 1.0 Content-Type: multipart/related; boundary="----=_Part_9994_1568379985.1711668161498" ------=_Part_9994_1568379985.1711668161498 Content-Type: text/html; charset=UTF-8 Content-Transfer-Encoding: quoted-printable Content-Location: file:///C:/exported.html
Allows the search and retrieval of groups.
Root Relation: Groups
This resource supports the following methods: GET, POST
Retrieves all (or a subset) of groups.
This method supports the OData parameters $filter, $top, $take, $orderby= and $inlinecount. See OData Topic for more details.
For more details on expansions, please see the Expand help topic.
These are the expected status codes returned by the service. In addition= , some other status codes may be returned if either an internal error occur= s or there is an authentication issue (such as an expired OAuth token).
Status | Description |
---|---|
200 - OK | Returned if the request was completed successful= ly. |
An example of fetching all groups.
Request Headers
Key | Value | Description |
---|---|---|
Accept | application/json |
Response Headers
Key | Value | Description |
---|---|---|
Content-Type | application/json; charset=3Dutf-8 |
Response Body
[ { "Id": "9e1ee34b-f96f-4005-9f7a-1457df86256d", "Name": "Admins", "Description": "System Administrators", "Self": "http://localhost/api/group/9e1ee34b-f96f-4005-9f7a-1457df86256= d", "Links": [ { "Title": "Members", "Href": "http://localhost/api/group/9e1ee34b-f96f-4005-9f7a-1457df8= 6256d/users", "Rel": "Users" }, { "Href": "http://localhost/api/group/9e1ee34b-f96f-4005-9f7a-1457df8= 6256d/permissions/global", "Rel": "GlobalPermissions" }, { "Href": "http://localhost/api/group/9e1ee34b-f96f-4005-9f7a-1457df8= 6256d/permissions/projects", "Rel": "ProjectPermissions" } ] }, { "Id": "9e1ee34b-f96f-4005-9f7a-1457df86256d", "Name": "QA", "Description": "QA Team (Testers + Test Managers)", "Self": "http://localhost/api/group/9e1ee34b-f96f-4005-9f7a-1457df86256= d", "Links": [ { "Title": "Members", "Href": "http://localhost/api/group/9e1ee34b-f96f-4005-9f7a-1457df8= 6256d/users", "Rel": "Users" }, { "Href": "http://localhost/api/group/9e1ee34b-f96f-4005-9f7a-1457df8= 6256d/permissions/global", "Rel": "GlobalPermissions" }, { "Href": "http://localhost/api/group/9e1ee34b-f96f-4005-9f7a-1457df8= 6256d/permissions/projects", "Rel": "ProjectPermissions" } ] } ]
Status Code
200 - OK
An example of fetching a set of groups filtered by name, by using the OD= ATA $filter query parameter.
Request Headers
Key | Value | Description |
---|---|---|
Accept | application/json |
Request Parameters
Key | Value | Description |
---|---|---|
$filter | Name eq 'QA' | The ODATA $filter parameter, this query paramete= r should be url encoded i.e. $filter=3DName%20eq%20'QA' . |
Response Headers
Key | Value | Description |
---|---|---|
Content-Type | application/json; charset=3Dutf-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-1457df86256= d", "Links": [ { "Title": "Members", "Href": "http://localhost/api/group/9e1ee34b-f96f-4005-9f7a-1457df8= 6256d/users", "Rel": "Users" }, { "Href": "http://localhost/api/group/9e1ee34b-f96f-4005-9f7a-1457df8= 6256d/permissions/global", "Rel": "GlobalPermissions" }, { "Href": "http://localhost/api/group/9e1ee34b-f96f-4005-9f7a-1457df8= 6256d/permissions/projects", "Rel": "ProjectPermissions" } ] } ]
Status Code
200 - OK
Create a new group
These are the expected status codes returned by the service. In addition= , some other status codes may be returned if either an internal error occur= s or there is an authentication issue (such as an expired OAuth token).
Status | Description |
---|---|
200 - OK | Returned if the request was completed successful= ly. |
403 - Forbidden | Returned if request contained invalid data or wo= uld cause a conflict with an existing group record. |
404 - NotFound | Returned if group does not exists. |
Create a new group.
Request Headers
Key | Value | Description |
---|---|---|
Accept | application/json |
Request Body
{ "Id": null, "Name": "QA", "Description": "QA Team (Testers + Test Managers)" }
Response Headers
Key | Value | Description |
---|---|---|
Content-Type | application/json; charset=3Dutf-8 | |
Location | http://localhost/api/group/9e1ee34b-f96f-4= 005-9f7a-1457df86256d |
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-1457df862= 56d/users", "Rel": "Users" }, { "Href": "http://localhost/api/group/9e1ee34b-f96f-4005-9f7a-1457df862= 56d/permissions/global", "Rel": "GlobalPermissions" }, { "Href": "http://localhost/api/group/9e1ee34b-f96f-4005-9f7a-1457df862= 56d/permissions/projects", "Rel": "ProjectPermissions" } ] }
Status Code
201 - Created