REST
The REST (Representational State Transfer) collection method retrieves attributes from enabled servers and returns the results as a table.
Properties
- Namespace - Set of all namespaces referenced. Specify using notation: [ns0="uri0"][ns1="uri1"].. Example:
[ns0="http://type.abc.com"][ns1="http://app.abc.com"]
- Column Type - List all the metric column names and their types. Supported types are STRING and NUMBER. The order and data type of the columns should match the order and data type of the columns listed in the extension.
Example
If the response payload (XML) is:
<ns0:getEmployeeDataResponse xmlns:ns0="http://sample.demo.com"> <employee>1234</employee> <id>1234</id> <title>4</title> </ns0:getEmployeeDataResponse>
The Column Type will be:
Employee:STRING,Title:STRING,ID:NUMBER
Note:
The order of columns in Column Type should match the order of columns in the Row Type property. - Row Type - Provide a XPath/JSON-Path expression corresponding to each metric column defined above. For multiple metric columns, they should be separated by commas.
Example
If the response payload (XML) is:
<ns0:getEmployeeDataResponse xmlns:ns0="http://sample.demo.com"> <employee>1234</employee> <id>1234</id> <title>4</title> </ns0:getEmployeeDataResponse>
The Row Type will be (in XPath):
/ns0:getEmployeeDataResponse/employee,/ns0:getDataResponse/title,/ns0:getDataResponse/id
- Request element payload - Payload Element in XML/JSON format. Must be specified using the CDATA section if it is XML. (optional)
- Request Metadata - A serialized string of the object oracle.sysman.emInternalSDK.webservices.rs.api.request.Resource
Available Variables
Variables can be used in collection method properties. Variable names are case-sensitive. To escape '%', use '%%'.
Name | Description |
---|---|
%scriptsDir% |
Directory where scripts are stored. |
%NAME% |
Name of the entity. |
%TYPE% |
Entity type. |
%DISPLAY_NAME% |
Display name of target instance. |
%TYPE_DISPLAY_NAME% |
Display name of target type. |