SIGNL4 - Alertes mobiles
SIGNL4 offre des alertes mobiles critiques, une réponse aux incidents et une répartition des services pour l’infrastructure critique. Il vous avertit de manière permanente via l’envoi (push) d’application, de sms et d’appels vocaux, notamment le suivi, l’escalade, la collaboration et la planification des tâches.
Ce connecteur est disponible dans les produits et régions suivants :
| Service | classe | Régions |
|---|---|---|
| Copilot Studio | Premium | 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 | Premium | 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 | Premium | 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 | |
|---|---|
| Nom | Derdack GmbH |
| URL | https://www.signl4.com/feedback-we-love-hear-from-you/ |
| Messagerie électronique | success@signl4.com |
| Métadonnées du connecteur | |
|---|---|
| Éditeur | Derdack |
| Site internet | https://www.signl4.com |
| Politique de confidentialité | https://www.signl4.com/privacy-policy/ |
| Catégories | Opérations informatiques ; Communication |
SIGNL4 offre des alertes critiques, une réponse aux incidents et une répartition des services pour l’infrastructure critique. Il vous avertit de manière permanente via l’envoi (push) d’application, de sms et d’appels vocaux, notamment le suivi, l’escalade, la collaboration et la planification des tâches.
Vous pouvez intégrer SIGNL4 dans votre flux afin d’envoyer des alertes d’équipe fiables chaque fois que nécessaire.
Prerequisites
Vous avez besoin d’un compte SIGNL4. Si vous n’en avez pas déjà, vous pouvez en obtenir un à https://connect.signl4.com/. Vous pouvez également télécharger directement l’application mobile à partir du Google Play Store ou à partir de l’App Store Apple.
Comment obtenir des informations d’identification
Pour utiliser le connecteur, vous avez besoin de votre clé API SIGNL4. Dans le portail web SIGNL4, vous obtenez votre clé API sous Intégrations -> Clé API. Vous pouvez ensuite utiliser votre clé API pour authentifier votre connecteur SIGNL4 dans Power Automate.
Bien démarrer avec votre connecteur
Vous trouverez ici une description détaillée des fonctions d’API SIGNL4. Après avoir ajouté le connecteur SIGNL4 à votre flux Power Automate, vous devez obtenir la clé API SIGNL4. Vous pouvez ensuite utiliser les fonctions d’API en conséquence. Si vous devez avoir d’autres questions, n’hésitez pas à contacter l’équipe SIGNL4.
Le moyen le plus simple de démarrer consiste à utiliser l’action EventsSend pour envoyer une alerte :
- Commencez par obtenir votre secret d’équipe SIGNL4 / secret d’intégration à partir de votre portail web SIGNL4.
- Lorsque vous disposez du secret d’équipe /secret d’intégration, vous pouvez l’utiliser dans la fonction EventsSend pour déclencher un événement qui peut générer une alerte pour votre équipe. Vous devez simplement entrer n’importe quel titre et message. Vous trouverez une description des autres paramètres sur la page de documentation du webhook entrant.
- C’est-à-dire que vous déclenchez un événement et recevez une alerte dans SIGNL4.
Problèmes connus et limitations
Le connecteur SIGNL4 pour Power Automate encapsule l’ENSEMBLE de l’API REST SIGNL4 2.0. Certaines fonctionnalités dépendent de votre plan SIGNL4.
Erreurs courantes et solutions
N/A
Questions fréquentes (FAQ)
Vous trouverez ici le FAQ SIGNL4 et l’aide en ligne. Il existe également une bibliothèque vidéo complète disponible.
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 |
|---|---|---|---|
| Clé d’API | securestring | Clé API pour cette API | Vrai |
Limitations
| Nom | Appels | Période de renouvellement |
|---|---|---|
| Appels d’API par connexion | 100 | 60 secondes |
Actions
| Accuser réception d’une alerte |
Accusez réception d’une alerte. |
| Acknowlegde plusieurs alertes |
Cette méthode confirme toutes les alertes fournies. |
| Active une instance de script |
Active une instance de script. |
| Ajouter un utilisateur à une équipe |
Ajoutez un utilisateur à une équipe. |
| Annoter l’alerte |
Annote une alerte en fonction des informations d’annotation données. |
| Annulation de file d’attente de plusieurs accusés de réception |
Cette méthode tente d’annuler l’accusé de réception de plusieurs alertes via une file d’attente. L’opération est gérée en arrière-plan. |
| Annuler la fermeture d’une alerte |
Cette méthode tente d’annuler une fermeture d’alerte. |
| Annuler l’accusé de réception d’une alerte |
Cette méthode tente d’annuler un accusé de réception d’alerte. |
| Chargement d’une image de profil pour un utilisateur spécifié |
Chargement d’une image de profil pour un utilisateur spécifié. |
| Chargement d’une image de profil pour une équipe spécifiée |
Chargement d’une image de profil pour une équipe spécifiée. |
| Confirme toutes les alertes visibles |
Cette méthode confirme toutes les alertes non gérées que votre équipe possède actuellement par un utilisateur spécifique. |
| Copier les vacances d’une équipe vers une autre |
Copiez les vacances d’une équipe vers une autre. |
| Creat ou Mettre à jour le calendrier des devoirs donné |
Créer/mettre à jour une planification de service donnée. |
| Crée une instance de script dans l’équipe SIGNL4 |
Crée une instance de script du script spécifié dans le corps de la requête. |
| Créer des modèles de légende pour votre abonnement |
Créez de nouveaux modèles de légende pour votre abonnement. |
| Créer un modèle d’alerte |
Créez un modèle d’alerte. |
| Créer un travail distant |
Exemple de demande :
|
| Créer un webhook |
Crée un webhook sortant qui sera averti lorsque certains événements se produisent. |
| Créer une action à distance |
Exemple de demande :
|
| Créer une catégorie |
Exemple de demande :
|
| Créer une source d’événement |
Créez une source d’événement. |
| Déclencher une alerte |
Déclenche une nouvelle alerte pour votre équipe. Tous les membres de l’équipe en service recevront des notifications d’alerte. |
| Définir des abonnements de catégorie |
Exemple de demande :
|
| Définir des profils de notification pour l’utilisateur |
Définissez des profils de notification pour l’utilisateur. |
| Définir le numéro de téléphone d’un utilisateur |
Définissez le numéro de téléphone d’un utilisateur. Si un autre numéro de téléphone est enregistré, il est remplacé. |
| Définir l’emplacement d’un utilisateur |
Définir l’emplacement d’un utilisateur. |
| Définit les paramètres d’alerte d’une équipe spécifique |
Définit les paramètres d’alerte d’une équipe spécifique. |
| Désactive une instance de script donnée |
Désactive une instance de script donnée. |
| Enregistrer les congés d’une équipe |
Enregistrez les vacances pour une équipe. |
| Enregistrer les vacances répétées pour une équipe |
Enregistrez les vacances répétées pour une équipe. |
| Enregistrer plusieurs planifications |
Enregistrez plusieurs planifications. Il est possible de remplacer les planifications existantes si vous le souhaitez. |
| Envoie un courrier à un utilisateur spécifié |
Envoie un courrier à un utilisateur spécifié qui contient des informations sur toutes les sources d’événements de l’équipe de l’utilisateur. |
| Envoie à nouveau l’e-mail d’invitation s’il existe une invitation |
Envoie à nouveau un e-mail d’invitation s’il existe une invitation. |
| Envoyer un événement |
Envoyer un événement. |
| Extraire l’utilisateur |
L’utilisateur spécifié est sorti du devoir. |
| Fermer plusieurs alertes |
Cette méthode ferme toutes les alertes fournies. |
| Fermer toutes les alertes reconnues |
Cette méthode ferme toutes les alertes reconnues que votre équipe a actuellement. |
| Fermer une alerte |
Fermez une alerte. |
| Inviter des utilisateurs à une équipe |
Inviter des utilisateurs à une équipe. |
| Met à jour le mot de passe d’un utilisateur |
Met à jour le mot de passe d’un utilisateur. |
| Met à jour le profil d’équipe d’une équipe |
Met à jour le profil d’équipe d’une équipe. |
| Met à jour le profil utilisateur d’un utilisateur |
Met à jour le profil utilisateur d’un utilisateur. |
| Met à jour les données personnalisées d’une instance de script donnée qui inclut son nom d’affichage |
Met à jour l’instance de script spécifiée. |
| Met à jour un profil d’abonnements |
Met à jour un profil d’abonnements. |
| Met à jour une action à distance |
Exemple de demande :
|
| Met à jour une instance de script donnée |
Met à jour l’instance de script spécifiée, généralement utilisée pour mettre à jour la configuration d’un script. |
| Mettre à jour le modèle de légende existant pour votre abonnement |
Mettez à jour le modèle de légende existant pour votre abonnement. |
| Mettre à jour le Webhook par ID |
Met à jour le webhook spécifié. |
| Mettre à jour les informations de paramètres régionaux (par exemple, langue, fuseau horaire) pour l’utilisateur |
Mettez à jour les informations de paramètres régionaux (par exemple, langue, fuseau horaire) pour l’utilisateur. |
| Mettre à jour les paramètres de confidentialité d’une équipe |
Mettez à jour les paramètres de confidentialité d’une équipe. |
| Mettre à jour les paramètres prépayés actuels de votre abonnement |
Mettez à jour les paramètres prépayés actuels de votre abonnement. |
| Mettre à jour les paramètres prépayés actuels d’un abonnement |
Mettez à jour les paramètres prépayés actuels d’un abonnement. |
| Mettre à jour l’appartenance à l’équipe de l’utilisateur |
Met à jour l’appartenance de l’équipe de l’utilisateur. Vous pouvez déplacer l’utilisateur vers une autre équipe au sein de l’abonnement et/ou modifier le rôle de l’utilisateur. |
| Mettre à jour un modèle d’alerte existant |
Mettez à jour un modèle d’alerte existant. |
| Mettre à jour une catégorie existante |
Exemple de demande :
|
| Mettre à jour une source d’événement |
Mettez à jour une source d’événement. |
| Obtenir des abonnements de catégorie |
Exemple de demande :
|
| Obtenir des détails sur une alerte |
Obtenez des détails sur une alerte. |
| Obtenir des entrées de chronologie d’alerte |
Obtenir les entrées de chronologie des alertes d’une alerte par ID. |
| Obtenir des informations de toutes les équipes |
Obtenez des informations sur toutes les équipes. |
| Obtenir des informations d’un abonnement spécifique |
Obtenez des informations sur un abonnement spécifique. |
| Obtenir des informations pour toutes les équipes de l’abonnement |
Obtenez des informations pour toutes les équipes de l’abonnement. |
| Obtenir des informations publiques sur toutes les équipes d’un abonnement |
Obtenez des informations publiques sur toutes les équipes d’un abonnement. |
| Obtenir des informations sur les pièces jointes d’une alerte |
Obtenir des pièces jointes d’une alerte par ID. |
| Obtenir des informations sur les rapports d’alerte téléchargeables |
Obtenez des informations sur les rapports d’alerte téléchargeables. |
| Obtenir des informations sur l’assistant de service pour les équipes |
Obtenez des informations sur l’assistant de service pour les équipes. |
| Obtenir des informations sur tous les abonnements disponibles et gérés |
Obtenez des informations sur tous les abonnements disponibles/gérés. |
| Obtenir des métriques pour toutes les catégories |
Exemple de demande :
|
| Obtenir des métriques pour une catégorie spécifique |
Exemple de demande :
|
| Obtenir des notifications d’alerte |
Obtenez des notifications de tous les utilisateurs par ID d’alerte. |
| Obtenir des profils de notification pour l’utilisateur |
Obtenir des profils de notification pour l’utilisateur. |
| Obtenir des sources d’événements d’une ou plusieurs équipes |
Obtenir des sources d’événements d’une ou plusieurs équipes. |
| Obtenir des vacances pour l’équipe |
Obtenez des vacances pour l’équipe. |
| Obtenir des webhooks |
Retourne une collection de webhooks sortants définis dans le système. |
| Obtenir la source d’événement par ID |
Obtenir la source d’événement par ID. |
| Obtenir le solde prépayé actuel de votre abonnement |
Obtenez le solde prépayé actuel de votre abonnement. |
| Obtenir le solde prépayé actuel d’un abonnement |
Obtenez le solde prépayé actuel d’un abonnement. |
| Obtenir les appartenances à l’équipe d’un utilisateur |
Obtenir les appartenances à l’équipe d’un utilisateur. |
| Obtenir les appartenances à l’équipe par équipe |
Obtenez les appartenances à l’équipe par équipe. |
| Obtenir les détails d’un événement |
Obtenez les détails d’un événement. |
| Obtenir les paramètres de confidentialité de l’équipe pour une équipe |
Obtenir les paramètres de confidentialité de l’équipe pour une équipe. |
| Obtenir les paramètres de service d’équipe pour plusieurs équipes |
Obtenir les paramètres de service d’équipe pour plusieurs équipes. |
| Obtenir les paramètres d’événement |
Obtenir les paramètres d’un événement par ID. |
| Obtenir les paramètres prépayés actuels de votre abonnement |
Obtenez les paramètres prépayés actuels de votre abonnement. |
| Obtenir les paramètres prépayés actuels d’un abonnement |
Obtenez les paramètres prépayés actuels d’un abonnement. |
| Obtenir les transactions prépayées de votre abonnement |
Obtenez les transactions prépayées de votre abonnement. |
| Obtenir les transactions prépayées d’un abonnement |
Obtenez les transactions prépayées d’un abonnement. |
| Obtenir l’état des droits par ID d’utilisateur |
Retourne un objet avec des informations de devoir. |
| Obtenir tous les modèles de légende pour votre abonnement |
Obtenez tous les modèles de légende pour votre abonnement. |
| Obtenir tous les modèles d’alerte de l’équipe |
Obtenez tous les modèles d’alerte de l’équipe. |
| Obtenir tous les utilisateurs |
Retourne une liste d’objets utilisateur avec des détails tels que leur adresse e-mail et leurs informations de service. Seuls les utilisateurs auxquels vous avez accès seront retournés. |
| Obtenir toutes les catégories |
Obtenez toutes les catégories. |
| Obtenir toutes les catégories |
Exemple de demande :
|
| Obtenir toutes les équipes dont l’utilisateur est membre |
Retourne une liste d’objets d’équipe avec des détails tels que leur nom. Seules les équipes dont l’utilisateur est membre sont retournées. |
| Obtenir un rapport d’alerte |
Retourne des informations sur le volume d’alerte survenu dans différentes périodes, ainsi que sur le comportement de réponse (quantité d’alertes confirmées et non gérées) des membres de l’équipe. |
| Obtenir un utilisateur par ID |
Retourne un objet utilisateur avec des détails tels que son adresse e-mail et ses informations de service. |
| Obtenir un événement de vue d’ensemble |
Obtenir l’événement de vue d’ensemble par ID. |
| Obtenir une alerte |
Obtient une alerte par ID. |
| Obtenir une catégorie spécifique |
Exemple de demande :
|
| Obtenir une image utilisateur personnelle |
Obtenir une image utilisateur personnelle. |
| Obtenir une vue d’ensemble de l’événement paginé |
Obtenir une vue d’ensemble de l’événement paginé. S’il existe d’autres résultats, vous obtenez également un jeton de continuation que vous pouvez ajouter au filtre d’événements. |
| Obtenir webhook par ID |
Retourne les informations du webhook spécifié par l’ID passé. |
| Obtention de tous les utilisateurs d’équipes spécifiées |
Obtention de tous les utilisateurs d’équipes spécifiées. |
| Obtient la progression de la configuration d’un utilisateur spécifique |
Obtient la progression de la configuration d’un utilisateur spécifique. |
| Obtient la progression de la configuration d’une équipe spécifique |
Obtient la progression de la configuration d’une équipe spécifique. |
| Obtient les alertes paginées |
Obtient les alertes paginées. |
| Obtient les informations d’une équipe spécifique |
Obtient des informations d’une équipe spécifique. |
| Obtient les licences de numéro de voix d’un abonnement |
Obtient les licences de numéro de voix d’un abonnement. |
| Obtient les licences utilisateur d’un abonnement |
Obtient les licences utilisateur d’un abonnement. |
| Obtient les noms de toutes les images de catégorie d’alerte |
Obtient les noms de toutes les images de catégorie d’alerte. Vous pouvez obtenir l’image en accédant à account.signl4.com/images/alerts/categoryImageName.svg. |
| Obtient les paramètres d’alerte d’une équipe spécifique |
Obtient les paramètres d’alerte d’une équipe spécifique. |
| Obtient les paramètres d’alerte d’une équipe spécifique |
Obtient les paramètres d’alerte d’une équipe spécifique. |
| Obtient les sources d’événements d’une équipe spécifique |
Obtient les sources d’événements d’une équipe spécifique. |
| Obtient l’image d’une équipe spécifiée |
Obtient l’image d’une équipe spécifiée. |
| Obtient une pièce jointe spécifiée d’une alerte spécifiée |
Obtient une pièce jointe spécifiée d’une alerte spécifiée. |
| Percutez l’utilisateur dans |
L’utilisateur spécifié sera percé en fonction. |
| Percutez l’utilisateur en tant que Gestionnaire |
L’utilisateur spécifié est percuté en tant que responsable. |
|
Possibilité de désactiver un web |
Possibilité de désactiver un webHook. |
|
Possibilité d’activer un web |
Possibilité d’activer un webHook. |
| Remonter une alerte manuellement à une équipe |
Réaffectez une alerte manuellement à une équipe. |
| Retirer la fermeture de plusieurs alertes |
Cette méthode tente d’annuler plusieurs fermetures d’alerte. L’opération est gérée en arrière-plan. |
| Retourne des actions distantes |
Exemple de demande :
|
| Retourne des informations sur toutes les planifications planifiées |
Retourne des informations sur toutes les planifications planifiées. |
| Retourne le rapport d’alerte |
Retourne le rapport d’alerte. |
| Retourne les fonctionnalités d’un abonnement spécifié |
Retourne les fonctionnalités d’un abonnement spécifié. |
| Retourne les informations de la planification des droits avec l’ID spécifié |
Retourne les informations de la planification des droits avec l’ID spécifié. |
| Retourne les informations de prix du canal de l’abonnement |
Retourne les informations de prix du canal de l’abonnement. |
| Retourne les travaux distants paginés à partir du journal |
Exemple de demande :
|
| Retourne tous les scripts d’inventaire |
Retourne tous les scripts d’inventaire. |
| Retourne tous les scripts d’inventaire disponibles |
Retourne tous les scripts d’inventaire disponibles qui peuvent être ajoutés à un abonnement SIGNL4. |
| Retourne toutes les informations relatives à une instance de script donnée |
Obtient l’instance de script spécifiée par l’ID d’instance passé. |
| Retourne toutes les instances de script de l’équipe SIGNL4 |
Retourne toutes les instances de script dans l’abonnement. |
| Retourne un script d’inventaire par son ID |
Obtient le script spécifié par l’ID de script passé. |
| Retourne un travail distant à partir du journal |
Exemple de demande :
|
| Retourne une action distante |
Exemple de demande :
|
| Récupérer toute la définition disponible |
Récupérez toute la définition disponible. |
| Récupérer une définition |
Récupérer une définition. |
| Supprime le compte d’utilisateur |
Supprime le compte d’utilisateur. |
| Supprime l’image d’équipe actuelle |
Supprime l’image d’équipe actuelle. |
| Supprime un utilisateur ou une invitation d’une équipe |
Supprime un utilisateur ou une invitation d’une équipe. |
| Supprime une action à distance |
Exemple de demande :
|
| Supprime une instance de script |
Obtient l’instance de script spécifiée par l’ID d’instance passé. |
| Supprimer le modèle de légende existant de votre abonnement |
Supprimez le modèle de légende existant de votre abonnement. |
| Supprimer le numéro de téléphone d’un utilisateur |
Supprimez le numéro de téléphone d’un utilisateur. |
| Supprimer le Webhook par ID |
Supprime le webhook spécifié afin qu’il ne soit plus averti. |
| Supprimer les jours fériés |
Supprimer les jours fériés. |
| Supprimer les planifications de droits dans la plage |
Supprimez les planifications de droits dans la plage. |
| Supprimer un devoir spécifique |
Supprimez un devoir spécifique. |
| Supprimer un modèle d’alerte spécifique |
Supprimez un modèle d’alerte spécifique. |
| Supprimer une adresse de contact d’un utilisateur |
Supprimez une adresse de contact d’un utilisateur. |
| Supprimer une catégorie existante |
Exemple de demande :
|
| Supprimer une distribution d’événements |
Supprimez une distribution d’événements. |
| Supprimer une image utilisateur personnelle |
Supprimez l’image utilisateur personnelle. |
| Supprimer une source d’événement |
Supprimez une source d’événement. |
|
Télécharger le rapport de droits avec un file |
Téléchargez le rapport de droits avec un fileName spécifique. |
| Valide un numéro de téléphone créé précédemment pour un utilisateur |
Valide un numéro de téléphone créé précédemment pour un utilisateur. |
| Valider un créneau horaire d’un modèle |
Validez un intervalle de temps d’un modèle par rapport à tous les créneaux horaires existants d’autres modèles. |
| Vérifie si un utilisateur dispose de l’autorisation fournie |
Vérifie si un utilisateur dispose de l’autorisation fournie. |
Accuser réception d’une alerte
Accusez réception d’une alerte.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de l’alerte
|
alertId | True | string |
ID pour accuser réception d’une alerte. |
|
descr
|
descr | string | ||
|
uid
|
uid | True | string |
Retours
- Corps
- V2.AlertInfo
Acknowlegde plusieurs alertes
Cette méthode confirme toutes les alertes fournies.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
alertIds
|
alertIds | True | array of string | |
|
descr
|
descr | string | ||
|
uid
|
uid | True | string |
Active une instance de script
Active une instance de script.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’instance de script
|
instanceId | True | string |
ID de l’instance à activer. |
Retours
- Corps
- ScriptInstanceDetails
Ajouter un utilisateur à une équipe
Ajoutez un utilisateur à une équipe.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’équipe
|
teamId | True | string |
ID de l’équipe à qui l’utilisateur doit être invité. |
|
ID d’utilisateur
|
userId | True | string |
ID de l’utilisateur que vous souhaitez ajouter à une équipe. |
|
roleId
|
roleId | string | ||
|
setUserOnDuty
|
setUserOnDuty | boolean |
Retours
- Corps
- V2.TeamMembershipDetails
Annoter l’alerte
Annote une alerte en fonction des informations d’annotation données.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de l’alerte
|
alertId | True | string |
ID de l’alerte à annoter. |
|
texte
|
text | string | ||
|
type
|
type | integer |
|
|
|
userId
|
userId | string |
Retours
Annulation de file d’attente de plusieurs accusés de réception
Cette méthode tente d’annuler l’accusé de réception de plusieurs alertes via une file d’attente. L’opération est gérée en arrière-plan.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
alertIds
|
alertIds | True | array of string | |
|
descr
|
descr | string | ||
|
uid
|
uid | True | string |
Annuler la fermeture d’une alerte
Cette méthode tente d’annuler une fermeture d’alerte.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de l’alerte
|
alertId | True | string |
ID d’alerte. |
|
descr
|
descr | string | ||
|
uid
|
uid | True | string |
Retours
- Corps
- V2.AlertInfo
Annuler l’accusé de réception d’une alerte
Cette méthode tente d’annuler un accusé de réception d’alerte.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de l’alerte
|
alertId | True | string |
ID d’alerte. |
|
descr
|
descr | string | ||
|
uid
|
uid | True | string |
Retours
- Corps
- V2.AlertInfo
Chargement d’une image de profil pour un utilisateur spécifié
Chargement d’une image de profil pour un utilisateur spécifié.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’utilisateur
|
userId | True | string |
ID de l’utilisateur. |
Chargement d’une image de profil pour une équipe spécifiée
Chargement d’une image de profil pour une équipe spécifiée.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’équipe
|
teamId | True | string |
ID d’équipe où définir l’image de l’équipe. |
Confirme toutes les alertes visibles
Cette méthode confirme toutes les alertes non gérées que votre équipe possède actuellement par un utilisateur spécifique.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’utilisateur
|
userId | string |
ID utilisateur de l’utilisateur à utiliser pour reconnaître les alarmes. |
|
|
categoryIds
|
categoryIds | array of string | ||
|
maxDate
|
maxDate | date-time | ||
|
minDate
|
minDate | date-time | ||
|
portée
|
scope | integer |
|
|
|
teamIds
|
teamIds | array of string |
Copier les vacances d’une équipe vers une autre
Copiez les vacances d’une équipe vers une autre.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’équipe
|
teamId | True | string |
ID d’équipe de l’équipe vers laquelle vous souhaitez copier les jours fériés |
|
Année
|
year | True | integer |
Année à partir de laquelle vous souhaitez copier |
|
ID d’équipe
|
sourceTeamId | True | string |
ID d’équipe de l’équipe à partir de laquelle vous souhaitez copier les congés |
Retours
- Corps
- V2.TeamHolidayDetails
Creat ou Mettre à jour le calendrier des devoirs donné
Créer/mettre à jour une planification de service donnée.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’équipe
|
teamId | True | string |
ID de l’équipe à laquelle le devoir doit être attribué. |
|
end
|
end | date-time | ||
|
pièce d'identité
|
id | string | ||
|
options
|
options | integer | ||
|
start
|
start | date-time | ||
|
userId
|
userId | string |
Retours
- Corps
- ScheduleInfo
Crée une instance de script dans l’équipe SIGNL4
Crée une instance de script du script spécifié dans le corps de la requête.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
config
|
config | |||
|
customScriptDescription
|
customScriptDescription | string | ||
|
customScriptName
|
customScriptName | string | ||
|
enabled
|
enabled | boolean | ||
|
instanceId
|
instanceId | string | ||
|
scriptId
|
scriptId | string | ||
|
scriptName
|
scriptName | string | ||
|
sharedTeams
|
sharedTeams | array of string | ||
|
teamId
|
teamId | string |
Retours
- Corps
- ScriptInstanceDetails
Créer des modèles de légende pour votre abonnement
Créez de nouveaux modèles de légende pour votre abonnement.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
categoryId
|
categoryId | string | ||
|
externalId
|
externalId | string | ||
|
pièce d'identité
|
id | string | ||
|
location
|
location | string | ||
|
nom
|
name | string | ||
|
Objet
|
subject | string | ||
|
targetAllTeams
|
targetAllTeams | boolean | ||
|
targetTeamId
|
targetTeamId | string | ||
|
texte
|
text | string | ||
|
workflowType
|
workflowType | integer |
|
Retours
- response
- array of V2.CalloutTemplateDetails
Créer un modèle d’alerte
Créez un modèle d’alerte.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’équipe
|
teamId | True | string |
ID d’équipe pour lequel vous souhaitez créer le modèle |
|
categories
|
categories | array of string | ||
|
enabled
|
enabled | boolean | ||
|
mode
|
mode | integer |
|
|
|
referenceId
|
referenceId | string | ||
|
pièce d'identité
|
id | string | ||
|
nom
|
name | string | ||
|
chaîne
|
channel | integer |
|
|
|
delayInMinutes
|
delayInMinutes | integer | ||
|
enabled
|
enabled | boolean | ||
|
overrideEscalationSettings
|
overrideEscalationSettings | boolean | ||
|
overrideNotificationProfiles
|
overrideNotificationProfiles | boolean | ||
|
overrideResponseSettings
|
overrideResponseSettings | boolean | ||
|
responseMode
|
responseMode | integer |
|
|
|
responseTime
|
responseTime | integer | ||
|
suppressSignl
|
suppressSignl | boolean | ||
|
heure
|
hour | integer | ||
|
minutes
|
minutes | integer | ||
|
jour de la semaine
|
weekday | integer |
|
|
|
pièce d'identité
|
id | string |
Retours
Créer un travail distant
Exemple de demande :
POST /remoteActions/{actionId}/jobs
{
"remoteActionPin" : "1234",
"parameters": [
{
"name": "Param1",
"value": "Value 1"
}
]
}
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’action
|
actionId | True | string |
ID d’action |
|
nom
|
name | True | string | |
|
value
|
value | string | ||
|
alertId
|
alertId | string | ||
|
options
|
options | integer |
|
|
|
remoteActionPin
|
remoteActionPin | string |
Retours
- Corps
- V2.RemoteJob
Créer un webhook
Crée un webhook sortant qui sera averti lorsque certains événements se produisent.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
descriptif
|
description | string | ||
|
extUrl
|
extUrl | True | string | |
|
nom
|
name | True | string | |
|
teamId
|
teamId | string |
Retours
- response
- string
Créer une action à distance
Exemple de demande :
POST /remoteActions
{
"teamId": "cbb70402-1359-477f-ac92-0171cf2b5ff7",
"name": "MyAction",
"enabled": true,
}
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Language
|
language | integer |
|
|
|
nom
|
name | True | string | |
|
value
|
value | string | ||
|
canEdit
|
canEdit | boolean | ||
|
canExecute
|
canExecute | boolean | ||
|
teamId
|
teamId | string | ||
|
définitionId
|
definitionId | string | ||
|
descriptif
|
description | string | ||
|
enabled
|
enabled | boolean | ||
|
nom
|
name | string | ||
|
teamId
|
teamId | string |
Retours
- Corps
- V2.RemoteActionDetails
Créer une catégorie
Exemple de demande :
POST /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7
{
"name": "Water",
"imageName": "water.svg",
"color": "#0000cc",
"keywordMatching": "Any",
"keywords": [
{
"value": "H2O"
},
{
"value": "Water"
}
]
}
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’équipe
|
teamId | True | string |
ID de l’équipe à laquelle appartient la catégorie |
|
enabled
|
enabled | boolean | ||
|
pièce d'identité
|
id | string | ||
|
nom
|
name | string | ||
|
type
|
type | True | integer |
|
|
value
|
value | string | ||
|
color
|
color | True | string | |
|
pièce d'identité
|
id | string | ||
|
nom
|
name | string | ||
|
type
|
type | True | integer |
|
|
value
|
value | string | ||
|
pièce d'identité
|
id | string | ||
|
imageName
|
imageName | True | string | |
|
isDefault
|
isDefault | boolean | ||
|
keywordMatching
|
keywordMatching | True | integer |
|
|
Mots-clés
|
keywords | True | array of string | |
|
keywordsExcluded
|
keywordsExcluded | array of string | ||
|
nom
|
name | True | string | |
|
options
|
options | integer |
|
|
|
order
|
order | integer | ||
|
teamId
|
teamId | string |
Retours
- Corps
- CategoryInfo
Créer une source d’événement
Créez une source d’événement.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
descriptif
|
description | string | ||
|
handicapé
|
disabled | boolean | ||
|
language
|
language | integer |
|
|
|
nom
|
name | string | ||
|
sharedTeams
|
sharedTeams | array of string | ||
|
teamId
|
teamId | string | ||
|
type
|
type | integer |
|
Retours
- Corps
- EventSourceEndpointInfo
Déclencher une alerte
Déclenche une nouvelle alerte pour votre équipe. Tous les membres de l’équipe en service recevront des notifications d’alerte.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
nom
|
name | string | ||
|
order
|
order | integer | ||
|
type
|
type | integer |
|
|
|
value
|
value | string | ||
|
contenu
|
content | string | ||
|
type de contenu
|
contentType | string | ||
|
encodage
|
encoding | integer |
|
|
|
pièce d'identité
|
id | string | ||
|
nom
|
name | string | ||
|
catégorie
|
category | string | ||
|
externalId
|
externalId | string | ||
|
Drapeaux
|
flags | integer |
|
|
|
severity
|
severity | integer |
|
|
|
teamId
|
teamId | True | string | |
|
texte
|
text | True | string | |
|
title
|
title | True | string |
Retours
- Corps
- V2.AlertDetails
Définir des abonnements de catégorie
Exemple de demande :
POST /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7/c0054336-cd89-4abf-882d-ba69b5adb25e/subscriptions
{
}
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’équipe
|
teamId | True | string |
ID de l’équipe à laquelle appartient la catégorie |
|
ID de catégorie
|
categoryId | True | string |
Catégorie à mettre à jour |
|
status
|
status | True | integer |
|
|
userId
|
userId | True | string |
Retours
- response
- array of CategorySubscriptionInfo
Définir des profils de notification pour l’utilisateur
Définissez des profils de notification pour l’utilisateur.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’utilisateur
|
userId | True | string |
ID de l’utilisateur à partir duquel vous souhaitez obtenir les profils de notification. |
|
chaîne
|
channel | integer |
|
|
|
delayInMinutes
|
delayInMinutes | integer | ||
|
enabled
|
enabled | boolean | ||
|
options
|
options | integer | ||
|
persistant
|
persistent | boolean |
Retours
Définir le numéro de téléphone d’un utilisateur
Définissez le numéro de téléphone d’un utilisateur. Si un autre numéro de téléphone est enregistré, il est remplacé.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’utilisateur
|
userId | True | string |
ID utilisateur de l’utilisateur auquel vous souhaitez ajouter un numéro de téléphone |
|
countryCode
|
countryCode | string | ||
|
numéro de téléphone
|
phoneNumber | string | ||
|
sendValidationCode
|
sendValidationCode | boolean | ||
|
sendValidationCodeVia
|
sendValidationCodeVia | integer |
|
Retours
Définir l’emplacement d’un utilisateur
Définir l’emplacement d’un utilisateur.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’utilisateur
|
userId | True | string |
ID de l’utilisateur. |
|
latitude
|
latitude | double | ||
|
longitude
|
longitude | double | ||
|
horodatage
|
timestamp | date-time |
Retours
- Corps
- LocationInfo
Définit les paramètres d’alerte d’une équipe spécifique
Définit les paramètres d’alerte d’une équipe spécifique.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’équipe
|
teamId | True | string |
ID de l’équipe pour laquelle les paramètres doivent être définis. |
|
escEnabled
|
escEnabled | boolean | ||
|
escMode
|
escMode | integer |
|
|
|
escRefId
|
escRefId | string | ||
|
filterAction
|
filterAction | integer |
|
|
|
filterMode
|
filterMode | integer |
|
|
|
chaîne
|
channel | integer |
|
|
|
delay
|
delay | integer | ||
|
enabled
|
enabled | boolean | ||
|
optOut
|
optOut | integer |
|
|
|
overrideNotificationProfiles
|
overrideNotificationProfiles | boolean | ||
|
persNotInterval
|
persNotInterval | integer | ||
|
persNotMode
|
persNotMode | integer |
|
|
|
responseMode
|
responseMode | integer |
|
|
|
responseTime
|
responseTime | integer |
Retours
- Corps
- AlertSettings
Désactive une instance de script donnée
Désactive une instance de script donnée.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’instance de script
|
instanceId | True | string |
ID de l’instance à désactiver. |
Retours
- Corps
- ScriptInstanceDetails
Enregistrer les congés d’une équipe
Enregistrez les vacances pour une équipe.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’équipe
|
teamId | True | string |
ID d’équipe de l’équipe pour laquelle vous souhaitez enregistrer les congés |
|
Année
|
year | True | integer |
Année pour laquelle vous souhaitez économiser des vacances |
|
Jour
|
day | integer | ||
|
month
|
month | integer |
|
Retours
- Corps
- V2.TeamHolidayDetails
Enregistrer les vacances répétées pour une équipe
Enregistrez les vacances répétées pour une équipe.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’équipe
|
teamId | True | string |
ID d’équipe de l’équipe pour laquelle vous souhaitez enregistrer les congés |
|
Jour
|
day | integer | ||
|
month
|
month | integer |
|
Retours
- Corps
- V2.TeamHolidayDetails
Enregistrer plusieurs planifications
Enregistrez plusieurs planifications. Il est possible de remplacer les planifications existantes si vous le souhaitez.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’équipe
|
teamId | True | string |
ID d’équipe à définir |
|
Remplacer
|
overrideExisting | boolean |
Remplacez ou coupez les planifications existantes si la valeur est true. |
|
|
end
|
end | date-time | ||
|
pièce d'identité
|
id | string | ||
|
options
|
options | integer | ||
|
start
|
start | date-time | ||
|
userId
|
userId | string |
Retours
- response
- array of ScheduleInfo
Envoie un courrier à un utilisateur spécifié
Envoie un courrier à un utilisateur spécifié qui contient des informations sur toutes les sources d’événements de l’équipe de l’utilisateur.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’utilisateur
|
userId | True | string |
ID d’utilisateur. |
|
ID d’équipe
|
teamId | string |
ID d’équipe à partir duquel l’utilisateur doit obtenir les informations de point de terminaison. |
Envoie à nouveau l’e-mail d’invitation s’il existe une invitation
Envoie à nouveau un e-mail d’invitation s’il existe une invitation.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’équipe
|
teamId | True | string |
ID d’équipe de l’équipe avec l’utilisateur invité. |
|
inviteurId
|
inviterId | string | ||
|
userMail
|
userMail | True | string |
Retours
- response
- string
Envoyer un événement
Envoyer un événement.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Secret d’équipe
|
teamSecret | True | string |
Secret d’équipe. |
|
Titre
|
Title | True | string | |
|
Message
|
Message | True | string | |
|
X-S4-Service
|
X-S4-Service | string |
X-S4-Service : affecte la signature à la catégorie de service/système avec le nom spécifié. |
|
|
X-S4-Location
|
X-S4-Location | string |
X-S4-Location : transmettez les informations d’emplacement (latitude,longitude) avec votre événement et affichez une carte dans l’application mobile. |
|
|
X-S4-AlertingScenario
|
X-S4-AlertingScenario | string |
X-S4-AlertingScenario : si cet événement déclenche un signl, permet de contrôler la façon dont SIGNL4 avertit l’équipe. Les valeurs prises en charge sont les suivantes : single_ack, multi_ack, urgence. |
|
|
X-S4-ExternalID
|
X-S4-ExternalID | string |
X-S4-ExternalID : si l’événement provient d’un enregistrement dans un système tiers, utilisez ce paramètre pour passer l’ID unique de cet enregistrement. Cet ID sera communiqué dans les notifications de webhook sortant à partir de SIGNL4, ce qui est idéal pour la corrélation/synchronisation de cet enregistrement avec signl. |
|
|
X-S4-Status
|
X-S4-Status | string |
X-S4-Status : si vous souhaitez résoudre un signl existant par un ID externe (X-S4-ExternalID), vous pouvez ajouter ce paramètre d’état. Il a trois valeurs possibles : nouvelles, reconnues, résolues. |
|
|
X-S4-Filtering
|
X-S4-Filtering | boolean |
Filtrage X-S4 : spécifiez une valeur booléenne true ou false pour appliquer le filtrage d’événements pour cet événement, ou non. Si la valeur est true, l’événement déclenche uniquement une notification à l’équipe, s’il contient au moins un mot clé de l’une de vos catégories de services et système (c’est-à-dire qu’il est mis en liste verte). |
|
|
Paramètre d’ID externe
|
ExtIdParam | string |
Paramètre d’ID externe. |
|
|
Paramètre d’état externe
|
ExtStatusParam | string |
Paramètre d’état externe. |
|
|
Nouvel état
|
NewStatus | string |
Nouvel état. |
|
|
Paramètre d’état résolu
|
ResolvedStatus | string |
Paramètre d’état résolu. |
|
|
État ack
|
AckStatus | string |
État ack. |
Retours
- Corps
- OverviewEvent
Extraire l’utilisateur
L’utilisateur spécifié est sorti du devoir.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
teamIds
|
teamIds | array of string | ||
|
userId
|
userId | True | string |
Retours
Fermer plusieurs alertes
Cette méthode ferme toutes les alertes fournies.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
alertIds
|
alertIds | True | array of string | |
|
descr
|
descr | string | ||
|
uid
|
uid | True | string |
Fermer toutes les alertes reconnues
Cette méthode ferme toutes les alertes reconnues que votre équipe a actuellement.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’utilisateur
|
userId | string |
ID utilisateur de l’utilisateur à utiliser pour fermer les alarmes. |
|
|
categoryIds
|
categoryIds | array of string | ||
|
maxDate
|
maxDate | date-time | ||
|
minDate
|
minDate | date-time | ||
|
portée
|
scope | integer |
|
|
|
teamIds
|
teamIds | array of string |
Fermer une alerte
Fermez une alerte.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de l’alerte
|
alertId | True | string |
ID pour accuser réception d’une alerte. |
|
descr
|
descr | string | ||
|
uid
|
uid | True | string |
Retours
- Corps
- V2.AlertInfo
Inviter des utilisateurs à une équipe
Inviter des utilisateurs à une équipe.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
inviteurId
|
inviterId | string | ||
|
Messagerie électronique
|
string | |||
|
roleId
|
roleId | string | ||
|
teamId
|
teamId | True | string |
Retours
- response
- array of V2.InvitationResult
Met à jour le mot de passe d’un utilisateur
Met à jour le mot de passe d’un utilisateur.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’utilisateur
|
userId | True | string |
ID d’utilisateur de l’utilisateur dont le mot de passe doit être modifié. |
|
currentPassword
|
currentPassword | string | ||
|
newPassword
|
newPassword | string |
Met à jour le profil d’équipe d’une équipe
Met à jour le profil d’équipe d’une équipe.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’équipe
|
teamId | True | string |
ID d’équipe de l’équipe qui doit être mis à jour. |
|
nom
|
name | string |
Retours
- Corps
- TeamInfo
Met à jour le profil utilisateur d’un utilisateur
Met à jour le profil utilisateur d’un utilisateur.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’utilisateur
|
userId | True | string |
ID de l’utilisateur à mettre à jour. |
|
nom
|
name | string | ||
|
timeZone
|
timeZone | string |
Retours
- Corps
- UserInfo
Met à jour les données personnalisées d’une instance de script donnée qui inclut son nom d’affichage
Met à jour l’instance de script spécifiée.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’instance de script
|
instanceId | True | string |
ID d’instance du script à mettre à jour. |
|
customScriptDescription
|
customScriptDescription | string | ||
|
customScriptName
|
customScriptName | string | ||
|
instanceId
|
instanceId | string | ||
|
scriptName
|
scriptName | string |
Retours
- Corps
- ScriptInstanceDetails
Met à jour un profil d’abonnements
Met à jour un profil d’abonnements.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Identifiant d’abonnement
|
subscriptionId | True | string |
ID de l’abonnement à mettre à jour |
|
nom
|
name | string |
Retours
- Corps
- SubscriptionInfo
Met à jour une action à distance
Exemple de demande :
PUT /remoteActions/{actionId}
{
"teamId": "cbb70402-1359-477f-ac92-0171cf2b5ff7",
"name": "MyAction",
"enabled": true,
}
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’action
|
actionId | True | string |
ID de l’action distante à mettre à jour |
|
ID d’action
|
language | integer |
|
|
|
nom
|
name | True | string | |
|
value
|
value | string | ||
|
canEdit
|
canEdit | boolean | ||
|
canExecute
|
canExecute | boolean | ||
|
teamId
|
teamId | string | ||
|
définitionId
|
definitionId | string | ||
|
descriptif
|
description | string | ||
|
enabled
|
enabled | boolean | ||
|
nom
|
name | string | ||
|
teamId
|
teamId | string |
Retours
- Corps
- V2.RemoteActionDetails
Met à jour une instance de script donnée
Met à jour l’instance de script spécifiée, généralement utilisée pour mettre à jour la configuration d’un script.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’instance de script
|
instanceId | True | string |
ID d’instance du script à mettre à jour. |
|
config
|
config | |||
|
customScriptDescription
|
customScriptDescription | string | ||
|
customScriptName
|
customScriptName | string | ||
|
enabled
|
enabled | boolean | ||
|
teamId
|
teamId | string |
Retours
- Corps
- ScriptInstanceDetails
Mettre à jour le modèle de légende existant pour votre abonnement
Mettez à jour le modèle de légende existant pour votre abonnement.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de modèle
|
templateId | True | string |
ID du modèle que vous souhaitez mettre à jour |
|
categoryId
|
categoryId | string | ||
|
externalId
|
externalId | string | ||
|
pièce d'identité
|
id | string | ||
|
location
|
location | string | ||
|
nom
|
name | string | ||
|
Objet
|
subject | string | ||
|
targetAllTeams
|
targetAllTeams | boolean | ||
|
targetTeamId
|
targetTeamId | string | ||
|
texte
|
text | string | ||
|
workflowType
|
workflowType | integer |
|
Retours
- response
- array of V2.CalloutTemplateDetails
Mettre à jour le Webhook par ID
Met à jour le webhook spécifié.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de webhook sortant
|
webhookId | True | string |
ID du webhook sortant à mettre à jour. |
|
descriptif
|
description | string | ||
|
extUrl
|
extUrl | True | string | |
|
nom
|
name | True | string | |
|
teamId
|
teamId | string |
Retours
- Corps
- WebhookInfo
Mettre à jour les informations de paramètres régionaux (par exemple, langue, fuseau horaire) pour l’utilisateur
Mettez à jour les informations de paramètres régionaux (par exemple, langue, fuseau horaire) pour l’utilisateur.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’utilisateur
|
userId | True | string |
ID d’utilisateur, e-mail ou « moi » pour l’utilisateur que vous souhaitez mettre à jour |
|
language
|
language | string | ||
|
timeZone
|
timeZone | string |
Retours
Mettre à jour les paramètres de confidentialité d’une équipe
Mettez à jour les paramètres de confidentialité d’une équipe.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’équipe
|
teamId | True | string |
ID d’équipe de l’équipe |
|
hideContactAddresses
|
hideContactAddresses | boolean | ||
|
hideDutyData
|
hideDutyData | boolean | ||
|
hideForEscalation
|
hideForEscalation | boolean |
Retours
Mettre à jour les paramètres prépayés actuels de votre abonnement
Mettez à jour les paramètres prépayés actuels de votre abonnement.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
topUpAmount
|
topUpAmount | integer | ||
|
topUpEnabled
|
topUpEnabled | boolean | ||
|
topUpLimit
|
topUpLimit | integer |
Retours
- Corps
- PrepaidSettingsInfo
Mettre à jour les paramètres prépayés actuels d’un abonnement
Mettez à jour les paramètres prépayés actuels d’un abonnement.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Identifiant d’abonnement
|
subscriptionId | True | string |
ID de l’abonnement |
|
topUpAmount
|
topUpAmount | integer | ||
|
topUpEnabled
|
topUpEnabled | boolean | ||
|
topUpLimit
|
topUpLimit | integer |
Retours
- Corps
- PrepaidSettingsInfo
Mettre à jour l’appartenance à l’équipe de l’utilisateur
Met à jour l’appartenance de l’équipe de l’utilisateur. Vous pouvez déplacer l’utilisateur vers une autre équipe au sein de l’abonnement et/ou modifier le rôle de l’utilisateur.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’équipe
|
teamId | True | string |
L’équipe de l’utilisateur auquel vous souhaitez effectuer la mise à jour appartient pour le moment. |
|
ID d’utilisateur
|
userId | True | string |
ID utilisateur de l’utilisateur que vous souhaitez mettre à jour. |
|
ID d’utilisateur
|
requesterUserId | string |
ID utilisateur de l’utilisateur avec lequel vous souhaitez modifier le rôle. Cela doit être fourni lors de l’utilisation d’une clé API. Cet utilisateur doit avoir un administrateur de rôle (pour définir un rôle d’administrateur) ou un administrateur d’équipe (pour définir des droits). |
|
|
Définir l’utilisateur en service
|
setUserOnDuty | boolean |
Définit le nouvel état de service pour l’utilisateur si l’utilisateur est déplacé vers une autre équipe. L’utilisateur est en service par défaut. |
|
|
isValid
|
isValid | boolean | ||
|
roleId
|
roleId | string | ||
|
teamId
|
teamId | string |
Retours
- Corps
- UserInfo
Mettre à jour un modèle d’alerte existant
Mettez à jour un modèle d’alerte existant.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’équipe
|
teamId | True | string |
ID d’équipe pour lequel vous souhaitez créer le modèle |
|
ID de modèle
|
patternId | True | string |
ID de modèle de modèle à mettre à jour |
|
categories
|
categories | array of string | ||
|
enabled
|
enabled | boolean | ||
|
mode
|
mode | integer |
|
|
|
referenceId
|
referenceId | string | ||
|
pièce d'identité
|
id | string | ||
|
nom
|
name | string | ||
|
chaîne
|
channel | integer |
|
|
|
delayInMinutes
|
delayInMinutes | integer | ||
|
enabled
|
enabled | boolean | ||
|
overrideEscalationSettings
|
overrideEscalationSettings | boolean | ||
|
overrideNotificationProfiles
|
overrideNotificationProfiles | boolean | ||
|
overrideResponseSettings
|
overrideResponseSettings | boolean | ||
|
responseMode
|
responseMode | integer |
|
|
|
responseTime
|
responseTime | integer | ||
|
suppressSignl
|
suppressSignl | boolean | ||
|
heure
|
hour | integer | ||
|
minutes
|
minutes | integer | ||
|
jour de la semaine
|
weekday | integer |
|
|
|
pièce d'identité
|
id | string |
Retours
Mettre à jour une catégorie existante
Exemple de demande :
PUT /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7/c0054336-cd89-4abf-882d-ba69b5adb25e
{
"name": "Water-Updated",
"imageName": "water.svg",
"color": "#0000cc",
"keywordMatching": "All",
"keywords": [
{
"value": "H2O"
},
{
"value": "Water"
},
{
"value": "Wet"
}
]
}
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’équipe
|
teamId | True | string |
ID de l’équipe à laquelle appartient la catégorie |
|
ID de catégorie
|
categoryId | True | string |
ID de catégorie |
|
enabled
|
enabled | boolean | ||
|
pièce d'identité
|
id | string | ||
|
nom
|
name | string | ||
|
type
|
type | True | integer |
|
|
value
|
value | string | ||
|
color
|
color | True | string | |
|
pièce d'identité
|
id | string | ||
|
nom
|
name | string | ||
|
type
|
type | True | integer |
|
|
value
|
value | string | ||
|
pièce d'identité
|
id | string | ||
|
imageName
|
imageName | True | string | |
|
isDefault
|
isDefault | boolean | ||
|
keywordMatching
|
keywordMatching | True | integer |
|
|
Mots-clés
|
keywords | True | array of string | |
|
keywordsExcluded
|
keywordsExcluded | array of string | ||
|
nom
|
name | True | string | |
|
options
|
options | integer |
|
|
|
order
|
order | integer | ||
|
teamId
|
teamId | string |
Retours
- Corps
- CategoryInfo
Mettre à jour une source d’événement
Mettez à jour une source d’événement.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de source d’événement
|
eventSourceId | True | string |
ID de la source d’événement |
|
descriptif
|
description | string | ||
|
handicapé
|
disabled | boolean | ||
|
nom
|
name | string | ||
|
teamId
|
teamId | string |
Retours
- Corps
- EventSourceEndpointInfo
Obtenir des abonnements de catégorie
Exemple de demande :
GET /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7/c0054336-cd89-4abf-882d-ba69b5adb25e/subscriptions
{
}
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’équipe
|
teamId | True | string |
ID de l’équipe à laquelle appartient la catégorie |
|
ID de catégorie
|
categoryId | True | string |
Catégorie pour laquelle obtenir des abonnements |
Retours
- response
- array of CategorySubscriptionInfo
Obtenir des détails sur une alerte
Obtenez des détails sur une alerte.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de l’alerte
|
alertId | True | string |
Alerte que vous souhaitez obtenir. |
|
ID d’utilisateur
|
userId | string |
ID utilisateur de l’utilisateur dans lequel se comporte l’API est appelée. Il est utilisé à des fins de filtrage concernant l’alerte. |
Retours
- Corps
- V2.AlertDetails
Obtenir des entrées de chronologie d’alerte
Obtenir les entrées de chronologie des alertes d’une alerte par ID.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de l’alerte
|
alertId | True | string |
ID de l’alerte demandée. |
|
ID d’utilisateur
|
userId | string |
Identifiant utilisateur. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
|
array of |
Obtenir des informations de toutes les équipes
Obtenez des informations sur toutes les équipes.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’équipe
|
teamId | array |
ID d’équipe |
Retours
- response
- array of TeamInfo
Obtenir des informations d’un abonnement spécifique
Obtenez des informations sur un abonnement spécifique.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Identifiant d’abonnement
|
subscriptionId | True | string |
ID de l’abonnement à récupérer. |
Retours
- Corps
- SubscriptionInfo
Obtenir des informations pour toutes les équipes de l’abonnement
Obtenez des informations pour toutes les équipes de l’abonnement.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Identifiant d’abonnement
|
subscriptionId | True | string |
ID de l’abonnement à mettre à jour |
Retours
- response
- array of TeamInfo
Obtenir des informations publiques sur toutes les équipes d’un abonnement
Obtenez des informations publiques sur toutes les équipes d’un abonnement.
Retours
- response
- array of V2.TeamPublicDetails
Obtenir des informations sur les pièces jointes d’une alerte
Obtenir des pièces jointes d’une alerte par ID.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de l’alerte
|
alertId | True | string |
ID de l’alerte demandée. |
Retours
- response
- array of V2.AlertAttachmentInfo
Obtenir des informations sur les rapports d’alerte téléchargeables
Obtenez des informations sur les rapports d’alerte téléchargeables.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’équipe
|
teamId | True | string |
ID de l’équipe à partir de laquelle vous souhaitez télécharger des rapports. |
Retours
- response
- array of AlertAuditReportFileInfo
Obtenir des informations sur l’assistant de service pour les équipes
Obtenez des informations sur l’assistant de service pour les équipes.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’équipe
|
teamId | array |
ID des équipes pour obtenir les résumés. |
|
|
Dernières deux tâches
|
lastTwoDuties | boolean |
Décidez si vous souhaitez toutes les tâches ou seulement les deux dernières. |
Retours
Obtenir des informations sur tous les abonnements disponibles et gérés
Obtenez des informations sur tous les abonnements disponibles/gérés.
Retours
- response
- array of SubscriptionInfo
Obtenir des métriques pour toutes les catégories
Exemple de demande :
GET /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7/metrics
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’équipe
|
teamId | True | string |
ID de l’équipe à laquelle appartient les catégories |
Retours
- response
- array of CategoryMetrics
Obtenir des métriques pour une catégorie spécifique
Exemple de demande :
GET /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7/c0054336-cd89-4abf-882d-ba69b5adb25e/metrics
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’équipe
|
teamId | True | string |
ID de l’équipe à laquelle appartient la catégorie |
|
ID de catégorie
|
categoryId | True | string |
ID de la catégorie à obtenir |
Retours
- Corps
- CategoryMetrics
Obtenir des notifications d’alerte
Obtenez des notifications de tous les utilisateurs par ID d’alerte.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de l’alerte
|
alertId | True | string |
ID de l’alerte demandée. |
Retours
- response
- array of AlertNotificationInfo
Obtenir des profils de notification pour l’utilisateur
Obtenir des profils de notification pour l’utilisateur.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’utilisateur
|
userId | True | string |
ID de l’utilisateur à partir duquel vous souhaitez obtenir les profils de notification. |
Retours
Obtenir des sources d’événements d’une ou plusieurs équipes
Obtenir des sources d’événements d’une ou plusieurs équipes.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’équipe
|
teamId | array |
ID d’équipe à partir duquel obtenir les sources d’événements. Si vous n’ajoutez aucun ID d’équipe, vous obtenez des sources d’événements auxquelles vous avez accès à partir de votre abonnement. |
|
|
Inclure interne
|
includeInternal | boolean |
Si le type de source d’événements interne true (Système, Manuel, API) est inclus dans le résultat. |
|
|
Language
|
language | integer |
|
Retours
Obtenir des vacances pour l’équipe
Obtenez des vacances pour l’équipe.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’équipe
|
teamId | True | string |
ID d’équipe à partir duquel vous souhaitez obtenir des vacances |
Retours
- Corps
- V2.TeamHolidayDetails
Obtenir des webhooks
Retourne une collection de webhooks sortants définis dans le système.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’équipe
|
teamId | string |
ID d’équipe. |
Retours
- response
- array of WebhookInfo
Obtenir la source d’événement par ID
Obtenir la source d’événement par ID.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de source d’événement
|
eventSourceId | True | string |
ID de la source d’événement. |
|
Language
|
language | integer |
|
Retours
- Corps
- EventSourceEndpointInfo
Obtenir le solde prépayé actuel de votre abonnement
Obtenir le solde prépayé actuel d’un abonnement
Obtenez le solde prépayé actuel d’un abonnement.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Identifiant d’abonnement
|
subscriptionId | True | string |
ID de l’abonnement |
Retours
- Corps
- PrepaidBalanceInfo
Obtenir les appartenances à l’équipe d’un utilisateur
Obtenir les appartenances à l’équipe d’un utilisateur.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’utilisateur
|
userId | True | string |
ID d’utilisateur auquel vous souhaitez accéder. |
Retours
- response
- array of V2.TeamMembershipDetails
Obtenir les appartenances à l’équipe par équipe
Obtenez les appartenances à l’équipe par équipe.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’équipe
|
teamId | True | string |
ID d’équipe de l’équipe auquel vous souhaitez accéder. |
Retours
- response
- array of V2.TeamMembershipDetails
Obtenir les détails d’un événement
Obtenez les détails d’un événement.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de l’événement
|
eventId | True | string |
ID d’événement de l’événement que vous souhaitez obtenir |
Retours
- Corps
- V2.EventDetails
Obtenir les paramètres de confidentialité de l’équipe pour une équipe
Obtenir les paramètres de confidentialité de l’équipe pour une équipe.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’équipe
|
teamId | True | string |
ID d’équipe de l’équipe |
Retours
Obtenir les paramètres de service d’équipe pour plusieurs équipes
Obtenir les paramètres de service d’équipe pour plusieurs équipes.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’équipe
|
teamId | array |
ID d’équipe. |
Retours
Obtenir les paramètres d’événement
Obtenir les paramètres d’un événement par ID.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de l’événement
|
eventId | True | string |
ID d’événement de l’alerte demandée. |
Retours
- response
- array of EventParameterInfo
Obtenir les paramètres prépayés actuels de votre abonnement
Obtenir les paramètres prépayés actuels d’un abonnement
Obtenez les paramètres prépayés actuels d’un abonnement.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Identifiant d’abonnement
|
subscriptionId | True | string |
ID de l’abonnement |
Retours
- Corps
- PrepaidSettingsInfo
Obtenir les transactions prépayées de votre abonnement
Obtenez les transactions prépayées de votre abonnement.
Retours
- response
- array of PrepaidTransactionInfo
Obtenir les transactions prépayées d’un abonnement
Obtenez les transactions prépayées d’un abonnement.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Identifiant d’abonnement
|
subscriptionId | True | string |
ID de l’abonnement pour obtenir des transactions pour |
Retours
- response
- array of PrepaidTransactionInfo
Obtenir l’état des droits par ID d’utilisateur
Retourne un objet avec des informations de devoir.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’utilisateur
|
userId | True | string |
Identificateur de l’utilisateur à obtenir. Utilisez « Moi » pour obtenir des informations sur l’utilisateur actuellement connecté. Cela n’est pas possible avec une clé API. Il peut également s’agir d’une adresse e-mail d’un utilisateur dans l’équipe ou de l’ID unique d’un objet utilisateur en fonction de l’utilisateur. » |
|
ID d’équipe
|
teamId | array |
ID d’équipe." |
Retours
Obtenir tous les modèles de légende pour votre abonnement
Obtenez tous les modèles de légende pour votre abonnement.
Retours
- response
- array of V2.CalloutTemplateDetails
Obtenir tous les modèles d’alerte de l’équipe
Obtenez tous les modèles d’alerte de l’équipe.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’équipe
|
teamId | True | string |
ID d’équipe de l’équipe à laquelle vous souhaitez accéder |
Retours
- response
- array of V2.AlertingPatternDetails
Obtenir tous les utilisateurs
Retourne une liste d’objets utilisateur avec des détails tels que leur adresse e-mail et leurs informations de service. Seuls les utilisateurs auxquels vous avez accès seront retournés.
Retours
- response
- array of V2.UserDetails
Obtenir toutes les catégories
Obtenez toutes les catégories.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’équipe
|
teamId | array |
ID d’équipe. |
Retours
Obtenir toutes les catégories
Exemple de demande :
GET /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’équipe
|
teamId | True | string |
ID de l’équipe à laquelle appartiennent les catégories |
Retours
- response
- array of CategoryInfo
Obtenir toutes les équipes dont l’utilisateur est membre
Retourne une liste d’objets d’équipe avec des détails tels que leur nom. Seules les équipes dont l’utilisateur est membre sont retournées.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’équipe
|
userId | True | string |
ID d’équipe. |
Retours
- response
- array of TeamInfo
Obtenir un rapport d’alerte
Retourne des informations sur le volume d’alerte survenu dans différentes périodes, ainsi que sur le comportement de réponse (quantité d’alertes confirmées et non gérées) des membres de l’équipe.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’utilisateur
|
userId | string |
ID utilisateur de l’utilisateur pour lequel vous souhaitez un rapport. |
|
|
ID d’équipe
|
teamId | array |
ID d’équipe des équipes pour lesquelles vous souhaitez obtenir un rapport. Si vous ne définissez pas d’ID d’équipe, vous obtiendrez toutes les ressources de toutes les équipes auquel vous avez accès. |
Retours
Obtenir un utilisateur par ID
Retourne un objet utilisateur avec des détails tels que son adresse e-mail et ses informations de service.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’utilisateur
|
userId | True | string |
Identificateur de l’utilisateur à obtenir. Utilisez « Moi » pour obtenir des informations sur l’utilisateur actuellement connecté. Cela n’est pas possible avec une clé API. Il peut également s’agir d’une adresse e-mail d’un utilisateur dans l’équipe ou de l’ID unique d’un objet utilisateur en fonction de l’utilisateur. » |
Retours
- Corps
- V2.UserDetails
Obtenir un événement de vue d’ensemble
Obtenir l’événement de vue d’ensemble par ID.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de l’événement
|
eventId | True | string |
ID de l’événement à obtenir. |
Retours
- Corps
- OverviewEvent
Obtenir une alerte
Obtient une alerte par ID.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de l’alerte
|
alertId | True | string |
ID de l’alerte demandée. |
|
ID d’utilisateur
|
userId | string |
Identifiant utilisateur. |
Retours
- Corps
- V2.AlertInfo
Obtenir une catégorie spécifique
Exemple de demande :
GET /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7/c0054336-cd89-4abf-882d-ba69b5adb25e
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’équipe
|
teamId | True | string |
ID de l’équipe à laquelle appartient la catégorie |
|
ID de catégorie
|
categoryId | True | string |
ID de la catégorie à obtenir |
Retours
- Corps
- CategoryInfo
Obtenir une image utilisateur personnelle
Obtenir une image utilisateur personnelle.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’utilisateur
|
userId | True | string |
ID d’utilisateur. |
|
Hauteur de l’image
|
height | integer |
Hauteur de l’image. |
|
|
Largeur de l’image
|
width | integer |
Largeur de l’image. |
Retours
- Corps
- UserImage
Obtenir une vue d’ensemble de l’événement paginé
Obtenir une vue d’ensemble de l’événement paginé. S’il existe d’autres résultats, vous obtenez également un jeton de continuation que vous pouvez ajouter au filtre d’événements.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Limit
|
maxResults | integer |
Définit la limite des détails d’alerte récupérés par requête. 1 à 100 sont autorisés par demande. Le nombre d’alertes peut être inférieur s’il est filtré mais au moins 1. |
|
|
nextPartitionKey
|
nextPartitionKey | string | ||
|
nextRowKey
|
nextRowKey | string | ||
|
nextTableName
|
nextTableName | string | ||
|
eventSourceId
|
eventSourceId | string | ||
|
eventStatusCode
|
eventStatusCode | integer |
|
|
|
maxCreationDate
|
maxCreationDate | date-time | ||
|
minCreationDate
|
minCreationDate | date-time | ||
|
modifiedSince
|
modifiedSince | date-time | ||
|
teamid
|
teamid | string | ||
|
textToSearch
|
textToSearch | string |
Retours
Obtenir webhook par ID
Retourne les informations du webhook spécifié par l’ID passé.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de webhook sortant
|
webhookId | True | string |
ID du webhook sortant à récupérer. |
Retours
- Corps
- WebhookInfo
Obtention de tous les utilisateurs d’équipes spécifiées
Obtention de tous les utilisateurs d’équipes spécifiées.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’équipe
|
teamId | array |
ID d’équipe à demander. Si elle est vide, vous obtenez tous les utilisateurs de toutes les équipes auxquels vous avez accès. |
Retours
Obtient la progression de la configuration d’un utilisateur spécifique
Obtient la progression de la configuration d’un utilisateur spécifique.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’utilisateur
|
userId | True | string |
ID de l’utilisateur pour lequel la progression doit être récupérée. |
Retours
- Corps
- UserSetupProgress
Obtient la progression de la configuration d’une équipe spécifique
Obtient la progression de la configuration d’une équipe spécifique.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’équipe
|
teamId | True | string |
ID de l’équipe pour laquelle la progression doit être récupérée. |
Retours
- Corps
- TeamSetupProgress
Obtient les alertes paginées
Obtient les alertes paginées.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’utilisateur
|
userId | string |
ID utilisateur de l’utilisateur pour lequel vous souhaitez obtenir des alertes. |
|
|
Limite d’alerte
|
maxResults | integer |
Définit la limite des détails d’alerte récupérés par requête. 1 à 100 sont autorisés par demande. Le nombre d’alertes peut être inférieur s’il est filtré mais au moins 1. |
|
|
afterId
|
afterId | string | ||
|
alertIds
|
alertIds | array of string | ||
|
alertStatusCodes
|
alertStatusCodes | integer |
|
|
|
categoryIds
|
categoryIds | array of string | ||
|
nextPartitionKey
|
nextPartitionKey | string | ||
|
nextRowKey
|
nextRowKey | string | ||
|
nextTableName
|
nextTableName | string | ||
|
externalId
|
externalId | string | ||
|
maxCreated
|
maxCreated | date-time | ||
|
minCreated
|
minCreated | date-time | ||
|
modifiedSince
|
modifiedSince | date-time | ||
|
showPersonalHiddenCategories
|
showPersonalHiddenCategories | boolean | ||
|
teamIds
|
teamIds | array of string | ||
|
textToSearch
|
textToSearch | string |
Retours
Obtient les informations d’une équipe spécifique
Obtient des informations d’une équipe spécifique.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’équipe
|
teamId | True | string |
ID de l’équipe qui doit être récupérée. |
Retours
- Corps
- TeamInfo
Obtient les licences de numéro de voix d’un abonnement
Obtient les licences de numéro de voix d’un abonnement.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Identifiant d’abonnement
|
subscriptionId | True | string |
ID de l’abonnement |
Retours
- Corps
- UserLicenseInfo
Obtient les licences utilisateur d’un abonnement
Obtient les licences utilisateur d’un abonnement.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Identifiant d’abonnement
|
subscriptionId | True | string |
ID de l’abonnement |
Retours
- Corps
- UserLicenseInfo
Obtient les noms de toutes les images de catégorie d’alerte
Obtient les noms de toutes les images de catégorie d’alerte. Vous pouvez obtenir l’image en accédant à account.signl4.com/images/alerts/categoryImageName.svg.
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
|
array of string |
Obtient les paramètres d’alerte d’une équipe spécifique
Obtient les paramètres d’alerte d’une équipe spécifique.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’équipe
|
teamId | array |
ID de l’équipe. |
Retours
Obtient les paramètres d’alerte d’une équipe spécifique
Obtient les paramètres d’alerte d’une équipe spécifique.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’équipe
|
teamId | True | string |
ID de l’équipe pour laquelle les paramètres doivent être récupérés. |
Retours
- Corps
- AlertSettings
Obtient les sources d’événements d’une équipe spécifique
Obtient les sources d’événements d’une équipe spécifique.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’équipe
|
teamId | True | string |
ID de l’équipe pour laquelle les sources doivent être récupérées. |
Retours
- response
- array of EventSourceEndpointInfo
Obtient l’image d’une équipe spécifiée
Obtient l’image d’une équipe spécifiée.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’équipe
|
teamId | True | string |
ID de l’équipe à partir de laquelle vous souhaitez obtenir l’image. |
|
Hauteur de l’image
|
height | integer |
Paramètre facultatif définissant la hauteur souhaitée de l’image récupérée. |
|
|
Largeur de l’image
|
width | integer |
Paramètre facultatif définissant la largeur souhaitée de l’image récupérée. |
Retours
- Corps
- V2.TeamImageDetails
Obtient une pièce jointe spécifiée d’une alerte spécifiée
Obtient une pièce jointe spécifiée d’une alerte spécifiée.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de l’alerte
|
alertId | True | string |
ID de l’alerte qui contient la pièce jointe souhaitée. |
|
ID de pièce jointe
|
attachmentId | True | string |
ID de la pièce jointe que vous souhaitez récupérer. |
|
Largeur de l’image
|
width | integer |
Paramètre facultatif définissant la largeur souhaitée de l’image récupérée. |
|
|
Hauteur de l’image
|
height | integer |
Paramètre facultatif définissant la hauteur souhaitée de l’image récupérée. |
|
|
Scale
|
scale | boolean |
Paramètre facultatif définissant s’il souhaite mettre à l’échelle l’image récupérée. La valeur par défaut est true. |
Retours
- response
- binary
Percutez l’utilisateur dans
L’utilisateur spécifié sera percé en fonction.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
teamIds
|
teamIds | array of string | ||
|
userId
|
userId | True | string |
Retours
Percutez l’utilisateur en tant que Gestionnaire
L’utilisateur spécifié est percuté en tant que responsable.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
teamIds
|
teamIds | array of string | ||
|
userId
|
userId | True | string |
Retours
Possibilité de désactiver un webHook
Possibilité de désactiver un webHook.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Webhook ID
|
webhookId | True | string |
ID de webhook pour le webhook qui doit être activé. |
Retours
- Corps
- WebhookInfo
Possibilité d’activer un webHook
Possibilité d’activer un webHook.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Webhook ID
|
webhookId | True | string |
ID de webhook pour webhook qui doit être désactivé. |
Retours
- Corps
- WebhookInfo
Remonter une alerte manuellement à une équipe
Réaffectez une alerte manuellement à une équipe.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de l’alerte
|
alertId | True | string |
ID d’alerte de l’alerte que vous souhaitez escalader. |
|
targetTeamId
|
targetTeamId | string | ||
|
userId
|
userId | string |
Retours
- response
- string
Retirer la fermeture de plusieurs alertes
Cette méthode tente d’annuler plusieurs fermetures d’alerte. L’opération est gérée en arrière-plan.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
alertIds
|
alertIds | True | array of string | |
|
descr
|
descr | string | ||
|
uid
|
uid | True | string |
Retourne des actions distantes
Exemple de demande :
GET /RemoteActions?externalId=12345
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’équipe
|
teamId | string |
ID d’équipe |
|
|
External ID
|
externalId | string |
Filtre facultatif pour l’ID externe |
|
|
Type
|
type | integer |
|
|
|
Service d’exécuteur
|
executorService | string |
Service d’exécuteur |
|
|
Language
|
language | integer |
|
Retours
- response
- array of V2.RemoteActionInfo
Retourne des informations sur toutes les planifications planifiées
Retourne des informations sur toutes les planifications planifiées.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
limit
|
limit | integer | ||
|
minDate
|
minDate | date-time | ||
|
teamIds
|
teamIds | array of string | ||
|
userId
|
userId | string |
Retours
- response
- array of V2.ScheduleDetails
Retourne le rapport d’alerte
Retourne le rapport d’alerte.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’équipe
|
teamId | True | string |
ID de l’équipe pour laquelle vous souhaitez obtenir les informations relatives au fichier de rapport de devoir. |
|
Nom du fichier
|
fileName | True | string |
Nom du fichier que vous souhaitez télécharger. |
Retours
- response
- binary
Retourne les fonctionnalités d’un abonnement spécifié
Retourne les fonctionnalités d’un abonnement spécifié.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Identifiant d’abonnement
|
subscriptionId | True | string |
ID de l’abonnement à partir duquel les fonctionnalités doivent être récupérées. |
Retours
- response
- array of SubscriptionFeature
Retourne les informations de la planification des droits avec l’ID spécifié
Retourne les informations de la planification des droits avec l’ID spécifié.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’équipe
|
teamId | True | string |
ID de l’équipe à laquelle appartient le devoir |
|
ID de la planification des droits
|
scheduleId | True | string |
ID de l’horaire de service demandé. |
Retours
- Corps
- ScheduleInfo
Retourne les informations de prix du canal de l’abonnement
Retourne les informations de prix du canal de l’abonnement.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Identifiant d’abonnement
|
subscriptionId | True | string |
ID de l’abonnement à récupérer. |
Retours
- Corps
- ChannelPriceInfo
Retourne les travaux distants paginés à partir du journal
Exemple de demande :
POST /remoteActions/journal/paged?maxResults=100
{
"statusCode": "Executed"
}
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Résultats max.
|
maxResults | integer |
Résultats max. |
|
|
Language
|
language | integer |
|
|
|
actionId
|
actionId | string | ||
|
continuationToken
|
continuationToken | string | ||
|
maxCreationDate
|
maxCreationDate | date-time | ||
|
minCreationDate
|
minCreationDate | date-time | ||
|
modifiedSince
|
modifiedSince | date-time | ||
|
statusCodes
|
statusCodes | integer |
|
Retours
Retourne tous les scripts d’inventaire
Retourne tous les scripts d’inventaire.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Language
|
language | string |
Language |
Retours
- response
- array of InventoryScriptInfo
Retourne tous les scripts d’inventaire disponibles
Retourne tous les scripts d’inventaire disponibles qui peuvent être ajoutés à un abonnement SIGNL4.
Retours
- response
- array of InventoryScriptInfo
Retourne toutes les informations relatives à une instance de script donnée
Obtient l’instance de script spécifiée par l’ID d’instance passé.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’instance de script
|
instanceId | True | string |
ID d’instance de script à renvoyer. |
Retours
- Corps
- ScriptInstanceDetails
Retourne toutes les instances de script de l’équipe SIGNL4
Retourne toutes les instances de script dans l’abonnement.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’équipe
|
teamId | array |
ID d’équipe. |
|
|
Modifié depuis
|
modifiedSince | date-time |
Modifié depuis. |
Retours
- response
- array of ScriptInstanceInfo
Retourne un script d’inventaire par son ID
Obtient le script spécifié par l’ID de script passé.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Script ID
|
scriptId | True | string |
ID du script à renvoyer. |
|
Language
|
language | string |
Language |
Retours
- Corps
- ScriptInstanceDetails
Retourne un travail distant à partir du journal
Exemple de demande :
GET /remoteActions/journal/{jobId}
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID du travail
|
jobId | True | string |
ID du travail à retourner |
|
Language
|
language | integer |
|
Retours
- Corps
- V2.RemoteJob
Retourne une action distante
Exemple de demande :
GET /RemoteActions/{actionId}
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’action
|
actionId | True | string |
ID de l’action à retourner |
|
Language
|
language | integer |
|
Retours
- Corps
- V2.RemoteActionDetails
Récupérer toute la définition disponible
Récupérez toute la définition disponible.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Language
|
language | integer |
|
Retours
Récupérer une définition
Récupérer une définition.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de définition
|
definitionId | True | string |
ID de définition |
|
Language
|
language | integer |
|
Retours
Supprime le compte d’utilisateur
Supprime le compte d’utilisateur.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’utilisateur
|
userId | True | string |
ID de l’utilisateur à supprimer. |
Supprime l’image d’équipe actuelle
Supprime l’image d’équipe actuelle.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’équipe
|
teamId | True | string |
ID d’équipe à partir duquel vous souhaitez supprimer l’image d’équipe. |
Supprime un utilisateur ou une invitation d’une équipe
Supprime un utilisateur ou une invitation d’une équipe.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’équipe
|
teamId | True | string |
ID de l’équipe dont l’utilisateur doit être supprimé |
|
ID d’utilisateur
|
userId | True | string |
ID de l’utilisateur qui doit être supprimé |
|
ID d’utilisateur
|
requesterUserId | string |
ID utilisateur de l’utilisateur qui supprimera l’autre utilisateur. |
Supprime une action à distance
Exemple de demande :
DELETE /eaRemoteActions/{actionId}
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’action
|
actionId | True | string |
ID de l’action à supprimer |
Supprime une instance de script
Obtient l’instance de script spécifiée par l’ID d’instance passé.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’instance de script
|
instanceId | True | string |
ID d’instance de script à renvoyer. |
Supprimer le modèle de légende existant de votre abonnement
Supprimez le modèle de légende existant de votre abonnement.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de modèle
|
templateId | True | string |
ID de modèle. |
Supprimer le numéro de téléphone d’un utilisateur
Supprimez le numéro de téléphone d’un utilisateur.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’utilisateur
|
userId | True | string |
ID de l’utilisateur |
Supprimer le Webhook par ID
Supprime le webhook spécifié afin qu’il ne soit plus averti.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de webhook sortant
|
webhookId | True | string |
ID du webhook sortant qui sera supprimé. |
Supprimer les jours fériés
Supprimer les jours fériés.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’équipe
|
teamId | True | string |
ID d’équipe à partir duquel vous souhaitez supprimer les congés |
|
Jour
|
day | integer | ||
|
month
|
month | integer |
|
|
|
année
|
year | integer |
Supprimer les planifications de droits dans la plage
Supprimez les planifications de droits dans la plage.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’équipe
|
teamId | True | string |
ID d’équipe que vous souhaitez supprimer |
|
de
|
from | date-time | ||
|
à
|
to | date-time |
Retours
- response
- array of ScheduleInfo
Supprimer un devoir spécifique
Supprimez un devoir spécifique.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’équipe
|
teamId | True | string |
ID de l’équipe à laquelle appartient le devoir. |
|
ID de la planification des droits
|
dutyId | True | string |
ID du devoir à supprimer. |
Supprimer un modèle d’alerte spécifique
Supprimez un modèle d’alerte spécifique.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’équipe
|
teamId | True | string |
ID d’équipe de l’équipe à laquelle vous souhaitez accéder |
|
ID de modèle
|
patternId | True | string |
ID de modèle pour le modèle auquel vous souhaitez accéder |
Supprimer une adresse de contact d’un utilisateur
Supprimez une adresse de contact d’un utilisateur.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’utilisateur
|
userId | True | string |
ID utilisateur de l’utilisateur à supprimer l’adresse de |
|
ID d’adresse
|
addressId | True | string |
ID de l’adresse de contact |
Supprimer une catégorie existante
Exemple de demande :
DELETE /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7/c0054336-cd89-4abf-882d-ba69b5adb25e
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’équipe
|
teamId | True | string |
ID de l’équipe à laquelle appartient la catégorie |
|
ID de catégorie
|
categoryId | True | string |
ID de la catégorie à supprimer |
Supprimer une distribution d’événements
Supprimez une distribution d’événements.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de source d’événement
|
distributionId | True | string |
ID de la source d’événement |
Supprimer une image utilisateur personnelle
Supprimez l’image utilisateur personnelle.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’utilisateur
|
userId | True | string |
ID d’utilisateur ou moi |
Supprimer une source d’événement
Supprimez une source d’événement.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de source d’événement
|
eventSourceId | True | string |
ID de la source d’événement |
Télécharger le rapport de droits avec un fileName spécifique
Téléchargez le rapport de droits avec un fileName spécifique.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’équipe
|
teamId | True | string |
ID de l’équipe pour laquelle vous souhaitez télécharger le rapport de devoir. |
|
Nom du fichier
|
fileName | True | string |
Nom du fichier csv à télécharger. |
Retours
- response
- binary
Valide un numéro de téléphone créé précédemment pour un utilisateur
Valide un numéro de téléphone créé précédemment pour un utilisateur.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’utilisateur
|
userId | True | string |
ID utilisateur de l’utilisateur que vous souhaitez valider le numéro de téléphone créé précédent |
|
numéro de téléphone
|
phoneNumber | string | ||
|
validationCode
|
validationCode | string |
Valider un créneau horaire d’un modèle
Validez un intervalle de temps d’un modèle par rapport à tous les créneaux horaires existants d’autres modèles.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’équipe
|
teamId | True | string |
ID d’équipe du modèle d’alerte |
|
ID de modèle
|
patternId | string |
ID de modèle d’alerte du modèle pour lequel vous souhaitez gagner du temps. Peut être null |
|
|
ID de catégorie
|
categoryIds | array |
ID de catégorie du modèle que vous souhaitez valider. Peut être null. |
|
|
heure
|
hour | integer | ||
|
minutes
|
minutes | integer | ||
|
jour de la semaine
|
weekday | integer |
|
|
|
pièce d'identité
|
id | string |
Retours
Vérifie si un utilisateur dispose de l’autorisation fournie
Vérifie si un utilisateur dispose de l’autorisation fournie.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’utilisateur
|
userId | True | string |
ID de l’utilisateur pour lequel vérifier les autorisations. |
|
permissions
|
permissions | array of string | ||
|
teamIds
|
teamIds | array of string |
Retours
Définitions
AlertAuditReportFileInfo
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
fileName
|
fileName | string | |
|
fileSizeInBytes
|
fileSizeInBytes | integer | |
|
lastRecord
|
lastRecord | date-time | |
|
dernierMise à jour
|
lastUpdated | date-time | |
|
month
|
month | integer | |
|
année
|
year | integer |
AlertEscalationModes
AlertFilterActions
AlertFilterModes
AlertNotificationInfo
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
address
|
address | string | |
|
deviceName
|
deviceName | string | |
|
lastUpdate
|
lastUpdate | date-time | |
|
messageStatus
|
messageStatus | AlertNotificationInfoMessageStatus |
|
|
messageStatusErrorCode
|
messageStatusErrorCode | integer | |
|
notificationChannelType
|
notificationChannelType | AlertNotificationInfoChannelType |
|
|
userId
|
userId | string | |
|
userStatus
|
userStatus | AlertNotificationInfoUserStatus |
|
AlertNotificationInfoChannelType
- 0 = Aucune
- 1 = Push
- 2 = E-mail
- 4 = Bot
- 8 = Voix
- 16 = SMS
- 0 = Aucune
- 1 = Push
- 2 = E-mail
- 4 = Bot
- 8 = Voix
- 16 = SMS
AlertNotificationInfoMessageStatus
- 0 = Aucune
- 1 = Rejeté
- 2 = Échec
- 3 = Mis en file d’attente
- 4 = Transmis
- 5 = Mise en mémoire tampon
- 6 = Livré
- 7 = Annulé
- 8 = Protégé
- 9 = AbuseProtected
- 10 = Différé
- 0 = Aucune
- 1 = Rejeté
- 2 = Échec
- 3 = Mis en file d’attente
- 4 = Transmis
- 5 = Mise en mémoire tampon
- 6 = Livré
- 7 = Annulé
- 8 = Protégé
- 9 = AbuseProtected
- 10 = Différé
AlertNotificationInfoUserStatus
- 0 = Aucune
- 1 = MessageCreated
- 2 = NotOnDuty
- 3 = CategoryHidden
- 4 = CategoryMuted
- 5 = NoNotificationProfiles
- 6 = NoMessagesByNotificationProfiles
- 0 = Aucune
- 1 = MessageCreated
- 2 = NotOnDuty
- 3 = CategoryHidden
- 4 = CategoryMuted
- 5 = NoNotificationProfiles
- 6 = NoMessagesByNotificationProfiles
AlertResponseModes
AlertSettings
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
escEnabled
|
escEnabled | boolean | |
|
escMode
|
escMode | AlertEscalationModes |
|
|
escRefId
|
escRefId | string | |
|
filterAction
|
filterAction | AlertFilterActions |
|
|
filterMode
|
filterMode | AlertFilterModes |
|
|
notificationProfileOverrides
|
notificationProfileOverrides | array of AlertSettingsNotificationProfile | |
|
optOut
|
optOut | TeamCategoryOptOutModes |
|
|
overrideNotificationProfiles
|
overrideNotificationProfiles | boolean | |
|
persNotInterval
|
persNotInterval | integer | |
|
persNotMode
|
persNotMode | PersistentNotificationModes |
|
|
responseMode
|
responseMode | AlertResponseModes |
|
|
responseTime
|
responseTime | integer |
AlertSettingsChannelType
AlertSettingsNotificationProfile
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
chaîne
|
channel | AlertSettingsChannelType |
|
|
delay
|
delay | integer | |
|
enabled
|
enabled | boolean |
CategoryAugmentation
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
enabled
|
enabled | boolean | |
|
pièce d'identité
|
id | string | |
|
nom
|
name | string | |
|
type
|
type | CategoryAugmentationType |
|
|
value
|
value | string |
CategoryAugmentationType
- 0 = Paramètre
- 1 = Objet
- 2 = Texte
- 3 = Emplacement
- 0 = Paramètre
- 1 = Objet
- 2 = Texte
- 3 = Emplacement
CategoryEnrichment
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
pièce d'identité
|
id | string | |
|
nom
|
name | string | |
|
type
|
type | CategoryEnrichmentType |
|
|
value
|
value | string |
CategoryEnrichmentType
CategoryInfo
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
augmentations
|
augmentations | array of CategoryAugmentation | |
|
color
|
color | string | |
|
enrichissements
|
enrichments | array of CategoryEnrichment | |
|
pièce d'identité
|
id | string | |
|
imageName
|
imageName | string | |
|
isDefault
|
isDefault | boolean | |
|
keywordMatching
|
keywordMatching | KeywordMatchingType |
|
|
Mots-clés
|
keywords | array of string | |
|
keywordsExcluded
|
keywordsExcluded | array of string | |
|
nom
|
name | string | |
|
options
|
options | CategoryInfoOptions |
|
|
order
|
order | integer | |
|
teamId
|
teamId | string |
CategoryInfoOptions
- 0 = Aucune
- 1 = Masqué
- 2 = DenyDelete
- 4 = HideOptOut
- 8 = HideKeywords
- 0 = Aucune
- 1 = Masqué
- 2 = DenyDelete
- 4 = HideOptOut
- 8 = HideKeywords
CategoryMetrics
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
categoryId
|
categoryId | string | |
|
last24h
|
last24h | integer | |
|
lastAlert
|
lastAlert | date-time | |
|
subscriberCount
|
subscriberCount | integer |
CategorySubscriptionInfo
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
status
|
status | CategorySubscriptionStatus |
|
|
userId
|
userId | string |
CategorySubscriptionStatus
ChannelPriceInfo
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
SMS
|
sms | integer | |
|
voicePerMinute
|
voicePerMinute | integer |
DutySummaryInfo
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
dutyEnd
|
dutyEnd | date-time | |
|
dutyId
|
dutyId | string | |
|
dutyStart
|
dutyStart | date-time |
EventParameterInfo
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
nom
|
name | string | |
|
order
|
order | integer | |
|
type
|
type | EventParameterTypes |
|
|
value
|
value | string |
EventParameterTypes
- 0 = Aucune
- 1 = Objet
- 2 = Tableau
- 3 = Constructeur
- 4 = Propriété
- 5 = Commentaire
- 6 = Entier
- 7 = Float
- 8 = Chaîne
- 9 = Boolean
- 10 = Null
- 11 = Non défini
- 12 = Date
- 13 = Brut
- 14 = Octets
- 15 = Guid
- 16 = Uri
- 17 = TimeSpan
- 100 = Html
- 0 = Aucune
- 1 = Objet
- 2 = Tableau
- 3 = Constructeur
- 4 = Propriété
- 5 = Commentaire
- 6 = Entier
- 7 = Float
- 8 = Chaîne
- 9 = Boolean
- 10 = Null
- 11 = Non défini
- 12 = Date
- 13 = Brut
- 14 = Octets
- 15 = Guid
- 16 = Uri
- 17 = TimeSpan
- 100 = Html
EventSeverities
EventSourceEndpointInfo
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
address
|
address | string | |
|
descriptif
|
description | string | |
|
handicapé
|
disabled | boolean | |
|
groupId
|
groupId | string | |
|
pièce d'identité
|
id | string | |
|
lastEvent
|
lastEvent | date-time | |
|
nom
|
name | string | |
|
Sous-type
|
subType | string | |
|
subscriptionId
|
subscriptionId | string | |
|
teamId
|
teamId | string | |
|
type
|
type | EventSourceTypes |
|
EventSourceTypes
- 0 = Aucune
- 1 = e-mail
- 2 = WebHook
- 3 = Script
- 4 = Système
- 5 = Manuel
- 6 = Voix
- 7 = Api
- 0 = Aucune
- 1 = e-mail
- 2 = WebHook
- 3 = Script
- 4 = Système
- 5 = Manuel
- 6 = Voix
- 7 = Api
EventStatusCodes
- 0 = Aucune
- 1 = Traitement
- 2 = Signled
- 3 = Filtré
- 4 = Résolu
- 5 = Ignoré
- 6 = Accusé de réception
- 7 = Supprimé
- 8 = NoRuleApplied
- 9 = MultipleTargetStatus
- 1000 = Erreur
- 0 = Aucune
- 1 = Traitement
- 2 = Signled
- 3 = Filtré
- 4 = Résolu
- 5 = Ignoré
- 6 = Accusé de réception
- 7 = Supprimé
- 8 = NoRuleApplied
- 9 = MultipleTargetStatus
- 1000 = Erreur
InventoryScriptInfo
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
config
|
config | ||
|
données
|
data | ScriptDescriptionData | |
|
eventPattern
|
eventPattern | ||
|
localisationDetails
|
localizationDetails | array of ScriptLocalizationDetail | |
|
scriptId
|
scriptId | string | |
|
scriptName
|
scriptName | string | |
|
visibilité
|
visibility | string |
KeywordMatchingType
LocationInfo
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
latitude
|
latitude | double | |
|
longitude
|
longitude | double | |
|
horodatage
|
timestamp | date-time |
MultiTeamResult-2-EventSourceEndpointInfo-V2.EventSourceEndpointError-
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
données
|
data | array of EventSourceEndpointInfo | |
|
Erreurs
|
errors | array of V2.EventSourceEndpointError |
MultiTeamResult-2-TeamDutySummaryInfo-V2.TeamDutySummaryError-
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
données
|
data | array of TeamDutySummaryInfo | |
|
Erreurs
|
errors | array of V2.TeamDutySummaryError |
MultiTeamResult-2-UserDutyInfo-V2.DutyError-
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
données
|
data | array of UserDutyInfo | |
|
Erreurs
|
errors | array of V2.DutyError |
MultiTeamResult-2-V2.AlertCountsDetails-V2.AlertReportError-
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
données
|
data | array of V2.AlertCountsDetails | |
|
Erreurs
|
errors | array of V2.AlertReportError |
MultiTeamResult-2-V2.AlertSettingsDetails-V2.AlertSettingsError-
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
données
|
data | array of V2.AlertSettingsDetails | |
|
Erreurs
|
errors | array of V2.AlertSettingsError |
MultiTeamResult-2-V2.CategoryDetails-V2.CategoryError-
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
données
|
data | array of V2.CategoryDetails | |
|
Erreurs
|
errors | array of V2.CategoryError |
MultiTeamResult-2-V2.TeamDutySettingsDetails-V2.TeamDutySettingsError-
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
données
|
data | array of V2.TeamDutySettingsDetails | |
|
Erreurs
|
errors | array of V2.TeamDutySettingsError |
MultiTeamResult-2-V2.TeamPermissions-V2.PermissionError-
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
données
|
data | array of V2.TeamPermissions | |
|
Erreurs
|
errors | array of V2.PermissionError |
MultiTeamResult-2-V2.UserDetails-V2.TeamUserError-
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
données
|
data | array of V2.UserDetails | |
|
Erreurs
|
errors | array of V2.TeamUserError |
MultiTeamResult-2-V2.UserDutyDetails-V2.DutyChangeError-
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
données
|
data | array of V2.UserDutyDetails | |
|
Erreurs
|
errors | array of V2.DutyChangeError |
OverviewEvent
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
reconnuAlerts
|
acknowledgedAlerts | array of string | |
|
alertId
|
alertId | string | |
|
categoryId
|
categoryId | string | |
|
closedAlerts
|
closedAlerts | array of string | |
|
creationTime
|
creationTime | date-time | |
|
eventSourceGroupId
|
eventSourceGroupId | string | |
|
eventSourceId
|
eventSourceId | string | |
|
eventSourceTeamId
|
eventSourceTeamId | string | |
|
eventSourceType
|
eventSourceType | EventSourceTypes |
|
|
eventStatus
|
eventStatus | EventStatusCodes |
|
|
pièce d'identité
|
id | string | |
|
dernière modification
|
lastModified | date-time | |
|
severity
|
severity | EventSeverities |
|
|
teamId
|
teamId | string | |
|
texte
|
text | string | |
|
title
|
title | string |
PagedResultsPublicContinuationToken
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
nextPartitionKey
|
nextPartitionKey | string | |
|
nextRowKey
|
nextRowKey | string | |
|
nextTableName
|
nextTableName | string |
PagedResultsPublic-1-OverviewEvent-
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
continuationToken
|
continuationToken | PagedResultsPublicContinuationToken | |
|
hasMore
|
hasMore | boolean | |
|
results
|
results | array of OverviewEvent |
PagedResultsPublic-1-V2.AlertInfo-
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
continuationToken
|
continuationToken | PagedResultsPublicContinuationToken | |
|
hasMore
|
hasMore | boolean | |
|
results
|
results | array of V2.AlertInfo |
PagedResultsPublic-1-V2.RemoteJob-
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
continuationToken
|
continuationToken | PagedResultsPublicContinuationToken | |
|
hasMore
|
hasMore | boolean | |
|
results
|
results | array of V2.RemoteJob |
PersistentNotificationModes
PrepaidBalanceInfo
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
balance
|
balance | integer | |
|
latestTopUp
|
latestTopUp | date-time | |
|
pendingTransactions
|
pendingTransactions | boolean |
PrepaidSettingsInfo
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
topUpAmount
|
topUpAmount | integer | |
|
topUpEnabled
|
topUpEnabled | boolean | |
|
topUpLimit
|
topUpLimit | integer |
PrepaidTransactionInfo
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
montant
|
amount | integer | |
|
autoTopUpId
|
autoTopUpId | string | |
|
créé
|
created | date-time | |
|
createdBy
|
createdBy | string | |
|
monnaie
|
currency | string | |
|
modified
|
modified | date-time | |
|
packageCode
|
packageCode | string | |
|
status
|
status | string | |
|
statusCode
|
statusCode | integer | |
|
subscriptionId
|
subscriptionId | string | |
|
transactionId
|
transactionId | string |
ScheduleInfo
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
end
|
end | date-time | |
|
pièce d'identité
|
id | string | |
|
options
|
options | integer | |
|
start
|
start | date-time | |
|
userId
|
userId | string |
ScriptDescriptionData
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
descriptif
|
description | string | |
|
nom
|
name | string | |
|
scriptType
|
scriptType | string | |
|
brève description
|
shortDescription | string |
ScriptInstanceDetails
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
config
|
config | ||
|
customScriptDescription
|
customScriptDescription | string | |
|
customScriptName
|
customScriptName | string | |
|
enabled
|
enabled | boolean | |
|
eventPattern
|
eventPattern | ||
|
eventSourceId
|
eventSourceId | string | |
|
instanceId
|
instanceId | string | |
|
dernière modification
|
lastModified | date-time | |
|
runtimeInformation
|
runtimeInformation | ScriptInstanceInfoRuntimeInformationModel | |
|
scriptId
|
scriptId | string | |
|
scriptName
|
scriptName | string | |
|
subscriptionId
|
subscriptionId | string | |
|
teamId
|
teamId | string | |
|
webhookUrl
|
webhookUrl | string |
ScriptInstanceInfo
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
customScriptDescription
|
customScriptDescription | string | |
|
customScriptName
|
customScriptName | string | |
|
enabled
|
enabled | boolean | |
|
eventPattern
|
eventPattern | ||
|
eventSourceId
|
eventSourceId | string | |
|
instanceId
|
instanceId | string | |
|
dernière modification
|
lastModified | date-time | |
|
runtimeInformation
|
runtimeInformation | ScriptInstanceInfoRuntimeInformationModel | |
|
scriptId
|
scriptId | string | |
|
scriptName
|
scriptName | string | |
|
subscriptionId
|
subscriptionId | string | |
|
teamId
|
teamId | string |
ScriptInstanceInfoRuntimeInformationModel
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
runtimeStatus
|
runtimeStatus | ScriptInstanceInfoRuntimeStatus |
|
|
runtimeStatusMessage
|
runtimeStatusMessage | string |
ScriptInstanceInfoRuntimeStatus
- 0 = Inconnu
- 1 = Démarrage
- 2 = OK
- 3 = Arrêt
- 4 = Arrêté
- -1 = Erreur
- 0 = Inconnu
- 1 = Démarrage
- 2 = OK
- 3 = Arrêt
- 4 = Arrêté
- -1 = Erreur
ScriptLocalizationDetail
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
config
|
config | ||
|
données
|
data | ScriptDescriptionData | |
|
language
|
language | string |
SubscriptionFeature
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
nom
|
name | string | |
|
type
|
type | integer | |
|
value
|
value | string |
SubscriptionInfo
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
branchId
|
branchId | string | |
|
country
|
country | string | |
|
monnaie
|
currency | string | |
|
externalAccountId
|
externalAccountId | string | |
|
pièce d'identité
|
id | string | |
|
nom
|
name | string | |
|
nextBilling
|
nextBilling | date-time | |
|
ownerId
|
ownerId | string | |
|
planCode
|
planCode | string | |
|
planState
|
planState | integer | |
|
referralEnabled
|
referralEnabled | boolean | |
|
status
|
status | integer |
TeamCategoryOptOutModes
TeamDutySummaryInfo
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
dutyAssistEnabled
|
dutyAssistEnabled | boolean | |
|
dutySummaries
|
dutySummaries | array of DutySummaryInfo | |
|
teamId
|
teamId | string |
TeamInfo
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
pièce d'identité
|
id | string | |
|
imageLastModified
|
imageLastModified | date-time | |
|
memberIds
|
memberIds | array of string | |
|
nom
|
name | string | |
|
setupProgressEnabled
|
setupProgressEnabled | boolean | |
|
subscriptionId
|
subscriptionId | string | |
|
timezone
|
timezone | string |
TeamSetupProgress
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
completedSteps
|
completedSteps | array of string | |
|
teamId
|
teamId | string | |
|
horodatage
|
timestamp | date-time |
UserDutyInfo
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
lastChange
|
lastChange | date-time | |
|
onDuty
|
onDuty | boolean | |
|
onManagerDuty
|
onManagerDuty | boolean | |
|
en retard
|
overdue | boolean | |
|
teamId
|
teamId | string | |
|
userId
|
userId | string |
UserImage
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
contenu
|
content | byte | |
|
contentDispostion
|
contentDispostion | string | |
|
contentEncoding
|
contentEncoding | string | |
|
type de contenu
|
contentType | string | |
|
dernière modification
|
lastModified | date-time | |
|
nom
|
name | string |
Infos utilisateur
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
colorIndex
|
colorIndex | integer | |
|
contactAddresses
|
contactAddresses | array of | |
|
dutyInfos
|
dutyInfos | UserDutyInfo | |
|
externalAuthProvider
|
externalAuthProvider | string | |
|
pièce d'identité
|
id | string | |
|
isDeactivated
|
isDeactivated | boolean | |
|
isInvite
|
isInvite | boolean | |
|
isRemoteActionPinSet
|
isRemoteActionPinSet | boolean | |
|
lastSeen
|
lastSeen | date-time | |
|
courriel
|
string | ||
|
nom
|
name | string | |
|
roleId
|
roleId | string | |
|
subscriptionId
|
subscriptionId | string | |
|
timeZone
|
timeZone | string | |
|
userImageLastModified
|
userImageLastModified | date-time |
UserLicenseInfo
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
currentUsers
|
currentUsers | integer | |
|
isFree
|
isFree | boolean | |
|
isTrial
|
isTrial | boolean | |
|
licensedUsers
|
licensedUsers | integer | |
|
planCode
|
planCode | string |
UserPermission
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
autorisé
|
allowed | boolean | |
|
autorisation
|
permission | string |
UserSetupProgress
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
completedSteps
|
completedSteps | array of string | |
|
horodatage
|
timestamp | date-time | |
|
userId
|
userId | string |
V2. AlertAnnotationDetails
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
pièce d'identité
|
id | string | |
|
teamId
|
teamId | string | |
|
texte
|
text | string | |
|
horodatage
|
timestamp | date-time | |
|
type
|
type | V2.AlertAnnotationTypes |
|
|
userId
|
userId | string |
V2. AlertAnnotationTypes
V2. AlertAttachmentInfo
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
type de contenu
|
contentType | string | |
|
pièce d'identité
|
id | string | |
|
nom
|
name | string |
V2. AlertCategoryCountsDetails
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
reconnu
|
acknowledged | integer | |
|
categoryId
|
categoryId | string | |
|
fermé
|
closed | integer | |
|
Unhandled
|
unhandled | integer |
V2. AlertCountTypes
- 1 = TeamCurrentDuty
- 2 = TeamLastDuty
- 3 = UserLastDutyChange
- 4 = Last24Hours
- 1 = TeamCurrentDuty
- 2 = TeamLastDuty
- 3 = UserLastDutyChange
- 4 = Last24Hours
V2. AlertCountsDetails
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
reconnu
|
acknowledged | integer | |
|
categoryCounts
|
categoryCounts | array of V2.AlertCategoryCountsDetails | |
|
fermé
|
closed | integer | |
|
end
|
end | date-time | |
|
dernière modification
|
lastModified | date-time | |
|
start
|
start | date-time | |
|
subscriptionId
|
subscriptionId | string | |
|
teamId
|
teamId | string | |
|
type
|
type | V2.AlertCountTypes |
|
|
typeString
|
typeString | string | |
|
Unhandled
|
unhandled | integer | |
|
userId
|
userId | string |
V2. AlertDeliveryStatusCodes
- 0 = Aucune
- 1 = Ouvrir
- 2 = Échec
- 4 = Transmis
- 6 = Livré
- 8 = Protégé
- 9 = AbuseProtected
- 22 = Partiellement échec
- 24 = PartiellementTransmitted
- 26 = PartiellementDelivered
- 30 = NoOneOnDuty
- 31 = NoOneNotified
- 0 = Aucune
- 1 = Ouvrir
- 2 = Échec
- 4 = Transmis
- 6 = Livré
- 8 = Protégé
- 9 = AbuseProtected
- 22 = Partiellement échec
- 24 = PartiellementTransmitted
- 26 = PartiellementDelivered
- 30 = NoOneOnDuty
- 31 = NoOneNotified
V2. AlertDeliveryStatusDetails
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
alertId
|
alertId | string | |
|
statusCode
|
statusCode | V2.AlertDeliveryStatusCodes |
|
|
userDeliveryStatus
|
userDeliveryStatus | array of V2.UserDeliveryStatus |
V2. AlertDetails
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
parameters
|
parameters | array of V2.EventParameterDetails | |
|
attachments
|
attachments | array of V2.AlertAttachmentInfo | |
|
categoryId
|
categoryId | string | |
|
Escalades
|
escalations | array of V2.AlertEscalationDetails | |
|
eventId
|
eventId | string | |
|
externalId
|
externalId | string | |
|
Drapeaux
|
flags | V2.AlertFlags |
|
|
histoire
|
history | V2.AlertHistoryInfo | |
|
pièce d'identité
|
id | string | |
|
dernière modification
|
lastModified | date-time | |
|
requiredAcknowledgements
|
requiredAcknowledgements | integer | |
|
severity
|
severity | V2.AlertSeverities |
|
|
status
|
status | V2.AlertStatusDetails | |
|
subscriptionId
|
subscriptionId | string | |
|
teamId
|
teamId | string | |
|
texte
|
text | string | |
|
timelineEntries
|
timelineEntries | array of | |
|
title
|
title | string | |
|
workflowType
|
workflowType | V2.AlertWorkflowTypes |
|
V2. AlertEscalationDetails
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
alertId
|
alertId | string | |
|
alertStatus
|
alertStatus | V2.AlertStatusCodes |
|
|
escType
|
escType | V2.AlertEscalationType |
|
|
status
|
status | V2.AlertEscalationStatus |
|
|
teamId
|
teamId | string | |
|
teamName
|
teamName | string | |
|
horodatage
|
timestamp | date-time |
V2. AlertEscalationStatus
- 0 = Ok
- 1 = InProgress
- 2 = TargetInvalid
- 3 = TargetPrivate
- 4 = Filtré
- 5 = Supprimé
- 0 = Ok
- 1 = InProgress
- 2 = TargetInvalid
- 3 = TargetPrivate
- 4 = Filtré
- 5 = Supprimé
V2. AlertEscalationType
V2. AlertFlags
- 0 = Aucune
- 1 = HasAttachments
- 2 = HasAnnotations
- 4 = IsBreached
- 8 = HasLocationInfo
- 16 = EscalatedToTeam
- 32 = EscalatedToManager
- 64 = CreatedByEscalation
- 0 = Aucune
- 1 = HasAttachments
- 2 = HasAnnotations
- 4 = IsBreached
- 8 = HasLocationInfo
- 16 = EscalatedToTeam
- 32 = EscalatedToManager
- 64 = CreatedByEscalation
V2. AlertHistoryInfo
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
reconnuAt
|
acknowledgedAt | date-time | |
|
Remerciements
|
acknowledgements | array of string | |
|
closedAt
|
closedAt | date-time | |
|
closedBy
|
closedBy | string | |
|
créé
|
created | date-time |
V2. AlertInfo
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
categoryId
|
categoryId | string | |
|
eventId
|
eventId | string | |
|
externalId
|
externalId | string | |
|
Drapeaux
|
flags | V2.AlertFlags |
|
|
histoire
|
history | V2.AlertHistoryInfo | |
|
pièce d'identité
|
id | string | |
|
dernière modification
|
lastModified | date-time | |
|
requiredAcknowledgements
|
requiredAcknowledgements | integer | |
|
severity
|
severity | V2.AlertSeverities |
|
|
status
|
status | V2.AlertStatusDetails | |
|
subscriptionId
|
subscriptionId | string | |
|
teamId
|
teamId | string | |
|
texte
|
text | string | |
|
title
|
title | string | |
|
workflowType
|
workflowType | V2.AlertWorkflowTypes |
|
V2. AlertReportError
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
code d'erreur
|
errorCode | integer | |
|
errorDescription
|
errorDescription | string | |
|
teamId
|
teamId | string |
V2. AlertSettingsChannelType
V2. AlertSettingsDetails
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
escEnabled
|
escEnabled | boolean | |
|
escMode
|
escMode | AlertEscalationModes |
|
|
escRefId
|
escRefId | string | |
|
filterAction
|
filterAction | AlertFilterActions |
|
|
filterMode
|
filterMode | AlertFilterModes |
|
|
notificationProfileOverrides
|
notificationProfileOverrides | array of V2.AlertSettingsNotificationProfileDetails | |
|
optOut
|
optOut | TeamCategoryOptOutModes |
|
|
overrideNotificationProfiles
|
overrideNotificationProfiles | boolean | |
|
persNotInterval
|
persNotInterval | integer | |
|
persNotMode
|
persNotMode | PersistentNotificationModes |
|
|
responseMode
|
responseMode | AlertResponseModes |
|
|
responseTime
|
responseTime | integer | |
|
teamId
|
teamId | string |
V2. AlertSettingsError
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
code d'erreur
|
errorCode | integer | |
|
errorDescription
|
errorDescription | string | |
|
teamId
|
teamId | string |
V2. AlertSettingsNotificationProfileDetails
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
chaîne
|
channel | V2.AlertSettingsChannelType |
|
|
delayInMinutes
|
delayInMinutes | integer | |
|
enabled
|
enabled | boolean |
V2. AlertSeverities
V2. AlertStatusCodes
- 0 = Aucune
- 1 = Ouvrir
- 2 = Accusé de réception
- 4 = Fermé
- 8 = NoReply
- 16 = Échec
- 32 = Erreur
- 0 = Aucune
- 1 = Ouvrir
- 2 = Accusé de réception
- 4 = Fermé
- 8 = NoReply
- 16 = Échec
- 32 = Erreur
V2. AlertStatusDetails
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
alertDeliveryStatus
|
alertDeliveryStatus | V2.AlertDeliveryStatusDetails | |
|
statusCode
|
statusCode | V2.AlertStatusCodes |
|
V2. AlertWorkflowTypes
- 0 = Aucune
- 1 = Utilisateur
- 2 = TeamBroadcast
- 3 = TeamEscalation
- 4 = MultiAcknowledge
- 5 = MultiAcknowledgeEmergency
- 0 = Aucune
- 1 = Utilisateur
- 2 = TeamBroadcast
- 3 = TeamEscalation
- 4 = MultiAcknowledge
- 5 = MultiAcknowledgeEmergency
V2. AlertingPatternChannelType
V2. AlertingPatternDetails
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
categories
|
categories | array of string | |
|
escalationSettings
|
escalationSettings | V2.AlertingPatternEscalationSettings | |
|
pièce d'identité
|
id | string | |
|
nom
|
name | string | |
|
notificationProfileOverrides
|
notificationProfileOverrides | array of V2.AlertingPatternNotificationProfileDetails | |
|
overrideEscalationSettings
|
overrideEscalationSettings | boolean | |
|
overrideNotificationProfiles
|
overrideNotificationProfiles | boolean | |
|
overrideResponseSettings
|
overrideResponseSettings | boolean | |
|
responseSettings
|
responseSettings | V2.AlertingPatternResponseSettings | |
|
suppressSignl
|
suppressSignl | boolean | |
|
timeSlots
|
timeSlots | array of V2.TimeSlotDetails |
V2. AlertingPatternEscalationSettings
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
enabled
|
enabled | boolean | |
|
mode
|
mode | AlertEscalationModes |
|
|
referenceId
|
referenceId | string |
V2. AlertingPatternNotificationProfileDetails
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
chaîne
|
channel | V2.AlertingPatternChannelType |
|
|
delayInMinutes
|
delayInMinutes | integer | |
|
enabled
|
enabled | boolean |
V2. AlertingPatternResponseSettings
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
responseMode
|
responseMode | AlertResponseModes |
|
|
responseTime
|
responseTime | integer |
V2. CalloutTemplateDetails
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
categoryId
|
categoryId | string | |
|
externalId
|
externalId | string | |
|
pièce d'identité
|
id | string | |
|
location
|
location | string | |
|
nom
|
name | string | |
|
Objet
|
subject | string | |
|
targetAllTeams
|
targetAllTeams | boolean | |
|
targetTeamId
|
targetTeamId | string | |
|
texte
|
text | string | |
|
workflowType
|
workflowType | V2.CalloutTemplateWorkflowType |
|
V2. CalloutTemplateWorkflowType
- 0 = AsConfiguredInTeam
- 2 = TeamBroadcast
- 4 = MultiAcknowledge
- 5 = MultiAcknowledgeEmergency
- 0 = AsConfiguredInTeam
- 2 = TeamBroadcast
- 4 = MultiAcknowledge
- 5 = MultiAcknowledgeEmergency
V2. CategoryAugmentationDetails
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
enabled
|
enabled | boolean | |
|
pièce d'identité
|
id | string | |
|
nom
|
name | string | |
|
type
|
type | V2.CategoryAugmentationType |
|
|
value
|
value | string |
V2. CategoryAugmentationType
- 0 = Paramètre
- 1 = Objet
- 2 = Texte
- 3 = Emplacement
- 0 = Paramètre
- 1 = Objet
- 2 = Texte
- 3 = Emplacement
V2. CategoryDetails
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
augmentations
|
augmentations | array of V2.CategoryAugmentationDetails | |
|
color
|
color | string | |
|
enrichissements
|
enrichments | array of V2.CategoryEnrichmentDetails | |
|
pièce d'identité
|
id | string | |
|
imageName
|
imageName | string | |
|
isDefault
|
isDefault | boolean | |
|
keywordMatching
|
keywordMatching | V2.KeywordMatchingType |
|
|
Mots-clés
|
keywords | array of string | |
|
keywordsExcluded
|
keywordsExcluded | array of string | |
|
nom
|
name | string | |
|
options
|
options | V2.CategoryOptions |
|
|
order
|
order | integer | |
|
teamId
|
teamId | string |
V2. CategoryEnrichmentDetails
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
pièce d'identité
|
id | string | |
|
nom
|
name | string | |
|
type
|
type | V2.CategoryEnrichmentType |
|
|
value
|
value | string |
V2. CategoryEnrichmentType
V2. CategoryError
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
code d'erreur
|
errorCode | integer | |
|
errorDescription
|
errorDescription | string | |
|
teamId
|
teamId | string |
V2. CategoryOptions
- 0 = Aucune
- 1 = Masqué
- 2 = DenyDelete
- 4 = HideOptOut
- 8 = HideKeywords
- 0 = Aucune
- 1 = Masqué
- 2 = DenyDelete
- 4 = HideOptOut
- 8 = HideKeywords
V2. ChannelType
- 0 = Aucune
- 1 = Push
- 2 = E-mail
- 4 = Bot
- 8 = Voix
- 16 = SMS
- 0 = Aucune
- 1 = Push
- 2 = E-mail
- 4 = Bot
- 8 = Voix
- 16 = SMS
V2. DutyChangeError
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
code d'erreur
|
errorCode | integer | |
|
errorDescription
|
errorDescription | string | |
|
teamId
|
teamId | string | |
|
userId
|
userId | string |
V2. DutyError
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
code d'erreur
|
errorCode | integer | |
|
errorDescription
|
errorDescription | string | |
|
teamId
|
teamId | string |
V2. DutyModes
V2. EventDetails
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
parameters
|
parameters | array of V2.EventParameterDetails | |
|
reconnuAlerts
|
acknowledgedAlerts | array of string | |
|
closedAlerts
|
closedAlerts | array of string | |
|
creationTime
|
creationTime | date-time | |
|
eventSourceGroupId
|
eventSourceGroupId | string | |
|
eventSourceId
|
eventSourceId | string | |
|
eventSourceTeamId
|
eventSourceTeamId | string | |
|
eventSourceType
|
eventSourceType | V2.EventSourceTypes |
|
|
eventStatus
|
eventStatus | V2.EventStatusCodes |
|
|
externalId
|
externalId | string | |
|
de
|
from | string | |
|
pièce d'identité
|
id | string | |
|
dernière modification
|
lastModified | date-time | |
|
severity
|
severity | V2.EventSeverities |
|
|
targets
|
targets | array of V2.EventTargetDetails | |
|
texte
|
text | string | |
|
title
|
title | string |
V2. EventParameterDetails
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
pièce d'identité
|
id | string | |
|
nom
|
name | string | |
|
options
|
options | V2.EventParameterOptions |
|
|
order
|
order | integer | |
|
type
|
type | V2.EventParameterTypes |
|
|
value
|
value | string |
V2. EventParameterOptions
V2. EventParameterTypes
- 0 = Aucune
- 1 = Objet
- 2 = Tableau
- 3 = Constructeur
- 4 = Propriété
- 5 = Commentaire
- 6 = Entier
- 7 = Float
- 8 = Chaîne
- 9 = Boolean
- 10 = Null
- 11 = Non défini
- 12 = Date
- 13 = Brut
- 14 = Octets
- 15 = Guid
- 16 = Uri
- 17 = TimeSpan
- 100 = Html
- 0 = Aucune
- 1 = Objet
- 2 = Tableau
- 3 = Constructeur
- 4 = Propriété
- 5 = Commentaire
- 6 = Entier
- 7 = Float
- 8 = Chaîne
- 9 = Boolean
- 10 = Null
- 11 = Non défini
- 12 = Date
- 13 = Brut
- 14 = Octets
- 15 = Guid
- 16 = Uri
- 17 = TimeSpan
- 100 = Html
V2. EventSeverities
V2. EventSourceEndpointError
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
code d'erreur
|
errorCode | integer | |
|
errorDescription
|
errorDescription | string | |
|
teamId
|
teamId | string |
V2. EventSourceTypes
- 0 = Aucune
- 1 = e-mail
- 2 = WebHook
- 3 = Script
- 4 = Système
- 5 = Manuel
- 6 = Voix
- 7 = Api
- 0 = Aucune
- 1 = e-mail
- 2 = WebHook
- 3 = Script
- 4 = Système
- 5 = Manuel
- 6 = Voix
- 7 = Api
V2. EventStatusCodes
- 0 = Aucune
- 1 = Traitement
- 2 = Signled
- 3 = Filtré
- 4 = Résolu
- 5 = Ignoré
- 6 = Accusé de réception
- 7 = Supprimé
- 8 = NoRuleApplied
- 9 = MultipleTargetStatus
- 1000 = Erreur
- 0 = Aucune
- 1 = Traitement
- 2 = Signled
- 3 = Filtré
- 4 = Résolu
- 5 = Ignoré
- 6 = Accusé de réception
- 7 = Supprimé
- 8 = NoRuleApplied
- 9 = MultipleTargetStatus
- 1000 = Erreur
V2. EventTargetDetails
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
alertId
|
alertId | string | |
|
categoryId
|
categoryId | string | |
|
creationTime
|
creationTime | date-time | |
|
distributionId
|
distributionId | string | |
|
eventId
|
eventId | string | |
|
eventTargetStatus
|
eventTargetStatus | V2.EventTargetStatusCode |
|
|
pièce d'identité
|
id | string | |
|
dernière modification
|
lastModified | date-time | |
|
teamId
|
teamId | string |
V2. EventTargetStatusCode
- 0 = Aucune
- 1 = Traitement
- 2 = Signled
- 3 = Filtré
- 4 = Résolu
- 5 = Ignoré
- 6 = Accusé de réception
- 7 = Supprimé
- 1000 = Erreur
- 0 = Aucune
- 1 = Traitement
- 2 = Signled
- 3 = Filtré
- 4 = Résolu
- 5 = Ignoré
- 6 = Accusé de réception
- 7 = Supprimé
- 1000 = Erreur
V2. HolidayDetails
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Jour
|
day | integer | |
|
month
|
month | V2.Month |
|
|
répétitif
|
repeating | boolean | |
|
année
|
year | integer |
V2. InvitationResult
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
code d'erreur
|
errorCode | integer | |
|
errorMessage
|
errorMessage | string | |
|
invitedUser
|
invitedUser | V2.InvitedUserInfo | |
|
success
|
success | boolean |
V2. InvitedUserInfo
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
mailAddress
|
mailAddress | string | |
|
roleId
|
roleId | string | |
|
status
|
status | V2.UserStatus |
|
|
userId
|
userId | string |
V2. KeywordMatchingType
V2. Mois
- 0 = Annuler l’ensemble
- 1 = Janvier
- 2 = Février
- 3 = Mars
- 4 = avril
- 5 = Mai
- 6 = Juin
- 7 = juillet
- 8 = août
- 9 = septembre
- 10 = octobre
- 11 = Novembre
- 12 = Décembre
- 0 = Annuler l’ensemble
- 1 = Janvier
- 2 = Février
- 3 = Mars
- 4 = avril
- 5 = Mai
- 6 = Juin
- 7 = juillet
- 8 = août
- 9 = septembre
- 10 = octobre
- 11 = Novembre
- 12 = Décembre
V2. NotificationProfileDetails
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
chaîne
|
channel | V2.ChannelType |
|
|
delayInMinutes
|
delayInMinutes | integer | |
|
enabled
|
enabled | boolean | |
|
options
|
options | integer | |
|
persistant
|
persistent | boolean |
V2. Chevauchement deTimeSlotsDetails
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
refId
|
refId | string | |
|
timeSlots
|
timeSlots | array of V2.TimeSlotDetails |
V2. PermissionError
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
code d'erreur
|
errorCode | integer | |
|
errorDescription
|
errorDescription | string | |
|
teamId
|
teamId | string |
V2. PhoneNumberValidationStatus
- 0 = NotValidated
- 1 = Validé
- 2 = CountryNotSupported
- 0 = NotValidated
- 1 = Validé
- 2 = CountryNotSupported
V2. RemoteActionDefinitionDetails
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
parameters
|
parameters | array of V2.RemoteActionDefinitionParameterDetails | |
|
createdAt
|
createdAt | date-time | |
|
descriptif
|
description | string | |
|
executorService
|
executorService | string | |
|
externalId
|
externalId | string | |
|
pièce d'identité
|
id | string | |
|
nom
|
name | string | |
|
statusCode
|
statusCode | V2.RemoteActionDefinitionStatus |
|
|
statusDescription
|
statusDescription | string | |
|
type
|
type | V2.RemoteActionTypes |
|
|
version
|
version | integer |
V2. RemoteActionDefinitionParameterDetails
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
controlType
|
controlType | V2.RemoteActionParameterControlTypes |
|
|
defaultValue
|
defaultValue | string | |
|
descriptif
|
description | string | |
|
nom d’affichage
|
displayName | string | |
|
nom
|
name | string | |
|
options
|
options | V2.RemoteActionParameterOptions |
|
|
order
|
order | integer | |
|
values
|
values | array of string |
V2. RemoteActionDefinitionStatus
V2. RemoteActionDetails
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
parameters
|
parameters | array of V2.RemoteActionParameter | |
|
accès
|
access | array of V2.RemoteActionTeamAccessDetails | |
|
createdAt
|
createdAt | date-time | |
|
currentPrincipal
|
currentPrincipal | V2.RemoteActionPrincipalAccessDetails | |
|
définitionId
|
definitionId | string | |
|
definitionVersion
|
definitionVersion | integer | |
|
descriptif
|
description | string | |
|
enabled
|
enabled | boolean | |
|
executorService
|
executorService | string | |
|
externalId
|
externalId | string | |
|
pièce d'identité
|
id | string | |
|
nom
|
name | string | |
|
statusCode
|
statusCode | V2.RemoteActionStatus |
|
|
statusDescription
|
statusDescription | string | |
|
subscriptionId
|
subscriptionId | string | |
|
teamId
|
teamId | string | |
|
type
|
type | V2.RemoteActionTypes |
|
V2. RemoteActionInfo
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
accès
|
access | array of V2.RemoteActionTeamAccessDetails | |
|
createdAt
|
createdAt | date-time | |
|
currentPrincipal
|
currentPrincipal | V2.RemoteActionPrincipalAccessDetails | |
|
définitionId
|
definitionId | string | |
|
descriptif
|
description | string | |
|
enabled
|
enabled | boolean | |
|
pièce d'identité
|
id | string | |
|
nom
|
name | string | |
|
statusCode
|
statusCode | V2.RemoteActionStatus |
|
|
statusDescription
|
statusDescription | string | |
|
subscriptionId
|
subscriptionId | string | |
|
teamId
|
teamId | string | |
|
type
|
type | V2.RemoteActionTypes |
|
V2. RemoteActionParameter
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
controlType
|
controlType | V2.RemoteActionParameterControlTypes |
|
|
nom d’affichage
|
displayName | string | |
|
nom
|
name | string | |
|
options
|
options | V2.RemoteActionParameterOptions |
|
|
order
|
order | integer | |
|
value
|
value | string | |
|
values
|
values | array of string |
V2. RemoteActionParameterControlTypes
- 0 = Texte
- 1 = MultiLineText
- 2 = Entier
- 3 = Double
- 4 = Bool
- 5 = Heure
- 6 = Date
- 7 = Fuseau horaire
- 8 = Mot de passe
- 9 = Code confidentiel
- 10 = SingleChoice
- 11 = MultiChoice
- 12 = Suggestion
- 0 = Texte
- 1 = MultiLineText
- 2 = Entier
- 3 = Double
- 4 = Bool
- 5 = Heure
- 6 = Date
- 7 = Fuseau horaire
- 8 = Mot de passe
- 9 = Code confidentiel
- 10 = SingleChoice
- 11 = MultiChoice
- 12 = Suggestion
V2. RemoteActionParameterOptions
- 0 = Aucune
- 1 = Obligatoire
- 2 = Verrouillé
- 4 = Chiffré
- 0 = Aucune
- 1 = Obligatoire
- 2 = Verrouillé
- 4 = Chiffré
V2. RemoteActionPrincipalAccessDetails
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
canEdit
|
canEdit | boolean | |
|
canExecute
|
canExecute | boolean |
V2. RemoteActionStatus
- 0 = Désactivé
- 1 = Activé
- 2 = Non valide
- 4 = ProviderDisabled
- 0 = Désactivé
- 1 = Activé
- 2 = Non valide
- 4 = ProviderDisabled
V2. RemoteActionTeamAccessDetails
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
canEdit
|
canEdit | boolean | |
|
canExecute
|
canExecute | boolean | |
|
teamId
|
teamId | string |
V2. RemoteActionTypes
- 0 = Inconnu
- 1 = Script
- 2 = EnterpriseAlert
- 3 = Webhook
- 0 = Inconnu
- 1 = Script
- 2 = EnterpriseAlert
- 3 = Webhook
V2. RemoteJob
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
parameters
|
parameters | array of V2.RemoteJobParameter | |
|
actionId
|
actionId | string | |
|
activatedAt
|
activatedAt | date-time | |
|
createdAt
|
createdAt | date-time | |
|
creatorInfo
|
creatorInfo | V2.RemoteJobCreatorDetails | |
|
définitionId
|
definitionId | string | |
|
externalId
|
externalId | string | |
|
pièce d'identité
|
id | string | |
|
lastUpdate
|
lastUpdate | date-time | |
|
options
|
options | V2.RemoteJobOptions |
|
|
startedAt
|
startedAt | date-time | |
|
statusCode
|
statusCode | V2.RemoteJobStatusCodes |
|
|
statusDescription
|
statusDescription | string | |
|
détails du statut
|
statusDetails | string | |
|
type
|
type | V2.RemoteActionTypes |
|
V2. RemoteJobCreatorDetails
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
referenceId
|
referenceId | string | |
|
referenceName
|
referenceName | string | |
|
type
|
type | V2.RemoteJobCreatorType |
|
V2. RemoteJobCreatorType
- 0 = Aucune
- 1 = Utilisateur
- 2 = ApiKey
- 3 = Système
- 0 = Aucune
- 1 = Utilisateur
- 2 = ApiKey
- 3 = Système
V2. RemoteJobOptions
V2. RemoteJobParameter
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
nom
|
name | string | |
|
value
|
value | string |
V2. RemoteJobStatusCodes
- 0 = Aucune
- 1 = En attente
- 2 = Prêt
- 4 = Exécution
- 8 = Exécuté
- 16 = Erreur
- 0 = Aucune
- 1 = En attente
- 2 = Prêt
- 4 = Exécution
- 8 = Exécuté
- 16 = Erreur
V2. ScheduleDetails
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
end
|
end | date-time | |
|
pièce d'identité
|
id | string | |
|
options
|
options | integer | |
|
start
|
start | date-time | |
|
teamId
|
teamId | string | |
|
userId
|
userId | string |
V2. TeamDutySettingsDetails
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
autosnapEnabled
|
autosnapEnabled | boolean | |
|
dutyAssistantEnabled
|
dutyAssistantEnabled | boolean | |
|
dutyChangeNotificationsEnabled
|
dutyChangeNotificationsEnabled | boolean | |
|
dutyLength
|
dutyLength | integer | |
|
handoverDate
|
handoverDate | date-time | |
|
handoverTime
|
handoverTime | integer | |
|
handoverWeekDay
|
handoverWeekDay | integer | |
|
minMemberOnDuty
|
minMemberOnDuty | integer | |
|
planningEnabled
|
schedulingEnabled | boolean | |
|
shiftReport CarbonCopyMail
|
shiftReportCarbonCopyMail | string | |
|
shiftReportEnabled
|
shiftReportEnabled | boolean | |
|
teamId
|
teamId | string | |
|
timezone
|
timezone | string |
V2. TeamDutySettingsError
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
code d'erreur
|
errorCode | integer | |
|
errorDescription
|
errorDescription | string | |
|
teamId
|
teamId | string |
V2. TeamDutySummaryError
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
code d'erreur
|
errorCode | integer | |
|
errorDescription
|
errorDescription | string | |
|
userId
|
userId | string |
V2. TeamHolidayDetails
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
vacances
|
holidays | array of V2.HolidayDetails | |
|
teamId
|
teamId | string |
V2. TeamImageDetails
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
contenu
|
content | byte | |
|
contentDispostion
|
contentDispostion | string | |
|
contentEncoding
|
contentEncoding | string | |
|
type de contenu
|
contentType | string | |
|
dernière modification
|
lastModified | date-time | |
|
nom
|
name | string |
V2. TeamMembershipDetails
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
mailAddress
|
mailAddress | string | |
|
memberSince
|
memberSince | date-time | |
|
roleId
|
roleId | string | |
|
status
|
status | V2.UserStatus |
|
|
teamId
|
teamId | string | |
|
userId
|
userId | string |
V2. TeamPermissions
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
permissions
|
permissions | array of UserPermission | |
|
teamId
|
teamId | string |
V2. TeamPrivacySettingsDetails
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
hideContactAddresses
|
hideContactAddresses | boolean | |
|
hideDutyData
|
hideDutyData | boolean | |
|
hideForEscalation
|
hideForEscalation | boolean | |
|
teamId
|
teamId | string |
V2. TeamPublicDetails
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
pièce d'identité
|
id | string | |
|
nom
|
name | string | |
|
privacySettings
|
privacySettings | V2.TeamPrivacySettingsDetails |
V2. TeamUserError
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
code d'erreur
|
errorCode | integer | |
|
errorDescription
|
errorDescription | string | |
|
teamId
|
teamId | string |
V2. TimeSlotDetails
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
end
|
end | V2.WeekTimeDetails | |
|
pièce d'identité
|
id | string | |
|
start
|
start | V2.WeekTimeDetails |
V2. TimeSlotValidationResultDetails
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
isOverlapping
|
isOverlapping | boolean | |
|
item
|
item | V2.TimeSlotDetails | |
|
chevauchement detimeSlots
|
overlappingTimeSlots | array of V2.OverlappingTimeSlotsDetails | |
|
valable
|
valid | boolean |
V2. UserDeliveryStatus
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
statusCode
|
statusCode | V2.UserDeliveryStatusCodes |
|
|
userId
|
userId | string |
V2. UserDeliveryStatusCodes
- 0 = Aucune
- 1 = Ouvrir
- 2 = Échec
- 4 = Transmis
- 6 = Livré
- 8 = Protégé
- 9 = AbuseProtected
- 24 = PartiellementTransmitted
- 26 = PartiellementDelivered
- 30 = NotOnDuty
- 31 = CategoryOptOut
- 32 = NoMessagesSent
- 0 = Aucune
- 1 = Ouvrir
- 2 = Échec
- 4 = Transmis
- 6 = Livré
- 8 = Protégé
- 9 = AbuseProtected
- 24 = PartiellementTransmitted
- 26 = PartiellementDelivered
- 30 = NotOnDuty
- 31 = CategoryOptOut
- 32 = NoMessagesSent
V2. UserDetails
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
colorIndex
|
colorIndex | integer | |
|
contactAddresses
|
contactAddresses | array of | |
|
dutyInfos
|
dutyInfos | array of V2.UserDutyDetails | |
|
externalAuthProvider
|
externalAuthProvider | string | |
|
pièce d'identité
|
id | string | |
|
isDeactivated
|
isDeactivated | boolean | |
|
isInvite
|
isInvite | boolean | |
|
lastSeen
|
lastSeen | date-time | |
|
courriel
|
string | ||
|
nom
|
name | string | |
|
remoteActionPinSet
|
remoteActionPinSet | boolean | |
|
subscriptionId
|
subscriptionId | string | |
|
timeZone
|
timeZone | string | |
|
userImageLastModified
|
userImageLastModified | date-time |
V2. UserDutyDetails
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
dutyMode
|
dutyMode | V2.DutyModes |
|
|
lastChange
|
lastChange | date-time | |
|
onDutyTime
|
onDutyTime | integer | |
|
en retard
|
overdue | boolean | |
|
teamId
|
teamId | string | |
|
userId
|
userId | string |
V2. UserLocaleResponseDetails
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
pièce d'identité
|
id | string | |
|
language
|
language | string | |
|
timeZone
|
timeZone | string |
V2. UserPhoneNumberDetails
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
countryCode
|
countryCode | string | |
|
numéro de téléphone
|
phoneNumber | string | |
|
validationStatus
|
validationStatus | V2.PhoneNumberValidationStatus |
|
V2. UserStatus
V2. WeekTimeDetails
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
heure
|
hour | integer | |
|
minutes
|
minutes | integer | |
|
jour de la semaine
|
weekday | V2.Weekday |
|
V2. Jour de la semaine
- 0 = Vacances
- 1 = Lundi
- 2 = Mardi
- 3 = Mercredi
- 4 = Jeudi
- 5 = Vendredi
- 6 = Samedi
- 7 = Dimanche
- 0 = Vacances
- 1 = Lundi
- 2 = Mardi
- 3 = Mercredi
- 4 = Jeudi
- 5 = Vendredi
- 6 = Samedi
- 7 = Dimanche
WebhookInfo
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
descriptif
|
description | string | |
|
enabled
|
enabled | boolean | |
|
extUrl
|
extUrl | string | |
|
pièce d'identité
|
id | string | |
|
nom
|
name | string | |
|
subId
|
subId | string | |
|
teamId
|
teamId | string |
ficelle
Il s’agit du type de données de base « string ».
binaire
Il s’agit du type de données de base "binaire".