reportformatQuery (Command)

Mis à jour le 19 Dec 2024
2 Minutes à lire

Partager
Sombre
Lumière
PDF

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 reportformatQuery command allows to query report formats that match specified search criteria.

Parameters

Table: reporfFormatQuery 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)).
attributeSet	ReportFormatAttributeSet	Required. A set containing zero or more attribute fields that specify the query search criteria. See ReportFormatAttributeSet (Data type).
fieldSet	ReportFormatFieldSet	Optional. Specifies the attribute fields to be returned for all the records matching the search criteria.
queryOptions	ReportFormatQueryOptions	Optional. Options to determine what results should be returned. See ReportFormatQueryOptions (Data type).

Table: reporfFormatQuery output parameters
Parameter name	Data type	Description
results	ReportFormatQueryResults	Result structure containing return and status codes and a list of zero or more result attribute fields.

ReportFormatAttributeSet (Data type)

The attributes specified in this attribute set define the search criteria.

Search attribute fields are interpreted as follows:

A wildcard character (*) can be added to the values at the start, the end, or both. They will be interpreted as the SQL LIKE statement.
A list of comma-separated values can be specified for the attribute that specifies the domain name. In this case it will be interpreted as the logical OR of the given values.
You cannot use wildcard characters in comma-separated values.
If none of the above applies, the search will be done using the exact match of the given value.

To query the report format definitions that the administrator currently logged on can update or run, add the REPORTFORMATFLD_QUERY_FOR attribute to the attribute set. This report format attribute is of type string and supports the following values:

update
run

ReportFormatQueryOptions (Data type)

This data type determines what results should be returned.

Table: QueryOptions (Data type)
Element name	Data type	Description
count	Boolean	Flag to request OneSpan Authentication Server to return only the number of records in the result set, but not the result set itself. Default value: false
distinct	Boolean	Flag to request OneSpan Authentication Server to return only unique query results. Default value: false
rowcount	Unsigned Integer	Option to request OneSpan Authentication Server to return the specified number of result records, beginning with the record specified by rowoffset. If set to 0, all result records are returned. Default value: 0
rowoffset	Unsigned Integer	Option to request OneSpan Authentication Server to return result records starting from the specified offset. Can only be used together with rowcount. Default value: 0
sortfieldid	String	Optional. Required if you specify SortOrder. Determines the field attribute to use as sort key when sorting the result set using SortOrder. May contain any field attribute from the FieldSet parameter.
sortorder	String	Optional. Determines the sort order of the result set. By default, the result set is unsorted. Possible values: QUERYOPTIONSORTORDER_ASCENDING. Result set in ascending order. QUERYOPTIONSORTORDER_DESCENDING. Result set in descending order.

Additional considerations

After upgrading OneSpan Authentication Server, server data is continuously migrated while the already-upgraded OneSpan Authentication Server service is running. Until data migration has been completed, the result of a query command may be incomplete and may include both migrated and non-migrated data. This means that values for new data fields may be missing or not set correctly in the query result.

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

What's Next

replicationserverExecute (Command)

Table des matières

Parameters
Additional considerations