概念: JSON 形式の API

JSON リクエスト

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)