Skip to main content
Read an interaction ownership receipt

Authorizations

Authorization
string
header
required

Opaque control credential

Path Parameters

projectId
string
required
Pattern: ^prj_[0-9a-z]{12,32}$
hostedRunId
string
required
Pattern: ^hrun_[0-9a-z]{12,32}$
claimId
string
required
Pattern: ^iclaim_[0-9a-z]{12,32}$

Query Parameters

generation
integer
required
Required range: x >= 1
runnerId
string
required
Pattern: ^[A-Za-z0-9][A-Za-z0-9._:-]{0,159}$

Response

Current retained claim

schemaVersion
enum<number>
required
Available options:
1
claimId
string
required
Pattern: ^iclaim_[0-9a-z]{12,32}$
organizationId
string
required
Pattern: ^org_[0-9a-z]{12,32}$
projectId
string
required
Pattern: ^prj_[0-9a-z]{12,32}$
hostedRunId
string
required
Pattern: ^hrun_[0-9a-z]{12,32}$
interactionId
string
required
Required string length: 1 - 96
Pattern: ^[a-z][a-z0-9]*(?:[-_][a-z0-9]+)*$
expectedRunRevision
integer
required
Required range: 0 < x <= 9007199254740991
runnerId
string
required
Pattern: ^[A-Za-z0-9][A-Za-z0-9._:-]{0,159}$
generation
integer
required
Required range: 0 < x <= 9007199254740991
version
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
state
enum<string>
required
Available options:
reserved,
started,
submitted,
expired,
uncertain,
cancelled
createdAtMs
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
updatedAtMs
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
expiresAtMs
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
simulationWorkId
string
Pattern: ^simwork_[0-9a-z]{12,32}$
startedAtMs
integer
Required range: -9007199254740991 <= x <= 9007199254740991
finishedAtMs
integer
Required range: -9007199254740991 <= x <= 9007199254740991
completionOperationId
string
Pattern: ^op_[0-9a-z]{12,32}$