GetResourceInfoJson
HTTP Request Formats
POST api/report/resource
GET api/report/resource/{resourceName}
To specify the schedule the command shall be sent to:
POST api/schedule/{scheduleName}/report/resource
GET api/achedule/{scheduleName}/report/resource/{resourceName}
Description
The GetResourceInfoJson REST API command returns all of the attributes of the resource specified by the <ResourceName> parameter in JSON format.
GetResourceInfoJson vs. GetResourceInfo
The choice of command will depend on use case.
GetResourceInfoJson provides output in a commonly used format that is easy to parse. This command is preferred if resource value information will be further processed.
GetResourceInfo 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. Only one of "Id", "IdList", and "All" should be 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 |
| Groups | "Groups": ["ResGroup1","ResGroup2","ResGroup3"] | Parameter is a string of a comma delimited list of resource group names. Wildcards are allowed |
Examples
Finds the values of all the attributes of the SSR resource in the active schedule
POST api/report/resource
Body:
{
"Id" : "SSR"
}
Alternative:
GET api/report/resource/SSR
Return Message
Returns a message that contains all of the attribute data for the resource in JSON format.
Group Membership
This command belongs to the following group(s):
Version
12.3
