Cisco Crosswork Jobs API
The jobs API from Cisco Crosswork — 7 operation(s) for jobs.
The jobs API from Cisco Crosswork — 7 operation(s) for jobs.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/cisco-crosswork-jobs-api"
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Cisco Crosswork Workflow Manager Jobs API
description: Cisco Crosswork Workflow Manager (CWM) 2.1 offers RESTful APIs that enable automation engineers and developers to create, deploy, and manage workflows, adapters, jobs, resources, events, and workers within the Cisco CWM platform.
version: 2.1.0
termsOfService: https://www.cisco.com/c/en/us/about/legal/terms-conditions.html
contact:
name: API Support
url: https://www.cisco.com/support
x-provenance:
method: harvested
authored_by: Cisco Crosswork
harvested_by: API Evangelist
harvested_on: '2026-08-19'
first_party: true
provider_published: true
note: Refined from Cisco's own Crosswork Workflow Manager 2.1 Swagger 2.0 reference (see openapi/_original/cisco-crosswork-cwm-workflow-manager-openapi.json). Converted to OpenAPI 3.2.0 and split by tag; operationIds absent from Cisco's source were synthesised deterministically from method+path.
x-evidence:
- type: source
url: https://developer.cisco.com/docs/crosswork/workflow-manager/
- type: raw
url: https://pubhub.devnetcloud.com/media/crosswork-workflow-manager-api-document/docs/262737b2-b3c2-32cd-b07b-fdbdcd23918f/apis/
servers:
- url: /crosswork/cwm/v2
description: Relative to the customer-deployed Crosswork Workflow Manager host (https://{cwm-host}:{port})
security:
- Bearer: []
tags:
- name: jobs
paths:
/job:
get:
summary: List jobs.
description: Retrieve a list of jobs based on query parameters.
operationId: list_jobs
tags:
- jobs
parameters:
- name: pageSize
in: query
description: Number of jobs to return per page.
required: false
schema:
type: integer
- name: nextPageToken
in: query
description: Page token to retrieve the next page of results.
required: false
schema:
type: string
- name: query
in: query
description: Query string to filter jobs.
required: false
schema:
type: string
responses:
'200':
description: Jobs retrieved successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/workflowservice.ListWorkflowExecutionsResponse'
'400':
description: Bad request.
content:
application/json:
schema:
$ref: '#/components/schemas/gin.H'
'404':
description: Jobs not found.
content:
application/json:
schema:
$ref: '#/components/schemas/gin.H'
security:
- Bearer: []
post:
summary: Execute a job.
description: Execute a new job using the provided parameters.
operationId: execute_job
tags:
- jobs
requestBody:
description: Job execution parameters.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/server.TriggerData'
responses:
'200':
description: Job executed successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/gin.H'
'400':
description: Bad request.
content:
application/json:
schema:
$ref: '#/components/schemas/gin.H'
'500':
description: Internal server error.
content:
application/json:
schema:
$ref: '#/components/schemas/gin.H'
security:
- Bearer: []
/job/count:
get:
summary: Get total job count.
description: Retrieve the total count of jobs, optionally filtered by a query.
operationId: job_count
tags:
- jobs
parameters:
- name: query
in: query
description: Query to filter the job count.
required: false
schema:
type: string
responses:
'200':
description: Total job count retrieved successfully.
content:
application/json:
schema:
type: string
'400':
description: Bad request.
content:
application/json:
schema:
$ref: '#/components/schemas/gin.H'
'404':
description: Jobs not found.
content:
application/json:
schema:
$ref: '#/components/schemas/gin.H'
security:
- Bearer: []
/job/tags:
get:
summary: List job tags.
description: Retrieve a list of all job tags from the database.
operationId: list_job_tags
tags:
- jobs
responses:
'200':
description: Job tags retrieved successfully.
content:
application/json:
schema:
type: array
items:
type: string
'400':
description: Bad request.
content:
application/json:
schema:
type: string
security:
- Bearer: []
/job/{jobId}/runs/{runId}:
get:
summary: Describe a job run.
description: Retrieve details of a specific job run by job ID and run ID.
operationId: describe_job
tags:
- jobs
parameters:
- name: jobId
in: path
description: Job ID.
required: true
schema:
type: string
- name: runId
in: path
description: Run ID.
required: true
schema:
type: string
responses:
'200':
description: Job run details retrieved successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/workflowservice.DescribeWorkflowExecutionResponse'
'400':
description: Bad request.
content:
application/json:
schema:
$ref: '#/components/schemas/gin.H'
'404':
description: Job run not found.
content:
application/json:
schema:
$ref: '#/components/schemas/gin.H'
security:
- Bearer: []
/job/{jobId}/runs/{runId}/cancel:
post:
summary: Cancel a job run.
description: Cancel the execution of a running job.
operationId: cancel_job
tags:
- jobs
parameters:
- name: jobId
in: path
description: Job ID.
required: true
schema:
type: string
- name: runId
in: path
description: Run ID.
required: true
schema:
type: string
responses:
'200':
description: Job run cancelled successfully.
content:
application/json:
schema:
type: string
'400':
description: Bad request.
content:
application/json:
schema:
$ref: '#/components/schemas/gin.H'
'404':
description: Job run not found.
content:
application/json:
schema:
$ref: '#/components/schemas/gin.H'
security:
- Bearer: []
/job/{jobId}/runs/{runId}/events:
get:
summary: Get job execution history.
description: Retrieve the full history of a job execution by job ID and run ID.
operationId: get_job_history
tags:
- jobs
parameters:
- name: jobId
in: path
description: Job ID.
required: true
schema:
type: string
- name: runId
in: path
description: Run ID.
required: true
schema:
type: string
- name: isLongPoll
in: query
description: Enable long polling for new events.
required: false
schema:
type: boolean
- name: filterType
in: query
description: Filter event types (e.g., 'all', 'close_event').
required: false
schema:
type: string
responses:
'200':
description: Job history retrieved successfully.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/history.HistoryEvent'
'400':
description: Bad request.
content:
application/json:
schema:
$ref: '#/components/schemas/gin.H'
'404':
description: Job history not found.
content:
application/json:
schema:
$ref: '#/components/schemas/gin.H'
security:
- Bearer: []
/job/{jobId}/runs/{runId}/terminate:
post:
summary: Terminate a job run.
description: Forcefully terminate the execution of a running job.
operationId: terminate_job
tags:
- jobs
parameters:
- name: jobId
in: path
description: Job ID.
required: true
schema:
type: string
- name: runId
in: path
description: Run ID.
required: true
schema:
type: string
- name: reason
in: query
description: Reason for terminating the job.
required: true
schema:
type: string
responses:
'200':
description: Job run terminated successfully.
content:
application/json:
schema:
type: string
'400':
description: Bad request.
content:
application/json:
schema:
$ref: '#/components/schemas/gin.H'
'404':
description: Job run not found.
content:
application/json:
schema:
$ref: '#/components/schemas/gin.H'
security:
- Bearer: []
components:
schemas:
common.SearchAttributes:
type: object
properties:
indexed_fields:
type: object
additionalProperties:
$ref: '#/components/schemas/common.Payload'
workflow.RequestIdInfo:
type: object
properties:
buffered:
description: 'Indicate if the request is still buffered. If so, the event ID is not known and its value
will be an invalid event ID.'
type: boolean
event_id:
description: 'The event id of the history event generated by the request. It''s possible the event ID is not
known (unflushed buffered event). In this case, the value will be zero or a negative value,
representing an invalid ID.'
type: integer
event_type:
$ref: '#/components/schemas/enums.EventType'
common.RetryPolicy:
type: object
properties:
backoff_coefficient:
description: 'Coefficient used to calculate the next retry interval.
The next retry interval is previous interval multiplied by the coefficient.
Must be 1 or larger.'
type: number
initial_interval:
$ref: '#/components/schemas/durationpb.Duration'
maximum_attempts:
description: 'Maximum number of attempts. When exceeded the retries stop even if not expired yet.
1 disables retries. 0 means unlimited (up to the timeouts)'
type: integer
maximum_interval:
$ref: '#/components/schemas/durationpb.Duration'
non_retryable_error_types:
description: 'Non-Retryable errors types. Will stop retrying if the error type matches this list. Note that
this is not a substring match, the error *type* (not message) must match exactly.'
type: array
items:
type: string
common.WorkflowExecution:
type: object
properties:
run_id:
type: string
workflow_id:
type: string
description: "Contains information about the root workflow execution.\nThe root workflow execution is defined as follows:\n1. A workflow without parent workflow is its own root workflow.\n2. A workflow that has a parent workflow has the same root workflow as its parent workflow.\nNote: workflows continued as new or reseted may or may not have parents, check examples below.\n\nExamples:\n\n\tScenario 1: Workflow W1 starts child workflow W2, and W2 starts child workflow W3.\n\t - The root workflow of all three workflows is W1.\n\tScenario 2: Workflow W1 starts child workflow W2, and W2 continued as new W3.\n\t - The root workflow of all three workflows is W1.\n\tScenario 3: Workflow W1 continued as new W2.\n\t - The root workflow of W1 is W1 and the root workflow of W2 is W2.\n\tScenario 4: Workflow W1 starts child workflow W2, and W2 is reseted, creating W3\n\t - The root workflow of all three workflows is W1.\n\tScenario 5: Workflow W1 is reseted, creating W2.\n\t - The root workflow of W1 is W1 and the root workflow of W2 is W2."
common.Payload:
type: object
properties:
data:
type: array
items:
type: integer
metadata:
type: object
additionalProperties:
type: array
items:
type: integer
description: "Alternative way to supply `message` and `stack_trace` and possibly other attributes, used for encryption of\nerrors originating in user code which might contain sensitive information.\nThe `encoded_attributes` Payload could represent any serializable object, e.g. JSON object or a `Failure` proto\nmessage.\n\nSDK authors:\n- The SDK should provide a default `encodeFailureAttributes` and `decodeFailureAttributes` implementation that:\n - Uses a JSON object to represent `{ message, stack_trace }`.\n - Overwrites the original message with \"Encoded failure\" to indicate that more information could be extracted.\n - Overwrites the original stack_trace with an empty string.\n - The resulting JSON object is converted to Payload using the default PayloadConverter and should be processed\n by the user-provided PayloadCodec\n\n- If there's demand, we could allow overriding the default SDK implementation to encode other opaque Failure attributes.\n(-- api-linter: core::0203::optional=disabled --)"
common.Payloads:
type: object
properties:
payloads:
type: array
items:
$ref: '#/components/schemas/common.Payload'
workflow.DeploymentVersionTransition:
type: object
properties:
deployment_version:
$ref: '#/components/schemas/go_temporal_io_api_deployment_v1.WorkerDeploymentVersion'
version:
description: 'Deprecated. Use `deployment_version`.
Deprecated: Marked as deprecated in temporal/api/workflow/v1/message.proto.'
type: string
description: 'When present, indicates the workflow is transitioning to a different deployment version
(which may belong to the same deployment name or another). Can indicate one of the following
transitions: unversioned -> versioned, versioned -> versioned
on a different deployment version, or versioned -> unversioned.
Not applicable to workflows with PINNED behavior.
When a workflow with AUTO_UPGRADE behavior creates a new workflow task, it will automatically
start a transition to the task queue''s current version if the task queue''s current version is
different from the workflow''s current deployment version.
If the AUTO_UPGRADE workflow is stuck due to backlogged activity or workflow tasks, those
tasks will be redirected to the task queue''s current version. As soon as a poller from
that deployment version is available to receive the task, the workflow will automatically
start a transition to that version and continue execution there.
A version transition can only exist while there is a pending or started workflow task.
Once the pending workflow task completes on the transition''s target version, the
transition completes and the workflow''s `behavior`, and `deployment_version` fields are updated per the
worker''s task completion response.
Pending activities will not start new attempts during a transition. Once the transition is
completed, pending activities will start their next attempt on the new version.'
common.ActivityType:
type: object
properties:
name:
type: string
failure.Failure:
type: object
properties:
cause:
$ref: '#/components/schemas/failure.Failure'
encoded_attributes:
$ref: '#/components/schemas/common.Payload'
failureInfo:
description: "Types that are valid to be assigned to FailureInfo:\n\n\t*Failure_ApplicationFailureInfo\n\t*Failure_TimeoutFailureInfo\n\t*Failure_CanceledFailureInfo\n\t*Failure_TerminatedFailureInfo\n\t*Failure_ServerFailureInfo\n\t*Failure_ResetWorkflowFailureInfo\n\t*Failure_ActivityFailureInfo\n\t*Failure_ChildWorkflowExecutionFailureInfo\n\t*Failure_NexusOperationExecutionFailureInfo\n\t*Failure_NexusHandlerFailureInfo"
message:
type: string
source:
description: 'The source this Failure originated in, e.g. TypeScriptSDK / JavaSDK
In some SDKs this is used to rehydrate the stack trace into an exception object.'
type: string
stack_trace:
type: string
description: The last attempt's failure, if any.
workflow.NexusOperationCancellationInfo:
type: object
properties:
attempt:
description: 'The number of attempts made to deliver the cancel operation request.
This number represents a minimum bound since the attempt is incremented after the request completes.'
type: integer
blocked_reason:
description: If the state is BLOCKED, blocked reason provides additional information.
type: string
last_attempt_complete_time:
$ref: '#/components/schemas/timestamppb.Timestamp'
last_attempt_failure:
$ref: '#/components/schemas/failure.Failure'
next_attempt_schedule_time:
$ref: '#/components/schemas/timestamppb.Timestamp'
requested_time:
$ref: '#/components/schemas/timestamppb.Timestamp'
state:
$ref: '#/components/schemas/enums.NexusOperationCancellationState'
go_temporal_io_api_enums_v1.CallbackState:
type: integer
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
x-enum-varnames:
- CALLBACK_STATE_UNSPECIFIED
- CALLBACK_STATE_STANDBY
- CALLBACK_STATE_SCHEDULED
- CALLBACK_STATE_BACKING_OFF
- CALLBACK_STATE_FAILED
- CALLBACK_STATE_SUCCEEDED
- CALLBACK_STATE_BLOCKED
common.Link:
type: object
properties:
variant:
description: "Types that are valid to be assigned to Variant:\n\n\t*Link_WorkflowEvent_\n\t*Link_BatchJob_"
workflow.DeploymentTransition:
type: object
properties:
deployment:
$ref: '#/components/schemas/deployment.Deployment'
description: 'When present, indicates the workflow is transitioning to a different deployment. Can
indicate one of the following transitions: unversioned -> versioned, versioned -> versioned
on a different deployment, or versioned -> unversioned.
Not applicable to workflows with PINNED behavior.
When a workflow with AUTO_UPGRADE behavior creates a new workflow task, it will automatically
start a transition to the task queue''s current deployment if the task queue''s current
deployment is different from the workflow''s deployment.
If the AUTO_UPGRADE workflow is stuck due to backlogged activity or workflow tasks, those
tasks will be redirected to the task queue''s current deployment. As soon as a poller from
that deployment is available to receive the task, the workflow will automatically start a
transition to that deployment and continue execution there.
A deployment transition can only exist while there is a pending or started workflow task.
Once the pending workflow task completes on the transition''s target deployment, the
transition completes and the workflow''s `deployment` and `behavior` fields are updated per
the worker''s task completion response.
Pending activities will not start new attempts during a transition. Once the transition is
completed, pending activities will start their next attempt on the new deployment.
Deprecated. Use version_transition.
Deprecated: Marked as deprecated in temporal/api/workflow/v1/message.proto.'
go_temporal_io_api_deployment_v1.WorkerDeploymentVersion:
type: object
properties:
build_id:
description: 'A unique identifier for this Version within the Deployment it is a part of.
Not necessarily unique within the namespace.
The combination of `deployment_name` and `build_id` uniquely identifies this
Version within the namespace, because Deployment names are unique within a namespace.'
type: string
deployment_name:
description: Identifies the Worker Deployment this Version is part of.
type: string
description: 'The Worker Deployment Version that completed the last workflow task of this workflow execution.
An absent value means no workflow task is completed, or the workflow is unversioned.
If present, and `behavior` is UNSPECIFIED, the last task of this workflow execution was completed
by a worker that is not using versioning but _is_ passing Deployment Name and Build ID.
For child workflows of Pinned parents, this will be set to the parent''s Pinned Version when
the child starts, so that the child''s first workflow task goes to the same Version as the parent.
Note that if `versioning_override.behavior` is PINNED then `versioning_override.pinned_version`
will override this value.'
workflow.WorkflowExecutionConfig:
type: object
properties:
default_workflow_task_timeout:
$ref: '#/components/schemas/durationpb.Duration'
task_queue:
$ref: '#/components/schemas/taskqueue.TaskQueue'
user_metadata:
$ref: '#/components/schemas/sdk.UserMetadata'
workflow_execution_timeout:
$ref: '#/components/schemas/durationpb.Duration'
workflow_run_timeout:
$ref: '#/components/schemas/durationpb.Duration'
enums.PendingActivityState:
type: integer
enum:
- 0
- 1
- 2
- 3
- 4
- 5
x-enum-varnames:
- PENDING_ACTIVITY_STATE_UNSPECIFIED
- PENDING_ACTIVITY_STATE_SCHEDULED
- PENDING_ACTIVITY_STATE_STARTED
- PENDING_ACTIVITY_STATE_CANCEL_REQUESTED
- PENDING_ACTIVITY_STATE_PAUSED
- PENDING_ACTIVITY_STATE_PAUSE_REQUESTED
workflowservice.ListWorkflowExecutionsResponse:
type: object
properties:
executions:
type: array
items:
$ref: '#/components/schemas/workflow.WorkflowExecutionInfo'
next_page_token:
type: array
items:
type: integer
workflow.PendingNexusOperationInfo:
type: object
properties:
attempt:
description: 'The number of attempts made to deliver the start operation request.
This number represents a minimum bound since the attempt is incremented after the request completes.'
type: integer
blocked_reason:
description: If the state is BLOCKED, blocked reason provides additional information.
type: string
cancellation_info:
$ref: '#/components/schemas/workflow.NexusOperationCancellationInfo'
endpoint:
description: 'Endpoint name.
Resolved to a URL via the cluster''s endpoint registry.'
type: string
last_attempt_complete_time:
$ref: '#/components/schemas/timestamppb.Timestamp'
last_attempt_failure:
$ref: '#/components/schemas/failure.Failure'
next_attempt_schedule_time:
$ref: '#/components/schemas/timestamppb.Timestamp'
operation:
description: Operation name.
type: string
operation_id:
description: 'Operation ID. Only set for asynchronous operations after a successful StartOperation call.
Deprecated. Renamed to operation_token.
Deprecated: Marked as deprecated in temporal/api/workflow/v1/message.proto.'
type: string
operation_token:
description: Operation token. Only set for asynchronous operations after a successful StartOperation call.
type: string
schedule_to_close_timeout:
$ref: '#/components/schemas/durationpb.Duration'
scheduled_event_id:
description: 'The event ID of the NexusOperationScheduled event. Can be used to correlate an operation in the
DescribeWorkflowExecution response with workflow history.'
type: integer
scheduled_time:
$ref: '#/components/schemas/timestamppb.Timestamp'
service:
description: Service name.
type: string
state:
$ref: '#/components/schemas/enums.PendingNexusOperationState'
workflow.WorkflowExecutionExtendedInfo:
type: object
properties:
cancel_requested:
description: indicates if the workflow received a cancel request
type: boolean
execution_expiration_time:
$ref: '#/components/schemas/timestamppb.Timestamp'
last_reset_time:
$ref: '#/components/schemas/timestamppb.Timestamp'
original_start_time:
$ref: '#/components/schemas/timestamppb.Timestamp'
request_id_infos:
description: 'Request ID information (eg: history event information associated with the request ID).
Note: It only contains request IDs from StartWorkflowExecution requests, including indirect
calls (eg: if SignalWithStartWorkflowExecution starts a new workflow, then the request ID is
used in the StartWorkflowExecution request).'
type: object
additionalProperties:
$ref: '#/components/schemas/workflow.RequestIdInfo'
reset_run_id:
description: Reset Run ID points to the new run when this execution is reset. If the execution is reset multiple times, it points to the latest run.
type: string
run_expiration_time:
$ref: '#/components/schemas/timestamppb.Timestamp'
enums.EventType:
type: integer
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 47
- 41
- 42
- 43
- 44
- 45
- 46
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
x-enum-varnames:
- EVENT_TYPE_UNSPECIFIED
- EVENT_TYPE_WORKFLOW_EXECUTION_STARTED
- EVENT_TYPE_WORKFLOW_EXECUTION_COMPLETED
- EVENT_TYPE_WORKFLOW_EXECUTION_FAILED
- EVENT_TYPE_WORKFLOW_EXECUTION_TIMED_OUT
- EVENT_TYPE_WORKFLOW_TASK_SCHEDULED
- EVENT_TYPE_WORKFLOW_TASK_STARTED
- EVENT_TYPE_WORKFLOW_TASK_COMPLETED
- EVENT_TYPE_WORKFLOW_TASK_TIMED_OUT
- EVENT_TYPE_WORKFLOW_TASK_FAILED
- EVENT_TYPE_ACTIVITY_TASK_SCHEDULED
- EVENT_TYPE_ACTIVITY_TASK_STARTED
- EVENT_TYPE_ACTIVITY_TASK_COMPLETED
- EVENT_TYPE_ACTIVITY_TASK_FAILED
- EVENT_TYPE_ACTIVITY_TASK_TIMED_OUT
- EVENT_TYPE_ACTIVITY_TASK_CANCEL_REQUESTED
- EVENT_TYPE_ACTIVITY_TASK_CANCELED
- EVENT_TYPE_TIMER_STARTED
- EVENT_TYPE_TIMER_FIRED
- EVENT_TYPE_TIMER_CANCELED
- EVENT_TYPE_WORKFLOW_EXECUTION_CANCEL_REQUESTED
- EVENT_TYPE_WORKFLOW_EXECUTION_CANCELED
- EVENT_TYPE_REQUEST_CANCEL_EXTERNAL_WORKFLOW_EXECUTION_INITIATED
- EVENT_TYPE_REQUEST_CANCEL_EXTERNAL_WORKFLOW_EXECUTION_FAILED
- EVENT_TYPE_EXTERNAL_WORKFLOW_EXECUTION_CANCEL_REQUESTED
- EVENT_TYPE_MARKER_RECORDED
- EVENT_TYPE_WORKFLOW_EXECUTION_SIGNALED
- EVENT_TYPE_WORKFLOW_EXECUTION_TERMINATED
- EVENT_TYPE_WORKFLOW_EXECUTION_CONTINUED_AS_NEW
- EVENT_TYPE_START_CHILD_WORKFLOW_EXECUTION_INITIATED
- EVENT_TYPE_START_CHILD_WORKFLOW_EXECUTION_FAILED
- EVENT_TYPE_CHILD_WORKFLOW_EXECUTION_STARTED
- EVENT_TYPE_CHILD_WORKFLOW_EXECUTION_COMPLETED
- EVENT_TYPE_CHILD_WORKFLOW_EXECUTION_FAILED
- EVENT_TYPE_CHILD_WORKFLOW_EXECUTION_CANCELED
- EVENT_TYPE_CHILD_WORKFLOW_EXECUTION_TIMED_OUT
- EVENT_TYPE_CHILD_WORKFLOW_EXECUTION_TERMINATED
- EVENT_TYPE_SIGNAL_EXTERNAL_WORKFLOW_EXECUTION_INITIATED
- EVENT_TYPE_SIGNAL_EXTERNAL_WORKFLOW_EXECUTION_FAILED
- EVENT_TYPE_EXTERNAL_WORKFLOW_EXECUTION_SIGNALED
- EVENT_TYPE_UPSERT_WORKFLOW_SEARCH_ATTRIBUTES
- EVENT_TYPE_WORKFLOW_EXECUTION_UPDATE_ADMITTED
- EVENT_TYPE_WORKFLOW_EXECUTION_UPDATE_ACCEPTED
- EVENT_TYPE_WORKFLOW_EXECUTION_UPDATE_REJECTED
- EVENT_TYPE_WORKFLOW_EXECUTION_UPDATE_COMPLETED
- EVENT_TYPE_WORKFLOW_PROPERTIES_MODIFIED_EXTERNALLY
- EVENT_TYPE_ACTIVITY_PROPERTIES_MODIFIED_EXTERNALLY
- EVENT_TYPE_WORKFLOW_PROPERTIES_MODIFIED
- EVENT_TYPE_NEXUS_OPERATION_SCHEDULED
- EVENT_TYPE_NEXUS_OPERATION_STARTED
- EVENT_TYPE_NEXUS_OPERATION_COMPLETED
- EVENT_TYPE_NEXUS_OPERATION_FAILED
- EVENT_TYPE_NEXUS_OPERATION_CANCELED
- EVENT_TYPE_NEXUS_OPERATION_TIMED_OUT
- EVENT_TYPE_NEXUS_OPERATION_CANCEL_REQUESTED
- EVENT_TYPE_WORKFLOW_EXECUTION_OPTIONS_UPDATED
- EVENT_TYPE_NEXUS_OPERATION_CANCEL_REQUEST_COMPLETED
- EVENT_TYPE_NEXUS_OPERATION_CANCEL_REQUEST_FAILED
description: The event type of the history event generated by the request.
enums.PendingWorkflowTaskState:
type: integer
enum:
- 0
- 1
- 2
x-enum-varnames:
- PENDING_WORKFLOW_TASK_STATE_UNSPECIFIED
- PENDING_WORKFLOW_TASK_STATE_SCHEDULED
- PENDING_WORKFLOW_TASK_STATE_STARTED
enums.PendingNexusOperationState:
type: integer
enum:
- 0
- 1
- 2
- 3
- 4
x-enum-varnames:
- PENDING_NEXUS_OPERATION_STATE_UNSPECIFIED
- PENDING_NEXUS_OPERATION_STATE_SCHEDULED
- PENDING_NEXUS_OPERATION_STATE_BACKING_OFF
- PENDING_NEXUS_OPERATION_STATE_STARTED
- PENDING_NEXUS_OPERATION_STATE_BLOCKED
workflow.PendingChildExecutionInfo:
type: object
properties:
initiated_id:
type: integer
parent_close_policy:
$ref: '#/components/schemas/enums.ParentClosePolicy'
run_id:
type: string
workflow_id:
type: string
workflow_type_name:
type: string
workflow.CallbackInfo:
type: object
properties:
attempt:
description: 'The number of attempts made to deliver the callback.
This number represents a minimum bound since the attempt is incremented after the callback request completes.'
type: integer
blocked_reason:
description: If the state is BLOCKED, blocked reason provides additional information.
type: string
callback:
$ref: '#/components/schemas/common.Callback'
last_attempt_complete_time:
$ref: '#/components/schemas/timestamppb.Timestamp'
last_attempt_failure:
$ref: '#/components/schemas/failure.Failure'
next_attempt_schedule_time:
$ref: '#/components/schemas/timestamppb.Timestamp'
registration_time:
$ref: '#/components/schemas/timestamppb.Timestamp'
state:
# --- truncated at 32 KB (61 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/cisco-crosswork/refs/heads/main/openapi/cisco-crosswork-jobs-api-openapi.yml