Metodo "POST /openapi/v1/report"

Genera i dati dei rapporti sugli utenti che sono registrati sul portale e stanno completando la formazione sui programmi ASAP.

La dimensione dei dati trasmessi è descritta nel corpo della richiesta.

Richiesta

Intestazione:

• Autorizzazione: token API dell'azienda.

Corpo:

• lng – una sequenza: codice della lingua utilizzata per il rapporto. Una delle lingue di localizzazione disponibili nel formato ISO 639-1. Necessario. È indicato in lettere minuscole.

  Mappatura tra la lingua del rapporto e il valore di lng

  Locale	Codice lingua/nome della sottocartella
  Inglese	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
  ไทย	ni
  日本語	ja
  简体中文	cn
  繁體中文（香港）	zh

• email – un array: indirizzo email dell'utente. Indicato per ottenere dati su un utente specifico. Opzionale.
• page – digita int: numero della pagina con il rapporto. Quando accedi all'API, nella risposta vengono visualizzati al massimo 500 record. Se sono presenti più utenti nel rapporto, per visualizzare più di 500 record devi specificare anche la pagina del rapporto. Opzionale.

  Ad esempio, per visualizzare il record 501° del rapporto, imposta il parametro "page": 2.

Esempio del corpo di una richiesta: { "lng":"en", "email":["example@email.com","jackrockstar88@email.com"], "page":1 }

Risposta

JSON che contiene un array di dati su ciascun utente:

• id – una sequenza: ID assegnato al dipendente sulla piattaforma ASAP.
• email – una sequenza: indirizzo email usato per registrare l'utente.
• shortName – una sequenza: nome registrato dell'utente.
• fullName – una sequenza: nome e cognome registrato dell'utente.
• group – una sequenza: gruppo di formazione corrente dell'utente.
• educationTime – una sequenza: durata della formazione in secondi.
• mainEducationProgress – una sequenza: categoria di rendimento nel corso principale.
• expressEducationProgress – una sequenza: categoria di rendimento nel corso rapido.
• educationStatus – una sequenza: stato attuale della formazione.
• mainEducationProgressPercent – un float: avanzamento della formazione nel corso principale, espresso in percentuale nel formato xx.xx.
• expressEducationProgressPercent – un float: avanzamento della formazione nel corso rapido, espresso in percentuale nel formato xx.xx.
• mainEducationEndPlan – una data: data pianificata per il completamento del corso principale.
• expressEducationEndPlan – una data: data pianificata per il completamento del corso rapido.
• realMainEducationEnd – una data: data di completamento del corso principale.
• realExpressEducationEnd – una data: data di completamento del corso rapido.
• educationMainCourses – un array: corsi di formazione e stato della formazione nel corso principale. Formato della risposta.
• educationExpressCourses – un array: corsi di formazione e stato della formazione nel corso rapido. Formato della risposta.
• dateLastActive – una data: data dell'attività più recente, in un formato che varia in base alla lingua di localizzazione dell'input.
• certificatesReceived – un int: numero totale di attestati ricevuti dall'utente durante la formazione.

  Se l'utente non ha avviato la formazione o non ha ricevuto alcun attestato, viene restituito "0".

• phishingAttacks – un array: informazioni su un attacco di phishing durante la formazione sulla piattaforma ASAP. Formato della risposta.

Esempio di risposta: { "id":"60e050803050c0704080a0e060", "email":"jackrockstar88@email.com", "shortName":"Jack", "fullName":"Jack Rock", "group":"Low Risk", "educationTime":840, "mainEducationProgress":"Behind schedule", "expressEducationProgress":"In progress", "educationStatus":"not started", "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 } ] }

Possibili errori

• 200 – success: l'operazione è andata a buon fine.
• 401 – common-unauthorized: si è verificato un errore di autenticazione.
• 404 – user not found: è stato inviato un indirizzo email non valido.
• 400 – bad request: si è verificato un problema con la richiesta.
• 500 – internal-server-error: si è verificato un errore del server interno.

In questa sezione Formato dell'oggetto educationMainCourses Formato dell'oggetto educationExpressCourses Formato dell'oggetto PhishingAttacks

In alto