v1

latestOpenAPI 3.0.0Apache-2.02026-07-172384109.4 KB

for invoking workflow RPC API in the worker

post/api/v1/workflowWorker/rpc

Request body

workflowTypestring required
rpcNamestring required
signalChannelInfosobject
internalChannelInfosobject

Example request

{
  "internalChannelInfos": {
    "key": {
      "size": 0
    }
  },
  "input": {
    "data": "data",
    "extStoreId": "extStoreId",
    "extPath": "extPath",
    "encoding": "encoding"
  },
  "signalChannelInfos": {
    "key": {
      "size": 0
    }
  },
  "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"
    }
  ],
  "rpcName": "rpcName",
  "dataAttributes": [
    {
      "value": {
        "data": "data",
        "extStoreId": "extStoreId",
        "extPath": "extPath",
        "encoding": "encoding"
      },
      "key": "key"
    },
    {
      "value": {
        "data": "data",
        "extStoreId": "extStoreId",
        "extPath": "extPath",
        "encoding": "encoding"
      },
      "key": "key"
    }
  ]
}

Response

successful operation

Example response

{
  "output": {
    "data": "data",
    "extStoreId": "extStoreId",
    "extPath": "extPath",
    "encoding": "encoding"
  },
  "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"
    }
  ],
  "stateDecision": {
    "nextStates": [
      {
        "stateId": "stateId",
        "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
          }
        },
        "stateInput": {
          "data": "data",
          "extStoreId": "extStoreId",
          "extPath": "extPath",
          "encoding": "encoding"
        },
        "waitForKey": "waitForKey"
      },
      {
        "stateId": "stateId",
        "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
          }
        },
        "stateInput": {
          "data": "data",
          "extStoreId": "extStoreId",
          "extPath": "extPath",
          "encoding": "encoding"
        },
        "waitForKey": "waitForKey"
      }
    ],
    "conditionalClose": {
      "closeInput": {
        "data": "data",
        "extStoreId": "extStoreId",
        "extPath": "extPath",
        "encoding": "encoding"
      },
      "channelName": "channelName",
      "conditionalCloseType": null
    }
  },
  "upsertDataAttributes": [
    {
      "value": {
        "data": "data",
        "extStoreId": "extStoreId",
        "extPath": "extPath",
        "encoding": "encoding"
      },
      "key": "key"
    },
    {
      "value": {
        "data": "data",
        "extStoreId": "extStoreId",
        "extPath": "extPath",
        "encoding": "encoding"
      },
      "key": "key"
    }
  ],
  "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"
    }
  ]
}