GET v1/{subscriptionID}/dataSources/{dataSourceID}/schema

Gets a data source schema.

Request Information

URI Parameters

Name	Description	Type	Additional information
subscriptionID	The Circle subscription ID.	globally unique identifier	Required
dataSourceID	The data source ID.	globally unique identifier	Required

Body Parameters

None.

Response Information

Resource Description

Returns a data source schema for the specified data source ID.

DataSourceSchemaModel

Name	Description	Type	Additional information
DataSource	Gets the data source information.	DataSourceModel	None.
Tables	Gets the data source tables.	Collection of DataSourceTableModel	None.

Response Formats

application/json, text/json

Sample:

{
  "DataSource": {
    "ID": "bff5fe0f-8e81-4595-9020-cc79825df868",
    "UProduceDataSourceID": "94b3eed8-c4ab-474e-83cb-b5b90db17122",
    "FriendlyID": "sample string 3",
    "SubscriptionID": "70d60a78-8ca5-4f3d-868f-2952a0960601",
    "IsRemote": true,
    "Name": "sample string 6",
    "CreationTime": "2021-12-02T21:24:29.2416934Z",
    "Creator": {
      "ID": "a65a5d89-1cbc-42c9-becc-d94b3a8e87c9",
      "Name": "sample string 2"
    },
    "ModificationTime": "2021-12-02T21:24:29.2416934Z",
    "Modifier": {
      "ID": "a65a5d89-1cbc-42c9-becc-d94b3a8e87c9",
      "Name": "sample string 2"
    },
    "FileToken": {
      "Token": "sample string 1",
      "Type": 1,
      "FileName": "sample string 2",
      "FileType": 1
    }
  },
  "Tables": [
    {
      "Name": "sample string 1",
      "Columns": [
        {
          "Name": "sample string 1",
          "Type": 1
        },
        {
          "Name": "sample string 1",
          "Type": 1
        }
      ]
    },
    {
      "Name": "sample string 1",
      "Columns": [
        {
          "Name": "sample string 1",
          "Type": 1
        },
        {
          "Name": "sample string 1",
          "Type": 1
        }
      ]
    }
  ]
}