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'URL

HTTPS://api.adaptiveplanning.com/api/rest/modeling/<version>/<tenant>/sheet/cube/definition
Version : v1
Catégorie
Soumission de données
Description
Modification des métadonnées
Autorisations requises pour appeler
Gestion du modèle
Le modèle comprend : feuilles, comptes, dimensions et formules
Paramètres obligatoires dans la demande
nom

VERB(S) HTTP pris en charge

Verbe HTTP
Ressource unique
Description
PATCH
Prise en charge
Insérer ou mettre à jour la définition d'une feuille cube
DELETE
Prise en charge
Supprimer une définition de feuille cube
OPTIONS
Prise en charge
Renvoie la liste des paramètres HTTP pris en charge pour cette ressource de collecte.

PATCH

URI de la demande
/sheet/cube/definition
Mettez à jour la définition de la feuille cube en correspondant au paramètre de requête fourni.
Si aucune feuille avec le nom correspondant n'existe, 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
Exemple de corps de demande
Voir la section Corps de la demande.
Paramètres de requête
Nom
Description
Obligatoire
instanceCode
instanceCode à partir de laquelle extraire les valeurs. Par exemple, GLOBO. Si aucun code d'instance n'est spécifié, l'instance par défaut de l'utilisateur est utilisée.
N
nom
Nom de la feuille.
N
reorderColumns
Le réglage de ce paramètre de requête sur true (vrai) va modifier l'ordre dans la liste des colonnes pour refléter l'ordre des colonnes indiqué dans le corps de la demande API. Par défaut, cette valeur est définie sur false (faux). Voir Référence : réorganiser les colonnes pour les API JSON modèles et de définition de feuille cube.
N
Corps de la demande
Exemple de corps de demande
Le même format de définition de feuille cube est utilisé pour les données utiles JSON des 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 la définition de la feuille
Nom
Description
Obligatoire
propriétés
Objet contenant les propriétés générales de la feuille
N
colonnes
Liste des objets de colonne de feuille cube.
N
comptes
Liste des objets du compte
N
accessibilité
Objet contenant la définition de l'accessibilité de la feuille affectée à un utilisateur.
N
Objet des 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 du compte.
N
chaîne
userAssigned
Si la feuille est une feuille affectée à un utilisateur ou (par défaut) une feuille affectée à un périmètre.
N
booléen
false
timeStratumCode
Le code de la strate de temps associé aux données de la feuille.
N
chaîne
Strate de temps GL
recalculateOnDemand
Si l'option Relancer le calcul à la demande est activée pour la feuille.
N
booléen
false
rearrangeGLAndCustomAccounts
Si les utilisateurs sont autorisés à réorganiser les comptes cubes de saisie avec d'autres comptes cubes. Cette option ne peut être activée que lorsqu'il existe des comptes cubes standard ou en cours de création dans la demande.
N
booléen
false
hideRollupTotals
Si les totaux d'agrégat doivent être masqués pour améliorer les performances des feuilles.
N
booléen
false
horizontalAxis
Objet de référence de colonne qui identifie la colonne sur l'axe horizontal.
N
objet de colonne
Temps
axe vertical
Liste des objets de référence de colonne identifiant les colonnes sur l'axe vertical. Si des valeurs sont définies, l'axe vertical remplacera toutes les sélections précédentes.
N
tableau d'objets de colonne
Compte
maxColumnWidth
La largeur maximale en pixels pour chaque colonne. Doit être compris entre 10 et 1000, ou 0 si aucune largeur n'est spécifiée.
N
entier
0
suppressZeroRows
Si les lignes nulles sont supprimées.
N
booléen
false
Objet de référence de colonne de feuille
Nom
Description
Obligatoire
Nom
Nom de la colonne. Obligatoire pour les dimensions personnalisées et les attributs.
O
type
Type de la colonne.
O
Objet de colonne de feuille
Nom
Description
Obligatoire
propriétés
Objet contenant les propriétés des colonnes de la feuille.
O
disponibilité
Liste des objets de disponibilité de la feuille pour la colonne actuelle. Voir Disponibilité de la feuille pour plus d'informations sur le format de liste.
N
disponibilité par défaut
La disponibilité par défaut à appliquer à toutes les valeurs, sauf indication contraire dans la disponibilité. Valide pour les colonnes de périmètre et de dimension.
N
supprimer
Demande de suppression de la colonne de la feuille indiquée. Non valide pour les colonnes dépendantes de colonnes existantes qui ne sont pas marquées pour suppression (comme les attributs de dimension).
N
Objet des propriétés de colonne de la 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 à celui de la dimension personnalisée ou de l'attribut respectif.
O
chaîne
type
Type de la colonne.
Valeurs possibles : Level, ACCOUNT, TIME, DIMENSION, LIGN_ATTRIBUE, ACCOUNT_ATTRIBUE, DIMENSION_ATTRIBUE.
O
chaîne
initialBalance
Le solde initial sera visible dans la feuille. Valide uniquement pour les colonnes de temps.
N
booléen
vrai
visibleTimeStratumCodes
Définit la liste des strates de temps visibles dans la feuille. Valide uniquement pour les colonnes de temps.
N
tableau de chaînes
Toutes les strates de temps
editableOnSheet
Si de nouvelles valeurs peuvent être ajoutées à la colonne de dimension depuis la feuille. Uniquement valide pour les colonnes de dimension et de sélecteur de texte.
N
booléen
false
newValueBehavior
Indique si les nouvelles valeurs doivent être activées ou désactivées lorsque celles-ci sont ajoutées à la dimension sous-jacente. Uniquement valide pour les colonnes de dimensions. Valeurs prises en charge : Aetilable, UN Available, ou Parent
N
chaîne
AVAILABLE
Objet de la table de recherche de colonne de la feuille
Nom
Description
Obligatoire
Type
Par défaut
nom
Nom de la table de recherche.
O
chaîne
displayAs
Le format Afficher sous forme de pour cette table de recherche. Valeurs possibles : NOMBRE et POURCENTAGE. Uniquement valide pour les tables de valeurs.
N
chaîne
NUMBER
decimalPrecision
Précision décimale des valeurs de cette table de recherche. Valeurs possibles : de 0 à 9.
N
entier
0
type
Type de table de recherche. Valeurs possibles : VALUE, SPREAD.
O
chaîne
Objet du compte de la feuille
Nom
Description
Obligatoire
nom
Le nom du compte.
O
code
Le code du compte.
O
parent
Le compte parent.
N
Type
Le type de compte.
O
description
La description du compte.
N
shortName
Le nom abrégé du compte.
N
isCumulated
Indique si le compte est cumulé.
N
isPlanByDelta
Indique si le compte est plan par delta.
N
isActualsByDelta
Indique si le compte est de montants réels par delta.
N
isLink
Indique si le compte est un compte lié ou non.
N
timeRollupType
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
Type d'agrégat à effectuer pour les agrégats de périmètres/dimensions personnalisées.
N
levelDimWeightAccount
Le compte de pondération utilisé pour les agrégats de périmètre/dimension personnalisée.
N
levelDimRollupText
Valeur de texte d'agrégat utilisée dans les agrégats de périmètre/dimension personnalisée.
N
actualsOverlay
Paramètre de superposition des montants réels pour le compte.
N
attributeValues
Liste des objets de valeur d'attribut pour ce compte.
N
displayAs
L'affichage comme paramètre pour le compte.
N
formula
La formule du compte.
N
decimalPrecision
Précision décimale par défaut pour le compte.
N
exchangeRateType
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
startExpanded
Indique si le compte commence à être développé sur la feuille.
N
dataEntryType
Paramètre de type de saisie de données pour ce compte.
N
dataPrivacy
Les paramètres de confidentialité de ce compte.
N
linkedAccountMappings
Liste des mappages de comptes liés.
N
Objet d'accessibilité de la feuille
Nom
Description
Obligatoire
Type
Par défaut
noms d'utilisateur
Liste des noms d'utilisateur à ajouter à la feuille
Doit correspondre à des adresses e-mail valides.
N
tableau de chaînes
excludedFromWorkflow
Met à jour la case à cocher Exclu du workflow dans les paramètres d'accessibilité de la feuille.
N
booléen
false
Exemple de réponse
204
La réponse réussie est vide avec le code de statut 204.

DELETE

URI de la demande
/sheet/cube/definition
Supprimez la définition de feuille cube correspondant au paramètre de requête donné. Si une feuille avec l'identifiant correspondant n'existe pas, le statut d'erreur ne se produira pas.
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
Exemple de corps de demande
<None>
Paramètres de requête
Nom
Description
Obligatoire
nom
Nom de la feuille cube.
N
instanceCode
instanceCode à partir de laquelle extraire les valeurs. Par exemple, GLOBO. Si aucun code d'instance n'est spécifié, l'instance par défaut de l'utilisateur est utilisée.
N
Exemple de réponse
204
La réponse réussie est vide avec le code de statut 204.