WeaveKit Docs

Acquire/renew the presence lock

Acquires a 60s presence lease on the caller's current workitem so withdraw/cancel is blocked while the record is being viewed; call again to renew (heartbeat).

POST/api/objects/{name}/{id}/workflow/lock

Acquires a 60s presence lease on the caller's current workitem so withdraw/cancel is blocked while the record is being viewed; call again to renew (heartbeat).

Authorization

bearerAuth
AuthorizationBearer <token>

API key present in auth.source (or resolved by an AuthResolver).

In: header

Path Parameters

name*string

Object name from objects/<name>/schema.json.

id*string

Record id — the record_key encoding of the (possibly composite) primary key; returned as weave_id.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/objects/string/string/workflow/lock"
{  "expiresAt": "2019-08-24T14:15:22Z"}