Celonis (Pré-visualização)
Celonis Platform API para trabalhar com elementos do Modelo de Conhecimento, como registros, KPIs, filtros, gatilhos e seus dados relacionados.
Este conector está disponível nos seguintes produtos e regiões:
| Serviço | Class | Regiões |
|---|---|---|
| Estúdio Copiloto | Premium | Todas as regiões do Power Automatic , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Aplicações Lógicas | Standard | Todas as regiões do Logic Apps , exceto as seguintes: - Regiões do Azure Government - Regiões do Azure China - Departamento de Defesa dos EUA (DoD) |
| Aplicações Power | Premium | Todas as regiões do Power Apps , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Automatize o poder | Premium | Todas as regiões do Power Automatic , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Contato | |
|---|---|
| Nome | Suporte Celonis |
| URL | https://developer.celonis.com/ |
| intelligence-api-feedback-sc@celonis.de |
| Metadados do conector | |
|---|---|
| Editora | Celonis |
| Sítio Web | https://www.celonis.com |
| Política de privacidade | https://www.celonis.com/privacy-policy/ |
| Categorias | IA; Gestão Empresarial |
Title
A API Celonis Intelligence permite que os clientes da Celonis incorporem inteligência de processo acionável em plataformas de terceiros, onde os usuários finais podem se beneficiar das perceções de processos da Celonis. Dessa forma, ele aproximaria a inteligência da Celonis, como KPIs de processo ou ineficiências de processos, dos usuários finais e beneficiaria os usuários operacionais sem acesso atual à Celonis, fornecendo informações valiosas para uma melhor tomada de decisão durante a execução de suas atividades diárias. Além do recurso de consulta de dados, a API de inteligência também suporta o envio de dados para plataformas de terceiros, permitindo que eles se inscrevam em gatilhos de negócios.
Editora: Nome do editor
Pré-requisitos
- Uma equipa na Plataforma Celonis.
- Um Modelo de Conhecimento disponível na equipa de um cliente.
- Subscrição Celonis baseada em processos (contacte a equipa da sua conta para verificar).
Operações suportadas
Os métodos atuais da API permitem que os consumidores interajam com os Modelos de Conhecimento definidos na Plataforma Celonis, fornecendo as seguintes funcionalidades:
Métodos de descoberta de modelo de conhecimento
Obter uma lista de Modelos de Conhecimento (KM)
Obter uma lista de Registos KM
Obter detalhes do esquema de registro KM
Obter uma lista de Filtros KM
Métodos de recuperação de dados do modelo de conhecimento
Obter uma lista de dados do Registro KM
Métodos de gerenciamento do ciclo de vida da assinatura
Obter uma lista de Subscrições
Obter uma lista de KM Triggers
Criar uma assinatura para um gatilho KM
Atualizar uma subscrição
Pausar uma assinatura
Retomar uma subscrição
Cancelar uma assinatura
Obtenção de credenciais
Authentication
Cada solicitação para a API deve ser autenticada com uma chave de API Celonis. Existem duas formas de o fazer:
Usando uma chave de API do usuário
Você pode descobrir como criar uma chave de API de usuário seguindo nosso guia de chaves de API de usuário . A API do Celonis usa a autenticação de token de portador para verificar o acesso do consumidor. As credenciais devem ser enviadas em um cabeçalho de Autorização na solicitação HTTP. As credenciais enviadas no URL ou no corpo da solicitação serão ignoradas. Para autenticar usando a Autenticação de Token de Portador:
- Crie o token em Celonis:
MDg5MGVkNDktNjMwZC00ODdiLTkyNGItMjNmMzMxNjRmM2IwOkhNUVRMUis4SGh6NHhBY21Vck9GaWdkem5rYzBrb3p0N056WUM0bGlqczMM - Inclua a cadeia de caracteres no cabeçalho de Autorização HTTP formatado assim:
Authorization: **Bearer** MDg5MGVkNDktNjMwZC00ODdiLTkyNGItMjNmMzMxNjRmM2IwOkhNUVRMUis4SGh6NHhBY21Vck9GaWdkem5rYzBrb3p0N056WUM0bGlqczMM
Usando uma chave da API do aplicativo
Você pode descobrir como criar uma AppKey seguindo nosso guia de chaves de API de aplicativo . Para autenticar usando a Autenticação AppKey:
- Crie a AppKey no Celonis:
MzgyZDEzYjItNjI1MS00NTIwLTk1YTItY2ZjYzMzZTllOTNmOkE3a1dvYnpYQ0c3aUtUdTNRNC9UNzFLUXZmY0E2ZjVXUUROajFoN1R5UzIr - Inclua a cadeia de caracteres no cabeçalho de Autorização HTTP formatado assim:
Authorization: **AppKey** MzgyZDEzYjItNjI1MS00NTIwLTk1YTItY2ZjYzMzZTllOTNmOkE3a1dvYnpYQ0c3aUtUdTNRNC9UNzFLUXZmY0E2ZjVXUUROajFoN1R5UzIr
Authorization
Você deve definir as permissões corretas e garantir que a Chave de API do Usuário ou a Chave de API de Aplicativo aproveitada para fins de autorização tenha acesso ao pacote do Celonis Studio contendo o(s) Modelo(s) de Conhecimento que você gostaria de acessar por meio de APIs de Inteligência. Você pode conceder permissões de acesso seguindo estas etapas:
- Vá para o pacote Studio.
- Clique nos três pontos e selecione
Permissionsno menu pop-up. - Pesquise o Usuário (no caso de você estar usando um token ao portador ) ou AppKey (no caso de você estar usando um AppKey ) e conceda pelo menos
USE PACKAGEdireitos.
Introdução
A URL base da API do Celonis é https://<team>.<cluster>.celonis.cloud/intelligence/api Para encontrar a equipe e o cluster, verifique o URL usado para acessar a plataforma Celonis e recuperar a equipe e o cluster a partir dela.
A API do Celonis Intelligence é uma API JSON e seus endpoints sempre retornarão uma resposta JSON, independentemente do sucesso da solicitação.
Os métodos atuais da API permitem que os consumidores interajam com os Modelos de Conhecimento definidos na Plataforma Celonis, fornecendo as seguintes funcionalidades:
- Lista de modelos de conhecimento disponíveis e seus detalhes
- Lista de registos e respetivos dados
- Lista de filtros
- Dados para um registo específico. Detalhes sobre os recursos da API do Celonis Intelligence no portal do desenvolvedor Celonis.
Problemas conhecidos e limitações
Limitação de Velocidade
A API de inteligência não foi criada para exportar dados RAW em massa, mas para disponibilizar os resultados calculados e os insights da mineração de processos para plataformas e aplicativos de terceiros 3rd. É por isso que a API Celonis impõe o limite de taxa. Isso significa que apenas um certo número de solicitações é permitido por dia e um certo número de registros pode ser recuperado em cada chamada. A Celonis reserva-se o direito de ajustar os limites tarifários a qualquer momento para garantir um serviço de alta qualidade para todos os clientes.
Caso um cliente exceda repetidamente os limites de taxa ou se envolva em comportamentos considerados suspeitos, a Celonis reserva-se o direito de limitar ou suspender temporária ou permanentemente o acesso à API desse cliente.
Quando um cliente excede o número de solicitações por dia, a API Celonis retornará uma resposta 429 (muitas solicitações), incluindo um cabeçalho HTTP (x-ratelimit-reset) que indica o tempo (em segundos) que o cliente precisa esperar antes que uma nova solicitação possa ser processada.
Os seguintes cabeçalhos HTTP também são retornados como parte de cada chamada:
-
x-ratelimit-limit: Representa o número máximo de solicitações que o cliente pode executar na janela de tempo atual. -
x-ratelimit-remaining: Número de solicitações restantes na janela de tempo atual. Atualmente, a API tem os seguintes limites padrão:
Tabela 1. Limites de taxa de solicitação padrão
|
Limite | Valores padrão | |--|--| | Número máximo de pedidos/dia | 6000 pedidos/dia | | Número máximo de pedidos/segundo | 20 pedidos/segundo | | Número máximo de campos permitidos por solicitação no Modelo de Conhecimento | 200 campos/pedido | | Número máximo de registros por solicitação retornados ao chamar o /data ponto de extremidade | 50 registros/solicitação | | Número máximo total de registos que podem ser recuperados através do /data ponto final | Primeiros 5.000 registos por tabela filtrada/ordenada | A assinatura do Trigger também está impondo limites de taxa. Isto significa que, para uma equipa, apenas um determinado número de subscrições pode ser criado. Além disso, não importa quantas assinaturas sejam criadas, há um número máximo de eventos que podem ser emitidos da API para os consumidores de terceiros.
Se um cliente atingir o número máximo de subscrições, terá de eliminar uma subscrição existente para criar uma nova.
Se um cliente atingir o número máximo de eventos emitidos pela API, o restante dos dados produzidos pela Celonis Platform será descartado.
Se o cliente estiver se aproximando de sua cota diária, ele será informado por e-mail para sua conta de administrador. O primeiro e-mail será enviado quando 80% da cota forem excedidos, informando sua conta de administrador de que você está acima dessa porcentagem. O segundo e-mail será enviado assim que exceder 100% da quota.
Atualmente, a API tem os seguintes limites padrão:
Tabela 2. Limites de taxa de eventos padrão
|
Limite | Valores padrão | |--|--| | Número máximo de subscrições/equipa | 10 | | Número máximo de eventos/dia | 100,000 | Consulte a equipa da sua conta para verificar os limites da sua equipa.
Perguntas Frequentes
Consulte a seção Perguntas frequentes no Celonis Developer Portal.
Instruções de implantação
Required. Adicione instruções sobre como implantar esse conector como conector personalizado.
A criar uma ligação
O conector suporta os seguintes tipos de autenticação:
| Predefinição | 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.
Esta conexão não é compartilhável. Se o aplicativo avançado for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.
| Nome | Tipo | Description | Obrigatório |
|---|---|---|---|
| Equipa | cadeia (de caracteres) | Por favor, especifique a equipe Celonis. | Verdade |
| Cluster | cadeia (de caracteres) | Especifique o cluster Celonis. | Verdade |
| Authorization | securestring | A autorização para esta api | Verdade |
Limites de Limitação
| Name | Chamadas | Período de Renovação |
|---|---|---|
| Chamadas de API por conexão | 100 | 60 segundos |
Ações
| Atualiza uma subscrição |
Atualiza uma subscrição |
| Cancelar inscrição de um gatilho removendo todos os dados da assinatura |
Cancelar inscrição de um gatilho removendo todos os dados da assinatura |
| Cria uma assinatura para o gatilho |
Cria uma assinatura para o gatilho |
| Obtenha os detalhes de KM de nível superior |
Modelo de Conhecimento definido em uma equipe EMS |
| Obtenha os detalhes do esquema de registro KM de nível superior |
Detalhes do esquema de registro de nível superior |
| Obter uma lista de dados do Registro KM |
Dados para um registro no modelo de conhecimento |
| Obter uma lista de Filtros KM |
Lista de filtros para o modelo de conhecimento |
| Obter uma lista de KM Triggers |
Lista de gatilhos para o modelo de conhecimento |
| Obter uma lista de KMs |
Lista de modelos de conhecimento definidos em uma equipe EMS |
| Obter uma lista de Subscrições |
Lista de todas as Subscrições criadas |
| Obter uma lista do esquema KM Records |
Lista de esquemas de registros |
| Pausa a subscrição para deixar de receber eventos |
Pausa a subscrição para deixar de receber eventos |
| Recupera a próxima página de eventos que não foram encaminhados devido a uma assinatura com falha |
Recupera a próxima página de eventos se eles não foram encaminhados devido a uma assinatura com falha |
| Retoma a subscrição para começar a receber novos eventos, descartando eventos do histórico |
Retoma a subscrição pausada para começar a receber novos eventos novamente, descartando eventos do histórico |
| Retoma a subscrição pausada para começar a receber eventos novamente |
Retoma a subscrição pausada para começar a receber eventos novamente |
Atualiza uma subscrição
Atualiza uma subscrição
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da Subscrição
|
subscription_id | True | string |
O ID da subscrição que será totalmente atualizado |
|
headers
|
headers | object |
Os cabeçalhos de retorno de chamada podem conter token de autenticação, tipo de conteúdo, etc. |
|
|
protocolo
|
protocol | True | string |
O único valor possível realmente é HTTPS, o que significa que o URI de retorno de chamada deve ser um https válido |
|
URI
|
uri | True | string |
Uri para executar o retorno de chamada da API de inteligência assim que o gatilho for acionado |
|
configurations
|
configurations | array of string |
Configuração da Subscrição |
|
|
nome
|
name | True | string |
Nome da subscrição |
Cancelar inscrição de um gatilho removendo todos os dados da assinatura
Cancelar inscrição de um gatilho removendo todos os dados da assinatura
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da Subscrição
|
subscription_id | True | string |
O ID da subscrição será eliminado |
Cria uma assinatura para o gatilho
Cria uma assinatura para o gatilho
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Km Id
|
km_id | True | string |
A ID do Modelo de Conhecimento |
|
ID do gatilho
|
trigger_id | True | string |
O ID do gatilho |
|
headers
|
headers | object |
Os cabeçalhos de retorno de chamada podem conter token de autenticação, tipo de conteúdo, etc. |
|
|
protocolo
|
protocol | True | string |
O único valor possível realmente é HTTPS, o que significa que o URI de retorno de chamada deve ser um https válido |
|
URI
|
uri | True | string |
Uri para executar o retorno de chamada da API de inteligência assim que o gatilho for acionado |
|
configurations
|
configurations | array of string |
Configuração da Subscrição |
|
|
nome
|
name | True | string |
Nome da subscrição |
Devoluções
- response
- string
Obtenha os detalhes de KM de nível superior
Modelo de Conhecimento definido em uma equipe EMS
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do Modelo de Conhecimento
|
km_id | True | string |
ID do Modelo de Conhecimento |
Devoluções
Estrutura dos dados do Modelo de Conhecimento
- Modelo de Conhecimento
- knowledgeModelDetailedDTO
Obtenha os detalhes do esquema de registro KM de nível superior
Detalhes do esquema de registro de nível superior
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do Modelo de Conhecimento
|
km_id | True | string |
ID do Modelo de Conhecimento |
|
ID do Registo
|
record_id | True | string |
ID do Registo |
Devoluções
Record representa um conceito dentro de um Modelo de Conhecimento
- Tipo de registo
- recordDTO
Obter uma lista de dados do Registro KM
Dados para um registro no modelo de conhecimento
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do Modelo de Conhecimento
|
km_id | True | string |
ID do Modelo de Conhecimento |
|
ID do Registo
|
record_id | True | string |
ID do Registo |
|
Filtros
|
filters | array |
Um id de filtro predefinido |
|
|
IDs de campo
|
fields | True | array |
Um id de filtro predefinido |
|
Página
|
page | integer |
O número de página do resultado, começando por 0 (primeira página) |
|
|
Tamanho da página
|
pageSize | integer |
O número de itens retornados em uma página. |
|
|
Classificação
|
sort | array |
Define a estratégia a seguir para a classificação. Deve ser uma lista separada por vírgulas de campos, e eles devem começar com "+" para aplicar a ordem ASC ou "-" para aplicar a ordem DESC. Os campos sem prefixo serão classificados como ASC. Campos não existentes no cabeçalho gerarão um erro |
|
|
Expressão de filtro
|
filterExpr | array |
Expressões de filtro dinâmico |
Devoluções
- Página de resultados de dados de registo
- recordResultPageDTO
Obter uma lista de Filtros KM
Lista de filtros para o modelo de conhecimento
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Página
|
page | integer |
O número de página do resultado, começando por 0 (primeira página) |
|
|
Tamanho da página
|
pageSize | integer |
O número de itens retornados em uma página. |
|
|
Classificação
|
sort | string |
Define a estratégia a ser prosseguida para a classificação que não diferencia maiúsculas de minúsculas. Deve ser apenas um campo, e deve começar com "+" para aplicar a ordem ASC ou "-" para aplicar a ordem DESC. O prefixo não será classificado como ASC. Campo não existente no cabeçalho irá lançar um erro |
|
|
ID do Modelo de Conhecimento
|
km_id | True | string |
ID do Modelo de Conhecimento |
Devoluções
- Página de resultados do esquema de filtro
- filterResultPage
Obter uma lista de KM Triggers
Lista de gatilhos para o modelo de conhecimento
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Página
|
page | integer |
O número de página do resultado, começando por 0 (primeira página) |
|
|
Tamanho da página
|
pageSize | integer |
O número de itens retornados em uma página. |
|
|
Ordenar
|
sort | string |
Define a estratégia a ser prosseguida para a classificação que não diferencia maiúsculas de minúsculas. Deve ser apenas um campo, e deve começar com "+" para aplicar a ordem ASC ou "-" para aplicar a ordem DESC. O prefixo não será classificado como ASC. Campo não existente no cabeçalho irá lançar um erro |
|
|
Km Id
|
km_id | True | string |
A ID do Modelo de Conhecimento |
Devoluções
- Página de resultados do esquema de gatilho
- triggerResultPage
Obter uma lista de KMs
Lista de modelos de conhecimento definidos em uma equipe EMS
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Página
|
page | integer |
O número de página do resultado, começando por 0 (primeira página) |
|
|
Tamanho da página
|
pageSize | integer |
O número de itens retornados em uma página. |
|
|
Classificação
|
sort | string |
Define a estratégia a ser prosseguida para a classificação que não diferencia maiúsculas de minúsculas. Deve ser apenas um campo, e deve começar com "+" para aplicar a ordem ASC ou "-" para aplicar a ordem DESC. O prefixo não será classificado como ASC. Campo não existente no cabeçalho irá lançar um erro |
Devoluções
- Página de resultados do KnowledgeModel
- knowledgeModelResultPage
Obter uma lista de Subscrições
Lista de todas as Subscrições criadas
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Página
|
page | integer |
O número de página do resultado, começando por 0 (primeira página) |
|
|
Tamanho da página
|
pageSize | integer |
O número de itens retornados em uma página. |
|
|
Ordenar
|
sort | string |
Define a estratégia a ser prosseguida para a classificação que não diferencia maiúsculas de minúsculas. Deve ser apenas um campo, e deve começar com "+" para aplicar a ordem ASC ou "-" para aplicar a ordem DESC. O prefixo não será classificado como ASC. Campo não existente no cabeçalho irá lançar um erro |
Devoluções
- Página de resultados do esquema de subscrição
- subscriptionResultPage
Obter uma lista do esquema KM Records
Lista de esquemas de registros
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Página
|
page | integer |
O número de página do resultado, começando por 0 (primeira página) |
|
|
Tamanho da página
|
pageSize | integer |
O número de itens retornados em uma página. |
|
|
Classificação
|
sort | string |
Define a estratégia a ser prosseguida para a classificação que não diferencia maiúsculas de minúsculas. Deve ser apenas um campo, e deve começar com "+" para aplicar a ordem ASC ou "-" para aplicar a ordem DESC. O prefixo não será classificado como ASC. Campo não existente no cabeçalho irá lançar um erro |
|
|
ID do Modelo de Conhecimento
|
km_id | True | string |
ID do Modelo de Conhecimento |
Devoluções
- Página de resultados do esquema de registro
- recordSchemaResultPage
Pausa a subscrição para deixar de receber eventos
Pausa a subscrição para deixar de receber eventos
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da Subscrição
|
subscription_id | True | string |
O ID da subscrição será pausado |
Recupera a próxima página de eventos que não foram encaminhados devido a uma assinatura com falha
Recupera a próxima página de eventos se eles não foram encaminhados devido a uma assinatura com falha
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da Subscrição
|
subscription_id | True | string |
A ID da assinatura que recuperará o evento com falha enviado, em um máximo de 50 itens |
Devoluções
- Página de resultados do sinal
- SignalResultPage
Retoma a subscrição para começar a receber novos eventos, descartando eventos do histórico
Retoma a subscrição pausada para começar a receber novos eventos novamente, descartando eventos do histórico
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da Subscrição
|
subscription_id | True | string |
O ID da subscrição será retomado sem receber eventos passados |
Retoma a subscrição pausada para começar a receber eventos novamente
Retoma a subscrição pausada para começar a receber eventos novamente
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da Subscrição
|
subscription_id | True | string |
O ID da subscrição será retomado e começará a receber o evento novamente |
Definições
SignalResultPage
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
conteúdo
|
content | array of signalDTO | |
|
pageSize
|
pageSize | integer |
Tamanho da página, definido pelo sistema |
filterDTO
Filtro a aplicar num KM
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
descrição
|
description | string |
Humano compreensível Descrição do filtro |
|
id
|
id | string |
Identificador exclusivo do filtro |
|
nome
|
name | string |
Nome de exibição do filtro compreensível para humanos |
filterResultPage
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
página
|
page | integer |
Página |
|
pageSize
|
pageSize | integer |
Tamanho da página, definido pelo parâmetro pageSize |
|
ordenar
|
sort | string |
Campo usado para aplicar a classificação aos dados solicitados, + ou nenhum símbolo significa ASC, - significa DESC |
|
total
|
total | integer |
Total de elementos retornados na página |
|
conteúdo
|
content | array of filterDTO |
knowledgeModelDetailedDTO
Estrutura dos dados do Modelo de Conhecimento
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | string |
Identificador Único do Modelo de Conhecimento |
|
nome
|
name | string |
Texto compreensível para humanos |
|
KMId estendido
|
extendedKMId | string |
Modelo de conhecimento utilizado como referência, base de GC. |
knowledgeModelResultPage
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
página
|
page | integer |
Página |
|
pageSize
|
pageSize | integer |
Tamanho da página, definido pelo parâmetro pageSize |
|
ordenar
|
sort | string |
Campo usado para aplicar a classificação aos dados solicitados, + ou nenhum símbolo significa ASC, - significa DESC |
|
total
|
total | integer |
Total de elementos retornados na página |
|
conteúdo
|
content | array of knowledgeModelSimplifiedDTO |
knowledgeModelSimplifiedDTO
Estrutura dos dados do Modelo de Conhecimento
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | string |
Identificador Único do Modelo de Conhecimento |
|
nome
|
name | string |
Texto compreensível para humanos |
|
publicado em
|
published | string |
Última data de publicação |
recordDTO
Record representa um conceito dentro de um Modelo de Conhecimento
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
descrição
|
description | string |
Descrição dos registos |
|
id
|
id | string |
Identificador único do registo |
|
nome
|
name | string |
Nome de exibição de registro, um nome compreensível para humanos |
|
campos
|
fields | array of recordFieldDTO |
recordFieldDTO
Campos para um registo
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
format
|
format | string |
Formato a aplicar |
|
id
|
id | string |
Montante pendente a pagar |
|
nome
|
name | string |
nome humano compreensível |
|
tipo
|
type | string | |
|
unidade
|
unit | string |
Unidade adicionada ao valor do campo |
recordIdDTO
ID e nome do tipo de registo
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
descrição
|
description | string |
Descrição dos registos |
|
id
|
id | string |
Identificador único do registo |
|
nome
|
name | string |
Nome de exibição de registro, um nome compreensível para humanos |
recordItemDTO
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
dados
|
data | array of |
Lista de item de registro, composto com nome e valor |
|
headers
|
headers | array of recordItemHeaderDTO |
recordItemHeaderDTO
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
agregação
|
aggregation | boolean |
Indique se um campo é uma agregação/informação calculada (KPI). |
|
filtrável
|
filterable | boolean |
Indique se o campo pode ser filtrado. |
|
format
|
format | string |
Formatar expressão |
|
id
|
id | string |
Identidade de campo a ser usada na lista de campos param e filterExpression param |
|
nome
|
name | string |
Texto compreensível para humanos |
|
ordenável
|
sortable | boolean |
Indique se o campo pode ser classificado. |
|
tipo
|
type | string |
Possíveis tipos de dados. |
|
unidade
|
unit | string |
Um sinal complementar para a visualização do valor do formato |
recordResultPageDTO
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
página
|
page | integer |
Página |
|
pageSize
|
pageSize | integer |
Tamanho da página, definido pelo parâmetro pageSize |
|
ordenar
|
sort | array of string | |
|
total
|
total | integer |
Total de elementos retornados na página |
|
Item de registro
|
content | recordItemDTO |
recordSchemaResultPage
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
página
|
page | integer |
Página |
|
pageSize
|
pageSize | integer |
Tamanho da página, definido pelo parâmetro pageSize |
|
ordenar
|
sort | string |
Campo usado para aplicar a classificação aos dados solicitados, + ou nenhum símbolo significa ASC, - significa DESC |
|
total
|
total | integer |
Total de elementos retornados na página |
|
conteúdo
|
content | array of recordIdDTO |
signalDTO
Sinal armazenado na subscrição
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
signal
|
signal | string |
Raw json de um sinal |
|
ID de subscrição
|
subscriptionId | string |
Identificador único do assinante como SUID |
|
triggerId
|
triggerId | string |
Identificador único do gatilho como SUID |
|
Data de criação
|
creationDate | date-time |
Data de criação do sinal |
assinaturaDTO
Esquema de subscrição
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
configurations
|
configurations | array of string |
Configuração da Subscrição |
|
id
|
id | string |
Identificador único do assinante como SUID |
|
knowledgeModelId
|
knowledgeModelId | string |
Identificador Único do Modelo de Conhecimento |
|
latestSucceedEvent
|
latestSucceedEvent | date-time |
Data do último evento sucedido |
|
nome
|
name | string |
Nome da subscrição compreensível para humanos |
|
estado
|
status | string | |
|
triggerId
|
triggerId | string |
Identificador único do gatilho como SUID |
subscriptionResultPage
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
página
|
page | integer |
Página |
|
pageSize
|
pageSize | integer |
Tamanho da página, definido pelo parâmetro pageSize |
|
ordenar
|
sort | string |
Campo usado para aplicar a classificação aos dados solicitados, + ou nenhum símbolo significa ASC, - significa DESC |
|
total
|
total | integer |
Total de elementos retornados na página |
|
conteúdo
|
content | array of subscriptionDTO |
triggerDTO
Gatilho definido em KM
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | string |
Identificador único do gatilho como SUID |
|
nome
|
name | string |
Nome do gatilho compreensível para humanos |
|
registo
|
record | string |
Identificador único do registo como SUID |
triggerResultPage
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
página
|
page | integer |
Página |
|
pageSize
|
pageSize | integer |
Tamanho da página, definido pelo parâmetro pageSize |
|
ordenar
|
sort | string |
Campo usado para aplicar a classificação aos dados solicitados, + ou nenhum símbolo significa ASC, - significa DESC |
|
total
|
total | integer |
Total de elementos retornados na página |
|
conteúdo
|
content | array of triggerDTO |
cadeia (de caracteres)
Este é o tipo de dados básico 'string'.