v1

latestOpenAPI 3.0.0Apache-2.02026-07-172384109.4 KB

for invoking WorkflowState.start API

post/api/v1/workflowState/start

Request body

workflowTypestring required
workflowStateIdstring required

Example request

{
  "dataObjects": [
    {
      "value": {
        "data": "data",
        "extStoreId": "extStoreId",
        "extPath": "extPath",
        "encoding": "encoding"
      },
      "key": "key"
    },
    {
      "value": {
        "data": "data",
        "extStoreId": "extStoreId",
        "extPath": "extPath",
        "encoding": "encoding"
      },
      "key": "key"
    }
  ],
  "workflowStateId": "workflowStateId",
  "context": {
    "firstAttemptTimestamp": 6,
    "workflowStartedTimestamp": 0,
    "workflowRunId": "workflowRunId",
    "attempt": 1,
    "workflowId": "workflowId",
    "stateExecutionId": "stateExecutionId"
  },
  "workflowType": "workflowType",
  "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"
    }
  ],
  "stateInput": {
    "data": "data",
    "extStoreId": "extStoreId",
    "extPath": "extPath",
    "encoding": "encoding"
  }
}

Response

successful operation

localActivityInputstring

Example response

{
  "upsertSearchAttributes": [
    {
      "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"
    }
  ],
  "recordEvents": [
    {
      "value": {
        "data": "data",
        "extStoreId": "extStoreId",
        "extPath": "extPath",
        "encoding": "encoding"
      },
      "key": "key"
    },
    {
      "value": {
        "data": "data",
        "extStoreId": "extStoreId",
        "extPath": "extPath",
        "encoding": "encoding"
      },
      "key": "key"
    }
  ],
  "localActivityInput": "localActivityInput",
  "commandRequest": {
    "signalCommands": [
      {
        "signalChannelName": "signalChannelName",
        "atLeast": 1,
        "atMost": 5,
        "commandId": "commandId"
      },
      {
        "signalChannelName": "signalChannelName",
        "atLeast": 1,
        "atMost": 5,
        "commandId": "commandId"
      }
    ],
    "timerCommands": [
      {
        "durationSeconds": 6,
        "firingUnixTimestampSeconds": 0,
        "commandId": "commandId"
      },
      {
        "durationSeconds": 6,
        "firingUnixTimestampSeconds": 0,
        "commandId": "commandId"
      }
    ],
    "deciderTriggerType": null,
    "commandCombinations": [
      {
        "commandIds": [
          "commandIds",
          "commandIds"
        ]
      },
      {
        "commandIds": [
          "commandIds",
          "commandIds"
        ]
      }
    ],
    "commandWaitingType": null,
    "interStateChannelCommands": [
      {
        "channelName": "channelName",
        "atLeast": 5,
        "atMost": 2,
        "commandId": "commandId"
      },
      {
        "channelName": "channelName",
        "atLeast": 5,
        "atMost": 2,
        "commandId": "commandId"
      }
    ]
  },
  "publishToInterStateChannel": [
    {
      "channelName": "channelName",
      "value": {
        "data": "data",
        "extStoreId": "extStoreId",
        "extPath": "extPath",
        "encoding": "encoding"
      }
    },
    {
      "channelName": "channelName",
      "value": {
        "data": "data",
        "extStoreId": "extStoreId",
        "extPath": "extPath",
        "encoding": "encoding"
      }
    }
  ],
  "upsertStateLocals": [
    {
      "value": {
        "data": "data",
        "extStoreId": "extStoreId",
        "extPath": "extPath",
        "encoding": "encoding"
      },
      "key": "key"
    },
    {
      "value": {
        "data": "data",
        "extStoreId": "extStoreId",
        "extPath": "extPath",
        "encoding": "encoding"
      },
      "key": "key"
    }
  ],
  "upsertDataObjects": [
    {
      "value": {
        "data": "data",
        "extStoreId": "extStoreId",
        "extPath": "extPath",
        "encoding": "encoding"
      },
      "key": "key"
    },
    {
      "value": {
        "data": "data",
        "extStoreId": "extStoreId",
        "extPath": "extPath",
        "encoding": "encoding"
      },
      "key": "key"
    }
  ]
}