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

Disponibilité de la feuille

Point de terminaison de l'adresse URL

HTTPS://api.adaptiveinsights.com/api/rest/modeling/<version>/<tenant>/sheet/availability
Version : v1
Catégorie
Modification de métadonnées
Description
Récupérez ou mettez à jour la disponibilité des valeurs de dimension ou d’attribut pour une feuille et une colonne donné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
sheetName, columnName

VERB(s) HTTP pris en charge

Configurer HTTP HTTP
Ressource unique
Ressource de recouvrement
Description
GET
Non pris en charge
Pris en charge
Récupère la disponibilité de toutes les valeurs pour une feuille et une colonne données.
POST
Non pris en charge
Pris en charge
Mettez à jour la disponibilité des valeurs pour une feuille et une colonne données.
OPTIONS
Pris en charge
Pris en charge
Renvoie la liste des verbales HTTP prises en charge pour cette ressource de recouvrement.

OBTENIR :

Demande :
/sheet/availability:
Récupère une collection de valeurs selon la disponibilité.
Récupère la disponibilité de toutes les valeurs dans une dimension de feuille. Vous pouvez filtrer par instanceCode, sheetName et columnName.
URI de la demande exemple :
HTTPS://api.adaptiveinsights.com/api/rest/modeling/v1/globosales/sheet/availability?sheetName=ExpenseCube&columnName=Level&columnType=Level
En-tête de demande d’exemple :
Accepter la langue : en
Corps de la demande d'exemple
Paramètres d'interrogation
Nom
Description
Obligatoire
sheetName
Le nom de la feuille à partir duquel extraire les valeurs de disponibilité.
Y
columnName
Le nom de la colonne de feuille à partir duquel extraire les valeurs de disponibilité. Obligatoire pour les feuilles cubes uniquement.
Seules les colonnes dans lesquelles la disponibilité de la valeur peut être modifiée sont prises en charge.
Pour les colonnes de compte et de niveau de feuille cube, le nom de la colonne respecte les paramètres régionaux définis dans l’en-tête Accept-Language.
Y
columnCode
Le code de la colonne de la feuille à partir duquel extraire les valeurs de disponibilité. Obligatoire pour les feuilles modélisées uniquement.
Seules les colonnes dans lesquelles la disponibilité de la valeur peut être modifiée sont prises en charge.
Y
columnType
Le type de colonne pour la colonneName ou la colonneCode donnée.
Valeurs acceptées : compte, niveau, dimension, attribut
Y
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
limit
Le nombre maximum d’objets dans une seule réponse.
N
offset
L’index de zéro du premier objet dans une collection de réponses. La valeur par défaut est 0.
Utilisez la valeur de décalage avec le paramètre de limite pour contrôler la pagination d’une collection 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 un ensemble de disponibilités de valeurs.
Met à jour la disponibilité de toutes les valeurs dans une dimension de feuille.
URI de la demande exemple :
https://api.adaptiveplanning.com/api/rest/modeling/v1/globosales/sheet/availability?sheetName=ExpenseCube&columnName=Level&columnType=Level
En-tête de demande d’exemple :
Accepter la langue : en
Corps de la demande :
Tableau JSON d’objets de disponibilité, correspondant à la propriété data de l’exportation. Chaque objet JSON a la structure suivante :
Nom
Description
Obligatoire
code
Code de la valeur. Permet d’identifier les valeurs de façon unique.
Y
nom
Nom de la valeur.
Y
accountGroup
Si la valeur est un groupe de comptes. Obligatoire pour les comptes.
N
disponible
Que la valeur soit disponible ou non. Si cette option n’est pas présente, aucune modification n’est apportée.
N
deleteIfDataIsPresent
S’il faut supprimer les données le cas échéant. Obligatoire lors de la désactivation d’une valeur de dimension personnalisée sur des feuilles cubes.
N
actionIfDataIsPresent
L’action à effectuer lorsque des données existent. Obligatoire lors de la désactivation d’une valeur de dimension personnalisée sur des feuilles modélisées.
N
Corps de la demande d'exemple
Corps de la demande
 
[
    {
        "code": "SalesCube.DiscountPercent",
        "name": "Discount Percent",
        "accountGroup": false,
        "available": false
    }
]
Paramètres d'interrogation
Nom
Description
Obligatoire
sheetName
Le nom de la feuille à partir duquel récupérer les valeurs de disponibilité.
Y
columnName
le nom de la colonne de feuille à partir duquel extraire les valeurs de disponibilité. Obligatoire pour les feuilles cubes uniquement.
Seules les colonnes dans lesquelles la disponibilité de la valeur peut être modifiée sont prises en charge.
Pour les colonnes de compte et de niveau de feuille cube, le nom de la colonne respecte les paramètres régionaux définis dans l’en-tête Accept-Language.
Y
columnCode
Le code de la colonne de la feuille à partir duquel extraire la disponibilité. Obligatoire pour les feuilles modélisées uniquement.
Seules les colonnes dans lesquelles la disponibilité de la valeur peut être modifiée sont prises en charge.
Y
columnType
Le type de colonne pour la colonneName ou la colonneCode donnée.
Valeurs acceptées : compte, niveau, dimension, attribut.
Y
instanceCode
InstanceCode à partir de laquelle extraire des valeurs. Par exemple, GLOBO. Si aucune 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.