Concepto: API con formato JSON

Solicitudes JSON

Verbo o método HTTP.
Ejemplo:
GET
,
PUT
o
PATCH
Punto final de URL
Si su instancia utiliza autenticación regional fuera de EE. UU., las URL de autorización y los puntos finales de API variarán en función de su región. Consulte Referencia: URL de autenticación regional.
Ejemplo:
HTTPS://api.adaptiveplanning.com/api/rest/modeling/v1/globosales/sheet/availability
Cabecera de autorización
Ejemplo:
--header 'Authorization: Basic c5RldmVjQLdsb2JvLmNabTpjaGFuZ2VtZQ=='

Verbos o métodos HTTP

Punto final de URL

service name
Un nombre de componente, basado en una funcionalidad como
modeling
o
security
.
version
La versión del servicio. Versión actual para todos los servicios:
v1
.
tenant
El entorno de cliente de este servicio, que indica la instancia de Adaptive Planning. Utilizar
default
para la instancia por defecto del usuario en la autorización.
resource path
La ruta al recurso, utilizando nombres como
sheet
y
availability
. La ruta también admite parámetros de consulta, como:
sheetName
para especificar el nombre de una hoja en Adaptive Planning.
columnName
para especificar el nombre de una columna en una hoja de Adaptive Planning.
limit
para especificar el límite de entradas de datos de objeto incluidas en una sola respuesta.
offset
para especificar el desplazamiento del primer objeto de una colección para incluirlo en la respuesta.

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

Ejemplo: solicitud POST con cuerpo 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
        }
]'

Cobros

Solicitud de muestra con límite y compensación

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

Respuesta de muestra con límite y compensación

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


 

Tipos de credenciales, autenticación y autorización

Autenticación básica

Autenticación basada en token (TBA)