Concept : API au format JSON

Demandes JSON

Méthode HTTP ou processus HTTP.
Exemple :
GET
,
PUT
, ou
PATCH
Point de terminaison de l’adresse URL.
Si votre instance utilise une authentification régionale qui n’est pas fondée sur les États-Unis, les adresses URL d’autorisation et les points de terminaison d’API varient en fonction de votre région. Voir : Référence : URL d’authentification régionales.
Exemple :
HTTPS://api.adaptiveplanning.com/api/rest/modeling/v1/globosales/sheet/availability
En-tête de l'autorisation
Exemple :
--header 'Authorization: Basic c5RldmVjQLdsb2JvLmNabTpjaGFuZ2VtZQ=='

Réponses ou méthodes HTTP

Point de terminaison de l'adresse URL

service name
Un nom de composante, fondé sur une fonctionnalité comme
modeling
, ou
security
.
version
La version du service. Version actuelle pour tous les services :
v1
.
tenant
Le locataire de ce service, indiquant l'instance Adaptive Planning. Utilisation
default
pour l’instance par défaut de l’utilisateur dans l’autorisation.
resource path
Le chemin d’accès à la ressource, avec des noms comme
sheet
Et
availability
. Le chemin prend également en charge des paramètres d’interrogation, tels que :
sheetName
pour préciser le nom d'une feuille dans Adaptive Planning.
columnName
pour préciser le nom d'une colonne dans une feuille Adaptive Planning.
limit
pour préciser la limite des entrées de données d’objets incluses dans une seule réponse.
offset
pour préciser le décalage par rapport au premier objet d’une collection à inclure dans la réponse.

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

Exemple : demande POST avec corps 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
        }
]'

Collections

Demande d'exemple avec limite et décalage

@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)

Exemple de réponse avec limite et décalage

{
    "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
 


 

Types de données d’identification, authentification et autorisation

Authentification de base

Authentification par jeton