GetResourceValuesJson
HTTP Request Formats
POST api/report/ResourceValues
GET api/report/ResourceValues/{resourceName}
To specify the schedule the command shall be sent to:
POST api/schedule/{scheduleName}/report/ResourceValues
GET api/schedule/{scheduleName}/report/ResourceValues/{resourceName}
Description
The GetResourceValuesJson REST API command returns the value report for the specified attribute (capacity, accommodation, or availability) of the resource specified by the <ResourceName> parameter in JSON format. The output will be formatted as a JSON array, even if information on only a single resource's attribute is requested. Each element in this JSON array maps to information on a single resource's specified attribute (capacity, accommodation, or availability).
GetResourceValuesJson vs. GetResourceValues
The choice of command will depend on use case.
GetResourceValuesJson provides output in a commonly used format that is easy to parse. This command is preferred if resource value information will be further processed.
GetResourceValues provides output that is difficult to parse but easy to understand. This command is preferred if no further processing is required.
Parameters
Parameters are only required if a POST endpoint is used
| JSON Parameters | Body Format | Description |
|---|---|---|
| Id | "Id" : "Res1" | Parameter is a string of a single resource name. Wildcards are allowed |
| IdList | "IdList": ["Res1","Res2","Res3"] | Parameter is a string of text in single quotes of a comma delimited list of resource names. Wildcards are allowed |
| All | "All : "TRUE" | Optional boolean will make a report for all resources within the schedule |
| Attribute | "Attribute" : ["AvailReport"] | The parameter options are Availability Report ("AvailReport"), Accommodation Report ("AccomReport"), or Capacity Report ("CapReport"). |
Examples
Requests a capacity value report for the SSR resource in the active schedule
POST api/report/ResourceValues
Body:
{
"Id" : "SSR",
"Attribute" : "CapReport"
}
Alternative:
GET api/report/ResourceValues/SSR/
Return Message
Returns a message that contains the value timeline for the specified resource attribute.
The following JSON file contains sample output of the above command.
The following JSON file contains sample output of the above command, with 'Capacity' replaced by 'Accommodation'.
The following JSON file contains sample output of the above command, with 'Capacity' replaced by 'Availability'.
Group Membership
This command belongs to the following group(s):
Version
12.3
