Méthode « POST /openapi/v1/report »

Générer des données de rapport sur les utilisateurs qui sont enregistrés sur le portail et qui suivent une formation sur les programmes ASAP.

La taille des données transmises est décrite dans le corps de la demande.

Demande

En-tête :

• Autorisation : le jeton API de l'entreprise.

Corps :

• lng : une chaîne – le code de la langue utilisée pour le rapport. Une des langues de localisation disponibles au format ISO 639-1. Obligatoire. La langue est indiquée en lettres minuscules.

  Correspondance entre la langue du rapport et la valeur de lng

  Paramètres régionaux	Code de la langue / Nom du sous-dossier
  English	en
  Bahasa Indonesia	id
  Bosanski	bs
  Català	ca
  Čeština	cs
  Dansk	da
  Deutsch	de
  Ελληνικά	el
  Español (España)	es
  Español (México)	mx
  Français	fr
  Հայերեն	hy
  Hrvatski	hr
  Italiano	it
  Қазақша	kk
  Magyar	hu
  Nederlands	nl
  Polski	pl
  Português (Brasil)	br
  Português (Portugal)	pt
  Română	ro
  Русский	ru
  Slovenský	sl
  Slovenský	sk
  Srpski	sr
  Svenska	sv
  Tiếng Việt	vi
  Türkçe	tr
  العربية	ar
  ไทย	th
  日本語	ja
  简体中文	cn
  繁體中文（香港）	zh

• email : un tableau – l'adresse email de l'utilisateur. Indiquée pour obtenir des données sur un utilisateur particulier. Facultative.
• page : type int – numéro de la page avec le rapport. Lors de l'accès à l'API, la réponse n'affiche pas plus de 500 enregistrements. S'il y a plus d'utilisateurs dans le rapport, pour afficher les enregistrements au-delà de 500, vous devez également indiquer la page du rapport. Facultative.

  Par exemple, pour visualiser le 501ᵉ enregistrement du rapport, il faut définir le paramètre « page » : 2.

Exemple du corps d'une demande : { "lng":"en", "email":["example@email.com","jackrockstar88@email.com"], "page":1 }

Réponse

JSON contenant un tableau de données sur chaque utilisateur :

• id : une chaîne – l'identifiant attribué à l'employé sur la plateforme ASAP.
• email : une chaîne – l'adresse email utilisée pour enregistrer l'utilisateur.
• shortName : une chaîne – le nom court enregistré de l'utilisateur.
• fullName : une chaîne – le nom complet enregistré de l'utilisateur.
• group : une chaîne – le groupe de formation actuel de l'utilisateur.
• educationTime : une chaîne – durée de la formation en secondes.
• mainEducationProgress : une chaîne – catégorie de performance dans la formation principale.
• expressEducationProgress : une chaîne – catégorie de performance dans la formation express.
• educationStatus : une chaîne – état actuel de la formation.
• mainEducationProgressPercent : un flottant – progression de la formation dans la formation principale, exprimée en pourcentage dans le format xx.xx.
• expressEducationProgressPercent : un flottant – progression de la formation dans la formation express, exprimée en pourcentage dans le format xx.xx.
• mainEducationEndPlan : une date – date prévue pour l'achèvement de la formation principale.
• expressEducationEndPlan : une date – date prévue pour l'achèvement de la formation express.
• realMainEducationEnd : une date – date d'achèvement de la formation principale.
• realExpressEducationEnd : une date – date d'achèvement de la formation express.
• educationMainCourses : un tableau – formations et état des formations dans la formation principale. Format de la réponse.
• educationExpressCourses : un tableau – formations et état des formations dans la formation express. Format de la réponse.
• dateLastActive : une date – la date de l'activité la plus récente, dans un format qui dépend de la langue de localisation de saisie.
• certificatesReceived : un int – le nombre total de certificats reçus par l'utilisateur pendant la formation.

  Si l'utilisateur n'a pas commencé la formation ou n'a pas reçu de certificats, la valeur « 0 » est renvoyée.

• phishingAttacks : un tableau – informations sur une attaque de phishing lors d'une formation sur la plateforme ASAP. Format de la réponse.

Exemple de réponse : { "id":"60e050803050c0704080a0e060", "email":"jackrockstar88@email.com", "shortName":"Jack", "fullName":"Jack Rock", "group":"Faible risque", "educationTime":840, "mainEducationProgress":"En retard sur le programme", "expressEducationProgress":"En cours", "educationStatus":"pas encore commencé", "mainEducationProgressPercent":"50.00", "expressEducationProgressPercent":"14.80", "mainEducationEndPlan":"2022-08-08", "expressEducationEndPlan":"0001-01-01", "realMainEducationEnd":"0001-01-01", "realExpressEducationEnd":"0001-01-01", "educationMainCourses": [ { code: 'Password', level: 1 || null, status: 0 || 1 || 2 startedAt: '' finishedAt: '' || null, } ], "educationExpressCourses": [ { code: 'Password', level: 1 || null, status: 0 || 1 || 2 startedAt: '' finishedAt: '' || null, } ], "dateLastActive":"2022-08-08", "certificatesReceived":2, "phishingAttacks": [ { code: 'Password', level: 1 startedAt: '2022-09-09T18.00.00.0Z', phishingAttackLetter: 'Hallo!', phishingAttackResult: '0', followPhishingLinkAt: null } ] }

Erreurs possibles

• 200 : successful – l'opération a réussi.
• 401 : common-unauthorized – il y a eu une erreur d'authentification.
• 404 : user not found – l'email a été envoyé à une adresse email incorrecte.
• 400 : Bad Request – une erreur s'est produite dans la demande.
• 500 : internal-server-error – une erreur de serveur interne s'est produite.

Dans cette section Format de l'objet educationMainCourses Format de l'objet educationExpressCourses Format de l'objet PhishingAttacks

Jusqu'au sommet