Skip to main content

Test a field's search API

Executes the field's searchAPIDefs and returns the mapped results. May save the API entity if the search response sets resultToBeWrittenBackFor. Returns 202 if the test triggers an async/webhook flow.

Path Parameters
internalId string — REQUIRED
fieldId string — REQUIRED
Request Body — REQUIRED
fieldValues object

Map of field variableName -> stringified value. Keys must match the variableName of the operation's IntegrationAppAPIFields. null is allowed (interpreted as an empty map).

Responses
200

Returns the test result

Schema — OPTIONAL
object