Celonis (versão prévia)
A API da Plataforma Celonis para trabalhar com elementos do Modelo de Conhecimento, como registros, KPIs, filtros, gatilhos e seus dados relacionados.
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 Celonis |
| URL | https://developer.celonis.com/ |
| intelligence-api-feedback-sc@celonis.de |
| Metadados do conector | |
|---|---|
| Publicador | Celonis |
| Site | https://www.celonis.com |
| Política de privacidade | https://www.celonis.com/privacy-policy/ |
| Categorias | IA; Gestão de empresas |
Title
A API de Inteligência do Celonis permite que os clientes da Celonis insiram inteligência de processo acionável em plataformas de terceiros em que os usuários finais podem se beneficiar dos insights de processo do Celonis. Dessa forma, isso aproximaria os usuários finais dos usuários finais e beneficiaria os usuários operacionais sem acesso atual ao Celonis, fornecendo insights valiosos para uma melhor tomada de decisão durante a execução de suas atividades diárias. Além da funcionalidade de consulta de dados, a API de Inteligência também dá suporte ao envio de dados por push para plataformas de terceiros, permitindo que eles assinem gatilhos de negócios.
Publicador: Nome do Publicador
Pré-requisitos
- Uma equipe na Plataforma Celonis.
- Um modelo de conhecimento disponível na equipe de um cliente.
- Assinatura do Celonis baseada em processo (contate sua equipe de conta para verificar).
Operações com suporte
Os métodos de API atuais 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 KM (Modelos de Conhecimento)
Obter uma lista de registros 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 de registro KM
Métodos de gerenciamento do ciclo de vida da assinatura
Obter uma lista de Assinaturas
Obter uma lista de gatilhos KM
Criar uma assinatura para um gatilho KM
Atualizar uma assinatura
Pausar uma assinatura
Retomar uma assinatura
Encerrar uma assinatura
Obtendo credenciais
Authentication
Cada solicitação à API deve ser autenticada com uma chave de API do Celonis. Há duas maneiras de fazer isso:
Usando uma chave de API de 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 na URL ou no corpo da solicitação serão ignoradas. Para autenticar usando a Autenticação de Token de Portador:
- Crie o token no Celonis:
MDg5MGVkNDktNjMwZC00ODdiLTkyNGItMjNmMzMxNjRmM2IwOkhNUVRMUis4SGh6NHhBY21Vck9GaWdkem5rYzBrb3p0N056WUM0bGlqczMM - Inclua a cadeia de caracteres no cabeçalho de Autorização HTTP formatado desta forma:
Authorization: **Bearer** MDg5MGVkNDktNjMwZC00ODdiLTkyNGItMjNmMzMxNjRmM2IwOkhNUVRMUis4SGh6NHhBY21Vck9GaWdkem5rYzBrb3p0N056WUM0bGlqczMM
Usando uma chave de API de Aplicativo
Você pode descobrir como criar um AppKey seguindo nosso guia de Chaves de API de Aplicativo . Para autenticar usando a Autenticação AppKey:
- Crie o AppKey no Celonis:
MzgyZDEzYjItNjI1MS00NTIwLTk1YTItY2ZjYzMzZTllOTNmOkE3a1dvYnpYQ0c3aUtUdTNRNC9UNzFLUXZmY0E2ZjVXUUROajFoN1R5UzIr - Inclua a cadeia de caracteres no cabeçalho de Autorização HTTP formatado desta forma:
Authorization: **AppKey** MzgyZDEzYjItNjI1MS00NTIwLTk1YTItY2ZjYzMzZTllOTNmOkE3a1dvYnpYQ0c3aUtUdTNRNC9UNzFLUXZmY0E2ZjVXUUROajFoN1R5UzIr
Authorization
Você deve definir as permissões certas e garantir que a Chave de API de Usuário ou a Chave de API de Aplicativo aproveitada para fins de autorização tenha acesso ao pacote do Celonis Studio que contém os Modelos de Conhecimento que você deseja acessar por meio de APIs de Inteligência. Você pode conceder permissões de acesso seguindo estas etapas:
- Vá para o pacote do Studio.
- Clique nos três pontos e selecione
Permissionsno menu pop-up. - Pesquise o Usuário (caso esteja usando um token de portador ) ou AppKey (caso esteja 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 localizar a equipe e o cluster, verifique a URL que você usa para acessar a Plataforma Celonis e recuperar a equipe e o cluster dela.
A API de Inteligência do Celonis é uma API JSON e seus pontos de extremidade sempre retornarão uma resposta JSON, independentemente do sucesso da solicitação.
Os métodos de API atuais 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 registros e seus detalhes
- Lista de filtros
- Dados de um registro específico. Detalhes sobre os recursos da API do Celonis Intelligence no portal do desenvolvedor do Celonis.
Problemas e limitações conhecidos
Limitação de taxa
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. É por isso que a API do Celonis impõe a limitação de taxa. Isso significa que apenas um determinado número de solicitações são permitidas por dia e um determinado número de registros pode ser recuperado em cada chamada. A Celonis reserva-se o direito de ajustar os limites de taxa 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 um comportamento considerado suspeito, a Celonis reserva-se o direito de limitar ou suspender temporariamente ou permanentemente o acesso à API desse cliente.
Quando um cliente excede o número de solicitações por dia, a API do 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 aguardar 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 solicitações/dia | 6000 requests/day | | Número máximo de solicitações/segundo | 20 requests/second | | Número máximo de campos permitidos por solicitação no Modelo de Conhecimento | 200 fields/request | | Número máximo de registros por solicitação retornado ao chamar o /data ponto de extremidade | 50 registros/solicitação | | Número máximo total de registros que podem ser recuperados por meio do /data ponto de extremidade | Primeiros 5.000 registros por tabela filtrada/classificada | A assinatura do Gatilho também está impondo a limitação de taxa. Isso significa que, para uma equipe, apenas um determinado número de assinaturas 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 assinaturas, ele precisará excluir uma assinatura existente para criar uma nova.
Se um cliente atingir o número máximo de eventos emitidos da API, o restante dos dados produzidos pela Plataforma Celonis será descartado.
Se o cliente estiver se aproximando de sua cota diária, ele será informado por email para sua conta de administrador. O primeiro email será enviado quando 80% da cota forem excedidas, permitindo que sua conta de administrador saiba que você está acima desse percentual. O segundo email será enviado assim que você exceder 100% da cota.
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 assinaturas/equipe | 10 | | Número máximo de eventos/dia | 100,000 | Consulte sua equipe de conta para verificar os limites da sua equipe.
Perguntas frequentes
Consulte a seção Perguntas Frequentes no Portal do Desenvolvedor do Celonis.
Instruções de implantação
Obrigatório Adicione instruções sobre como implantar esse conector como conector personalizado.
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 |
|---|---|---|---|
| Equipe | cadeia | Especifique a equipe do Celonis. | Verdade |
| Cluster | cadeia | Especifique o cluster Celonis. | Verdade |
| Authorization | secureString | A autorização para essa api | Verdade |
Limitações
| Nome | Chamadas | Período de renovação |
|---|---|---|
| Chamadas à API por conexão | 100 | 60 segundos |
Ações
| Atualiza uma assinatura |
Atualiza uma assinatura |
| Cancelar a assinatura de um gatilho removendo todos os dados da assinatura |
Cancelar a assinatura de um gatilho removendo todos os dados da assinatura |
| Cria uma assinatura para o gatilho |
Cria uma assinatura para o gatilho |
| Obter os detalhes do esquema de registro KM de nível superior |
Detalhes do esquema de registro de nível superior |
| Obter os detalhes do KM de nível superior |
Modelo de conhecimento definido em uma equipe do EMS |
| Obter uma lista de Assinaturas |
Lista de todas as assinaturas criadas |
| Obter uma lista de dados de registro KM |
Dados de um registro no modelo de conhecimento |
| Obter uma lista de filtros KM |
Lista de filtros para o modelo de conhecimento |
| Obter uma lista de gatilhos KM |
Lista de gatilhos para o modelo de conhecimento |
| Obter uma lista de KMs |
Lista de modelos de conhecimento definidos em uma equipe do EMS |
| Obter uma lista do esquema km records |
Lista de esquema de registros |
| Pausa a assinatura para parar de receber eventos |
Pausa a assinatura para parar de receber eventos |
| Recupera que a próxima página de eventos não foi encaminhada 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 assinatura para começar a receber novos eventos, descartando eventos de histórico |
Retoma a assinatura pausada para começar a receber novos eventos novamente, descartando eventos de histórico |
| Retoma a assinatura pausada para começar a receber eventos novamente |
Retoma a assinatura pausada para começar a receber eventos novamente |
Atualiza uma assinatura
Atualiza uma assinatura
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da assinatura
|
subscription_id | True | string |
A ID da assinatura que será totalmente atualizada |
|
headers
|
headers | object |
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, na verdade, é 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 depois que o gatilho for acionado |
|
configurações
|
configurations | array of string |
Configuração da assinatura |
|
|
nome
|
name | True | string |
Nome da assinatura |
Cancelar a assinatura de um gatilho removendo todos os dados da assinatura
Cancelar a assinatura de um gatilho removendo todos os dados da assinatura
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da assinatura
|
subscription_id | True | string |
A ID da assinatura será excluída |
Cria uma assinatura para o gatilho
Cria uma assinatura para o gatilho
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Km Id
|
km_id | True | string |
A ID do modelo de conhecimento |
|
ID do gatilho
|
trigger_id | True | string |
A ID do gatilho |
|
headers
|
headers | object |
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, na verdade, é 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 depois que o gatilho for acionado |
|
configurações
|
configurations | array of string |
Configuração da assinatura |
|
|
nome
|
name | True | string |
Nome da assinatura |
Retornos
- response
- string
Obter os detalhes do esquema de registro KM de nível superior
Detalhes do esquema de registro de nível superior
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do modelo de conhecimento
|
km_id | True | string |
ID do modelo de conhecimento |
|
ID do Registro
|
record_id | True | string |
ID do Registro |
Retornos
O registro representa um conceito dentro de um modelo de conhecimento
- Tipo de registro
- recordDTO
Obter os detalhes do KM de nível superior
Modelo de conhecimento definido em uma equipe do EMS
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do modelo de conhecimento
|
km_id | True | string |
ID do modelo de conhecimento |
Retornos
Estrutura de dados do Modelo de Conhecimento
- Modelo de conhecimento
- knowledgeModelDetailedDTO
Obter uma lista de Assinaturas
Lista de todas as assinaturas criadas
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Página
|
page | integer |
O número da página do resultado, começando em 0 (primeira página) |
|
|
Tamanho da Página
|
pageSize | integer |
O número de itens retornados em uma página. |
|
|
Classificar
|
sort | string |
Define a estratégia para prosseguir para classificação que não diferencia maiúsculas de minúsculas. Ele deve ser apenas um campo e deve começar com "+" para aplicar a ordem ASC ou "-" para aplicar a ordem DESC. O não prefixo será classificado como ASC. O campo não existente no cabeçalho gerará um erro |
Retornos
- Página de resultados do esquema de assinatura
- subscriptionResultPage
Obter uma lista de dados de registro KM
Dados de um registro no modelo de conhecimento
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do modelo de conhecimento
|
km_id | True | string |
ID do modelo de conhecimento |
|
ID do Registro
|
record_id | True | string |
ID do Registro |
|
Filtros
|
filters | array |
Uma ID de filtro predefinida |
|
|
IDs de campo
|
fields | True | array |
Uma ID de filtro predefinida |
|
Página
|
page | integer |
O número da página do resultado, começando em 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 para continuar 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. 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 |
Retornos
- Página de resultados de dados de registro
- recordResultPageDTO
Obter uma lista de filtros KM
Lista de filtros para o modelo de conhecimento
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Página
|
page | integer |
O número da página do resultado, começando em 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 para prosseguir para classificação que não diferencia maiúsculas de minúsculas. Ele deve ser apenas um campo e deve começar com "+" para aplicar a ordem ASC ou "-" para aplicar a ordem DESC. O não prefixo será classificado como ASC. O campo não existente no cabeçalho gerará um erro |
|
|
ID do modelo de conhecimento
|
km_id | True | string |
ID do modelo de conhecimento |
Retornos
- Página de resultados do esquema de filtro
- filterResultPage
Obter uma lista de gatilhos KM
Lista de gatilhos para o modelo de conhecimento
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Página
|
page | integer |
O número da página do resultado, começando em 0 (primeira página) |
|
|
Tamanho da Página
|
pageSize | integer |
O número de itens retornados em uma página. |
|
|
Classificar
|
sort | string |
Define a estratégia para prosseguir para classificação que não diferencia maiúsculas de minúsculas. Ele deve ser apenas um campo e deve começar com "+" para aplicar a ordem ASC ou "-" para aplicar a ordem DESC. O não prefixo será classificado como ASC. O campo não existente no cabeçalho gerará um erro |
|
|
Km Id
|
km_id | True | string |
A ID do modelo de conhecimento |
Retornos
- Página de resultados do esquema de gatilho
- triggerResultPage
Obter uma lista de KMs
Lista de modelos de conhecimento definidos em uma equipe do EMS
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Página
|
page | integer |
O número da página do resultado, começando em 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 para prosseguir para classificação que não diferencia maiúsculas de minúsculas. Ele deve ser apenas um campo e deve começar com "+" para aplicar a ordem ASC ou "-" para aplicar a ordem DESC. O não prefixo será classificado como ASC. O campo não existente no cabeçalho gerará um erro |
Retornos
- Página de resultados do KnowledgeModel
- knowledgeModelResultPage
Obter uma lista do esquema km records
Lista de esquema de registros
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Página
|
page | integer |
O número da página do resultado, começando em 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 para prosseguir para classificação que não diferencia maiúsculas de minúsculas. Ele deve ser apenas um campo e deve começar com "+" para aplicar a ordem ASC ou "-" para aplicar a ordem DESC. O não prefixo será classificado como ASC. O campo não existente no cabeçalho gerará um erro |
|
|
ID do modelo de conhecimento
|
km_id | True | string |
ID do modelo de conhecimento |
Retornos
- Página de resultados do esquema de registro
- recordSchemaResultPage
Pausa a assinatura para parar de receber eventos
Pausa a assinatura para parar de receber eventos
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da assinatura
|
subscription_id | True | string |
A ID da assinatura será pausada |
Recupera que a próxima página de eventos não foi encaminhada 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
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da assinatura
|
subscription_id | True | string |
A ID da assinatura que recuperará o evento com falha enviado, em um máximo de 50 itens |
Retornos
- Página de resultados do sinal
- SignalResultPage
Retoma a assinatura para começar a receber novos eventos, descartando eventos de histórico
Retoma a assinatura pausada para começar a receber novos eventos novamente, descartando eventos de histórico
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da assinatura
|
subscription_id | True | string |
A ID da assinatura será retomada sem receber eventos passados |
Retoma a assinatura pausada para começar a receber eventos novamente
Retoma a assinatura pausada para começar a receber eventos novamente
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da assinatura
|
subscription_id | True | string |
A ID da assinatura será retomada e começará a receber o evento novamente |
Definições
SignalResultPage
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
conteúdo
|
content | array of signalDTO | |
|
pageSize
|
pageSize | integer |
Tamanho da página, definido pelo sistema |
filterDTO
Filtrar para aplicar em um KM
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
descrição
|
description | string |
Descrição do filtro compreensível humano |
|
id
|
id | string |
Identificador exclusivo do filtro |
|
nome
|
name | string |
Nome de exibição filtro compreensível humano |
filterResultPage
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
página
|
page | integer |
Página |
|
pageSize
|
pageSize | integer |
Tamanho da página, definido pelo parâmetro pageSize |
|
classificar
|
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 de dados do Modelo de Conhecimento
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | string |
Identificador exclusivo do modelo de conhecimento |
|
nome
|
name | string |
Texto compreensível para humanos |
|
extendedKMId
|
extendedKMId | string |
Modelo de conhecimento usado como referência, base KM. |
knowledgeModelResultPage
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
página
|
page | integer |
Página |
|
pageSize
|
pageSize | integer |
Tamanho da página, definido pelo parâmetro pageSize |
|
classificar
|
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 de dados do Modelo de Conhecimento
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | string |
Identificador exclusivo do modelo de conhecimento |
|
nome
|
name | string |
Texto compreensível para humanos |
|
publicado
|
published | string |
Data da publicação mais recente |
recordDTO
O registro representa um conceito dentro de um modelo de conhecimento
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
descrição
|
description | string |
Descrição do registro |
|
id
|
id | string |
Identificador exclusivo do registro |
|
nome
|
name | string |
Nome de exibição do registro, um nome compreensível humano |
|
fields
|
fields | array of recordFieldDTO |
recordFieldDTO
Campos para um registro
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
format
|
format | string |
Formato a ser aplicado |
|
id
|
id | string |
Valor pendente a ser pago |
|
nome
|
name | string |
nome compreensível humano |
|
tipo
|
type | string | |
|
unidade
|
unit | string |
Unidade adicionada ao valor do campo |
recordIdDTO
ID e nome do tipo de registro
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
descrição
|
description | string |
Descrição do registro |
|
id
|
id | string |
Identificador exclusivo do registro |
|
nome
|
name | string |
Nome de exibição do registro, um nome compreensível humano |
recordItemDTO
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
dados
|
data | array of |
Lista de item de registro, composto com nome e valor |
|
headers
|
headers | array of recordItemHeaderDTO |
recordItemHeaderDTO
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
agregação
|
aggregation | boolean |
Indique se um campo é uma KPI (agregação/informações calculadas). |
|
filterable
|
filterable | boolean |
Indique se o campo pode ser filtrado. |
|
format
|
format | string |
Formatar expressão |
|
id
|
id | string |
Identidade de campo a ser usada no parâmetro de lista de campos e no parâmetro filterExpression |
|
nome
|
name | string |
Texto compreensível para humanos |
|
classificável
|
sortable | boolean |
Indique se o campo pode ser classificado. |
|
tipo
|
type | string |
Tipos de dados possíveis. |
|
unidade
|
unit | string |
Um sinal complementar para a exibição de valor de formato |
recordResultPageDTO
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
página
|
page | integer |
Página |
|
pageSize
|
pageSize | integer |
Tamanho da página, definido pelo parâmetro pageSize |
|
classificar
|
sort | array of string | |
|
total
|
total | integer |
Total de elementos retornados na página |
|
Item de Registro
|
content | recordItemDTO |
recordSchemaResultPage
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
página
|
page | integer |
Página |
|
pageSize
|
pageSize | integer |
Tamanho da página, definido pelo parâmetro pageSize |
|
classificar
|
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 assinatura
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
signal
|
signal | string |
Json bruto de um sinal |
|
subscriptionId
|
subscriptionId | string |
Identificador exclusivo do assinante como UM SUID |
|
triggerId
|
triggerId | string |
Identificador exclusivo do gatilho como UM SUID |
|
data de criação
|
creationDate | date-time |
Data da criação do sinal |
subscriptionDTO
Esquema Subscription
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
configurações
|
configurations | array of string |
Configuração da assinatura |
|
id
|
id | string |
Identificador exclusivo do assinante como UM SUID |
|
knowledgeModelId
|
knowledgeModelId | string |
Identificador exclusivo do modelo de conhecimento |
|
latestSucceedEvent
|
latestSucceedEvent | date-time |
Data do último evento bem-sucedido |
|
nome
|
name | string |
Nome da assinatura compreensível para humanos |
|
status
|
status | string | |
|
triggerId
|
triggerId | string |
Identificador exclusivo do gatilho como UM SUID |
subscriptionResultPage
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
página
|
page | integer |
Página |
|
pageSize
|
pageSize | integer |
Tamanho da página, definido pelo parâmetro pageSize |
|
classificar
|
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
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | string |
Identificador exclusivo do gatilho como UM SUID |
|
nome
|
name | string |
Nome do gatilho compreensível para humanos |
|
registro
|
record | string |
Identificador exclusivo do registro como UM SUID |
triggerResultPage
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
página
|
page | integer |
Página |
|
pageSize
|
pageSize | integer |
Tamanho da página, definido pelo parâmetro pageSize |
|
classificar
|
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
Esse é o tipo de dados básico 'string'.