Skip to main content
Documentatie
Documentatie
Adaptive Planning
Laatst bijgewerkt: 2023-06-23
Dimensiewaarden

Dimensiewaarden

Versie: v1

Ondersteunde HTTP-werkwoord(en)

HTTP-werkwoord
Omschrijving
POST
Alle bestaande ongebruikte dimensiewaarden verwijderen (dimensiewaarden in gebruik worden genegeerd).

POST:

Aanvraag:
/removeDimensionValues
Met de opgegeven dimensienaam en lijst met dimensiewaardecodes worden de bijbehorende dimensiewaarden verwijderd.
Voorbeeldaanvraag-URI:
https://api.adaptiveplanning.com/api/rest/modeling/v1/globosales/accounts/removeDimensionValues
of
https://api.adaptiveplanning.com/api/rest/modeling/v1/globosales/accounts/removeDimensionValues?doValidateOnly=true&&showWarnings=true
Kop voorbeeldaanvraag:
Autorisatie: basis
Type inhoud: application/json
Hoofdtekst voorbeeldaanvraag
Voorbeeld van POST-aanvraag
 
[
    {
        "dimensionName": "Dim1",
        "dimensionValueCodes": [
            "dimensionValueCode100"
        ]
    },
    {
        "dimensionName": "Dim2",
        "dimensionValueCodes": [
            "dimensionValueCode102",
            "dimensionValueCode103"
        ]
    },
    {
        "dimensionName": "Dim3",
        "dimensionValueCodes": [
            "dimensionValueCode104",
            "dimensionValueCode105",
            "dimensionValueCode106",
            "dimensionValueCode107"
            "dimensionValueCode108",
            "dimensionValueCode109"
        ]
    }
]
Payload Parameters
Naam
Omschrijving
Vereist
dimensieName
Dimensienaam.
J
dimensionValueCodes
Lijst met alle dimensiewaardecodes die moeten worden verwijderd.
J
Path Parameter
Naam
Omschrijving
Vereist
tenant
Tenant om op te werken. bijv. globosales
J
Query Parameters
Naam
Omschrijving
Vereist
Standaard
doValidateOnly
Verwerk de aanvraag in de validatiemodus, wat betekent dat de wijzigingen niet in de database worden bewaard.
N
false
Waarschuwingen weergeven
Lijst met waarschuwingen achter elke dimensiewaarde die wordt genegeerd of die niet kan worden verwijderd.
N
false
Voorbeeldantwoord:
200 OK
Geslaagd antwoord.
{
"total": 5
}
Geslaagd antwoord met waarschuwingen.
{
"total": 5,
"warning": {
"info": "Some dimension values were not deleted.",
"warnings": [
{
"field": "TEST-67",
"warning": "Dimension value isn't available for deletion."
},
{
"field": "TEST-5",
"warning": "In-use dimension values cannot be deleted."
}
]
}
}
Ongeldige aanvraag 400
De aanvraag kan niet worden begrepen door de server.
401 Niet geautoriseerd
Gebruiker is niet geautoriseerd.
403 Forbidden
Gebruiker heeft onvoldoende machtigingen.
Interne serverfout 500
Interne serverfout.