This is an archive version of the document. To get the most up-to-date information, see the current version.Get Collection for Scope
You can get license usage data for a VAO scope with the specified ID.
Request
To retrieve a representation of license usage data for a VAO scope, send the HTTP GET request to the /Scopes/{scopeId}/LicenseUsage endpoint.
HTTP Request
GET https://<hostname>:<port>/api/v3/Sites/{siteId}/Scopes/{scopeId}/LicenseUsage |
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 /LicenseUsage collection for the specified scope. The InLineModel schema is used for the resource collection representation.
Example
The following example returns license usage data for a VAO scope with the ID 87da0cab-09f5-4b8f-bd3c-a346983c2930 created on the VAO server with the ID 76da0d75-75b0-4675-8296-0142ad0d52a7.
|