Agilidade (versão prévia)
A agilidade permite centralizar sua lógica de negócios e processos e expô-los como microsserviços para aplicativos novos ou existentes. Com o conector Agilit-e, você obtém acesso a muitos serviços, incluindo BPM (Business Process Management), Roles, Keywords, Templates e muito mais.
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 | Equipe de suporte do Agilit-e |
| URL | https://agilite.io |
| support@agilite.io |
| Metadados do conector | |
|---|---|
| Publicador | Agilidade-e |
| Site | https://agilite.io |
| Política de privacidade | https://agilite.io/privacy-policy/ |
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 | Compartilhável |
Padrão
Aplicável: todas as regiões
Parâmetros para criar conexão.
Essa é 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 dos Conectores para aplicativos de tela – Power Apps | Microsoft Docs
| Nome | Tipo | Description | Obrigatório |
|---|---|---|---|
| Especifique a URL do Servidor de API de Agilidade. (Use 'https://api.agilite.io' para a nuvem De agilidade) | cadeia | Especifique a URL do Servidor de API de Agilidade. (Use 'https://api.agilite.io' para a nuvem De agilidade) | Verdade |
| Chave de API (gerada em 'https://portal.agilite.io' em Administração) | secureString | Chave de API (gerada em 'https://portal.agilite.io' em Administração) | Verdade |
Limitações
| Nome | Chamadas | Período de renovação |
|---|---|---|
| Chamadas à API por conexão | 100 | 60 segundos |
Ações
| Atribuir função (funções) |
Atribua a função especificada pelo usuário aplicável a um registro específico. Um exemplo disso seria um revisor de documentos ou um aprovador de licença |
| Executar (BPM) |
Envia uma opção na etapa atual do fluxo de trabalho. Dependendo das regras de negócios, o registro será progredido para a próxima etapa no processo e retornará informações sobre a próxima etapa para a api de chamada |
| Executar (modelos) |
Processa e retorna um modelo da Agilit-e com base na 'chave de perfil' fornecida |
| Gerar Número (Numeração) |
Gera um número exclusivo com base na 'chave de perfil' fornecida |
| Obter chaves de perfil por grupo (palavras-chave) |
Retorna todas as chaves de perfil de palavra-chave com base no 'nome do grupo' fornecido |
| Obter estado de registro (BPM) |
Obtenha o estado de registro bpm para um ou mais registros para incluir o status atual, quem é responsável pelo registro, o histórico de fluxo de trabalho e outras informações para descrever o estado e as regras atuais para o registro |
| Obter função (funções) |
Obtenha pessoas responsáveis atribuídas a funções no portal de administração do Agilit-e. Essas funções não são apenas relevantes para registros específicos ou processos de negócios e são mais normalmente usadas para funções de toda a empresa na organização |
| Obter funções atribuídas (funções) |
Obter pessoas responsáveis para a função atribuída anteriormente para um registro específico |
| Obter por chave de perfil (BPM) |
Obtenha o perfil completo do BPM com configuração e opções para o processo. |
| Obter por chave de perfil (palavras-chave) |
Retorna 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) |
Retorna um rótulo de palavra-chave com base em 'profile-key' e 'value-key' fornecidos |
| Obter valor por rótulo (palavras-chave) |
Retorna um valor de palavra-chave com base em 'profile-key' e 'label-key' fornecidos |
| Registrar registro BPM (BPM) |
Registre o novo registro BPM. O registro é atribuído com uma recordID que é usada para o ciclo de vida do registro para identificar o registro, seu progresso, histórico e status em todos os tempos |
Atribuir função (funções)
Atribua a função especificada pelo usuário aplicável a um registro específico. Um exemplo disso seria um revisor de documentos ou um aprovador de licença
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Chave de processo
|
process-key | True | string |
Chave Exclusiva para o perfil de destino |
|
ID do registro BPM
|
bpm-record-id | True | string |
Identifica o registro para o qual a função está sendo definida. A ID é registrada pela api registerBPMRecord para novos registros e pode ser encontrada na propriedade recordID das respostas da API do BPM |
|
Usuário Atual
|
current-user | True | string |
O endereço de email do usuário que está definindo a função. Normalmente, esse será o usuário que está conectado no momento da chamada à API |
|
Nome da Função
|
role-name | True | string |
O nome da função que está sendo atribuída. Por exemplo, Aprovador ou Revisor |
|
Usuários Responsáveis
|
responsible-users | True | string |
Os endereços de email dos usuários atribuídos a essa função – (separados usando vírgulas) |
Retornos
dados
- dados
- object
Executar (BPM)
Envia uma opção na etapa atual do fluxo de trabalho. Dependendo das regras de negócios, o registro será progredido para a próxima etapa no processo e retornará informações sobre a próxima etapa para a api de chamada
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Chave de processo
|
process-key | True | string |
Chave Exclusiva para o perfil de destino |
|
ID do registro BPM
|
bpm-record-id | True | string |
Identifica o registro que está sendo enviado. A ID é registrada pela api registerBPMRecord para novos registros e pode ser encontrada na propriedade recordID das respostas da API do BPM |
|
Opção Selecionada
|
option-selected | True | string |
Identifica a opção selecionada pelo usuário a ser executada como parte do processo de envio. Esse valor deve corresponder a uma opção de etapa válida no perfil de fluxo de trabalho |
|
Usuário Atual
|
current-user | True | string |
O endereço de email do usuário que está enviando a etapa BPM. Normalmente, esse será o usuário que está conectado no momento da chamada à API |
|
Comentários da etapa de fluxo de trabalho
|
comments | string |
Passa comentários para o processo de execução que será carimbado no histórico do fluxo de trabalho. Isso normalmente seria usado se o usuário rejeitasse uma etapa ou solicitasse mais informações |
|
|
|
object |
Retornos
- Corpo
- ExecuteBPMResult
Executar (modelos)
Processa e retorna um modelo da Agilit-e com base na 'chave de perfil' fornecida
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Chave de perfil
|
profile-key | True | string |
Chave Exclusiva para o perfil de destino |
|
|
object |
Retornos
- Corpo
- StdJSONResponse
Gerar Número (Numeração)
Gera um número exclusivo com base na 'chave de perfil' fornecida
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Chave de perfil
|
profile-key | True | string |
Chave Exclusiva para o perfil de destino |
|
|
object |
Retornos
- Corpo
- StdJSONResponse
Obter chaves de perfil por grupo (palavras-chave)
Retorna todas as chaves de perfil de palavra-chave com base no 'nome do grupo' fornecido
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Nome de Grupo
|
group-name | True | string |
O nome do grupo usado para agrupar perfis de palavra-chave |
|
Classificar
|
sort | string |
Um parâmetro opcional para classificar o resultado de Chave/Valor retornado |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
|
array of string |
Obter estado de registro (BPM)
Obtenha o estado de registro bpm para um ou mais registros para incluir o status atual, quem é responsável pelo registro, o histórico de fluxo de trabalho e outras informações para descrever o estado e as regras atuais para o registro
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Chaves de processo
|
process-keys | string |
Filtre para identificar o (es) processo comercial para o qual os registros serão retornados. Essa chave pode ser encontrada no perfil bpm no Portal de Administração do Agilit-e – (separado usando vírgulas) |
|
|
IDs de registro bpm
|
bpm-record-ids | string |
filtrar para retornar apenas registros com recordIds específicos. A recordId é registrada pela api registerBPMRecord para novos registros e pode ser encontrada na propriedade recordID das respostas da API do BPM – (separadas usando vírgulas) |
|
|
Nomes de etapas
|
step-names | string |
Filtre para retornar apenas os registros que estão atualmente nas etapas de fluxo de trabalho especificadas – (separadas usando vírgulas) |
|
|
Usuários Responsáveis
|
responsible-users | string |
Filtre para retornar apenas os registros que estão atribuídos ao endereço de email especificado ( es) – (separado usando vírgulas) |
|
|
Usuários relevantes
|
relevant-users | string |
Filtrar para retornar apenas registros relevantes para o endereço de email especificado ( es) – (separado usando vírgulas) |
|
|
Incluir Histórico
|
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 |
Retornos
- Itens
- GetBPMRecordState
Obter função (funções)
Obtenha pessoas responsáveis atribuídas a funções no portal de administração do Agilit-e. Essas funções não são apenas relevantes para registros específicos ou processos de negócios e são mais normalmente usadas para funções de toda a empresa na organização
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Nomes de função
|
role-names | True | string |
Especifique os nomes de função para os quais você deseja recuperar os usuários responsáveis – (separados 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 um nível pode ser um nome de departamento (se você quiser recuperar o Gerenciador de Departamentos) ou um nome de produto (se você quiser recuperar o Gerenciador de Produtos) – (separado usando vírgulas) |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
responsibleUsers
|
responsibleUsers | array of string |
responsibleUsers |
Obter funções atribuídas (funções)
Obter pessoas responsáveis para a função atribuída anteriormente para um registro específico
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Chave de processo
|
process-key | True | string |
Chave Exclusiva para o perfil de destino |
|
ID do registro BPM
|
bpm-record-id | True | string |
Identifica o registro para o qual a função está sendo definida. A ID é registrada pela api registerBPMRecord para novos registros e pode ser encontrada na propriedade recordID das respostas da API do BPM |
|
Nome da Função
|
role-names | True | string |
As funções a serem consultadas (separadas usando vírgulas) |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
|
array of object | ||
|
Nome
|
name | string | |
|
Usuários
|
users | array of object | |
|
Email
|
users.email | string |
Obter por chave de perfil (BPM)
Obtenha o perfil completo do BPM com configuração e opções para o processo.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Chave de perfil
|
profile-key | True | string |
Chave Exclusiva para o perfil de destino |
Retornos
- Corpo
- GetBPMProfile
Obter por chave de perfil (palavras-chave)
Retorna pares chave/valor de um perfil de palavra-chave específico com base na 'chave de perfil' fornecida
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Chave de perfil
|
profile-key | True | string |
Chave Exclusiva para o perfil de destino |
|
Classificar
|
sort | string |
Um parâmetro opcional para classificar o resultado de Chave/Valor retornado |
Retornos
- Itens
- KeywordValues
Obter rótulo por valor (palavras-chave)
Retorna um rótulo de palavra-chave com base em 'profile-key' e 'value-key' fornecidos
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Chave de perfil
|
profile-key | True | string |
Chave Exclusiva para o perfil de destino |
|
Chave de valor
|
value-key | True | string |
A chave Value na listagem Rótulo/Valor do perfil de destino |
Retornos
- Corpo
- StdJSONResponse
Obter valor por rótulo (palavras-chave)
Retorna um valor de palavra-chave com base em 'profile-key' e 'label-key' fornecidos
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Chave de perfil
|
profile-key | True | string |
Chave Exclusiva para o perfil de destino |
|
Chave de rótulo
|
label-key | True | string |
A chave Label na listagem Rótulo/Valor do perfil de destino |
Retornos
- Corpo
- StdJSONResponse
Registrar registro BPM (BPM)
Registre o novo registro BPM. O registro é atribuído com uma recordID que é usada para o ciclo de vida do registro para identificar o registro, seu progresso, histórico e status em todos os tempos
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Chave de processo
|
process-key | True | string |
Chave Exclusiva para o perfil de destino |
|
Usuário Atual
|
current-user | True | string |
O endereço de email do usuário que está registrando o registro. Normalmente, esse será o usuário que está conectado no momento da chamada à API |
Retornos
- Corpo
- RegisterBPMRecord
Definições
ExecuteBPMResult
| Nome | 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 da etapa
|
instructions | string |
Instruções para o usuário responsável durante a etapa |
|
Chave da Etapa de Processo
|
key | string |
Uma chave exclusiva para identificar a Etapa do Processo |
|
Nome da etapa do processo
|
name | string |
Um nome curto para a Etapa de Processo |
|
Chave de perfil BPM
|
processKey | string |
Uma chave exclusiva para identificar o perfil do BPM |
|
Estágio do Processo
|
processStage | string |
Uma chave que define o estágio de processo da etapa atual |
|
Tipo de responsabilidade
|
responsibility | string |
Responsabilidade baseada em usuário/função |
|
Função responsável da etapa de processo
|
responsibleRole | string |
A função responsável pela etapa de processo atual |
|
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 de etapa
|
stepOptions.description | string |
Uma breve descrição explicando a opção De etapa |
|
Carimbo de evento de opção de etapa
|
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 De etapa |
|
Próxima Etapa
|
stepOptions.nextStep | string |
A próxima etapa para a qual o processo empresarial será roteado. Deixe vazio se nenhuma etapa adicional |
|
Notas sobre a opção De etapa
|
stepOptions.notes | string |
Opção De anotações opcionais para a etapa |
|
visibleObjects
|
stepOptions.visibleObjects | array of object | |
|
ID do objeto Step Option
|
stepOptions.visibleObjects.id | string |
A ID do componente que é referenciado na interface do usuário |
|
choices
|
stepOptions.visibleObjects.inputOptions.choices | array of object | |
|
Rótulo de Tipo de Opções
|
stepOptions.visibleObjects.inputOptions.choices.label | string |
Um rótulo para escolha selecionada |
|
Valor do Tipo de Opções
|
stepOptions.visibleObjects.inputOptions.choices.value | string |
Um valor para a opção 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 de 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 |
|
É editável o objeto de opção de etapa
|
stepOptions.visibleObjects.isEditable | boolean |
É o componente referenciado editável para entrada do usuário |
|
É obrigatório o objeto Step Option
|
stepOptions.visibleObjects.isMandatory | boolean |
O componente referenciado requer entrada do usuário |
|
visibleObjects
|
visibleObjects | array of object | |
|
ID do objeto da etapa de processo
|
visibleObjects.id | string |
A ID do componente que é referenciado na interface do usuário |
|
choices
|
visibleObjects.inputOptions.choices | array of object | |
|
Rótulo de Tipo de Opções
|
visibleObjects.inputOptions.choices.label | string |
Um rótulo para escolha selecionada |
|
Valor do Tipo de Opções
|
visibleObjects.inputOptions.choices.value | string |
Um valor para a opção 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 de 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 |
|
É editável o objeto da etapa de processo
|
visibleObjects.isEditable | boolean |
É o componente referenciado editável para entrada do usuário |
|
É obrigatório o objeto da etapa de processo
|
visibleObjects.isMandatory | boolean |
O componente referenciado requer entrada do usuário |
GetBPMProfile
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
appAdmin
|
appAdmin | array of object | |
|
Email do Administrador do Aplicativo
|
appAdmin.email | string |
Um endereço de email 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 do BPM |
|
Nome do grupo de perfil BPM
|
groupName | string |
Um agrupamento opcional para o perfil bpm |
|
Chave de perfil BPM
|
key | string |
Uma chave exclusiva para identificar o perfil do BPM |
|
Nome do perfil bpm
|
name | string |
Um nome curto para o perfil bpm |
|
Notas de perfil do BPM
|
notes | string |
Notas opcionais para o perfil BPM |
|
processSteps
|
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 |
|
É a primeira etapa
|
processSteps.firstStep | boolean |
Especifique se o registro da Etapa de Processo é a primeira etapa no Processo Empresarial |
|
Instruções da etapa
|
processSteps.instructions | string |
Instruções para o usuário responsável durante a etapa |
|
Chave da Etapa de Processo
|
processSteps.key | string |
Uma chave exclusiva para identificar a Etapa do Processo |
|
Nome da etapa do processo
|
processSteps.name | string |
Um nome curto para a Etapa de Processo |
|
Estágio do Processo
|
processSteps.processStage | string |
Uma chave que define o estágio de processo da etapa atual |
|
URL de referência da etapa de processo
|
processSteps.referenceUrl | string |
Uma URL de referência para a Etapa de Processo |
|
Tipo de responsabilidade
|
processSteps.responsibility | string |
Responsabilidade baseada em usuário/função |
|
Função responsável da etapa de 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 de etapa
|
processSteps.stepOptions.description | string |
Uma breve descrição explicando a opção De etapa |
|
Nome da opção de etapa
|
processSteps.stepOptions.name | string |
Um nome curto para a opção De etapa |
|
Próxima Etapa
|
processSteps.stepOptions.nextStep | string |
A próxima etapa para a qual o processo empresarial será roteado. Deixe vazio se nenhuma etapa adicional |
|
Notas sobre a opção De etapa
|
processSteps.stepOptions.notes | string |
Opção De anotações opcionais para a etapa |
|
visibleObjects
|
processSteps.stepOptions.visibleObjects | array of object | |
|
ID do objeto Step Option
|
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 | |
|
Rótulo de Tipo de Opções
|
processSteps.stepOptions.visibleObjects.inputOptions.choices.label | string |
Um rótulo para escolha selecionada |
|
Valor do Tipo de Opções
|
processSteps.stepOptions.visibleObjects.inputOptions.choices.value | string |
Um valor para a opção 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 de 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 |
|
É editável o objeto de opção de etapa
|
processSteps.stepOptions.visibleObjects.isEditable | boolean |
É o componente referenciado editável para entrada do usuário |
|
É obrigatório o objeto Step Option
|
processSteps.stepOptions.visibleObjects.isMandatory | boolean |
O componente referenciado requer entrada do usuário |
|
visibleObjects
|
processSteps.visibleObjects | array of object | |
|
ID do objeto da etapa de processo
|
processSteps.visibleObjects.id | string |
A ID do componente que é referenciado na interface do usuário |
|
choices
|
processSteps.visibleObjects.inputOptions.choices | array of object | |
|
Rótulo de Tipo de Opções
|
processSteps.visibleObjects.inputOptions.choices.label | string |
Um rótulo para escolha selecionada |
|
Valor do Tipo de Opções
|
processSteps.visibleObjects.inputOptions.choices.value | string |
Um valor para a opção 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 de 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 |
|
É editável o objeto da etapa de processo
|
processSteps.visibleObjects.isEditable | boolean |
É o componente referenciado editável para entrada do usuário |
|
É obrigatório o objeto da etapa de processo
|
processSteps.visibleObjects.isMandatory | boolean |
O componente referenciado requer entrada do usuário |
|
URL de Referência de Perfil do BPM
|
referenceUrl | string |
Uma URL opcional que pode ser referenciada para o perfil bpm atual |
GetBPMRecordState
| Nome | 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 |
|
eventStampHistory
|
eventStampHistory | array of object | |
|
Nome do histórico do carimbo de evento
|
eventStampHistory.eventName | string |
Nome do carimbo de evento |
|
Carimbo de data/hora do histórico do carimbo de data/hora do carimbo de data/hora do
|
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órico
|
history.comments | string |
Comentários opcionais adicionados no momento em que a entrada histórico foi criada |
|
Função Atual do Histórico
|
history.currentRole | string |
A função atual no momento da entrada histórico |
|
Histórico do usuário atual
|
history.currentUser | string |
O usuário atual no momento da entrada histórico |
|
Duração da etapa
|
history.duration | string |
O tempo (em minutos) em que o registro existia na Etapa de Processo atual antes de ser acionado |
|
Carimbo de Evento histórico
|
history.eventStamp | array of string |
Carimbos de Evento que ocorreram no momento da entrada histórico |
|
Da Etapa
|
history.fromStep | string |
A chave da etapa de processo da qual o registro BPM veio no momento da entrada histórico |
|
Do nome da etapa
|
history.fromStepName | string |
O nome da etapa de processo da qual o registro BPM veio no momento da entrada histórico |
|
Opção histórico selecionada
|
history.optionSelected | string |
A opção selecionada ao acioná-lo |
|
Chave de processo do BPM de histórico
|
history.processKey | string |
A chave de processo bpm exclusiva para a entrada histórico |
|
Estágio do processo de histórico
|
history.processStage | string |
O estágio processo no momento da entrada histórico |
|
ID do registro bpm de histórico
|
history.recordId | string |
A ID de registro para o registro relacionado ao BPM gerado durante o processo registrar registro bpm |
|
Função Responsável do Histórico
|
history.responsibleRole | string |
A função responsável do registro BPM no momento da entrada histórico |
|
Usuários Responsáveis do Histórico
|
history.responsibleUsers | array of string |
Usuários Responsáveis no momento da entrada histórico |
|
Data do envio do histórico
|
history.submissionDate | date-time |
A data/hora em que o registro BPM foi acionado |
|
Para processar o estágio
|
history.toProcessStage | string |
O estágio de processo para o registro BPM no momento da entrada histórico |
|
Para a etapa
|
history.toStep | string |
A chave da etapa de processo para o registro BPM no momento da entrada histórico |
|
Nome da etapa para
|
history.toStepName | string |
O nome da etapa de processo para o registro BPM no momento da entrada histórico |
|
Instruções da etapa
|
instructions | string |
Instruções para o usuário responsável durante a etapa |
|
Chave da Etapa de Processo
|
key | string |
Uma chave exclusiva para identificar a Etapa do Processo |
|
Nome da etapa do processo
|
name | string |
Um nome curto para a Etapa de Processo |
|
Chave de perfil BPM
|
processKey | string |
Uma chave exclusiva para identificar o perfil do BPM |
|
Estágio do Processo
|
processStage | string |
Uma chave que define o estágio de 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 de processo
|
referenceUrl | string |
Uma URL de referência para a Etapa de Processo |
|
Função responsável da etapa de processo
|
responsibleRole | string |
A função responsável pela etapa atual |
|
Etapa do processo usuários responsáveis
|
responsibleUsers | array of string |
Usuários responsáveis pela etapa atual do processo |
|
funções
|
roles | array of object | |
|
Nome da Função
|
roles.name | string |
Nome da função |
|
users
|
roles.users | array of object | |
|
Email de função
|
roles.users.email | string |
Endereços de email vinculados ao nome da função |
|
stepOptions
|
stepOptions | array of object | |
|
Descrição da opção de etapa
|
stepOptions.description | string |
Uma breve descrição explicando a opção De etapa |
|
Carimbo de evento de opção de etapa
|
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 De etapa |
|
Próxima Etapa
|
stepOptions.nextStep | string |
A próxima etapa para a qual o processo empresarial será roteado. Deixe vazio se nenhuma etapa adicional |
|
Notas sobre a opção De etapa
|
stepOptions.notes | string |
Opção De anotações opcionais para a etapa |
|
visibleObjects
|
stepOptions.visibleObjects | array of object | |
|
ID do objeto Step Option
|
stepOptions.visibleObjects.id | string |
A ID do componente que é referenciado na interface do usuário |
|
choices
|
stepOptions.visibleObjects.inputOptions.choices | array of object | |
|
Rótulo de Tipo de Opções
|
stepOptions.visibleObjects.inputOptions.choices.label | string |
Um rótulo para escolha selecionada |
|
Valor do Tipo de Opções
|
stepOptions.visibleObjects.inputOptions.choices.value | string |
Um valor para a opção 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 de 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 |
|
É editável o objeto de opção de etapa
|
stepOptions.visibleObjects.isEditable | boolean |
É o componente referenciado editável para entrada do usuário |
|
É obrigatório o objeto Step Option
|
stepOptions.visibleObjects.isMandatory | boolean |
O componente referenciado requer entrada do usuário |
|
Enviado em etapa
|
submittedIntoStep | date-time |
A data/hora em que o registro BPM foi enviado para a Etapa de Processo atual |
|
Duração do tempo de destino
|
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 de processo
|
visibleObjects.id | string |
A ID do componente que é referenciado na interface do usuário |
|
choices
|
visibleObjects.inputOptions.choices | array of object | |
|
Rótulo de Tipo de Opções
|
visibleObjects.inputOptions.choices.label | string |
Um rótulo para escolha selecionada |
|
Valor do Tipo de Opções
|
visibleObjects.inputOptions.choices.value | string |
Um valor para a opção 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 de 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 |
|
É editável o objeto da etapa de processo
|
visibleObjects.isEditable | boolean |
É o componente referenciado editável para entrada do usuário |
|
É obrigatório o objeto da etapa de processo
|
visibleObjects.isMandatory | boolean |
O componente referenciado requer entrada do usuário |
KeywordValues
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Etiqueta
|
label | string | |
|
Value
|
value | string |
RegisterBPMRecord
| Nome | 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 |
|
eventStampHistory
|
eventStampHistory | array of object | |
|
Nome do histórico do carimbo de evento
|
eventStampHistory.eventName | string |
Nome do carimbo de evento |
|
Carimbo de data/hora do histórico do carimbo de data/hora do carimbo de data/hora do
|
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órico
|
history.comments | string |
Comentários opcionais adicionados no momento em que a entrada histórico foi criada |
|
Função Atual do Histórico
|
history.currentRole | string |
A função atual no momento da entrada histórico |
|
Histórico do usuário atual
|
history.currentUser | string |
O usuário atual no momento da entrada histórico |
|
Duração da etapa
|
history.duration | string |
O tempo (em minutos) em que o registro existia na Etapa de Processo atual antes de ser acionado |
|
Carimbo de Evento histórico
|
history.eventStamp | array of string |
Carimbos de Evento que ocorreram no momento da entrada histórico |
|
Da Etapa
|
history.fromStep | string |
A chave da etapa de processo da qual o registro BPM veio no momento da entrada histórico |
|
Do nome da etapa
|
history.fromStepName | string |
O nome da etapa de processo da qual o registro BPM veio no momento da entrada histórico |
|
Opção histórico selecionada
|
history.optionSelected | string |
A opção selecionada ao acioná-lo |
|
Chave de processo do BPM de histórico
|
history.processKey | string |
A chave de processo bpm exclusiva para a entrada histórico |
|
Estágio do processo de histórico
|
history.processStage | string |
O estágio processo no momento da entrada histórico |
|
ID do registro bpm de histórico
|
history.recordId | string |
A ID de registro para o registro relacionado ao BPM gerado durante o processo registrar registro bpm |
|
Função Responsável do Histórico
|
history.responsibleRole | string |
A função responsável do registro BPM no momento da entrada histórico |
|
Usuários Responsáveis do Histórico
|
history.responsibleUsers | array of string |
Usuários Responsáveis no momento da entrada histórico |
|
Data do envio do histórico
|
history.submissionDate | date-time |
A data/hora em que o registro BPM foi acionado |
|
Para processar o estágio
|
history.toProcessStage | string |
O estágio de processo para o registro BPM no momento da entrada histórico |
|
Para a etapa
|
history.toStep | string |
A chave da etapa de processo para o registro BPM no momento da entrada histórico |
|
Nome da etapa para
|
history.toStepName | string |
O nome da etapa de processo para o registro BPM no momento da entrada histórico |
|
Instruções da etapa
|
instructions | string |
Instruções para o usuário responsável durante a etapa |
|
Chave da Etapa de Processo
|
key | string |
Uma chave exclusiva para identificar a Etapa do Processo |
|
Nome da etapa do processo
|
name | string |
Um nome curto para a Etapa de Processo |
|
Chave de perfil BPM
|
processKey | string |
Uma chave exclusiva para identificar o perfil do BPM |
|
Estágio do Processo
|
processStage | string |
Uma chave que define o estágio de 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 de processo
|
referenceUrl | string |
Uma URL de referência para a Etapa de Processo |
|
Função responsável da etapa de processo
|
responsibleRole | string |
A função responsável pela etapa de processo atual |
|
Etapa do processo usuários responsáveis
|
responsibleUsers | array of string |
Os usuários responsáveis pela etapa atual do processo |
|
funções
|
roles | array of object | |
|
Nome da Função
|
roles.name | string |
Nome da função |
|
users
|
roles.users | array of object | |
|
Email de função
|
roles.users.email | string |
Endereços de email vinculados ao nome da função |
|
stepOptions
|
stepOptions | array of object | |
|
Descrição da opção de etapa
|
stepOptions.description | string |
Uma breve descrição explicando a opção De etapa |
|
Carimbo de evento de opção de etapa
|
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 De etapa |
|
Próxima Etapa
|
stepOptions.nextStep | string |
A próxima etapa para a qual o processo empresarial será roteado. Deixe vazio se nenhuma etapa adicional |
|
Notas sobre a opção De etapa
|
stepOptions.notes | string |
Notas opcionais para a opção De etapa |
|
visibleObjects
|
stepOptions.visibleObjects | array of object | |
|
ID do objeto Step Option
|
stepOptions.visibleObjects.id | string |
A ID do componente que é referenciado na interface do usuário |
|
choices
|
stepOptions.visibleObjects.inputOptions.choices | array of object | |
|
Rótulo de Tipo de Opções
|
stepOptions.visibleObjects.inputOptions.choices.label | string |
Um rótulo para escolha selecionada |
|
Valor do Tipo de Opções
|
stepOptions.visibleObjects.inputOptions.choices.value | string |
Um valor para a opção 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 de 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 |
|
É editável o objeto de opção de etapa
|
stepOptions.visibleObjects.isEditable | boolean |
É o componente referenciado editável para entrada do usuário |
|
É obrigatório o objeto Step Option
|
stepOptions.visibleObjects.isMandatory | boolean |
O componente referenciado requer entrada do usuário |
|
visibleObjects
|
visibleObjects | array of object | |
|
ID do objeto da etapa de processo
|
visibleObjects.id | string |
A ID do componente que é referenciado na interface do usuário |
|
choices
|
visibleObjects.inputOptions.choices | array of object | |
|
Rótulo de Tipo de Opções
|
visibleObjects.inputOptions.choices.label | string |
Um rótulo para escolha selecionada |
|
Valor do Tipo de Opções
|
visibleObjects.inputOptions.choices.value | string |
Um valor para a opção 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 de 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 |
|
É editável o objeto da etapa de processo
|
visibleObjects.isEditable | boolean |
É o componente referenciado editável para entrada do usuário |
|
É obrigatório o objeto da etapa de processo
|
visibleObjects.isMandatory | boolean |
O componente referenciado requer entrada do usuário |
StdJSONResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Resultado
|
result | string |
Resultado |
objeto
Esse é o tipo 'object'.