Concept: API's met JSON-indeling

JSON-aanvragen

HTTP-werkwoord of -methode.
Voorbeeld:
GET
,
PUT
, of
PATCH
URL-eindpunt.
Als uw instance gebruikmaakt van niet op de VS gebaseerde regionale verificatie, verschillen uw autorisatie-URL's en API-eindpunten op basis van uw regio. Zie Referentie: regionale verificatie-URL's.
Voorbeeld:
HTTPS://api.adaptiveplanning.com/api/rest/modeling/v1/globosales/sheet/availability
Autorisatiekop
Voorbeeld:
--header 'Authorization: Basic c5RldmVjQLdsb2JvLmNabTpjaGFuZ2VtZQ=='

HTTP-werkwoorden of -methoden

URL-eindpunt

service name
Een componentnaam, op basis van functionaliteit zoals
modeling
, of
security
.
version
De versie van de service. Huidige versie voor alle services:
v1
.
tenant
De tenant voor deze service, die de Adaptive Planning-instance aangeeft. Gebruiken
default
voor de standaardinstance van de gebruiker in de autorisatie.
resource path
Het pad naar de resource, met behulp van zelfstandige naamwoorden zoals
sheet
and
availability
. Het pad ondersteunt ook queryparameters, zoals:
sheetName
om de naam van een blad in Adaptive Planning op te geven.
columnName
om de naam van een kolom in een Adaptive Planning-blad op te geven.
limit
om de limiet voor objectgegevensinvoer in één antwoord op te geven.
offset
om de verschuiving op te geven voor het eerste object in een verzameling dat in het antwoord moet worden opgenomen.

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

Voorbeeld: POST-aanvraag met JSON-hoofdtekst

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
        }
]'

Inningen

Voorbeeldaanvraag met limiet en tegenboeking

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

Voorbeeldantwoord met limiet en verschuiving

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


 

Referentietypen, verificatie en autorisatie

Basisverificatie

Verificatie op basis van tokens (TBA)