API REFERENCE · SCHEMA

OperationsReport schema

Required fields are always present in their containing object. Optional fields may be omitted; null is allowed only where stated. Array item fields apply to every item.

timeZoneRequired
string

Captured calendar timezone used for this report range.

fromRequired
string
toRequired
string
generatedAtRequired
string

Format: date-time.

screeningsRequired
object
screenings fields and rules
screenings.totalRequired
integer

Minimum: 0.

screenings.potentialMatchesRequired
integer

Minimum: 0.

screenings.noMatchesRequired
integer

Minimum: 0.

screenings.expiredRequired
integer

Minimum: 0.

casesRequired
object
cases fields and rules
cases.openRequired
integer

Minimum: 0.

cases.confirmedRequired
integer

Minimum: 0.

cases.dismissedRequired
integer

Minimum: 0.

cases.overdueRequired
integer

Minimum: 0.

cases.pendingApprovalRequired
integer

Minimum: 0.

cases.unassignedRequired
integer

Minimum: 0.

monitoringRequired
object
monitoring fields and rules
monitoring.activeRequired
integer

Minimum: 0.

monitoring.pausedRequired
integer

Minimum: 0.

monitoring.overdueRequired
integer

Minimum: 0.

monitoring.failedRequired
integer

Minimum: 0.

monitoring.unreadRequired
integer

Minimum: 0.

reviewsRequired
object
reviews fields and rules
reviews.totalRequired
integer

Minimum: 0.

reviews.reusedRequired
integer

Minimum: 0.

reviews.medianHoursRequired
number or null

May be null.

reviews.medianHours fields and rules

Allowed alternatives

  • number
  • null

    May be null.

reviewersRequired
object[]
reviewers item fields

Each array item: object.

reviewers[].actorIdRequired
string
reviewers[].actorEmailOptional
string
reviewers[].decisionsRequired
integer

Minimum: 0.

sourceCoverageRequired
object[]
sourceCoverage item fields

Each array item: object.

sourceCoverage[].sourceIdRequired
string
sourceCoverage[].screeningsRequired
integer

Minimum: 0.

expiringEvidenceRequired
object[]
expiringEvidence item fields

Each array item: object.

expiringEvidence[].screeningIdRequired
string

Format: uuid.

expiringEvidence[].expiresAtRequired
string

Format: date-time.

expiringEvidence[].caseIdRequired
string or null

May be null.

expiringEvidence[].caseId fields and rules

Allowed alternatives

  • string

    Format: uuid.

  • null

    May be null.

limitationsRequired
string[]
limitations item fields

Each array item: string.

Use OperationsReport in a workflow

Used by

Open an operation for its complete request or response example, including any outer JSON object that wraps these fields.

Implementation guides