Disponibilité de la feuille

Point de terminaison de l'URL

VERB(S) HTTP pris en charge

GET :

Demande :

/sheet/availability: Récupère un ensemble de disponibilités de valeurs.

Récupère la disponibilité de toutes les valeurs dans une dimension de feuille. Vous pouvez filtrer par instanceCode, sheetName et columnName.

Exemple d'URI de demande :

HTTPS://api.adaptiveinsights.com/api/rest/modeling/v1/globosales/sheet/availability?sheetName=ExpenseCube&columnName=Level&columnType=Level

Exemple d'en-tête de demande :

Accepter la langue : en

Exemple de corps de demande

Paramètres de requête

Nom	Description	Obligatoire
sheetName	Nom de la feuille à partir de laquelle récupérer les valeurs de disponibilité.	O
columnName	Nom de la colonne de la feuille à partir de laquelle récupérer les valeurs de disponibilité. Obligatoire pour les feuilles cubes uniquement. Seules les colonnes où la disponibilité de la valeur peut être modifiée sont prises en charge. Pour les colonnes de compte et de périmètre de feuille cube, le nom de la colonne respecte les paramètres régionaux définis dans l'en-tête Accepter la langue.	O
columnCode	Code de la colonne de la feuille à partir de laquelle récupérer les valeurs de disponibilité. Obligatoire pour les feuilles modèles uniquement. Seules les colonnes où la disponibilité de la valeur peut être modifiée sont prises en charge.	O
columnType	Type de colonne pour columnName ou columnCode donné. Valeurs acceptées : compte, périmètre, dimension, attribut	O
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
limit	Le nombre maximum d'objets dans une même réponse.	N
offset	Index à base zéro du premier objet dans une collection de réponse. La valeur par défaut est 0. Utilisez le décalage avec le paramètre de limite pour contrôler la pagination d'un ensemble de réponses.	N

Exemple de réponse

200

Réponse réussie.

Exemple de réponse

{ "data": [ { "code": "Corporate Plan", "name": "Corporate Plan", "available": true }, { "code": "Engineering", "name": "Engineering", "available": true }, { "code": "Development", "name": "Development", "available": true }, { "code": "Documentation", "name": "Documentation", "available": true }, { "code": "QA", "name": "QA", "available": true }, { "code": "2014-Development Organization", "name": "2014-Development Organization", "available": false }, { "code": "Development-India", "name": "Development-India", "available": false }, { "code": "QA-India", "name": "QA-India", "available": false }, { "code": "G & A", "name": "G & A", "available": false }, { "code": "Hosting", "name": "Hosting", "available": true }, { "code": "Professional Services", "name": "Professional Services", "available": true }, { "code": "Sales", "name": "Sales", "available": true }, { "code": "Marketing", "name": "Marketing", "available": true }, { "code": "US Sales", "name": "US Sales", "available": false }, { "code": "Worldwide Sales", "name": "Worldwide Sales", "available": true }, { "code": "Asia Sales", "name": "Asia Sales", "available": false }, { "code": "Europe Sales", "name": "Europe Sales", "available": true }, { "code": "Latin America Sales", "name": "Latin America Sales", "available": true } ], "total": 18 }

POST :

Demande :

/sheet/availability: Met à jour la disponibilité des valeurs pour un ensemble.

Met à jour la disponibilité de toutes les valeurs dans une dimension de feuille.

Exemple d'URI de demande :

https://api.adaptiveplanning.com/api/rest/modeling/v1/globosales/sheet/availability?sheetName=ExpenseCube&columnName=Level&columnType=Level

Exemple d'en-tête de demande :

Accepter la langue : en

Corps de la demande :

Tableau JSON des objets de disponibilité, correspondant à la propriété "données" de l'export. Chaque objet JSON a la structure suivante :

Nom	Description	Obligatoire
code	Code de la valeur. Utilisé pour identifier de façon unique les valeurs.	O
nom	Nom de la valeur.	O
accountGroup	Si la valeur est un groupe de comptes. Obligatoire pour les comptes.	N
disponible	La valeur est disponible ou non. Si la case est absente, aucun changement n'est effectué.	N
deleteIfDataIsPresent	Si les données doivent être supprimées, si elles existent. Obligatoire lors de la désactivation d'une valeur de dimension personnalisée dans les feuilles cubes.	N
actionIfDataIsPresent	Action à effectuer lorsqu'il existe des données. Obligatoire lors de la désactivation d'une valeur de dimension personnalisée dans les feuilles modèles.	N

Exemple de corps de demande

Corps de la demande

[ { "code": "SalesCube.DiscountPercent", "name": "Discount Percent", "accountGroup": false, "available": false } ]

Paramètres de requête

Nom	Description	Obligatoire
sheetName	Nom de la feuille d'où sont extraites les valeurs de disponibilité.	O
columnName	Nom de la colonne de la feuille à partir de laquelle récupérer les valeurs de disponibilité. Obligatoire pour les feuilles cubes uniquement. Seules les colonnes où la disponibilité de la valeur peut être modifiée sont prises en charge. Pour les colonnes de compte et de périmètre de feuille cube, le nom de la colonne respecte les paramètres régionaux définis dans l'en-tête Accepter la langue.	O
columnCode	Le code de la colonne de la feuille dont vous souhaitez extraire la disponibilité. Obligatoire pour les feuilles modèles uniquement. Seules les colonnes où la disponibilité de la valeur peut être modifiée sont prises en charge.	O
columnType	Type de colonne pour columnName ou columnCode donné. Valeurs acceptables : compte, périmètre, dimension, attribut.	O
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.