This documentation supports the 9.1 version of Remedy Action Request System.

To view the latest version, select the version from the Product version menu.

ARGetEscalation

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 escalation with the indicated name from the specified server.

Privileges

BMC Remedy AR System administrator.

Synopsis

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

int ARGetEscalation(
   ARControlStruct *control,
   ARNameType name,
   AREscalationTmStruct *escalationTm,
   ARWorkflowConnectStruct *schemaList,
   unsigned int *enable,
   ARQualifierStruct *query,
   ARFilterActionList *actionList,
   ARFilterActionList *elseList,
   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 escalation to retrieve.

Return values

escalationTm

The time specification for evaluating the escalation condition. This parameter can take one of two forms: a time interval that defines how frequently the server checks the escalation condition (in seconds) or a bitmask that defines a particular day (by month or week) and time (hour and minute) for the server to check the condition. Specify NULL for this parameter if you do not want to retrieve this value.

schemaList

The list of form names the escalation is linked to. The escalation must be associated with a single form or a list of forms that currently exists on the server. Specify NULL for this parameter if you do not want to retrieve the list.

enable

A flag that specifies whether the escalation is disabled (0) or enabled (1). Specify NULL for this parameter if you do not want to retrieve this value.

query

A query operation performed when the escalation is executed that determines the set of entries to which the escalation actions (defined by the actionList parameter) are applied. The system returns 0 (AR_COND_OP_NONE) if the escalation has no qualification. Specify NULL for this parameter if you do not want to retrieve this value.

actionList

The set of actions performed for each entry that matches the criteria defined by the query parameter. This list can contain from 1 to 25 actions (limited by AR_MAX_ACTIONS). Specify NULL for this parameter if you do not want to retrieve this value.

elseList

The set of actions performed if no entries match the criteria defined by the query parameter. This list can contain from zero to 25 actions (limited by AR_MAX_ACTIONS). Specify NULL for this parameter if you do not want to retrieve this value.

helpText

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

owner

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

lastChanged

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

changeDiary

The change diary associated with the escalation. The server adds the user making the change and a time stamp when it saves the change diary. Use ARDecodeDiary to parse the change diary into user, time stamp, and text components. 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 list is 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.

See also

ARCreateEscalation, ARDecodeDiary, ARDeleteEscalation, ARGetListEscalation, ARGetMultipleEscalations, ARSetEscalation. See FreeAR for: FreeARFilterActionList, FreeARPropList, FreeARQualifierStruct, FreeARStatusList.

Was this page helpful? Yes No Submitting... Thank you

Comments