Esta función recupera información sobre un conjunto de datos. Solo puede acceder a los conjuntos de datos que creó.
Resumen
La solicitud Obtener metadatos del conjunto de datos permite a la aplicación de cliente recuperar los metadatos (estado y fila) relacionados con el conjunto de datos del reporte. Los parámetros obligatorios para la llamada incluyen dataId, 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 Obtener metadatos del conjunto de datos utiliza la siguiente dirección URL base:
https://www.dayforcehcm.com/api/ClientName/V1/Analytics/Datasets/datasetId/Metadata
Nota: Los conjuntos de datos caducan si no se ha accedido a ellos a través del terminal Obtener conjunto de datos durante 63 días. Si se envía una solicitud Obtener metadatos del conjunto de datos para un conjunto de datos vencido, la respuesta mostrará el estado “Vencido”.
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.
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": {
"DatasetId": "string",
"Status": "string",
"RowCount": "string"
"ReportId": 0,
"Refresh Status": "string"
"Filters": "string",
"Parameters": "string",
},
Nota: El "Refresh Status" no se muestra durante el estado "Processing" o "Requested", o cuando el conjunto de datos no se ha actualizado. Además, "Row Count" no se muestra durante el estado "Requested"; además los "Filters" y "Parameters" no se muestran durante el estado "Processing" o "Requested".