Passa al contenuto principale
Documentazione
Documentazione
Adaptive Planning
Ultimo aggiornamento: 2023-06-23
Disponibilità foglio

Disponibilità foglio

URL Endpoint

HTTPS://api.adaptiveinsights.com/api/rest/modeling/<version>/<tenant>/sheet/availability
Versione: v1
Categoria
Modifica dei metadati
Descrizione
Recuperare o aggiornare la disponibilità dei valori dimensione o attributo per un determinato foglio e colonna.
Autorizzazioni necessarie per il richiamo
Model Management Access
Model include: fogli, conti, dimensioni e formule
Parametri obbligatori su richiesta
sheetName, columnName

VERBI HTTP supportati

Verbo HTTP
Risorsa singola
Risorsa raccolta
Descrizione
GET
Non supportato
Supportato
Recuperare la disponibilità di tutti i valori per un determinato foglio e colonna.
POST
Non supportato
Supportato
Aggiornare la disponibilità dei valori per un determinato foglio e colonna.
OPZIONI
Supportato
Supportato
Restituisce l'elenco dei verbi HTTP supportati per questa risorsa di raccolta.

GET:

Richiesta:
/sheet/availability:
Recupera una raccolta di disponibilità valori.
Recupera la disponibilità di tutti i valori in una dimensione foglio. È possibile filtrare per instanceCode, sheetName e columnName.
URI richiesta di esempio:
HTTPS://api.adaptiveinsights.com/api/rest/modeling/v1/globosales/sheet/availability?sheetName=ExpenseCube&columnName=Level&columnType=Level
Intestazione richiesta di esempio:
Accept-Language: en
Esempio di corpo richiesta
Parametri query
Nome
Descrizione
Obbligatorio
sheetName
Il nome del foglio da cui recuperare i valori di disponibilità.
S
columnName
Il nome della colonna del foglio da cui recuperare i valori di disponibilità. Obbligatorio solo per i fogli cubo.
Sono supportate solo le colonne in cui è possibile modificare la disponibilità del valore.
Per le colonne dei conti e dei livelli del foglio cubo, il nome della colonna rispetta le impostazioni internazionali impostate nell'intestazione Accept-Language.
S
columnCode
Il codice della colonna del foglio da cui recuperare i valori di disponibilità. Obbligatorio solo per i fogli modellati.
Sono supportate solo le colonne in cui è possibile modificare la disponibilità del valore.
S
columnType
Il tipo di colonna per il columnName o il columnCode specificato.
Valori accettabili: conto, livello, dimensione, attributo
S
instanceCode
instanceCode da cui recuperare i valori. Ad esempio, GLOBO. Se non viene specificato instanceCode, viene utilizzata l'istanza predefinita dell'utente.
N
limit
Il numero massimo di oggetti in una singola risposta.
N
offset
Indice in base zero del primo oggetto in una raccolta di risposte. Il valore predefinito è 0.
Utilizzare l'offset con il parametro limit per controllare il paging di una raccolta di risposte.
N
Risposta di esempio
200
Risposta riuscita.
Risposta di esempio
 
{
    "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:

Richiesta:
/sheet/availability:
Aggiorna una raccolta di disponibilità valori.
Aggiorna la disponibilità di tutti i valori in una dimensione foglio.
URI richiesta di esempio:
https://api.adaptiveplanning.com/api/rest/modeling/v1/globosales/sheet/availability?sheetName=ExpenseCube&columnName=Level&columnType=Level
Intestazione richiesta di esempio:
Accept-Language: en
Corpo della richiesta:
Matrice JSON di oggetti di disponibilità, corrispondente alla proprietà "data" dell'esportazione. Ogni oggetto JSON ha la struttura seguente:
Nome
Descrizione
Obbligatorio
codice
Codice del valore Utilizzato per identificare in modo univoco i valori.
S
nome
Nome del valore.
S
accountGroup
Indica se il valore è un gruppo di conti. Obbligatorio per i conti.
N
disponibile
Se il valore è disponibile o meno. Se non è presente, non viene apportata alcuna modifica.
N
deleteIfDataIsPresent
Se eliminare i dati, se presenti. Obbligatorio quando si disabilita un valore dimensione personalizzata nei fogli cubo.
N
actionIfDataIsPresent
L'azione da eseguire quando sono presenti dati. Obbligatorio quando si disabilita un valore dimensione personalizzata nei fogli modellati.
N
Esempio di corpo richiesta
Corpo richiesta
 
[
    {
        "code": "SalesCube.DiscountPercent",
        "name": "Discount Percent",
        "accountGroup": false,
        "available": false
    }
]
Parametri query
Nome
Descrizione
Obbligatorio
sheetName
Il nome del foglio da cui recuperare i valori di disponibilità.
S
columnName
il nome della colonna del foglio da cui recuperare i valori di disponibilità. Obbligatorio solo per i fogli cubo.
Sono supportate solo le colonne in cui è possibile modificare la disponibilità del valore.
Per le colonne dei conti e dei livelli del foglio cubo, il nome della colonna rispetta le impostazioni internazionali impostate nell'intestazione Accept-Language.
S
columnCode
Il codice della colonna del foglio da cui recuperare la disponibilità. Obbligatorio solo per i fogli modellati.
Sono supportate solo le colonne in cui è possibile modificare la disponibilità del valore.
S
columnType
Il tipo di colonna per il columnName o il columnCode specificato.
Valori accettabili: conto, livello, dimensione, attributo.
S
instanceCode
instanceCode da cui recuperare i valori. Ad esempio, GLOBO. Se non viene specificato instanceCode, viene utilizzata l'estensione predefinita dell'utente.
N
Risposta di esempio:
204
La risposta corretta è vuota con codice di stato 204.