Skip to content

ListScriptRuns

GET
/api/v1/t/{tenant}/workflows/instances/{instanceId}/script-runs
curl --request GET \
--url https://example.com/api/v1/t/example/workflows/instances/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/script-runs
tenant
required
string

Tenant slug

instanceId
required
string format: uuid

OK

Media typeapplication/json
Array<object>
object
runId
required
string format: uuid
instanceId
required
string format: uuid
documentId
required
string format: uuid
sequence
required
integer format: int32
stepName
required
string
stepLabel
required
null | string
hook
required
Allowed values: OnDocumentArrived BeforeApproval OnApproved OnRejected OnTimer
status
required
Allowed values: Running Succeeded Failed
exit
required
null | string
scriptSha256
required
string
sdkVersion
required
string
durationMs
required
null | integer format: int32
startedAt
required
string format: date-time
endedAt
required
null | string format: date-time
details
required
One of:
null
sourceCalls
required
Array<object>
object
sourceKey
required
string
kind
required
Allowed values: Run TestRun ConnectionTest
outcome
required
Allowed values: Succeeded Cached Blocked TimedOut TooLarge InvalidResponse HttpError Failed
httpStatus
required
null | integer format: int32
durationMilliseconds
required
integer format: int32
bytes
required
integer format: int64
calledAt
required
string format: date-time
url
required
null | string
Example
[
{
"hook": "OnDocumentArrived",
"status": "Running",
"details": {
"effects": [
{
"kind": "setField"
}
],
"logs": [
{
"level": "Info"
}
]
},
"sourceCalls": [
{
"kind": "Run",
"outcome": "Succeeded"
}
]
}
]

Forbidden

Media typeapplication/problem+json
object
type
null | string
title
null | string
status
null | integer format: int32
detail
null | string
instance
null | string
Examplegenerated
{
"type": "example",
"title": "example",
"status": 1,
"detail": "example",
"instance": "example"
}

Not Found

Too Many Requests

Media typeapplication/problem+json
object
type
null | string
title
null | string
status
null | integer format: int32
detail
null | string
instance
null | string
Examplegenerated
{
"type": "example",
"title": "example",
"status": 1,
"detail": "example",
"instance": "example"
}