Pin one of the caller's captured scopes

POST

/api/v1/kg/studio/scopes/{name}/pin

curl --request POST \
  --url http://localhost:11044/api/v1/kg/studio/scopes/example/pin \
  --header 'X-Embabel-Api-Key: <X-Embabel-Api-Key>'

• Your world, at the port the installer gives it

Authorizations

• apiKeyAuth
• basicAuth

Parameters

Path Parameters

name

required

string

The captured scope’s name, as listed by GET /kg/studio/scopes; pinning removes its expiry, and a name with no live scope behind it is a 404

Responses

200

The scope as stored, now with no expiry

Media typeapplication/json

A captured query scope: a frozen result set referenced in a later query as (x:$name).

object

capturedAt

required

When the membership froze, ISO-8601.

string

expiresAt

When the scope lapses, ISO-8601 — null means PINNED (kept until deleted).

string

members

required

How many members the capture froze. Membership is frozen; values stay live.

integer format: int64

name

required

The name the scope was captured under, unique per user; a later query binds it as (x:$name).

string

outputLabel

required

The node label later references bind with.

string

statement

required

The statement that produced the capture — the scope’s provenance.

string

Example ^generated

{
  "capturedAt": "example",
  "expiresAt": "example",
  "members": 1,
  "name": "example",
  "outputLabel": "example",
  "statement": "example"
}

401

Not authenticated

Media typeapplication/json

A refusal carrying only a human-readable reason.

object

error

required

What went wrong, in the terms the caller can act on.

string

Example ^generated

{
  "error": "example"
}

404

No such scope

Media typeapplication/json

A refusal carrying only a human-readable reason.

object

error

required

What went wrong, in the terms the caller can act on.

string

Example ^generated

{
  "error": "example"
}