La siguiente función recupera el contenido del conjunto de datos de un reporte. Solo puede acceder a los conjuntos de datos que creó.
Resumen
La solicitud GET Dataset permite a la aplicación de cliente recuperar el contenido del conjunto de datos de un reporte. Entre los parámetros obligatorios para la llamada se incluyen DatasetId, 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.
La dirección URL de la solicitud GET Dataset utiliza la siguiente dirección URL base:
https://www.dayforcehcm.com/api/ClientName/V1/Analytics/Datasets/datasetId
Nota: Los conjuntos de datos vencen si no se accedió a ellos mediante el punto de conexión GET Dataset durante 63 días. Si se envía una solicitud GET Dataset para un conjunto de datos vencido, se devolverá una respuesta 204: Sin contenido porque el conjunto de datos solicitado venció.
Parámetros
Nota: Un asterisco (*) junto al nombre de un parámetro indica un parámetro obligatorio.
datasetId* (cadena)
- Identifica de forma única un conjunto de datos.
page (cadena)
- Identifica el número de páginas.
DatasetPageSize (cadena)
-
Identifica el valor máximo de tamaño de página del conjunto de datos en megabytes. Este parámetro anula el valor existente del campo Tamaño máximo de página del conector de datos de análisis (valor máximo permitido: 2000 MB) en Admin. Sistema > Propiedades del cliente.
Nota: Si el valor que indique supera el valor máximo permitido de 2000 MB, se restablecerá automáticamente a 2000 MB. Si cae por debajo del mínimo de 32 MB, se restablecerá a 32 MB.
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": {
"Name": " Care",
"Start Date": null,
"Due Date": null,
"Completed Date": null,
"Priority Level": 0,
"Budget Hours": 0.00000,
"% Time Elapsed": null,
"Product Group": null,
"Product Module": null,
"Project Type": null,
"Project Client": null,
"Project Phase": null,
"Account #": null,
"IFRS": false,
"Clock Code": null,
"XRef Code": null,
"Ledger Code": null,
"Certified Payroll Project Number": null
}
],
"Page": null,
"TotalPages": null}
Nota: "Data", "Page" y "TotalPages" solo se muestran si la función de paginación está habilitada.