Skip to main content
POST
/
api
/
datawarehouse
/
v1
/
connection
/
{connection_id}
/
upload
/
{upload_id}
/
schemas
IngestSchemas
curl --request POST \
  --url https://developer.synq.io/api/datawarehouse/v1/connection/{connection_id}/upload/{upload_id}/schemas \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "stateAt": "2023-11-07T05:31:56Z",
  "schemas": [
    {
      "fqn": {
        "objectName": "<string>",
        "instanceName": "<string>",
        "databaseName": "<string>",
        "schemaName": "<string>"
      },
      "columns": [
        {
          "name": "<string>",
          "nativeType": "<string>",
          "ordinalPosition": 123,
          "description": "<string>",
          "tags": [
            {
              "tagName": "<string>",
              "tagValue": "<string>"
            }
          ],
          "isStruct": true,
          "isRepeated": true,
          "fields": [
            {
              "name": "<string>",
              "nativeType": "<string>",
              "description": "<string>",
              "ordinalPosition": 123,
              "isStruct": true,
              "isRepeated": true,
              "fields": "<array>"
            }
          ]
        }
      ]
    }
  ]
}
'
{}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
connection_id
string
required
​
upload_id
string<uuid>
required

Body

application/json
​
stateAt
string<date-time>
required

Time at which state was collected timestamp.gt = 2022-01-01T00:00:00Z timestamp.gt_lt = 2022-01-01T00:00:00Z timestamp.gt_lt_exclusive = 2022-01-01T00:00:00Z timestamp.gt_lte = 2022-01-01T00:00:00Z timestamp.gt_lte_exclusive = 2022-01-01T00:00:00Z timestamp.lt_now = true

​
schemas
Schema · object[]

Response

200 - application/json

Success

The response is of type IngestSchemasResponse · object.