Référence : réorganiser les colonnes pour les API JSON modèles et de définition de feuille cube

Disponible uniquement pour

/definition

quand le paramètre de requête

reorderColumns

est vraie.

Exemple de demande

URI de la demande :

HTTPS://api.adaptiveplanning.com/api/rest/modeling/<version>/<tenant>/sheet/modeled/definition/?name=APIColumnsReorderTwo1660598383&reorderColumns=true

Création du corps de la demande	Demander la mise à jour du corps	Résultats attendus
{ "properties": { "prefix": "APIColumnsReorderTwo1660598383" }, "columns": [ { "properties": { "name": "Level", "type": "LEVEL" } }, { "properties": { "name": "TextOne", "code": "TextOne", "type": "TEXT" } }, { "properties": { "name": "TextTwo", "code": "TextTwo", "type": "TEXT" } }, { "properties": { "name": "TextThree", "code": "TextThree", "type": "TEXT" } }, { "properties": { "name": "TextFour", "code": "TextFour", "type": "TEXT" } }, { "properties": { "name": "TextFive", "code": "TextFive", "type": "TEXT" } } ] }	{ "properties": { "prefix": "APIColumnsReorderTwo1660598383" }, "columns": [ { "properties": { "name": "TextFour", "code": "TextFour", "type": "TEXT" } }, { "properties": { "name": "TextSix", "code": "TextSix", "type": "TEXT" } }, { "properties": { "name": "TextThree", "code": "TextThree", "type": "TEXT" } }, { "properties": { "name": "TextSeven", "code": "TextSeven", "type": "TEXT" } }, { "properties": { "name": "TextEight", "code": "TextEight", "type": "TEXT" } }, { "properties": { "name": "TextOne", "code": "TextOne", "type": "TEXT" } } ] }	Si reorderColumns a été false , nous nous attendrions à un ordre suivant après la mise à jour de la liste des colonnes : Périmètre TextOne TextTwo TextThree TextFour TextFive TextSix TextSeven TextEight Avec reorderColumns définir sur true , nous affichons à la place l'ordre suivant : Périmètre TextTwo TextFour TextSix TextThree TextSeven TextEight TextOne TextFive

Création du corps de la demande

Demander la mise à jour du corps

Résultats attendus

{
    "properties": {
        "prefix": "APIColumnsReorderTwo1660598383"
    },
    "columns": [
        {
            "properties": {
                "name": "Level",
                "type": "LEVEL"
            }
        },
        {
            "properties": {
                "name": "TextOne",
                "code": "TextOne",
                "type": "TEXT"
            }
        },
        {
            "properties": {
                "name": "TextTwo",
                "code": "TextTwo",
                "type": "TEXT"
            }
        },
        {
            "properties": {
                "name": "TextThree",
                "code": "TextThree",
                "type": "TEXT"
            }
        },
        {
            "properties": {
                "name": "TextFour",
                "code": "TextFour",
                "type": "TEXT"
            }
        },
        {
            "properties": {
                "name": "TextFive",
                "code": "TextFive",
                "type": "TEXT"
            }
        }
    ]
}

{
    "properties": {
        "prefix": "APIColumnsReorderTwo1660598383"
    },
    "columns": [
        {
            "properties": {
                "name": "TextFour",
                "code": "TextFour",
                "type": "TEXT"
            }
        },
        {
            "properties": {
                "name": "TextSix",
                "code": "TextSix",
                "type": "TEXT"
            }
        },
        {
            "properties": {
                "name": "TextThree",
                "code": "TextThree",
                "type": "TEXT"
            }
        },
        {
            "properties": {
                "name": "TextSeven",
                "code": "TextSeven",
                "type": "TEXT"
            }
        },
        {
            "properties": {
                "name": "TextEight",
                "code": "TextEight",
                "type": "TEXT"
            }
        },
        {
            "properties": {
                "name": "TextOne",
                "code": "TextOne",
                "type": "TEXT"
            }
        }
    ]
}

reorderColumns

a été

false

, nous nous attendrions à un ordre suivant après la mise à jour de la liste des colonnes :

Périmètre

TextOne

TextTwo

TextThree

TextFour

TextFive

TextSix

TextSeven

TextEight

Avec

reorderColumns

définir sur

true

, nous affichons à la place l'ordre suivant :

Périmètre

TextTwo

TextFour

TextSix

TextThree

TextSeven

TextEight

TextOne

TextFive

L'indicateur des colonnes de réorganisation peut être activé lors de la création d'une nouvelle feuille ou de la mise à jour d'une feuille existante.

Généralement, l'algorithme de réorganisation établira des priorités dans l'ordre des colonnes dans la demande API. Toutefois, en cas d' ambiguïté ou lorsqu'il traite des colonnes qui ne sont pas mentionnées par la demande, l'algorithme hiérarchise les colonnes telles qu'elles existaient déjà dans la feuille.

L'algorithme de réorganisation va déplacer les colonnes en arrière plutôt que de les faire avancer. Si deux colonnes changent de place (C, B), dans la pratique, l'algorithme déplace B après C, plutôt que déplacer C avant B. Ce problème est important lorsqu'il existe des colonnes entre B et C qui ne sont pas mentionnées dans la demande.