Concept : API au format JSON

Demandes JSON

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

Méthodes ou Actions HTTP

Point de terminaison de l'URL

service name
Un nom de composant, basé sur une fonctionnalité comme
modeling
, ou
security
.
version
Version du service. Version actuelle pour tous les services :
v1
.
tenant
Environnement client de ce service, indiquant l'instance Adaptive Planning. Utiliser
default
pour l'instance par défaut de l'utilisateur dans l'autorisation.
resource path
Le chemin d'accès à la ressource, en utilisant des noms tels que
sheet
et
availability
. Le chemin prend également en charge les paramètres de requête, comme :
sheetName
pour indiquer le nom d'une feuille dans Adaptive Planning.
columnName
pour indiquer le nom d'une colonne dans une feuille Adaptive Planning.
limit
pour spécifier le nombre maximum d'entrées de données d'objets incluses dans une seule réponse.
offset
pour spécifier le décalage du premier objet d'un recouvrement à inclure dans la réponse.

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

Exemple : POST Request avec le 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 contrepartie

@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 d'identifiant, authentification et autorisation

Authentification de base

Authentification par jeton (TBA)