latestOpenAPI 3.1.02026-08-194237902.5 MB

563848e0ecc0

RosterRecord

Submit drafted roster rows for revalidation

Moves the roster into revalidation and re-runs validation over its rows in the background.

When to use: call this after saving draft corrections with PATCH /roster-records/{rosterId}/draft, once the edits are ready to be checked again.

Preconditions: supply the tenant-id header and the rosterId of an existing roster job. The roster must not already be undergoing processing - a roster in REVALIDATE, VALIDATION_IN_PROGRESS, IN_PROGRESS, or PRE_PROCESSING state is rejected with 409, and the response names the state that blocked the request. Wait for that work to finish, then retry.

What you get back: 202 as soon as the request is accepted, with the roster's new status set to REVALIDATE. The counts in the body are placeholders at this point: validation runs asynchronously, so poll the roster or its rows to observe progress and final results rather than reading totals from this response.

Side effects: the roster status is updated and a validation run is queued. Revalidation can be turned off for the platform, in which case this endpoint returns 503 until it is re-enabled.

post/roster-records/{rosterId}/revalidate

Path parameters

rosterIdstring required

Identifier of the roster job to operate on, as returned by the roster listing endpoints.

Headers

tenant-idstring required

Unique identifier of the tenant whose roster data is being accessed. Obtained from your account configuration; it also scopes every filter applied to the request.

Response

The revalidation request was accepted and the roster moved to REVALIDATE. Validation runs in the background; the numeric counts are placeholders until it completes.

processedinteger

Total VALIDATION_FAILED rows examined

validatedinteger

Rows that passed validation

validationFailedinteger

Rows that failed validation

statusstring

Roster revalidation status (e.g. REVALIDATE when async dispatch accepted)