Agilite (Pré-visualização)
O Agilit-e permite centralizar sua lógica e processos de negócios e expô-los como microsserviços a aplicativos novos ou existentes. Com o conector Agilit-e, você ganha acesso a muitos serviços, incluindo Business Process Management (BPM), funções, palavras-chave, modelos e muito mais.
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 | Equipe de Suporte Agilit-e |
| URL | https://agilite.io |
| support@agilite.io |
| Metadados do conector | |
|---|---|
| Editora | Agilit-e |
| Sítio Web | https://agilite.io |
| Política de privacidade | https://agilite.io/privacy-policy/ |
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 | Compartilhável |
Padrão
Aplicável: Todas as regiões
Parâmetros para criar conexão.
Esta é uma conexão compartilhável. Se o aplicativo de energia for compartilhado com outro usuário, a conexão também será compartilhada. Para obter mais informações, consulte a Visão geral de conectores para aplicativos de tela - Power Apps | Documentos Microsoft
| Nome | Tipo | Description | Obrigatório |
|---|---|---|---|
| Especifique a URL do Agilit-e API Server. (Use 'https://api.agilite.io' para Agilit-e Cloud) | cadeia (de caracteres) | Especifique a URL do Agilit-e API Server. (Use 'https://api.agilite.io' para Agilit-e Cloud) | Verdade |
| Chave API (Gerada em 'https://portal.agilite.io' em Administração) | securestring | Chave API (Gerada em 'https://portal.agilite.io' em Administração) | Verdade |
Limites de Limitação
| Name | Chamadas | Período de Renovação |
|---|---|---|
| Chamadas de API por conexão | 100 | 60 segundos |
Ações
| Atribuir função (funções) |
Atribua a função especificada pelo usuário que é aplicável a um registro específico. Um exemplo disso seria um revisor de documentos ou um aprovador de licenças |
| Executar (BPM) |
Envia uma opção em sua etapa de fluxo de trabalho atual. Dependendo das regras de negócios, o registro será progredido para a próxima etapa do processo e retornará informações sobre a próxima etapa para a api de chamada |
| Executar (Modelos) |
Processa e retorna um modelo do Agilit-e com base na 'chave de perfil' fornecida |
| Gerar Número (Numeração) |
Gera um número único com base na 'chave de perfil' fornecida |
| Obter chaves de perfil por grupo (palavras-chave) |
Devolve todas as chaves de perfil de palavra-chave com base no 'nome do grupo' fornecido |
| Obter estado de registro (BPM) |
Obter o Estado do Registro BPM para um ou mais registros para incluir o status atual, quem é responsável pelo registro, o histórico do fluxo de trabalho e outras informações para descrever o estado atual e as regras para o registro |
| Obter Função (Funções) |
Obtenha a(s) pessoa(s) responsável(eis) atribuída(s) a funções no portal de administração do Agilit-e. Essas funções não são relevantes apenas para registros ou processos de negócios específicos e são mais normalmente usadas para funções em toda a empresa na organização |
| Obter funções atribuídas (funções) |
Obter pessoa(s) responsável(is) pela função atribuída anteriormente para um registo específico |
| Obter por chave de perfil (BPM) |
Obtenha o Perfil BPM completo com configuração e opções para o processo. |
| Obter por chave de perfil (palavras-chave) |
Devolve pares Chave/Valor de um perfil de palavra-chave específico com base na 'chave de perfil' fornecida |
| Obter rótulo por valor (palavras-chave) |
Devolve uma etiqueta de palavra-chave com base na 'chave de perfil' e na 'chave de valor' fornecidas |
| Obter valor por rótulo (palavras-chave) |
Devolve um valor de palavra-chave com base na 'chave de perfil' e na 'chave de etiqueta' fornecidas |
| Registrar registro BPM (BPM) |
Registre um novo registro BPM. O registro é atribuído com um recordID que é usado para o ciclo de vida do registro para identificar o registro, seu progresso, histórico e status em todos os momentos |
Atribuir função (funções)
Atribua a função especificada pelo usuário que é aplicável a um registro específico. Um exemplo disso seria um revisor de documentos ou um aprovador de licenças
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Chave de processo
|
process-key | True | string |
Chave única para o perfil visado |
|
ID do registro BPM
|
bpm-record-id | True | string |
Identifica o registro para o qual a função está sendo definida. O id é registrado pela api registerBPMRecord para novos registros e pode ser encontrado na propriedade recordID das respostas da api BPM |
|
Usuário Atual
|
current-user | True | string |
O endereço de e-mail do usuário que está definindo a função. Normalmente, esse será o usuário que está conectado no momento de chamar a api |
|
Nome do Direito de Acesso
|
role-name | True | string |
O nome da função que está sendo atribuída. Por exemplo, Aprovador ou Revisor |
|
Utilizadores Responsáveis
|
responsible-users | True | string |
Os endereços de e-mail dos usuários atribuídos a essa função - (separados usando vírgulas) |
Devoluções
dados
- dados
- object
Executar (BPM)
Envia uma opção em sua etapa de fluxo de trabalho atual. Dependendo das regras de negócios, o registro será progredido para a próxima etapa do processo e retornará informações sobre a próxima etapa para a api de chamada
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Chave de processo
|
process-key | True | string |
Chave única para o perfil visado |
|
ID do registro BPM
|
bpm-record-id | True | string |
Identifica o registro que está sendo enviado. O id é registrado pela api registerBPMRecord para novos registros e pode ser encontrado na propriedade recordID das respostas da api BPM |
|
Opção selecionada
|
option-selected | True | string |
Identifica a opção selecionada pelo usuário para ser executada como parte do processo de envio. Esse valor deve corresponder a uma opção de etapa válida no perfil do fluxo de trabalho |
|
Usuário Atual
|
current-user | True | string |
O endereço de e-mail do usuário que está enviando a etapa BPM. Normalmente, esse será o usuário que está conectado no momento de chamar a api |
|
Comentários da etapa do fluxo de trabalho
|
comments | string |
Passa comentários para o processo de execução que serão carimbados no histórico do fluxo de trabalho. Isso normalmente seria usado se o usuário estiver rejeitando uma etapa ou solicitando mais informações |
|
|
|
object |
Devoluções
- Body
- ExecuteBPMResult
Executar (Modelos)
Processa e retorna um modelo do Agilit-e com base na 'chave de perfil' fornecida
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Chave de perfil
|
profile-key | True | string |
Chave única para o perfil visado |
|
|
object |
Devoluções
- Body
- StdJSONResponse
Gerar Número (Numeração)
Gera um número único com base na 'chave de perfil' fornecida
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Chave de perfil
|
profile-key | True | string |
Chave única para o perfil visado |
|
|
object |
Devoluções
- Body
- StdJSONResponse
Obter chaves de perfil por grupo (palavras-chave)
Devolve todas as chaves de perfil de palavra-chave com base no 'nome do grupo' fornecido
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Nome do Grupo
|
group-name | True | string |
O nome do grupo usado para agrupar perfis de palavras-chave |
|
Ordenar
|
sort | string |
Um parâmetro opcional para classificar o resultado de chave/valor retornado |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
|
array of string |
Obter estado de registro (BPM)
Obter o Estado do Registro BPM para um ou mais registros para incluir o status atual, quem é responsável pelo registro, o histórico do fluxo de trabalho e outras informações para descrever o estado atual e as regras para o registro
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Chaves de processo
|
process-keys | string |
Filtre para identificar o(s) processo(s) comercial(is) para o(s) qual(is) os registros serão retornados. Esta chave pode ser encontrada no perfil BPM no Portal de Administração Agilit-e - (separado usando vírgulas) |
|
|
Ids de registro BPM
|
bpm-record-ids | string |
filtro para retornar somente registros com recordIds específicos. O recordId é registrado pela api registerBPMRecord para novos registros e pode ser encontrado na propriedade recordID das respostas da api BPM - (separar usando vírgulas) |
|
|
Nomes das etapas
|
step-names | string |
Filtrar para retornar somente os registros que estão atualmente para a(s) etapa(s) de fluxo de trabalho especificada(s) - (separar usando vírgulas) |
|
|
Utilizadores Responsáveis
|
responsible-users | string |
Filtrar para retornar apenas os registros que estão atualmente atribuídos ao(s) endereço(s) de e-mail especificado(s) - (separar usando vírgulas) |
|
|
Utilizadores Relevantes
|
relevant-users | string |
Filtrar para retornar somente registros que são relevantes para o(s) endereço(s) de e-mail especificado(s) - (separar usando vírgulas) |
|
|
Incluir História
|
include-history | boolean |
Especifique se o objeto de histórico deve ser retornado com as informações de estado do registro |
|
|
Incluir opções de etapa
|
include-step-options | boolean |
Especifique se o objeto de opções de etapa deve ser retornado com as informações de estado do registro |
|
|
Incluir objetos visíveis
|
include-visible-objects | boolean |
Especifique se o objeto de objetos visíveis deve ser retornado com as informações de estado do registro |
Devoluções
- Itens
- GetBPMRecordState
Obter Função (Funções)
Obtenha a(s) pessoa(s) responsável(eis) atribuída(s) a funções no portal de administração do Agilit-e. Essas funções não são relevantes apenas para registros ou processos de negócios específicos e são mais normalmente usadas para funções em toda a empresa na organização
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Nomes de funções
|
role-names | True | string |
Especifique o(s) nome(s) de função para o(s) qual(is) você deseja recuperar os usuários responsáveis - (separar usando vírgulas) |
|
Níveis condicionais
|
conditional-levels | string |
Especifique níveis adicionais que podem ser usados para determinar a pessoa correta para a função. Um exemplo de nível pode ser um nome de departamento (se você quiser recuperar o Gerente de Departamento) ou um nome de produto (se quiser recuperar o Gerente de Produto) - (separado usando vírgulas) |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Utilizadores responsáveis
|
responsibleUsers | array of string |
Utilizadores responsáveis |
Obter funções atribuídas (funções)
Obter pessoa(s) responsável(is) pela função atribuída anteriormente para um registo específico
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Chave de processo
|
process-key | True | string |
Chave única para o perfil visado |
|
ID do registro BPM
|
bpm-record-id | True | string |
Identifica o registro para o qual a função está sendo definida. O id é registrado pela api registerBPMRecord para novos registros e pode ser encontrado na propriedade recordID das respostas da api BPM |
|
Nome do Direito de Acesso
|
role-names | True | string |
A(s) função(ões) a ser consultada (separar usando vírgulas) |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
|
array of object | ||
|
Nome
|
name | string | |
|
Utilizadores
|
users | array of object | |
|
Email
|
users.email | string |
Obter por chave de perfil (BPM)
Obtenha o Perfil BPM completo com configuração e opções para o processo.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Chave de perfil
|
profile-key | True | string |
Chave única para o perfil visado |
Devoluções
- Body
- GetBPMProfile
Obter por chave de perfil (palavras-chave)
Devolve pares Chave/Valor de um perfil de palavra-chave específico com base na 'chave de perfil' fornecida
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Chave de perfil
|
profile-key | True | string |
Chave única para o perfil visado |
|
Ordenar
|
sort | string |
Um parâmetro opcional para classificar o resultado de chave/valor retornado |
Devoluções
- Itens
- KeywordValues
Obter rótulo por valor (palavras-chave)
Devolve uma etiqueta de palavra-chave com base na 'chave de perfil' e na 'chave de valor' fornecidas
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Chave de perfil
|
profile-key | True | string |
Chave única para o perfil visado |
|
Chave de Valor
|
value-key | True | string |
A chave Valor na listagem Rótulo/Valor para o perfil de destino |
Devoluções
- Body
- StdJSONResponse
Obter valor por rótulo (palavras-chave)
Devolve um valor de palavra-chave com base na 'chave de perfil' e na 'chave de etiqueta' fornecidas
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Chave de perfil
|
profile-key | True | string |
Chave única para o perfil visado |
|
Chave do rótulo
|
label-key | True | string |
A chave Label na listagem Label/Value para o perfil de destino |
Devoluções
- Body
- StdJSONResponse
Registrar registro BPM (BPM)
Registre um novo registro BPM. O registro é atribuído com um recordID que é usado para o ciclo de vida do registro para identificar o registro, seu progresso, histórico e status em todos os momentos
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Chave de processo
|
process-key | True | string |
Chave única para o perfil visado |
|
Usuário Atual
|
current-user | True | string |
O endereço de e-mail do usuário que está registrando o registro. Normalmente, esse será o usuário que está conectado no momento de chamar a api |
Devoluções
- Body
- RegisterBPMRecord
Definições
ExecuteBPMResult
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Descrição da etapa do processo
|
description | string |
Uma breve descrição explicando a etapa do processo |
|
Duração do SLA (Hrs)
|
duration | string |
A duração do SLA em horas. Forneça um valor de 0 se não for aplicável |
|
Carimbo de evento da etapa do processo
|
eventStamp | string |
Um carimbo de evento para a etapa atual do processo |
|
Instruções do passo
|
instructions | string |
Instruções para o Utilizador Responsável durante o Passo |
|
Chave de passo do processo
|
key | string |
Uma chave única para identificar a etapa do processo |
|
Nome da etapa do processo
|
name | string |
Um nome curto para a etapa do processo |
|
Chave de perfil BPM
|
processKey | string |
Uma chave única para identificar o Perfil BPM |
|
Fase de Processo
|
processStage | string |
Uma chave que define o estágio do processo da etapa atual |
|
Tipo de Responsabilidade
|
responsibility | string |
Responsabilidade baseada no utilizador/função |
|
Papel Responsável da Etapa do Processo
|
responsibleRole | string |
A função responsável pela etapa atual do processo |
|
Etapa do processo Usuários responsáveis
|
responsibleUsers | array of string |
Os usuários responsáveis pela etapa atual do processo |
|
stepOptions
|
stepOptions | array of object | |
|
Descrição da opção Step
|
stepOptions.description | string |
Uma breve descrição explicando a opção Step |
|
Opção de Etapa: Carimbo de Evento
|
stepOptions.eventStamp | array of string |
Um carimbo de evento para a opção de etapa atual |
|
Nome da opção de etapa
|
stepOptions.name | string |
Um nome curto para a opção Step |
|
Próximo Passo
|
stepOptions.nextStep | string |
A próxima etapa para a qual o processo de negócios será encaminhado. Deixar vazio se não houver mais passos |
|
Notas de opção de passo
|
stepOptions.notes | string |
Notas opcionais para a opção Step |
|
visibleObjects
|
stepOptions.visibleObjects | array of object | |
|
ID do objeto de opção de etapa
|
stepOptions.visibleObjects.id | string |
A id do componente que é referenciado na interface do usuário |
|
choices
|
stepOptions.visibleObjects.inputOptions.choices | array of object | |
|
Opções Tipo Rótulo
|
stepOptions.visibleObjects.inputOptions.choices.label | string |
Um rótulo para a escolha selecionada |
|
Opções Tipo Valor
|
stepOptions.visibleObjects.inputOptions.choices.value | string |
Um valor para a escolha selecionada |
|
Rótulo de opções de entrada
|
stepOptions.visibleObjects.inputOptions.label | string |
Um rótulo que define o campo de entrada ou o componente editável |
|
Mensagens de opções de entrada
|
stepOptions.visibleObjects.inputOptions.messages | array of string |
Mensagens a serem usadas quando a validação das Opções de Entrada falhar |
|
Tipo de opções de entrada
|
stepOptions.visibleObjects.inputOptions.type | string |
Define o tipo de campo de entrada ou componente editável a ser usado |
|
O objeto Step Option é editável
|
stepOptions.visibleObjects.isEditable | boolean |
O componente referenciado é editável para entrada do usuário |
|
O objeto Step Option é obrigatório
|
stepOptions.visibleObjects.isMandatory | boolean |
O componente referenciado requer a entrada do usuário |
|
visibleObjects
|
visibleObjects | array of object | |
|
ID do objeto da etapa do processo
|
visibleObjects.id | string |
A id do componente que é referenciado na interface do usuário |
|
choices
|
visibleObjects.inputOptions.choices | array of object | |
|
Opções Tipo Rótulo
|
visibleObjects.inputOptions.choices.label | string |
Um rótulo para a escolha selecionada |
|
Opções Tipo Valor
|
visibleObjects.inputOptions.choices.value | string |
Um valor para a escolha selecionada |
|
Rótulo de opções de entrada
|
visibleObjects.inputOptions.label | string |
Um rótulo que define o campo de entrada ou o componente editável |
|
Mensagens de opções de entrada
|
visibleObjects.inputOptions.messages | array of string |
Mensagens a serem usadas quando a validação das Opções de Entrada falhar |
|
Tipo de opções de entrada
|
visibleObjects.inputOptions.type | string |
Define o tipo de campo de entrada ou componente editável a ser usado |
|
O objeto Process Step é editável
|
visibleObjects.isEditable | boolean |
O componente referenciado é editável para entrada do usuário |
|
O objeto da etapa do processo é obrigatório
|
visibleObjects.isMandatory | boolean |
O componente referenciado requer a entrada do usuário |
GetBPMProfile
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
appAdmin
|
appAdmin | array of object | |
|
E-mail do administrador do aplicativo
|
appAdmin.email | string |
Um endereço de e-mail para o administrador do perfil BPM atual |
|
URL do aplicativo BPM
|
appUrl | string |
Uma url opcional para o aplicativo que usa o perfil BPM atual |
|
Descrição do perfil BPM
|
description | string |
Uma breve descrição explicando o perfil BPM |
|
Nome do Grupo de Perfis BPM
|
groupName | string |
Um agrupamento opcional para o perfil BPM |
|
Chave de perfil BPM
|
key | string |
Uma chave única para identificar o Perfil BPM |
|
Nome do perfil BPM
|
name | string |
Um nome curto para o perfil BPM |
|
Notas de perfil BPM
|
notes | string |
Notas opcionais para o perfil BPM |
|
processPassos
|
processSteps | array of object | |
|
Descrição da etapa do processo
|
processSteps.description | string |
Uma breve descrição explicando a etapa do processo |
|
Duração do SLA (Hrs)
|
processSteps.duration | string |
A duração do SLA em horas. Forneça um valor de 0 se não for aplicável |
|
É o primeiro passo
|
processSteps.firstStep | boolean |
Especifique se o registro da etapa do processo é a primeira etapa do processo de negócios |
|
Instruções do passo
|
processSteps.instructions | string |
Instruções para o Utilizador Responsável durante o Passo |
|
Chave de passo do processo
|
processSteps.key | string |
Uma chave única para identificar a etapa do processo |
|
Nome da etapa do processo
|
processSteps.name | string |
Um nome curto para a etapa do processo |
|
Fase de Processo
|
processSteps.processStage | string |
Uma chave que define o estágio do processo da etapa atual |
|
URL de referência da etapa do processo
|
processSteps.referenceUrl | string |
Um URL de referência para a etapa do processo |
|
Tipo de Responsabilidade
|
processSteps.responsibility | string |
Responsabilidade baseada no utilizador/função |
|
Papel Responsável da Etapa do Processo
|
processSteps.responsibleRole | string |
A função responsável pela etapa atual |
|
roleLevels
|
processSteps.roleLevels | array of string |
Níveis de função condicional |
|
stepOptions
|
processSteps.stepOptions | array of object | |
|
Descrição da opção Step
|
processSteps.stepOptions.description | string |
Uma breve descrição explicando a opção Step |
|
Nome da opção de etapa
|
processSteps.stepOptions.name | string |
Um nome curto para a opção Step |
|
Próximo Passo
|
processSteps.stepOptions.nextStep | string |
A próxima etapa para a qual o processo de negócios será encaminhado. Deixar vazio se não houver mais passos |
|
Notas de opção de passo
|
processSteps.stepOptions.notes | string |
Notas opcionais para a opção Step |
|
visibleObjects
|
processSteps.stepOptions.visibleObjects | array of object | |
|
ID do objeto de opção de etapa
|
processSteps.stepOptions.visibleObjects.id | string |
A id do componente que é referenciado na interface do usuário |
|
choices
|
processSteps.stepOptions.visibleObjects.inputOptions.choices | array of object | |
|
Opções Tipo Rótulo
|
processSteps.stepOptions.visibleObjects.inputOptions.choices.label | string |
Um rótulo para a escolha selecionada |
|
Opções Tipo Valor
|
processSteps.stepOptions.visibleObjects.inputOptions.choices.value | string |
Um valor para a escolha selecionada |
|
Rótulo de opções de entrada
|
processSteps.stepOptions.visibleObjects.inputOptions.label | string |
Um rótulo que define o campo de entrada ou o componente editável |
|
Mensagens de opções de entrada
|
processSteps.stepOptions.visibleObjects.inputOptions.messages | array of string |
Mensagens a serem usadas quando a validação das Opções de Entrada falhar |
|
Tipo de opções de entrada
|
processSteps.stepOptions.visibleObjects.inputOptions.type | string |
Define o tipo de campo de entrada ou componente editável a ser usado |
|
O objeto Step Option é editável
|
processSteps.stepOptions.visibleObjects.isEditable | boolean |
O componente referenciado é editável para entrada do usuário |
|
O objeto Step Option é obrigatório
|
processSteps.stepOptions.visibleObjects.isMandatory | boolean |
O componente referenciado requer a entrada do usuário |
|
visibleObjects
|
processSteps.visibleObjects | array of object | |
|
ID do objeto da etapa do processo
|
processSteps.visibleObjects.id | string |
A id do componente que é referenciado na interface do usuário |
|
choices
|
processSteps.visibleObjects.inputOptions.choices | array of object | |
|
Opções Tipo Rótulo
|
processSteps.visibleObjects.inputOptions.choices.label | string |
Um rótulo para a escolha selecionada |
|
Opções Tipo Valor
|
processSteps.visibleObjects.inputOptions.choices.value | string |
Um valor para a escolha selecionada |
|
Rótulo de opções de entrada
|
processSteps.visibleObjects.inputOptions.label | string |
Um rótulo que define o campo de entrada ou o componente editável |
|
Mensagens de opções de entrada
|
processSteps.visibleObjects.inputOptions.messages | array of string |
Mensagens a serem usadas quando a validação das Opções de Entrada falhar |
|
Tipo de opções de entrada
|
processSteps.visibleObjects.inputOptions.type | string |
Define o tipo de campo de entrada ou componente editável a ser usado |
|
O objeto Process Step é editável
|
processSteps.visibleObjects.isEditable | boolean |
O componente referenciado é editável para entrada do usuário |
|
O objeto da etapa do processo é obrigatório
|
processSteps.visibleObjects.isMandatory | boolean |
O componente referenciado requer a entrada do usuário |
|
URL de referência do perfil BPM
|
referenceUrl | string |
Uma url opcional que pode ser referenciada para o perfil BPM atual |
GetBPMRecordState
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Descrição da etapa do processo
|
description | string |
Uma breve descrição explicando a etapa do processo |
|
Duração do SLA (Hrs)
|
duration | string |
A duração do SLA em horas. Forneça um valor de 0 se não for aplicável |
|
eventoStampHistory
|
eventStampHistory | array of object | |
|
Nome do histórico de carimbos do evento
|
eventStampHistory.eventName | string |
Nome do carimbo do evento |
|
Carimbo de data/hora do histórico de carimbos de evento
|
eventStampHistory.timeStamp | date-time |
O carimbo de data/hora de quando o carimbo de evento ocorreu |
|
histórico
|
history | array of object | |
|
Comentários de História
|
history.comments | string |
Comentários opcionais adicionados no momento em que a entrada Histórico foi criada |
|
História Papel Atual
|
history.currentRole | string |
O papel atual no momento da entrada História |
|
Histórico Usuário Atual
|
history.currentUser | string |
O Usuário atual no momento da entrada do Histórico |
|
Duração do passo
|
history.duration | string |
O tempo (em minutos) em que o registro existia na etapa do processo atual antes de ser acionado |
|
Carimbo do Evento Histórico
|
history.eventStamp | array of string |
Carimbo de evento que ocorreu no momento da entrada do Histórico |
|
Do Passo
|
history.fromStep | string |
A chave da etapa do processo: o registro BPM veio no momento da entrada do Histórico; |
|
Do Nome da Etapa
|
history.fromStepName | string |
O nome da etapa do processo do registro BPM veio no momento da entrada do histórico |
|
Opção Histórico Selecionada
|
history.optionSelected | string |
A opção selecionada ao acionar o registro BPM |
|
Histórico da chave de processo BPM
|
history.processKey | string |
A chave de processo BPM exclusiva para a entrada Histórico |
|
Etapa do processo histórico
|
history.processStage | string |
A etapa do Processo no momento da entrada de História |
|
Histórico BPM Record Id
|
history.recordId | string |
A ID de registro para o registro relacionado ao BPM gerado durante o processo de registro BPM |
|
Papel responsável pela história
|
history.responsibleRole | string |
O papel responsável do Registro BPM no momento da entrada do Histórico |
|
Histórico de Usuários Responsáveis
|
history.responsibleUsers | array of string |
Utilizador(es) responsável(eis) no momento da entrada no Histórico |
|
Data de Submissão do Histórico
|
history.submissionDate | date-time |
A data/hora em que o registro BPM foi acionado |
|
Para o estágio do processo
|
history.toProcessStage | string |
A etapa do processo para o registro BPM no momento da entrada do histórico |
|
Para o passo
|
history.toStep | string |
A chave da etapa do processo para o registro BPM no momento da entrada do histórico |
|
Para o nome da etapa
|
history.toStepName | string |
O nome da etapa do processo para o registro BPM no momento da entrada Histórico |
|
Instruções do passo
|
instructions | string |
Instruções para o Utilizador Responsável durante o Passo |
|
Chave de passo do processo
|
key | string |
Uma chave única para identificar a etapa do processo |
|
Nome da etapa do processo
|
name | string |
Um nome curto para a etapa do processo |
|
Chave de perfil BPM
|
processKey | string |
Uma chave única para identificar o Perfil BPM |
|
Fase de Processo
|
processStage | string |
Uma chave que define o estágio do processo da etapa atual |
|
ID do registro BPM
|
recordId | string |
A id de registro gerada pelo módulo BPM ao registrar um registro BPM |
|
Referência de registro BPM
|
recordRef | string |
Um número legível gerado pelo módulo BPM usando o módulo Numeração ao registrar um registro BPM |
|
URL de referência da etapa do processo
|
referenceUrl | string |
Um URL de referência para a etapa do processo |
|
Papel Responsável da Etapa do Processo
|
responsibleRole | string |
A função responsável pela etapa atual |
|
Etapa do processo Usuários responsáveis
|
responsibleUsers | array of string |
Usuário(s) responsável(eis) pela etapa atual do processo |
|
roles
|
roles | array of object | |
|
Nome do Direito de Acesso
|
roles.name | string |
Nome da função |
|
users
|
roles.users | array of object | |
|
E-mail da função
|
roles.users.email | string |
Endereço(s) de e-mail vinculado(s) ao nome da função |
|
stepOptions
|
stepOptions | array of object | |
|
Descrição da opção Step
|
stepOptions.description | string |
Uma breve descrição explicando a opção Step |
|
Opção de Etapa: Carimbo de Evento
|
stepOptions.eventStamp | array of string |
Um carimbo de evento para a opção de etapa atual |
|
Nome da opção de etapa
|
stepOptions.name | string |
Um nome curto para a opção Step |
|
Próximo Passo
|
stepOptions.nextStep | string |
A próxima etapa para a qual o processo de negócios será encaminhado. Deixar vazio se não houver mais passos |
|
Notas de opção de passo
|
stepOptions.notes | string |
Notas opcionais para a opção Step |
|
visibleObjects
|
stepOptions.visibleObjects | array of object | |
|
ID do objeto de opção de etapa
|
stepOptions.visibleObjects.id | string |
A id do componente que é referenciado na interface do usuário |
|
choices
|
stepOptions.visibleObjects.inputOptions.choices | array of object | |
|
Opções Tipo Rótulo
|
stepOptions.visibleObjects.inputOptions.choices.label | string |
Um rótulo para a escolha selecionada |
|
Opções Tipo Valor
|
stepOptions.visibleObjects.inputOptions.choices.value | string |
Um valor para a escolha selecionada |
|
Rótulo de opções de entrada
|
stepOptions.visibleObjects.inputOptions.label | string |
Um rótulo que define o campo de entrada ou o componente editável |
|
Mensagens de opções de entrada
|
stepOptions.visibleObjects.inputOptions.messages | array of string |
Mensagens a serem usadas quando a validação das Opções de Entrada falhar |
|
Tipo de opções de entrada
|
stepOptions.visibleObjects.inputOptions.type | string |
Define o tipo de campo de entrada ou componente editável a ser usado |
|
O objeto Step Option é editável
|
stepOptions.visibleObjects.isEditable | boolean |
O componente referenciado é editável para entrada do usuário |
|
O objeto Step Option é obrigatório
|
stepOptions.visibleObjects.isMandatory | boolean |
O componente referenciado requer a entrada do usuário |
|
Enviado em etapa
|
submittedIntoStep | date-time |
A data/hora em que o registro BPM foi enviado para a etapa atual do processo |
|
Duração do Tempo Alvo
|
targetTimeDuration | date-time |
A data/hora em que o registro BPM precisa ser acionado com base na Duração do SLA |
|
visibleObjects
|
visibleObjects | array of object | |
|
ID do objeto da etapa do processo
|
visibleObjects.id | string |
A id do componente que é referenciado na interface do usuário |
|
choices
|
visibleObjects.inputOptions.choices | array of object | |
|
Opções Tipo Rótulo
|
visibleObjects.inputOptions.choices.label | string |
Um rótulo para a escolha selecionada |
|
Opções Tipo Valor
|
visibleObjects.inputOptions.choices.value | string |
Um valor para a escolha selecionada |
|
Rótulo de opções de entrada
|
visibleObjects.inputOptions.label | string |
Um rótulo que define o campo de entrada ou o componente editável |
|
Mensagens de opções de entrada
|
visibleObjects.inputOptions.messages | array of string |
Mensagens a serem usadas quando a validação das Opções de Entrada falhar |
|
Tipo de opções de entrada
|
visibleObjects.inputOptions.type | string |
Define o tipo de campo de entrada ou componente editável a ser usado |
|
O objeto Process Step é editável
|
visibleObjects.isEditable | boolean |
O componente referenciado é editável para entrada do usuário |
|
O objeto da etapa do processo é obrigatório
|
visibleObjects.isMandatory | boolean |
O componente referenciado requer a entrada do usuário |
Valores-chavePalavra-chave
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Etiqueta
|
label | string | |
|
Valor
|
value | string |
RegistoBPMRecord
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Descrição da etapa do processo
|
description | string |
Uma breve descrição explicando a etapa do processo |
|
Duração do SLA (Hrs)
|
duration | string |
A duração do SLA em horas. Forneça um valor de 0 se não for aplicável |
|
eventoStampHistory
|
eventStampHistory | array of object | |
|
Nome do histórico de carimbos do evento
|
eventStampHistory.eventName | string |
Nome do carimbo do evento |
|
Carimbo de data/hora do histórico de carimbos de evento
|
eventStampHistory.timeStamp | date-time |
O carimbo de data/hora de quando o carimbo de evento ocorreu |
|
histórico
|
history | array of object | |
|
Comentários de História
|
history.comments | string |
Comentários opcionais adicionados no momento em que a entrada Histórico foi criada |
|
História Papel Atual
|
history.currentRole | string |
O papel atual no momento da entrada História |
|
Histórico Usuário Atual
|
history.currentUser | string |
O Usuário atual no momento da entrada do Histórico |
|
Duração do passo
|
history.duration | string |
O tempo (em minutos) em que o registro existia na etapa do processo atual antes de ser acionado |
|
Carimbo do Evento Histórico
|
history.eventStamp | array of string |
Carimbo de evento que ocorreu no momento da entrada do Histórico |
|
Do Passo
|
history.fromStep | string |
A chave da etapa do processo: o registro BPM veio no momento da entrada do Histórico; |
|
Do Nome da Etapa
|
history.fromStepName | string |
O nome da etapa do processo do registro BPM veio no momento da entrada do histórico |
|
Opção Histórico Selecionada
|
history.optionSelected | string |
A opção selecionada ao acionar o registro BPM |
|
Histórico da chave de processo BPM
|
history.processKey | string |
A chave de processo BPM exclusiva para a entrada Histórico |
|
Etapa do processo histórico
|
history.processStage | string |
A etapa do Processo no momento da entrada de História |
|
Histórico BPM Record Id
|
history.recordId | string |
A ID de registro para o registro relacionado ao BPM gerado durante o processo de registro BPM |
|
Papel responsável pela história
|
history.responsibleRole | string |
O papel responsável do Registro BPM no momento da entrada do Histórico |
|
Histórico de Usuários Responsáveis
|
history.responsibleUsers | array of string |
Utilizador(es) responsável(eis) no momento da entrada no Histórico |
|
Data de Submissão do Histórico
|
history.submissionDate | date-time |
A data/hora em que o registro BPM foi acionado |
|
Para o estágio do processo
|
history.toProcessStage | string |
A etapa do processo para o registro BPM no momento da entrada do histórico |
|
Para o passo
|
history.toStep | string |
A chave da etapa do processo para o registro BPM no momento da entrada do histórico |
|
Para o nome da etapa
|
history.toStepName | string |
O nome da etapa do processo para o registro BPM no momento da entrada Histórico |
|
Instruções do passo
|
instructions | string |
Instruções para o Utilizador Responsável durante o Passo |
|
Chave de passo do processo
|
key | string |
Uma chave única para identificar a etapa do processo |
|
Nome da etapa do processo
|
name | string |
Um nome curto para a etapa do processo |
|
Chave de perfil BPM
|
processKey | string |
Uma chave única para identificar o Perfil BPM |
|
Fase de Processo
|
processStage | string |
Uma chave que define o estágio do processo da etapa atual |
|
ID do registro BPM
|
recordId | string |
A id de registro gerada pelo módulo BPM ao registrar um registro BPM |
|
Referência de registro BPM
|
recordRef | string |
Um número legível gerado pelo módulo BPM usando o módulo Numeração ao registrar um registro BPM |
|
URL de referência da etapa do processo
|
referenceUrl | string |
Um URL de referência para a etapa do processo |
|
Papel Responsável da Etapa do Processo
|
responsibleRole | string |
A função responsável pela etapa atual do processo |
|
Etapa do processo Usuários responsáveis
|
responsibleUsers | array of string |
Os usuários responsáveis pela etapa atual do processo |
|
roles
|
roles | array of object | |
|
Nome do Direito de Acesso
|
roles.name | string |
Nome da função |
|
users
|
roles.users | array of object | |
|
E-mail da função
|
roles.users.email | string |
Endereço(s) de e-mail vinculado(s) ao nome da função |
|
stepOptions
|
stepOptions | array of object | |
|
Descrição da opção Step
|
stepOptions.description | string |
Uma breve descrição explicando a opção Step |
|
Opção de Etapa: Carimbo de Evento
|
stepOptions.eventStamp | array of string |
Um carimbo de evento para a opção de etapa atual |
|
Nome da opção de etapa
|
stepOptions.name | string |
Um nome curto para a opção Step |
|
Próximo Passo
|
stepOptions.nextStep | string |
A próxima etapa para a qual o processo de negócios será encaminhado. Deixar vazio se não houver mais passos |
|
Notas de opção de passo
|
stepOptions.notes | string |
Notas opcionais para a opção Step |
|
visibleObjects
|
stepOptions.visibleObjects | array of object | |
|
ID do objeto de opção de etapa
|
stepOptions.visibleObjects.id | string |
A id do componente que é referenciado na interface do usuário |
|
choices
|
stepOptions.visibleObjects.inputOptions.choices | array of object | |
|
Opções Tipo Rótulo
|
stepOptions.visibleObjects.inputOptions.choices.label | string |
Um rótulo para a escolha selecionada |
|
Opções Tipo Valor
|
stepOptions.visibleObjects.inputOptions.choices.value | string |
Um valor para a escolha selecionada |
|
Rótulo de opções de entrada
|
stepOptions.visibleObjects.inputOptions.label | string |
Um rótulo que define o campo de entrada ou o componente editável |
|
Mensagens de opções de entrada
|
stepOptions.visibleObjects.inputOptions.messages | array of string |
Mensagens a serem usadas quando a validação das Opções de Entrada falhar |
|
Tipo de opções de entrada
|
stepOptions.visibleObjects.inputOptions.type | string |
Define o tipo de campo de entrada ou componente editável a ser usado |
|
O objeto Step Option é editável
|
stepOptions.visibleObjects.isEditable | boolean |
O componente referenciado é editável para entrada do usuário |
|
O objeto Step Option é obrigatório
|
stepOptions.visibleObjects.isMandatory | boolean |
O componente referenciado requer a entrada do usuário |
|
visibleObjects
|
visibleObjects | array of object | |
|
ID do objeto da etapa do processo
|
visibleObjects.id | string |
A id do componente que é referenciado na interface do usuário |
|
choices
|
visibleObjects.inputOptions.choices | array of object | |
|
Opções Tipo Rótulo
|
visibleObjects.inputOptions.choices.label | string |
Um rótulo para a escolha selecionada |
|
Opções Tipo Valor
|
visibleObjects.inputOptions.choices.value | string |
Um valor para a escolha selecionada |
|
Rótulo de opções de entrada
|
visibleObjects.inputOptions.label | string |
Um rótulo que define o campo de entrada ou o componente editável |
|
Mensagens de opções de entrada
|
visibleObjects.inputOptions.messages | array of string |
Mensagens a serem usadas quando a validação das Opções de Entrada falhar |
|
Tipo de opções de entrada
|
visibleObjects.inputOptions.type | string |
Define o tipo de campo de entrada ou componente editável a ser usado |
|
O objeto Process Step é editável
|
visibleObjects.isEditable | boolean |
O componente referenciado é editável para entrada do usuário |
|
O objeto da etapa do processo é obrigatório
|
visibleObjects.isMandatory | boolean |
O componente referenciado requer a entrada do usuário |
StdJSONResponse
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Result
|
result | string |
Result |
objecto
Este é o tipo 'objeto'.