Getting Teams
You can get a resource representation of teams whose backed-up data was retrieved from an archive by a retrieval job with the specified ID.
Request
GET https://<hostname>:4443/v6/DataRetrievals/{dataRetrievalId}/teams |
Request Headers
The request header must contain an authorization token of the current session.
Request Parameters
The following parameter must be specified in the URL of the request:
Parameter | Type | Description |
|---|---|---|
dataRetrievalId | string | Specifies the identification number of the retrieval job. For more information on how to get this parameter, see Getting Retrieval Jobs. |
Request Body
None.
Response
The server returns the following response to the client.
Response Codes
A successfully completed operation returns a response code 200 OK.
Response Headers
The response to this request contains the following headers. The response may also include additional standard HTTPS headers.
Header | Description |
|---|---|
Content-length | The length of the response body. |
Content-type | The media type and syntax of the response body message: application/json; charset=utf-8 |
Response Body
In the response body, the server returns a resource representation of the /DataRetrievals/{dataRetrievalId}/teams resource. The response body contains the following properties:
Property | Type | Description |
|---|---|---|
id | string | Specifies the team ID. |
displayName | string | Specifies a display name of the team. |
description | string | Specifies a description of the team. |
_links | Dictionary of string [key] and Object [value] | Links to related resources (navigation property). |
Example
The example returns a resource representation of teams whose backed-up data was retrieved from an archive by the retrieval job with the ID 97ea63e9-125d-44e4-aaed-182c46b2b2b5.
Request: GET https://abc.tech.local:4443/v6/DataRetrievals/97ea63e9-125d-44e4-aaed-182c46b2b2b5/teams
Request Header: Authorization: Bearer <Access-Token>
Response: 200 OK
Response Body: [ { "id": "95e4e659-9039-45ef-826c-d1ba4b8e5d25", "displayName": "Team 1", "description": "", "_links": { "dataRetrieval": { "href": "/v6/dataRetrievals/97ea63e9-125d-44e4-aaed-182c46b2b2b5" } } }, { "id": "9d77731b-dcdf-4fa9-86d5-350bec0bdf0f", "displayName": "Team A", "description": "", "_links": { "dataRetrieval": { "href": "/v6/dataRetrievals/97ea63e9-125d-44e4-aaed-182c46b2b2b5" } } } ] |