Skip to main content
Section ID: DOC-API-MODEL-schema-1l7vrun3li#overview

Execution

Execution is a single firing record for a scheduled job.

Meaning and usage​

Section ID: DOC-API-MODEL-schema-1l7vrun3li#meaning

See the definition above.

Usage profiles​

Section ID: DOC-API-MODEL-schema-1l7vrun3li#fields

UsageFields and validation
In responsesView fields

In responses​

Section ID: DOC-API-MODEL-schema-1l7vrun3li#response

API JSON uses JSON field names (camelCase).

FieldTypePresenceMeaning
Section ID: DOC-API-MODEL-schema-1l7vrun3li#field-executionidSection ID: DOC-API-MODEL-schema-1l7vrun3li#response-field-executionidexecutionIdstring (int64)OptionalIdentifier of the scheduled job execution record. Pattern: ^-?\d+$.
Section ID: DOC-API-MODEL-schema-1l7vrun3li#field-scheduleidSection ID: DOC-API-MODEL-schema-1l7vrun3li#response-field-scheduleidscheduleIdstringOptionalIdentifier of the scheduled job.
Section ID: DOC-API-MODEL-schema-1l7vrun3li#field-tenantidSection ID: DOC-API-MODEL-schema-1l7vrun3li#response-field-tenantidtenantIdstringOptionalIdentifier of the tenant that owns or scopes this record.
Section ID: DOC-API-MODEL-schema-1l7vrun3li#field-projectidSection ID: DOC-API-MODEL-schema-1l7vrun3li#response-field-projectidprojectIdstringOptionalIdentifier of the project within the tenant that scopes this record.
Section ID: DOC-API-MODEL-schema-1l7vrun3li#field-scheduledtimeSection ID: DOC-API-MODEL-schema-1l7vrun3li#response-field-scheduledtimescheduledTimestring (date-time)OptionalInstant for which this execution or trigger was scheduled.
Section ID: DOC-API-MODEL-schema-1l7vrun3li#field-startedatSection ID: DOC-API-MODEL-schema-1l7vrun3li#response-field-startedatstartedAtstring (date-time)OptionalTime at which the scheduled execution started.
Section ID: DOC-API-MODEL-schema-1l7vrun3li#field-completedatSection ID: DOC-API-MODEL-schema-1l7vrun3li#response-field-completedatcompletedAtstring (date-time)OptionalTime at which the scheduled execution completed.
Section ID: DOC-API-MODEL-schema-1l7vrun3li#field-statusSection ID: DOC-API-MODEL-schema-1l7vrun3li#response-field-statusstatusstring (EXECUTION_STATUS_COMPLETED, EXECUTION_STATUS_FAILED, EXECUTION_STATUS_CANCELLED) or integer (int32)Optional; explicit presenceExecution outcome recorded for this scheduled attempt.
Section ID: DOC-API-MODEL-schema-1l7vrun3li#field-httpstatusSection ID: DOC-API-MODEL-schema-1l7vrun3li#response-field-httpstatushttpStatusstring (int64)OptionalHTTP status code returned by the target. Pattern: ^-?\d+$.
Section ID: DOC-API-MODEL-schema-1l7vrun3li#field-attemptSection ID: DOC-API-MODEL-schema-1l7vrun3li#response-field-attemptattemptstring (int64)OptionalAttempt number (1-based) within this firing. Pattern: ^-?\d+$.
Section ID: DOC-API-MODEL-schema-1l7vrun3li#field-durationmsSection ID: DOC-API-MODEL-schema-1l7vrun3li#response-field-durationmsdurationMsstring (int64)OptionalEnd-to-end duration of the delivery attempt, in milliseconds. Pattern: ^-?\d+$.
Section ID: DOC-API-MODEL-schema-1l7vrun3li#field-targetkindSection ID: DOC-API-MODEL-schema-1l7vrun3li#response-field-targetkindtargetKindstringOptionalKind of target invoked by the scheduled execution.
Section ID: DOC-API-MODEL-schema-1l7vrun3li#field-errorSection ID: DOC-API-MODEL-schema-1l7vrun3li#response-field-errorerrorstringOptionalError message when status is FAILED.
Section ID: DOC-API-MODEL-schema-1l7vrun3li#field-responsebodySection ID: DOC-API-MODEL-schema-1l7vrun3li#response-field-responsebodyresponseBodystringOptionalTruncated HTTP response body captured on failed dispatches, with a 4 KiB cap. Empty for successful dispatches by design — only error responses are stored. May also be empty for binary content types or transport-level errors (see response_size_bytes / error).
Section ID: DOC-API-MODEL-schema-1l7vrun3li#field-responseheadersSection ID: DOC-API-MODEL-schema-1l7vrun3li#response-field-responseheadersresponseHeadersMap from string to stringOptionalAllowlisted response headers from the failed dispatch. Allowlist: content-type, content-length, retry-after, x-request-id, date.
Section ID: DOC-API-MODEL-schema-1l7vrun3li#field-responsetruncatedSection ID: DOC-API-MODEL-schema-1l7vrun3li#response-field-responsetruncatedresponseTruncatedbooleanOptionalTrue when response_body was clipped at the 4 KiB cap.
Section ID: DOC-API-MODEL-schema-1l7vrun3li#field-responsesizebytesSection ID: DOC-API-MODEL-schema-1l7vrun3li#response-field-responsesizebytesresponseSizeBytesstring (int64)OptionalOriginal response size in bytes (from Content-Length when present, else total bytes read before truncation). Pattern: ^-?\d+$.
Section ID: DOC-API-MODEL-schema-1l7vrun3li#field-endreasonSection ID: DOC-API-MODEL-schema-1l7vrun3li#response-field-endreasonendReasonstringOptionalExplanation of an execution failure when status alone is insufficient. discarded means the job exhausted maxAttempts and will not be retried. Empty when there is no additional reason.

Values of status​

Section ID: DOC-API-MODEL-schema-1l7vrun3li#response-values-status

Terminal result of one scheduled-job firing. Use end_reason for additional information about a non-successful result. A firing that exhausts its delivery attempts has status FAILED and end_reason "discarded".

ValueNo.FormMeaning
EXECUTION_STATUS_COMPLETED0CanonicalThe scheduled HTTP dispatch received a status below 400; this does not establish completion of downstream asynchronous work.
EXECUTION_STATUS_FAILED1CanonicalThe firing failed, including exhausted delivery attempts; inspect end_reason.
EXECUTION_STATUS_CANCELLED2CanonicalThe firing was cancelled rather than completed, for example by an operator or a non-HTTP cancellation condition, such as a permanent failure to obtain dispatch credentials before the request is sent.

Where used​

Section ID: DOC-API-MODEL-schema-1l7vrun3li#where-used

ReferenceRelationship
List executions for a scheduled jobPOST /api/v1/scheduler/list-executions

Download the public reference contract.

Document ID: DOC-API-MODEL-schema-1l7vrun3li