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

Beschikbaarheid blad

URL-eindpunt

HTTPS://api.adaptiveinsights.com/api/rest/modeling/<version>/<tenant>/sheet/availability
Versie: v1
Categorie
Metadata Modification
Omschrijving
De beschikbaarheid van dimensie- of kenmerkwaarden voor een bepaald blad en een bepaalde kolom op te halen of bij te werken.
Vereiste machtigingen voor aanroepen
Toegangsmodel voor modelbeheer
omvat: bladen, rekeningen, dimensies en formules
Vereiste parameters voor aanvraag
bladnaam, kolomnaam

Ondersteunde HTTP-werkwoord(en)

HTTP-werkwoord
Eén resource
Inningsresource
Omschrijving
GET
Niet ondersteund
Ondersteund
Haal de beschikbaarheid op van alle waarden voor een bepaald blad en een bepaalde kolom.
POST
Niet ondersteund
Ondersteund
Werk de beschikbaarheid van waarden voor een bepaald blad en een bepaalde kolom bij.
OPTIES
Ondersteund
Ondersteund
Retourneert de lijst met HTTP-werkwoorden die worden ondersteund voor deze verzamelingsresource.

GET:

Aanvraag:
/sheet/availability:
Hiermee wordt een verzameling van waardebeschikbaarheid opgehaald.
Haalt de beschikbaarheid op van alle waarden in een bladdimensie. U kunt filteren op instanceCode, sheetName en columnName.
Voorbeeldaanvraag-URI:
HTTPS://api.adaptiveinsights.com/api/rest/modeling/v1/globosales/sheet/availability?sheetName=ExpenseCube&columnName=Level&columnType=Level
Kop voorbeeldaanvraag:
Taal accepteren: en
Hoofdtekst voorbeeldaanvraag
Query Parameters
Naam
Omschrijving
Vereist
sheetName
De naam van het blad waaruit de beschikbaarheidswaarden moeten worden opgehaald.
J
columnName
De naam van de bladkolom waaruit de beschikbaarheidswaarden moeten worden opgehaald. Alleen vereist voor kubusbladen.
Alleen kolommen waarin de waarde voor beschikbaarheid kan worden gewijzigd, worden ondersteund.
Voor rekening- en niveaukolommen van kubusbladen respecteert de naam van de kolom de landinstelling die is ingesteld in de kop Taal accepteren.
J
columnCode
De code van de bladkolom waaruit de beschikbaarheidswaarden moeten worden opgehaald. Alleen vereist voor gemodelleerde bladen.
Alleen kolommen waarin de waarde voor beschikbaarheid kan worden gewijzigd, worden ondersteund.
J
columnType
Het type kolom voor de opgegeven columnName of columnCode.
Aanvaardbare waarden: rekening, niveau, dimensie, kenmerk
J
instanceCode
De instanceCode waaruit waarden moeten worden opgehaald. Bijvoorbeeld GLOBO. Als er geen instanceCode is opgegeven, wordt de standaardinstance van de gebruiker gebruikt.
N
limiet
Het maximum aantal objecten in één antwoord.
N
verschuiving
De op nul gebaseerde index van het eerste object in een antwoordverzameling. De standaardwaarde is 0.
Gebruik verschuiving met de parameter limiet om het paginering van een antwoordverzameling te beheren.
N
Voorbeeldantwoord:
200
Geslaagd antwoord.
Voorbeeldantwoord:
 
{
    "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:

Aanvraag:
/sheet/availability:
Hiermee wordt een verzameling waardebeschikbaarheid bijgewerkt.
Hiermee wordt de beschikbaarheid van alle waarden in een bladdimensie bijgewerkt.
Voorbeeldaanvraag-URI:
https://api.adaptiveplanning.com/api/rest/modeling/v1/globosales/sheet/availability?sheetName=ExpenseCube&columnName=Level&columnType=Level
Kop voorbeeldaanvraag:
Taal accepteren: en
Hoofdtekst van aanvraag:
JSON-matrix met beschikbaarheidsobjecten die overeenkomen met de eigenschap 'data' van de export. Elk JSON-object heeft de volgende structuur:
Naam
Omschrijving
Vereist
code
Code van de waarde. Wordt gebruikt om waarden op unieke wijze te identificeren.
J
Naam
Naam van de waarde.
J
accountGroup
Of de waarde een rekeninggroep is. Vereist voor rekeningen.
N
beschikbaar
Of de waarde beschikbaar is of niet. Als deze niet aanwezig is, wordt er geen wijziging aangebracht.
N
deleteIfDataIsPresent
Of de gegevens moeten worden verwijderd, indien aanwezig. Vereist wanneer u een aangepaste dimensiewaarde op kubusbladen uitschakelt.
N
actionIfDataIsPresent
De actie die moet worden uitgevoerd wanneer er gegevens aanwezig zijn. Vereist bij het uitschakelen van een aangepaste dimensiewaarde op gemodelleerde bladen.
N
Hoofdtekst voorbeeldaanvraag
Hoofdtekst van aanvraag
 
[
    {
        "code": "SalesCube.DiscountPercent",
        "name": "Discount Percent",
        "accountGroup": false,
        "available": false
    }
]
Query Parameters
Naam
Omschrijving
Vereist
sheetName
De naam van het blad waaruit de beschikbaarheidswaarden moeten worden opgehaald.
J
columnName
de naam van de bladkolom waaruit de beschikbaarheidswaarden moeten worden opgehaald. Alleen vereist voor kubusbladen.
Alleen kolommen waarin de waarde voor beschikbaarheid kan worden gewijzigd, worden ondersteund.
Voor rekening- en niveaukolommen van kubusbladen respecteert de naam van de kolom de landinstelling die is ingesteld in de kop Taal accepteren.
J
columnCode
De code van de bladkolom waaruit de beschikbaarheid moet worden opgehaald. Alleen vereist voor gemodelleerde bladen.
Alleen kolommen waarin de waarde voor beschikbaarheid kan worden gewijzigd, worden ondersteund.
J
columnType
Het type kolom voor de opgegeven columnName of columnCode.
Aanvaardbare waarden: rekening, niveau, dimensie, kenmerk.
J
instanceCode
De instanceCode waaruit waarden moeten worden opgehaald. Bijvoorbeeld GLOBO. Als er geen instanceCode is opgegeven, wordt de standaardinstance van de gebruiker gebruikt.
N
Voorbeeldantwoord:
204
Geslaagd antwoord is leeg met statuscode 204.