List field pairs for a component. - Gable Docs

Documentation Index

Fetch the complete documentation index at: /llms.txt

Use this file to discover all available pages before exploring further.

GET

/ v0 / experimental / component /{id} / field-pairs

Try it

List field pairs for a component.

cURL

curl --request GET \
  --url https://demo-api.gable.ai/v0/experimental/component/{id}/field-pairs \
  --header 'X-API-KEY: <api-key>'

Python

import requests

url = "https://demo-api.gable.ai/v0/experimental/component/{id}/field-pairs"

headers = {"X-API-KEY": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

JavaScript (Fetch)

const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};

fetch('https://demo-api.gable.ai/v0/experimental/component/{id}/field-pairs', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

PHP

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://demo-api.gable.ai/v0/experimental/component/{id}/field-pairs",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-KEY: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

Go

package main

import (
    "fmt"
    "net/http"
    "io"
)

func main() {

url := "https://demo-api.gable.ai/v0/experimental/component/{id}/field-pairs"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("X-API-KEY", "<api-key>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
    body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))
}

Java (Unirest)

HttpResponse<String> response = Unirest.get("https://demo-api.gable.ai/v0/experimental/component/{id}/field-pairs")
  .header("X-API-KEY", "<api-key>")
  .asString();

Ruby

require 'uri'
require 'net/http'

url = URI("https://demo-api.gable.ai/v0/experimental/component/{id}/field-pairs")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'

response = http.request(request)
puts response.read_body

Responses

200 - List of field pairs.

400 - Bad Request.

404 - Not Found.

500 - Internal Server Error.

{
  "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,
      "upstreamDependencies": [
        {
          "componentName": "<string>",
          "field": "<string>",
          "hops": 123,
          "path": [
            {
              "componentName": "<string>",
              "field": "<string>"
            }
          ]
        }
      ],
      "downstreamDependencies": [
        {
          "componentName": "<string>",
          "field": "<string>",
          "hops": 123,
          "path": [
            {
              "componentName": "<string>",
              "field": "<string>"
            }
          ]
        }
      ],
      "strandIds": [
        "<string>"
      ],
      "createdAt": "2023-11-07T05:31:56Z",
      "createdBy": "<string>"
    }
  ]
}

{
  "message": "<string>",
  "id": 123,
  "title": "<string>"
}