/ingest/settings/ingest-schema

1 min

POST

https://app.amberflo.io/ingest/settings/ingest-schema

Body Parameters

bodyingestion.settings.IngestMessageSchema.in
- idstring
  Description
  Unique id for the schema.
- schemaingestion.schema_adapters.nodes.ExplodeNode.in
  Description
  Schema description
  - typestring
    Default
    explode
  - sourceNamestring
  - subComponentsingestion.schema_adapters.nodes.SchemaExtractorNode.in[]
    - ingestion.schema_adapters.nodes.CustomerIdNode.in
      - typestring
        Default
        customer_id
      - sourceNamestring
    - ingestion.schema_adapters.nodes.DimensionNode.in
      - typestring
        Default
        dimension
      - sourceNamestring
      - targetNamestring
    - ingestion.schema_adapters.nodes.EventTimeNode.in
      - typestring
        Default
        event_time
      - timeFormatingestion.schema_adapters.nodes.TimeFormat.in
        Max depth limit reached
      - sourceNamestring
    - ingestion.schema_adapters.nodes.ExplodeNode.in
      - Max depth limit reached
    - ingestion.schema_adapters.nodes.ForkNode.in
      - Max depth limit reached
    - ingestion.schema_adapters.nodes.MeterApiNameNode.in
      - Max depth limit reached
    - ingestion.schema_adapters.nodes.ValueNode.in
      - Max depth limit reached
    - ingestion.schema_adapters.nodes.SameElementArrayNode.in
      - Max depth limit reached
    - ingestion.schema_adapters.nodes.UniqueIdNode.in
      - Max depth limit reached
- conditioningestion.schema_adapters.conditions.MatchCondition.in
  Description
  Optional condition for applying schema. Used to evaluate if schema should be applied
  - ingestion.schema_adapters.conditions.NotCondition.in
    - typestring
      Default
      not
    - conditioningestion.schema_adapters.conditions.MatchCondition.in
      - ingestion.schema_adapters.conditions.NotCondition.in
        Circular-Reference
      - ingestion.schema_adapters.conditions.ValidIdentifierCondition.in
        typestring
        Default
        valid_identifier
        fieldNamestring
        validValuesstring[]
  - ingestion.schema_adapters.conditions.ValidIdentifierCondition.in
    - 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

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 --request POST \
     --url https://app.amberflo.io/ingest/settings/ingest-schema \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
     "schema": {
     "type": "explode",
     "subComponents": {
     "type": "customer_id"
     }
     },
     "condition": {
     "type": "not",
     "condition": {}
     }
     }'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");

var raw = JSON.stringify({
   "schema": {
      "type": "explode",
      "subComponents": {
         "type": "customer_id"
      }
   },
   "condition": {
      "type": "not",
      "condition": {}
   }
});

var requestOptions = {
   method: 'POST',
   headers: myHeaders,
   body: raw,
   redirect: 'follow'
};

fetch("https://app.amberflo.io/ingest/settings/ingest-schema", 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")

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

request = Net::HTTP::Post.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
request.body = JSON.dump({
   "schema": {
      "type": "explode",
      "subComponents": {
         "type": "customer_id"
      }
   },
   "condition": {
      "type": "not",
      "condition": {}
   }
})

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

python

import requests
import json

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

payload = json.dumps({
   "schema": {
      "type": "explode",
      "subComponents": {
         "type": "customer_id"
      }
   },
   "condition": {
      "type": "not",
      "condition": {}
   }
})
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

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

print(response.text)

200

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