Zum Hauptinhalt wechseln
Dokumentation
Dokumentation
Adaptive Planning
Zuletzt aktualisiert: 2023-06-23
Tabellenblatt-Verfügbarkeit

Tabellenblatt-Verfügbarkeit

URL-Endpunkt

HTTPS://api.adaptiveinsights.com/api/rest/modeling/<version>/<tenant>/sheet/availability
Version: v1
Kategorie
Metadatenänderung
Beschreibung
Rufen Sie die Verfügbarkeit von Dimensionen oder Attributwerten für ein bestimmtes Tabellenblatt und eine bestimmte Spalte ab oder aktualisieren Sie sie.
Zum Aufrufen sind Berechtigungen erforderlich
Zugriff auf Modellmanagement:
Modell beinhaltet: Tabellenblätter, Konten, Dimensionen und Formeln
Auf Anforderung erforderliche Parameter
sheetName, columnName

Unterstützte HTTP-VERB(s)

HTTP Verb
Einzelressource
Einzugsressource
Beschreibung
GET
Nicht unterstützt
Unterstützt
Rufen Sie die Verfügbarkeit aller Werte für ein bestimmtes Tabellenblatt und eine bestimmte Spalte ab.
POST
Nicht unterstützt
Unterstützt
Aktualisieren Sie die Verfügbarkeit von Werten für ein bestimmtes Tabellenblatt und eine bestimmte Spalte.
OPTIONEN
Unterstützt
Unterstützt
Gibt die Liste der für diese Erfassungsressource unterstützten HTTP-Verben zurück.

GET:

Anfrage:
/sheet/availability:
Ruft eine Sammlung der Wertverfügbarkeit ab.
Ruft die Verfügbarkeit aller Werte in einer Tabellenblattdimension ab. Sie können nach instanceCode, sheetName und columnName filtern.
Beispiel für eine Anforderungs-URI:
HTTPS://api.adaptiveinsights.com/api/rest/modeling/v1/globosales/sheet/availability?sheetName=ExpenseCube&columnName=Level&columnType=Level
Beispiel für Anforderungs-Header:
Accept-Language: en
Beispielanforderungstext
Abfrageparameter
Name
Beschreibung
Erforderlich
sheetName
Der Name des Tabellenblatts, aus dem Verfügbarkeitswerte abgerufen werden sollen.
J
columnName
Der Name der Tabellenblattspalte, aus der Verfügbarkeitswerte abgerufen werden sollen. Nur für Cube-Tabellenblätter erforderlich.
Es werden nur Spalten unterstützt, in denen die Wertverfügbarkeit geändert werden kann.
Bei Konto- und Ebenenspalten in Cube-Tabellenblättern entspricht der Name der Spalte dem Gebietsschema, das im Accept-Language-Header festgelegt wurde.
J
columnCode
Der Code der Tabellenblattspalte, aus der Verfügbarkeitswerte abgerufen werden sollen. Nur für modellierte Tabellenblätter erforderlich.
Es werden nur Spalten unterstützt, in denen die Wertverfügbarkeit geändert werden kann.
J
columnType
Die Art der Spalte für den angegebenen columnName oder columnCode.
Zulässige Werte: Konto, Ebene, Dimension, Attribut
J
instanceCode
instanceCode, aus dem Werte abgerufen werden sollen. Beispiel: GLOBO. Wenn kein instanceCode angegeben wird, wird die Standardinstanz des Benutzers verwendet.
N
limit
Die maximale Anzahl von Objekten in einer einzelnen Antwort.
N
offset
Der 0-basierte Index des ersten Objekts in einer Antwortauflistung. Der Standardwert ist 0.
Verwenden Sie Offset mit dem Grenzwert-Parameter, um das Paging einer Antworterfassung zu steuern.
N
Beispielantwort
200
Erfolgreiche Antwort.
Beispielantwort
 
{
    "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:

Anfrage:
/sheet/availability:
Aktualisiert eine Sammlung von Wertverfügbarkeiten.
Aktualisiert die Verfügbarkeit aller Werte in einer Tabellenblattdimension.
Beispiel für eine Anforderungs-URI:
https://api.adaptiveplanning.com/api/rest/modeling/v1/globosales/sheet/availability?sheetName=ExpenseCube&columnName=Level&columnType=Level
Beispiel für Anforderungs-Header:
Accept-Language: en
Anforderungstext:
JSON-Array von Verfügbarkeitsobjekten, das mit der Eigenschaft "data" des Exports übereinstimmt. Jedes JSON-Objekt hat die folgende Struktur:
Name
Beschreibung
Erforderlich
-Code
Code des Werts. Wird verwendet, um Werte eindeutig zu identifizieren.
J
Name
Name des Werts.
J
accountGroup
Ob der Wert eine Kontogruppe ist Erforderlich für Konten.
N
verfügbar
Ob der Wert verfügbar ist oder nicht. Wenn nicht vorhanden, wird keine Änderung vorgenommen.
N
deleteIfDataIsPresent
Ob die Daten gelöscht werden sollen, falls vorhanden. Erforderlich, wenn ein benutzerdefinierter Dimensionswert in Cube-Tabellenblättern deaktiviert werden soll.
N
actionIfDataIsPresent
Die Aktion, die ausgeführt werden soll, wenn Daten vorhanden sind. Erforderlich, wenn ein benutzerdefinierter Dimensionswert in modellierten Tabellenblättern deaktiviert wird.
N
Beispielanforderungstext
Anforderungstext
 
[
    {
        "code": "SalesCube.DiscountPercent",
        "name": "Discount Percent",
        "accountGroup": false,
        "available": false
    }
]
Abfrageparameter
Name
Beschreibung
Erforderlich
sheetName
Der Name des Tabellenblatts, aus dem Verfügbarkeitswerte abgerufen werden sollen.
J
columnName
Der Name der Tabellenblattspalte, aus der Verfügbarkeitswerte abgerufen werden sollen. Nur für Cube-Tabellenblätter erforderlich.
Es werden nur Spalten unterstützt, in denen die Wertverfügbarkeit geändert werden kann.
Bei Konto- und Ebenenspalten in Cube-Tabellenblättern entspricht der Name der Spalte dem Gebietsschema, das im Accept-Language-Header festgelegt wurde.
J
columnCode
Der Code der Tabellenblattspalte, aus der die Verfügbarkeit abgerufen werden soll. Nur für modellierte Tabellenblätter erforderlich.
Es werden nur Spalten unterstützt, in denen die Wertverfügbarkeit geändert werden kann.
J
columnType
Die Art der Spalte für den angegebenen columnName oder columnCode.
Zulässige Werte: Konto, Ebene, Dimension, Attribut.
J
instanceCode
instanceCode, aus dem Werte abgerufen werden sollen. Beispiel: GLOBO. Wenn kein instanceCode angegeben wird, wird die Standardinstanz des Benutzers verwendet.
N
Beispielantwort:
204
Erfolgreiche Antwort ist leer mit Statuscode 204.