GetResourceValues
HTTP Request Formats
POST api/report/ResourceValues/plain
GET api/report/ResourceValues/{resourceName}/plain
To specify the schedule the command shall be sent to:
POST api/schedule/{scheduleName}/report/ResourceValues/plain
GET api/schedule/{scheduleName}/report/ResourceValues/{resourceName}/plain
Description
The GetResourceValues REST API command returns the value report for the specified attribute (capacity, accommodation, or availability) of the resource specified.
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/plain
Body:
{
"Id" : "SSR",
"Attribute" : "CapReport"
}
Alternative:
GET api/report/ResourceValues/SSR/plain
Return Message
Returns a message that contains the value timeline for the specified resource attribute. The report matches the format specified on the Data Values Report page.
Group Membership
This command belongs to the following group(s):
Version
12.3
