AR System API library functions
The functions provided in the API libraries enable programmers to control the following AR System components:
Component | Description |
|---|---|
Requests | Records in the database. Analogous to a row in a database table. Also known as entries. |
Forms | Objects used to query, modify, and submit records. Also known as schemas. |
Views | Various form (schema) layouts. Also known as VUIs. |
Fields | Objects in which data is entered on a form. Also, used to enhance the appearance of a form. Analogous to a column in a database table. |
Menus | Objects that can be attached to one or more fields often used to improve ease-of-use when selecting a value for a field. |
Filters | Server-side, action-based workflow rules. |
Escalations | Server-side, time-based workflow rules. |
Active links | Client-side, action-based, and time-based workflow rules. |
Containers | Generic lists of references that are used to define guides and applications. |
Support files | Files that clients can retrieve. Commonly used for reports but can be any file on the server. |
The API functions enable you to perform the following five actions:
- Create - Create an instance of the object.
- Delete - Delete an existing instance of the object.
- Get - Get details about an existing instance of the object.
- Set - Set (update) an existing instance of the object.
- GetList - Search and get a list of matching instances of the object.
Additional functions are available for Data Import, Data Export, User Administration, and Connection Control.