Skip to main content
Stage records
Operation ID: http.graph.workspaces.capture

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

org
string
required
project
string
required
ws
string
required

Body

application/json
idempotency_key
string
required

Required caller-chosen command identity. Reuse the same key and body after a lost reply; choose a fresh key for new intent, even if the content is identical. Replay returns the original receipt and never recreates edited or removed items.

Required string length: 1 - 200
capture_binding
string

Named capture binding from the exact Shape artifact. Required links are checked when the workspace is submitted.

Required string length: 1 - 128
expected_artifact
object

Require this exact Shape artifact for every staged item. Set shape to its Shape id. A mismatched workspace binding or selected published head is refused before items are written.

shape
string

Default Shape (name or id) for items in this call that do not name their own. Needed only when a type or relationship name is declared by several published Shapes.

Required string length: 1 - 200
entities
object[]
Maximum array length: 100
relationships
object[]
Maximum array length: 100

Response

2XX - application/json

Success.

data
object
required