On this page
Tasks API
Generated Golden API operations for Tasks.
Golden 3.0.0 public API reference. Parameters, responses, and schemas for supported customer operations.
16 operations.
GET /api/jobs/definitions
List schedule definitions.
Operation ID: list
List definitions created by Golden. Uses page and size and optional filters. Requires the ADMIN role.
Security: bearerAuth
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
type | query | false | string | — |
enabled | query | false | boolean | — |
source | query | false | string | enum: [“DECLARED”, “API”] |
orphaned | query | false | boolean | — |
page | query | false | integer (int32) | default: 0 |
size | query | false | integer (int32) | default: 20 |
Responses
| Status | Description | Body |
|---|---|---|
200 | OK | /: TzPageTzDefinitionResponse |
GET /api/jobs/definitions/{id}
Read a schedule definition.
Operation ID: get
Returns a definition and its ETag. Use that version in If-Match for a subsequent change. Requires the ADMIN role.
Security: bearerAuth
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
id | path | true | string (uuid) | — |
Responses
| Status | Description | Body |
|---|---|---|
200 | OK | /: TzDefinitionResponse |
PUT /api/jobs/definitions/{id}
Replace a schedule definition.
Operation ID: replace
Requires If-Match with the version read from the definition. Check the full replacement body and owner-managed fields before changing an existing definition. Requires the ADMIN role.
Security: bearerAuth
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
id | path | true | string (uuid) | — |
If-Match | header | true | string | — |
Request body
| Media type | Required | Schema |
|---|---|---|
application/json | true | TzDefinitionRequest |
Responses
| Status | Description | Body |
|---|---|---|
200 | OK | /: TzDefinitionResponse |
DELETE /api/jobs/definitions/{id}
Delete a schedule definition.
Operation ID: delete
Requires If-Match. Product-managed definitions can reject deletion; use the owning entity or source configuration where applicable. Requires the ADMIN role.
Security: bearerAuth
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
id | path | true | string (uuid) | — |
If-Match | header | true | string | — |
Responses
| Status | Description | Body |
|---|---|---|
204 | Completed with no response body | — |
PUT /api/jobs/definitions/{id}/enabled
Enable or disable a schedule.
Operation ID: setEnabled
Send the enabled boolean and the current If-Match value. Disabling future scheduling does not cancel an execution already in progress. Requires the ADMIN role.
Security: bearerAuth
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
id | path | true | string (uuid) | — |
If-Match | header | true | string | — |
Request body
| Media type | Required | Schema |
|---|---|---|
application/json | true | TzEnabledRequest |
Responses
| Status | Description | Body |
|---|---|---|
200 | OK | /: TzDefinitionResponse |
GET /api/jobs/definitions/{id}/next-runs
Preview scheduled execution times.
Operation ID: nextRuns
Returns upcoming times for the definition. Count defaults to 10 and must be between 1 and 365. Requires the ADMIN role.
Security: bearerAuth
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
id | path | true | string (uuid) | — |
count | query | false | integer (int32) | default: 10 |
Responses
| Status | Description | Body |
|---|---|---|
200 | OK | /: TzNextRunsResponse |
POST /api/jobs/definitions/{id}/run
Run a definition now.
Operation ID: run
Returns the new run identifier when accepted. Follow that execution separately. The force parameter bypasses the overlap check only. Requires the ADMIN role.
Security: bearerAuth
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
id | path | true | string (uuid) | — |
force | query | false | boolean | default: false |
Request body
| Media type | Required | Schema |
|---|---|---|
application/json | false | TzRunNowRequest |
Responses
| Status | Description | Body |
|---|---|---|
202 | Request accepted; follow the execution | /: TzDefinitionRunResponse |
GET /api/jobs/runs
List execution summaries.
Operation ID: find
Filter by type, status, definition, time range, or owner. Uses page and size; read an individual run for its input and output. Requires the ADMIN role.
Security: bearerAuth
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
type | query | false | string | — |
status | query | false | string | enum: [“PENDING”, “RUNNING”, “CANCELLING”, “SUCCEEDED”, “FAILED”, “CANCELLED”, “SKIPPED”] |
definition | query | false | string (uuid) | — |
from | query | false | string (date-time) | — |
to | query | false | string (date-time) | — |
owner | query | false | string | — |
page | query | false | integer (int32) | default: 0 |
size | query | false | integer (int32) | default: 20 |
Responses
| Status | Description | Body |
|---|---|---|
200 | OK | /: TzPageTzRunSummary |
POST /api/jobs/runs
Submit an execution.
Operation ID: submit
Submit the input required by an available job type. Prefer the product operation that starts the work when one exists. Acceptance is not successful completion. Requires the ADMIN role.
Security: bearerAuth
Request body
| Media type | Required | Schema |
|---|---|---|
application/json | true | TzRunSubmitRequest |
Responses
| Status | Description | Body |
|---|---|---|
201 | Execution created | /: TzRunView |
200 | An existing execution was returned for the request | /: TzRunView |
DELETE /api/jobs/runs
Delete retained execution records.
Operation ID: delete_1
Deletes eligible terminal execution records selected by the request. This does not undo the work those executions performed. Requires the ADMIN role.
Security: bearerAuth
Request body
| Media type | Required | Schema |
|---|---|---|
application/json | true | TzRunDeleteRequest |
Responses
| Status | Description | Body |
|---|---|---|
204 | Completed with no response body | — |
GET /api/jobs/runs/{id}
Read one execution.
Operation ID: get_2
Read state, progress, input, output, and failure information for the identified run. Requires the ADMIN role.
Security: bearerAuth
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
id | path | true | string (uuid) | — |
Responses
| Status | Description | Body |
|---|---|---|
200 | OK | /: TzRunView |
POST /api/jobs/runs/{id}/cancel
Request execution cancellation.
Operation ID: cancel
Requests cooperative cancellation. Work already applied is not rolled back by this request. Requires the ADMIN role.
Security: bearerAuth
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
id | path | true | string (uuid) | — |
Request body
| Media type | Required | Schema |
|---|---|---|
application/json | false | TzRunCancelRequest |
Responses
| Status | Description | Body |
|---|---|---|
202 | Request accepted; follow the execution | — |
GET /api/jobs/runs/{id}/chain
Read related executions.
Operation ID: chain
Read the chain of executions associated with this run. Requires the ADMIN role.
Security: bearerAuth
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
id | path | true | string (uuid) | — |
Responses
| Status | Description | Body |
|---|---|---|
200 | OK | /: TzChainView |
POST /api/jobs/runs/{id}/retry
Retry an execution.
Operation ID: retry
Request a new attempt for an eligible execution. Inspect prior effects and the failure before retrying data-changing work. Requires the ADMIN role.
Security: bearerAuth
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
id | path | true | string (uuid) | — |
force | query | false | boolean | default: false |
Responses
| Status | Description | Body |
|---|---|---|
202 | Request accepted; follow the execution | — |
200 | An existing execution was returned for the request | — |
GET /api/jobs/types
List available execution types.
Operation ID: list_1
Lists execution types available in this Golden service. Requires the ADMIN role.
Security: bearerAuth
Responses
| Status | Description | Body |
|---|---|---|
200 | OK | /: TzTypesResponse |
GET /api/jobs/types/{type}
Read an execution type.
Operation ID: get_1
Read the input and execution information for one available type. Requires the ADMIN role.
Security: bearerAuth
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
type | path | true | string | — |
Responses
| Status | Description | Body |
|---|---|---|
200 | OK | /: TzTypeResponse |