Therefore Web API Programming Interface 1.0

Zoom Window Out
Larger Text | Smaller Text
Hide Page Header
Show Expanding Text
Printable Version
Save Permalink URL

Therefore Web API > Web API Reference > Operations

CreateQuery

Scroll

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

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

Creates a query and returns a query number of created query.

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

Element Name	Element Type	Restrictions	Description
■ parameters
□ Query		mandatory nillable	Sets 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. The default value is 500.
□ 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 block size for the query. Default value will be used if this parameter is not set. Default block size: 100 rows.
□ 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
■ IsPersonalQuery	xs:boolean		Indicates if query is a personal query.
□ Name	xs:string	nillable	A query name used to display query in UI.
■ QueryNo	xs:int		Query number of the query.
□ FullText	xs:string	nillable	Sets the string to search in the query.
□ UiFields		mandatory nillable	Sets 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.

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

Element Name	Element Type	Restrictions	Description
■ parameters
■ QueryNo	xs:int		The query number of the created query.

Legend:

■	Not nillable element.
□	Nillable element.
≡	List of elements.
Bold	Mandatory element.