/ingest/settings/ingest-schema/{id}

1 min

GET

https://app.amberflo.io/ingest/settings/ingest-schema/{id}

Path Parameters

idstringrequired

Responses

200Successful request

ingestion.settings.IngestMessageSchema.out
- idstring
  Description
  Unique id for the schema.
- createTimeInSecondsinteger<int64>
  Description
  Create time in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds)
- updateTimeInSecondsinteger<int64>
  Description
  Update time in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (seconds)
- schemaingestion.schema_adapters.nodes.ExplodeNode.out
  Description
  Schema description
  - typestring
    Default
    explode
  - sourceNamestring
  - subComponentsingestion.schema_adapters.nodes.SchemaExtractorNode.out[]
    - ingestion.schema_adapters.nodes.CustomerIdNode.out
      - typestring
        Default
        customer_id
      - sourceNamestring
    - ingestion.schema_adapters.nodes.DimensionNode.out
      - typestring
        Default
        dimension
      - sourceNamestring
      - targetNamestring
    - ingestion.schema_adapters.nodes.EventTimeNode.out
      - typestring
        Default
        event_time
      - timeFormatingestion.schema_adapters.nodes.TimeFormat.out
        Max depth limit reached
      - sourceNamestring
    - ingestion.schema_adapters.nodes.ExplodeNode.out
      - Max depth limit reached
    - ingestion.schema_adapters.nodes.ForkNode.out
      - Max depth limit reached
    - ingestion.schema_adapters.nodes.MeterApiNameNode.out
      - Max depth limit reached
    - ingestion.schema_adapters.nodes.ValueNode.out
      - Max depth limit reached
    - ingestion.schema_adapters.nodes.SameElementArrayNode.out
      - Max depth limit reached
    - ingestion.schema_adapters.nodes.UniqueIdNode.out
      - Max depth limit reached
- conditioningestion.schema_adapters.conditions.MatchCondition.out
  Description
  Optional condition for applying schema. Used to evaluate if schema should be applied
  - ingestion.schema_adapters.conditions.NotCondition.out
    - typestring
      Default
      not
    - conditioningestion.schema_adapters.conditions.MatchCondition.out
      - ingestion.schema_adapters.conditions.NotCondition.out
        Circular-Reference
      - ingestion.schema_adapters.conditions.ValidIdentifierCondition.out
        typestring
        Default
        valid_identifier
        fieldNamestring
        validValuesstring[]
  - ingestion.schema_adapters.conditions.ValidIdentifierCondition.out
    - typestring
      Default
      valid_identifier
    - fieldNamestring
    - validValuesstring[]
- autoDetectableboolean
  Description
  Whether the schema can be used in schema auto-detection. Can only be true if schema has condition

curl

curl --location --globoff 'https://app.amberflo.io/ingest/settings/ingest-schema/{id}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'

javascript

var myHeaders = new Headers();
myHeaders.append("Accept", "application/json");
myHeaders.append("Content-Type", "application/json");

var requestOptions = {
   method: 'GET',
   headers: myHeaders,
   redirect: 'follow'
};

fetch("https://app.amberflo.io/ingest/settings/ingest-schema/{id}", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://app.amberflo.io/ingest/settings/ingest-schema/{id}")

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

request = Net::HTTP::Get.new(url)
request["Accept"] = "application/json"
request["Content-Type"] = "application/json"

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

python

import requests
import json

url = "https://app.amberflo.io/ingest/settings/ingest-schema/{id}"

payload = {}
headers = {
   'Accept': 'application/json',
   'Content-Type': 'application/json'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

200

// Successful request
{
  "id": "",
  "createTimeInSeconds": "",
  "updateTimeInSeconds": "",
  "schema": {
    "type": "",
    "sourceName": "",
    "subComponents": {}
  },
  "condition": {},
  "autoDetectable": false
}