GetResourceInfo

HTTP Request Formats

POST api/report/resource/plain

GET api/report/resource/{resourceName}/plain

To specify the schedule the command shall be sent to:

POST api/schedule/{scheduleName}/report/resource/plain

GET api/achedule/{scheduleName}/report/resource/{resourceName}/plain

The GetResourceInfo REST API command returns all of the attributes of the resource specified by the <ResourceName> parameter.

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
FieldList	"FieldList" : ["<ReportField1>","<ReportField2>"]	<ReportField> are specific report fields that are desired. If this parameter is used, the report produced will only contain these fields (if not used the report will contain all fields). A list of fields can be found on the Resource Reports page.

Finds the values of all the attributes of the SSR resource in the active schedule

POST api/report/resource/plain

Body:

{

"Id" : "SSR"

}

Alternative:

GET api/report/resource/SSR/plain

Returns a message that contains all of the attribute data for the resource. The report matches the format specified on the Resource Report page.

This command belongs to the following group(s):

12.3