Skip to main content
GET
Search across records given an input request with assorted GET parameters.

Authorizations

Authorization
string
header
required

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

Query Parameters

principalId
string
applicationId
string
workflowId
string
stepId
string
layoutId
string
statuses
enum<string>[]
Available options:
INACTIVE,
NOT_ASSIGNED,
ASSIGNED,
IN_PROGRESS,
COMPLETE
sortLayoutFieldId
string
sortSystemFieldPath
string
sortFieldId
string
sortFieldType
enum<string>
Available options:
TEXT,
EXTERNAL_USER,
EXTERNAL_ID,
TEXT_AREA,
DATE_PICKER,
NUMBER,
E_SIGNATURE,
CHECKBOX,
MULTI_SELECT,
RADIO,
SELECT,
USER,
ATTACHMENT,
CALCULATION,
TEXT_CONCATENATION,
FIXED_DATE_CALCULATION,
LINKED_RECORDS_COUNT,
DUE_DATE,
DAYS_UNTIL_DUE,
EVIDENCE,
AEC_INFO,
ANNUAL_LOSS_EXPOSURE
sortSystemField
enum<string>
Available options:
NAME,
STATUS,
CREATED,
ENTERED_STEP_DATE,
USER_DATE,
EFFECTIVE_DUE_DATE,
STEP_DUE_DATE,
CURRENT_DATE,
DUE_DATE,
DAYS_UNTIL_DUE,
SIMILARITY,
RATIONALE,
MATCH_CONFIDENCE,
COMPLETED_DATE,
LAST_COMPLETED_DATE,
ID,
SEQUENCE,
ASSESSMENT_COUNT,
USER_NAME,
USER_ID,
CREATOR_NAME,
USER_GROUP,
STEP_NAME,
STEP_ID,
ORIGIN_NAME,
ORIGIN_ID,
WORKFLOW_NAME,
WORKFLOW_RECORD_PREFIX,
WORKFLOW_ID,
PRIMARY_FIELD,
STATE
sortDirection
enum<string>
Available options:
ASC,
DESC
query
string
assigned
boolean
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.

Response

200 - application/json

OK

headers
object[]
required
uuid
string
required
content
object[]
pageable
object
pageRequest
object
last
boolean
totalElements
integer<int64>
totalPages
integer<int32>
first
boolean
numberOfElements
integer<int32>
sort
object
size
integer<int32>
number
integer<int32>
empty
boolean