importCubeData

Adaptive Planning

Notes de publication (Workday 2025R2)

importCubeData

Catégorie	Soumission de données
Description	Insère ou remplace des données dans une feuille cube. Cette méthode peut également être utilisée pour supprimer des données d’une feuille cube en important des zéros vers des emplacements dans le cube. Importer un zéro dans une feuille cube va effacer les données à l’emplacement du zéro.
Autorisations obligatoires pour pouvoir être appelées	Importer
Paramètres requis sur demande	Données d’identification, 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 recevront les rangées de données fournies. Cette méthode peut également être utilisée pour supprimer des données d’une feuille cube en important des zéros vers des emplacements dans le cube. Importer 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 :

données d'identification

importDataOptions

version

feuille

rowData

De plus, lorsque le mode est précisé REplace, l’élément de champ d’application doit être précisé.

Une non-correspondance entre le nombre de caractères de canal (|) dans l’en-tête et les données générera une erreur pour l’API v30 ou une version plus récente.

Exemple de demande spécifiant le mode Remplacer avec un 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 de données d'identification
Nom du marqueur		données d'identification
Description		Tous les appels d'API doivent contenir un seulun élément d’identification pour désigner l’utilisateur qui invoque l’API. L’appel d’API est alors effectué en tant que cet utilisateur (toute piste d’audit ou tout historique des actions dans le système indiquera que cet utilisateur a effectué l’action). Par conséquent, l’utilisateur doit disposer des autorisations requises pour effectuer l’action afin que l’appel d’API puisse être exécuté réussir.
Attributs de l'élément
Nom de l’attribut	Obligatoire?	Valeur	Exemple
ouvrir une session	Y	Le nom de connexion de l’utilisateur qui invoque la méthode API. Cet utilisateur doit disposer des autorisations requises pour invoquer la méthode.	sampleuser@company.com
mot de passe	Y	Le mot de passe de l’utilisateur qui invoque la méthode API.	my_password
paramètres régionaux	N	Indiquez les paramètres régionaux à utiliser pour interpréter les nombres et les dates entrants, et pour mettre en forme les nombres et les dates sortants (à l’aide du séparateur de milliers approprié,les noms des périodes temporelles et le format de date). Les paramètres régionaux sont également utilisés pour préciser la langue dans laquelle tous les messages de système de la réponse doivent être affichés. Si cette valeur n’est pas précisée, la valeur en_US (rubrique en anglais américain) est utilisée.	fr_FR
instanceCode	N	Si l’utilisateur indiqué dans les données d’identification a accès à plusieurs instances de Adaptive Planning, cet attribut peut être utilisé pour indiquer que l’utilisateur a l’intention d’accéder à une instance autre que celle par défaut. Si elle n’est pas précisée, l’instance par défaut de l’utilisateur sera utilisée. Pour déterminer les codes d’instances 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'importation.
Attributs de l'élément
Nom de l’attribut	Obligatoire?	Valeur	Exemple
planOrActuals	Y	Défini à l'une des valeurs suivantes :Plan" ou "Chiffres réels" pour préciser le type de données importées. Si ce paramètre est en conflit avec la version indiquée dans leMarqueur de version, leLa valeur du marqueur de version a la priorité et ce paramètre est ignoré.	Plan
moveBPtr	N	Utilisé uniquement lorsquel'attribut planOrActuals est défini surChiffres réels. SimoveBPtr est défini àvrai, l’importation déplacera le pointeur de disponibilité des chiffres réels dans la version des chiffres réels pour qu’il corresponde à la dernière période trouvée dans les données importées. Si la valeur estfaux, l’importation n’aura aucune incidence sur les périodes qui affichent les chiffres réels dans les versions. Cet attribut doit être défini à Faux siplanOrActuals est défini àPlan.	faux
AllowParallel	Y	Utilisé uniquement lorsquel'attribut planOrActuals est défini surChiffres réels. Si la valeur estVrai, alors l’importation se poursuivra même s’il existe déjà une autre importation de chiffres réels ou de transactions en cours pour cette instance. Si la valeur estfaux, alors une tentative d’importation échouera si une importation de chiffres réels ou de transactions est déjà traitée pour cette instance.	faux
UseMappings	N	Indique si vous souhaitez utiliser des mappages d’importation pour les comptes, les plans et les valeurs de dimension dans les éléments de rangée. ÉtudiéVrai par défaut. Sifaux, alors les identifiants internes doivent être utilisés : les comptes sont repérés par un code, les niveaux et les valeurs de dimension par nom.	faux
includeContext	N	Indique si les messages peuvent inclure le bloc de contexte. Les valeurs sontfaux (ne jamais afficher le contexte) ouvrai (afficher le contexte, le cas échéant). Si non précisé,Vrai est postulé.	faux
displayNameEnabled Disponible uniquement dans l’API v30+ pour les instances qui activent le nom d’affichage.	N	displayNameEnabled=true indique que l’importation de ImportCubeData doit être attendue 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. afficherNameEnabled=false indique que l’API ImportCubeData doit continuer à suivre le contrat de l’API antérieure à la version 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 « false ».	faux
mode Disponible dans l'API v32+	N	Indique le mode d'importation, qui est l'un des éléments suivants : APPEND ou REMPLACER. APPEND – Les faits existants sont mis à jour ou de nouveaux faits sont insérés. Aucun fait ne sera supprimé. REMPLACER – L’appelant doit préciser 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 la charge utile. 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 à partir de l’API v32 et des versions ultérieures. L'appel de l'API avec des versions précédentes générera une erreur. La valeur par défaut pour le mode lorsqu’elle n’est pas précisée est APPEND.	REPLACE
Contenu de l'élément
(aucun)

élément de version
Nom du marqueur		version
Description		Indique la version à utiliser pour recevoir les données demandées. Une version doit être fournie pour chaque appel.
Attributs de l'élément
Nom de l’attribut	Obligatoire?	Valeur	Exemple
nom	N	Le nom de la version à utiliser pour recevoir les données. Une seule version est accessible dans un seul appel d'API. Si aucun nom n’est fourni, leL’indicateur isDefault doit être défini àvrai 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 à Vrai; auquel cas l’attribut de nom du marqueur (s’il est présent) est ignoré. Sinon, si cette valeur est fausse 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 réussisse.	faux
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	Y	Le nom de la feuille dans laquelle les données seront importées.	Personnel
isUserAssigned	N	Indique qu’il s’agit d’une feuille affectée à un utilisateur. Si elle n’est pas précisée, la valeur par défaut est fausse, ce qui indique qu’il s’agit d’une feuille avec un niveau affecté.	faux
Contenu de l'élément
(aucun)

élément de champ d'application
Nom du marqueur		Champ d'application
Description		Indique le champ d'application de cette importation. S’applique uniquement lorsque le mode d’importation est précisé REplace. Disponible dans l'API v32+
Attributs de l'élément
Nom de l’attribut	Obligatoire?	Valeur	Exemple
mode	Y	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 : AUCUNE - Ne pas effacer les notes de cellule. TOUT - Effacer toutes les notes de cellule du champ d’application. MODIFIED_Only - efface les notes de cellule pour les cellules du champ d’application qui sont modifiées par l’importation. Cela inclut les cellules précédemment vides dans lesquelles des faits sont importés et les cellules dont les faits sont effacés. Si précisé, la valeur par défaut est NEE.	AUCUNE
Contenu de l'élément
Un élément de temps, un élément de compte et un élément de niveau, qui sont tous obligatoires.

élément de temps
Nom du marqueur		Temps
Description		Indique un ou plusieurs intervalles de temps qui représentent le champ d'application pour le moment de l'importation. Disponible dans l'API v32+
Attributs de l'élément
Nom de l’attribut	Obligatoire?	Valeur	Exemple
mode	Y	Indique le mode pour le champ d'application des heures. Doit être l’une des trois options suivantes : INPUT - Lorsque ce mode est précisé, le champ d’application des heures sera déterminé par les codes d’entrée des heures dans l’élément <en-tête>. Si l’en-tête contient deux mois, le champ d’application de l’importation sera ces deux mois. Explicit - Si ce mode est précisé, nous nous attendons à voir un ou plusieurs sous-éléments timeRange qui détermineraient l’intervalle de temps pour l’importation. Version - Lorsque ce mode est spécifié, le champ d’application des heures correspond au début et à la fin de la version, y compris toute période de solde initiale. Si le mode est précisé et qu’il s’agit de INPUT ou de VER marque, aucun élément timeRange ne doit être inclus. Si elle était présente, cette condition serait traitée comme une condition d’erreur. Préciser Version tient compte de la date de début de la version, même lorsque la date de début du plan est postérieure à la date de début de la version.	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 un intervalle de temps unique pour le champ d’application des heures. Disponible dans l'API v32+
Attributs de l'élément
Nom de l’attribut	Obligatoire?	Valeur	Exemple
début	Y	La période de début de l’intervalle de temps d’importation.	07/2021
fin	Y	la période de fin de l’intervalle de temps d’importation.	08/2021
Contenu de l'élément
(aucun)

élément des comptes
Nom du marqueur		comptes
Description		Indique les codes de compte pour le champ d'application de l'importation. S'il existe un code de compte ici, mais qu'il n'y a aucune donnée pour ce compte dans les données d'importation, les données de ce compte seront supprimées pour l'intervalle de temps et le reste des coordonnées du champ d'application. Disponible dans l'API v32+
Attributs de l'élément
Nom de l’attribut	Obligatoire?	Valeur	Exemple
mode	Y	Indique le mode du champ d'application du compte. Doit être l’une des trois options suivantes : Explicit - Si ce mode est précisé, nous nous attendons à voir un ou plusieurs sous-éléments de compte qui détermineraient le champ d'application des comptes pour l'importation. INPUT - Lorsque ce mode est précisé, le champ d’application du compte sera déterminé par l’ensemble unique de comptes présents dans les données d’importation. TOUT - Lorsque ce mode est précisé, le champ d’application du compte correspond à tous les comptes pour l’importation. Pour une importation de feuille cube, cela représentera tous les comptes pouvant être importés pour cette feuille cube. Si le mode est précisé et est INPUT ou TOUT, aucun sous-élément de compte ne doit être inclus. Si elle était présente, cette condition serait 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 INPUT ou TOUT.

élément de compte
Nom du marqueur		compte
Description		Indique le code de compte à inclure dans le champ d'application pour l'importation. Disponible dans l'API v32+
Attributs de l'élément
Nom de l’attribut	Obligatoire?	Valeur	Exemple
includeDescendants	N	Si le compte est un compte feuille, IncludeDescendants n’a aucun effet. Si le compte est un compte parent, le fait d’indiquer à cet attribut la valeur Vrai inclura tous les descendants feuilles de ce compte dans le champ d’application. Si le compte est un compte parent et que la valeur de IncludeDescendants est fausse, 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 pour devenir un compte parent et que les spécifications d’importation peuvent ne pas être mises à jour à temps pour refléter ce changement. L’omission d’un compte parent avec la valeur IncludeDescendants=false empêche la suppression involontaire de données. Cet attribut est facultatif et la valeur par défaut sera considérée comme fausse.	vrai
Contenu de l'élément
Indique le code de compte du compte utilisé dans le cadre de l'étendue de l'importation. Par exemple, Operational_Expense.

élément niveaux
Nom du marqueur		niveaux
Description		Indique les codes de niveau pour le champ d'application de l'importation. Si un code de niveau est indiqué ici, mais qu'il n'y a aucune donnée pour ce niveau dans les données d'importation, les données de ce niveau seront supprimées pour l'intervalle de temps et le reste des coordonnées du champ d'application. Disponible dans l'API v32+
Attributs de l'élément
Nom de l’attribut	Obligatoire?	Valeur	Exemple
mode	Y	Indique le mode pour le champ d'application du niveau. Doit être l’une des trois options suivantes : Explicit - Si ce mode est précisé, nous nous attendons à voir un ou plusieurs sous-éléments de niveau qui détermineraient le niveau d’application pour l’importation. INPUT - Lorsque ce mode est spécifié, le champ d’application du niveau sera déterminé par l’ensemble unique de niveaux présents dans les données d’importation. TOUT - Quand ce mode est précisé, le champ d’application du niveau correspond à tous les niveaux pouvant être importés. Si le mode est précisé et est INPUT ou TOUT, aucun sous-élément de niveau ne doit être inclus. Si elle était présente, cette condition serait traitée comme une condition d’erreur.	INPUT
Contenu de l'élément
Un ou plusieurs éléments de niveau, sauf si le mode est précisé comme INPUT ou TOUT.

élément de niveau
Nom du marqueur		niveau
Description		Indique le code de niveau à inclure dans le champ d'application pour l'importation. Disponible dans l'API v32+
Attributs de l'élément
Nom de l’attribut	Obligatoire?	Valeur	Exemple
includeDescendants	N	Si le niveau est un niveau parent, le fait de préciser cet attribut comme valeur vraie inclura tous les descendants feuilles de ce niveau, y compris (le nœud seulement) dans le champ d’application. Il s'agit d'un attribut facultatif. Si l’attribut n’est pas fourni, la valeur par défaut sera fausse. Si l’attribut n’est pas fourni ou qu’il est fourni avec la valeur Faux et que le niveau précisé est un niveau parent, cela signifie que l’importation tient compte du nœud Seul (par exemple, Ingénierie seulement) pour ce niveau pour le champ d’application. Les enfants du niveau ne seront pas pris en compte dans le champ d'application à moins d'être précisés explicitement avec d'autres éléments de niveau.	vrai
Contenu de l'élément
Indique le code du niveau dans le cadre du champ d'application de l'importation. Par exemple, Perfectionnement.

Élément rowData
Nom du marqueur		rowData
Description		Conteneur pour les rangées de données importées.
Attributs de l'élément
(aucun)
Contenu de l'élément
Un seulélément d'en-tête et une valeur exacteélément de rangées.

élément d'en-tête
Nom du marqueur		header
Description		Indique le nom et l'ordre des colonnes de données dans le rapport correspondant.élément de rangées.
Attributs de l'élément
(aucun)
Contenu de l'élément
Une ligne de texte avec des noms de colonnes séparés par des barres verticales. Ces noms de colonnes doivent correspondre aux noms des dimensions ou aux champs de la feuille, ou à des codes de période temporelle pouvant contenir des données. Ils sont identiques aux noms de colonnes qui se trouvent dans le modèle d’importation de la feuille vers laquelle les données sont importées, chaque en-tête de colonne étant séparés du suivant par une barre verticale ou une barre verticale. 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 l'API v30 ou une version plus récente pour les paramètres régionaux pris en charge par Adaptive Planning.

élément rows
Nom du marqueur		lignes
Description		Conteneur pour une ou plusieurs valeurséléments de rangée.
Attributs de l'élément
(aucun)
Contenu de l'élément
Une ou plusieurséléments de rangée.

élément de rangée
Nom du marqueur		rangée
Description		Données pour une seule rangée en cours d'importation.
Attributs de l'élément
(aucun)
Contenu de l'élément
Les données pour les champs d’une seule rangée en cours d’importation, les valeurs de chaque champ étant séparées par une barre verticale ou une barre verticale. 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 nombres dans les valeurs utilisent des séparateurs de milliers, ils sont considérés comme des séparateurs de virgules utilisés dans les paramètres régionaux indiqués dans les données d’identification de la demande.

Format de réponse

Voici des exemples de réponses pour une importation réussie et non réussie des 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	Y	L'un ou l'autrevrai oufaux, indiquant si l’appel d’API a réussi ou non. Même les appels réussis peuvent contenir des messages d’avertissement dans leur réponse.	vrai
Contenu de l'élément
Un seul facultatifélément de messages.

élément de message
Nom du marqueur		messages
Description		Conteneur pour une ou plusieurs valeurséléments de message.
Attributs de l'élément
(aucun)
Contenu de l'élément
Une ou plusieurséléments de message.

élément de message
Nom du marqueur		message
Description		Représente un message renvoyé par le système à l’appelant. Les messages sont utilisés pour envoyer des messages d’erreur lorsque les demandes échouent, pour envoyer des messages d’avertissement lorsque les demandes réussissent et pour les messages de confirmation lorsque les demandes réussissent.
Attributs de l'élément
Nom de l’attribut	Obligatoire?	Valeur	Exemple
clé	N	Lorsqu’elle est fournie, une clé est un moyen de repérer un message ou un type de message particulier, ce qui est utile à des fins d’enregistrement automatique d’erreurs et de récupération 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 improbable que les clés changent à l’avenir en raison d’ajustements de formulation ou de changements de terminologie.	invalid-attributevalueid
Contenu de l'élément
Le texte du message. Ce texte est dans la langue des paramètres régionaux indiqués dans la demande (en supposant que les paramètres régionaux sont pris en charge). Le texte peut également contenir des renseignements variables, tels que le nombre de rangées traitées, ou la colonne ou la valeur particulière qui a causé une erreur. Un élément de contexte facultatif.

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

élément de col
Nom du marqueur		col
Description		Représente le contexte du message. Donne une paire en-tête/valeur afin de pouvoir repérer la rangée générant le message.
Attributs de l'élément
Nom de l’attribut	Obligatoire?	Valeur	Exemple
header	Y	L’en-tête de la colonne.	"Compte"
valeur	Y	La valeur dans la colonne.	"GL-29482-38233"
Contenu de l'élément
(aucun)

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

Que désirez-vous porter à notre attention? Information exacte Répond à ma question Facile à trouver Facile à comprendre M'aide à effectuer ma tâche Information complète et détaillée

Que désirez-vous porter à notre attention? Information inexacte Ne répond pas à ma question Difficile à trouver Difficile à comprendre Ne m'aide pas à effectuer ma tâche Information incomplète ou pas assez détaillée

Décrivez-nous la tâche que vous effectuez. Quelle information supplémentaire pourrait améliorer ce contenu? Voulez-vous partager d’autres détails?

Nom complet

Courriel

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

Merci pour vos commentaires