Cette fonction récupère les renseignements sur un ensemble de données. Vous ne pouvez accéder qu’aux ensembles de données que vous avez créés.
Aperçu
La requête Obtenir les métadonnées de l’ensemble de données permet à l’application utilisatrice de récupérer les métadonnées (statut et rangée) liées à l’ensemble de données du 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 les métadonnées de l’ensemble de données utilise l’adresse URL de base suivante :
https://www.dayforcehcm.com/api/ClientName/V1/Analytics/Datasets/datasetId/Metadata
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 Obtenir les métadonnées de l’ensemble de données est envoyée pour un ensemble de données expiré, la réponse affichera le statut « 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.
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": {
"DatasetId": "string",
"Status": "string",
"RowCount": "string"
"ReportId": 0,
"Refresh Status": "string"
"Filters": "string",
"Parameters": "string",
"TotalPages": "string",
},
N. B. : "Refresh Status" ne s’affiche pas pendant le que le statut est "Processing" ou "Requested" ni si l’ensemble de données n’a pas été actualisé. "Row Count" ne s’affiche pas pendant que le statut est "Requested", et "Filters« et "Parameters" ne s’affichent pas pendant que le statut est "Processing" ou "Requested". TotalPages ne s’affichent que si la fonction de pagination est activée.