RESTful: Obtener reportes

Guía de Datos y análisis de Dayforce

Version
R2023.2.0
RESTful: Obtener reportes

La siguiente función recuperará una lista de reportes a los que tiene acceso en la función Análisis de Dayforce. La información devuelta contiene detalles sobre cada reporte, como el nombre y la descripción del reporte. El contenido de cada reporte no estará disponible en esta función.

Resumen

La solicitud Obtener reportes permite a la aplicación de cliente recuperar una lista de reportes disponibles. Los parámetros obligatorios para la llamada incluyen ClientNamespace y BearerToken, aunque la autorización otorgada por el BearerToken también se puede proporcionar a través de la autenticación básica de usuario. El sistema buscará todos los reportes a los que tiene acceso en la función de reportes específicos.

La dirección URL para Obtener reportes de análisis utiliza la siguiente dirección URL base:

https://www.dayforcehcm.com/api/ClientName/V1/Analytics/Reports

Parámetros

Nota: Un asterisco (*) junto al nombre de un parámetro indica un parámetro obligatorio.

ClientNamespace* (cadena)

  • Identifica de forma única la instancia de Dayforce del cliente. Esto es necesario para iniciar sesión.

BearerToken* (cadena)

  • El token de autorización es obligatorio para esta API. No es posible probar esta API en la red de programadores (DDN) de Dayforce. Esta autorización también puede proporcionarse con la autenticación básica de usuario.

Respuesta

La respuesta está en formato JSON, como se ilustra en el siguiente ejemplo:

{
  "Data": [
    {
      "ReportId": "string",
      "Name": "string",
      "Description": "string"
    }
  ],
  "ProcessResults": [
    {
      "Code": "string",
      "Context": "string",
      "Level": "string",
      "Message": "string"
    }
  ]
}