Get Entries operation
The Get Entries operation retrieves one or more entries satisfying a specified condition from the BMC Remedy Action Request (AR) System schema.
The following table describes the input elements for the Get Entries operation:
Input elements for the Get Entries operation
Element | Description | Required |
---|---|---|
| Specifies the name of the adapter in the adapter configuration that is used to execute the operation | No |
| Specifies the BMC Remedy AR System schema from which the entries are retrieved | Yes |
| Specifies the fields to be returned by the query | Yes |
| Specifies the query statement used to determine the records to be selected | No |
| Identifies a BMC Remedy AR System field that must be evaluated to match the specified condition | No |
| Identifies the value specified in | No |
| Identifies an additional BMC Remedy AR System field that must be evaluated to match the specified condition Note | No |
| Identifies the value that must be present in the key2 field for an entry to be selected, based on the match condition specified Note
| No |
| Specifies whether attachments need to be downloaded with details or only the details are to be returned in the response
| No |
| Specifies whether the attachment is a Base 64-encoded string
| No |
| Contains the elements required to specify the sort criteria | No |
| Contains the | Conditional; required if |
| Specifies the BMC Remedy AR System schema field name or ID on which sorting is to be performed | Conditional; required if |
| Specifies the sorting order for the
| No |
| Specifies the maximum number of records to be retrieved per request | No |
Action name
Before running the operation, ensure that you specify the value of the Action field in the Call Adapter Activity to query.
The following figure shows an XML sample of the input elements for the Get Entries operation:
XML sample of the input elements for the Get Entries operation
<request-data>
<remedy-action>
<schema>Sample:Cities</schema>
<query>'Airport Code'="JIA"</query>
<fields>
<field>City</field>
<field>Airport Code</field>
</fields>
</remedy-action>
</request-data>
XML sample of the input elements for the Get Entries operation using a sort list
<request-data>
<remedy-action>
<schema>Test Sort</schema>
<fields>
<field>FirstName</field>
<field>LastName</field>
<field>Request ID</field>
<field>Short Description</field>
</fields>
<sort-field-list>
<field>
<name-or-id>FirstName</name-or-id>
<order>1</order>
</field>
<field>
<name-or-id>536870914</name-or-id> <!-- LastName field ID=536870914 -->
<order>2</order>
</field>
</sort-field-list>
<max-retrieve>10</max-retrieve>
</remedy-action>
</request-data>
Note
In the preceding sample, the fields are first sorted by "FirstName", and then the "LastName", whose field-id is 536870914.
The following table describes the output elements for the Get Entries operation:
Output elements for the Get Entries operation
Output | Description |
---|---|
| Contains the entry fields |
| Contains the metadata from the request |
| Contains the number of entries returned |
| Contains the entry IDs of the fields queried |
| Contains the field name and the corresponding value for the fields queried |
The following figure illustrates an XML sample of the output elements for the Get Entries operation:
XML sample of the output elements for the Get Entries operation
<get-action-result>
<entries>
<metadata>
<entry-count>6</entry-count>
</metadata>
<entry id="000000000000152">
<field name="User">Justin</field>
<field name="Priority">2</field>
<field name="Request ID">000000000000152</field>
</entry>
<entry id="000000000000153">
<field name="User">Sharon</field
<field name="Priority">9</field>
<field name="Request ID">000000000000153</field>
</entry>
<entry id="000000000000155">
<field name="User">Ted</field>
<field name="Priority">1</field>
<field name="Request ID">000000000000155</field>
</entry>
<entry id="000000000000156">
<field name="User">Sharon</field>
<field name="Priority">3</field>
<field name="Request ID">000000000000156</field>
</entry>
<entry id="000000000000158">
<field name="User">Ted</field>
<field name="Priority">8</field>
<field name="Request ID">000000000000158</field>
</entry>
<entry id="000000000000161">
<field name="User">Sharon</field>
<field name="Priority">2</field>
<field name="Request ID">000000000000161</field>
</entry>
</entries>
</get-action-result>
Comments
Log in or register to comment.