Concetto: API formattate JSON

Richieste JSON

Verbo o metodo HTTP
Esempio:
GET
,
PUT
o
PATCH
Endpoint URL
Se l'istanza utilizza un'autenticazione regionale non statunitense, gli URL di autorizzazione e gli endpoint API variano in base all'area geografica. Consultare Riferimenti: URL di autenticazione internazionali.
Esempio:
HTTPS://api.adaptiveplanning.com/api/rest/modeling/v1/globosales/sheet/availability
Intestazione autorizzazione
Esempio:
--header 'Authorization: Basic c5RldmVjQLdsb2JvLmNabTpjaGFuZ2VtZQ=='

Verbi o metodi HTTP

Endpoint URL

service name
Un nome del componente, basato su funzionalità come
modeling
o
security
.
version
La versione del servizio. Versione corrente per tutti i servizi:
v1
.
tenant
Il tenant per questo servizio, che indica l'istanza di Adaptive Planning. Utilizzare
default
per l'istanza predefinita dell'utente nell'autorizzazione.
resource path
Il percorso della risorsa, utilizzando nomi come
sheet
e
availability
. Il percorso supporta anche i parametri di query, ad esempio:
sheetName
per specificare il nome di un foglio in Adaptive Planning.
columnName
per specificare il nome di una colonna in un foglio di Adaptive Planning.
limit
per specificare il limite di voci di dati oggetto incluse in una singola risposta.
offset
per specificare lo scostamento rispetto al primo oggetto di una raccolta da includere nella risposta.

https://api.adaptiveplanning.com/api/rest/modeling/v1/globosales/sheet/availability?sheetName=Expense Cube&columnName=Level&columnType=Level

Esempio: richiesta POST con corpo JSON

curl --location --request POST 'https://api.adaptiveplanning.com/api/rest/modeling/v1/default/sheet/availability?sheetName=Sales Cube&columnName=account&columnType=Account' \
--header 'Authorization: Basic c5RldmVjQLdsb2JvLmNabTpjaGFuZ2VtZQ==' \
--header 'Content-Type: application/json' \
--data-raw '[
        {
            "name": "Discount Percent",
            "code": "SalesCube.DiscountPercent",
            "accountGroup": false,
            "available": true
        }
]'

Raccolte

Richiesta di esempio con limite e compensazione

@GET 
@PATH("/users/instances?instanceCode=GLOBO&limit=20&offset=0")  
@Produces(MediaType.APPLICATION_JSON)    
public List<User> getUsers(@PathParam("instanceCode") String instanceCode,@PathParam("limit")int limit,@PathParam("offset")int offset)

Risposta di esempio con limite e compensazione

{
    "total": 25,
    "link": {
        "next": "https://api.adaptiveplanning.com/api/rest/security/v1/default/users/instances?instanceCode=GLOBO&offset=4&limit=2",
        "previous": "https://api.adaptiveplanning.com/api/rest/security/v1/default/users/instances?instanceCode=GLOBO&offset=0&limit=2"
    },
    "users": [
        {
            "userId": 14,
            "userGuid": "474C4F424F000000000000000100000E",
            "userName": "asiaboss@globo.com",
            "instances": [
                {
                    "code": "GLOBO",
                    "default": true
                }
            ]
        },
        {
            "userId": 21,
            "userGuid": "474C4F424F0000000000000001000015",
            "userName": "Bob@globo.com",
            "instances": [
                {
                    "code": "GLOBOSALES"
                },
                {
                    "code": "GLOBOSUB"
                },
                {
                    "code": "GLOBO",
                    "default": true
                }
            ]
        }
    ]
}
 
 
Note:
-Default offset = 0 and limit = 500
 


 

Tipi di credenziali, autenticazione e autorizzazione

Autenticazione di base

Autenticazione basata su token (TBA)