DokumentationExperience PlatformAnvändarhandbok om Source Connectors

Konfigurera specifikationer för självbetjäningskällor (Batch SDK)

Last update: Tue Jul 16 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
  • Ämnen:

Skapat för:

  • Utvecklare

Utforska specifikationerna och definiera de parametrar som krävs för att utforska och inspektera objekt som finns i källan. Utforska specifikationerna definierar också det svarsformat som returneras när objekt utforskas och inspekteras.

TIP
Utforska specifikationerna är hårdkodade och du kan helt enkelt kopiera och klistra in nyttolasten nedan i din anslutningsspecifikation.
"exploreSpec": {
  "name": "Resource",
  "type": "Resource",
  "requestSpec": {
    "$schema": "http://json-schema.org/draft-07/schema#",
    "type": "object"
  },
  "responseSpec": {
    "$schema": "http: //json-schema.org/draft-07/schema#",
    "type": "object",
    "properties": {
      "format": {
        "type": "string"
      },
      "schema": {
        "type": "object",
        "properties": {
          "columns": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "name": {
                  "type": "string"
                },
                "type": {
                  "type": "string"
                }
              }
            }
          }
        }
      },
      "data": {
        "type": "array",
        "items": {
          "type": "object"
        }
      }
    }
  }
}
Utforska specifikationer
Beskrivning
Exempel
name
Definierar namnet eller identifieraren för specifikationen.
Resource
type
Definierar typen av experimentspecifikation.
Resource
requestSpec
Innehåller de parametrar som krävs för att utforska objekt i anslutningen.
requestSpec.type
Definierar datatypen för förfrågningsspecifikationen.
object
responseSpec
Innehåller parametrar som definierar formatet för svarsmeddelandet som returneras mot ett utforska anrop.
responseSpec.type
Definierar datatypen för svarsspecifikationen.
object
responseSpec.properties
Innehåller information om hur svarsmeddelandet formateras.
responseSpec.properties.format
Definierar svarsschemats formatering.
object
responseSpec.properties.format.type
Definierar egenskapernas datatyp.
string
responseSpec.schema
Innehåller information om hur svarsschemat formateras.
responseSpec.schema.type
Definierar schemats datatyp.
object
responseSpec.schema.properties
Innehåller information om kolumner, typ och objekt som finns i ett schema.
responseSpec.schema.properties.columns.items.properties.name
Visar filens namn.
responseSpec.schema.properties.columns.items.properties.name.type
Definierar datatypen för filnamnet.
string

Nästa steg

När du har fyllt i utforska specifikationerna kan du fortsätta att skapa en fullständig anslutningsspecifikation med API:t Flow Service. Mer information finns i API-handboken för Självbetjäningskällor (Batch SDK).

recommendation-more-help
337b99bb-92fb-42ae-b6b7-c7042161d089