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

Generar datos de informes sobre los usuarios que están registrados en el portal y que están completando formación en los programas ASAP.

El tamaño de los datos pasados se describe en el cuerpo de la solicitud.

Solicitud

Encabezado:

• Authorization: El token de la API de la empresa.

Cuerpo:

• lng – una cadena: El código de idioma del idioma utilizado para el informe. Uno de los idiomas de localización disponibles en el formato ISO 639-1. Es necesario. Se indica en minúsculas.

  Correspondencias entre el idioma del informe y el valor de lng

  Idioma	Código de idioma / nombre de subcarpeta
  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 – una matriz: La dirección de correo electrónico del usuario. Se indica para obtener datos de un usuario concreto. Opcional.
• page – tipo int: número de la página con el informe. Al acceder a la API, no se muestran más de 500 registros en la respuesta. Si el informe contiene más usuarios, para ver más de 500 registros, debe especificar además la página del informe. Opcional.

  Por ejemplo, para ver el registro 501 del informe, establezca el parámetro "page": 2.

Ejemplo del cuerpo de una solicitud: { "lng":"en", "email":["example@email.com","jackrockstar88@email.com"], "page":1 }

Respuesta

JSON que contiene una matriz de datos sobre cada usuario:

• id – una cadena: El ID asignado al empleado en la plataforma ASAP.
• email – una cadena: La dirección de correo electrónico utilizada para registrar al usuario.
• shortName – una cadena: El nombre corto registrado del usuario.
• fullName – una cadena: El nombre completo registrado del usuario.
• group – una cadena: El grupo de formación actual del usuario.
• educationTime – una cadena: Duración de la formación en segundos.
• mainEducationProgress – una cadena: Categoría de rendimiento en el curso principal.
• expressEducationProgress – una cadena: Categoría de rendimiento en el curso exprés.
• educationStatus – una cadena: Estado actual de la formación.
• mainEducationProgressPercent – un valor flotante: Progreso de la formación en el curso principal, expresado como un porcentaje con el formato xx.xx.
• expressEducationProgressPercent – un valor flotante: Progreso de la formación en el curso exprés, expresado como un porcentaje con el formato xx.xx.
• mainEducationEndPlan – una fecha: Fecha prevista para la finalización del curso principal.
• expressEducationEndPlan – una fecha: Fecha prevista para la finalización del curso exprés.
• realMainEducationEnd – una fecha: Fecha de finalización del curso principal.
• realExpressEducationEnd – una fecha: Fecha de finalización del curso exprés.
• educationMainCourses – una matriz: Cursos de la formación y estado de la formación en el curso principal. Formato de respuesta.
• educationExpressCourses – una matriz: cursos de la formación y estado de la formación en el curso exprés. Formato de respuesta.
• dateLastActive – una fecha: La fecha de la actividad más reciente, en un formato que depende del idioma de localización de entrada.
• certificatesReceived – un entero: El número total de certificados recibidos por el usuario durante la formación.

  Si el usuario no ha iniciado la formación o no ha recibido ningún certificado, se devuelve «0».

• phishingAttacks – una matriz: Información sobre un ataque de phishing durante la formación en la plataforma ASAP. Formato de respuesta.

Ejemplo de una respuesta: { "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 } ] }

Posibles errores:

• 200 – success: La operación se ha realizado correctamente.
• 401 – common-unauthorized: Ha ocurrido un error de autenticación.
• 404 – user not found: Se ha enviado una dirección de correo electrónico no válida.
• 400 – bad request: Hay algún error con la solicitud.
• 500 – internal-server-error: Ha habido un error interno del servidor.

En esta sección Formato del objeto educationMainCourses Formato del objeto educationExpressCourses Formato del objeto PhishingAttacks

Ir arriba