Définition d'une feuille modèle

Point de terminaison de l'URL

VERB(S) HTTP pris en charge

PATCH

URI de la demande

/sheet/modeled/definition

Mettez à jour la définition de la feuille modèle correspondant au paramètre de requête fourni. Si aucune feuille avec l'identifiant correspondant n'existe, une nouvelle feuille modèle 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/modeled/definition?name=Capital Model

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
proceedWithWarnings	Si l'utilisateur doit ignorer les validations d'avertissement, c'est généralement renvoyé lorsqu'une propriété de feuille modifiée est susceptible de supprimer des données 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 modèle est utilisé pour les données utiles JSON des 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 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 modèle. Les 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 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
code	Le code de la 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 du compte. Obligatoire lors de la création d'une nouvelle feuille. Déprécié en faveur 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 périmètre.	N	booléen	false
salaryDetail	Si la feuille contient des informations sur le salaire.	N	booléen	false
frozenColumnCount		N	entier	0
allowSplits	Si la feuille autorise les lignes de subdivision.	N	booléen	false
allowRollupModelEdits	Si la feuille autorise les modifications pendant l'affichage des périmètres d'agrégat.	N	booléen	false
allowActuals	Si la feuille est disponible dans les versions de montants réels.	N	booléen	false
recalculateOnDemand	Si l'option Relancer le calcul à la demande est activée pour la feuille.	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

Objet de colonne de feuille

Nom	Description	Obligatoire	Type	Par défaut
propriétés	Objet contenant les propriétés des colonnes de la feuille.	O	objet
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	liste
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. Pour les colonnes de dimension, si aucune disponibilité ou disponibilité n'est spécifiée, la disponibilité par défaut sera définie sur vrai pour les nouvelles colonnes. Par défaut, cette valeur sera vide, ce qui signifie que la disponibilité existante est conservée, sauf si elle est spécifiquement modifiée 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 dimensions. Obligatoire lorsque la disponibilité par défaut est fausse pour les colonnes existantes.	N	chaîne
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	booléen

Objet des propriétés de colonne de la 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 périmètre et de devise de périmètre.	O	chaîne
type	Type de la colonne. Valeurs possibles : Level, DIMENSION, N Level_AttributIBUE, DIMENSION_ATTRIBUE, TIMESPA Nature, NUMBER, DATE, TEXT, TEXT_SELECTOR, LOVE_CURRENCY, DISVIEW, IN ITITA_BALANCE, CHECHEBOOK	O	chaîne
lecture seule	Si la colonne actuelle est en lecture seule ou non. Pour les colonnes d'attributs de dimension, définissez lecture seule sur false (faux) afin d'utiliser l'attribut en tant que filtre sur la dimension. Requis pour être vrai (et par défaut vrai) pour les attributs de périmètre et les colonnes d'affichage.	N	booléen	false
allowSplits	La colonne actuelle peut-elle être subdivisée ? Uniquement valide pour les feuilles lorsque la propriété générale AllowSplits est vraie.	N	booléen	false
showTotalsAtBottom	Si les totaux doivent être affichés en bas de la feuille pour cette colonne.	N	booléen	false
allowHidden	Si cette colonne peut être masquée dans la visionneuse de feuilles dans Options d'affichage. Valide pour toutes les colonnes sauf les colonnes de sélecteur de texte et d'intervalle de temps.	N	booléen	vrai
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
obligatoire	Si chaque ligne doit contenir une valeur de cette colonne. Uniquement valide pour les colonnes de dimensions pour lesquelles la valeur leur est activée.	N	booléen	false
recalculateOnMatch	Si les valeurs correspondantes doivent être recalculées. Seules les colonnes de dimension et de sélecteur de texte valides pour les feuilles où recalculateOnDemand est vraie.	N	booléen	false
lookupTables	Liste des objets LookupTable pour définir les tables de répartition et de valeur. Uniquement valide pour les colonnes de dimension et de sélecteur de texte.	N	LookupTable	nul
valeurs	Liste des chaînes à ajouter comme valeurs de sélecteur de texte. Uniquement valide pour les colonnes de sélecteur de texte.	N	tableau de chaînes	nul
row Key	Si cette colonne peut être utilisée comme Clé de ligne. Uniquement valide pour les colonnes de pilote de texte.	N	booléen	false
displayAs	Le format Afficher sous forme de pour la colonne. Uniquement valide pour les colonnes de pilote numériques. Valeurs possibles : NUMBER, POURCENTAGE, CURRENCY	N	Afficher sous forme de	false
decimalPrecision	Précision décimale à afficher. Uniquement valide pour les colonnes de pilote numériques. Valeurs possibles : de 0 à 9, ou -1 pour utiliser la précision de la devise lorsqu'elle est affichée avec la valeur DEVISE.	N	entier	0
showToggle	Si la colonne Case à cocher doit être affichée en tant que bascule. Uniquement valide pour les colonnes Case à cocher.	N	booléen	false
showInEditMode	Si la colonne doit être affichée sur les lignes modifiables de la feuille modèle. Uniquement valide pour les colonnes Devise du périmètre.	N	booléen	false
referenceTimePeriod	Indique la période de référence d'une colonne d'affichage. Uniquement valide pour les colonnes d'affichage de compte. Valeurs possibles : FIRST_NON_ACTUALS_PERIOD, START_Of_ PLAN	N	chaîne	FIRST_NON_ACTUALS_PERIOD
startOfRollupRange	Indique où commencer une plage d'agrégat de période pour une colonne d'affichage. Uniquement valide pour les colonnes d'affichage de compte. Valeurs possibles : CONTINING_REFERENCE_PER ChaqueD, BEO_REFERENCE_PER Chaque vers concernant	N	chaîne	CONTAINING_REFERENCE_PERIOD
timePeriodsInRollupRange	Nombre de périodes à inclure dans la plage d'agrégat d'une colonne d'affichage. Uniquement valide pour les colonnes d'affichage de compte.	N	entier	1
startOfRollupRangeTimeStratumCode	Code de la période pour déterminer le début de la plage d'agrégat d'une colonne d'affichage. Uniquement valide pour les colonnes d'affichage de compte. Les valeurs possibles incluent des strates de temps égales ou supérieures à celles de la feuille.	N	chaîne	Strate de temps de la feuille
accountCode	Code du compte permettant de déterminer le compte modèle d'une colonne d'affichage. Uniquement valide pour les colonnes d'affichage. Seules les valeurs valides figurent dans la feuille modèle donnée	N	chaîne

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

Pour plus d'informations, voir Référence : propriétés des données utiles d'importation du compte JSON

Nom	Description	Obligatoire
nom	Le nom du compte.	O
code	Le code du compte.	O
parent	Le compte parent.	N
description	La description du compte.	N
isCumulated	Indique si le compte est cumulé.	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
weightedAverageTranslationsEnabled	Indique si les conversions par moyenne pondérée sont activées pour le compte.	N
weightedAverageTranslationResetStratum	La strate repos WAT de ce compte.	N
weightedAverageTranslationTransferAccount	Compte de transfert WAT pour ce 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
hasSalaryDetail	Indique si le compte contient ou non des informations de salaire.	N
isBreakbackEligible	Indique si la répartition est éligible pour ce compte.	N
isSystemAccount	Indique si ce compte est un compte système ou non.	N
isIntercompany	Indique s'il s'agit ou non d'un compte intercompagnies.	N
isAssumption	Indique si le compte est une hypothèse ou non.	N
isMetric	Indique si le compte est un compte métrique ou non.	N
modeledSheetSpreadCode	Le code de répartition de la feuille modèle pour le modèle de répartition associé.	N
spreadTargetAccount	L'objet du compte cible du compte de répartition.	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/modeled/definition

Supprimez la définition de feuille modèle 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/modeled/definition?name=Capital Model

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	Le nom de la feuille modèle.	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.

POST

URI de la demande

/sheet/modeled/definition/validate

Validez une demande de définition de feuille modèle.

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

Exemple de corps de demande

<Documentation ci-dessous>

Paramètres de requête

Voir le point de terminaison relatif en cours de validation (par exemple, PATCH).

Corps de la demande

Exemple de corps de demande

Le même format de définition de feuille modèle est utilisé pour les données utiles JSON du point de terminaison en cours de validation. Cependant, 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 quel point de terminaison API de feuille modèle est en cours de validation. Prend actuellement en charge les points de terminaison suivants : PATCH	O
dependentDimensions	Liste des noms de dimension à supposer existants pour la validation. Les dimensions ne sont pas conservées suite à la demande de validation. Le système part du principe que toutes les dimensions personnalisées dépendantes sont plates.	N
dependentAttributes	Liste des objets aux attributs dépendants. Les attributs ne sont pas conservés suite à la demande de validation.	N

Objet de l'attribut de personne à charge

Nom	Description	Obligatoire
attributeName	Nom de l'attribut dépendant.	O
attributeType	Type de l'attribut dépendant. Les types pris en charge sont les suivants : LEVEL_ATTRIBUTE DIMENSION_ATTRIBUTE	O
dimensionName	Nom de la dimension pour l'attribut dépendant. Uniquement applicable et obligatoire pour les attributs de dimension. Non autorisé pour les attributs de périmètre.	N