Contracts

The table below summarizes the Search contract.

Contracts and Attributes

Search Request Contract

The following objects and attributes make up the Search request contract.

ATTRIBUTE	DESCRIPTION
from number	Start index for pagination (starts from 0).
size number	End index for pagination. The sum of the start index and the end index should not be greater than 10000.

query object	Search query with optional filter. The search query can use either the terms or match query parameter.
query.bool object	Object containing parameters for the search.
query.bool.must array	Array of search items using terms or match query.
query.bool.must.term string	Searches for an exact match of a single term. Use query.bool.must.terms to search for multiple values. The format is: <propertyName>:<propertyValue> For example: `[ { "term": { "fieldType": "custom" } } ]`
query.bool.must.match string	Searches for a partial or full text match. The format is: <propertyName>:<propertyValue> The only property that supports this is the “name” of the form. For example: `{ "match": { "name": "Flood" } },`
query.bool.filter array	Array of filter items using term or match query.
query.bool.filter.term string	Filters results based on an exact match of a single search term. The format is: <propertyName>:<propertyValue> For example: `[ { "term": { "fieldType": "custom" } } ]`
query.bool.filter.match string	Searches for a partial or full text match. The format is: <propertyName>:<propertyValue> The only property that supports this is the “name” of the form. For example: `{ "match": { "name": "Flood" } },`

sort array of objects	Indicates the sort order of the results. Results can be sorted in ascending or descending order. The format is: <propertyName>:{order: ASC \| DESC } For example: `{ "sort": [ { "modifiedDate": { "order": "asc" } } ] }`

Field Search Response Contract

The following table includes the objects and attributes in a Search response when searching for fields within a given form. It also includes information about whether the attribute can be used for queries and filtering, is returned with an exact or partial match, and whether it can be used for sorting.

📘
Additional details about search attributes and query syntax are provided in this spreadsheet.

ATTRIBUTES	DESCRIPTION	Query & Filtering	Match Type	Sort Supported
fieldId string	The field ID.	Yes	Exact	Yes
fieldDescription string	Description of the field.	No	NA	No
fieldType string	Field type. Possible values are: standard custom * virtual Note: These values are case-sensitive.	Yes	Exact	Yes
fieldFormat string	The datatype of the field. Possible values are: DECIMAL_n For example ‘DECIMAL_2’ where ‘2’ is the number of decimals INTEGER YN STATE ZIPCODE SSN PHONE RASTRING DATE _ STRING Note: These values are case-sensitive.	Yes	Exact	Yes
fieldEntityPath string	Shows the contract path of the field in the loan object. For example, loan.closingCost.closing Disclosure2.otherSubTotal.	No	NA	Yes
fieldProperty string	The field entities filter key in the contract path. For example, closingDisclosure2.	No	NA	Yes
collectionField string	Indicates the name of the collection, if the field belongs to a collection. For example, "_Assets"," _Liabilities". Note: These values are case-sensitive.	Yes	Exact	Yes
fieldAllowEdit boolean	Indicates whether the field is read-only.	No	NA	Yes
fieldEnabled boolean	Indicates whether the field is enabled in the form; applies to custom forms. Note: This value is case-sensitive.	Yes	Exact	Yes
fieldVisible boolean	Indicates whether the field is visible on the form; applies to custom forms. Note: The value is case-sensitive.	Yes	Exact	Yes

Form Search Response Contract

The following table includes the objects and attributes in a Search response when searching for searching for forms containing a given field ID. It also includes information about whether the attribute can be used for queries and filtering, is returned with an exact or partial match, and whether it can be used for sorting.

📘
Additional details about search attributes and query syntax are provided in this spreadsheet.

ATTRIBUTES	DESCRIPTION	Query & Filtering	Match Type	Sort Supported
id string	Unique identifier given to a form.	No	NA	Yes
fileName string	The file name of the form.	No	NA	Yes
name string	Name of the form. This attribute is used for partial match. Wildcards are not supported.	Yes	Partial	No
formName string	Name of the form. This attribute is used for exact match.	Yes	Exact	Yes
description string	Description of the form. This attribute is used in custom forms.	No	NA	No
schemaGenerated boolean	Indicates if the form is built using the Web Input Form Builder; many of the standard forms are also built using the Input Form Builder.	Yes	Exact	Yes
schemaVersion string	The version of the form.	No	NA	No
enabled boolean	Indicates whether the form is enabled for use in Encompass. This attribute is used in custom forms.	Yes	Exact	Yes
status string	Status of the form, indicates whether the form is uploaded for storage. Note this attribute will be deprecated in a future release	No	NA	No
modifiedDate string($date-time)	For custom forms, this is the last modified date. For standard forms, this is the date when the form was indexed for search results.	No	NA	Yes
instance string	Instance ID that is associated with your token. Notes: This value can never be different from your instance ID. It will be blank for standard forms as it applies to all instances.	No - Always enforced implicitly	NA	Yes
deviceTypes string	Form factor supported by the form. Possible values are: Desktop Tablet Mobile All Note: These values are case-sensitive.	Yes	Exact	Yes
type string	The type of form. Possible values are: standard custom angular - Indicates the tech stack used to build the standard form. react - Indicates the tech stack used to build the standard form. * tools - Indicates that the standard form manifests as a tool in left pane of the web version Note: These values are case-sensitive.	Yes	Exact	Yes
personaAccessList string	The persona settings assigned to the form.	No	NA	No
hideFromLeftNav boolean	Indicates whether the form is hidden from the left navigation menu.	Yes	Exact	Yes