Skip to main content
GET
/
v0
/
experimental
/
component
/
{id}
/
field-pairs
List field pairs for a component.
curl --request GET \
  --url https://{hostname}.gable.ai/v0/experimental/component/{id}/field-pairs \
  --header 'X-API-KEY: <api-key>'
{
  "fieldPairs": [
    {
      "fieldPairGroupId": "<string>",
      "payloadGroupId": "<string>",
      "componentId": "<string>",
      "ingress": {
        "componentId": "<string>",
        "xgressId": "<string>",
        "fieldPath": "<string>",
        "dataType": "<string>"
      },
      "egress": {
        "componentId": "<string>",
        "xgressId": "<string>",
        "fieldPath": "<string>",
        "dataType": "<string>"
      },
      "isSuppressed": true,
      "upstreamSourcesCount": 123,
      "downstreamConsumersCount": 123,
      "strandIds": [
        "<string>"
      ],
      "createdAt": "2023-11-07T05:31:56Z",
      "createdBy": "<string>"
    }
  ]
}

Authorizations

​
X-API-KEY
string
header
required

Path Parameters

​
id
string<uuid>
required

UUID of the component.

Query Parameters

​
payloadGroupId
string

Optional payload to scope the returned field pairs to.

​
origin
enum<string>

Optional filter by row provenance. Provenance of a field pair row. SCAN = produced by scanner output. BYO_ADD / BYO_CHANGE / BYO_SUPPRESS = produced by the corresponding user-initiated event. Stored, not derived — carries history.

Available options:
SCAN,
BYO_ADD,
BYO_CHANGE,
BYO_SUPPRESS
​
isSuppressed
boolean

Optional filter by suppression state.

Response

List of field pairs.

List of field pairs for a component.

​
fieldPairs
object[]
required