v1

latestOpenAPI 3.0.0Apache-2.02026-07-172384109.4 KB

execute an RPC of a workflow

post/api/v1/workflow/rpc

Request body

workflowIdstring required

workflowRunIdstring

rpcNamestring required

timeoutSecondsinteger

useMemoForDataAttributesboolean

Example request

{
  "input": {
    "data": "data",
    "extStoreId": "extStoreId",
    "extPath": "extPath",
    "encoding": "encoding"
  },
  "searchAttributesLoadingPolicy": {
    "lockingKeys": [
      "lockingKeys",
      "lockingKeys"
    ],
    "lazyLoadingLargeDataAttributes": true,
    "useKeyAsPrefix": true,
    "partialLoadingKeys": [
      "partialLoadingKeys",
      "partialLoadingKeys"
    ],
    "persistenceLoadingType": null
  },
  "timeoutSeconds": 0,
  "searchAttributes": [
    {
      "valueType": null,
      "key": "key"
    },
    {
      "valueType": null,
      "key": "key"
    }
  ],
  "useMemoForDataAttributes": true,
  "workflowRunId": "workflowRunId",
  "rpcName": "rpcName",
  "workflowId": "workflowId",
  "dataAttributesLoadingPolicy": {
    "lockingKeys": [
      "lockingKeys",
      "lockingKeys"
    ],
    "lazyLoadingLargeDataAttributes": true,
    "useKeyAsPrefix": true,
    "partialLoadingKeys": [
      "partialLoadingKeys",
      "partialLoadingKeys"
    ],
    "persistenceLoadingType": null
  }
}

Response

successful operation

Example response

{
  "output": {
    "data": "data",
    "extStoreId": "extStoreId",
    "extPath": "extPath",
    "encoding": "encoding"
  }
}