주 컨텐츠로 이동
문서
문서
Adaptive Planning
최종 업데이트: 2024-03-08
그룹

그룹

URL 엔드포인트

HTTPS://api.adaptiveplanning.com/api/rest/security/<version>/<tenant>/groups/{groupID}
버전: v1
카테고리
메타데이터 검색
설명
지정된 인스턴스에 대해 정의된 모든 그룹의 전체 목록을 반환합니다. 여기에는 전체 인스턴스에서 글로벌로 정의된 그룹과 사용자가 정의한 그룹이 포함됩니다.
호출에 필요한 권한
관리자 액세스 > 사용자
요청 시 필수 매개변수
자격증명

지원되는 HTTP 동사

HTTP Verb
단일 리소스
수금 리소스
설명
GET
지원
지원
계획에서 그룹을 검색합니다.

GET:

요청:
/groups/{groupId}
지정된 인스턴스에 대해 정의된 모든 그룹 및 해당 사용자/구성원의 목록을 검색합니다.
샘플 요청 URI:
HTTPS://api.adaptiveplanning.com/api/rest/security/v1/default/groups?instanceCode=globalsales&offset=2&limit=1
샘플 요청 헤더:
Accept-Language: ko
샘플 요청 본문
쿼리 매개변수
이름
설명
필수
groupId
개별적으로 반환할 그룹의 ID입니다.
아니요
includeUsers
호출 중인 그룹의 사용자를 반환할지 여부를 결정합니다. 사용자 포함은 기본적으로 설정되어 있습니다.
아니요
limit
단일 응답의 최대 오브젝트 수입니다.
아니요
offset
페이지당 특정 수의 그룹을 표시합니다. 그룹이 한도를 초과하면 추가 그룹이 다음 페이지로 이동합니다. 특정 페이지에 액세스하려면 오프셋 값을 지정해야 합니다.
아니요
instanceCode
기본적으로 지정된 기본 인스턴스 사용자를 반환합니다. 값을 제공하면 parent/child 인스턴스를 포함하여 사용자가 액세스할 수 있는 인스턴스를 호출할 수 있습니다.
아니요
샘플 응답
샘플 응답
 
{
   "links": {
       "next": "HTTPS://api.adaptiveplanning.com/api/rest/security/v1/default/groups?instanceCode=TENANT&offset=2&limit=1",
       "previous": "HTTPS://api.adaptiveplanning.com/api/rest/security/v1/default/groups?instanceCode=TENANT&offset=0&limit=1"
   },
   "total": 3,
   "groups": [
       {
           "id": 2,
           "name": "Admins",
           "groupType": "NATIVE",
           "users": [
               {
                   "userGuid": "randomValue",
                   "wid": "",
                   "userName": "test@email.com"
               },
               {
                   "userGuid": "randomValue",
                   "wid": "",
                   "userName": "test2@email.com"
               },
           ]
       },
       {
           "id": 1,
           "name": "Corporate and Operations",
           "groupType": "NATIVE",
           "users": []
       },
       {
           "id": 3,
           "name": "Ops and Admins",
           "groupType": "NATIVE",
           "users": [],
           "groups": [
               {
                   "id": 2,
                   "name": "Admins",
                   "groupType": "NATIVE"
               },
               {
                   "id": 1,
                   "name": "Corporate and Operations",
                   "groupType": "NATIVE"
               }
           ]
       }
   ]
}
응답 요소
태그명
응답
요소의 특성
특성명
필수
값
예:
합계
예
총 그룹 수
3
개 그룹
예
모든 그룹 또는 지정된 그룹의 그룹 정보 그룹이 다른 그룹 내에 있는 경우 지정된 그룹과 연결된 그룹도 표시됩니다.
{
"id": 1,
"name": "Corporate and Operations",
"groupType": "NATIVE",
"users": []
}
groupType
예
그룹 유형을 표시합니다.
외부
ID
예
그룹의 연결된 ID입니다.
1
이름
예
그룹의 이름입니다.
"Admins"
명의 사용자
아니요
includeUsers가 true이거나 includeUsers가 기본값인 경우 사용자의 GUID, wid 및 사용자명과 함께 제공됩니다. 그렇지 않은 경우 반환되지 않습니다.
"users": [
{
"userGuid": "randomValue",
"wid": "",
"userName": "test@example.com"
},
{
"userGuid": "randomValue",
"wid": "",
"userName": "test2@example.com"
}
링크
아니요
한도 및/또는 오프셋이 제공되고 그룹의 다른 페이지로 이동할 수단이 필요한 경우 링크를 사용하여 앞뒤로 이동할 수 있습니다.
"links": {
"next": "HTTPS://api.adaptiveplanning.com/api/rest/security/v1/default/groups?instanceCode=TENANT&offset=2&limit=1",
"previous": "HTTPS://api.adaptiveinsights.com/api/rest/security/v1/default/groups?instanceCode=TENANT&offset=0&limit=1"
}
다음
아니요
한도가 제공되고 사용가능한 다음 페이지가 있으면 '링크'가 '다음'과 함께 표시됩니다.
"HTTPS://api.adaptiveplanning.com/api/rest/security/v1/default/groups?instanceCode=TENANT&offset=2&limit=1"
이전
아니요
한도 및 오프셋이 제공되고 이전 및 추가 페이지를 사용할 수 있는 중간에 있는 경우 '이전'을 사용할 수 있습니다.
"HTTPS://api.adaptiveplanning.com/api/rest/security/v1/default/groups?instanceCode=TENANT&offset=2&limit=1"
요소의 콘텐츠
표시된 요소와 관련된 정보입니다.
오류 응답
오류
원인
한도 및 오프셋에 대해 올바른 매개변수 값을 지정하십시오.
한도/오프셋 값에 대한 잘못된 입력
GroupAPI: getGroupByGroupId에 대해 인스턴스 코드 {TENANT}에 대한 그룹을 찾을 수 없습니다.
인스턴스 코드에 대한 groupId가 없습니다.
이 API: 글로벌 사용자 그룹 관리를 실행할 수 있는 모든 권한이 없습니다.
사용자 자격증명에 API 호출을 호출할 수 있는 적절한 권한이 없습니다.
잘못된 자격증명
사용된 자격증명이 올바르지 않습니다.
HTTP 404를 찾을 수 없음
groupId 매개변수가 잘못되었습니다.