Skip to main content
PATCH
/
utils
/
context-packs
/
{name}
/
soft-fk-edges
/
{edge_id}
Update a soft FK edge
curl --request PATCH \
  --url https://api.example.com/utils/context-packs/{name}/soft-fk-edges/{edge_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "description": "<string>",
  "confidence": 0.5
}
'
{
  "id": "<string>",
  "organization_id": "<string>",
  "project_id": "<string>",
  "context_pack_id": "<string>",
  "from_table": "<string>",
  "from_column": "<string>",
  "to_table": "<string>",
  "to_column": "<string>",
  "description": "<string>",
  "confidence": 123,
  "deprecated_at": "2023-11-07T05:31:56Z",
  "deleted_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

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

Headers

​
X-Project-ID
string | null

Path Parameters

​
name
string
required

Context pack name

​
edge_id
string
required

FK edge ID

Body

application/json
​
description
string | null
​
confidence
number | null
Required range: 0 <= x <= 1
​
status
enum<string> | null

Lifecycle status of a soft FK edge.

Available options:
active,
deprecated,
deleted

Response

Successful Response

​
id
string
required
​
organization_id
string
required
​
project_id
string
required
​
context_pack_id
string
required
​
from_table
string
required
​
from_column
string
required
​
to_table
string
required
​
to_column
string
required
​
description
string | null
required
​
source
enum<string>
required

Origin of a soft FK edge.

Available options:
manual,
ingestion,
inferred
​
confidence
number
required
​
status
enum<string>
required

Lifecycle status of a soft FK edge.

Available options:
active,
deprecated,
deleted
​
deprecated_at
string<date-time> | null
required
​
deleted_at
string<date-time> | null
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required