importCubeData

Adaptive Planning

Documentation Workday Adaptive Planning (Workday 2025R2)
Intégration
Gérer l'intégration des données
Documentation de l'API
Modes de soumission des données

Dernière mise à jour : 2023-06-23

importCubeData

Catégorie	Soumission de données
Description	Insère ou remplace les données dans une feuille cube. Cette méthode peut également être utilisée pour supprimer les données d'une feuille cube en important des zéros dans des emplacements du cube. L'import d'un zéro dans une feuille cube va effacer les données à l'emplacement du zéro.
Autorisations requises pour appeler	Importer
Paramètres obligatoires à la demande	Identifiants, ImportDataOptions, Version, Feuille, RowData

La demande de cette méthode contient les paramètres qui seront utilisés pour déterminer quelle feuille et quelle version vont recevoir les lignes de données fournies. Cette méthode peut également être utilisée pour supprimer les données d'une feuille cube en important des zéros dans des emplacements du cube. L'import d'un zéro dans une feuille cube va effacer les données à l'emplacement du zéro.

Format de demande


<?xml version='1.0' encoding='UTF-8'?>
<call method="importCubeData" callerName="a string that identifies your client application">
<credentials login="sampleuser@company.com" password="my_pwd" instanceCode="INSTANCE1"/>
<importDataOptions planOrActuals="Plan" allowParallel="false" moveBPtr="false"/>
<version name="Budget 2014" isDefault="false" />
<sheet name="Sales Cube" isUserAssigned="false" />
<rowData>
   <header>ProductFurniture|CountryRegion|FabricationMachine|Customer|Account|Level|06/2014|07/2014|08/2014|09/2014|01/2015</header>
   <rows>
     <row>Coffee table|Argentina|Do-All 15 Vertical|Aeropostale|Price|Corporate Plan|0|0|0|0|0</row>
   </rows>
</rowData>
</call>

Chaque invocation de cet appel d'API doit contenir exactement un élément de chacun des types répertoriés :

identifiants

importDataOptions

version

feuille

rowData

De plus, lorsque le mode est spécifié Remplacer, l'élément de champ d'application doit être spécifié.

Une incohérence entre le nombre de caractères du trait vertical (|) dans l'en-tête et les données va entraîner une erreur pour l'API v30 ou supérieure.

Exemple de demande spécifiant le mode Remplacer avec le champ d'application :

<?xml version='1.0' encoding='UTF-8'?>
<call method="importCubeData" callerName="a string that identifies your client application">
 <credentials login="sampleuser@company.com" password="my_pwd" instanceCode="INSTANCE1"/>
 <version name="Budget 2022" isDefault="true" />
 <sheet name="Expense Cube" isUserAssigned="false" />
 <importDataOptions planOrActuals="Plan" allowParallel="false" moveBPtr="false" mode="REPLACE" />
 <!-- Scope parameter specifying the import scope.-->
 <scope>
 <!-- Specifies the time scope for import. All values will be specified as time codes.-->
  <time mode="EXPLICIT">
   <timeRange start="01/2021" end="10/2021" />
  </time>
  <!-- Specifies list of accounts in the scope. All values will be specified as code field.-->
  <accounts mode="EXPLICIT">
   <account includeDescendants="true">Op_Expense_Inputs</account>
   <account includeDescendants="true">Op_Expense_Drivers</account>
  </accounts>
  <!-- Specifies list of levels in the scope. All values will be specified as code field.-->
  <levels mode="INPUT"/>
 </scope>
 <rowData>
  <header>ProductFurniture|CountryRegion|FabricationMachine|Customer|Account|Level|01/2022|02/2022|03/2022|04/2022|05/2022|06/2022|07/2022|08/2022|09/2022|10/2022|11/2022|12/2022</header>
  <rows>
   <row>Coffee Table|Argentina|Do-All 15 Vertical|Aeropostale|Units|Development|44567.33|21345.77|22341.43|65567.32|298145.12|12641.83|77821.53|7766342.09|211441.21|88712.43|61940.41|662341.03|775420.25|800345.17</row>
  </rows>
 </rowData>
</call>

élément identifiants
Nom du marqueur		identifiants
Description		Tous les appels d'API doivent contenir un seull'élément identifiants pour identifier l'utilisateur qui a appelé l'API. L'appel d'API est ensuite effectué en tant qu'utilisateur ( n'importe quelle piste d'audit ou historique d'actions dans le système indique que cet utilisateur a effectué l'action) et, par conséquent, l'utilisateur doit avoir les autorisations requises pour effectuer l'action afin que l'appel d'API s'appelle réussir.
Attributs de l'élément
Nom de l'attribut	Obligatoire ?	Valeur	Exemple
se connecter	O	Le nom de connexion de l'utilisateur appelant la méthode API. Cet utilisateur doit avoir les autorisations requises pour appeler la méthode.	sampleuser@company.com
mot de passe	O	Mot de passe de l'utilisateur appelant la méthode API.	my_password
paramètres régionaux	N	Indiquez les paramètres régionaux à utiliser pour interpréter les chiffres et les dates entrants, et pour formater les chiffres et les dates sortants (en utilisant le séparateur de milliers approprié),noms de période et format de date). Les paramètres régionaux sont également utilisés pour indiquer la langue dans laquelle doivent s'afficher les messages système figurant dans la réponse. Si aucune option n'est indiquée, l'expression en_US (anglais américain) est utilisée.	fr_FR
instanceCode	N	Si l'utilisateur indiqué dans les identifiants a accès à plusieurs instances Adaptive Planning, cet attribut peut être utilisé pour indiquer qu'il a l'intention d'accéder à une instance différente de son instance par défaut. Si aucune option n'est indiquée, l'instance par défaut de l'utilisateur sera utilisée. Pour déterminer les codes d'instance disponibles, utilisez l'API exportInstances.	MYINSTANCE1
Contenu de l'élément
(aucun)

élément importDataOptions
Nom du marqueur		importDataOptions
Description		Indique les options à utiliser lors de l'import.
Attributs de l'élément
Nom de l'attribut	Obligatoire ?	Valeur	Exemple
planOrActuals	O	Définir sur l'un des "Plan" ou "Montants réels" pour indiquer le type de données importées. Si ce paramètre est en conflit avec la version indiquée dans lesMarqueur de version :La valeur du marqueur de version est prioritaire et ce paramètre est ignoré.	Le plan
moveBPtr	N	Utilisé uniquement lorsque :L'attribut planOrActuals est défini surMontants réels. SimoveBPtr est défini surtrue, l'import déplacera le pointeur de disponibilité des montants réels dans la version des montants réels pour qu'il corresponde à la dernière période trouvée dans les données importées. En cas defalse (faux), l'import n'affectera pas les périodes qui affichent des montants réels dans aucune version. Cet attribut doit être défini sur false (faux) siplanOrActuals est défini surPlan.	faux
AllowParallel	O	Utilisé uniquement lorsque :L'attribut planOrActuals est défini surMontants réels. En cas detrue (vrai), l'import se poursuivra même s'il existe déjà un autre import de montants réels ou de transactions en cours pour cette instance. En cas defalse (faux), la tentative d'import échouera si un import de montants réels ou de transactions est déjà en cours pour cette instance.	false
useMappings	N	Indique s'il faut utiliser des mappages d'import pour les comptes, les plans et les valeurs de dimension à l'intérieur des éléments de ligne. EnvisagéVrai par défaut. Sifalse (faux), alors les identifiants internes doivent être utilisés : les comptes sont identifiés par leur code, les périmètres et les valeurs de dimension par leur nom.	false
includeContext	N	Indique si les messages peuvent inclure le bloc de contexte. Les valeurs sontfalse (ne jamais afficher le contexte) ouvrai (afficher le contexte le cas échéant). Si aucune valeur n'est indiquée :true (vrai) est supposée.	false
displayNameEnabled Uniquement disponible dans API v30 et supérieure pour les instances qui activent le nom d'affichage.	N	displayNameEnabled=true indique que importCubeData doit s'attendre Account Code , Level Code , Dimension Code , et Dimension Name Column dans les données utiles lorsque l'option Activer le nom d'affichage est activée pour l'instance. displayNameEnabled=false indique que l'API importCubeData doit continuer après le contrat API pré-v30, même lorsque l'option Activer le nom d'affichage est activée pour l'instance. L'API importCubeData ignore les propriétés du nom d'affichage Account Code , Level Code , Dimension Code , et Dimension Name Column . La valeur par défaut pour displayNameEnabled est "faux".	false
mode Disponible dans API v32 et supérieure	N	Indique le mode d'import, qui est l'un des éléments Ajouter ou Remplacer. APPEND - Les faits existants sont mis à jour ou de nouveaux faits insérés. Aucun fait ne sera supprimé. Remplacer - L'appelant doit indiquer un élément de champ d'application représentant les coordonnées du cube dans lequel les données seront remplacées par celles fournies dans les données utiles. Toutes les données existantes dans le champ d'application seront remplacées par les données des données utiles de l'appel. Cette option est prise en charge par les versions API v32 et supérieure. L'appel de l'API avec les versions précédentes va générer une erreur. La valeur par défaut du mode lorsqu'elle n'est pas spécifiée est APPEND.	REPLACE
Contenu de l'élément
(aucun)

élément de version
Nom du marqueur		version
Description		Indique quelle version doit être utilisée pour recevoir les données demandées. Une version doit être indiquée pour chaque appel.
Attributs de l'élément
Nom de l'attribut	Obligatoire ?	Valeur	Exemple
nom	N	Nom de la version à utiliser pour recevoir les données. Une seule version peut être accessible dans un même appel d'API. Si aucun nom n'est indiqué, leL'indicateur isDefault doit être défini survrai sur cet élément.	Budget 2012
isDefault	N	Si l'appelant souhaite accéder à la version par défaut actuelle de l'instance, quel que soit son nom, cet attribut peut être défini sur true (vrai), auquel cas l'attribut de nom du marqueur (s'il est présent) est ignoré. Sinon, si cette valeur est "faux" ou si cet attribut n'est pas présent, une version avec le nom fourni doit exister et être accessible à l'utilisateur pour que cet appel fonctionne.	false
Contenu de l'élément
(aucun)

élément de feuille
Nom du marqueur		feuille
Description		Indique quelle feuille doit recevoir les données importées. Chaque appel d'API ne peut cibler que les données d'une seule feuille.
Attributs de l'élément
Nom de l'attribut	Obligatoire ?	Valeur	Exemple
nom	O	Le nom de la feuille vers laquelle les données seront importées.	Personnel
isUserAssigned	N	Indique qu'il s'agit d'une feuille affectée à un utilisateur. Si aucune valeur n'est indiquée, la valeur par défaut est false (faux), ce qui indique qu'il s'agit d'une feuille affectée à un périmètre.	false
Contenu de l'élément
(aucun)

élément du périmètre
Nom du marqueur		Champ d'application
Description		Indique le périmètre de cet import. Uniquement applicable lorsque le mode d'import est défini sur Remplacer. Disponible dans API v32 et supérieure
Attributs de l'élément
Nom de l'attribut	Obligatoire ?	Valeur	Exemple
mode	O	Indique s'il faut effacer ou non les notes de cellule dans le champ d'application. Doit être l'une des trois valeurs énumérées suivantes : AUCUNE - Ne pas effacer les notes de cellule. TOUT : permet d'effacer toutes les notes de cellule du périmètre. MODIFICATION_UNIQUEMENT : effacez les notes de cellule pour les cellules du champ d'application qui sont modifiées par l'import. Cela concerne les cellules précédemment vides dans lesquelles des faits ont été importés, ainsi que les cellules dont les faits ont été effacés. Si la valeur eraseCellNotes n'est pas spécifiée, la valeur par défaut est NOne.	AUCUNE
Contenu de l'élément
Un élément temps, un élément comptes et un élément périmètres, tous ces éléments sont obligatoires.

élément de temps
Nom du marqueur		Temps
Description		Indique une ou plusieurs plages de temps qui représentent le périmètre de temps de l'import. Disponible dans API v32 et supérieure
Attributs de l'élément
Nom de l'attribut	Obligatoire ?	Valeur	Exemple
mode	O	Indique le mode pour la période. Doit être l'une des trois options suivantes : Saisie d'élément de paie - lorsque ce mode est spécifié, la période sera déterminée par les codes horaires de l'élément <en-tête>. Si l'en-tête contient deux mois, alors le périmètre de l'import sera celui-ci. Expérience : si ce mode est spécifié, un ou plusieurs sous-éléments timeRange s'afficheront, qui détermineront l'intervalle de temps de l'import. VERSION : lorsque ce mode est spécifié, la période sera le début et la fin de la version, y compris toute période de solde initial. Si le mode est spécifié et qu'il est Saisie d'élément de paie ou VERSION, aucun élément timeRange ne doit être inclus. Si elle est présente, cette condition sera traitée comme une condition d'erreur. Si vous indiquez VERSION, la date de début de la Version est prise en compte, même si celle du plan est postérieure à celle-ci.	INPUT
Contenu de l'élément
Un ou plusieurs éléments timeRange sauf si le mode est INPUT ou VERSION.

élément timeRange
Nom du marqueur		TimeRange
Description		Indique une seule plage de temps pour la période. Disponible dans API v32 et supérieure
Attributs de l'élément
Nom de l'attribut	Obligatoire ?	Valeur	Exemple
début	O	Période de début de la plage de temps de l'import.	07/2021
fin	O	comme la période de fin de la plage de temps de l'importation.	08/2021
Contenu de l'élément
(aucun)

élément Comptes
Nom du marqueur		comptes
Description		Indique les codes de compte pour le périmètre d'import. Si un code de compte existe ici, mais qu'il n'existe aucune donnée pour ce compte dans les données d'import, les données de ce compte seront supprimées pour la plage de temps et le reste des coordonnées du périmètre. Disponible dans API v32 et supérieure
Attributs de l'élément
Nom de l'attribut	Obligatoire ?	Valeur	Exemple
mode	O	Indique le mode pour le périmètre du compte. Doit être l'une des trois options suivantes : Expérience : si ce mode est spécifié, un ou plusieurs sous-éléments de compte détermineront le périmètre du compte pour l'import. Saisie d'élément de paie - lorsque ce mode est spécifié, le périmètre du compte sera déterminé par l'ensemble unique de comptes figurant dans les données d'import. TOUS : lorsque ce mode est spécifié, le périmètre du compte sera tous les comptes pour l'import. Pour l'import d'une feuille cube, cela représentera tous les comptes importables pour cette feuille cube. Si le mode est spécifié et qu'il est Saisie d'élément de paie ou Tout, aucun sous-élément de compte ne doit être inclus. Si elle est présente, cette condition sera traitée comme une condition d'erreur.	EXPLICIT
Contenu de l'élément
Un ou plusieurs éléments de compte sauf si le mode est Saisie d'élément de paie ou Tout.

élément de compte
Nom du marqueur		account
Description		Indique le code du compte à inclure dans le périmètre d'import. Disponible dans API v32 et supérieure
Attributs de l'élément
Nom de l'attribut	Obligatoire ?	Valeur	Exemple
includeDescendants	N	Si le compte est un compte feuille, l'option Inclure les descendants n'a aucun effet. Si le compte est un compte parent, le fait d'affecter cet attribut à true (vrai) va inclure tous les descendants feuilles de ce compte dans le périmètre. Si le compte est un compte parent et que includeDescendants a la valeur Faux, cet élément de compte sera traité comme s'il n' avait pas été indiqué. La raison de ce traitement des comptes parents est qu'un compte feuille peut parfois être promu en tant que compte parent et que les spécifications de l'import peuvent ne pas être mises à jour à temps pour refléter ce changement. Le fait d'ignorer un compte parent avec includeDescendants=false empêche une suppression involontaire de données. Il s'agit d'un attribut facultatif dont la valeur par défaut sera considérée comme fausse.	vrai
Contenu de l'élément
Indique le code du compte utilisé dans le périmètre d'import. Par exemple, Operational_Expense.

élément périmètres
Nom du marqueur		périmètre(s)
Description		Indique les codes de périmètre pour le périmètre d'import. Si un code de périmètre est indiqué ici mais qu'il n'existe aucune donnée pour ce périmètre dans les données d'import, les données de ce périmètre seront supprimées pour la plage de temps et le reste des coordonnées du périmètre. Disponible dans API v32 et supérieure
Attributs de l'élément
Nom de l'attribut	Obligatoire ?	Valeur	Exemple
mode	O	Indique le mode pour le périmètre. Doit être l'une des trois options suivantes : Expérience : si ce mode est spécifié, un ou plusieurs sous-éléments de périmètre seront attendus pour déterminer le périmètre de l'import. Saisie d'élément de paie : lorsque ce mode est spécifié, la charge du périmètre sera déterminée par l'ensemble unique de périmètres figurant dans les données d'import. TOUS : lorsque ce mode est spécifié, le champ d'application du périmètre sera tous les périmètres importables. Si le mode est spécifié et qu'il est Saisie d'élément de paie ou Tout, alors aucun sous-élément de périmètre ne doit être inclus. Si elle est présente, cette condition sera traitée comme une condition d'erreur.	INPUT
Contenu de l'élément
Un ou plusieurs éléments de périmètre sauf si le mode est spécifié Saisie d'élément de paie ou Tout.

élément de périmètre
Nom du marqueur		level
Description		Indique le code du périmètre à inclure dans le périmètre d'import. Disponible dans API v32 et supérieure
Attributs de l'élément
Nom de l'attribut	Obligatoire ?	Valeur	Exemple
includeDescendants	N	Si le périmètre est un périmètre parent, le fait d'affecter cet attribut à true (vrai) va inclure tous les descendants feuilles de ce périmètre, y compris lui-même (nœud uniquement) dans le périmètre. Il s'agit d'un attribut facultatif. Si l'attribut n'est pas fourni, la valeur par défaut sera false (faux). Si l'attribut n'est pas fourni ou fournit la valeur false (faux) et que le périmètre spécifié est un périmètre parent, cela signifie que l'import ne prendra en compte que le nœud (par exemple, Ingénierie uniquement) de ce périmètre pour déterminer le périmètre. Les enfants du périmètre ne seront pas considérés dans le périmètre, sauf si vous les spécifiez explicitement avec d'autres éléments de périmètre.	vrai
Contenu de l'élément
Indique le code du périmètre dans le cadre du périmètre d'import. Par exemple, Développement.

Élément rowData
Nom du marqueur		rowData
Description		Conteneur pour les lignes de données en cours d'import.
Attributs de l'élément
(aucun)
Contenu de l'élément
Totalement unélément d'en-tête et exactement unélément rows.

élément d'en-tête
Nom du marqueur		header
Description		Indique les noms et l'ordre des colonnes de données dans les colonnes correspondantes.élément rows.
Attributs de l'élément
(aucun)
Contenu de l'élément
Une ligne de texte avec des noms de colonne séparés par des barres verticales. Ces noms de colonne doivent correspondre aux noms des dimensions ou des champs de la feuille, ou aux codes de période qui peuvent contenir des données. Ils sont identiques aux noms de colonne qui se trouvent dans le modèle d'import de la feuille vers laquelle les données sont importées, chaque en-tête de colonne est alors séparés du suivant par un symbole de barre verticale ou de trait vertical. Pour les instances qui activent le Nom d'affichage, l'en-tête ne prend pas en charge "<dimension>" en combinaison avec "<dimension> Name" ou "<dimension> Code" dans API v30 ou supérieure pour les paramètres régionaux pris en charge par Adaptive Planning.

élément de lignes
Nom du marqueur		lignes
Description		Conteneur pour un ou plusieursdes éléments de ligne.
Attributs de l'élément
(aucun)
Contenu de l'élément
Un ou plusieursdes éléments de ligne.

élément de ligne
Nom du marqueur		ligne
Description		Données d'une ligne unique en cours d'import.
Attributs de l'élément
(aucun)
Contenu de l'élément
Les données des champs d'une seule ligne en cours d'importation, valeur de chaque champ séparée par un symbole de barre verticale ou de trait vertical. Les champs de données doivent être dans le même ordre que la ligne dans l'élément d'en-tête. Si les chiffres dans les valeurs utilisent des séparateurs de milliers, ils sont supposés être les séparateurs de virgules utilisés dans les paramètres régionaux indiqués dans les identifiants de la demande.

Format de la réponse

Voici des exemples de réponses pour une importation réussie ou non de données cubes.

Exemple de réussite


<?xml version='1.0' encoding='UTF-8'?>
<response success="true">
<messages>
  <message key="warning-no-data-imported-dimension-unmapped">Warning: Row 3 was not imported because Coffeee table is unmapped.</message>
</messages>
</response>

Échec (avec contexte)


<?xml version='1.0' encoding='UTF-8'?>
<response success="false">
   <messages>
       <message key="err-incomplete-cube-row">
           <context>
               <col header="ProductFurniture" value="Coffee table" />
               <col header="CountryRegion" value="" />
               <col header="Account" value="Do-All 15 Vertical" />
               <col header="Level" value="Aeropostale" />
               <col header="06/2014" value="Price" />
               <col header="07/2014" value="Corporate Plan" />
               <col header="08/2014" value="0.0" />
               <col header="09/2014" value="0.0" />
               <col header="01/2015" value="0.0" />
     
           </context>
     Row 1 is missing a value.
   
       </message>
       <message key="err-no-rows">You must import at least one row of data.</message>
     </messages>
</response>

Échec (sans contexte)


<?xml version='1.0' encoding='UTF-8'?>
<response success="false">
   <messages>
       <message key="err-incomplete-cube-row">Row 1 is missing a value.</message>
       <message key="err-no-rows">You must import at least one row of data.</message>

   </messages>
</response>

élément de réponse
Nom du marqueur		réponse
Attributs de l'élément
Nom de l'attribut	Obligatoire ?	Valeur	Exemple
réussite	O	Matriciel ou subordonnévrai oufalse (faux), indiquant si l'appel d'API a réussi ou non. Même les appels traités avec succès peuvent contenir des messages d'avertissement dans leur réponse.	vrai
Contenu de l'élément
Un seul facultatifL'élément Messages.

élément de messages
Nom du marqueur		messages
Description		Conteneur pour un ou plusieursÉléments de message.
Attributs de l'élément
(aucun)
Contenu de l'élément
Un ou plusieursÉléments de message.

élément de message
Nom du marqueur		message
Description		Représente un message que le système renvoie à l'appelant. Les messages sont utilisés pour les messages d'erreur lorsque les demandes n'ont pas abouti, pour les messages d'avertissement lorsque les demandes ont abouti et pour les messages de confirmation lorsque les demandes ont abouti.
Attributs de l'élément
Nom de l'attribut	Obligatoire ?	Valeur	Exemple
clé	N	Lorsqu'elle est fournie, une clé permet d'identifier un message ou un type de message particulier, utile pour l'enregistrement et la récupération automatisés des erreurs dans les programmes clients. Les clés ne changent pas selon les paramètres régionaux des demandes, même lorsque la langue du message change. Il est également peu probable que les clés changent à l'avenir en raison d'ajustements du libellé ou de la terminologie.	invalid-attributevalueid
Contenu de l'élément
Texte du message. Ce texte est exprimé dans la langue des paramètres régionaux indiqués dans la demande (en supposant que les paramètres régionaux soient pris en charge). Le texte peut également contenir des informations variables telles que le nombre de lignes qui ont été traitées ou la colonne ou la valeur particulière à l'origine de l'erreur. Un élément de contexte facultatif.

élément de contexte
Nom du marqueur		context
Description		Conteneur pour un ou plusieurs éléments de col.
Attributs de l'élément
Nom de l'attribut	Obligatoire ?	Valeur	Exemple
aucun(e)
Contenu de l'élément
Un ou plusieurs éléments de col.

élément col
Nom du marqueur		col
Description		Représente le contexte du message. Fournit une paire en-tête/valeur afin que la ligne générant le message puisse être identifiée.
Attributs de l'élément
Nom de l'attribut	Obligatoire ?	Valeur	Exemple
header	O	L'en-tête de la colonne.	"Compte"
valeur	O	Valeur de la colonne.	"GL-29482-38233"
Contenu de l'élément
(aucun)

importConfigurableModelData

importStandardData

Cela vous a-t-il été utile?

Souhaitez-vous nous signaler quelque chose ? Exact Répond à ma question Facile à trouver Facile à comprendre Utile pour ma tâche Complet et détaillé

Souhaitez-vous nous signaler quelque chose ? Inexact Ne répond pas à ma question Pas facile à trouver Pas facile à comprendre Inutile pour ma tâche Incomplet ou pas assez détaillé

Décrivez-nous votre tâche en cours. Quelles informations supplémentaires pourraient améliorer ce contenu ? Voulez-vous partager des informations supplémentaires ?

Nom complet

E-mail

Workday utilisera votre nom et votre adresse électronique pour répondre à vos commentaires. Vos données seront traitées conformément à notre Déclaration de confidentialité.

Merci pour votre feedback