Passer au contenu principal
Documentation
Documentation
Adaptive Planning
Dernière mise à jour : 2024-09-20
Modeled Sheet Definition

Modeled Sheet Definition

Point de terminaison de l'adresse URL

HTTPS://api.adaptiveplanning.com/api/rest/modeling/<version>/<tenant>/sheet/modeled/definition
Version : v1
Catégorie
Soumission de données
Description
Modification de métadonnées
Autorisations obligatoires pour être appelées
Le modèle d’accès à la gestion du modèle
comprend : 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
Ressource de recouvrement
Description
PATCH
Pris en charge
Non pris en charge
Insérer ou mettre à jour une définition de feuille modélisée
SUPPRIMER
Pris en charge
Non pris en charge
Supprimer une définition de feuille modélisée
POST
Pris en charge
Non pris en charge
Mode de validation pour la définition de feuille modélisée uper.
OPTIONS
Pris en charge
Non pris en charge
Renvoie la liste des verbales HTTP prises en charge pour cette ressource de recouvrement.

PATCH

URI de la demande
/sheet/modeled/definition
Mettez à jour la définition de la feuille modélisée en fonction du paramètre d'interrogation fourni.
Si n’existe aucune feuille avec l’identifiant correspondant, une nouvelle feuille modélisée avec les propriétés données sera créée.
Demande d'exemple par nom
https://api.adaptiveplanning.com/api/rest/modeling/v1/globosales/sheet/modeled/definition?name=Capital Model
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
poursuivreAvertir
Si la validation doit ignorer toute validation avec avertissement, généralement renvoyée lorsqu’une propriété de feuille modifiée peut supprimer des données 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 modélisée est utilisé comme charge utile JSON pour les deux points de terminaison.
Format de demande
 
{
  "properties": {
      "description": "Capital Model",
      "prefix": "Capital"
  },
  "columns": [
      {
          "properties": {
              "code": "Base Pay",
              "name": "Base Pay",
              "type": "TEXT_SELECTOR",
              "values": ["value1", "value2"],
              "lookupTables": [
                  {
                      "name": "valueLookup1",
                      "type": "VALUE",
                      "decimalPrecision": 1,
                      "displayAs": "CURRENCY"
                  },
                  {
                      "name": "spreadLookup1",
                      "type": "SPREAD",
                      "decimalPrecision": 0,
                      "displayAs": "NUMBER"
                  }
              ]
          },
          "availability": [
              {
                  "name": "100k",
                  "code": "100k",
                  "available": true
              }
          ],
          "defaultAvailability": false,
          "defaultActionIfDataIsPresent": "delete"
      },
      {
          "properties": {
              "code": "Label",
              "name": "Label",
              "type": "TEXT"
          },
          "delete": true
      }
  ],
  "accounts": [
      {
          "name": "AccountName",
          "code": "AccountCode"
      }
  ],
  "accessibility": {
      "usernames": [ "test@greenco.com" ],
      "excludedFromWorkflow": true
  }
}
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 colonnes de feuille modélisée.
De nouvelles colonnes seront créées à la fin de la définition de la feuille et l'ordre relatif des nouvelles colonnes sera respecté.
Les colonnes existantes seront uniquement mises à jour sur place; elles ne seront pas réorganisées.
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
code
Le code de feuille utilisé pour préfixer les codes de compte et un identifiant unique secondaire. Obligatoire lors de la création d’une nouvelle feuille.
N
chaîne
préfixe
Préfixe de feuille utilisé pour le code de compte. Obligatoire lors de la création d’une nouvelle feuille. Déprécié en raison du code.
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
salaryDetail
Si la feuille contient les détails du salaire.
N
Booléen
faux
frozenColumnCount
N
nombre entier
0
allowSplits
Si la feuille autorise le fractionnement de rangées.
N
Booléen
faux
allowRollupModelEdits
Si la feuille autorise les modifications tout en affichant les niveaux d’agrégat.
N
Booléen
faux
allowActuals
Si la feuille est disponible dans les versions des chiffres réels.
N
Booléen
faux
recalculateOnDemand
Si l’option Recalculer sur demande est activée pour la feuille.
N
Booléen
faux
timeStratumCode
Code de strate de temps associé aux données de la feuille.
N
chaîne
Strate de temps GL
Objet de colonne de feuille
Nom
Description
Obligatoire
Type
Par défaut
propriétés
Objet contenant les propriétés de la colonne de la feuille.
Y
objet
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
liste
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.
Pour les colonnes de dimension, si aucune disponibilité ou valueAvailability n’est indiquée, la valeur defaultAvailability sera vraie pour les nouvelles colonnes.
Par défaut, cette valeur sera vide, ce qui signifie que la disponibilité existante est conservée, sauf si elle a été modifiée spécifiquement par la disponibilité.
N
Booléen
defaultActionIfDataIsPresent
L’action par défaut si des données sont présentes lors de la suppression d’une valeur, sauf indication contraire dans la disponibilité. Valide pour les colonnes de dimension.
Obligatoire lorsque la valeur Disponibilité par défaut est fausse pour les colonnes existantes.
N
chaîne
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
Booléen
Objet de propriétés de colonne de feuille
Nom
Description
Obligatoire
Type
Par défaut
nom
Nom de la colonne.
N
chaîne
code
Le code de la colonne. Obligatoire pour toutes les colonnes, à l’exception des colonnes de niveau et de devise de niveau.
Y
chaîne
type
Le type de colonne.
Valeurs possibles : REVEL, DIMECTION, REVEL_ATTRIBULTE, DIMECTION_ATTRIBUDUE, TIMESpan, NUMBER, DATE, TExT, TExT_SELECTOR, REVEL_ exécuterCY, DISplay, IN Setup_BALANCE, CHE Heures
Y
chaîne
lecture seule
Que la colonne actuelle soit en lecture seule ou non. Pour les colonnes d’attribut de dimension, définissez lecture seule à Faux pour utiliser l’attribut comme filtre sur la dimension.
Obligatoire pour être Vrai (et par défaut Vrai) pour les attributs de niveau et les colonnes d’affichage.
N
Booléen
faux
allowSplits
Si la colonne actuelle peut être fractionnée. Uniquement valide pour les feuilles lorsque la propriété générale AllowSplits est vraie.
N
Booléen
faux
showTotalsAtBottom
Afficher ou non les totaux en bas de la feuille pour cette colonne.
N
Booléen
faux
allowHidden
Si cette colonne peut être masquée dans la vue de la feuille dans Options d’affichage. Valide pour toutes les colonnes, à l'exception du sélecteur de texte et des colonnes d'intervalle de temps.
N
Booléen
vrai
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
requis
Si chaque rangée doit avoir une valeur dans cette colonne. Valide uniquement pour les colonnes de dimension lorsque la valeur de Allow Implicitement est Faux.
N
Booléen
faux
recalculateOnMatch
S’il faut recalculer les valeurs lors de la correspondance. Uniquement les colonnes de dimension et de sélecteur de texte valides pour les feuilles pour lesquelles la valeur de recalculateOnDemand est vraie.
N
Booléen
faux
lookupTables
Liste d’objets LookupTable pour définir les tables de répartition et de valeurs. Valide uniquement pour les colonnes de dimension et de sélecteur de texte.
N
LookupTable
nul
valeurs
Liste de chaînes à ajouter comme valeurs de sélecteur de texte. Valide uniquement pour les colonnes de sélecteur de texte.
N
tableau de chaînes
nul
rowkey
Si cette colonne peut être utilisée comme clé de rangée. Valide uniquement pour les colonnes de texte de pilote.
N
Booléen
faux
displayAs
Le format Afficher sous forme de pour la colonne. Valide uniquement pour les colonnes de pilote numériques.
Valeurs possibles : nombre, pourcentage, devise
N
DisplayAs
faux
decimalPrecision
Précision décimale à afficher. Valide uniquement pour les colonnes de pilote numériques.
Valeurs possibles : 0 à 9, ou -1 pour utiliser la précision de la devise lorsqu’elle est affichée en tant que DEVISE.
N
nombre entier
0
showToggle
S’il faut afficher une colonne de cases à cocher sous forme de commutateur. Valide uniquement pour les colonnes de case à cocher.
N
Booléen
faux
showInEditMode
S’il faut afficher la colonne dans les rangées modifiables de la feuille modélisée. Valide uniquement pour les colonnes de devise du niveau.
N
Booléen
faux
referenceTimePeriod
Indique la période de référence pour une colonne d’affichage. Valide uniquement pour les colonnes d'affichage de compte.
Valeurs possibles : FIRST_NON_ACTualS_PEREOD, START_Of_P rien
N
chaîne
FIRST_NON_ACTUALS_PERIOD
startOfRollupRange
Indique où démarrer une plage d’agrégat de périodes temporelles pour une colonne d’affichage. Valide uniquement pour les colonnes d'affichage de compte.
Valeurs possibles : CONCOUNTING_REFERENCE_PEREOD, BEURE_REFERENCE_PEREOD,AFTE_REFERENCE_PEREOD
N
chaîne
CONTAINING_REFERENCE_PERIOD
timePeriodsInRollupRange
Nombre de périodes temporelles à inclure dans la plage d'agrégat pour une colonne d'affichage. Valide uniquement pour les colonnes d'affichage de compte.
N
nombre entier
1
startOfRollupRangeTimeStratumCode
Code de la période pour déterminer le début de la plage d’agrégat pour une colonne d’affichage. Valide uniquement pour les colonnes d'affichage de compte. Les valeurs possibles incluent des strates de temps égales ou supérieures à la strate de temps de la feuille.
N
chaîne
Strate de temps de la feuille
accountCode
Code du compte pour déterminer le compte modélisé pour une colonne d'affichage. Valide uniquement pour les colonnes d'affichage. Seules les valeurs valides sont les comptes dans la feuille modélisée donnée
N
chaîne
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
description
La description du compte.
N
isCumulative
Indique si le compte est cumulé.
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
weightedAverageTranslationsEnabled
Indique si le compte est activé ou non avec des conversions de moyennes pondérées.
N
weightedAverageTranslationResetStratum
La strate de repos WAT pour ce compte.
N
weightedAverageTranslationTransferAccount
Le compte de transfert WAT pour ce 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
hasSalaryDetail
Indique si le compte comporte ou non des détails sur le salaire.
N
isBreakbackEligible
Indique si la répartition est admissible pour ce compte.
N
isSystemAccount
Indique si ce compte est un compte système ou non.
N
isIntercompany
Indique s’il s’agit d’un compte intersociétés ou non.
N
isAssumption
Indique si le compte est une hypothèse ou non.
N
isMetric
Indique si le compte est un compte d'indicateur ou non.
N
modeledSheetSpreadCode
Le code de répartition de la feuille modélisée pour la répartition modèle associée.
N
spreadTargetAccount
L’objet de compte cible du compte de répartition.
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/modeled/definition
Supprimez la définition de feuille modélisée 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/modeled/definition?name=Capital Model
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 modélisée.
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 vide avec le code de statut 204.

POST

URI de la demande
/sheet/modeled/definition/validate
Validez une demande de définition de feuille modélisée.
Demande d'exemple par nom
https://api.adaptiveplanning.com/api/rest/modeling/v1/default/sheet/modeled/definition/validate?name=My Sheet
En-tête de demande d'exemple
Accepter la langue : en
Corps de la demande d'exemple
<Documenté ci-dessous>
Paramètres d'interrogation
Voir le point de terminaison relatif en cours de validation (ie PATCH).
Corps de la demande
Corps de la demande d'exemple
Le même format de définition de feuille modélisée est utilisé comme données utiles JSON pour le point de terminaison à valider. Toutefois, l’objet
validationOptions
 est obligatoire dans les données utiles lors de l’envoi d’une demande de validation.
Format de demande
 
{

  "validationOptions": {
      "httpMethod": "Patch",
      "dependentDimensions": [
          "MyTestDim1", "MyTestDim2"
      ],
      "dependentAttributes": [
          {
              "attributeName": "MyTestAttr1",
              "attributeType": "DIMENSION_ATTRIBUTE",
              "dimensionName": "MyTestDim2"
          },
          {
              "attributeName": "MyTestAttr2",
              "attributeType": "LEVEL_ATTRIBUTE"
          }
      ]
  },

  "properties": {
      "description": "Capital Model",
      "prefix": "Capital"
  },
  "columns": [
      {
          "properties": {
              "code": "Base Pay",
              "name": "Base Pay",
              "type": "TEXT_SELECTOR",

...
Objet d'options de validation
Nom
Description
Obligatoire
httpMethod
Indique le point de terminaison de l'API de feuille modélisée qui est en cours de validation. Prend actuellement en charge les points de terminaison suivants :
  • PATCH
Y
dependentDimensions
Liste de noms de dimension dont il faut supposer qu'ils existent pour validation. Les dimensions ne sont pas persistantes à la suite de la demande de validation. Il est convenu que toutes les dimensions personnalisées dépendantes sont fixes.
N
dependentAttributes
Liste des objets d’attributs dépendants. Les attributs ne sont pas persistants à la suite de la demande de validation.
N
Objet d'attributs dépendant
Nom
Description
Obligatoire
attributeName
Nom de l'attribut dépendant.
Y
attributeType
Le type de l'attribut dépendant. Les types pris en charge sont :
  • LEVEL_ATTRIBUTE
  • DIMENSION_ATTRIBUTE
Y
dimensionName
Nom de la dimension pour l'attribut dépendant. S'applique uniquement et est obligatoire pour les attributs de dimension. Non autorisé pour les attributs de niveau.
N