K2 Workflow (Pré-visualização)
Use o serviço K2 Workflow API para trabalhar remotamente com fluxos de trabalho e tarefas.
Este conector está disponível nos seguintes produtos e regiões:
| Serviço | Class | Regiões |
|---|---|---|
| Estúdio Copiloto | Standard | 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 | Standard | 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 | Standard | 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 | |
|---|---|
| URL | https://portal.k2.com/ticket/default |
| Metadados do conector | |
|---|---|
| Editora | K2 |
| Sítio Web | https://www.k2.com |
| Política de privacidade | https://www.k2.com/legal/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 | Não compartilhável |
Padrão
Aplicável: Todas as regiões
Parâmetros para criar conexão.
Esta conexão não é compartilhável. Se o aplicativo avançado for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.
| Nome | Tipo | Description | Obrigatório |
|---|---|---|---|
| K2 URL | cadeia (de caracteres) | O seu URL K2 (exemplo: https://[K2ID].onk2.com). | Verdade |
| Nome de utilizador | securestring | O nome de usuário para esta api | Verdade |
| Palavra-passe | securestring | A senha para esta api | Verdade |
Limites de Limitação
| Name | Chamadas | Período de Renovação |
|---|---|---|
| Chamadas de API por conexão | 100 | 60 segundos |
Ações
| Atribuir tarefa |
Atribui uma tarefa ao usuário atual. |
| Concluir evento do servidor |
Enviar uma resposta de conclusão 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 tarefas |
Obtém uma lista de ações para a tarefa. |
| Obter evento do 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 despertar |
Desperta uma tarefa para dormir. |
| Tarefa de liberação |
Libera uma tarefa. |
| Tarefa de redirecionamento |
Envia uma tarefa para outra pessoa. |
| Tarefa de sono |
Suspende uma tarefa por uma duração, seja por um número de segundos ou até uma data. |
Atribuir tarefa
Atribui uma tarefa ao usuário atual.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Número de Série
|
serialNumber | True | string |
O número de série da tarefa. Ex: 1234_5678 |
Devoluções
- response
- object
Concluir evento do servidor
Enviar uma resposta de conclusão para uma tarefa de servidor assíncrono aguardando uma resposta
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Número de série do 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 itens
|
ItemReferences | object |
Os campos Referência de Item da instância do fluxo de trabalho. |
|
|
Campos de dados
|
DataFields | object |
Os campos de dados da instância do fluxo de trabalho. |
Iniciar fluxo de trabalho
Cria e inicia uma nova instância de fluxo de trabalho.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do fluxo de trabalho
|
id | True | integer |
Especifique um ID de fluxo de trabalho para iniciar a instância. |
|
Detalhes da instância do fluxo de trabalho
|
instance | True | dynamic |
Enviar objeto de instância de fluxo de trabalho para iniciar o fluxo de trabalho. |
Devoluções
- response
- integer
Obter ações de tarefas
Obtém uma lista de ações para a tarefa.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Número de Série
|
serialNumber | True | string |
O número de série da tarefa. Ex: 1234_5678 |
Devoluções
- Body
- TaskActionsResponse
Obter evento do servidor
Obtém um evento de servidor por número de série.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Número de série do evento do servidor
|
serialNumber | True | string |
O número de série do evento do servidor. Ex: 1234_5678. |
Devoluções
Obter fluxo de trabalho
Obtém uma definição de fluxo de trabalho por ID.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do fluxo de trabalho
|
id | True | integer |
A ID do fluxo de trabalho. |
Devoluções
- Body
- WorkflowDataResponse
Obter fluxos de trabalho
Obtenha uma lista de fluxos de trabalho disponíveis.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Tipo de fluxo de trabalho
|
type | string |
O tipo de fluxo de trabalho. Startable ou próprio. |
Devoluções
Obter tarefa
Obtém uma tarefa por número de série.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Número de Série
|
serialNumber | True | string |
O número de série da tarefa. Ex: 1234_5678 |
Devoluções
- Body
- Task
Obter tarefas
Obtenha uma lista de tarefas disponíveis para o usuário conectado.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Todos, Alocado, Dormindo, SharedFrom, SharedTo
|
state | string |
Retorna a lista de tarefas para o usuário conectado. |
Devoluções
- Body
- TasksResponse
Tarefa de ação
Executa uma ação de fluxo de trabalho.
Parâmetros
| Name | Chave | Necessá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 itens
|
ItemReferences | object |
Os campos Referência de Item da instância do fluxo de trabalho. |
|
|
Campos de dados
|
DataFields | object |
Os campos de dados da instância do fluxo de trabalho. |
Tarefa de despertar
Desperta uma tarefa para dormir.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Número de Série
|
serialNumber | True | string |
O número de série da tarefa. Ex: 1234_5678 |
Devoluções
- response
- object
Tarefa de liberação
Libera uma tarefa.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Número de Série
|
serialNumber | True | string |
O número de série da tarefa. Ex: 1234_5678 |
Tarefa de redirecionamento
Envia uma tarefa para outra pessoa.
Parâmetros
| Name | Chave | Necessá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 quem a tarefa é redirecionada. |
Tarefa de sono
Suspende uma tarefa por uma duração, seja por um número de segundos ou até uma data.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Número de Série
|
serialNumber | True | string |
O número de série da tarefa. Ex: 1234_5678 |
|
Dormir Para
|
SleepFor | integer |
O número de segundos para suspender uma tarefa. |
|
|
Durma até
|
SleepUntil | date-time |
A data e a hora para despertar a tarefa. Formato: aaaa-MM-ddTHH:mm:ss:fffZ UTC |
Definições
ServerEventDataResponse
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Número de série do evento do servidor
|
serialNumber | string |
O número de série do evento do servidor. Ex: 1234_5678 |
|
ID do Fluxo de Trabalho de Eventos do Servidor
|
workflowID | integer |
A ID do fluxo de trabalho associado ao evento do servidor. |
|
Nome do fluxo de trabalho de evento do servidor
|
workflowName | string |
O nome do fluxo de trabalho associado ao evento do servidor. |
|
Nome de exibição do fluxo de trabalho de evento do servidor
|
workflowDisplayName | string |
O nome para 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 Eventos do Servidor
|
workflowInstanceID | integer |
O ID da instância do fluxo de trabalho associado ao evento do servidor. |
|
Folha de fluxo de trabalho de eventos do servidor
|
workflowInstanceFolio | string |
O fólio da instância de fluxo de trabalho associada ao evento do servidor. |
|
ID da Instância de Atividade de Evento do Servidor
|
activityInstanceID | integer |
O ID da instância de atividade do evento do servidor. |
|
ID de destino da atividade do evento do servidor
|
activityInstanceDestinationID | integer |
O ID de destino da instância de atividade do evento do servidor. |
|
Nome da atividade do 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 do Servidor
|
eventDescription | string |
A descrição do evento do servidor. |
|
originador
|
originator | User | |
|
eventInstance
|
eventInstance | EventInstanceWrapper | |
|
Campos de dados de atividade de evento do servidor
|
dataFields | object |
Os campos de dados da atividade. |
|
Campos XML de 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 do fluxo de trabalho. |
|
Cadeia de Dados dos Campos de Dados do Fluxo de Trabalho de Eventos 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 |
String que representa as referências de item da instância do fluxo de trabalho. |
|
viewFlowURL
|
viewFlowURL | string |
EventInstance
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Data de início da instância do evento
|
StartDate | date-time |
Data e hora em que a instância do evento foi iniciada. |
|
Duração esperada da instância do evento
|
ExpectedDuration | integer |
Duração esperada da instância do evento. |
|
Prioridade da instância do evento
|
Priority | integer |
Prioridade da instância do evento. |
|
Metadados da instância do evento
|
MetaData | string |
Metadados para a instância do evento. |
|
Descrição da instância do evento
|
Description | string |
Descrição da instância do evento. |
|
Nome da instância do evento
|
Name | string |
Nome da instância do evento. |
|
ID da instância do evento
|
ID | integer |
ID da instância do evento. |
UserDefinedXmlField
| Name | 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. |
TarefasResposta
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Contagem de tarefas
|
itemCount | integer |
A contagem de tarefas retornadas. |
|
Tasks
|
tasks | array of TaskLite |
Uma ou mais tarefas. |
TaskLite
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Número de série da tarefa
|
serialNumber | string |
O número de série da tarefa. Ex: 1234_5678 |
|
Estado da Tarefa
|
status | string |
O status da tarefa. Ex: Aberto, Concluído, Suspensão, Alocado, Disponível |
|
Data de início da tarefa
|
taskStartDate | date-time |
A data de início da tarefa. |
|
Duração do sono 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 da Vista de Tarefas
|
viewFlowURL | string |
A URL do 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 de Tarefa
|
workflowDisplayName | string |
O nome para exibição do fluxo de trabalho associado à tarefa. |
|
Categoria de fluxo de trabalho de tarefa
|
workflowCategory | string |
A categoria do fluxo de trabalho associado à tarefa. |
|
ID da instância do fluxo de trabalho da tarefa
|
workflowInstanceID | integer |
O ID da instância do fluxo de trabalho associado à tarefa. |
|
Fólio do fluxo de trabalho de tarefas
|
workflowInstanceFolio | string |
O fólio da instância do fluxo de trabalho associada à tarefa. |
|
ID da instância da tarefa
|
activityInstanceID | integer |
O ID da instância de atividade da tarefa. |
|
ID de Destino da Atividade da Tarefa
|
activityInstanceDestinationID | integer |
O 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 da Tarefa
|
eventDescription | string |
A descrição do evento da tarefa. |
|
originador
|
originator | User | |
|
ações
|
actions | TaskActionsResponse | |
|
Instruções de Tarefas
|
instruction | string |
As instruções associadas à tarefa. |
User
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Nome de Utilizador
|
username | string |
Nome de utilizador da pessoa. |
|
FQN do usuário
|
fqn | string |
Nome totalmente qualificado da pessoa. Ex: bob@denallix.com, K2:Denallix\Bob |
|
E-mail do usuário
|
string |
Endereço de e-mail da pessoa. |
|
|
Gestor de Utilizadores
|
manager | string |
Gestor da pessoa. |
|
Nome de exibição do usuário
|
displayName | string |
Nome de exibição da pessoa. |
TaskActionsResponse
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Ações não agrupáveis
|
nonBatchableActions | array of string |
Lista de ações que não podem ser executadas sem atribuir a tarefa. |
|
Ações em lote
|
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
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Número de série da tarefa
|
serialNumber | string |
O número de série da tarefa. Ex: 1234_5678 |
|
Estado da Tarefa
|
status | string |
O status da tarefa. Ex: Aberto, Concluído, Suspensão, Alocado, Disponível |
|
Data de início da tarefa
|
taskStartDate | date-time |
A data de início da tarefa. |
|
Duração do sono 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 da Vista de Tarefas
|
viewFlowURL | string |
A URL do 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 de Tarefa
|
workflowDisplayName | string |
O nome para exibição do fluxo de trabalho associado à tarefa. |
|
Categoria de fluxo de trabalho de tarefa
|
workflowCategory | string |
A categoria do fluxo de trabalho associado à tarefa. |
|
ID da instância do fluxo de trabalho da tarefa
|
workflowInstanceID | integer |
O ID da instância do fluxo de trabalho associado à tarefa. |
|
Fólio do fluxo de trabalho de tarefas
|
workflowInstanceFolio | string |
O fólio da instância do fluxo de trabalho associada à tarefa. |
|
ID da instância da tarefa
|
activityInstanceID | integer |
O ID da instância de atividade da tarefa. |
|
ID de Destino da Tarefa
|
activityInstanceDestinationID | integer |
O 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 da Tarefa
|
eventDescription | string |
A descrição do evento da tarefa. |
|
originador
|
originator | User | |
|
ações
|
actions | TaskActionsResponse | |
|
Campos de Dados do Fluxo de Trabalho de Tarefas
|
workflowInstanceDataFields | object |
Os campos de dados da instância do fluxo de trabalho. |
|
Campos de Dados de Atividade da Tarefa
|
activityDataFields | object |
Os campos de dados da atividade. |
|
Campos XML do Fluxo de Trabalho de Tarefas
|
workflowInstanceXmlFields | array of UserDefinedXmlField |
Os campos XML da instância do fluxo de trabalho. |
|
Referências de item de tarefa
|
itemReferences | object |
As referências de item da instância do fluxo de trabalho. |
|
Instruções
|
instruction | string | |
|
Cadeia de Dados de Campos de Fluxo de Trabalho de Tarefas
|
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 |
String que representa as referências de item da instância do fluxo de trabalho. |
WorkflowLabelsResponse[WorkflowLabel]
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Contagem de itens
|
itemCount | integer |
O número de fluxos de trabalho. |
|
Fluxos de trabalho
|
workflows | array of WorkflowLabel |
Uma lista de fluxos de trabalho. |
WorkflowLabel
| Name | 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 do fluxo de trabalho. |
|
Nome do sistema de fluxo de trabalho
|
systemName | string |
O nome do sistema de fluxo de trabalho. |
WorkflowDataResponse
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
workflowInfo
|
workflowInfo | WorkflowDefinition | |
|
Esquema de fluxo de trabalho
|
workflowSchema | string |
O esquema do fluxo de trabalho. |
Definição de fluxo de trabalho
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Nome do fluxo de trabalho
|
name | string |
O nome do fluxo de trabalho. |
|
Descrição do fluxo de trabalho
|
description | string |
A 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
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
EventInstance
|
EventInstance | EventInstance | |
|
Descrição da instância do evento
|
Description | string |
Descrição da instância do evento. |
|
Duração esperada da instância do evento
|
ExpectedDuration | integer |
Duração esperada da instância do evento. |
|
ID da instância do evento
|
ID | integer |
ID da instância do evento. |
|
Metadados da instância do evento
|
MetaData | string |
Metadados para a instância do evento. |
|
Nome da instância do evento
|
Name | string |
Nome da instância do evento. |
|
Prioridade da instância do evento
|
Priority | integer |
Prioridade da instância do evento. |
|
Data de início da instância do evento
|
StartDate | date-time |
Data e hora em que a instância do evento foi iniciada. |
número inteiro
Este é o tipo de dados básico 'inteiro'.
objecto
Este é o tipo 'objeto'.