Configurar as especificações de exploração para Fontes de autoatendimento (SDK em lote)

Última atualização em 2023-08-10
  • Tópicos
  • Sources
    Exibir mais informações sobre este tópico
  • Criado para:
  • Developer
    User
    Admin
    Leader

Explorar especificações define os parâmetros necessários para explorar e inspecionar objetos contidos na sua origem. Explorar especificações também define o formato de resposta retornado quando os objetos são explorados e inspecionados.

DICA

As especificações do Explore são codificadas e você pode simplesmente copiar e colar o conteúdo abaixo na especificação da sua conexão.

"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"
        }
      }
    }
  }
}
Explorar especificações Descrição Exemplo
name Define o nome ou identificador da especificação de exploração. Resource
type Define o tipo da especificação de exploração. Resource
requestSpec Contém os parâmetros necessários para explorar objetos na conexão.
requestSpec.type Define o tipo de dados da especificação da solicitação. object
responseSpec Contém os parâmetros que definem o formato da mensagem de resposta retornada em relação a uma chamada de exploração.
responseSpec.type Define o tipo de dados da especificação da resposta. object
responseSpec.properties Contém informações relacionadas a como a mensagem de resposta está formatada.
responseSpec.properties.format Define a formatação do schema de resposta. object
responseSpec.properties.format.type Define o tipo de dados das propriedades. string
responseSpec.schema Contém informações relacionadas a como o esquema de resposta é formatado.
responseSpec.schema.type Define o tipo de dados do esquema. object
responseSpec.schema.properties Contém informações sobre as colunas, o tipo e os itens mantidos em um esquema.
responseSpec.schema.properties.columns.items.properties.name Exibe o nome do arquivo.
responseSpec.schema.properties.columns.items.properties.name.type Define o tipo de dados do nome do arquivo. string

Próximas etapas

Com suas especificações de exploração preenchidas, você pode prosseguir para criar uma especificação de conexão completa usando o Flow Service API. Consulte a Guia da API de fontes de autoatendimento (SDK em lote) para obter mais informações.

Página anterior
Next page

Nesta página