Object API functions

The object API functions are divided into two categories:

• ARGet functions, which transform XML objects into BMC Remedy AR System structures.
• ARSet functions, which transform BMC Remedy AR System structures into XML objects.

Object manipulation functions

You can perform get and set operations for each of the following objects:

Active links

• ARGetActiveLinkFromXML
• ARSetActiveLinkToXML

Character menus

• ARGetMenuFromXML
• ARSetMenuToXML

Containers

• ARGetContainerFromXML
• ARSetContainerToXML

DSO

• ARGetDSOMappingFromXML
• ARSetDSOMappingToXML
• ARGetDSOPoolFromXML
• ARSetDSOPoolToXML

Escalations

• ARGetEscalationFromXML
• ARSetEscalationToXML

Fields

• ARGetFieldFromXML
• ARSetFieldToXML

Filters

• ARGetFilterFromXML
• ARSetFilterToXML

Schemas

• ARGetSchemaFromXML
• ARSetSchemaToXML

VUIs

• ARGetVUIFromXML
• ARSetVUIToXML

Other functions for object manipulation

The XML API also includes the following functions to object manipulation:

• ARParseXMLDocument — creates a parsed XML stream for the ARGet XML functions.
• ARGetListXMLObjects — retrieves object names and types from an XML document.
• ARSetXMLDocHeaderToXML and ARSetXMLDocFooterToXML — generates the headers and footers of an XML document.