Load one bounded candidate page from a successful actor-owned full-scan group.

GET

/api/workspace/entity/{entityIdOrKey}/record-matching/full-scans/{jobId}/groups/{groupId}/candidates

curl --request GET \
  --url 'https://example.com/api/workspace/entity/example/record-matching/full-scans/example/groups/example/candidates?page=1&pageSize=100'

Page is one-based and pageSize is clamped to the server candidate-page bound. The complete saved result is reauthorized before the requested page is materialized; stale or inaccessible results return HTTP 409 without partial data.

Authorizations

• None

Parameters

Path Parameters

entityIdOrKey

required

string

Target entity definition identifier or key.

jobId

required

string

Persisted successful job identifier.

groupId

required

string

Persisted group identifier from the published attempt.

Query Parameters

page

integer format: int32

default: 1

One-based candidate page.

pageSize

integer format: int32

default: 100

Requested candidate page size.

access_token

string

Optional access token for clients that cannot set Authorization headers. Prefer Authorization: Bearer <token> when possible.

Responses

200

OK

Media typeapplication/json

object

Data

One bounded candidate page for a persisted full-scan group.

object

GroupId

Stable saved group identifier.

string

nullable

Page

One-based candidate page.

integer format: int32

PageSize

Applied bounded candidate page size.

integer format: int32

TotalCandidateCount

Complete candidate count for the group.

integer format: int32

Candidates

Current actor-readable candidate summaries in this page.

Array<object>

nullable

Visible record candidate returned by the matching engine.

object

Id

string

nullable

DisplayName

string

nullable

Subtitle

string

nullable

IsArchived

boolean

OpenTarget

object

TargetCode

string

nullable

Parameters

object

key

additional properties

string

Errors

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Warnings

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Success

boolean

Example

{
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

403

Forbidden

Media typeapplication/json

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

key

additional properties

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

404

Not Found

Media typeapplication/json

object

Data

One bounded candidate page for a persisted full-scan group.

object

GroupId

Stable saved group identifier.

string

nullable

Page

One-based candidate page.

integer format: int32

PageSize

Applied bounded candidate page size.

integer format: int32

TotalCandidateCount

Complete candidate count for the group.

integer format: int32

Candidates

Current actor-readable candidate summaries in this page.

Array<object>

nullable

Visible record candidate returned by the matching engine.

object

Id

string

nullable

DisplayName

string

nullable

Subtitle

string

nullable

IsArchived

boolean

OpenTarget

object

TargetCode

string

nullable

Parameters

object

key

additional properties

string

Errors

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Warnings

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Success

boolean

Example

{
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

409

Conflict

Media typeapplication/json

object

Data

One bounded candidate page for a persisted full-scan group.

object

GroupId

Stable saved group identifier.

string

nullable

Page

One-based candidate page.

integer format: int32

PageSize

Applied bounded candidate page size.

integer format: int32

TotalCandidateCount

Complete candidate count for the group.

integer format: int32

Candidates

Current actor-readable candidate summaries in this page.

Array<object>

nullable

Visible record candidate returned by the matching engine.

object

Id

string

nullable

DisplayName

string

nullable

Subtitle

string

nullable

IsArchived

boolean

OpenTarget

object

TargetCode

string

nullable

Parameters

object

key

additional properties

string

Errors

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Warnings

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Success

boolean

Example

{
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}