exportLocales
카테고리
| 메타데이터 검색 |
설명
| 회사의 모든 로케일 목록을 반환합니다. |
요청 시 필수 매개변수
| 자격증명 |
이 메서드의 요청에는 호출 사용자를 식별하고 권한을 부여하는
자격증
명 태그만 포함되어 있습니다. 확인되면 이 메서드는 해당 회사와 연결된 모든 로케일의 전체 세트를 설명하는 XML 문서를 반환합니다.요청 형식
<?xml version='1.0' encoding='UTF-8'?> <call method="exportLocales" callerName="a string that identifies your client application"> <credentials login="sampleuser@company.com" password="my_pwd"/> </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> <locales> <locale code="en" name="English" isDefault="1" /> <locale code="de" name="German" isDefault="0" /> <locale code="fr" name="French" isDefault="0" /> <locale code="es" name="Spanish" isDefault="0" /> <locale code="pt" name="Portuguese" isDefault="0" /> <locale code="nl" name="Dutch" isDefault="0" /> <locale code="ja" name="Japanese" isDefault="0" /> </locales> </output> </response>
응답 요소
| |||
태그명
| 응답 | ||
요소의 특성
| |||
특성명
| 필수
| 값
| 예:
|
성공 | 예 | API 호출의 성공 여부를 나타내는 true 또는 false입니다. 성공한 호출의 경우에도 응답에 경고 메시지가 포함될 수 있습니다. | true |
폐지 | 아니요 | 이 속성이 응답 태그에 있고 true로 설정된 경우, 이 속성은 호출 중인 메서드 또는 API의 버전이 폐기되었으며 공식적으로 폐기됨을 나타냅니다. 현재로서는 계속 작동하지만 잠시 후 작동이 중지될 수 있습니다. 일반적으로 이 특성은 없습니다. | false |
요소의 콘텐츠
| |||
단일 옵션 메시지 요소와 정확히 하나의 필수 출력 요소 | |||
출력 요소
| |||
태그명
| 출력 | ||
요소의 특성
| |||
특성명
| 필수
| 값
| 예:
|
(없음) | |||
요소의 콘텐츠
| |||
단일 필수 특성 요소 이 출력 랩퍼는 모든 API 응답에서 표준이며, 성공한 API 호출의 유효한 출력을 포함합니다. | |||
locales 요소
| |||
태그명
| 로케일 | ||
설명
| 하나 이상의 로케일 요소에 대한 컨테이너입니다. | ||
요소의 특성
| |||
특성명
| 필수
| 값
| 예:
|
(없음) | |||
요소의 콘텐츠
| |||
하나 이상의 로케일 요소 | |||
로케일 요소
| |||
태그명
| 로케일 | ||
설명
| 회사와 연결된 단일 로케일을 나타냅니다. | ||
요소의 특성
| |||
특성명
| 필수
| 값
| 예:
|
코드 | 예 | Firefox에서 사용되는 표준 로케일 코드입니다. | ko |
이름 | 예 | 읽을 수 있는 로케일 이름 버전입니다. | 영어 |
isDefault | 예 | 이 로케일이 회사의 기본값인 경우 1입니다. 그렇지 않으면 0입니다. | 1 |
요소의 콘텐츠
| |||
(없음) | |||