Skip to main content

CreateUnitOperationRunBody

unitOperationIdnumberrequired

ID of the unit operation for this run

processRunIdnumber

ID of the process run to associate with this unit operation run

startTimestring<date-time>

Start time of the unit operation run

endTimestring<date-time>

End time of the unit operation run

statestring

State of the unit operation run

Possible values: [Running, Completed]

Default value: Running
fileUrisstring[]

Array of file URIs to associate with this run

flowRuns object[]

Array of flow run identifiers consisting of the Flow runId and flowId

  • Array [
  • runIdstringrequired

    Flow run ID associated with this run

    Possible values: Value must match regular expression /^\d+$/

    flowIdstringrequired

    Flow ID associated with this run

    Possible values: Value must match regular expression /^\S+$/

  • ]
  • instrumentRunIdsnumber[]

    Array of instrument run IDs to associate with this run

    panelSessionIdsstring[]

    Array of panel session IDs to associate with this run

    bqTableNamesstring[]

    Array of BqTable Names to associate with this run

    Possible values: Value must match regular expression /^\S+$/

    externalIdstringrequired

    External identifier for the unit operation run

    urlstring

    URL associated with the external identifier

    initiator object

    Initiator of the unit operation run

    userEmailstring

    User email if the initiator is a user

    flowRun object

    Flow run identifier consisting of the Flow runId and flowId

    runIdstringrequired

    Flow run ID associated with this run

    Possible values: Value must match regular expression /^\d+$/

    flowIdstringrequired

    Flow ID associated with this run

    Possible values: Value must match regular expression /^\S+$/

    connectionIdstring

    Connection ID if the initiator is a connection

    connectorConnectionIdstring

    Connector Connection ID if the initiator is a connector connection

    systemActorIdnumber

    System Actor ID if the initiator is a system actor

    CreateUnitOperationRunBody
    {
    "unitOperationId": 0,
    "processRunId": 0,
    "startTime": "2024-07-29T15:51:28.071Z",
    "endTime": "2024-07-29T15:51:28.071Z",
    "state": "Running",
    "fileUris": [
    "string"
    ],
    "flowRuns": [
    {
    "runId": "1234567890123",
    "flowId": "my-flow-1"
    },
    {
    "runId": "1234567890124",
    "flowId": "my-flow-2"
    }
    ],
    "instrumentRunIds": [
    0
    ],
    "panelSessionIds": [
    "string"
    ],
    "bqTableNames": [
    "string"
    ],
    "externalId": "string",
    "url": "string",
    "initiator": {
    "userEmail": "string",
    "flowRun": {
    "runId": "1234567890124",
    "flowId": "my-flow-2"
    },
    "connectionId": "string",
    "connectorConnectionId": "string",
    "systemActorId": 0
    }
    }