DocumentationExperience PlatformGuide des connecteurs sources

Configuration des spécifications d’exploration pour les sources en libre-service (SDK par lots)

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

Créé pour :

  • Développeur

Explorer les spécifications définit les paramètres requis pour explorer et inspecter les objets contenus dans votre source. Explorer les spécifications définit également le format de réponse renvoyé lorsque des objets sont explorés et inspectés.

TIP
Les spécifications Explorer sont codées en dur et vous pouvez simplement copier et coller la payload ci-dessous dans votre spécification de connexion.
"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"
        }
      }
    }
  }
}
Exploration des spécifications
Description
Exemple
name
Définit le nom ou l’identifiant de la spécification d’exploration.
Resource
type
Définit le type de la spécification d’exploration.
Resource
requestSpec
Contient les paramètres requis pour explorer les objets dans la connexion.
requestSpec.type
Définit le type de données de la spécification de requête.
object
responseSpec
Contient les paramètres qui définissent le format du message de réponse renvoyé par rapport à un appel d’exploration.
responseSpec.type
Définit le type de données de la spécification de réponse.
object
responseSpec.properties
Contient des informations relatives au format du message de réponse.
responseSpec.properties.format
Définit la mise en forme du schéma de réponse.
object
responseSpec.properties.format.type
Définit le type de données des propriétés.
string
responseSpec.schema
Contient des informations relatives au formatage du schéma de réponse.
responseSpec.schema.type
Définit le type de données du schéma.
object
responseSpec.schema.properties
Contient des informations sur les colonnes, le type et les éléments contenus dans un schéma.
responseSpec.schema.properties.columns.items.properties.name
Affiche le nom du fichier.
responseSpec.schema.properties.columns.items.properties.name.type
Définit le type de données du nom de fichier.
string

Étapes suivantes

Une fois vos spécifications d’exploration renseignées, vous pouvez créer une spécification de connexion complète à l’aide de l’API Flow Service. Pour plus d’informations, consultez le guide de l’API Sources en libre-service (SDK par lot) .

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