reportformatExecute (Command)

The content is currently unavailable in French. You are viewing the default English version.

Résumé de l’article

Avez-vous trouvé ce résumé utile ?

Merci pour vos commentaires

The reportformatExecute command executes the report format–related administrative operations.

Table: reportformatExecute commands
Command	Description
REPORTFORMATCMD_CREATE	Creates a new report format definition (see REPORTFORMATCMD_CREATE).
REPORTFORMATCMD_VIEW	Retrieves the settings of the specified report format (see REPORTFORMATCMD_VIEW).
REPORTFORMATCMD_UPDATE	Modifies an existing report format definition (see REPORTFORMATCMD_UPDATE).
REPORTFORMATCMD_DELETE	Deletes a report format definition (see REPORTFORMATCMD_DELETE).

Parameters

Table: reportformatExecute 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	ReportFormatCmdIDEnum	Required. The operation to be executed. See Table: reportformatExecute commands.
attributeSet	ReportFormatAttributeSet	Required. A set containing zero or more attribute fields.

Table: reportformatExecute oputput parameters
Parameter name	Data type	Description
results	ReportFormatResults	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: reportformatExecute field attributes
Attribute name	Data type	Description
REPORTFORMATFLD_CREATE_TIME	DateTime	The date and time the data record was created.
REPORTFORMATFLD_FORMAT_DEFINITION	String	The report format definition name.
REPORTFORMATFLD_DOMAIN	String	The domain where the report is located. Up to 255 characters.
REPORTFORMATFLD_FORMAT_NAME	String	Report format display name. Up to 64 characters.
REPORTFORMATFLD_MODIFY_TIME	DateTime	The date and time the data record was last modified.
REPORTFORMATFLD_QUERY_FOR	String	Use this attribute to query the report format definitions that the administrator currently logged on can update or run. Possible values: update run
REPORTFORMATFLD_REPORT_ID	String	The unique report identifier. Up to 255 characters.

Creates a new report format definition.

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

Table: REPORTFORMATCMD_CREATE (Supported input attributes)
Attribute name	Optionality
REPORTFORMATFLD_DOMAIN_NAME	Mandatory
REPORTFORMATFLD_FORMAT_DEFINITION	Mandatory
REPORTFORMATFLD_FORMAT_NAME	Mandatory
REPORTFORMATFLD_REPORT_ID	Mandatory

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

Table: REPORTFORMATCMD_CREATE (Supported output attributes)
Attribute name	Returned?
REPORTFORMATFLD_CREATE_TIME	Always
REPORTFORMATFLD_DOMAIN_NAME	Always
REPORTFORMATFLD_FORMAT_DEFINITION	Always
REPORTFORMATFLD_FORMAT_NAME	Always
REPORTFORMATFLD_MODIFY_TIME	Always
REPORTFORMATFLD_REPORT_ID	Always

Retrieves the settings of the specified report format definition.

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

Table: REPORTFORMATCMD_VIEW (Supported input attributes)
Attribute name	Optionality
REPORTFORMATFLD_DOMAIN_NAME	Mandatory
REPORTFORMATFLD_FORMAT_NAME	Mandatory
REPORTFORMATFLD_REPORT_ID	Mandatory

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

Table: REPORTFORMATCMD_VIEW (Supported output attributes)
Attribute name	Returned?
REPORTFORMATFLD_CREATE_TIME	Always
REPORTFORMATFLD_DOMAIN_NAME	Always
REPORTFORMATFLD_FORMAT_DEFINITION	Always
REPORTFORMATFLD_FORMAT_NAME	Always
REPORTFORMATFLD_MODIFY_TIME	Always
REPORTFORMATFLD_REPORT_ID	Always

Modifies an existing report format definition.

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

Table: REPORTFORMATCMD_UPDATE (Supported input attributes)
Attribute name	Optionality
REPORTFORMATFLD_DOMAIN_NAME	Mandatory
REPORTFORMATFLD_FORMAT_DEFINITION	Optional
REPORTFORMATFLD_FORMAT_NAME	Mandatory
REPORTFORMATFLD_REPORT_ID	Mandatory

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

Table: REPORTFORMATCMD_UPDATE (Supported output attributes)
Attribute name	Returned?
REPORTFORMATFLD_CREATE_TIME	Always
REPORTFORMATFLD_DOMAIN_NAME	Always
REPORTFORMATFLD_FORMAT_DEFINITION	Always
REPORTFORMATFLD_FORMAT_NAME	Always
REPORTFORMATFLD_MODIFY_TIME	Always
REPORTFORMATFLD_REPORT_ID	Always

Deletes a report format definition.

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

Table: REPORTFORMATCMD_DELETE (Supported input attributes)
Attribute name	Optionality
REPORTFORMATFLD_FORMAT_DEFINITION	Optional
REPORTFORMATFLD_DOMAIN_NAME	Mandatory
REPORTFORMATFLD_FORMAT_NAME	Mandatory
REPORTFORMATFLD_REPORT_ID	Mandatory

This command returns no result attributes.

Cet article vous a-t-il été utile ?

Table des matières