/
OR
orkescloud
/
Orkes Conductor API Server
Search skmtc…
⌘K
Changes
Docs
Sign in
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Checked 16h ago · Updated 16h ago
Details
Filter operations
a-2-a-callback-resource
2
admin-resource
5
API Gateway
26
application-resource
15
audit-resource
3
authorization-resource
5
context-controller
1
environment-resource
7
event-execution-resource
2
event-message-resource
2
event-resource
16
global-schema-resource
2
group-resource
10
health-check-resource
1
human-task
14
human-task-resource
1
incoming-webhook-resource
2
integration-resource
26
limits-resource
1
LLM
3
metadata-resource
12
metrics-resource
1
org-config-resource
1
orkes-agent-controller
39
prompt-resource
14
provider-controller
1
queue-admin-resource
2
role-resource
9
scheduler-bulk-resource
2
scheduler-resource
18
schema-resource
6
secret-resource
13
service-registry-resource
15
sharing-resource
3
tags
11
task-resource
18
token-resource
2
user-form
6
user-form-template-resource
3
user-resource
6
version-resource
1
webhooks-config-resource
8
workflow-bulk-resource
6
workflow-resource
32
post
Start a new workflow with StartWorkflowRequest, which allows task to be executed in a domain
post
Lists workflows for the given correlation id list and workflow name list
put
Starts the decision task for a workflow
get
Execute a workflow synchronously with input and outputs using get api
post
Execute a workflow synchronously with input and outputs
post
Execute a workflow synchronously
get
/api/workflow/introspection/records
get
Retrieve all the running workflows
get
Search for workflow executions based on payload and other parameters
post
Start a new workflow asynchronously. Returns the ID of the workflow instance that can be later used for tracking
post
Test workflow execution using mock data
post
Test workflow execution using mock data, blocking until the workflow completes or reaches the specified task
post
Start a new workflow. Returns the ID of the workflow instance that can be later used for tracking
post
Lists workflows for the given correlation id list
get
Lists workflows for the given correlation id
get
Gets the workflow by workflow (execution) id
delete
Terminate workflow execution
post
Jump workflow execution to given task
put
Pauses the workflow
delete
Removes the workflow from the system
post
Reruns the workflow from a specific task
post
Resets callback times of all non-terminal SIMPLE tasks to 0
post
Restarts a completed workflow
put
Resumes the workflow
post
Retries the last failed task
get
Gets the current serialized payload size of a workflow
put
Skips a given task from a current running workflow
post
Update a workflow state by updating variables or in progress task
get
Gets the workflow by workflow (execution) id
get
Gets the workflow tasks by workflow (execution) id
post
Upgrade running workflow to newer version
post
Update workflow variables
workflow-resource
Start a new workflow with StartWorkflowRequest, which allows task to be executed in a domain
post
/api/workflow
Query parameters
consistency
'SYNCHRONOUS'
|
'DURABLE'
|
'REGION_DURABLE'
Request body
StartWorkflowRequest
required
correlationId
string
createdBy
string
externalInputPayloadStoragePath
string
idempotencyKey
string
idempotencyStrategy
'FAIL'
|
'RETURN_EXISTING'
|
'FAIL_ON_RUNNING'
input
object
name
string
required
priority
integer
taskToDomain
object
version
integer
workflowDef
WorkflowDef
Response
OK
Changes