La fonction suivante récupère le contenu de l’ensemble de données d’un rapport. Vous pouvez uniquement accéder aux ensembles de données que vous avez créés.
Aperçu
La requête Obtenir l’ensemble de données permet à l’application utilisatrice d’extraire le contenu de l’ensemble de données d’un rapport. Les paramètres obligatoires pour l’appel comprennent DatasetId, 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 l’ensemble de données utilise l’adresse URL de base suivante :
https://www.dayforcehcm.com/api/ClientName/V1/Analytics/Datasets/datasetId
N. B. : Les ensembles de données expirent s’ils n’ont pas été consultés à l’aide du point d’extrémité Obtenir l’ensemble de données au cours des 63 derniers jours. Si une requête pour obtenir un ensemble de données expiré est envoyée, une réponse « 204 Aucun contenu » sera renvoyée, car l’ensemble de données demandé a expiré.
Paramètres
N. B. : Un astérisque (*) à côté du nom d’un paramètre indique un paramètre obligatoire.
datasetId* (chaîne)
- Identifie de façon unique un ensemble de données.
page (chaîne)
- Identifie le nombre de pages.
DatasetPageSize (chaîne)
-
Identifie la valeur maximale de la taille de la page de l’ensemble de données en mégaoctets. Ce paramètre remplace la valeur existante dans le champ Taille maximale de la page du Connecteur de données d’analyses (valeur maximale acceptée : 2 000 Mo) dans Admin. système > Propriétés du client.
N. B. : Si la valeur que vous saisissez excède la valeur maximale autorisée de 2 000 Mo, elle sera automatiquement réinitialisée à 2 000 Mo. Si elle tombe sous le minimum de 32 Mo, elle sera réinitialisée à 32 Mo.
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": " 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
}
N. B. : "Data", "Page" et "TotalPages" ne s’affichent que si la fonction de pagination est activée.