Para ativar a comunicação com seu ambiente Planful® (anteriormente Host Analytics®) por meio da interface da API REST publicada do serviço como parte de uma cadeia, adicione uma etapa com um comando de conexão Planful.
Para habilitar esses comandos, primeiro o administrador de TI cria um conector Planful.
Limpar dados
Para limpar os dados da tabela de preparação com base em um código de regra, use o comando Clear Data.
Chamada de API equivalente: https://help.planful.com/v1/docs/clear-data-1
Propriedades
| Propriedade |
Detalhes |
| Regra |
Digite o nome ou o código da regra para carregar os dados. |
Saídas
Nenhum
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Ocorreu um erro |
Obter lista de relatórios
Para recuperar uma lista de relatórios disponíveis, use o comando Get Reports List.
Chamada de API equivalente: N/A
Propriedades
| Propriedade |
Detalhes |
| Pasta de pesquisa |
Digite a pasta da qual você deseja recuperar os relatórios. |
| Tipo de relatório |
Digite o tipo de relatório a ser filtrado. |
Saídas
| Saída |
Tipo de saída |
| Relatórios |
JSON |
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Houve um erro |
Obter versão
Para obter a versão de sua instância do Planful, use o comando Get Version.
Chamada de API equivalente: https://help.planful.com/v1/docs/getversion-api
Propriedades
Nenhum
Saídas
| Saída |
Tipo de saída |
| Nome do aplicativo |
String |
| Versão |
String |
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Houve um erro |
Carregar dados
Para carregar dados em tabelas de preparação do aplicativo Planful, use o comando Load Data.
Chamada de API equivalente: https://help.planful.com/v1/docs/load-data-external-source-models
Propriedades
| Propriedade |
Detalhes |
| Regra |
Digite o nome ou o código da regra para carregar os dados. |
| Dados |
Insira o arquivo que contém os dados a serem carregados em Regra. Cada linha deve ser uma entrada separada. |
| Delimitador |
Selecione o delimitador usado em cada linha para separar os dados em colunas. |
Saídas
| Saída |
Tipo de saída |
| Contagem de registros |
Inteiro |
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Ocorreu um erro |
Recuperar dados GL
Para recuperar a coleção de objetos GLData com base em critérios de filtro, use o comando Retrieve GL Data. Cada objeto retornado corresponde a uma linha de dados GL no banco de dados.
Chamada de API equivalente: https://help.planful.com/v1/docs/gldata-retrieve-api
Propriedades
| Propriedade |
Detalhes |
| Filtros |
Insira os filtros de teste. |
Saídas
| Saída |
Tipo de saída |
| GLData (CSV) |
Arquivo |
| Contagem de registros |
Inteiro |
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Ocorreu um erro |
Recuperar dados do Segment1
Para recuperar uma coleção de objetos de Segment1 com base em critérios de filtro, use o comando Retrieve Segment1 Data. Cada objeto retornado corresponde a uma linha de dados de segment1 no banco de dados.
Chamada de API equivalente: https://help.planful.com/v1/docs/segment1-retrieve
Propriedades
| Propriedade |
Detalhes |
| Filtros |
Insira os filtros de teste. |
Saídas
| Saída |
Tipo de saída |
| Dados do segmento 1 (CSV) |
Arquivo |
| Contagem de registros |
Inteiro |
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Houve um erro |
Recuperar dados de Segment2
Para recuperar uma coleção de objetos do Segment2 com base em critérios de filtro, use o comando Retrieve Segment2 Data. Cada objeto retornado corresponde a uma linha de dados do segmento2 no banco de dados.
Chamada de API equivalente: https://help.planful.com/v1/docs/segment2-retrieve
Propriedades
| Propriedade |
Detalhes |
| Filtros |
Insira os filtros de teste. |
Saídas
| Saída |
Tipo de saída |
| Dados do segmento 2 (CSV) |
Arquivo |
| Contagem de registros |
Inteiro |
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Houve um erro |
Recuperar dados do Segment3
Para recuperar uma coleção de objetos do Segment3 com base em critérios de filtro, use o comando Retrieve Segment3 Data. Cada objeto retornado corresponde a uma linha de dados do segment3 no banco de dados.
Chamada de API equivalente: https://help.planful.com/v1/docs/segment3-retrieve
Propriedades
| Propriedade |
Detalhes |
| Filtros |
Insira os filtros de teste. |
Saídas
| Saída |
Tipo de saída |
| Dados do Segment3 (CSV) |
Arquivo |
| Contagem de registros |
Inteiro |
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Ocorreu um erro |
Recuperar dados do Segment4
Para recuperar uma coleção de objetos do Segment4 com base em critérios de filtro, use o comando Retrieve Segment4 Data. Cada objeto retornado corresponde a uma linha de dados do segment4 no banco de dados.
Chamada de API equivalente: https://help.planful.com/v1/docs/segment4-retrieve
Propriedades
| Propriedade |
Detalhes |
| Filtros |
Insira os filtros de teste. |
Saídas
| Saída |
Tipo de saída |
| Dados do Segment4 (CSV) |
Arquivo |
| Contagem de registros |
Inteiro |
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Ocorreu um erro |
Recuperar dados do Segment5
Para recuperar uma coleção de objetos do Segment5 com base em critérios de filtro, use o comando Retrieve Segment5 Data (Recuperar dados do Segment5). Cada objeto retornado corresponde a uma linha de dados do segmento5 no banco de dados.
Chamada de API equivalente: https://help.planful.com/v1/docs/segment5-retrieve
Propriedades
| Propriedade |
Detalhes |
| Filtros |
Insira os filtros de teste. |
Saídas
| Saída |
Tipo de saída |
| Dados do Segment5 (CSV) |
Arquivo |
| Contagem de registros |
Inteiro |
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Ocorreu um erro |
Recuperar dados do Segment6
Para recuperar uma coleção de objetos do Segment6 com base em critérios de filtro, use o comando Retrieve Segment6 Data (Recuperar dados do Segment6). Cada objeto retornado corresponde a uma linha de dados do segment6 no banco de dados.
Chamada de API equivalente: https://help.planful.com/v1/docs/segment6-retrieve
Propriedades
| Propriedade |
Detalhes |
| Filtros |
Insira os filtros de teste. |
Saídas
| Saída |
Tipo de saída |
| Dados do Segment6 (CSV) |
Arquivo |
| Contagem de registros |
Inteiro |
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Houve um erro |
Recuperar dados do Segment7
Para recuperar uma coleção de objetos do Segment7 com base em critérios de filtro, use o comando Retrieve Segment7 Data. Cada objeto retornado corresponde a uma linha de dados do segment7 no banco de dados.
Chamada de API equivalente: https://help.planful.com/v1/docs/segment7-retrieve
Propriedades
| Propriedade |
Detalhes |
| Filtros |
Insira os filtros de teste. |
Saídas
| Saída |
Tipo de saída |
| Dados do Segment7 (CSV) |
Arquivo |
| Contagem de registros |
Inteiro |
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Ocorreu um erro |
Recuperar dados do Segment8
Para recuperar uma coleção de objetos do Segment8 com base em critérios de filtro, use o comando Retrieve Segment8 Data. Cada objeto retornado corresponde a uma linha de dados do segment8 no banco de dados.
Chamada de API equivalente: https://help.planful.com/v1/docs/segment8-retrieve
Propriedades
| Propriedade |
Detalhes |
| Filtros |
Insira os filtros de teste. |
Saídas
| Saída |
Tipo de saída |
| Dados do Segment8 (CSV) |
Arquivo |
| Contagem de registros |
Inteiro |
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Houve um erro |
Executar relatório
Para executar um relatório e retornar seus resultados como JSON, use o comando Run Report.
Chamada de API equivalente: N/A
Propriedades
| Propriedade |
Detalhes |
| Código do relatório |
Digite o nome ou o código do relatório a ser executado. |
| Linhagem |
Informe onde o relatório está localizado no Planful. Use // como separadores no caminho. |
| Nome do cubo |
Digite o nome do cubo associado ao relatório. |
| Filtros |
Insira os filtros a serem aplicados ao relatório. |
| Aplicar filtros |
Selecione se você deseja aplicar os filtros. |
Saídas
| Saída |
Tipo de saída |
| Relatório |
JSON |
| Relatório (CSV) |
Arquivo |
| Contagem de registros |
Inteiro |
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Ocorreu um erro |
Transferir dados
Para transferir os dados da tabela de preparação para a tabela de destino no Planful com base em um código de regra, use o comando Transferir dados.
Chamada de API equivalente: https://help.planful.com/v1/docs/new-transfer-data-rest-api
Propriedades
| Propriedade |
Detalhes |
| Regra |
Digite o nome (código) da regra para carregar os dados |
Saídas
Nenhum
Códigos de saída
| Código |
Tipo |
Detalhes |
| 0 |
Sucesso |
Sucesso |
| 1 |
Erro |
Houve um erro |