Configurar REST em uma atividade de cópia
Este artigo descreve como usar a atividade de cópia no pipeline de dados para copiar dados de e para um ponto de extremidade REST.
Especificamente, este conector REST genérico suporta:
- Copiar dados de um ponto de extremidade REST usando os métodos GET ou POST e copiar dados para um ponto de extremidade REST usando os métodos POST, PUT ou PATCH.
- Paginação nas APIs REST.
- Para REST como origem, copie a resposta JSON REST como está ou analise-a usando o mapeamento de esquema. Somente a carga útil de resposta em JSON é suportada.
Configuração suportada
Para a configuração de cada guia em uma atividade de cópia, vá para as seções a seguir, respectivamente.
- General (Geral)
- Source
- Destino
- Mapeamento
- Definições
Geral
Para Configuração da guia Geral , vá para Geral.
Source
As propriedades a seguir são suportadas para REST na guia Origem de uma atividade de cópia.
As três primeiras propriedades a seguir são necessárias:
- Tipo de armazenamento de dados: Selecione Externo.
- Conexão: Selecione uma conexão REST na lista de conexões. Se nenhuma conexão existir, crie uma nova conexão REST selecionando Novo.
- Tipo de conexão: Selecione REST.
- URL relativa: uma URL relativa ao recurso que contém os dados. Quando essa propriedade não é especificada, somente a URL especificada na definição de conexão é usada. O conector HTTP copia dados da URL combinada:
[URL specified in connection]/[relative URL specified]
.
Em Avançado, você pode especificar os seguintes campos:
Método de solicitação: O método HTTP. Os valores permitidos são GET (padrão) e POST.
Tempo limite da solicitação: o tempo limite (o valor de período de tempo) para a solicitação HTTP obter uma resposta. Esse valor é o tempo limite para obter uma resposta, não o tempo limite para ler os dados da resposta. O valor padrão é 00:01:40.
Intervalo de solicitação (ms): o tempo de intervalo entre diferentes solicitações para várias páginas em milissegundos. O valor do intervalo de solicitação deve ser um número entre [10, 60000].
Cabeçalhos adicionais: cabeçalhos de solicitação HTTP adicionais.
Regras de paginação: as regras de paginação para compor solicitações de próxima página. Consulte a seção de suporte de paginação para obter detalhes.
Colunas adicionais: adicione mais colunas de dados para armazenar o caminho relativo ou o valor estático dos arquivos de origem. Se você estiver usando um valor estático, poderá usar expressões personalizadas para gerá-lo.
Destino
As propriedades a seguir são suportadas para REST na guia Destino de uma atividade de cópia.
As três primeiras propriedades a seguir são necessárias:
- Tipo de armazenamento de dados: Selecione Externo.
- Conexão: Selecione uma conexão REST na lista de conexões. Se nenhuma conexão existir, crie uma nova conexão REST selecionando Novo.
- Tipo de conexão: Selecione REST.
- URL relativa: uma URL relativa ao recurso que contém os dados. Quando essa propriedade não é especificada, somente a URL especificada na definição de conexão é usada. O conector HTTP copia dados da URL combinada:
[URL specified in connection]/[relative URL specified]
.
Em Avançado, você pode especificar os seguintes campos:
Método de solicitação: O método HTTP. Os valores permitidos são POST (padrão), PUT e PATCH.
Tempo limite da solicitação: o tempo limite (o valor de período de tempo) para a solicitação HTTP obter uma resposta. Esse valor é o tempo limite para obter uma resposta, não o tempo limite para gravar os dados. O valor padrão é 00:01:40.
Intervalo de solicitação (ms): o tempo de intervalo entre diferentes solicitações para várias páginas em milissegundos. O valor do intervalo de solicitação deve ser um número entre [10, 60000].
Tamanho do lote de gravação: número de registros a serem gravados no destino REST por lote. O valor padrão é 10000.
Tipo de compressão Http: Tipo de compressão HTTP a utilizar durante o envio de dados com o Nível de Compressão Ideal. Os valores permitidos são Nenhum e GZip.
Cabeçalhos adicionais: cabeçalhos de solicitação HTTP adicionais.
Mapeamento
Para a configuração da guia Mapeamento , vá para Configurar seus mapeamentos na guia mapeamento. O mapeamento não é suportado quando a origem e o destino são dados hierárquicos.
Definições
Para a configuração da guia Configurações , vá para Configurar suas outras configurações na guia configurações.
Resumo da tabela
As tabelas a seguir contêm mais informações sobre a atividade de cópia em REST.
Fonte da informação
Nome | Descrição | valor | Necessário | Propriedade de script JSON |
---|---|---|---|---|
Tipo de armazenamento de dados | Seu tipo de armazenamento de dados. | • Espaço de trabalho • Externo • Conjunto de dados de amostra |
Sim | tipo |
Ligação | Sua conexão com o armazenamento de dados de origem. | <A sua ligação> | Sim | ligação |
Tipo de ligação | O seu tipo de ligação. Selecione REST. | REST | Sim | type: RestResource |
URL relativo | Uma URL relativa ao recurso que contém os dados. Quando essa propriedade não é especificada, somente a URL especificada na definição de conexão é usada. O conector HTTP copia dados da URL combinada: [URL specified in connection]/[relative URL specified] . |
<O URL relativo> | Não | relativeUrl |
Método de solicitação | O método HTTP. Os valores permitidos são GET (padrão) e POST. | • OBTER • CORREIO |
Não | requestMethod |
Tempo limite de solicitação | O tempo limite (o valor de times) para a solicitação HTTP obter uma resposta. Esse valor é o tempo limite para obter uma resposta, não o tempo limite para ler os dados da resposta. O valor padrão é 00:01:40. | timespan | Não | httpRequestTimeout |
Intervalo de solicitação (ms) | O intervalo de tempo entre diferentes solicitações para várias páginas em milissegundos. O valor do intervalo de solicitação deve ser um número entre [10, 60000]. | [10, 60000] | Não | requestInterval |
Cabeçalhos adicionais | Cabeçalhos de solicitação HTTP adicionais. | <os seus cabeçalhos adicionais> | Não | additionalHeaders |
Regras de paginação | As regras de paginação para compor solicitações de próxima página. Consulte a seção de suporte de paginação para obter detalhes. | Ir para paginação | Não | paginaçãoRegras |
Colunas adicionais | Adicione mais colunas de dados ao caminho relativo ou ao valor estático dos arquivos de origem de armazenamento. A expressão é suportada para este último. | • Nome • Valor |
Não | adicionaisColunas: • nome • valor |
Informações sobre o destino
Nome | Descrição | valor | Necessário | Propriedade de script JSON |
---|---|---|---|---|
Tipo de armazenamento de dados | Seu tipo de armazenamento de dados. | • Espaço de trabalho • Externo |
Sim | tipo |
Ligação | Sua conexão com o armazenamento de dados de origem. | <A sua ligação> | Sim | ligação |
Tipo de ligação | O seu tipo de ligação. Selecione REST. | REST | Sim | type: RestResource |
URL relativo | Uma URL relativa ao recurso que contém os dados. Quando essa propriedade não é especificada, somente a URL especificada na definição de conexão é usada. O conector HTTP copia dados da URL combinada: [URL specified in connection]/[relative URL specified] . |
<O URL relativo> | Não | relativeUrl |
Método de solicitação | O método HTTP. Os valores permitidos são POST (padrão), PUT e PATCH. | • CORREIO • OBTER • ADESIVO |
Não | requestMethod |
Tempo limite de solicitação | O tempo limite (o valor de times) para a solicitação HTTP obter uma resposta. Esse valor é o tempo limite para obter uma resposta, não o tempo limite para ler os dados da resposta. O valor padrão é 00:01:40. | timespan | Não | httpRequestTimeout |
Intervalo de solicitação (ms) | O intervalo de tempo entre diferentes solicitações para várias páginas em milissegundos. O valor do intervalo de solicitação deve ser um número entre [10, 60000]. | [10, 60000] | Não | requestInterval |
Tamanho do lote de gravação | Número de registros a serem gravados no destino REST por lote. O valor padrão é 10000. | <número de linhas> (inteiro) |
Não | writeBatchSize |
Tipo de compressão Http | Tipo de compressão HTTP a utilizar durante o envio de dados com Nível de Compressão Ideal. Os valores permitidos são Nenhum e GZip. | • Nenhum • GZip |
Não | httpCompressionType |
Cabeçalhos adicionais | Cabeçalhos de solicitação HTTP adicionais. | <os seus cabeçalhos adicionais> | Não | additionalHeaders |