Workflow K2 (préversion)
Utilisez le service d’API de flux de travail K2 pour travailler à distance avec des flux de travail et des tâches.
Ce connecteur est disponible dans les produits et régions suivants :
| Service | classe | Régions |
|---|---|---|
| Copilot Studio | Norme | Toutes les régions Power Automate , à l’exception des éléments suivants : - Us Government (GCC) - Us Government (GCC High) - China Cloud géré par 21Vianet - Us Department of Defense (DoD) |
| Applications logiques | Norme | Toutes les régions Logic Apps , à l’exception des suivantes : - Régions Azure Government - Régions Azure Chine - Us Department of Defense (DoD) |
| Power Apps | Norme | Toutes les régions Power Apps , à l’exception des suivantes : - Us Government (GCC) - Us Government (GCC High) - China Cloud géré par 21Vianet - Us Department of Defense (DoD) |
| Power Automate | Norme | Toutes les régions Power Automate , à l’exception des éléments suivants : - Us Government (GCC) - Us Government (GCC High) - China Cloud géré par 21Vianet - Us Department of Defense (DoD) |
| Contact | |
|---|---|
| URL | https://portal.k2.com/ticket/default |
| Métadonnées du connecteur | |
|---|---|
| Éditeur | K2 |
| Site internet | https://www.k2.com |
| Politique de confidentialité | https://www.k2.com/legal/privacy-policy |
Création d’une connexion
Le connecteur prend en charge les types d’authentification suivants :
| Par défaut | Paramètres de création de connexion. | Toutes les régions | Non partageable |
Faire défaut
Applicable : Toutes les régions
Paramètres de création de connexion.
Cette connexion n’est pas partageable. Si l’application power est partagée avec un autre utilisateur, un autre utilisateur est invité à créer une connexion explicitement.
| Nom | Type | Descriptif | Obligatoire |
|---|---|---|---|
| K2 URL | ficelle | Votre URL K2 (exemple : https://[K2ID].onk2.com). | Vrai |
| Nom d’utilisateur | securestring | Nom d’utilisateur de cette API | Vrai |
| Mot de passe | securestring | Mot de passe de cette API | Vrai |
Limitations
| Nom | Appels | Période de renouvellement |
|---|---|---|
| Appels d’API par connexion | 100 | 60 secondes |
Actions
| Affecter une tâche |
Affecte une tâche à l’utilisateur actuel. |
| Démarrer le flux de travail |
Crée et démarre une nouvelle instance de flux de travail. |
| Get Server Event |
Obtient un événement de serveur par numéro de série. |
| Obtenir des actions de tâche |
Obtient une liste d’actions pour la tâche. |
| Obtenir des flux de travail |
Obtenez la liste des flux de travail disponibles. |
| Obtenir des tâches |
Obtenez la liste des tâches disponibles pour l’utilisateur connecté. |
| Obtenir la tâche |
Obtient une tâche par numéro de série. |
| Obtenir le flux de travail |
Obtient une définition de flux de travail par ID. |
| Terminer l’événement serveur |
Envoyer une réponse finale à une tâche de serveur asynchrone en attente d’une réponse |
| Tâche de mise en production |
Libère une tâche. |
| Tâche de mise en éveil |
Réveille une tâche en sommeil. |
| Tâche de redirection |
Envoie une tâche à une autre personne. |
| Tâche de veille |
Met en veille une tâche pendant une durée, soit en nombre de secondes, soit jusqu’à une date. |
| Tâche d’action |
Effectue une action de flux de travail. |
Affecter une tâche
Affecte une tâche à l’utilisateur actuel.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Numéro de série
|
serialNumber | True | string |
Numéro de série de la tâche. Ex : 1234_5678 |
Retours
- response
- object
Démarrer le flux de travail
Crée et démarre une nouvelle instance de flux de travail.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de flux de travail
|
id | True | integer |
Spécifiez un ID de flux de travail pour démarrer l’instance. |
|
Détails de l’instance de flux de travail
|
instance | True | dynamic |
Envoyer l’objet d’instance de flux de travail pour démarrer le flux de travail. |
Retours
- response
- integer
Get Server Event
Obtient un événement de serveur par numéro de série.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Numéro de série de l’événement serveur
|
serialNumber | True | string |
Numéro de série de l’événement de serveur. Ex : 1234_5678. |
Retours
- Corps
- ServerEventDataResponse
Obtenir des actions de tâche
Obtient une liste d’actions pour la tâche.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Numéro de série
|
serialNumber | True | string |
Numéro de série de la tâche. Ex : 1234_5678 |
Retours
- Corps
- TaskActionsResponse
Obtenir des flux de travail
Obtenez la liste des flux de travail disponibles.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Type de flux de travail
|
type | string |
Type de flux de travail. Startable ou Owned. |
Retours
Obtenir des tâches
Obtenez la liste des tâches disponibles pour l’utilisateur connecté.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
All, Allocation, Sleeping, SharedFrom, SharedTo
|
state | string |
Retourne la liste des tâches de l’utilisateur connecté. |
Retours
- Corps
- TasksResponse
Obtenir la tâche
Obtient une tâche par numéro de série.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Numéro de série
|
serialNumber | True | string |
Numéro de série de la tâche. Ex : 1234_5678 |
Retours
- Corps
- Task
Obtenir le flux de travail
Obtient une définition de flux de travail par ID.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de flux de travail
|
id | True | integer |
ID du flux de travail. |
Retours
- Corps
- WorkflowDataResponse
Terminer l’événement serveur
Envoyer une réponse finale à une tâche de serveur asynchrone en attente d’une réponse
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Numéro de série de l’événement serveur
|
serialNumber | True | string |
Numéro de série de l’événement de serveur. Ex : 1234_5678 |
|
Nom du champ XML
|
name | string |
Nom d’un champ XML. |
|
|
Valeur du champ XML
|
value | string |
Valeur du champ XML. |
|
|
Références d’éléments
|
ItemReferences | object |
Champs Référence d’élément de l’instance de flux de travail. |
|
|
Champs de données
|
DataFields | object |
Champs de données de l’instance de workflow. |
Tâche de mise en production
Libère une tâche.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Numéro de série
|
serialNumber | True | string |
Numéro de série de la tâche. Ex : 1234_5678 |
Tâche de mise en éveil
Réveille une tâche en sommeil.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Numéro de série
|
serialNumber | True | string |
Numéro de série de la tâche. Ex : 1234_5678 |
Retours
- response
- object
Tâche de redirection
Envoie une tâche à une autre personne.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Numéro de série
|
serialNumber | True | string |
Numéro de série de la tâche. Ex : 1234_5678 |
|
Informations de redirection
|
RedirectTo | True | string |
Personne à qui la tâche est redirigée. |
Tâche de veille
Met en veille une tâche pendant une durée, soit en nombre de secondes, soit jusqu’à une date.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Numéro de série
|
serialNumber | True | string |
Numéro de série de la tâche. Ex : 1234_5678 |
|
Veillez pour
|
SleepFor | integer |
Nombre de secondes à mettre en veille une tâche. |
|
|
Veillez jusqu’à ce que
|
SleepUntil | date-time |
Date et heure de mise en éveil de la tâche. Format : aaaa-MM-ddTHH :mm :ss :fffZ UTC |
Tâche d’action
Effectue une action de flux de travail.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Numéro de série
|
serialNumber | True | string |
Numéro de série de la tâche. Ex : 1234_5678 |
|
Action personnalisée
|
customAction | True | string |
Action de tâche, définie par le flux de travail. |
|
Nom du champ XML
|
name | string |
Nom d’un champ XML. |
|
|
Valeur du champ XML
|
value | string |
Valeur du champ XML. |
|
|
Références d’éléments
|
ItemReferences | object |
Champs Référence d’élément de l’instance de flux de travail. |
|
|
Champs de données
|
DataFields | object |
Champs de données de l’instance de workflow. |
Définitions
ServerEventDataResponse
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Numéro de série de l’événement serveur
|
serialNumber | string |
Numéro de série de l’événement de serveur. Ex : 1234_5678 |
|
ID de flux de travail d’événement serveur
|
workflowID | integer |
ID du flux de travail associé à l’événement de serveur. |
|
Nom du flux de travail d’événement serveur
|
workflowName | string |
Nom du flux de travail associé à l’événement de serveur. |
|
Nom d’affichage du flux de travail d’événement serveur
|
workflowDisplayName | string |
Nom complet du flux de travail associé à l’événement de serveur. |
|
Catégorie de flux de travail d’événement serveur
|
workflowCategory | string |
Catégorie du flux de travail associé à l’événement de serveur. |
|
ID d’instance de flux de travail d’événement serveur
|
workflowInstanceID | integer |
ID d’instance du flux de travail associé à l’événement de serveur. |
|
Workflow d’événement serveur Folio
|
workflowInstanceFolio | string |
Feuille de travail de l’instance de flux de travail associée à l’événement serveur. |
|
ID d’instance d’activité d’événement du serveur
|
activityInstanceID | integer |
ID d’instance d’activité de l’événement de serveur. |
|
ID de destination de l’activité d’événement serveur
|
activityInstanceDestinationID | integer |
ID de destination de l’instance d’activité de l’événement serveur. |
|
Nom de l’activité d’événement du serveur
|
activityName | string |
Nom de l’activité de l’événement de serveur. |
|
Nom de l’événement d’événement serveur
|
eventName | string |
Nom de l’événement de serveur. |
|
Description de l’événement d’événement serveur
|
eventDescription | string |
Description de l’événement serveur. |
|
auteur
|
originator | User | |
|
eventInstance
|
eventInstance | EventInstanceWrapper | |
|
Champs de données d’activité d’événement serveur
|
dataFields | object |
Champs de données de l’activité. |
|
Champs XML d’activité d’événement serveur
|
xmlFields | array of UserDefinedXmlField |
Champs XML de l’activité. |
|
Références d’éléments d’événement serveur
|
itemReferences | object |
Références d’élément de l’instance de workflow. |
|
Chaîne des champs de données du flux de travail d’événement serveur
|
workflowInstanceDataFieldsString | string |
Représentation sous forme de chaîne des champs de données de l’instance de flux de travail. |
|
Chaîne de référence d’élément d’événement serveur
|
itemReferencesString | string |
Chaîne représentant les références d’élément de l’instance de workflow. |
|
viewFlowURL
|
viewFlowURL | string |
EventInstance
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Date de début de l’instance d’événement
|
StartDate | date-time |
Date et heure de démarrage de l’instance d’événement. |
|
Durée attendue de l’instance d’événement
|
ExpectedDuration | integer |
Durée attendue de l’instance d’événement. |
|
Priorité de l’instance d’événement
|
Priority | integer |
Priorité de l’instance d’événement. |
|
Métadonnées d’instance d’événement
|
MetaData | string |
Métadonnées de l’instance d’événement. |
|
Description de l’instance d’événement
|
Description | string |
Description de l’instance d’événement. |
|
Nom de l’instance d’événement
|
Name | string |
Nom de l’instance d’événement. |
|
ID d’instance d’événement
|
ID | integer |
ID de l’instance d’événement. |
UserDefinedXmlField
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Nom du champ XML
|
name | string |
Nom d’un champ XML. |
|
Valeur du champ XML
|
value | string |
Valeur du champ XML. |
TasksResponse
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Nombre de tâches
|
itemCount | integer |
Nombre de tâches retournées. |
|
Tasks
|
tasks | array of TaskLite |
Une ou plusieurs tâches. |
TaskLite
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Numéro de série de la tâche
|
serialNumber | string |
Numéro de série de la tâche. Ex : 1234_5678 |
|
État de la tâche
|
status | string |
État de la tâche. Ex : Ouvrir, Terminé, Veille, Alloué, Disponible |
|
Date de début de la tâche
|
taskStartDate | date-time |
Date de début de la tâche. |
|
Durée de veille des tâches
|
sleepUntil | date-time |
Date et heure de mise en éveil de la tâche. |
|
Priorité des tâches
|
priority | integer |
Priorité de la tâche. |
|
URL du formulaire de tâche
|
formURL | string |
URL de formulaire de la tâche. |
|
URL du flux d’affichage des tâches
|
viewFlowURL | string |
URL de flux d’affichage de la tâche. |
|
ID du flux de travail de tâche
|
workflowID | integer |
ID du flux de travail associé à la tâche. |
|
Nom du flux de travail de tâche
|
workflowName | string |
Nom du flux de travail associé à la tâche. |
|
Nom d’affichage du flux de travail de tâche
|
workflowDisplayName | string |
Nom complet du flux de travail associé à la tâche. |
|
Catégorie de flux de travail de tâche
|
workflowCategory | string |
Catégorie du flux de travail associé à la tâche. |
|
ID d’instance de workflow de tâche
|
workflowInstanceID | integer |
ID d’instance du flux de travail associé à la tâche. |
|
Workflow de tâche Feuille de travail
|
workflowInstanceFolio | string |
Feuille de travail de l’instance de flux de travail associée à la tâche. |
|
ID de l’instance de tâche
|
activityInstanceID | integer |
ID d’instance d’activité de la tâche. |
|
ID de destination de l’activité de tâche
|
activityInstanceDestinationID | integer |
ID de destination de l’instance d’activité de la tâche. |
|
Nom de l’activité de tâche
|
activityName | string |
Nom de l’activité de la tâche. |
|
Nom de l’événement de tâche
|
eventName | string |
Nom de l’événement de la tâche. |
|
Description de l’événement task
|
eventDescription | string |
Description de l’événement de la tâche. |
|
auteur
|
originator | User | |
|
Actions
|
actions | TaskActionsResponse | |
|
Instructions de tâche
|
instruction | string |
Instructions associées à la tâche. |
Utilisateur
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Nom d'utilisateur
|
username | string |
Nom d’utilisateur de la personne. |
|
Nom de domaine complet de l’utilisateur
|
fqn | string |
Nom complet de la personne. Ex : bob@denallix.com, K2 :Denallix\Bob |
|
E-mail utilisateur
|
string |
Adresse e-mail de la personne. |
|
|
Gestionnaire d’utilisateurs
|
manager | string |
Responsable de la personne. |
|
Nom d’affichage de l’utilisateur
|
displayName | string |
Nom complet de la personne. |
TaskActionsResponse
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Actions non modifiables
|
nonBatchableActions | array of string |
Liste des actions qui ne peuvent pas être effectuées sans affecter la tâche. |
|
Actions batchables
|
batchableActions | array of string |
Liste des actions qui peuvent être effectuées sans affecter la tâche. |
|
Actions système
|
systemActions | array of string |
Liste des actions système. |
Tâche
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Numéro de série de la tâche
|
serialNumber | string |
Numéro de série de la tâche. Ex : 1234_5678 |
|
État de la tâche
|
status | string |
État de la tâche. Ex : Ouvrir, Terminé, Veille, Alloué, Disponible |
|
Date de début de la tâche
|
taskStartDate | date-time |
Date de début de la tâche. |
|
Durée de veille des tâches
|
sleepUntil | date-time |
Date et heure de mise en éveil de la tâche. |
|
Priorité des tâches
|
priority | integer |
Priorité de la tâche. |
|
URL du formulaire de tâche
|
formURL | string |
URL de formulaire de la tâche. |
|
URL du flux d’affichage des tâches
|
viewFlowURL | string |
URL de flux d’affichage de la tâche. |
|
ID du flux de travail de tâche
|
workflowID | integer |
ID du flux de travail associé à la tâche. |
|
Nom du flux de travail de tâche
|
workflowName | string |
Nom du flux de travail associé à la tâche. |
|
Nom d’affichage du flux de travail de tâche
|
workflowDisplayName | string |
Nom complet du flux de travail associé à la tâche. |
|
Catégorie de flux de travail de tâche
|
workflowCategory | string |
Catégorie du flux de travail associé à la tâche. |
|
ID d’instance de workflow de tâche
|
workflowInstanceID | integer |
ID d’instance du flux de travail associé à la tâche. |
|
Workflow de tâche Feuille de travail
|
workflowInstanceFolio | string |
Feuille de travail de l’instance de flux de travail associée à la tâche. |
|
ID de l’instance de tâche
|
activityInstanceID | integer |
ID d’instance d’activité de la tâche. |
|
ID de destination de tâche
|
activityInstanceDestinationID | integer |
ID de destination de l’instance d’activité de la tâche. |
|
Nom de l’activité de tâche
|
activityName | string |
Nom de l’activité de la tâche. |
|
Nom de l’événement de tâche
|
eventName | string |
Nom de l’événement de la tâche. |
|
Description de l’événement task
|
eventDescription | string |
Description de l’événement de la tâche. |
|
auteur
|
originator | User | |
|
Actions
|
actions | TaskActionsResponse | |
|
Champs de données de flux de travail de tâche
|
workflowInstanceDataFields | object |
Champs de données de l’instance de workflow. |
|
Champs de données d’activité des tâches
|
activityDataFields | object |
Champs de données de l’activité. |
|
Champs XML du flux de travail de tâche
|
workflowInstanceXmlFields | array of UserDefinedXmlField |
Champs XML de l’instance de flux de travail. |
|
Références d’éléments de tâche
|
itemReferences | object |
Références d’élément de l’instance de workflow. |
|
instruction
|
instruction | string | |
|
Chaîne des champs de données de flux de travail de tâche
|
workflowInstanceDataFieldsString | string |
Représentation sous forme de chaîne des champs de données de l’instance de flux de travail. |
|
Chaîne de références d’élément de tâche
|
itemReferencesString | string |
Chaîne représentant les références d’élément de l’instance de workflow. |
WorkflowLabelsResponse[WorkflowLabel]
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Nombre d’éléments
|
itemCount | integer |
Nombre de flux de travail. |
|
Workflows
|
workflows | array of WorkflowLabel |
Liste des flux de travail. |
WorkflowLabel
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID de flux de travail
|
id | integer |
ID du flux de travail. |
|
Version par défaut du flux de travail
|
defaultVersionId | integer |
Version de workflow par défaut. |
|
Nom du flux de travail
|
name | string |
Nom du flux de travail. |
|
Dossier de flux de travail
|
folder | string |
Dossier de flux de travail. |
|
Nom du système de flux de travail
|
systemName | string |
Nom du système de flux de travail. |
WorkflowDataResponse
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
workflowInfo
|
workflowInfo | WorkflowDefinition | |
|
Schéma de flux de travail
|
workflowSchema | string |
Schéma du flux de travail. |
WorkflowDefinition
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Nom du flux de travail
|
name | string |
Nom du workflow. |
|
Description du flux de travail
|
description | string |
Description du workflow. |
|
Dossier de flux de travail
|
folder | string |
Dossier (catégorie) du flux de travail. |
|
Nom du système de flux de travail
|
systemName | string |
Nom système du flux de travail. |
|
Durée attendue du flux de travail
|
expectedDuration | integer |
Durée attendue du flux de travail. |
EventInstanceWrapper
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
EventInstance
|
EventInstance | EventInstance | |
|
Description de l’instance d’événement
|
Description | string |
Description de l’instance d’événement. |
|
Durée attendue de l’instance d’événement
|
ExpectedDuration | integer |
Durée attendue de l’instance d’événement. |
|
ID d’instance d’événement
|
ID | integer |
ID de l’instance d’événement. |
|
Métadonnées d’instance d’événement
|
MetaData | string |
Métadonnées de l’instance d’événement. |
|
Nom de l’instance d’événement
|
Name | string |
Nom de l’instance d’événement. |
|
Priorité de l’instance d’événement
|
Priority | integer |
Priorité de l’instance d’événement. |
|
Date de début de l’instance d’événement
|
StartDate | date-time |
Date et heure de démarrage de l’instance d’événement. |
entier
Il s’agit du type de données de base 'integer'.
objet
Il s’agit du type "objet".