Obtaining entry details with the Get operation type
External applications can use a Get operation to get details about an entry in BMC Remedy AR System.
Like the Set operation, Get needs a qualification that is specified in BMC Remedy Developer Studio. You cannot use an attachment field as a field reference in a qualification. For the Get operation, a qualification is automatically generated, and a particular entry is retrieved. You can modify the qualification. For the GetList operation, you must manually enter a qualification, or the system retrieves all the entries.
Qualifications for a Get or GetList operation can be static, semi-dynamic, or completely dynamic. These qualification types are described in Modifying existing entries with the Set operation type.
When BMC Remedy AR System receives an incoming Get request, it performs these actions:
- Determines whether the qualification is dynamic. If so, it expands the XPATH expressions with data from the incoming XML to make the qualification static.
- Searches the base form for entries matching this qualification. Unlike Set and Create, Get can handle multiple entries. Also, unlike Set and Create, BMC Remedy AR System ignores the input mapping; the input XML is used only for expanding XPATH expressions. For information about XPATH expressions, see Using the XPATH function for web service qualifications.
- Gets field values from the matched entries.
The action of obtaining the field values triggers the OnGetEntry filters.
- Uses the output mapping to generate XML code from these field values, and sends an XML document back as a response.
You do not need an input mapping for the Get operation; you can create it, but the system ignores it.
The default operations listed are Get and GetList. These are merely names for the operation type Get. Use the mappings to create a Get or a GetList operation. Get returns one entry, and GetList returns multiple entries. For GetList operations, map the form to a complex type with maxOccurs= aNumberGreaterThan1orUnbounded so that the resulting records (>1) can be passed to the user. For more information, see The Get operation type for complex documents.