ARGetSchema

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 the form with the indicated name from the specified server. This information does not include the form's field definitions (see ARGetField).

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 ARGetSchema(
  ARControlStruct *control,
  ARNameType name,
  ARCompoundSchema *schema,
  ARSchemaInheritanceList *schemaInheritanceList,
  ARPermissionList *assignedGroupList,
  ARPermissionList *groupList,
  ARInternalIdList *admingrpList,
  AREntryListFieldList *getListFields,
  ARSortList *sortList,
  ARIndexList *indexList,
  ARArchiveInfoStruct *archiveInfo,
  ARAuditInfoStruct *auditInfo,
  ARAssociationsToFollowInfoStruct *assocToFollowInfo,
   ARNameType defaultVui,
  char **helpText,
  ARTimestamp *timestamp,
  ARAccessNameType owner,
  ARAccessNameType lastChanged,
  char **changeDiary,
  ARPropList *objPropList,
  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.

name

The name of the form to retrieve.

Return values

schema

The form type (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 the form type.

schemaInheritance

This is reserved for future use. Specify NULL.

assignedGroupList

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

groupList

A list of zero or more groups who can access the form, 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 assignedGroupList.

admingrpList

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.

getListFields

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 this value.

sortList

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 the default sort fields.

indexList

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.

archiveInfo

If a form is to be archived, this is the archive information for the form. Specify NULL for this parameter if you do not want to retrieve the archive information. These are the values for archive type:

In addition to the archive type, archiveInfo also stores the form name (if archive type is AR_ARCHIVE_FORM), time to trigger the archive, and the archive qualification criteria. For an archive form, the archive type is AR_ARCHIVE_NONE and the name of the source form for which this is the archive form is returned.

auditInfo

If a form is to be audited, this is the audit information for the form. Specify NULL for this parameter if you do not want to retrieve the audit information. These are the values for audit type:

In addition to the audit type, auditInfo also stores the form name (if audit type is AR_AUDIT_COPY or AR_AUDIT_LOG) and the audit qualification criteria.

assocToFollowInfo

During the data archiving process, if the you want to specify the list of associations to be followed, use this schema. Specify NULL for this parameter if you do not want to retrieve the AssociationsToFollowForArchive information. The following are the values for AssociationSelectionType:

In addition to the Association selection Type, assocToFollowInfo also stores, association name list. This will be applied when association selection type is SPECIFIC_ONLY or ALL_ENFORCED.

defaultVui

The label for the default view.

helpText

The help text associated with the form. Specify NULL for this parameter if you do not want to retrieve the help text. 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.

timestamp

A time stamp that specifies the last change to the form (includes changing or adding fields or character menus). Specify NULL for this parameter if you do not want to retrieve this value.

owner

The owning user for the form. Specify NULL for this parameter if you do not want to retrieve the owner.

lastChanged

The user who made the last change to the form. Specify NULL for this parameter if you do not want to retrieve this value.

changeDiary

The change diary associated with the form. 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.

objPropList

A list of server object properties. If this parameter is set to NULL, no 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.