Passer au contenu principal
Documentation
Documentation
Adaptive Planning
Dernière mise à jour : 2023-06-23
Temps

Temps

Point de terminaison de l'adresse URL

HTTPS://api.adaptiveinsights.com/api/rest/modeling/{version}/{tenant}/updateTime
Version : v1
Catégorie
Modification de métadonnées
Description
Mettre à jour la structure temporelle dans la planification
Autorisations obligatoires pour être appelées
Configurer le calendrier
Paramètres requis pour la demande
S.O.

Expressions HTTP prises en charge

Configurer HTTP
Description
POST
En fonction du paramètre d’opération, rechargez/mettez à jour/ajoutez la structure temporelle dans la planification. Si le paramètre d’opération n’est pas indiqué, utilisez l’opération d’ajout par défaut.

POST

Demande
/updateTime : met à jour la structure temporelle
Met à jour la structure temporelle dans la planification en fonction de l’opération (recharger/mettre à jour/ajouter) spécifiée comme paramètre d’interrogation (ajouter par défaut si l’opération n’est pas précisée) :
  • Recharger : rechargez l’ensemble de la structure temporelle. Toutes les données existantes seront effacées. Nous permettons aussi de définir la strate par défaut au moyen de rechargements.
  • Mettre à jour : mettez à jour la structure de temps existante (par exemple, changez les étiquettes pour les strates de temps existantes, ajoutez de nouvelles strates, etc.). Nous permettons également de définir la strate par défaut au moyen de mises à jour.
  • Ajouter : ajoutez de nouvelles périodes temporelles à la structure temporelle. Vous ne pouvez pas modifier des périodes temporelles, ajouter un nouveau niveau de granularité pour des périodes temporelles ou supprimer des périodes temporelles lorsque vous les ajoutez.
URI de la demande exemple :
HTTPS://api.adaptiveinsights.com/api/rest/modeling/v1/TIMEREALM/updateTime?operation
En-tête de demande d'exemple
Autorisation : De base ou par jeton.
Type de contenu : application/json
Corps de la demande
Corps de la demande d'exemple 
{
   "calendars": [
       {
           "name": "DefaultHierarchy",
           "strata": [
               {
                   "code": "month",
                   "label": "Month",
                   "shortName": "Mon"
               },
               {
                   "code": "qtr",
                   "label": "Quarter",
                   "shortName": "Qtr"
               },
               {
                   "code": "year",
                   "label": "Year",
                   "shortName": "Yr"
               }
           ]
       },
       {
           "name": "AltHierarchy",
           "strata": [
               {
                   "code": "month"
               },
               {
                   "code": "altQtr",
                   "label": "AltQuarter",
                   "shortName": "AltQtr"
               },
               {
                   "code": "altYear",
                   "label": "AltYear",
                   "shortName": "AltYr"
               }
           ]
       }
   ],
   "periods": [
       {
           "startDate": "2022-01-01",
           "endDate": "2023-01-01",
           "code": "2022",
           "label": "FY2022",
           "shortName": "2022",
           "stratum": "year"
       },
       {
           "startDate": "2022-01-01",
           "endDate": "2022-04-01",
           "code": "Q1-2022",
           "label": "Q1-FY2022",
           "shortName": "Q1",
           "stratum": "qtr"
       },
       {
           "startDate": "2022-01-01",
           "endDate": "2022-02-01",
           "code": "01/2022",
           "label": "Jan-2022",
           "shortName": "Jan",
           "stratum": "month"
       },
       {
           "startDate": "2022-02-01",
           "endDate": "2022-03-01",
           "code": "02/2022",
           "label": "Feb-2022",
           "shortName": "Feb",
           "stratum": "month"
       },
       {
           "startDate": "2022-03-01",
           "endDate": "2022-04-01",
           "code": "03/2022",
           "label": "Mar-2022",
           "shortName": "Mar",
           "stratum": "month"
       },
       {
           "startDate": "2022-04-01",
           "endDate": "2022-07-01",
           "code": "Q2-2022",
           "label": "Q2-FY2022",
           "shortName": "Q2",
           "stratum": "qtr"
       },
       {
           "startDate": "2022-04-01",
           "endDate": "2022-05-01",
           "code": "04/2022",
           "label": "April-2022",
           "shortName": "April",
           "stratum": "month"
       },
       {
           "startDate": "2022-05-01",
           "endDate": "2022-06-01",
           "code": "05/2022",
           "label": "May-2022",
           "shortName": "May",
           "stratum": "month"
       },
       {
           "startDate": "2022-06-01",
           "endDate": "2022-07-01",
           "code": "06/2022",
           "label": "June-2022",
           "shortName": "June",
           "stratum": "month"
       },
       {
           "startDate": "2022-07-01",
           "endDate": "2022-10-01",
           "code": "Q3-2022",
           "label": "Q3-FY2022",
           "shortName": "Q3",
           "stratum": "qtr"
       },
       {
           "startDate": "2022-07-01",
           "endDate": "2022-08-01",
           "code": "07/2022",
           "label": "July-2022",
           "shortName": "July",
           "stratum": "month"
       },
       {
           "startDate": "2022-08-01",
           "endDate": "2022-09-01",
           "code": "08/2022",
           "label": "Aug-2022",
           "shortName": "Aug",
           "stratum": "month"
       },
       {
           "startDate": "2022-09-01",
           "endDate": "2022-10-01",
           "code": "09/2022",
           "label": "Sept-2022",
           "shortName": "Sept",
           "stratum": "month"
       },
       {
           "startDate": "2022-10-01",
           "endDate": "2023-01-01",
           "code": "Q4-2022",
           "label": "Q4-FY2022",
           "shortName": "Q4",
           "stratum": "qtr"
       },
       {
           "startDate": "2022-10-01",
           "endDate": "2022-11-01",
           "code": "10/2022",
           "label": "Oct-2022",
           "shortName": "Oct",
           "stratum": "month"
       },
       {
           "startDate": "2022-11-01",
           "endDate": "2022-12-01",
           "code": "11/2022",
           "label": "Nov-2022",
           "shortName": "Nov",
           "stratum": "month"
       },
       {
           "startDate": "2022-12-01",
           "endDate": "2023-01-01",
           "code": "12/2022",
           "label": "Dec-2022",
           "shortName": "Dec",
           "stratum": "month"
       },
       {
           "startDate": "2023-01-01",
           "endDate": "2024-01-01",
           "code": "2023",
           "label": "FY2023",
           "shortName": "2023",
           "stratum": "year"
       },
       {
           "startDate": "2023-01-01",
           "endDate": "2023-04-01",
           "code": "Q1-2023",
           "label": "Q1-FY2023",
           "shortName": "Q1",
           "stratum": "qtr"
       },
       {
           "startDate": "2023-01-01",
           "endDate": "2023-02-01",
           "code": "01/2023",
           "label": "Jan-2023",
           "shortName": "Jan",
           "stratum": "month"
       },
       {
           "startDate": "2023-02-01",
           "endDate": "2023-03-01",
           "code": "02/2023",
           "label": "Feb-2023",
           "shortName": "Feb",
           "stratum": "month"
       },
       {
           "startDate": "2023-03-01",
           "endDate": "2023-04-01",
           "code": "03/2023",
           "label": "Mar-2023",
           "shortName": "Mar",
           "stratum": "month"
       },
       {
           "startDate": "2023-04-01",
           "endDate": "2023-07-01",
           "code": "Q2-2023",
           "label": "Q2-FY2023",
           "shortName": "Q2",
           "stratum": "qtr"
       },
       {
           "startDate": "2023-04-01",
           "endDate": "2023-05-01",
           "code": "04/2023",
           "label": "April-2023",
           "shortName": "April",
           "stratum": "month"
       },
       {
           "startDate": "2023-05-01",
           "endDate": "2023-06-01",
           "code": "05/2023",
           "label": "May-2023",
           "shortName": "May",
           "stratum": "month"
       },
       {
           "startDate": "2023-06-01",
           "endDate": "2023-07-01",
           "code": "06/2023",
           "label": "June-2023",
           "shortName": "June",
           "stratum": "month"
       },
       {
           "startDate": "2023-07-01",
           "endDate": "2023-10-01",
           "code": "Q3-2023",
           "label": "Q3-FY2023",
           "shortName": "Q3",
           "stratum": "qtr"
       },
       {
           "startDate": "2023-07-01",
           "endDate": "2023-08-01",
           "code": "07/2023",
           "label": "July-2023",
           "shortName": "July",
           "stratum": "month"
       },
       {
           "startDate": "2023-08-01",
           "endDate": "2023-09-01",
           "code": "08/2023",
           "label": "Aug-2023",
           "shortName": "Aug",
           "stratum": "month"
       },
       {
           "startDate": "2023-09-01",
           "endDate": "2023-10-01",
           "code": "09/2023",
           "label": "Sept-2023",
           "shortName": "Sept",
           "stratum": "month"
       },
       {
           "startDate": "2023-10-01",
           "endDate": "2024-01-01",
           "code": "Q4-2023",
           "label": "Q4-FY2023",
           "shortName": "Q4",
           "stratum": "qtr"
       },
       {
           "startDate": "2023-10-01",
           "endDate": "2023-11-01",
           "code": "10/2023",
           "label": "Oct-2023",
           "shortName": "Oct",
           "stratum": "month"
       },
       {
           "startDate": "2023-11-01",
           "endDate": "2023-12-01",
           "code": "11/2023",
           "label": "Nov-2023",
           "shortName": "Nov",
           "stratum": "month"
       },
       {
           "startDate": "2023-12-01",
           "endDate": "2024-01-01",
           "code": "12/2023",
           "label": "Dec-2023",
           "shortName": "Dec",
           "stratum": "month"
       },
       {
           "startDate": "2022-01-01",
           "endDate": "2023-01-01",
           "code": "alt2022",
           "label": "Alt FY2022",
           "shortName": "Alt2022",
           "stratum": "altYear"    
       },
       {
           "startDate": "2022-01-01",
           "endDate": "2022-05-01",
           "code": "altQ1-2022",
           "label": "Alt Q1-FY2022",
           "shortName": "AltQ1",
           "stratum": "altQtr"
       },
       {
           "startDate": "2022-05-01",
           "endDate": "2022-07-01",
           "code": "altQ2-2022",
           "label": "Alt Q2-FY2022",
           "shortName": "AltQ2",
           "stratum": "altQtr"
       },
       {
           "startDate": "2022-07-01",
           "endDate": "2022-09-01",
           "code": "altQ3-2022",
           "label": "Alt Q3-FY2022",
           "shortName": "AltQ3",
           "stratum": "altQtr"
       },
       {
           "startDate": "2022-09-01",
           "endDate": "2023-01-01",
           "code": "altQ4-2022",
           "label": "Alt Q4-FY2022",
           "shortName": "AltQ4",
           "stratum": "altQtr"
       },
       {
           "startDate": "2023-01-01",
           "endDate": "2024-01-01",
           "code": "alt2023",
           "label": "Alt FY2023",
           "shortName": "Alt2023",
           "stratum": "altYear"    
       },
       {
           "startDate": "2023-01-01",
           "endDate": "2023-05-01",
           "code": "altQ1-2023",
           "label": "Alt Q1-FY2023",
           "shortName": "AltQ1",
           "stratum": "altQtr"
       },
       {
           "startDate": "2023-05-01",
           "endDate": "2023-07-01",
           "code": "altQ2-2023",
           "label": "Alt Q2-FY2023",
           "shortName": "AltQ2",
           "stratum": "altQtr"
       },
       {
           "startDate": "2023-07-01",
           "endDate": "2023-09-01",
           "code": "altQ3-2023",
           "label": "Alt Q3-FY2023",
           "shortName": "AltQ3",
           "stratum": "altQtr"
       },
       {
           "startDate": "2023-09-01",
           "endDate": "2024-01-01",
           "code": "altQ4-2023",
           "label": "Alt Q4-FY2023",
           "shortName": "AltQ4",
           "stratum": "altQtr"
       }
   ]
}
Paramètres d'interrogation
Nom
Description
Obligatoire
opération
L'opération d'importation de la structure temporelle à effectuer. Elle doit être recharger, mettre à jour ou ajouter. Si aucune opération n’est précisée, Workday effectuera une addition par défaut.
N
poursuivreAvertirs
Paramètre d’interrogation facultatif utilisé pour faire disparaître des messages d’avertissement. Si cette valeur n’est pas définie à Vrai, des avertissements potentiels seront renvoyés avant l’exécution de l’appel. Ignorer en spécifiant ce paramètre à Vrai dans l’URL.
N
skipAwaitCacheRefresh
Un paramètre d’interrogation facultatif. Si la valeur est vraie, la réponse sera retournée dès qu’elle sera prête, sans attendre l’actualisation du cache.
N
Paramètres des données utiles
Objet de la structure temporelle
Nom
Description
Obligatoire
calendriers
Liste de tous les objets de calendrier à importer. Le calendrier par défaut doit être affiché en premier. Pour la mise à jour et l’ajout, les utilisateurs doivent inclure tous les calendriers existants.
N
périodes
Liste de tous les objets de période temporelle dans les calendriers. Les périodes doivent être répertoriées par ordre de profondeur pour chaque calendrier. Les périodes temporelles du calendrier par défaut doivent être affichées en premier. Pour les autres calendriers, il est facultatif de réénumérer les périodes temporelles à la strate branche ou en dessous.
N
Objet de calendrier
Nom
Description
Obligatoire
nom
Nom du calendrier.
Y
strata
La liste des objets de strate dans le calendrier doit être triée par ordre croissant, le niveau le plus bas étant la strate la plus précise. Pour les calendriers secondaires, il est facultatif de réinscrire les strates sous la strate branche.
Y
code
Code du calendrier. Pris en charge lorsque des codes de calendrier sont présents.
N
Objet de strate
Nom
Description
Obligatoire
code
Le code de la strate de temps doit être unique.
Y
label
Le libellé de la strate de temps doit être unique. N'est pas obligatoire pour les strates partagées réénumérées dans un autre calendrier.
Y
shortName
Le nom abrégé de la strate de temps doit être unique. N'est pas obligatoire pour les strates partagées réinscrites à d'autres calendriers.
N
isDefaultStratum
Si la strate de temps est la strate par défaut. Seuls les opérations de rechargement ou de mise à jour autorisent le paramètre de strate par défaut. Si isDefaultStratum n’est indiqué pour aucune strate, nous supposerons que la strate feuille est la strate par défaut pour l’opération de rechargement et que la strate par défaut existante reste inchangée pour l’opération mise à jour.
N
Objet de la période
Nom
Description
Obligatoire
startDate
La date de début de la période doit être au format yyyy-MM-dd.
Y
endDate
La date de fin de la période doit être au format yyyy-MM-dd.
Y
code
Le code de la période doit être unique.
Y
label
Libellé de la période.
Y
shortName
Nom abrégé de la période.
N
stratum
Le code de la strate à laquelle appartient cette période.
Y
instanceCode
InstanceCode à partir de laquelle extraire des valeurs. Par exemple, GLOBO. Si aucun instanceCode n’est indiquée, l’instance par défaut de l’utilisateur est utilisée.
N

Réponse

204 Aucun contenu
La réponse réussie est vide avec le code de statut 204.
Demande de type 400 Mauvais
La demande n'a pas pu être comprise par le serveur.
Exemple : 
{
   "message": "Include only one of these valid operation parameters in the request: reload, update, or append.",
   "status": 400
}
{
   "error": "Errors occurred while processing the request.",
   "errors": [
       {
           "error": "Stratum code is required. Specify a code.",
           "field": "calendars[0].strata[2].code",
           "code": "PLN310002"
       }
   ]
}
{
   "error": "Errors occurred while processing the request",
   "errors": [
       {
           "error": "Last descendant period (12/2022) end date (2023-01-02) doesn't match the ancestor period (Q4-2022) end date (2023-01-01).",
           "field": "periods[16]",
           "code": "PLN310002"
       },
       {
           "error": "Last descendant period (12/2022) end date (2023-01-02) doesn't match the ancestor period (2022) end date (2023-01-01).",
           "field": "periods[16]",
           "code": "PLN310002"
       }
   ]
}
401 non autorisé
L’utilisateur n’est pas autorisé.
Exemple : 
{
   "message": "Invalid credential",
   "status": 401
}
401 interdit
L'utilisateur dispose d'autorisations insuffisantes.
Exemple : 
{
   "message": "This resource is only available when the JSON based time API feature and the alternate time roll-up feature are enabled.",
   "status": 403
}
Erreur de serveur interne 500
Erreur de serveur interne.