This is an archive version of the document. To get the most up-to-date information, see the current version.Get Details for Groups in Plan
You can get runtime details for every group included in a plan with the specified ID.
Request
To retrieve a representation of a collection for all groups in a specific plan, send the HTTP GET request to the /RuntimeDetails/Plans/{planId}/Groups endpoint.
HTTP Request
GET https://<hostname>:<port>/api/v3/RuntimeDetails/Plans/{planId}/Groups |
Request Headers
The request contains the following headers.
Header | Required/Optional | Value | Description |
|---|---|---|---|
Authorization | Required | Bearer <Access-Token> | Authenticates a client who sends the request to the server. Must contain the access token for the current logon session in the Bearer <Access-Token> format. |
Accept | Optional |
| Specifies a media type of representation that is required in the response message. If the requested type is not supported, the server will return the response in the application/json media type. |
Response
The server returns the following response to the client.
Response Code
A successfully completed operation returns 200 response code.
Response Headers
The response to this request contains the following headers. The response may also include additional standard HTTP headers.
Header | Value | Description |
|---|---|---|
Content-Length | integer | Identifies the length of the response body message, in bytes. |
Content-Type |
| Identifies the media type of the response body message. |
Response Body
In the response body, VAO returns a representation of the /RuntimeDetails collection for all groups included in the specified plan. The GroupRuntimeDetails schema is used for the collection representation.
Example
The following request returns runtime details for all groups included in a plan with the ID 62685fe6-222a-493d-a99b-feea900921a2.
|