Skip to main content
POST
Python

Authorizations

Authorization
string
header
required

nia_sk_...

Headers

Idempotency-Key
string
required

Required. Kept 24 hours with the hash of the body: a retry with the same key returns the first answer, and the same key with a different body returns 409 conflict.

Required string length: 1 - 256

Body

application/json

A declared claim, held by holder. level defaults to the space's least restrictive level; a declaration is refused (409 lease_held) while another holder's claim is at least as restrictive, and the same holder renews its own. lease_s is capped by the space's longest declared lease. A task lock names an object and its task, and is refused (409 task_locked) while another holder has that task.

holder
string
required
Required string length: 1 - 256
kind
enum<string>
required
Available options:
owner,
case,
task_lock
lease_s
integer
required
Required range: 1 <= x <= 86400
intents
string[]
Maximum array length: 20
Pattern: ^[a-z][a-z0-9_]{0,39}$
level
string | null
Pattern: ^[a-z][a-z0-9_]{0,39}$
object
ObjectRef · object | null

A business object in a system of record, e.g. invoice / erp / 0823.

observed_at
string<date-time> | null

When the source saw it; an observation older than the source's last is ignored.

source
string | null

An observation of this ownership source, read and sent by the company's worker: never refused, replacing what the source said before, and capped by the source's validity.

Pattern: ^[a-z][a-z0-9_]{0,39}$
subject
Handle · object | null

An identifier of a subject in some channel or system: a phone, an e-mail, a CRM id.

task
string | null
Pattern: ^[a-z][a-z0-9_]{0,39}$

Response

The claim, with the epoch a release must name.

claim_id
string
required
Required string length: 1 - 512
epoch
integer
required
holder
string
required
kind
enum<string>
required
Available options:
owner,
case,
task_lock
level
string
required
Pattern: ^[a-z][a-z0-9_]{0,39}$
valid_until
string<date-time>
required