reportfieldExecute (Command)

  • Published on Jul 7, 2025
  • 1 minute(s) read
Prev Next

The reportfieldExecute executes report field–related administrative operations.

  Table:  reportfieldExecute commands
CommandDescription
REPORTFIELDCMD_VIEWRetrieves the settings of the specified report fields (see  REPORTFIELDCMD_VIEW).
REPORTFIELDCMD_CREATECreates new report fields (see  REPORTFIELDCMD_CREATE).
REPORTFIELDCMD_DELETEDeletes report fields (see  REPORTFIELDCMD_DELETE).
REPORTFIELDCMD_UPDATEUpdates report fields (see  REPORTFIELDCMD_UPDATE).

Parameters

  Table: reportfieldExecute input parameters
Parameter nameData typeDescription
sessionIDString

Required.The session identifier of the current administrative session. The logon command returns this identifier after a successful logon (see  logon (Command)).

cmdReportFieldCmdIDEnumRequired. The operation to be executed. (see Table: reportfieldExecute commands).
attributeSetReportFieldAttributeSetRequired. A set containing zero or more attribute fields.
  Table: reportfieldExecute oputput parameters
Parameter nameData typeDescription
resultsReportFieldResults

Result structure containing return and status codes and a list of zero or more result attribute fields.

The following field attributes are available for the operations of this command:

  Table: reportfieldExecute field attributes
Attribute nameData typeDescription
REPORTFIELDFLD_DOMAINString

The domain the report belongs to.

Up to 255 characters.

REPORTFIELDFLD_REPORT_IDStringThe name of the report.
REPORTFIELDFLD_DISPLAY_NAMEString

User-readable report field name.

Up to 255 characters.

REPORTFIELDFLD_OPERATIONString

The operation to perform on the report field.

Possible values:

  • max
  • min
  • count
  • sum
REPORTFIELDFLD_FIELD_NAMEString

The internal report field name.

REPORTFIELDFLD_CREATE_TIMEDatetime

The date and time the data record was created.

REPORTFIELDFLD_MODIFY_TIMEDatetime

The date and time the data record was last modified.

REPORTFIELDFLD_FIELD_ORDInteger 

REPORTFIELDFLD_FIELD_NAME can take the following values:

  • Action
  • Application
  • Back-End Authentication
  • Category
  • Characteristics
  • Client Location
  • Code
  • Command
  • Configuration Details
  • Credentials
  • Data Source
  • Data Source Location
  • Domain
  • Error Details
  • Error Message
  • Expiration Date
  • Fields
  • From
  • Input Details
  • Local Authentication
  • Message
  • Object
  • Operation
  • Outcome
  • Output Details
  • Password Protocol
  • Policy ID
  • RADIUS Profile
  • Reason
  • Request ID
  • Serial No
  • Server Location
  • Session ID
  • Source
  • Source Location
  • To
  • User ID
  • User Link
  • Version

REPORTFIELDCMD_VIEW

Retrieves the settings of the specified report fields.

The following attributes can be specified in the attributeSet input parameter of this command:

  Table: REPORTFIELDCMD_VIEW (Supported input attributes)
Attribute nameOptionality
REPORTFIELDFLD_DISPLAY_NAMEMandatory
REPORTFIELDFLD_DOMAINMandatory
REPORTFIELDFLD_REPORT_IDMandatory

The following attributes will be specified in the results output parameter of this command:

  Table: REPORTFIELDCMD_VIEW (Supported output attributes)
Attribute nameReturned
REPORTFIELDFLD_CREATE_TIMEAlways
REPORTFIELDFLD_DISPLAY_NAMEAlways
REPORTFIELDFLD_DOMAINAlways
REPORTFIELDFLD_FIELD_NAMEAlways
REPORTFIELDFLD_MODIFY_TIMEAlways
REPORTFIELDFLD_OPERATIONAlways
REPORTFIELDFLD_REPORT_IDAlways

REPORTFIELDCMD_CREATE

Creates new report fields.

The following attributes can be specified in the attributeSet input parameter of this command:

  Table: REPORTFIELDCMD_CREATE (Supported input attributes)
Attribute nameOptionality
REPORTFIELDFLD_DISPLAY_NAMEMandatory
REPORTFIELDFLD_DOMAINMandatory
REPORTFIELDFLD_FIELD_NAMEMandatory
REPORTFIELDFLD_FIELD_ORD 
REPORTFIELDFLD_OPERATION 
REPORTFIELDFLD_REPORT_IDMandatory

The following attributes will be specified in the results output parameter of this command:

  Table: REPORTFIELDCMD_CREATE (Supported output attributes)
Attribute nameReturned
REPORTFIELDFLD_CREATE_TIMEAlways
REPORTFIELDFLD_DISPLAY_NAMEAlways
REPORTFIELDFLD_DOMAINAlways
REPORTFIELDFLD_FIELD_NAMEAlways
REPORTFIELDFLD_MODIFY_TIMEAlways
REPORTFIELDFLD_REPORT_IDAlways

REPORTFIELDCMD_DELETE

Deletes report fields.

The following attributes can be specified in the attributeSet input parameter of this command:

  Table: REPORTFIELDCMD_DELTE (Supported input attributes)
Attribute nameOptionality
REPORTFIELDFLD_DISPLAY_NAMEMandatory
REPORTFIELDFLD_DOMAINMandatory
REPORTFIELDFLD_REPORT_IDMandatory

This command returns no result attributes.

REPORTFIELDCMD_UPDATE

Updates report fields.

The following attributes can be specified in the attributeSet input parameter of this command:

  Table: REPORTFIELDCMD_UPDATE (Supported input attributes)
Attribute nameOptionality
REPORTFIELDFLD_DISPLAY_NAMEMandatory
REPORTFIELDFLD_DOMAINMandatory
REPORTFIELDFLD_FIELD_NAMEMandatory
REPORTFIELDFLD_FIELD_ORD 
REPORTFIELDFLD_OPERATION 
REPORTFIELDFLD_REPORT_IDMandatory

The following attributes will be specified in the results output parameter of this command:

  Table: REPORTFIELDCMD_UPDATE (Supported output attributes)
Attribute nameReturned
REPORTFIELDFLD_CREATE_TIMEAlways
REPORTFIELDFLD_DISPLAY_NAMEAlways
REPORTFIELDFLD_DOMAINAlways
REPORTFIELDFLD_FIELD_NAMEAlways
REPORTFIELDFLD_MODIFY_TIMEAlways
REPORTFIELDFLD_REPORT_IDAlways