This is the complete specification of the custom query configuration file format.
This is the root element for a custom query specification.
Query description.
Query SQL.
SQL timeout in seconds.
Specification of input parameters.
Specification of output format.
Short informative title.
Type of authorization to use for query.
A secret value that must be passed by the client as a URL parameter named “Authorization”, or used to sign a JWT token, in addition to other authorization mechanisms. The query framework verifies the value passed by the client.
HTTP request must contain some sort of standard F2-REST user authorization - either HTTP Basic authentication with username/password or an OAuth2 access token.
HTTP request must contain an JWT authorization token as specified by the F2- self-service framework for web-actions and external validation.
HTTP request is not required to include any user authorization.
This element specifies input parameters for the query.
Single input parameter specification (repeatable).
This element specifies a single input parameter.
Parameter description.
Parameter name.
Specifies if the parameter is required.
Type of parameter.
Input string is converted to an SQL “bit” value. “1” and “True” are interpreted as Boolean true. “0” and “False” are interpreted as Boolean false.
Input string is converted to an SQL “Int” value.
Input string is converted to an SQL “Decimal” value.
Input string is converted to an SQL “Float” value.
Input string is converted to an SQL “varchar(255)” value.
Input string is converted to an SQL “DateTime” value. The date-time input format is "YYYY-MM-DDTHH:MM:SS" – for instance "2004-12-28T13:45:50".
Input string is interpreted as an expression for SQL full text searching. The search expression uses operators “AND”, “OR” and “NOT” – and allows grouping of expressions with parenthesis as well as sentences in quoted strings using double quotes.
Search expression example: dog OR (fish AND "white shark")
Input string is converted to an SQL “varchar(40)” value. The case number format is “YYYY – N” where YYYY is the year and N is the serial number (whitespace around the dash is optional).
This element specifies outputs from the query.
Simple output column (repeatable).
Link column for related item (repeatable).
Specification of ATOM formatting details.
This element represents a link to some other resource in F2-REST.
Link relationship type (identifies the type of link using a link relationship identifier).
Resource type of the link – defines the type of resource linked to.
Name of the output column that contains the database identifier used to locate the resource.
Name of the output column that contains the link title.
Link to a case resource.
Link to a matter resource.
Link to a document resource.
Link to a enumeration type resource.
Link to a meeting resource.
Link to a party resource.
This element modifies the appearance of the resulting SQL columns.
Name of output column.
Specifies whether or not to hide a column. Column hiding can be relevant for columns that are only needed to generate links.
This element specifies how to render the output as an ATOM feed (see https://tools.ietf.org/html/rfc4287).
Specification for the entries in the ATOM feed.
This element specifies the query data to use for ATOM entries.
Specifies which output column to use as <title> element in the ATOM feed.
Specifies which output column to use as <published> element in the ATOM feed.
Specifies which output column to use as <updated> element in the ATOM feed.