Skip to navigation

List Document Set Exceptions

View as Markdown

Lists the exceptions and warnings raised on one document set — the same worklist as the Exceptions panel on the reconcile details screen. It covers every comparison card unless card_id narrows it.

Each item is one finding, identified by exception_id, which stays the same across reconciliation runs. kind is CRITICAL_EXCEPTION, EXCEPTION or WARNING. state is OPEN, or RESOLVED once a later run passes or the pair is force accepted (force_accept is then set). source_* is where the finding was raised and target_* the document it was compared with. On a NOT_FOUND finding, missing_side and missing_cause say which value is missing and why. On an ERROR finding, error_cause and unreadable_fields say what could not be read.

With no filters the list holds open and resolved findings of every kind. Filters that take several values accept a repeated parameter or a comma-separated list.

Requires reconciliation v2 on the organisation; other tenants receive 404.

Authentication

x-api-keystring
API key issued by Staple.
AuthorizationBearer
JWT obtained from the login endpoint.

Path parameters

uuidstringRequired
Linking set UUID, as returned by List Linking Sets.
idstringRequired

Document set ID (document_set_id from List Document Sets), URL-encoded.

Query parameters

statelist of enumsOptional
Filter by finding state. Omit to return both.
Allowed values:
kindlist of enumsOptional

Filter by severity, for example kind=CRITICAL_EXCEPTION,EXCEPTION.

Allowed values:
statuslist of enumsOptional
Filter by the reconciliation status the finding records.
Allowed values:
card_idstringOptional

Only findings from this comparison card. An unknown card returns 404.

comparison_rule_idlist of stringsOptional
Only findings from these comparison rules.
label_idlist of stringsOptional
Only findings carrying these labels.
searchstringOptional

Case-insensitive substring match on exception_id, scenario_id, label_id and note.

limitintegerOptional<=200Defaults to 50
Page size. Defaults to 50 and is capped at 200.
offsetintegerOptionalDefaults to 0
Number of records to skip for pagination.

Response

OK