Configureren van de specificaties voor Self-Serve Sources (Batch SDK)

Laatst bijgewerkt: 16 juli 2024
  • Onderwerpen:

Gemaakt voor:

  • Ontwikkelaar

De specificaties van het onderzoek bepalen de parameters die voor het onderzoeken van en het inspecteren van voorwerpen in uw bron worden vereist. Met de specificaties verkennen definieert u ook de indeling voor reacties die wordt geretourneerd wanneer objecten worden doorzocht en geïnspecteerd.

TIP
Verken de specificaties zijn hard-gecodeerd en u kunt eenvoudig de lading kopiëren en kleven hieronder aan uw verbindingsspecificatie.
"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"
        }
      }
    }
  }
}
Specificaties verkennenBeschrijvingVoorbeeld
nameDefinieert de naam of id van de exploratiespecificatie.Resource
typeDefinieert het type van de verkenningsspecificatie.Resource
requestSpecBevat de parameters die vereist zijn om objecten in de verbinding te verkennen.
requestSpec.typeDefinieert het gegevenstype van de aanvraagspecificatie.object
responseSpecBevat de parameters die het formaat van het antwoordbericht bepalen tegen een verkennen vraag is teruggekeerd.
responseSpec.typeDefinieert het gegevenstype van de reactiespecificatie.object
responseSpec.propertiesBevat informatie met betrekking tot hoe het reactiebericht wordt geformatteerd.
responseSpec.properties.formatBepaalt het formatteren van het reactieschema.object
responseSpec.properties.format.typeDefinieert het gegevenstype van eigenschappen.string
responseSpec.schemaBevat informatie met betrekking tot hoe het reactieschema geformatteerd is.
responseSpec.schema.typeDefinieert het gegevenstype van het schema.object
responseSpec.schema.propertiesBevat informatie over de kolommen, het type, en de punten die binnen een schema worden gehouden.
responseSpec.schema.properties.columns.items.properties.nameHiermee geeft u de naam van het bestand weer.
responseSpec.schema.properties.columns.items.properties.name.typeHiermee definieert u het gegevenstype van de bestandsnaam.string

Volgende stappen

Als uw verkenningsspecificaties zijn gevuld, kunt u doorgaan met het maken van een volledige verbindingsspecificatie met de API Flow Service . Zie de Zelfbediening gids van de Bron (van de Partij SDK) APIvoor meer informatie.

Vorige paginaBronspecificatie configureren
Volgende paginaAPI-overzicht Zelfbediening (Batch SDK)

Experience Platform