exportGroups
카테고리
| 메타데이터 검색 |
설명
| 지정된 인스턴스에 대해 정의된 모든 그룹의 전체 목록을 반환합니다. 여기에는 전체 인스턴스에서 글로벌로 정의된 그룹과 사용자가 정의한 그룹이 포함됩니다. |
호출에 필요한 권한
| 사용자 관리자 |
요청 시 필수 매개변수
| 자격증명 |
이 메서드의 요청에는 호출 사용자를 식별하고 권한을 부여하는 자격증명 태그만 포함되어 있습니다. 확인되면 이 메서드는 인스턴스에 정의된 모든 그룹의 전체 세트를 설명하는 XML 문서를 반환합니다.
요청 형식
<?xml version='1.0' encoding='UTF-8'?> <call method="exportGroups" callerName="a string that identifies your client application"> <credentials login="sampleuser@company.com" password="my_password"/> </call>
자격증명 요소
| |||
태그명
| 자격증명 | ||
설명
| 모든 API 호출에는 API를 호출하는 사용자를 식별하는 단일 자격증명 요소가 포함되어야 합니다. 그러면 이 사용자로 API 호출이 수행됩니다(시스템의 모든 감사 추적 또는 액션 이력에 이 사용자가 액션을 수행했음이 표시됨). 따라서 사용자에게 액션을 수행하는 데 필요한 권한이 있어야 API 호출이 성공 | ||
요소의 특성
| |||
특성명
| 필수
| 값
| 예:
|
로그인 | 예 | API 메서드를 호출하는 사용자의 로그인명입니다. 이 사용자는 메서드를 호출하는 데 필요한 권한이 있어야 합니다. | sampleuser@company.com |
비밀번호 | 예 | API 메서드를 호출하는 사용자의 비밀번호입니다. | my_password |
로케일 | 아니요 | 수신 숫자 및 날짜를 해석하고 보내는 숫자 및 날짜의 형식을 지정하는 데 사용할 로케일을 지정합니다(적절한 천 단위 구분 기호, 월명 및 날짜 서식 사용). 로케일은 응답의 시스템 메시지에 사용할 언어를 지정하는 데도 사용됩니다. 지정하지 않으면 en_US(미국식 영어)가 사용됩니다. | fr_FR |
instanceCode | 아니요 | 자격증명에 지정된 사용자가 의 두 개 이상의 인스턴스에 액세스할 수 있는지 여부 Adaptive Planning 인 경우 이 속성을 사용하여 사용자가 기본 인스턴스가 아닌 다른 인스턴스에 액세스하려고 함을 지정할 수 있습니다. 지정하지 않으면 사용자의 기본 인스턴스가 사용됩니다. 사용가능한 인스턴스 코드를 확인하려면 exportInstances API를 사용합니다. | MYINSTANCE1 |
요소의 콘텐츠
| |||
(없음) | |||
응답 형식
<?xml version="1.0" encoding="UTF-8"?> <response success="true"> <output> <groups> <group id="1" name="Corporate and Operations" isGlobal="true"/> <group id="2" name="Admins" isGlobal="true"/> <group id="3" name="Ops and Admins" isGlobal="true"/> <group id="4" name="My group" isGlobal="false" ownerId="3"/> </groups> </output> </response>
응답 요소
| |||
태그명
| 응답 | ||
요소의 특성
| |||
특성명
| 필수
| 값
| 예:
|
성공 | 예 | API 호출의 성공 여부를 나타내는 true 또는 false입니다. 성공한 호출의 경우에도 응답에 경고 메시지가 포함될 수 있습니다. | true |
요소의 콘텐츠
| |||
단일 옵션 메시지 요소와 정확히 하나의 필수 출력 요소 | |||
메시지 요소
| |||
태그명
| 메시지 | ||
설명
| 하나 이상의 메시지 요소에 대한 컨테이너입니다. | ||
요소의 특성
| |||
특성명
| 필수
| 값
| 예:
|
(없음) | |||
요소의 콘텐츠
| |||
하나 이상의 메시지 요소 | |||
메시지 요소
| |||
태그명
| 메시지 | ||
설명
| 시스템에서 호출자에게 다시 전송되는 메시지를 나타냅니다. 메시지는 요청이 성공하지 못한 경우의 오류 메시지, 요청이 성공한 경우의 경고 메시지, 성공의 경우 확인 메시지에 사용됩니다. | ||
요소의 특성
| |||
특성명
| 필수
| 값
| 예:
|
키 | 아니요 | 지정된 경우 키는 특정 메시지 또는 메시지 유형을 식별하는 방법이며, 클라이언트 프로그램에서 자동화된 오류 기록 및 복구를 위해 유용합니다. 메시지의 언어가 변경되더라도 다른 요청 로케일에서는 키는 변경되지 않습니다. 또한 향후에는 문구 조정 또는 용어 변경으로 인해 키가 변경되지 않을 것입니다. | |
요소의 콘텐츠
| |||
메시지 텍스트입니다. 이 텍스트는 요청에 지정된 로케일의 언어로 표시됩니다(로케일이 지원된다고 가정). 텍스트에는 처리된 행 수, 오류를 일으킨 특정 열 또는 값과 같은 가변 정보가 포함될 수도 있습니다. | |||
출력 요소
| |
태그명
| 출력 |
요소의 특성
| |
(없음) | |
요소의 콘텐츠
| |
단일 그룹 요소 이 출력 랩퍼는 모든 API 응답에서 표준이며, 성공한 API 호출의 유효한 출력을 포함합니다. | |
그룹 요소
| |||
태그명
| 개 그룹 | ||
설명
| 하나 이상의 그룹 요소에 대한 컨테이너입니다. | ||
요소의 특성
| |||
특성명
| 필수
| 값
| 예:
|
(없음) | |||
요소의 콘텐츠
| |||
0개 이상의 그룹 요소 | |||
그룹 요소
| |||
태그명
| 그룹 | ||
설명
| exportGroups API 호출에 대한 응답으로 반환되는 단일 그룹을 나타냅니다. | ||
요소의 특성
| |||
특성명
| 필수
| 값
| 예:
|
ID | 예 | 사용자 그룹의 내부 시스템 ID 번호입니다. | 2 |
이름 | 예 | 사용자 그룹의 이름입니다. | 운영 및 관리자 |
isGlobal | 예 | 사용자 그룹이 인스턴스 전반에서 글로벌인지 여부를 나타냅니다. | 3 |
ownerId | 예 | 이 사용자 그룹을 소유한 사용자의 내부 시스템 ID입니다. isGlobal="false"인 경우에만 설정됩니다. | 5 |
요소의 콘텐츠
| |||
(없음) | |||