Fluxo de trabalho K2 (versão prévia)
Use o serviço de API de Fluxo de Trabalho K2 para trabalhar remotamente com fluxos de trabalho e tarefas.
Esse conector está disponível nos seguintes produtos e regiões:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Standard | 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 | Standard | 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 | Standard | 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 | |
|---|---|
| URL | https://portal.k2.com/ticket/default |
| Metadados do conector | |
|---|---|
| Publicador | K2 |
| Site | https://www.k2.com |
| Política de privacidade | https://www.k2.com/legal/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 | 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 |
|---|---|---|---|
| K2 URL | cadeia | Sua URL K2 (exemplo: https://[K2ID].onk2.com). | Verdade |
| Nome de usuário | secureString | O nome de usuário para esta api | Verdade |
| Senha | secureString | A senha dessa api | Verdade |
Limitações
| Nome | Chamadas | Período de renovação |
|---|---|---|
| Chamadas à API por conexão | 100 | 60 segundos |
Ações
| Atribuir Tarefa |
Atribui uma tarefa ao usuário atual. |
| Concluir evento do servidor |
Enviar uma resposta de término para uma tarefa de servidor assíncrono aguardando uma resposta |
| Iniciar fluxo de trabalho |
Cria e inicia uma nova instância de fluxo de trabalho. |
| Obter ações de tarefa |
Obtém uma lista de ações para a tarefa. |
| Obter evento de servidor |
Obtém um evento de servidor por número de série. |
| Obter fluxo de trabalho |
Obtém uma definição de fluxo de trabalho por ID. |
| Obter fluxos de trabalho |
Obtenha uma lista de fluxos de trabalho disponíveis. |
| Obter Tarefa |
Obtém uma tarefa por número de série. |
| Obter tarefas |
Obtenha uma lista de tarefas disponíveis para o usuário conectado. |
| Tarefa de ação |
Executa uma ação de fluxo de trabalho. |
| Tarefa de redirecionamento |
Envia uma tarefa para outra pessoa. |
| Tarefa De suspensão |
Suspensão de uma tarefa por uma duração, número de segundos ou até uma data. |
| Tarefa Desativar |
Desperta uma tarefa de suspensão. |
| Tarefa release |
Libera uma tarefa. |
Atribuir Tarefa
Atribui uma tarefa ao usuário atual.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Número de Série
|
serialNumber | True | string |
O número de série da tarefa. Ex: 1234_5678 |
Retornos
- response
- object
Concluir evento do servidor
Enviar uma resposta de término para uma tarefa de servidor assíncrono aguardando uma resposta
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Número de série de evento do servidor
|
serialNumber | True | string |
O número de série do evento do servidor. Ex: 1234_5678 |
|
Nome do campo XML
|
name | string |
O nome de um campo XML. |
|
|
Valor do campo XML
|
value | string |
O valor do campo XML. |
|
|
Referências de item
|
ItemReferences | object |
Os campos referência de item da instância de fluxo de trabalho. |
|
|
Campos de dados
|
DataFields | object |
Os campos de dados da instância de fluxo de trabalho. |
Iniciar fluxo de trabalho
Cria e inicia uma nova instância de fluxo de trabalho.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Fluxo de Trabalho
|
id | True | integer |
Especifique uma ID de fluxo de trabalho para iniciar a instância. |
|
Detalhes da instância de fluxo de trabalho
|
instance | True | dynamic |
Enviar objeto de instância de fluxo de trabalho para iniciar o fluxo de trabalho. |
Retornos
- response
- integer
Obter ações de tarefa
Obtém uma lista de ações para a tarefa.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Número de Série
|
serialNumber | True | string |
O número de série da tarefa. Ex: 1234_5678 |
Retornos
- Corpo
- TaskActionsResponse
Obter evento de servidor
Obtém um evento de servidor por número de série.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Número de série de evento do servidor
|
serialNumber | True | string |
O número de série do evento do servidor. Ex: 1234_5678. |
Retornos
- Corpo
- ServerEventDataResponse
Obter fluxo de trabalho
Obtém uma definição de fluxo de trabalho por ID.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Fluxo de Trabalho
|
id | True | integer |
A ID do fluxo de trabalho. |
Retornos
- Corpo
- WorkflowDataResponse
Obter fluxos de trabalho
Obtenha uma lista de fluxos de trabalho disponíveis.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Tipo de fluxo de trabalho
|
type | string |
O tipo de fluxo de trabalho. Startable ou Owned. |
Retornos
Obter Tarefa
Obtém uma tarefa por número de série.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Número de Série
|
serialNumber | True | string |
O número de série da tarefa. Ex: 1234_5678 |
Retornos
- Corpo
- Task
Obter tarefas
Obtenha uma lista de tarefas disponíveis para o usuário conectado.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
All, Allocated, Sleeping, SharedFrom, SharedTo
|
state | string |
Retorna a lista de tarefas para o usuário conectado. |
Retornos
- Corpo
- TasksResponse
Tarefa de ação
Executa uma ação de fluxo de trabalho.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Número de Série
|
serialNumber | True | string |
O número de série da tarefa. Ex: 1234_5678 |
|
Ação personalizada
|
customAction | True | string |
A ação da tarefa, definida pelo fluxo de trabalho. |
|
Nome do campo XML
|
name | string |
O nome de um campo XML. |
|
|
Valor do campo XML
|
value | string |
O valor do campo XML. |
|
|
Referências de item
|
ItemReferences | object |
Os campos referência de item da instância de fluxo de trabalho. |
|
|
Campos de dados
|
DataFields | object |
Os campos de dados da instância de fluxo de trabalho. |
Tarefa de redirecionamento
Envia uma tarefa para outra pessoa.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Número de Série
|
serialNumber | True | string |
O número de série da tarefa. Ex: 1234_5678 |
|
Informações de redirecionamento
|
RedirectTo | True | string |
A pessoa para a qual a tarefa é redirecionada. |
Tarefa De suspensão
Suspensão de uma tarefa por uma duração, número de segundos ou até uma data.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Número de Série
|
serialNumber | True | string |
O número de série da tarefa. Ex: 1234_5678 |
|
Sleep For
|
SleepFor | integer |
O número de segundos para suspensão de uma tarefa. |
|
|
Dormir até
|
SleepUntil | date-time |
A data e a hora para ativar a tarefa. Formato: yyyyy-MM-ddTHH:mm:ss:fffZ UTC |
Tarefa Desativar
Desperta uma tarefa de suspensão.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Número de Série
|
serialNumber | True | string |
O número de série da tarefa. Ex: 1234_5678 |
Retornos
- response
- object
Tarefa release
Libera uma tarefa.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Número de Série
|
serialNumber | True | string |
O número de série da tarefa. Ex: 1234_5678 |
Definições
ServerEventDataResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Número de série de evento do servidor
|
serialNumber | string |
O número de série do evento do servidor. Ex: 1234_5678 |
|
ID do fluxo de trabalho de evento do servidor
|
workflowID | integer |
A ID do fluxo de trabalho associado ao evento do servidor. |
|
Nome do fluxo de trabalho do evento do servidor
|
workflowName | string |
O nome do fluxo de trabalho associado ao evento do servidor. |
|
Nome de exibição do fluxo de trabalho do evento do servidor
|
workflowDisplayName | string |
O nome de exibição do fluxo de trabalho associado ao evento do servidor. |
|
Categoria de fluxo de trabalho de evento do servidor
|
workflowCategory | string |
A categoria do fluxo de trabalho associado ao evento do servidor. |
|
ID da instância do fluxo de trabalho de evento do servidor
|
workflowInstanceID | integer |
A ID da instância do fluxo de trabalho associado ao evento do servidor. |
|
Folio de fluxo de trabalho de evento do servidor
|
workflowInstanceFolio | string |
O folio da instância de fluxo de trabalho associada ao evento do servidor. |
|
ID da instância da atividade de evento do servidor
|
activityInstanceID | integer |
A ID da instância de atividade do evento do servidor. |
|
ID de destino da atividade de evento do servidor
|
activityInstanceDestinationID | integer |
A ID de destino da instância de atividade do evento do servidor. |
|
Nome da atividade de evento do servidor
|
activityName | string |
O nome da atividade do evento do servidor. |
|
Nome do evento do servidor
|
eventName | string |
O nome do evento do servidor. |
|
Descrição do evento de evento do servidor
|
eventDescription | string |
A descrição do evento do servidor. |
|
Originador
|
originator | User | |
|
eventInstance
|
eventInstance | EventInstanceWrapper | |
|
Campos de dados da atividade de evento do servidor
|
dataFields | object |
Os campos de dados da atividade. |
|
Campos XML da atividade de evento do servidor
|
xmlFields | array of UserDefinedXmlField |
Os campos XML da atividade. |
|
Referências de item de evento do servidor
|
itemReferences | object |
As referências de item da instância de fluxo de trabalho. |
|
Cadeia de caracteres de campos de dados de fluxo de trabalho de evento do servidor
|
workflowInstanceDataFieldsString | string |
Representação de cadeia de caracteres dos campos de dados da Instância de Fluxo de Trabalho. |
|
Cadeia de caracteres de referências de item de evento do servidor
|
itemReferencesString | string |
Cadeia de caracteres que representa as referências de item da instância de fluxo de trabalho. |
|
viewFlowURL
|
viewFlowURL | string |
EventInstance
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Data de início da instância de evento
|
StartDate | date-time |
Data e hora em que a instância de evento foi iniciada. |
|
Duração esperada da instância de evento
|
ExpectedDuration | integer |
Duração esperada da instância de evento. |
|
Prioridade da instância de evento
|
Priority | integer |
Prioridade da instância de evento. |
|
Metadados da Instância de Evento
|
MetaData | string |
Metadados para a instância de evento. |
|
Descrição da instância de evento
|
Description | string |
Descrição da instância de evento. |
|
Nome da Instância de Evento
|
Name | string |
Nome da instância de evento. |
|
ID da Instância de Evento
|
ID | integer |
ID da instância de evento. |
UserDefinedXmlField
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Nome do campo XML
|
name | string |
O nome de um campo XML. |
|
Valor do campo XML
|
value | string |
O valor do campo XML. |
TasksResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Contagem de tarefas
|
itemCount | integer |
A contagem de tarefas retornadas. |
|
Tasks
|
tasks | array of TaskLite |
Uma ou mais tarefas. |
TaskLite
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Número de série da tarefa
|
serialNumber | string |
O número de série da tarefa. Ex: 1234_5678 |
|
Status da Tarefa
|
status | string |
O status da tarefa. Ex: Open, Completed, Sleep, Allocated, Available |
|
Data de início da tarefa
|
taskStartDate | date-time |
A data de início da tarefa. |
|
Duração do suspensão da tarefa
|
sleepUntil | date-time |
A data e a hora em que a tarefa será ativada. |
|
Prioridade da tarefa
|
priority | integer |
A prioridade da tarefa. |
|
URL do Formulário de Tarefa
|
formURL | string |
A URL do formulário da tarefa. |
|
URL do Fluxo de Exibição de Tarefa
|
viewFlowURL | string |
A URL de Fluxo de Exibição da tarefa. |
|
ID do fluxo de trabalho da tarefa
|
workflowID | integer |
A ID do fluxo de trabalho associado à tarefa. |
|
Nome do fluxo de trabalho da tarefa
|
workflowName | string |
O nome do fluxo de trabalho associado à tarefa. |
|
Nome de exibição do fluxo de trabalho da tarefa
|
workflowDisplayName | string |
O nome de exibição do fluxo de trabalho associado à tarefa. |
|
Categoria de fluxo de trabalho da tarefa
|
workflowCategory | string |
A categoria do fluxo de trabalho associado à tarefa. |
|
ID da instância do fluxo de trabalho da tarefa
|
workflowInstanceID | integer |
A ID da instância do fluxo de trabalho associado à tarefa. |
|
Fluxo de Trabalho da Tarefa Folio
|
workflowInstanceFolio | string |
O folio da instância de fluxo de trabalho associada à tarefa. |
|
ID da Instância de Tarefa
|
activityInstanceID | integer |
A ID da instância de atividade da tarefa. |
|
ID de destino da atividade de tarefa
|
activityInstanceDestinationID | integer |
A ID de destino da instância de atividade da tarefa. |
|
Nome da atividade da tarefa
|
activityName | string |
O nome da atividade da tarefa. |
|
Nome do evento da tarefa
|
eventName | string |
O nome do evento da tarefa. |
|
Descrição do evento task
|
eventDescription | string |
A descrição do evento da tarefa. |
|
Originador
|
originator | User | |
|
Ações
|
actions | TaskActionsResponse | |
|
Instruções da tarefa
|
instruction | string |
As instruções associadas à tarefa. |
Utilizador
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Nome do usuário
|
username | string |
Nome de usuário da pessoa. |
|
FQN do usuário
|
fqn | string |
Nome totalmente qualificado da pessoa. Ex: bob@denallix.com, K2:Denallix\Bob |
|
Email do Usuário
|
string |
Endereço de email da pessoa. |
|
|
Gerenciador de Usuários
|
manager | string |
Gerente da pessoa. |
|
Nome de Exibição do Usuário
|
displayName | string |
Nome de exibição da pessoa. |
TaskActionsResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Ações não abatcháveis
|
nonBatchableActions | array of string |
Lista de ações que não podem ser executadas sem atribuir a tarefa. |
|
Ações em lotes
|
batchableActions | array of string |
Lista de ações que podem ser executadas sem atribuir a tarefa. |
|
Ações do Sistema
|
systemActions | array of string |
Lista de ações do sistema. |
Tarefa
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Número de série da tarefa
|
serialNumber | string |
O número de série da tarefa. Ex: 1234_5678 |
|
Status da Tarefa
|
status | string |
O status da tarefa. Ex: Open, Completed, Sleep, Allocated, Available |
|
Data de início da tarefa
|
taskStartDate | date-time |
A data de início da tarefa. |
|
Duração do suspensão da tarefa
|
sleepUntil | date-time |
A data e a hora em que a tarefa será ativada. |
|
Prioridade da tarefa
|
priority | integer |
A prioridade da tarefa. |
|
URL do Formulário de Tarefa
|
formURL | string |
A URL do formulário da tarefa. |
|
URL do Fluxo de Exibição de Tarefa
|
viewFlowURL | string |
A URL de Fluxo de Exibição da tarefa. |
|
ID do fluxo de trabalho da tarefa
|
workflowID | integer |
A ID do fluxo de trabalho associado à tarefa. |
|
Nome do fluxo de trabalho da tarefa
|
workflowName | string |
O nome do fluxo de trabalho associado à tarefa. |
|
Nome de exibição do fluxo de trabalho da tarefa
|
workflowDisplayName | string |
O nome de exibição do fluxo de trabalho associado à tarefa. |
|
Categoria de fluxo de trabalho da tarefa
|
workflowCategory | string |
A categoria do fluxo de trabalho associado à tarefa. |
|
ID da instância do fluxo de trabalho da tarefa
|
workflowInstanceID | integer |
A ID da instância do fluxo de trabalho associado à tarefa. |
|
Fluxo de Trabalho da Tarefa Folio
|
workflowInstanceFolio | string |
O folio da instância de fluxo de trabalho associada à tarefa. |
|
ID da Instância de Tarefa
|
activityInstanceID | integer |
A ID da instância de atividade da tarefa. |
|
ID de destino da tarefa
|
activityInstanceDestinationID | integer |
A ID de destino da instância de atividade da tarefa. |
|
Nome da atividade da tarefa
|
activityName | string |
O nome da atividade da tarefa. |
|
Nome do evento da tarefa
|
eventName | string |
O nome do evento da tarefa. |
|
Descrição do evento task
|
eventDescription | string |
A descrição do evento da tarefa. |
|
Originador
|
originator | User | |
|
Ações
|
actions | TaskActionsResponse | |
|
Campos de dados do fluxo de trabalho da tarefa
|
workflowInstanceDataFields | object |
Os campos de dados da instância de fluxo de trabalho. |
|
Campos de dados da atividade de tarefa
|
activityDataFields | object |
Os campos de dados da atividade. |
|
Campos XML do fluxo de trabalho da tarefa
|
workflowInstanceXmlFields | array of UserDefinedXmlField |
Os campos XML da instância de fluxo de trabalho. |
|
Referências de item de tarefa
|
itemReferences | object |
As referências de item da instância de fluxo de trabalho. |
|
instrução
|
instruction | string | |
|
Cadeia de caracteres de campos de dados do fluxo de trabalho da tarefa
|
workflowInstanceDataFieldsString | string |
Representação de cadeia de caracteres dos campos de dados da Instância de Fluxo de Trabalho. |
|
Cadeia de caracteres de referências de item de tarefa
|
itemReferencesString | string |
Cadeia de caracteres que representa as referências de item da instância de fluxo de trabalho. |
WorkflowLabelsResponse[WorkflowLabel]
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Contagem de Itens
|
itemCount | integer |
O número de fluxos de trabalho. |
|
Workflows
|
workflows | array of WorkflowLabel |
Uma lista de fluxos de trabalho. |
WorkflowLabel
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID do Fluxo de Trabalho
|
id | integer |
A ID do fluxo de trabalho. |
|
Versão padrão do fluxo de trabalho
|
defaultVersionId | integer |
A versão padrão do fluxo de trabalho. |
|
Nome do fluxo de trabalho
|
name | string |
O nome do fluxo de trabalho. |
|
Pasta de fluxo de trabalho
|
folder | string |
A pasta de fluxo de trabalho. |
|
Nome do sistema de fluxo de trabalho
|
systemName | string |
O nome do sistema de fluxo de trabalho. |
WorkflowDataResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
workflowInfo
|
workflowInfo | WorkflowDefinition | |
|
Esquema de fluxo de trabalho
|
workflowSchema | string |
O esquema do fluxo de trabalho. |
WorkflowDefinition
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Nome do fluxo de trabalho
|
name | string |
Nome do fluxo de trabalho. |
|
Descrição do fluxo de trabalho
|
description | string |
Descrição do fluxo de trabalho. |
|
Pasta de fluxo de trabalho
|
folder | string |
A pasta (categoria) do fluxo de trabalho. |
|
Nome do sistema de fluxo de trabalho
|
systemName | string |
O nome do sistema do fluxo de trabalho. |
|
Duração esperada do fluxo de trabalho
|
expectedDuration | integer |
A duração esperada do fluxo de trabalho. |
EventInstanceWrapper
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
EventInstance
|
EventInstance | EventInstance | |
|
Descrição da instância de evento
|
Description | string |
Descrição da instância de evento. |
|
Duração esperada da instância de evento
|
ExpectedDuration | integer |
Duração esperada da instância de evento. |
|
ID da Instância de Evento
|
ID | integer |
ID da instância de evento. |
|
Metadados da Instância de Evento
|
MetaData | string |
Metadados para a instância de evento. |
|
Nome da Instância de Evento
|
Name | string |
Nome da instância de evento. |
|
Prioridade da instância de evento
|
Priority | integer |
Prioridade da instância de evento. |
|
Data de início da instância de evento
|
StartDate | date-time |
Data e hora em que a instância de evento foi iniciada. |
inteiro
Esse é o tipo de dados básico 'integer'.
objeto
Esse é o tipo 'object'.