ticket.coding-artifact.reserve

Reserve an organization-scoped Git bundle identity bound to one delivery, work item, session, execution, lease, base OID, and head OID.

Reserve one immutable identity before a coding runner exports bytes.

Overview

Property	Value
Workflow type	Linear
Library	App-tickets
Version	1.0

Input Schema

Field	Type	Required	Default	Description
organization_uuid	string	Yes	—	Authenticated organization scope; control-plane injected, never caller authority.
delivery_uuid	string	No	—	Optional same-organization software delivery bound to the Git work; mismatches fail closed.
repository_uuid	string	Yes	—	Registered repository UUID; it must exactly match the Git work repository.
work_uuid	string	Yes	—	Ticket Git-work UUID whose clean exact OIDs are exported.
idempotency_key	string	Yes	—	Stable retry key for this one artifact identity; reuse with different immutable fields is rejected.
format	string	No	git_bundle_v3	Portable artifact format; currently only git_bundle_v3.
object_format	string	Yes	—	Native Git object format controlling exact OID length: sha1 or sha256.
base_oid	string	Yes	—	Exact latest acknowledged clean base Git OID; must match the selected object format and Git work.
head_oid	string	Yes	—	Exact latest acknowledged clean head Git OID; must match the selected object format and Git work.
session_uuid	string	Yes	—	AgentSession UUID bound to the exporting workspace lease.
execution_uuid	string	Yes	—	RunnerExecution UUID bound to the exporting workspace lease.
workspace_lease_uuid	string	Yes	—	WorkspaceLease UUID that must bind this work, session, execution, repository, base OID, and head OID.
expires_at	string	Yes	—	ISO-8601 retention deadline in the future and no more than 90 days from reservation.

Output Schema

Field	Type	Required	Default	Description
artifact	dict	No	—	Provider-neutral artifact; excludes storage coordinates and credentials.
created	boolean	No	—	True only when this idempotent call created the artifact.
changed	boolean	No	—	True only when this idempotent call advanced artifact state.
claimed	boolean	No	—	True only when this call acquired the lease.
organization_uuid	string	No	—	Input field preserved in workflow state.
delivery_uuid	string	No	—	Input field preserved in workflow state.
repository_uuid	string	No	—	Input field preserved in workflow state.
work_uuid	string	No	—	Input field preserved in workflow state.
idempotency_key	string	No	—	Input field preserved in workflow state.
format	string	No	—	Input field preserved in workflow state.
object_format	string	No	—	Input field preserved in workflow state.
base_oid	string	No	—	Input field preserved in workflow state.
head_oid	string	No	—	Input field preserved in workflow state.
session_uuid	string	No	—	Input field preserved in workflow state.
execution_uuid	string	No	—	Input field preserved in workflow state.
workspace_lease_uuid	string	No	—	Input field preserved in workflow state.
expires_at	string	No	—	Input field preserved in workflow state.
failed_at	string	No	—	ISO-8601 timestamp when action_fail recorded the failure
failure_reason	string	No	—	Human-readable failure reason from action_fail
failure_type	string	No	—	Engine-stamped failure category
failed_action	string	No	—	Engine-stamped action that raised
failed_at_state	string	No	—	Engine-stamped state when the workflow failed
failed_step	string	No	—	Engine-stamped step name (DAG path)
failed_layer	string	No	—	Engine-stamped layer index (DAG path)
error	string	No	—	Engine-stamped exception message
error_type	string	No	—	Engine-stamped exception class name
artifact_uuid	string	No	—	Input field preserved in workflow state.
manifest_sha256	string	No	—	Input field preserved in workflow state.
artifact_sha256	string	No	—	Input field preserved in workflow state.
size_bytes	integer	No	—	Input field preserved in workflow state.
object_count	integer	No	—	Input field preserved in workflow state.
uncompressed_bytes	integer	No	—	Input field preserved in workflow state.
verifier_uuid	string	No	—	Input field preserved in workflow state.
lease_uuid	string	No	—	Input field preserved in workflow state.
lease_seconds	integer	No	—	Input field preserved in workflow state.
enabled	boolean	No	—	Input field preserved in workflow state.
reason	string	No	—	Input field preserved in workflow state.
worker_uuid	string	No	—	Input field preserved in workflow state.
deleted_object_count	integer	No	—	Input field preserved in workflow state.
deleted_bytes	integer	No	—	Input field preserved in workflow state.
retryable	boolean	No	—	Input field preserved in workflow state.

States

State	Initial	Terminal	Success	Auto-advance	Description
initiated	Yes	No	—	execute	Accepted
executing	No	No	—	complete	Applying the mutation
completed	No	Yes	Yes	—	Done
failed	No	Yes	No	—	Failed

State Diagram

Transitions

From	Action	To	Description
initiated	execute	executing	Run the mutation
executing	complete	completed	Finalize
* (any state)	fail	failed	Catch-all failure

API Usage

POST /api/workflows/start
Content-Type: application/json

{
  "workflow_type": "ticket.coding-artifact.reserve",
  "initial_data": {
    "organization_uuid": "value",
    "repository_uuid": "value",
    "work_uuid": "value",
    "idempotency_key": "value"
  }
}