563848e0ecc0
Retrieve a download link for failed roster records
Returns a time-limited link to a CSV export of the records that failed for one roster job. This endpoint does not stream a CSV. It responds with a small JSON object carrying a fileUrl; the caller must follow that link to retrieve the file itself.
When to use: call this after a roster has finished processing, to hand a reviewer the list of records that could not be validated or ingested so they can be corrected offline.
Preconditions: supply the roster job's rosterId. The tenant-id header is optional here and falls back to a default identity when omitted, unlike the other roster endpoints, which require it.
What you get back: an object of the form {"fileUrl": "..."}. The link expires after seven days, so follow it promptly rather than storing it. When an export has already been generated for the roster its existing link is returned as-is; otherwise the export is generated on demand, which makes the first call for a large roster noticeably slower than later ones.
Path parameters
Identifier of the roster job whose failed records should be exported, as returned by the roster listing endpoints.
Headers
Unique identifier of the tenant that owns the roster job. Optional on this endpoint - a default identity is used when the header is omitted.
Response
An object carrying a time-limited link to the failed-records CSV export. Follow the link to download the file.