transitionFormRecord

POST

/api/v1/data-sources/{id}/records/{recordId}/transitions

const url = 'https://example.com/api/v1/data-sources/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/records/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/transitions';
const options = {method: 'POST'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://example.com/api/v1/data-sources/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/records/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/transitions

Moves a record to a new workflow state, enforcing the configured transition, per-form capability and record ownership, optimistic concurrency (version), and required-field completeness (including required images, satisfied only by a bound attachment) before any submit transition or any transition into an output-eligible state. A note is recorded as a comment; a transition that requires a note (the default changes_requested path, derived from the workflow) is rejected with 422 when the note is empty. A 409 means the record changed; reload, preserving any unsent note.

Parameters

Path Parameters

required

string format: uuid

recordId

required

string format: uuid

Responses

200

Record after the transition

409

Version conflict

422

Illegal transition or incomplete required fields