exportCalendar

이 API는 API v33 이상에서 지원됩니다.

API v40에서 업데이트되었습니다(2024년 9월 21일).

카테고리	메타데이터 검색
설명	캘린더 메타데이터를 반환합니다.
호출에 필요한 권한	없음(인스턴스에 대해 유효한 자격증명이어야 함)
요청 시 필수 매개변수	자격증명

이 메서드의 요청에는 호출 사용자를 식별하고 권한을 부여하는 자격증명 태그가 포함되어 있습니다. 호출자가 확인되면 이 메서드는 캘린더 정보의 전체 목록을 설명하는 XML 문서를 반환합니다.

요청 형식

<?xml version='1.0' encoding='UTF-8'?>
<call method="exportCalendar" callerName="a string that identifies your client application">
<credentials login="sampleuser@company.com" password="my_pwd" instanceCode="INSTANCE1"/>
</call>

자격증명 요소
태그명		자격증명
설명		모든 API 호출에는 API를 호출하는 사용자를 식별하는 단일 자격증명 요소가 포함되어야 합니다. 그러면 이 사용자로 API 호출이 수행됩니다(시스템의 모든 감사 추적 또는 액션 이력에 이 사용자가 액션을 수행했음이 표시됨). 따라서 사용자에게 액션을 수행하는 데 필요한 권한이 있어야 API 호출이 성공
요소의 특성
특성명	필수	값	예:
로그인	예	API 메서드를 호출하는 사용자의 로그인명입니다. 이 사용자는 메서드를 호출하는 데 필요한 권한이 있어야 합니다.	sampleuser@company.com
비밀번호	예	API 메서드를 호출하는 사용자의 비밀번호입니다.	my_password
instanceCode	아니요	자격증명에 지정된 사용자가 둘 이상의 Adaptive Planning 인스턴스에 액세스할 수 있는 경우 이 속성을 사용하여 사용자가 기본 인스턴스가 아닌 다른 인스턴스에 액세스하려고 함을 지정할 수 있습니다. 지정하지 않으면 사용자의 기본 인스턴스가 사용됩니다. 사용가능한 인스턴스 코드를 확인하려면 exportInstances API를 사용합니다.	MYINSTANCE1
요소의 콘텐츠
(없음)

응답 형식


<?xml version="1.0" encoding="UTF-8"?>
<response success="true">
<output>
<calendars>
  <calendar id="1" isDefault="true" name="DefaultTimeHierarchy" />
</calendars>
</output>
</response>

응답 요소
태그명		응답
요소의 특성
특성명	필수	값	예:
성공	예	API 호출의 성공 여부를 나타내는 'true' 또는 'false'입니다. 성공한 호출의 경우에도 응답에 경고 메시지가 포함될 수 있습니다.	true
요소의 콘텐츠
정확히 하나의 필수 출력 요소

출력 요소
태그명	출력
요소의 특성
(없음)
요소의 콘텐츠
단일 필수 캘린더 요소 이 출력 랩퍼는 모든 API 응답에서 표준이며, 성공한 API 호출의 유효한 출력을 포함합니다.

캘린더 요소
태그명		캘린더
설명		하나 이상의 캘린더 요소에 대한 컨테이너입니다.
요소의 특성
특성명	필수	값	예:
(없음)
요소의 콘텐츠
하나 이상의 캘린더 요소

캘린더 요소
태그명		캘린더
설명		캘린더를 나타냅니다.
요소의 특성
특성명	필수	값	예:
ID	예	특정 캘린더의 특정 정수 ID를 보유합니다.	1
isDefault	예	특정 캘린더가 기본 캘린더인지 여부를 나타내는 'true' 또는 'false'입니다.	true
이름	예	캘린더명을 포함합니다.	DefaultTimeHierarchy
코드 API v40 이상에서 사용가능	아니요	캘린더 코드가 있는 경우 캘린더 코드를 포함합니다.	DefaultTimeHierarchy
요소의 콘텐츠
(없음)