Konzept: Mit JSON formatierte APIs

JSON-Anforderungen

HTTP-Verb oder -Methode.
Beispiel:
GET
,
PUT
oder
PATCH
URL- Endpunkt.
Abhängig vom Standort Ihrer Adaptive Planning Instanz können Ihre Autorisierungs-URLs und API-Endpunkte variieren. Weitere Informationen finden Sie unterURLs und IP-Adressen für die Adaptive Planning Authentifizierung .
Beispiel:
HTTPS://api.adaptiveplanning.com/api/rest/modeling/v1/globosales/sheet/availability
Autorisierungs-Header
Beispiel:
--header 'Authorization: Basic c5RldmVjQLdsb2JvLmNabTpjaGFuZ2VtZQ=='

HTTP-Verben oder -Methoden

URL-Endpunkt

service name
Einen Komponente , der auf Funktionalität wie basiert
modeling
oder
security
.
version
Die Version des Service. Aktuelle Version für alle Services:
v1
.
tenant
Der Mandant für diesen Service, indem Sie die Adaptive Planning Instanz angeben. Verwenden
default
für die Instanz des Benutzers in der Autorisierung.
resource path
Der Pfad zur Ressource unter Verwendung von Nomen wie
sheet
und
availability
. Der Pfad unterstützt auch Abfrage , z. B.:
sheetName
, um den Namen eines Tabellenblatt in Adaptive Planning anzugeben.
columnName
, um den Namen einer Spalte in einem Tabellenblatt aus Adaptive Planning anzugeben.
limit
um den Grenzwert für die in einer einzelnen Antwort enthaltenen Objektdateneingaben anzugeben.
offset
, um den Zeitversatz zum ersten Objekt in einer Sammlung anzugeben, das in die Antwort aufgenommen werden soll.

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

Beispiel: POST-Anforderung mit JSON-Text

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

Einzug

Beispielanforderung mit Grenzwert und Zeitversatz

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

Beispielantwort mit Grenzwert und Zeitversatz

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


 

Zugangsdatenarten, Authentifizierung und Autorisierung

Einfache Authentifizierung

Token-basierte Authentifizierung (TBA)