Jedox OData Hub
Conecte-se ao Hub OData do Jedox. Busque dados do servidor Olap, transmita dados do servidor integrador ou execute cargas e trabalhos.
Esse conector está disponível nos seguintes produtos e regiões:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Aplicativos Lógicos | Standard | Todas as regiões dos Aplicativos Lógicos , exceto as seguintes: – Regiões do Azure Governamental - Regiões do Azure China - Departamento de Defesa dos EUA (DoD) |
| Power Apps | Premium | Todas as regiões do Power Apps , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Power Automate | Premium | Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Contato | |
|---|---|
| Nome | Suporte do Jedox |
| URL | https://support.jedox.com/ |
| support@jedox.com |
| Metadados do conector | |
|---|---|
| Publicador | Jedox |
| Site | https://jedox.com |
| Política de Privacidade | https://www.jedox.com/en/trust/data-protection-policy/ |
| Categorias | Business Intelligence; Dados |
O Hub OData Jedox fornece acesso aos dados Jedox, permitindo que você integre bancos de dados Jedox e trabalhos do Integrador em seus aplicativos e automação.
Pré-requisitos
Para usar esse conector, você precisará de uma Instância de Nuvem Jedox com um Hub OData ativo. Se você não tiver uma Instância Jedox ou o Hub OData, poderá criar uma Avaliação Jedox gratuita de 30 dias.
Como obter credenciais
Para usar esse conector, você precisa usar o nome de usuário e a senha como para sua Instância Jedox. Se a instância do Jedox usar o SSO (Logon Único) ou se você estiver usando uma instância de nuvem de avaliação, será necessário criar uma nova conta na Administração.
Introdução ao conector
Ao usar o conector pela primeira vez, você será criado para criar uma nova conexão. Você pode escolher livremente o nome da conexão. Para "URL do Hub OData", insira a URL completa no Hub OData Jedox:
https://odata.{InstanceId}.cloud.jedox.com
Para avaliações de nuvem Jedox, a URL deve ter esta aparência:
https://trialXXX.odata2.cloud.jedox.com
Insira seu nome de usuário e senha e clique em Criar.
Um guia de introdução completo pode ser encontrado na Base de Dados de Conhecimento Jedox
Problemas e limitações conhecidos
- O conector do Hub OData Jedox requer uma versão Jedox de 21.3 ou superior.
- Atualmente, o conector do Hub OData do Jedox não dá suporte ao SSO (Single Sign-On).
Criando uma conexão
O conector dá suporte aos seguintes tipos de autenticação:
| Default | Parâmetros para criar conexão. | Todas as regiões | Não compartilhável |
Padrão
Aplicável: todas as regiões
Parâmetros para criar conexão.
Essa não é uma conexão compartilhável. Se o aplicativo de energia for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.
| Nome | Tipo | Description | Obrigatório |
|---|---|---|---|
| OData Hub URL | cadeia | Forneça a URL da instância do Hub OData. | Verdade |
| Nome de usuário | secureString | Nome de usuário para sua instância de nuvem | Verdade |
| Senha | secureString | Senha para sua instância de nuvem | Verdade |
Limitações
| Nome | Chamadas | Período de renovação |
|---|---|---|
| Chamadas à API por conexão | 100 | 60 segundos |
Ações
| Executar a carga com variáveis |
Execute a carga com o nome fornecido no projeto do integrador fornecido. A execução será adicionada à fila. |
| Executar carga |
Execute a carga com o nome fornecido no projeto do integrador fornecido. A execução será adicionada à fila. |
| Executar trabalho |
Execute o trabalho com o nome fornecido no projeto do integrador fornecido. A execução será adicionada à fila. |
| Executar trabalho com variáveis |
Execute o trabalho com o nome fornecido no projeto do integrador fornecido. A execução será adicionada à fila. |
| Obter banco de dados por id |
Obtenha o banco de dados com a ID fornecida. |
| Obter bancos de dados |
Obtenha uma lista de bancos de dados encontrados no servidor. Os bancos de dados do sistema e da configuração são excluídos da lista, mas podem ser solicitados fornecendo a ID. |
| Obter carga por nome |
Obtenha a transformação com o nome fornecido no projeto do integrador fornecido. |
| Obter cargas |
Obtenha uma lista de cargas no projeto do integrador especificado. |
| Obter cubo por ID |
Obtenha o cubo com a ID fornecida no banco de dados especificado. Para evitar problemas com as codificações de URL, os cubos de atributo serão renomeados, por exemplo, #_Years para ATT_Years. |
| Obter cubos |
Obtenha uma lista de cubos no banco de dados especificado. Para evitar problemas com as codificações de URL, os cubos de atributo serão renomeados, por exemplo, #_Years para ATT_Years. |
| Obter células de cubo |
Obtenha as células de um cubo. Isso retorna os valores e os nomes de elementos das células. Se a célula tiver um valor de cadeia de caracteres, o valor será armazenado no campo stringValue. Os nomes de elementos são armazenados em propriedades dinâmicas. |
| Obter células de exibição armazenadas |
Obtenha todas as células de um modo de exibição. Isso retorna os valores e os nomes de elementos das células. Se a célula tiver um valor de cadeia de caracteres, o valor será armazenado no campo stringValue. Os nomes de elementos são armazenados em propriedades dinâmicas. |
| Obter dimensão por ID |
Obtenha a dimensão com a ID fornecida no banco de dados especificado. |
| Obter dimensões |
Obtenha uma lista de dimensões no banco de dados especificado. |
| Obter elemento por ID |
Retorna o elemento com a ID fornecida na dimensão fornecida. |
| Obter elementos |
Obtenha uma lista de elementos na dimensão fornecida. |
| Obter exibição armazenada por ID |
Obtenha a exibição com a ID fornecida no banco de dados especificado. |
| Obter exibições armazenadas |
Obtenha uma lista de exibições armazenadas no banco de dados especificado. |
| Obter extratos |
Obtenha uma lista de extrações no projeto do integrador especificado. |
| Obter extração por nome |
Obtenha o extrato com o nome fornecido no projeto do integrador fornecido. |
| Obter grupos de projetos do Integrador |
Obtenha uma lista de grupos de projetos do integrador encontrados no servidor. |
| Obter linhas de extração |
Transmita as linhas do extrato com o nome fornecido no projeto do integrador fornecido. |
| Obter linhas de transformação |
Transmita as linhas da transformação com o nome fornecido no projeto do integrador fornecido. |
| Obter o grupo de projetos do Integrador por identificador |
Obtenha o grupo de projetos com a ID fornecida. |
| Obter projeto do Integrador pelo nome |
Obtenha o projeto do integrador com o nome fornecido. |
| Obter projetos do Integrador |
Obtenha uma lista de projetos integradores encontrados no servidor. |
| Obter trabalho por nome |
Obtenha os trabalhos com o nome fornecido no projeto do integrador fornecido. |
| Obter trabalhos |
Obtenha uma lista de trabalhos no projeto do integrador especificado. |
| Obter transformação por nome |
Obtenha a transformação com o nome fornecido no projeto do integrador fornecido. |
| Obter transformações |
Obtenha uma lista de transformações no projeto do integrador especificado. |
Executar a carga com variáveis
Execute a carga com o nome fornecido no projeto do integrador fornecido. A execução será adicionada à fila.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Identificador de grupo
|
GroupIdentifier | True | string |
O identificador do grupo de projetos do Integrador |
|
Nome do Projeto
|
ProjectName | True | string |
O nome do projeto do Integrador |
|
Nome da carga
|
LoadName | True | string |
O nome da carga |
|
Variables
|
Variables | True | string |
Nomes e valores de variáveis semperados por um sinal de igual. Se uma variável for omitida, o valor padrão será usado. Várias variáveis devem ser propagadas por vírgulas. Exemplo: Variables='SourceDB=Demo,TargetDB=Biker' |
Retornos
- Corpo
- IntegratorRunResult
Executar carga
Execute a carga com o nome fornecido no projeto do integrador fornecido. A execução será adicionada à fila.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Identificador de grupo
|
GroupIdentifier | True | string |
O identificador do grupo de projetos do Integrador |
|
Nome do Projeto
|
ProjectName | True | string |
O nome do projeto do Integrador |
|
Nome da carga
|
LoadName | True | string |
O nome da carga |
Retornos
- Corpo
- IntegratorRunResult
Executar trabalho
Execute o trabalho com o nome fornecido no projeto do integrador fornecido. A execução será adicionada à fila.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Identificador de grupo
|
GroupIdentifier | True | string |
O identificador do grupo de projetos do Integrador |
|
Nome do Projeto
|
ProjectName | True | string |
O nome do projeto do Integrador |
|
Nome da Tarefa
|
JobName | True | string |
O nome do trabalho |
Retornos
- Corpo
- IntegratorRunResult
Executar trabalho com variáveis
Execute o trabalho com o nome fornecido no projeto do integrador fornecido. A execução será adicionada à fila.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Identificador de grupo
|
GroupIdentifier | True | string |
O identificador do grupo de projetos do Integrador |
|
Nome do Projeto
|
ProjectName | True | string |
O nome do projeto do Integrador |
|
Nome da Tarefa
|
JobName | True | string |
O nome do trabalho |
|
Variables
|
Variables | True | string |
Nomes e valores de variáveis semperados por um sinal de igual. Se uma variável for omitida, o valor padrão será usado. Várias variáveis devem ser propagadas por vírgulas. Exemplo: Variables='SourceDB=Demo,TargetDB=Biker' |
Retornos
- Corpo
- IntegratorRunResult
Obter banco de dados por id
Obtenha o banco de dados com a ID fornecida.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do banco de dados
|
DatabaseId | True | integer |
ID numérica do banco de dados |
Retornos
- Corpo
- Database
Obter bancos de dados
Obtenha uma lista de bancos de dados encontrados no servidor. Os bancos de dados do sistema e da configuração são excluídos da lista, mas podem ser solicitados fornecendo a ID.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Contagem superior
|
$top | integer |
Limita o número de itens retornados pelo número especificado. O serviço retorna o número de itens disponíveis até, mas não maior que o valor especificado n. |
|
|
Ignorar Contagem
|
$skip | integer |
Exclui os primeiros n itens da coleção consultada do resultado. O serviço retorna itens começando na posição n+1. |
|
|
Filter
|
$filter | string |
A opção de consulta do sistema $filter restringe o conjunto de itens retornados. Para obter uma lista de operações e funções disponíveis, consulte a Documentação do OData. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
value
|
value | DatabaseArray |
Obter carga por nome
Obtenha a transformação com o nome fornecido no projeto do integrador fornecido.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Identificador de grupo
|
GroupIdentifier | True | string |
O identificador do grupo de projetos do Integrador |
|
Nome do Projeto
|
ProjectName | True | string |
O nome do projeto do Integrador |
|
Nome da carga
|
LoadName | True | string |
O nome da carga |
Retornos
- Corpo
- IntegratorComponent
Obter cargas
Obtenha uma lista de cargas no projeto do integrador especificado.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Identificador de grupo
|
GroupIdentifier | True | string |
O identificador do grupo de projetos do Integrador |
|
Nome do Projeto
|
ProjectName | True | string |
O nome do projeto do Integrador |
|
Contagem superior
|
$top | integer |
Limita o número de itens retornados pelo número especificado. O serviço retorna o número de itens disponíveis até, mas não maior que o valor especificado n. |
|
|
Ignorar Contagem
|
$skip | integer |
Exclui os primeiros n itens da coleção consultada do resultado. O serviço retorna itens começando na posição n+1. |
|
|
Filter
|
$filter | string |
A opção de consulta do sistema $filter restringe o conjunto de itens retornados. Para obter uma lista de operações e funções disponíveis, consulte a Documentação do OData. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
value
|
value | IntegratorComponentArray |
Obter cubo por ID
Obtenha o cubo com a ID fornecida no banco de dados especificado. Para evitar problemas com as codificações de URL, os cubos de atributo serão renomeados, por exemplo, #_Years para ATT_Years.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do banco de dados
|
DatabaseId | True | integer |
ID numérica do banco de dados |
|
ID do cubo
|
CubeId | True | integer |
ID numérica do cubo |
Retornos
- Corpo
- Cube
Obter cubos
Obtenha uma lista de cubos no banco de dados especificado. Para evitar problemas com as codificações de URL, os cubos de atributo serão renomeados, por exemplo, #_Years para ATT_Years.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do banco de dados
|
DatabaseId | True | integer |
ID numérica do banco de dados |
|
Contagem superior
|
$top | integer |
Limita o número de itens retornados pelo número especificado. O serviço retorna o número de itens disponíveis até, mas não maior que o valor especificado n. |
|
|
Ignorar Contagem
|
$skip | integer |
Exclui os primeiros n itens da coleção consultada do resultado. O serviço retorna itens começando na posição n+1. |
|
|
Filter
|
$filter | string |
A opção de consulta do sistema $filter restringe o conjunto de itens retornados. Para obter uma lista de operações e funções disponíveis, consulte a Documentação do OData. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
value
|
value | CubeArray |
Obter células de cubo
Obtenha as células de um cubo. Isso retorna os valores e os nomes de elementos das células. Se a célula tiver um valor de cadeia de caracteres, o valor será armazenado no campo stringValue. Os nomes de elementos são armazenados em propriedades dinâmicas.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do banco de dados
|
DatabaseId | True | integer |
ID numérica do banco de dados |
|
ID do cubo
|
CubeId | True | integer |
ID numérica do cubo |
|
Contagem superior
|
$top | integer |
Limita o número de itens retornados pelo número especificado. O serviço retorna o número de itens disponíveis até, mas não maior que o valor especificado n. |
|
|
Ignorar Contagem
|
$skip | integer |
Exclui os primeiros n itens da coleção consultada do resultado. O serviço retorna itens começando na posição n+1. |
|
|
Filter
|
$filter | string |
A opção de consulta do sistema $filter restringe o conjunto de itens retornados. Para obter uma lista de operações e funções disponíveis, consulte a Documentação do OData.
|
|
|
Somente elementos base
|
baseonly | boolean |
Se definido como true, o resultado conterá apenas elementos base. Se definido como false, ele também conterá elementos consolidados. |
|
|
Usar regras
|
userules | boolean |
Se definido como true, as regras serão aplicadas às células resultantes. |
|
|
Supress Zeros
|
zerosupression | boolean |
Se definido como true, células numéricas com um valor de 0 e células de cadeia de caracteres vazias serão removidas do resultado. |
|
|
Desabilitar paginação
|
disablepaging | boolean |
Se definido como true, o serviço retornará todo o resultado em vez de uma única página. Com essa opção definida como true, a resposta pode levar vários minutos dependendo do tamanho do cubo. |
Retornos
Obter células de exibição armazenadas
Obtenha todas as células de um modo de exibição. Isso retorna os valores e os nomes de elementos das células. Se a célula tiver um valor de cadeia de caracteres, o valor será armazenado no campo stringValue. Os nomes de elementos são armazenados em propriedades dinâmicas.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do banco de dados
|
DatabaseId | True | integer |
ID numérica do banco de dados |
|
ID de exibição
|
ViewId | True | uuid |
UUID da exibição |
|
Contagem superior
|
$top | integer |
Limita o número de itens retornados pelo número especificado. O serviço retorna o número de itens disponíveis até, mas não maior que o valor especificado n. |
|
|
Ignorar Contagem
|
$skip | integer |
Exclui os primeiros n itens da coleção consultada do resultado. O serviço retorna itens começando na posição n+1. |
|
|
Filter
|
$filter | string |
A opção de consulta do sistema $filter restringe o conjunto de itens retornados. Para obter uma lista de operações e funções disponíveis, consulte a Documentação do OData.
|
|
|
Somente elementos base
|
baseonly | boolean |
Se definido como true, o resultado conterá apenas elementos base. Se definido como false, ele também conterá elementos consolidados. |
|
|
Usar regras
|
userules | boolean |
Se definido como true, as regras serão aplicadas às células resultantes. |
|
|
Supress Zeros
|
zerosupression | boolean |
Se definido como true, células numéricas com um valor de 0 e células de cadeia de caracteres vazias serão removidas do resultado. |
|
|
Desabilitar paginação
|
disablepaging | boolean |
Se definido como true, o serviço retornará todo o resultado em vez de uma única página. Com essa opção definida como true, a resposta pode levar vários minutos, dependendo do tamanho da exibição. |
Retornos
Obter dimensão por ID
Obtenha a dimensão com a ID fornecida no banco de dados especificado.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do banco de dados
|
DatabaseId | True | integer |
ID numérica do banco de dados |
|
ID da dimensão
|
DimensionId | True | integer |
ID numérica da dimensão |
Retornos
- Corpo
- Dimension
Obter dimensões
Obtenha uma lista de dimensões no banco de dados especificado.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do banco de dados
|
DatabaseId | True | integer |
ID numérica do banco de dados |
|
Contagem superior
|
$top | integer |
Limita o número de itens retornados pelo número especificado. O serviço retorna o número de itens disponíveis até, mas não maior que o valor especificado n. |
|
|
Ignorar Contagem
|
$skip | integer |
Exclui os primeiros n itens da coleção consultada do resultado. O serviço retorna itens começando na posição n+1. |
|
|
Filter
|
$filter | string |
A opção de consulta do sistema $filter restringe o conjunto de itens retornados. Para obter uma lista de operações e funções disponíveis, consulte a Documentação do OData. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
value
|
value | DimensionArray |
Obter elemento por ID
Retorna o elemento com a ID fornecida na dimensão fornecida.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do banco de dados
|
DatabaseId | True | integer |
ID numérica do banco de dados |
|
ID da dimensão
|
DimensionId | True | integer |
ID numérica da dimensão |
|
ID do elemento
|
ElementId | True | integer |
ID numérica do elemento |
Retornos
- Corpo
- Element
Obter elementos
Obtenha uma lista de elementos na dimensão fornecida.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do banco de dados
|
DatabaseId | True | integer |
ID numérica do banco de dados |
|
ID da dimensão
|
DimensionId | True | integer |
ID numérica da dimensão |
|
Contagem superior
|
$top | integer |
Limita o número de itens retornados pelo número especificado. O serviço retorna o número de itens disponíveis até, mas não maior que o valor especificado n. |
|
|
Ignorar Contagem
|
$skip | integer |
Exclui os primeiros n itens da coleção consultada do resultado. O serviço retorna itens começando na posição n+1. |
|
|
Filter
|
$filter | string |
A opção de consulta do sistema $filter restringe o conjunto de itens retornados. Para obter uma lista de operações e funções disponíveis, consulte a Documentação do OData. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
value
|
value | ElementArray |
Obter exibição armazenada por ID
Obtenha a exibição com a ID fornecida no banco de dados especificado.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do banco de dados
|
DatabaseId | True | integer |
ID numérica do banco de dados |
|
ID de exibição
|
ViewId | True | uuid |
UUID da exibição |
Retornos
- Corpo
- View
Obter exibições armazenadas
Obtenha uma lista de exibições armazenadas no banco de dados especificado.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do banco de dados
|
DatabaseId | True | integer |
ID numérica do banco de dados |
|
Contagem superior
|
$top | integer |
Limita o número de itens retornados pelo número especificado. O serviço retorna o número de itens disponíveis até, mas não maior que o valor especificado n. |
|
|
Ignorar Contagem
|
$skip | integer |
Exclui os primeiros n itens da coleção consultada do resultado. O serviço retorna itens começando na posição n+1. |
|
|
Filter
|
$filter | string |
A opção de consulta do sistema $filter restringe o conjunto de itens retornados. Para obter uma lista de operações e funções disponíveis, consulte a Documentação do OData. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
value
|
value | ViewArray |
Obter extratos
Obtenha uma lista de extrações no projeto do integrador especificado.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Identificador de grupo
|
GroupIdentifier | True | string |
O identificador do grupo de projetos do Integrador |
|
Nome do Projeto
|
ProjectName | True | string |
O nome do projeto do Integrador |
|
Contagem superior
|
$top | integer |
Limita o número de itens retornados pelo número especificado. O serviço retorna o número de itens disponíveis até, mas não maior que o valor especificado n. |
|
|
Ignorar Contagem
|
$skip | integer |
Exclui os primeiros n itens da coleção consultada do resultado. O serviço retorna itens começando na posição n+1. |
|
|
Filter
|
$filter | string |
A opção de consulta do sistema $filter restringe o conjunto de itens retornados. Para obter uma lista de operações e funções disponíveis, consulte a Documentação do OData. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
value
|
value | IntegratorComponentArray |
Obter extração por nome
Obtenha o extrato com o nome fornecido no projeto do integrador fornecido.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Identificador de grupo
|
GroupIdentifier | True | string |
O identificador do grupo de projetos do Integrador |
|
Nome do Projeto
|
ProjectName | True | string |
O nome do projeto do Integrador |
|
Extrair Nome
|
ExtractName | True | string |
O nome do extrato |
Retornos
- Corpo
- IntegratorComponent
Obter grupos de projetos do Integrador
Obtenha uma lista de grupos de projetos do integrador encontrados no servidor.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Contagem superior
|
$top | integer |
Limita o número de itens retornados pelo número especificado. O serviço retorna o número de itens disponíveis até, mas não maior que o valor especificado n. |
|
|
Ignorar Contagem
|
$skip | integer |
Exclui os primeiros n itens da coleção consultada do resultado. O serviço retorna itens começando na posição n+1. |
|
|
Filter
|
$filter | string |
A opção de consulta do sistema $filter restringe o conjunto de itens retornados. Para obter uma lista de operações e funções disponíveis, consulte a Documentação do OData. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
value
|
value | IntegratorProjectGroupArray |
Obter linhas de extração
Transmita as linhas do extrato com o nome fornecido no projeto do integrador fornecido.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Identificador de grupo
|
GroupIdentifier | True | string |
O identificador do grupo de projetos do Integrador |
|
Nome do Projeto
|
ProjectName | True | string |
O nome do projeto do Integrador |
|
Extrair Nome
|
ExtractName | True | string |
O nome do extrato |
|
Contagem superior
|
$top | integer |
Limita o número de itens retornados pelo número especificado. O serviço retorna o número de itens disponíveis até, mas não maior que o valor especificado n. |
|
|
Ignorar Contagem
|
$skip | integer |
Exclui os primeiros n itens da coleção consultada do resultado. O serviço retorna itens começando na posição n+1. |
|
|
Filter
|
$filter | string |
A opção de consulta do sistema $filter restringe o conjunto de itens retornados. Para obter uma lista de operações e funções disponíveis, consulte a Documentação do OData. |
Retornos
Obter linhas de transformação
Transmita as linhas da transformação com o nome fornecido no projeto do integrador fornecido.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Identificador de grupo
|
GroupIdentifier | True | string |
O identificador do grupo de projetos do Integrador |
|
Nome do Projeto
|
ProjectName | True | string |
O nome do projeto do Integrador |
|
Nome da Transformação
|
TransformName | True | string |
O nome da transformação |
|
Contagem superior
|
$top | integer |
Limita o número de itens retornados pelo número especificado. O serviço retorna o número de itens disponíveis até, mas não maior que o valor especificado n. |
|
|
Ignorar Contagem
|
$skip | integer |
Exclui os primeiros n itens da coleção consultada do resultado. O serviço retorna itens começando na posição n+1. |
|
|
Filter
|
$filter | string |
A opção de consulta do sistema $filter restringe o conjunto de itens retornados. Para obter uma lista de operações e funções disponíveis, consulte a Documentação do OData. |
Retornos
Obter o grupo de projetos do Integrador por identificador
Obtenha o grupo de projetos com a ID fornecida.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Identificador de grupo
|
GroupIdentifier | True | string |
O identificador do grupo de projetos do Integrador |
Retornos
- Corpo
- IntegratorProjectGroup
Obter projeto do Integrador pelo nome
Obtenha o projeto do integrador com o nome fornecido.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Identificador de grupo
|
GroupIdentifier | True | string |
O identificador do grupo de projetos do Integrador |
|
Nome do Projeto
|
ProjectName | True | string |
O nome do projeto do Integrador |
Retornos
- Corpo
- IntegratorProject
Obter projetos do Integrador
Obtenha uma lista de projetos integradores encontrados no servidor.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Identificador de grupo
|
GroupIdentifier | True | string |
O identificador do grupo de projetos do Integrador |
|
Contagem superior
|
$top | integer |
Limita o número de itens retornados pelo número especificado. O serviço retorna o número de itens disponíveis até, mas não maior que o valor especificado n. |
|
|
Ignorar Contagem
|
$skip | integer |
Exclui os primeiros n itens da coleção consultada do resultado. O serviço retorna itens começando na posição n+1. |
|
|
Filter
|
$filter | string |
A opção de consulta do sistema $filter restringe o conjunto de itens retornados. Para obter uma lista de operações e funções disponíveis, consulte a Documentação do OData. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
value
|
value | IntegratorProjectArray |
Obter trabalho por nome
Obtenha os trabalhos com o nome fornecido no projeto do integrador fornecido.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Identificador de grupo
|
GroupIdentifier | True | string |
O identificador do grupo de projetos do Integrador |
|
Nome do Projeto
|
ProjectName | True | string |
O nome do projeto do Integrador |
|
Nome da Tarefa
|
JobName | True | string |
O nome do trabalho |
Retornos
- Corpo
- IntegratorComponent
Obter trabalhos
Obtenha uma lista de trabalhos no projeto do integrador especificado.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Identificador de grupo
|
GroupIdentifier | True | string |
O identificador do grupo de projetos do Integrador |
|
Nome do Projeto
|
ProjectName | True | string |
O nome do projeto do Integrador |
|
Contagem superior
|
$top | integer |
Limita o número de itens retornados pelo número especificado. O serviço retorna o número de itens disponíveis até, mas não maior que o valor especificado n. |
|
|
Ignorar Contagem
|
$skip | integer |
Exclui os primeiros n itens da coleção consultada do resultado. O serviço retorna itens começando na posição n+1. |
|
|
Filter
|
$filter | string |
A opção de consulta do sistema $filter restringe o conjunto de itens retornados. Para obter uma lista de operações e funções disponíveis, consulte a Documentação do OData. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
value
|
value | IntegratorComponentArray |
Obter transformação por nome
Obtenha a transformação com o nome fornecido no projeto do integrador fornecido.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Identificador de grupo
|
GroupIdentifier | True | string |
O identificador do grupo de projetos do Integrador |
|
Nome do Projeto
|
ProjectName | True | string |
O nome do projeto do Integrador |
|
Nome da Transformação
|
TransformName | True | string |
O nome da transformação |
Retornos
- Corpo
- IntegratorComponent
Obter transformações
Obtenha uma lista de transformações no projeto do integrador especificado.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Identificador de grupo
|
GroupIdentifier | True | string |
O identificador do grupo de projetos do Integrador |
|
Nome do Projeto
|
ProjectName | True | string |
O nome do projeto do Integrador |
|
Contagem superior
|
$top | integer |
Limita o número de itens retornados pelo número especificado. O serviço retorna o número de itens disponíveis até, mas não maior que o valor especificado n. |
|
|
Ignorar Contagem
|
$skip | integer |
Exclui os primeiros n itens da coleção consultada do resultado. O serviço retorna itens começando na posição n+1. |
|
|
Filter
|
$filter | string |
A opção de consulta do sistema $filter restringe o conjunto de itens retornados. Para obter uma lista de operações e funções disponíveis, consulte a Documentação do OData. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
value
|
value | IntegratorComponentArray |
Definições
Cubo
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
FilledCellCount
|
FilledCellCount | integer | |
|
ID
|
Id | integer | |
|
Nome
|
Name | string | |
|
Tipo
|
Type | string |
CubeArray
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Itens
|
Cube |
Base de dados
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
CubeCount
|
CubeCount | integer | |
|
DimensionCount
|
DimensionCount | integer | |
|
ID
|
Id | integer | |
|
Nome
|
Name | string | |
|
Tipo
|
Type | string |
DatabaseArray
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Itens
|
Database |
Dimensão
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ElementCount
|
ElementCount | integer | |
|
ID
|
Id | integer | |
|
Nome
|
Name | string | |
|
Tipo
|
Type | string |
DimensionArray
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Itens
|
Dimension |
Elemento
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
Id | integer | |
|
Nome
|
Name | string | |
|
Cargo
|
Position | integer | |
|
Tipo
|
Type | string | |
|
Weight
|
Weight | float |
ElementArray
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Itens
|
Element |
IntegratorComponent
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Description
|
Description | string | |
|
ModificationDate
|
ModificationDate | date-time | |
|
Nome
|
Name | string | |
|
Tipo
|
Type | string |
IntegratorComponentArray
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Itens
|
IntegratorComponent |
IntegratorProject
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Description
|
Description | string | |
|
ModificationDate
|
ModificationDate | date-time | |
|
Nome
|
Name | string | |
|
Versão
|
Version | string |
IntegratorProjectArray
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Itens
|
IntegratorProject |
IntegratorProjectGroup
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Description
|
Description | string | |
|
Desenvolvedor
|
Developer | string | |
|
FriendlyName
|
FriendlyName | string | |
|
ID
|
Id | string | |
|
Nome
|
Name | string | |
|
Namespace
|
Namespace | string | |
|
Versão
|
Version | string |
IntegratorProjectGroupArray
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Itens
|
IntegratorProjectGroup |
IntegratorRunResult
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Erros
|
errors | integer | |
|
tipo de execução
|
executionType | string | |
|
id
|
id | integer | |
|
startDate
|
startDate | date-time | |
|
status
|
status | string | |
|
traceAvailable
|
traceAvailable | boolean | |
|
Avisos
|
warnings | integer |
View
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
CreationDate
|
CreationDate | date-time | |
|
CubeId
|
CubeId | integer | |
|
CubeName
|
CubeName | string | |
|
Description
|
Description | string | |
|
FriendlyName
|
FriendlyName | string | |
|
Global
|
Global | boolean | |
|
ID
|
Id | uuid | |
|
UserName
|
UserName | string |
ViewArray
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Itens
|
View |