start a workflow
post/api/v1/workflow/start
Request body
Example request
{
"startStateId": "startStateId",
"waitForCompletionStateIds": [
"waitForCompletionStateIds",
"waitForCompletionStateIds"
],
"workflowTimeoutSeconds": 0,
"waitForCompletionStateExecutionIds": [
"waitForCompletionStateExecutionIds",
"waitForCompletionStateExecutionIds"
],
"stateOptions": {
"searchAttributesLoadingPolicy": {
"lockingKeys": [
"lockingKeys",
"lockingKeys"
],
"lazyLoadingLargeDataAttributes": true,
"useKeyAsPrefix": true,
"partialLoadingKeys": [
"partialLoadingKeys",
"partialLoadingKeys"
],
"persistenceLoadingType": null
},
"executeApiTimeoutSeconds": 2,
"startApiRetryPolicy": {
"maximumAttemptsDurationSeconds": 9,
"maximumAttempts": 7,
"initialIntervalSeconds": 5,
"maximumIntervalSeconds": 2,
"backoffCoefficient": 5.637377
},
"waitUntilApiFailurePolicy": null,
"dataObjectsLoadingPolicy": {
"lockingKeys": [
"lockingKeys",
"lockingKeys"
],
"lazyLoadingLargeDataAttributes": true,
"useKeyAsPrefix": true,
"partialLoadingKeys": [
"partialLoadingKeys",
"partialLoadingKeys"
],
"persistenceLoadingType": null
},
"skipWaitUntil": true,
"startApiFailurePolicy": null,
"dataAttributesLoadingPolicy": {
"lockingKeys": [
"lockingKeys",
"lockingKeys"
],
"lazyLoadingLargeDataAttributes": true,
"useKeyAsPrefix": true,
"partialLoadingKeys": [
"partialLoadingKeys",
"partialLoadingKeys"
],
"persistenceLoadingType": null
},
"executeApiDataAttributesLoadingPolicy": {
"lockingKeys": [
"lockingKeys",
"lockingKeys"
],
"lazyLoadingLargeDataAttributes": true,
"useKeyAsPrefix": true,
"partialLoadingKeys": [
"partialLoadingKeys",
"partialLoadingKeys"
],
"persistenceLoadingType": null
},
"decideApiRetryPolicy": {
"maximumAttemptsDurationSeconds": 9,
"maximumAttempts": 7,
"initialIntervalSeconds": 5,
"maximumIntervalSeconds": 2,
"backoffCoefficient": 5.637377
},
"executeApiFailureProceedStateId": "executeApiFailureProceedStateId",
"decideApiTimeoutSeconds": 1,
"executeApiSearchAttributesLoadingPolicy": {
"lockingKeys": [
"lockingKeys",
"lockingKeys"
],
"lazyLoadingLargeDataAttributes": true,
"useKeyAsPrefix": true,
"partialLoadingKeys": [
"partialLoadingKeys",
"partialLoadingKeys"
],
"persistenceLoadingType": null
},
"startApiTimeoutSeconds": 6,
"executeApiFailurePolicy": null,
"executeApiFailureProceedStateOptions": null,
"waitUntilApiRetryPolicy": {
"maximumAttemptsDurationSeconds": 9,
"maximumAttempts": 7,
"initialIntervalSeconds": 5,
"maximumIntervalSeconds": 2,
"backoffCoefficient": 5.637377
},
"waitUntilApiSearchAttributesLoadingPolicy": {
"lockingKeys": [
"lockingKeys",
"lockingKeys"
],
"lazyLoadingLargeDataAttributes": true,
"useKeyAsPrefix": true,
"partialLoadingKeys": [
"partialLoadingKeys",
"partialLoadingKeys"
],
"persistenceLoadingType": null
},
"skipStartApi": true,
"waitUntilApiTimeoutSeconds": 3,
"waitUntilApiDataAttributesLoadingPolicy": {
"lockingKeys": [
"lockingKeys",
"lockingKeys"
],
"lazyLoadingLargeDataAttributes": true,
"useKeyAsPrefix": true,
"partialLoadingKeys": [
"partialLoadingKeys",
"partialLoadingKeys"
],
"persistenceLoadingType": null
},
"executeApiRetryPolicy": {
"maximumAttemptsDurationSeconds": 9,
"maximumAttempts": 7,
"initialIntervalSeconds": 5,
"maximumIntervalSeconds": 2,
"backoffCoefficient": 5.637377
}
},
"iwfWorkflowType": "iwfWorkflowType",
"workflowStartOptions": {
"workflowStartDelaySeconds": 4,
"retryPolicy": {
"maximumAttempts": 1,
"initialIntervalSeconds": 7,
"maximumIntervalSeconds": 1,
"backoffCoefficient": 1.2315135
},
"workflowConfigOverride": {
"disableSystemSearchAttribute": true,
"continueAsNewThreshold": 1,
"optimizeTimer": true,
"continueAsNewPageSizeInBytes": 4,
"executingStateIdMode": null,
"optimizeActivity": true
},
"idReusePolicy": null,
"searchAttributes": [
{
"stringValue": "stringValue",
"valueType": null,
"integerValue": 6,
"boolValue": true,
"doubleValue": 7.457744773683766,
"stringArrayValue": [
"stringArrayValue",
"stringArrayValue"
],
"key": "key"
},
{
"stringValue": "stringValue",
"valueType": null,
"integerValue": 6,
"boolValue": true,
"doubleValue": 7.457744773683766,
"stringArrayValue": [
"stringArrayValue",
"stringArrayValue"
],
"key": "key"
}
],
"workflowIDReusePolicy": null,
"useMemoForDataAttributes": true,
"cronSchedule": "cronSchedule",
"workflowAlreadyStartedOptions": {
"requestId": "requestId",
"ignoreAlreadyStartedError": true
},
"dataAttributes": [
{
"value": {
"data": "data",
"extStoreId": "extStoreId",
"extPath": "extPath",
"encoding": "encoding"
},
"key": "key"
},
{
"value": {
"data": "data",
"extStoreId": "extStoreId",
"extPath": "extPath",
"encoding": "encoding"
},
"key": "key"
}
]
},
"iwfWorkerUrl": "iwfWorkerUrl",
"workflowId": "workflowId",
"stateInput": {
"data": "data",
"extStoreId": "extStoreId",
"extPath": "extPath",
"encoding": "encoding"
}
}Response
successful operation
Example response
{
"workflowRunId": "workflowRunId"
}