Skip to main content

InstrumentRunDTO

idnumberrequired
createdAtstringrequired
instrumentIdnumberrequired

ID of the instrument this run belongs to

startTimestring<date-time>

Start time of the instrument run

endTimestring<date-time>

End time of the instrument run

statestringrequired

Current state of the instrument run

Possible values: [Running, Completed]

fileUrisstring[]

Array of file URIs associated with this run

flowRunIdsnumber[]

Array of flow run IDs associated with this run

externalIdstring

External identifier for the instrument run

urlstring

URL associated with the external identifier

bqTableIdsnumber[]

Array of BqTable IDs associated with this run

panelSessionIdsstring[]

Array of panel session IDs associated with this run

unitOperationRunIdnumber

ID of the unit operation run this instrument run belongs to

initiator object

Initiator of the instrument run

userEmailstring<email>

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

InstrumentRunDTO
{
"id": 0,
"createdAt": "string",
"instrumentId": 0,
"startTime": "2024-07-29T15:51:28.071Z",
"endTime": "2024-07-29T15:51:28.071Z",
"state": "Running",
"fileUris": [
"string"
],
"flowRunIds": [
0
],
"externalId": "string",
"url": "string",
"bqTableIds": [
0
],
"panelSessionIds": [
"string"
],
"unitOperationRunId": 0,
"initiator": {
"userEmail": "user@example.com",
"flowRun": {
"runId": "1234567890124",
"flowId": "my-flow-2"
},
"connectionId": "string",
"connectorConnectionId": "string",
"systemActorId": 0
}
}