ARGetMultipleSchemas

Note

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.

Description

Retrieves information about multiple forms with the indicated names from the specified server. This information does not include the form field definitions (see ARGetField or ARGetMultipleFields). This function performs the same action as ARGetSchema but is easier to use and more efficient than retrieving information about multiple forms one by one.

Information is returned in lists for each item, with one item in the list for each form returned. For example, if the second item in the list for existList is TRUE, the name of the second form is returned in the second item in the list for schemaNameList.

Privileges

This operation can be performed by users with access permission for the form. Access to groupList and admingrpList information is limited to users with BMC Remedy AR System administrator privileges.

Synopsis

#include "ar.h"
#include "arerrno.h"
#include "arextern.h"
#include "arstruct.h"

int ARGetMultipleSchemas(
  ARControlStruct *control,
  ARTimestamp changedSince,
  ARUnsignedIntList *schemaTypeList,
  ARNameList *nameList,
  ARInternalIdList *fieldIdList,
  ARBooleanList *existList,
  ARNameList *schemaNameList,
  ARCompoundSchemaList *schemaList,
  ARSchemaInheritanceListList *schemaInheritanceListList,
  ARPermissionListList *assignedGroupListList,
  ARPermissionListList *groupListList,
  ARInternalIdListList *admingrpListList,
  AREntryListFieldListList *getListFieldsList,
  ARSortListList *sortListList,
  ARIndexListList *indexListList,
  ARArchiveInfoList archiveInfoList.
  ARAuditInfoList auditInfoList.
  ARAssociationsToFollowInfoList *assocToFollowInfoList,
  ARNameList *defaultVuiList,
  ARTextStringList *helpTextList,
  ARTimestampList *timestampList,
  ARAccessNameList *ownerList,
  ARAccessNameList *lastChangedList,
  ARTextStringList *changeDiaryList,
  ARPropListList *objPropListList,
  ARStatusList *status)

Input arguments

control

The control record for the operation. It contains information about the user requesting the operation, where that operation is to be performed, and which session is used to perform it. The user and server fields are required.

To specify whether to search for an object's real or resolved name, use the AR_SESS_CONTROL_PROP_API_OVERLAYGROUP variable of the ARSetSessionConfiguration function (see ARSetSessionConfiguration). For calls that use field or view IDs, the search is performed on the real or resolved name of the associated form.

If you do not use the AR_SESS_CONTROL_PROP_API_OVERLAYGROUP variable, the BMC Remedy AR System server uses the default overlay group at run time. For information about configuring the default overlay group, see the description for Overlay-mode in Configuration-settings-N-R.

changedSince

A time stamp that limits the forms retrieved to those modified after the specified time. Specify 0 for this parameter to retrieve forms with any modification time stamp.

schemaTypeList

A list of values that indicate the form types to retrieve (some types are mutually exclusive).

To retrieve both visible and hidden forms, add 1024 (AR_HIDDEN_INCREMENT) to the form type. For example, specify AR_LIST_SCHEMA_ALL | AR_HIDDEN_INCREMENT for this parameter. This function does not support the AR_LIST_SCHEMA_UPLINK and AR_LIST_SCHEMA_DOWNLINK form types.

nameList

The names of the schemas to retrieve.

fieldIdList

List of form fields that exist in the retrieved schema. The system returns only the forms that contain all the fields in this list. Specify NULL for this parameter (or zero fields) to retrieve all (accessible) fields.

Note

Archive forms are not returned if you specify a list of form fields. You must specify NULL to return archive forms.

archiveInfoList

The list of archive information associated with the form. Specify NULL for this parameter to not retrieve archive information.

auditInfoList

The list of audit information associated with the form. Specify NULL for this parameter to not retrieve audit information.

assocToFollowInfoList

The list of associationsToFollowInfo associated with the form. Specify NULL for this parameter to not retrieve this information.

Return values

existList

A list of flags and corresponding Boolean values that indicate whether the forms exist. Values: TRUE means the forms exists; FALSE means the form does not exist.

schemaNameList

An array of retrieved schema names.

schemaList

A list of form types (base form or join form). See ARCreateSchema for a description of the possible values. Specify NULL for this parameter if you do not want to retrieve this value.

schemaInheritanceListList

This is reserved for future use. Specify NULL.

assignedGroupListList

A list of zero or more groups that are directly assigned permission to the forms.

groupListList

A list of zero or more groups who can access the forms, including the inheritance hierarchy in the case of hierarchical groups. Access to this information is limited to users with BMC Remedy AR System administrator privileges. Specify NULL for this parameter if you do not want to retrieve the group list.

If the static inheritance property is not enabled for the form, this list will be the same as the assignedGroupListList.

admingrpListList

A list of zero or more groups who can administer this form (and the associated filters, escalations, and active links). Users must belong to both a specified group and the Subadministrator group to obtain these privileges. Specify NULL for this parameter if you do not want to retrieve the administrator group list.

getListFieldsList

A list of zero or more fields that identifies the default query list data for retrieving form entries. Specify NULL for this parameter if you do not want to retrieve the default query list fields.

sortListList

A list of zero or more fields that identifies the default sort order for retrieving form entries. Specify NULL for this parameter if you do not want to retrieve this value.

indexListList

The set of zero or more indexes for the form. Specify NULL for this parameter if you do not want to retrieve the index list.

defaultVuiList

The default VUI label. Specify NULL for this parameter if you do not want to retrieve the index list.

helpTextList

A list of the help texts associated with the forms. Specify NULL for this parameter if you do not want to retrieve the help texts (which is useful if you are calling this function to verify whether instances of these objects exist).

timestampList

A list of time stamps that identify the last changes to the forms. Specify NULL for this parameter if you do not want to retrieve this value.

ownerList

A list of form owners. Specify NULL for this parameter if you do not want to retrieve the owners.

lastChangedList

A list of users who made the last changes to the forms. Specify NULL for this parameter if you do not want to retrieve this value.

changeDiaryList

A list of the change diaries associated with the forms. Use ARDecodeDiary to parse the change diary into user, time stamp, and text components. The server adds the user making the change and a time stamp when it saves the change diary. Specify NULL for this parameter if you do not want to retrieve the change diary. This value can be large, so do not retrieve it if the program does not need it, for example, if the program is only checking it an object exists.

objPropListList

A list of server object property lists that correspond to the schemas in schemaNameList. If this parameter is set to NULL, a properties list with zero properties is associated with the object, and when an ARGetSchema action is performed, zero properties are returned. See Server object properties.

status

A list of zero or more notes, warnings, or errors generated from a call to this function. For a description of all possible values, see Error-checking.