Passer au contenu principal
Documentation
Documentation
Adaptive Planning
Dernière mise à jour : 2023-06-23
Définition de feuille cube

Définition de feuille cube

Point de terminaison de l'adresse URL

HTTPS://api.adaptiveplanning.com/api/rest/modeling/<version>/<tenant>/sheet/cube/definition
Version : v1
Catégorie
Soumission de données
Description
Modification de métadonnées
Autorisations obligatoires pour être appelées
Le modèle de gestion modélisée
inclut : des feuilles, des comptes, des dimensions et des formules
Paramètres requis pour la demande
nom

VERB(s) HTTP pris en charge

Configurer HTTP HTTP
Ressource unique
Description
PATCH
Pris en charge
Insérer ou mettre à jour une définition de feuille cube
SUPPRIMER
Pris en charge
Supprimer une définition de feuille cube
OPTIONS
Pris en charge
Renvoie la liste des verbales HTTP prises en charge pour cette ressource de recouvrement.

PATCH

URI de la demande
/sheet/cube/definition
Mettez à jour la définition de feuille cube en fonction du paramètre d'interrogation fourni.
Si n’existe aucune feuille avec le nom correspondant, une nouvelle feuille cube sera créée avec les propriétés données.
Demande d'exemple par nom
https://api.adaptiveplanning.com/api/rest/modeling/v1/globosales/sheet/cube/definition?name=Sales Cube
En-tête de demande d'exemple
Accepter la langue : en
Corps de la demande d'exemple
Voir la section Corps de la demande
Paramètres d'interrogation
Nom
Description
Obligatoire
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
nom
Le nom de la feuille.
N
reorderColumns
Définir ce paramètre d’interrogation à Vrai changera l’ordre de la liste de colonnes pour refléter l’ordre des colonnes donné dans le corps de la demande API. La valeur par défaut est Faux. Voir : Référence : colonnes de réorganisation pour les API JSON modélisées et de définition de feuille cube.
N
Corps de la demande
Corps de la demande d'exemple
Le même format de définition de feuille cube est utilisé comme charge utile JSON pour les deux points de terminaison.
Format de demande
 
{
   "properties": {
       "description": "Expense Cube",
       "prefix": "Expense",
       "horizontalAxis": {
           "type": "level"
       },
       "verticalAxis": [
           {
               "type": "account"
           },
           {
               "type": "dimension",
               "name": "ProductFurniture"
           }
       ]
   },
   "columns": [
       {
           "properties": {
               "name": "Base Pay",
               "type": "dimension"
           },
           "availability":List<SheetAvaliabilityDTO>,
           "defaultAvailability": false
       }
   ],
   "accounts": [
       {
           "name": "AccountName",
           "code": "AccountCode"
       }
   ],
   "accessibility": {
       "usernames": [ "test@greenco.com" ],
       "excludedFromWorkflow": true
   }
}
Exemple de demande :
Exemple de demande de création de feuille
 
{
   "properties": {
       "description": "Test description",
       "prefix": "TestPrefix",
       "horizontalAxis": {
           "type": "level"
       },
       "verticalAxis": [
           {
               "type": "account"
           },
           {
               "type": "dimension",
               "name": "Base Pay"
           }
       ]
   },
   "columns": [
       {
           "properties": {
               "type": "Account"
           },
           "defaultAvailability": true
       },
       {
           "properties": {
               "type": "Level"
           },
           "defaultAvailability": true
       },
       {
           "properties": {
               "type": "Time"
           }
       },
       {
           "properties": {
               "name": "Base Pay",
               "type": "dimension"
           },
           "defaultAvailability": true
       }
   ],
   "accounts": [
       {
           "name": "AccountName",
           "code": "AccountCode",
           "type": "Standard"
       }
   ]
}
Objet de définition de feuille
Nom
Description
Obligatoire
propriétés
Objet contenant des propriétés de feuille générales
N
colonnes
Liste des objets de colonne de feuille cube.
N
comptes
Liste des objets de compte
N
accessibilité
Objet contenant la définition de l’accessibilité des feuilles affectées à des utilisateurs.
N
Objet de propriétés de la feuille
Nom
Description
Obligatoire
Type
Par défaut
description
Description de la feuille.
N
chaîne
Chaîne vide
préfixe
Préfixe de feuille utilisé pour le code de compte.
N
chaîne
userAssigned
Si la feuille est une feuille affectée à un utilisateur ou (par défaut) une feuille affectée à un niveau.
N
Booléen
faux
timeStratumCode
Code de strate de temps associé aux données de la feuille.
N
chaîne
Strate de temps GL
recalculateOnDemand
Si l’option Recalculer sur demande est activée pour la feuille.
N
Booléen
faux
rearrangeGLAndCustomAccounts
Si les utilisateurs sont autorisés à réorganiser les comptes cube de saisie avec d’autres comptes cubes. Cette option ne peut être activée que lorsque des comptes standard cubes existent ou sont créés dans la demande.
N
Booléen
faux
hideRollupTotals
S’il faut masquer les totaux des agrégats pour améliorer les performances des feuilles.
N
Booléen
faux
horizontalAxis
Objet de référence de colonne désignant la colonne sur l’axe horizontal.
N
objet colonne
Temps
verticalAxe
Liste des objets de référence de colonne désignant les colonnes sur l’axe vertical. Si cette option est fournie, l’axe vertical remplacera toutes les sélections précédentes.
N
tableau d'objets de colonne
Compte
maxColumnWidth
Leur largeur maximum en pixels pour chaque colonne. Doit être compris entre 10 et 1000, ou 0 si une largeur n’est pas précisée.
N
nombre entier
0
suppressZeroRows
Si les rangées nulles sont supprimées.
N
Booléen
faux
Objet de référence de colonne de feuille
Nom
Description
Obligatoire
Nom
Nom de la colonne. Obligatoire pour la dimension et les attributs personnalisés.
Y
type
Type de colonne.
Y
Objet de colonne de feuille
Nom
Description
Obligatoire
propriétés
Objet contenant les propriétés de la colonne de la feuille.
Y
disponibilité
Liste des objets de disponibilité de feuille pour la colonne actuelle. Voir : Disponibilité de la feuille pour plus de détails sur le format de la liste.
N
par défautDisponibilité
La disponibilité par défaut à appliquer à toutes les valeurs, sauf indication contraire dans la disponibilité. Valide pour les colonnes de niveau et de dimension.
N
supprimer
Demander à supprimer une colonne de la feuille donnée. Non valide pour les colonnes qui dépendent de colonnes existantes qui ne sont pas marquées pour la suppression (comme les attributs de dimension).
N
Objet de propriétés de colonne de feuille
Nom
Description
Obligatoire
Type
Par défaut
nom
Nom de la colonne. Pour les colonnes de dimension personnalisée et d’attribut, le nom correspond au nom de la dimension personnalisée ou de l’attribut respective.
Y
chaîne
type
Le type de colonne.
Valeurs possibles : REVEL, ACCOUNT, TIME, DIM Source, REVEL_ATTRIBUDUE, ACCOUNT_ATTRIBUDUE, DIMISE_ATTRIBUDUE
Y
chaîne
initialBalance
Si le solde initial sera visible sur la feuille. Valide uniquement pour les colonnes de temps.
N
Booléen
vrai
visibleTimeStratumCodes
Définit la liste des strates de temps visibles sur la feuille. Valide uniquement pour les colonnes de temps.
N
tableau de chaînes
Strate de tous les temps
editableOnSheet
Si de nouvelles valeurs peuvent être ajoutées à la colonne de dimension à partir de la feuille. Valide uniquement pour les colonnes de dimension et de sélecteur de texte.
N
Booléen
faux
newValueBehavior
Définit si vous souhaitez activer ou désactiver les nouvelles valeurs lorsque celles-ci sont ajoutées à la dimension sous-jacente. Valide uniquement pour les colonnes de dimension. Valeurs prises en charge : Adistribuable, UNA Available ou Parental
N
chaîne
AVAILABLE
Objet de table de consultation de colonne de feuille
Nom
Description
Obligatoire
Type
Par défaut
nom
Nom de la table de consultation.
Y
chaîne
displayAs
Le format Afficher sous forme de pour cette table de consultation. Valeurs possibles : NUMBER et PERCENT. Valide uniquement pour les tables de recherche de valeurs.
N
chaîne
NUMBER
decimalPrecision
Précision décimale des valeurs dans cette table de consultation. Valeurs possibles : 0 à 9.
N
nombre entier
0
type
Le type de table de consultation. Valeurs possibles : VALUE, SPécart.
Y
chaîne
Objet de compte de feuille
Nom
Description
Obligatoire
nom
Le nom du compte.
Y
code
Le code du compte.
Y
parent
Le compte parent.
N
Type
Le type de compte.
Y
description
La description du compte.
N
shortName
Le nom abrégé du compte.
N
isCumulative
Indique si le compte est cumulé.
N
isPlanByDelta
Indique si le compte est plan par delta.
N
isActualsByDelta
Indique si le compte est un nombre de chiffres réels par delta.
N
isLink
Indique si le compte est un compte lié ou non.
N
timeRollupType
Le type d'agrégat à effectuer pour les agrégats de temps.
N
timeWeightAccount
Le compte de pondération utilisé pour les agrégats de temps.
N
levelDimRollupType
Le type d’agrégat à effectuer pour les agrégats de niveaux/dimensions personnalisés.
N
levelDimWeightAccount
Le compte de pondération utilisé pour les agrégats de dimensions de niveau ou personnalisés.
N
levelDimRollupText
Valeur du texte d’agrégat utilisée dans les agrégats de niveaux/dimensions personnalisées.
N
actualsOverlay
Le paramètre de superposition des chiffres réels pour le compte.
N
attributeValues
Liste des objets de valeur d'attribut de compte pour ce compte.
N
displayAs
L’afficher comme paramètre pour le compte.
N
formula
La formule du compte.
N
decimalPrecision
La précision décimale par défaut du compte.
N
exchangeRateType
Le type de taux de change pour ce compte.
N
suppressZeros
Indique si les lignes nulles doivent être supprimées pour le compte dans les feuilles.
N
startdéveloppé
Indique si le compte commence en mode Développé sur la feuille.
N
dataEntryType
Le paramètre de type de saisie de données pour ce compte.
N
dataPrivacy
Le paramètre de confidentialité des données pour ce compte.
N
linkedAccountMappings
Liste de LinkedAccountMapping.
N
Objet d'accessibilité de feuille
Nom
Description
Obligatoire
Type
Par défaut
utilisateurs
Liste de noms d'utilisateur à ajouter à la feuille.
Doit se présenter sous la forme d’adresses de courriel valides.
N
tableau de chaînes
excludedFromWorkflow
Met à jour la case à cocher « Exclu du flux des travaux » dans les paramètres d'accessibilité de la feuille.
N
Booléen
faux
Exemple de réponse
204
La réponse réussie est vide avec le code de statut 204.

SUPPRIMER

URI de la demande
/sheet/cube/definition
Supprimez la définition de feuille cube correspondant au paramètre d'interrogation donné. Si aucune feuille avec l’identifiant correspondant n’existe, une erreur introuvable se produit.
Demande d'exemple par nom
https://api.adaptiveplanning.com/api/rest/modeling/v1/globosales/sheet/cube/definition?name=Sales Cube
En-tête de demande d'exemple
Accepter la langue : en
Corps de la demande d'exemple
<None>
Paramètres d'interrogation
Nom
Description
Obligatoire
nom
Le nom de la feuille cube.
N
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
Exemple de réponse
204
La réponse réussie est en blanc avec le code de statut 204.