Object manipulation functions

Important

You can continue to use C APIs to customize your application, but C APIs are not enhanced to support new capabilities provided by Java APIs and REST APIs.

You can perform five primary operations (create, delete, get (retrieve), get list (retrieve a list), and set (modify) for each of the objects listed below. For example, you can retrieve field properties or create entries for a specified form. Users with administrator capability can create or delete forms or other objects on a specified server. Some server objects can also be manipulated in other ways by additional functions. Specifically, these are the AR System functions associated with each object.

Functions that are used to perform administrative operations are noted by an asterisk (*).

Active links

ARCreateActiveLink *
ARDeleteActiveLink *
ARGetActiveLink *
ARGetListActiveLink *
ARGetMultipleActiveLinks *
ARSetActiveLink *

Associations

ARCreateAssociation *
ARDeleteAssociation *
ARGetAssociation *
ARGetListAssociation *
ARGetMultipleAssociations *
ARSetAssociation *

Containers

ARCreateContainer *
ARDeleteContainer *
ARGetContainer
ARGetListContainer
ARGetMultipleContainers
ARSetContainer *

Entries

ARCreateEntry
ARDeleteEntry *
ARGetEntry
ARGetEntryBLOB
ARGetEntryBlock
ARGetEntryStatistics
ARGetListEntry
ARGetListEntryBlocks
ARGetListEntryWithFields
ARGetListEntryWithMultiSchemaFields
ARGetMultipleEntries
ARMergeEntry
ARSetEntry

Escalations

ARCreateEscalation *
ARDeleteEscalation *
ARGetEscalation
ARGetListEscalation
ARGetMultipleEscalations
ARSetEscalation *

Fields

ARCreateField *
ARCreateMultipleFields *
ARDeleteField *
ARDeleteMultipleFields *
ARGetField
ARGetListEntryWithFields
ARGetListField
ARGetMultipleExtFieldCandidates
ARGetMultipleFields
ARSetField *
ARSetMultipleFields *

Filters

ARCreateFilter *
ARDeleteFilter *
ARGetFilter
ARGetListFilter
ARGetMultipleFilters
ARSetFilter *

Character menus

ARCreateCharMenu *
ARDeleteCharMenu *
ARExpandCharMenu
ARGetCharMenu
ARGetListCharMenu
ARGetMultipleCharMenus
ARSetCharMenu *

Forms (schemas)

ARCreateSchema *
ARDeleteSchema *
ARGetListExtSchemaCandidates
ARGetListSchema
ARGetListSchemaWithAlias
ARGetMultipleSchemas
ARGetSchema
ARSetSchema *

Support files

ARCreateSupportFile *
ARDeleteSupportFile *
ARGetListSupportFile
ARGetSupportFile
ARSetSupportFile *

VUIs

ARCreateVUI *
ARDeleteVUI *
ARGetListVUI
ARGetMultipleVUIs
ARGetVUI
ARSetVUI *

Images

ARCreateImage *
ARGetImage
ARGetMultipleImages
ARSetImage *
ARDeleteImage *
ARGetListImage