reportFileExecute (Command)

Scenario: Administration
Support: full-sdk

The reportFileExecute command executes report file–related administrative operations.

Table: reportFileExecute commands
Command	Description
REPORTFILECMD_CHANGE_OWNERSHIP	Changes the ownership of a report file (see REPORTFILECMD_CHANGE_OWNERSHIP).
REPORTFILECMD_DELETE	Deletes a report file (see REPORTFILECMD_DELETE).
REPORTFILECMD_TAKE_OWNERSHIP	Takes ownership of a report file (see REPORTFILECMD_TAKE_OWNERSHIP).
REPORTFILECMD_VIEW	Views report file details (see REPORTFILECMD_VIEW).

Parameters

Table: reportFileExecute input parameters
Parameter name	Data type	Description
sessionID	String	Required.The session identifier of the current administrative session. The logon command returns this identifier after a successful logon (see logon (Command)).
cmd	ReportFileCmdIDEnum	Required. The operation to be executed. See Table: reportFileExecute commands.
attributeSet	ReportFileAttributeSet	Required. A set containing zero or more attribute fields.

Table: reportFileExecute oputput parameters
Parameter name	Data type	Description
results	ReportFileResults	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: reportFileExecute field attributes
Attribute name	Data type	Description
REPORTFILEFLD_CREATE_TIME	Timestamp	The date and time the data record was created.
REPORTFILEFLD_DESCRIPTION	String	An informative text describing the report. Up to 255 characters.
REPORTFIELDFLD_DOMAIN	String	The domain the report was created in. Up to 255 characters.
REPORTFILEFLD_MODIFY_TIME	Timestamp	The date and time the data record was last modified.
REPORTFILEFLD_PERIOD_END	Timestamp	Report period end time.
REPORTFILEFLD_PERIOD_START	Timestamp	Report period start time.
REPORTFILEFLD_REPORTFILE_ID	String	The ID of the generated report. Up to 60 characters.
REPORTFILEFLD_SERVER_ID	String	The OneSpan Authentication Server instance that created the report. Up to 255 characters.
REPORTFILEFLD_SETTINGS	String	The query parameters used to generate the report. Up to 4096 characters.
REPORTFILEFLD_SIZE	Integer	The size of the report file.
REPORTFILEFLD_USER_ID	String	The user who created the report. Up to 255 characters.

Views report file details.

Only the REPORTFILEFLD_REPORTFILE_ID attribute can be specified in the attributeSet input parameter of this command.

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

Table: REPORTFILECMD_VIEW (Supportet output attributes)
Attribute name	Returned?
REPORTFILEFLD_CREATE_TIME	Always
REPORTFILEFLD_DESCRIPTION	Always
REPORTFILEFLD_DOMAIN_NAME	Always
REPORTFILEFLD_MODIFY_TIME	Always
REPORTFILEFLD_PERIOD_END	Always
REPORTFILEFLD_PERIOD_START	Always
REPORTFILEFLD_REPORTFILE_ID	Always
REPORTFILEFLD_SERVER_ID	Always
REPORTFILEFLD_SETTINGS	Always
REPORTFILEFLD_SIZE	Always
REPORTFILEFLD_USER_ID	Always

Deletes a report file.

Only the REPORTFILEFLD_REPORTFILE_ID attribute can be specified in the attributeSet input parameter of this command.

This command returns no result attributes.

Takes ownership of a report file.

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

Table: REPORTFILECMD_TAKE_OWNERSHIP (Supported input attributes)
Attribute name	Optionality
REPORTFILEFLD_DOMAIN_NAME	Mandatory
REPORTFILEFLD_REPORTFILE_ID	Mandatory
REPORTFILEFLD_USER_ID	Mandatory

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

Table: REPORTFILECMD_TAKE_OWNERSHIP (Supported output attributes)
Attribute name	Returned?
REPORTFILEFLD_CREATE_TIME	Always
REPORTFILEFLD_DESCRIPTION	Always
REPORTFILEFLD_DOMAIN_NAME	Always
REPORTFILEFLD_MODIFY_TIME	Always
REPORTFILEFLD_PERIOD_END	Always
REPORTFILEFLD_PERIOD_START	Always
REPORTFILEFLD_REPORTFILE_ID	Always
REPORTFILEFLD_SERVER_ID	Always
REPORTFILEFLD_SETTINGS	Always
REPORTFILEFLD_SIZE	Always
REPORTFILEFLD_USER_ID	Always

Changes the ownership of a report file.

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

Table: REPORTFILECMD_CHANGE_OWNERSHIP (Supported input attributes)
Attribute name	Optionality
REPORTFILEFLD_DOMAIN_NAME	Mandatory
REPORTFILEFLD_REPORTFILE_ID	Mandatory
REPORTFILEFLD_USER_ID	Mandatory

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

Table: REPORTFILECMD_CHANGE_OWNERSHIP (Supported output attributes)
Attribute name	Returned?
REPORTFILEFLD_CREATE_TIME	Always
REPORTFILEFLD_DESCRIPTION	Always
REPORTFILEFLD_DOMAIN_NAME	Always
REPORTFILEFLD_MODIFY_TIME	Always
REPORTFILEFLD_PERIOD_END	Always
REPORTFILEFLD_PERIOD_START	Always
REPORTFILEFLD_REPORTFILE_ID	Always
REPORTFILEFLD_SERVER_ID	Always
REPORTFILEFLD_SETTINGS	Always
REPORTFILEFLD_SIZE	Always
REPORTFILEFLD_USER_ID	Always