FlowmageDocs

Search records

BetaReads dataVersion 2

Searches one OTYS service and returns matching records.

Settings

SettingWhat it is
ConnectionRequiredThe OTYS connection the step signs in with.
ServiceRequiredThe OTYS data service, as spelled at ows.otys.nl/info — CandidateService, VacancyService, RelationService.
Fields to fetchThe fields you want back, as OTYS's `what` object: a 1 for each field. Ask for what you need — OTYS gets slower and less stable when you take its defaults.
FilterOTYS's condition tree. {"type":"COND","field":…,"op":…,"param":…}, or {"type":"AND","items":[…]}. Operators: EQ NE GE GT LE LT T F LIKE NLIKE. Leave empty for every record.
Sort by{"Person.lastName":"ASC"} — OTYS gives no order guarantee across pages without one.
Records per call1 to 200 — OTYS never returns more than 200, whatever you ask.
Skip recordsnumber
Fetch every pagePages on offset until the total is read, and refuses past 10,000 records rather than answering a short list.
LanguageSets the language for THIS call only, through LanguageService.wrapRequest. The connection's own language is never changed.
CursorPaste a previous run's Next cursor to read the page after it.
Technical details
KeyValue
connectiontexta connection id from `requires.connections` (provider `otys`)
servicetext
whatany JSON
conditionany JSON
sortany JSON
limitnumber, by default 100
offsetnumber, by default 0
returnAlltrue/false, by default false
languagetext
cursortext

Output

FieldType
recordsarray
recordCountRecords in this answernumber
totalHow many OTYS countednumber
hasMoreMore records are waiting behind this pageboolean
nextCursorCursor for the next pagestring
Sample output, and the expression for each field
  • hasMorefalse
  • recordCount0
  • records[]
  • total0

Errors

When a step of this node stops a run, the run page shows a code. Look it up:

Example step

The step as a flow file holds it. Replace each value in <…>.

{
  "config": {
    "connection": "<connection id>",
    "cursor": "",
    "language": "",
    "limit": 100,
    "offset": 0,
    "returnAll": false,
    "service": "<service>"
  },
  "label": "Search records",
  "type": "otys.search",
  "version": 2
}

Older versions

A flow that already has this version keeps running it. A new step always gets the newest.

Version 1
SettingWhat it is
ConnectionRequiredThe OTYS connection the step signs in with.
ServiceRequiredThe OTYS data service, as spelled at ows.otys.nl/info — CandidateService, VacancyService, RelationService.
Fields to fetchThe fields you want back, as OTYS's `what` object: a 1 for each field. Ask for what you need — OTYS gets slower and less stable when you take its defaults.
FilterOTYS's condition tree. {"type":"COND","field":…,"op":…,"param":…}, or {"type":"AND","items":[…]}. Operators: EQ NE GE GT LE LT T F LIKE NLIKE. Leave empty for every record.
Sort by{"Person.lastName":"ASC"} — OTYS gives no order guarantee across pages without one.
Records per call1 to 200 — OTYS never returns more than 200, whatever you ask.
Skip recordsnumber
Fetch every pagePages on offset until the total is read, and refuses past 10,000 records rather than answering a short list.
LanguageSets the language for THIS call only, through LanguageService.wrapRequest. The connection's own language is never changed.
Technical details
KeyValue
connectiontexta connection id from `requires.connections` (provider `otys`)
servicetext
whatany JSON
conditionany JSON
sortany JSON
limitnumber, by default 100
offsetnumber, by default 0
returnAlltrue/false, by default false
languagetext