Skip to navigation

Stage an accepted colour Candidate as a catalogue draft

Writes an accepted candidate into your catalogue as a draft. Send the candidate_sha256 that was accepted: a candidate pending or rejected answers 409 CANDIDATE_NOT_ACCEPTED, and another digest 409 CANDIDATE_DIGEST_MISMATCH. Acceptance is checked again as the draft is written; if what the candidate was measured from no longer holds, the answer is 409 CANDIDATE_NOT_STAGEABLE. The draft’s display_color is the candidate’s measured colour, so its applications take no render_color. A new_variant destination creates an unpublished variant whose revision 1 is the draft; an external_ref already in use answers 409 EXTERNAL_REF_TAKEN and is never read as the variant to revise. A variant_revision destination writes the variant’s next draft revision only while it is at the expected_generation you read, or answers 409 GENERATION_CONFLICT. The draft renders nothing until you approve and publish it. A refused stage writes nothing. Send an Idempotency-Key: it is required, and a retry with the same key and the same request answers the first response, byte for byte, with Idempotency-Replayed: true. Requires the catalogue.write scope; served only where both digitisation and the catalogue are enabled for your environment.

Authentication

X-API-Keystring

API key for one environment of your account. Keep server-side; never expose in browser clients.

Path parameters

candidate_idstringRequired

Headers

Idempotency-Keystring or nullOptional

Request

Stage an accepted candidate as a catalogue draft: the digest of the candidate the reviewer accepted, and where the draft goes.

candidate_sha256stringRequired
destinationobjectRequired

Response

The stage receipt: the draft is written. A replay under the same Idempotency-Key answers the same receipt with Idempotency-Replayed: true

assessment_idstring
candidate_idstring
candidate_sha256stringformat: "^[0-9a-f]{64}$"
created_atdatetime
destinationenum
Allowed values:
expected_generationinteger or null
idstring
reviewed_atdatetime
reviewed_byobject

Who made a decision: user, a person in the Platform, or api_key. It names no person; the Platform shows who.

revisioninteger
staged_byobject

Who made a decision: user, a person in the Platform, or api_key. It names no person; the Platform shows who.

variant_idstring

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
503
Service Unavailable Error