Resumen
La solicitud GET Report Metadata permite a la aplicación de cliente recuperar los metadatos (campos, filtros, etc.) de un reporte. Entre los parámetros obligatorios para la llamada se incluyen reportId, clientNamespace y BearerToken, aunque la autorización otorgada por 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 Report Metadata utiliza la siguiente dirección URL base:
https://www.dayforcehcm.com/api/ClientName/V1/Analytics/Reports/ReportId/Metadata
El punto de conexión de GET Report Metadata sigue la norma ISO 8601 para los estándares de fecha y hora. Se utilizará el siguiente formato estandarizado para los campos de fecha y hora:
aaaa-mm-ddThh:mm:ss[+|-]hh:mm (hora y fecha local del servidor con ajuste respecto a la hora UTC).
Los siguientes ejemplos muestran cómo se usa el formato para diferentes tipos de datos de fecha y hora:
- Fecha y hora:
"Value": "2022-02-08T00:45:00-05:00" - Fecha:
"2022-02-08T00:00:00-05:00"(incluya la hora con 00 para horas, minutos y segundos) - Hora:
"2022-02-08T14:15:30-05:00"(puede usar la fecha actual para llamar a la API o una fecha válida)
Parámetros
Nota: Un asterisco (*) junto al nombre de un parámetro indica un parámetro obligatorio.
reportId* (número entero)
- Identifica de forma única un reporte.
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": "string",
"Description": "string",
"XRefCode": "string",
"ReportId": 0,
"MaxRows": 0,
"OnlyIncludeUniqueRecords": true,
"Columns": [
{
"Name": "string",
"Description": "string",
"DataType": "string"
}
],
"Filters": [
{
"Name": "string",
"Description": "string",
"DataType": "string",
"Operator": "string",
"IsRequired": true,
"Value": "string",
"Editable": true,
"Sequence": 0,
"AvailableValues": [
{
"ListValueId": 0,
"Name": "string"
}
]
}
]
}
],
"ProcessResults": [
{
"Code": "string",
"Context": "string",
"Level": "string",
"Message": "string"
}
]
}