Skip to main content
Version: Early Access

findin Query Parameter

Used in conjunction with the find parameter, findin specifies the attributes to check for the find substring. The findin parameter is optional. If omitted, a base set of attributes will be searched. This free text search is relatively expensive for VersionOne, so when the exact contents of a field should be matched, use the where parameter instead.

rest-1 URL Syntax

In rest-1.v1/Data and rest-1.oauth.v1/Data, the findin parameter is a URL query parameter. The findin parameter can be a single attribute or a set of comma separated attributes. The following shows how the findin is expressed in the query:

<Server Base URI>/rest.v1/Data/Story?sel=Name,Number&find=Ticket&findin=Name

The following shows how the findinparameter is used to search within multiple attributes:

<Server BaseURI>/rest.v1/Data/Story?sel=Name,Number&find=Ticket&findin=Name,Description

query.v1 Syntax

In query.v1 and query.legacy.v1, the findin parameter is expressed as an array of attribute definitions.

YAML

            from: Story
select:
- Name
- Number
find: Ticket
findin:
- Name

JSON

            {
"from": "Story",
"select":
[
"Name",
"Number"
],
"find": "Ticket",
"findin":
[
"Name"
]
}