workflow-resource

Test workflow execution using mock data, blocking until the workflow completes or reaches the specified task

Changed on Oct 10, 2026

post/api/workflow/test/sync

Request

Base URL
https://developer.orkescloud.com
Auth
API key in header X-Authorization
TypeScript
https://skmtc.dev/orkescloud/apis/orkes-conductor-api-server/docs/api/workflow/test/sync/post.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

requestIdstring

waitUntilTaskRefstring

waitForSecondsinteger

consistency'SYNCHRONOUS' | 'DURABLE' | 'REGION_DURABLE'

returnStrategy'TARGET_WORKFLOW' | 'BLOCKING_WORKFLOW' | 'BLOCKING_TASK' | 'BLOCKING_TASK_INPUT' | 'BLOCKING_TASK_LIST'

Selects the workflow or task state returned by the synchronous signal endpoint.

Request body

correlationIdstring

createdBystring

externalInputPayloadStoragePathstring

idempotencyKeystring

idempotencyStrategy'FAIL' | 'RETURN_EXISTING' | 'FAIL_ON_RUNNING'

inputobject

maxLoopsinteger

mockTtlSecondsinteger

namestring required

priorityinteger

subWorkflowTestRequestobject

taskRefToMockOutputobject

taskToDomainobject

versioninteger

Response

Changes

Oct 10, 2026a142cbe9d486 Revision changes
- breaking
  added the new required request property //////
- breaking
  the request's body type changed from no type to object
- breaking
  the / request property's minItems was increased to 1
- breaking
  the / request property's minLength was increased from 0 to 1
- breaking
  the /// request property's minLength was increased from 0 to 1
- breaking
  the //// request property's minLength was increased from 0 to 1
- breaking
  the /// request property's minLength was increased from 0 to 1
- breaking
  the // request property type changed from no type to object
- breaking
  the request property type changed from no type to object
- breaking
  the / request property type changed from no type to object
- breaking
  the / request property type changed from no type to object
- breaking
  the / request property type changed from no type to object
- breaking
  the / request property type changed from no type to object
- breaking
  the // request property type changed from no type to object
- breaking
  the /// request property type changed from no type to object
- breaking
  the ///// request property type changed from no type to object
- breaking
  the /// request property type changed from no type to object
- breaking
  the /// request property type changed from no type to object
- breaking
  the //// request property type changed from no type to object
- breaking
  the //// request property type changed from no type to object
- breaking
  added to the response body oneOf list for the response status
- breaking
  the response's body type changed from no type to object for status
- warning
  the request property's max was set to 99.00
- warning
  the / request property's max was set to 2.00
- warning
  the request property's min was set to 0.00
- warning
  the / request property's min was set to 2.00
- warning
  the //// request property's min was set to 0.00
- warning
  the //// request property's min was set to 1.00
- warning
  the //// request property's min was set to 0.00
- warning
  the //// request property's min was set to 0.00
- warning
  the //// request property's min was set to 1.00
- warning
  the //// request property's min was set to 0.00
- warning
  the //// request property's min was set to 0.00
- warning
  added the new BLOCKING_TASK_LIST enum value to the response property for the response status
- info
  added the new optional request property ///
- info
  added the new optional request property ///
- info
  added the new optional request property ///
- info
  added the new optional request property ///
- info
  added the new optional request property //////
- info
  added the new enum value BLOCKING_TASK_LIST to the query request parameter returnStrategy
- info
  the request property / became optional
- info
  the request property /// became optional
- info
  the request property //// became optional
- info
  the request property /// became optional
- info
  added response discriminator for the response status
- info
  added the optional property to the response with the status

Operation history