Show/Hide Toolbars

Therefore Web API Programming Interface 1.0

REST URL (POST) https://tenant.thereforeonline.com/theservice/v0001/restun/GetSavedQuery

SOAP Action (POST) http://schemas.therefore.net/webservices/interop/v0001/messages/IThereforeService/GetSavedQuery

 

Gets saved query (search). The Query object returned in response can be used in the ExecuteSingleQuery request (as it is or with changes).

 

 

Input Message: http://schemas.therefore.net/webservices/interop/v0001/messages/IThereforeService/GetSavedQuery

 

Element Name

Element Type

Restrictions

Description

â–  parameters

 

 


â–  QueryNo

xs:int

mandatory

Sets number of the query to get.

 

 

Output Message: http://schemas.therefore.net/webservices/interop/v0001/messages/IThereforeService/GetSavedQueryResponse

 

Element Name

Element Type

Restrictions

Description

â–  parameters

 

 


â–¡ Query

 

nillable

Gets configuration of the search (query).

â–¡ CaseDefinitionNo

xs:int

nillable

Sets the number of the case definition to search in the case definition.

â–¡ CategoryNo

xs:int

nillable

Sets the number of the category to search in the category.

â–¡ Conditions

 

nillable

Sets the conditions list for the query.

≡ WSCondition

 

list nillable


â–¡ Condition

xs:string

mandatory nillable

Sets or gets condition.

â–¡ FieldNoOrName

xs:string

mandatory nillable

Sets or gets number or name of the field. When returned from the server it contains field number. When returned from the server it contains field number.

â–  TimeZone

 

 

restriction enum (xs:string)

- UTC (0)

- ServerLocal (1)

Sets or gets the time zone used in the condition for date/time values. The 'ServerLocal' option means that timezone from HTTP header 'The-Timezone-IANA' or 'The-Timezone-Microsoft' will be used if defined, otherwise the server local time zone will be used. If not set the UTC time zone will be used.

â–¡ FileByColName

xs:string

nillable

Looks up the specified column name and uses the field number for a query for an external data table.

â–¡ FileByFieldNo

xs:int

nillable

Sets the field number for a query for an external data table.

â–  MaxRows

xs:int

 

Sets the maximum number of rows the query will retrieve from the server.

â–¡ Mode

 

nillable

restriction enum (xs:string)

- NormalQuery (0)

- FileQuery (1)

- WorkflowQuery (4)

- CaseQuery (5)

Sets the mode of the query.

â–¡ OrderByFieldsNoOrNames

 

nillable

Orders result rows by field numbers or names. When returned from the server it contains field numbers. When returned from the server it contains field numbers.

≡ FieldNoOrName

xs:string

list nillable


â–  RowBlockSize

xs:int

 

Sets the rows block size for the query. The default value is 100.

â–¡ SelectedFieldsNoOrNames

 

nillable

Sets the list of field numbers or names to get these fields as a result. Set to null to get all the fields. Empty list means no fields will be returnded in response. When returned from the server it contains field numbers.

≡ FieldNoOrName

xs:string

list nillable


â–¡ GroupByFieldsNoOrNames

 

nillable

Contains list of field numbers, that the query should be grouped by

≡ FieldNoOrName

xs:string

list nillable


â–¡ FullText

xs:string

nillable

Sets the string to search in the query.

â–¡ ValidOperandMacros

 

nillable

Gets list of valid macros operands for queries.

≡ ValidOperandMacros

xs:string

list nillable


â–¡ ValidQueryOperators

 

nillable

Gets list of valid operators for queries.

â–¡ And

xs:string

nillable

Operator AND.

â–¡ Empty

xs:string

nillable

Operator EMPTY.

â–¡ GreaterThan

xs:string

nillable

Operator GREATER THAN.

â–¡ GreaterThanOrEqual

xs:string

nillable

Operator GREATER THAN OR EQUAL.

â–¡ LessThan

xs:string

nillable

Operator LESS THAN.

â–¡ LessThanOrEqual

xs:string

nillable

Operator LESS THAN OR EQUAL.

â–¡ Not

xs:string

nillable

Operator NOT.

â–¡ NotEmpty

xs:string

nillable

Operator NOT EMPTY.

â–¡ Or

xs:string

nillable

Operator OR.

â–¡ To

xs:string

nillable

Operator TO.

â–¡ Wildcard

xs:string

nillable

Wildcard.

â–¡ UiFields

 

nillable

Gets list of information on how to show the results in hitlist (Ui)

≡ WSQueryFieldUi

 

list nillable


â–  FieldNo

xs:int

mandatory

Sets or gets number or name of the field.

â–  DisplayPos

xs:int

mandatory

Sets or gets display position (order of display in hitlist) of the field.

â–  DisplayWidth

xs:int

mandatory

Sets or gets display width (width of column in hitlist) of the field.

â–  Alignment

xs:int

mandatory

Sets or gets alignment (left/middle/right aligned in hitlist) of the field.

 

 

 

Legend:

 

â– 

Not nillable element.

â–¡

Nillable element.

≡

List of elements.

Bold

Mandatory element.

 

 

© 2023 Therefore Corporation, all rights reserved.