概念：JSON 格式的 API

JSON Requests

HTTP 谓词或方法
示例：
GET
、
PUT
、或
PATCH
URL 端点。
如果您的实例使用的不是基于美国的区域身份验证，则您的授权 URL 和 API 端点会因您所在的区域而异。请参见 参考信息：区域身份验证 URL。
示例：
HTTPS://api.adaptiveplanning.com/api/rest/modeling/v1/globosales/sheet/availability
授权标头
示例：
--header 'Authorization: Basic c5RldmVjQLdsb2JvLmNabTpjaGFuZ2VtZQ=='

HTTP 谓词或方法

URL 端点

service name
组件名称，基于以下功能：
modeling
、或
security
。
version
服务的版本。所有服务的当前版本：
v1
。
tenant
此服务的租户，表示 Adaptive Planning 实例。用途
default
作为授权中用户的默认实例。
resource path
资源的路径，使用类似名词
sheet
和
availability
。该路径还支持查询参数，例如：
sheetName
以指定 Adaptive Planning 中工作表的名称。
columnName
以指定 Adaptive Planning 工作表中的列名称。
limit
以指定单个响应中包含的对象数据条目的限制。
offset
以指定要在响应中包括的集合中第一个对象的偏移量。

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

示例：使用 JSON 正文的 POST 请求

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

收款

包含限额和抵销的申请示例

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

包含限额和抵销的回复示例

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


 

凭据类型、身份验证和授权

基本身份验证

基于令牌的身份验证 (TBA)