개념: JSON 형식의 API

JSON 요청

HTTP Verb 또는 메서드
예:
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)