Skip to main content
POST
Searches for scoping records in the specified workflow.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

workflow
string
required
query
string
page
integer<int32>

Results page you want to retrieve (0..N)

size
integer<int32>

Number of records per page.

sort
string[]

Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

Body

application/json
parentRecordId
string
required
Minimum string length: 1
focusRecordId
string
required
scopingTreeId
string
required
Minimum string length: 1
includeMode
enum<string>
required
Available options:
INCLUDE,
EXCLUDE
sourceRecords
object[]
required

Response

200 - application/json

OK

recordResponse
object
required
totalAssessments
integer<int32>
required
recordsWithMultipleAssessments
integer<int32>
required