La fonction suivante récupère les métadonnées d’un rapport. Vous devez avoir accès au rapport. Les résultats peuvent être utilisés par la requête POST Report (publier un rapport) pour filtrer de grands ensembles de données.
Aperçu
La requête Obtenir les métadonnées du rapport permet à l’application utilisatrice d’extraire les métadonnées (champs, filtres, etc.) d’un rapport. Les paramètres obligatoires pour l’appel comprennent reportId, clientNamespace, et BearerToken, bien que l’autorisation fournie par le BearerToken puisse également être fournie au moyen de l’authentification de l’utilisateur de base.
L’adresse URL pour la requête Obtenir les métadonnées du rapport utilise l’adresse URL de base suivante :
https://www.dayforcehcm.com/api/ClientName/V1/Analytics/Reports/ReportId/Metadata
Le point d’extrémité Obtenir les métadonnées du rapport suit la norme ISO 8601 pour les normes de date et d’heure. Le format normalisé suivant sera utilisé pour les champs de date et d’heure :
yyyy-mm-ddThh:mm:ss[+|-]hh:mm (date et heure locale du serveur avec un décalage par rapport à l’heure UTC).
Les exemples suivants montrent comment le format est utilisé pour différents types de données de date et d’heure :
- Date et heure :
"Value": "2022-02-08T00:45:00-05:00" - Date :
"2022-02-08T00:00:00-05:00"(inclure l’heure avec 00 pour l’heure, les minutes et les secondes) - Temps :
"2022-02-08T14:15:30-05:00"(vous pouvez utiliser la date du jour pour appeler l’interface de programmation d’application ou une date valide)
Paramètres
N. B. : Un astérisque (*) à côté du nom d’un paramètre indique un paramètre obligatoire.
reportId* (entier)
- Identifie un rapport de façon unique.
clientNamespace* (chaîne)
- Identifie de façon unique l’instance Dayforce du client. Ceci est nécessaire pour se connecter.
BearerToken* (chaîne)
- Le jeton d’autorisation est obligatoire pour cette interface de programmation d’application. Le test de cette API dans le réseau de développeurs Dayforce (DDN) n’est pas pris en charge. Cette autorisation peut également être fournie avec une authentification de l’utilisateur de base.
Réponse
La réponse est au format JSON, comme l’illustre l’exemple ci-dessous :
{
"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"
}
]
}