Get Schema operation
The Get Schema operation retrieves a complete list of the field definitions such as field name, field ID, and data type for a specified BMC Remedy Action Request (AR) System.
The following table describes the request elements for Get Schema operation:
Adapter request elements for the Get Schema operation
Element | Description | Required |
|---|---|---|
<adapter name> | Specifies the name of the adapter in the adapter configuration that is used to execute the operation | No |
<schema name> | Specifies the BMC Remedy AR System schema from which the schema is retrieved | Yes |
The following figure shows an XML sample of the input elements for the Get Schema operation:
XML sample of the input elements for the Get Schema operation
<remedy-action>
<schema>Alert Events</schema>
</remedy-action>
The following table describes the output elements for the Get Schema operation:
Output elements for the Get Schema operation
Element | Description |
|---|---|
<schema-name> | Contains the name of the schema defined in the request |
<metadata> | Contains the metadata elements returned |
<timestamp> | Contains the time stamp of the request |
<field-count> | Contains the number of fields returned for the requested schema |
<fields> | Contains the field elements returned for the requested schema |
<field> | Contains the field name, field ID, and data type for the returned field |
The following figure illustrates an XML sample of the output elements for the Get Schema operation:
XML sample of the output elements for the Get Schema operation
<schema name="Alert Events">
<metadata>
<timestamp>1119389568636</timestamp>
<field-count>14</field-count>
</metadata>
<fields>
<field name="User" id="2" type="Character string" />
<field name="Status History" id="15" type="Character string" />
<field name="Priority" id="705" type="Integer" />
<field name="Source" id="4" type="Character string" />
<field name="Modified Date" id="6" type="Time" />
<field name="Create Date" id="3" type="Time" />
<field name="UNUSED" id="8" type="Character string" />
<field name="Alert Text" id="704" type="Character string" />
<field name="Form" id="701" type="Character string" />
<field name="Request ID" id="1" type="Character string" />
<field name="Server" id="703" type="Character string" />
<field name="Last Modified By" id="5" type="Character string" />
<field name="Read" id="7" type="Enumeration" />
<field name="Request" id="702" type="Character string" />
</fields>
</schema>