El punto de conexión POST Report se utiliza para iniciar la creación de un conjunto de datos para el reporte especificado en esta llamada. Los conjuntos de datos pueden devolver columnas agrupadas, así como totales de columnas y resúmenes para cualquier reporte V1 o V2.
Resumen
La URL para la solicitud POST Report utiliza la siguiente URL base:
https://www.dayforcehcm.com/api/CompanyName/V1/Reports/{reportId}
El punto de conexión POST Report 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 (fecha y hora 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
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 a través de la red de programadores (DDN) de Dayforce. Esta autorización también podría proporcionarse con la autenticación básica de usuario.
Cuerpo de la solicitud
El cuerpo de la solicitud debe usarse para incluir filtros y parámetros relacionados con un reporte específico. Todos los filtros y parámetros obligatorios deben agregarse sin valores predeterminados. Entre los campos obligatorios se incluyen Name, Value y Sequence para cada filtro, además de Name y Value para cada parámetro. Todos los nombres de parámetros deben comenzar con el símbolo "@". Puede cambiar el valor predeterminado de los filtros etiquetados como Editable.
Nota: ListValueID debe usarse para filtros y parámetros sin valor predeterminado. El valor correspondiente de ListValueID de cada reporte se puede encontrar en la sección Obtener metadatos de reporte mediante una llamada en el Explorador de servicios web.
{
"Filters": [
{
"Name": "Recent Hire Date",
"Value": "@EffectiveEnd",
"Sequence": 1
},
{
"Name": "Recent Hire Date",
"Value": "@EffectiveStart",
"Sequence": 2
},
{
"Name": "Location",
"Sequence": 4,
"ListValueId": 1000
},
{
"Name": "@Effective",
"Description": "@Effective",
"DataType": "Date",
"Operator": "between",
"IsRequired": true,
"Value": "2023-01-13T00:00:00-05:00",
"Editable": true
}
}
}
Respuesta
La respuesta está en formato JSON, como se ilustra en el siguiente ejemplo:
{
"Data": {
"DatasetId": "46ca93ab-b43c-42f9-bded-c91621ad2c6f",
"Status": "Requested"
}
]
}