importTransactions
카테고리
| 데이터 제출 |
설명
| 신규 트랜잭션을 삽입합니다. |
호출에 필요한 권한
| 가져오기 |
요청 시 필수 매개변수
| Credentials, ImportTransactionsOptions, RowData |
이 방법은 트랜잭션에 대한 액세스 권한이 있는 경우에만 적용됩니다.
가져오는 동안에만 트랜잭션을 삭제할 수 있습니다. 가져오기 중에 모든 트랜잭션을 제거하려면 하나의 빈 행을 가져오고 나머지 데이터를 삭제하는 것이 좋습니다.
이 방법은 특정 조건과 일치하는 기존 트랜잭션 행을 삭제하거나, 시스템에 새 트랜잭션 행을 삽입하거나, 한 번의 호출로 두 액션을 모두 수행하는 데 사용할 수 있습니다(예: 트랜잭션 행 세트를 다른 행 세트로 바꾸기).
요청 형식
<?xml version='1.0' encoding='UTF-8'?> <call method="importTransactions" callerName="a string that identifies your client application"> <credentials login="sampleuser@company.com" password="my_pwd" instanceCode="INSTANCE1"/> <importTransactionsOptions allowParallel="false" useMappings="false"/> <rowData> <header>Posting Date|Transaction Type|Account|Plan|Transaction Amount</header> <rows> <row>01/02/2011|Invoice|70110|Marketing|100</row> </rows> </rowData> </call>
이 API 호출을 호출할 때마다 나열된 각 유형의 요소가 정확히 하나만 포함되어야 합니다.
- 자격증명
- importTransactionsOptions
- rowData
헤더의 파이프 문자( | ) 수와 데이터가 일치하지 않으면 API v30 이상에서 오류가 발생합니다.
자격증명 요소
| |||
태그명
| 자격증명 | ||
설명
| 모든 API 호출에는 단일Credentials 요소를 사용하여 API를 호출하는 사용자를 식별합니다. 그러면 이 사용자로 API 호출이 수행됩니다(시스템의 모든 감사 추적 또는 액션 이력에 이 사용자가 액션을 수행했음이 표시됨). 따라서 사용자에게 액션을 수행하는 데 필요한 권한이 있어야 API 호출이 성공 | ||
요소의 특성
| |||
특성명
| 필수
| 값
| 예:
|
로그인 | 예 | API 메서드를 호출하는 사용자의 로그인명입니다. 이 사용자는 메서드를 호출하는 데 필요한 권한이 있어야 합니다. | sampleuser@company.com |
비밀번호 | 예 | API 메서드를 호출하는 사용자의 비밀번호입니다. | my_password |
로케일 | 아니요 | 수신 숫자 및 날짜를 해석하고 보내는 숫자 및 날짜의 형식을 지정하는 데 사용할 로케일을 지정합니다(적절한 천 단위 구분 기호, 월명 및 날짜 서식 사용). 로케일은 응답의 시스템 메시지에 사용할 언어를 지정하는 데도 사용됩니다. 지정하지 않으면 en_US(미국식 영어)가 사용됩니다. | fr_FR |
instanceCode | 아니요 | 자격증명에 지정된 사용자가 의 두 개 이상의 인스턴스에 액세스할 수 있는지 여부 Adaptive Planning 인 경우 이 속성을 사용하여 사용자가 기본 인스턴스가 아닌 다른 인스턴스에 액세스하려고 함을 지정할 수 있습니다. 지정하지 않으면 사용자의 기본 인스턴스가 사용됩니다. 사용가능한 인스턴스 코드를 확인하려면 exportInstances API를 사용합니다. | MYINSTANCE1 |
요소의 콘텐츠
| |||
(없음) | |||
importTransactionsOptions
element
| |||
태그명
| importTransactionsOptions | ||
설명
| 가져오기를 수행할 때 사용할 옵션을 지정합니다. 다음 중 하나 이상에 해당하는 경우삭제시작일deleteEndDate 또는transactionTypes가 지정된 경우 이 메서드 호출은 지정된 조건과 일치하는 기존 트랜잭션을 삭제하려고 시도합니다. | ||
요소의 특성
| |||
특성명
| 필수
| 값
| 예:
|
deleteStartDate | 아니요 | 이 메서드 호출이 일부 기존 트랜잭션을 삭제하기 위한 경우 이 속성은 삭제할 트랜잭션 세트의 시작일을 지정합니다(포함). 지정하지 않으면 날짜가 다음 날짜 또는 그 전인 모든 트랜잭션deleteEndDate(지정된 옵션 중 하나와 일치)TransactionTypes)가 삭제됩니다. | 11/01/2012 |
deleteEndDate | 아니요 | 이 메서드 호출이 일부 기존 트랜잭션을 삭제하기 위한 경우 이 속성은 삭제할 트랜잭션 세트의 종료일을 지정합니다(포함). 지정하지 않으면 날짜가 다음 날짜 또는 그 후인 모든 트랜잭션deleteStartDate(및 지정된 옵션 중 하나와 일치하는 날짜)TransactionTypes)가 삭제됩니다. | 12/31/2012 |
transactionTypes | 아니요 | 삭제할 트랜잭션 유형 세트로, 파이프 기호로 구분됩니다. 지정하지 않으면 다음 사이에 지정된 모든 트랜잭션deleteStartDate 및deleteEndDate가 삭제됩니다. '아니요'인 경우deleteStartDate 또는deleteEndDate를 지정하면 날짜와 관계없이 지정된 유형의 모든 트랜잭션이 삭제됩니다. | PO |
allowParallel | 예 | 다음으로 설정된 경우true이면 이 인스턴스에 대해 처리 중인 다른 실제값 또는 트랜잭션 가져오기가 이미 있는 경우에도 가져오기가 진행됩니다. 다음으로 설정된 경우false이면 이 인스턴스에 대해 처리 중인 실제값 또는 트랜잭션 가져오기가 이미 있는 경우 가져오기 시도가 실패합니다. | false |
useMappings | 아니요 | 행 요소 내의 계정, 계획 및 디멘션 값에 대해 가져오기 매핑을 사용할지 여부를 지정합니다. 고려됨기본적으로 true입니다. 조건false인 경우 내부 ID를 사용해야 합니다. 즉, 계정은 코드로, 레벨은 이름으로, 디멘션 값으로 식별됩니다. | false |
includeContext | 아니요 | 메시지에 컨텍스트 블록이 포함될 수 있는지 여부를 지정합니다. 값:false(컨텍스트 표시 안함) 또는true(해당하는 경우 컨텍스트 표시) 지정하지 않으면true로 가정합니다. | false |
displayNameEnabled
표시명을 활성화하는 인스턴스의 API v31 이상에서만 사용할 수 있습니다. | 아니요 | displayNameEnabled=true는 인스턴스에 대해 '표시명 사용' 설정이 '켜짐'인 경우 API에서 페이로드에 계정 코드, 레벨 코드, 디멘션 코드 및 디멘션명 열이 있어야 함을 나타냅니다. displayNameEnabled=false는 인스턴스에 대해 표시명 사용 설정이 ON인 경우에도 API가 v30 이전 API 계약을 따라야 함을 나타냅니다. displayNameEnabled의 기본값은 'false'입니다. | false |
요소의 콘텐츠
| |||
(없음) | |||
rowData 요소
| |||
태그명
| rowData | ||
설명
| 가져오는 데이터 행의 컨테이너입니다. | ||
요소의 특성
| |||
(없음) | |||
요소의 콘텐츠
| |||
정확히 1개헤더 요소 및 정확히 하나행 요소 | |||
헤더 요소
| |||
태그명
| 헤더 | ||
설명
| 해당하는 데이터의 열 이름과 순서를 지정합니다.행 요소 | ||
요소의 특성
| |||
(없음) | |||
요소의 콘텐츠
| |||
세로 막대로 구분된 열 이름이 있는 텍스트 줄입니다. 이러한 열 이름은 시트의 디멘션 또는 필드 이름 또는 데이터를 포함할 수 있는 월과 일치해야 합니다. 이 이름은 데이터를 가져올 대상 시트의 가져오기 템플릿에 있는 열 이름과 동일하며, 각 열 헤더가 세로 막대 또는 파이프 기호로 구분되어 있습니다.
표시명을 활성화하는 인스턴스의 경우 헤더가 다음을 지원하지 않습니다. "<dimension>" 조합 "<dimension> Name" 또는 "<dimension> Code" Adaptive Planning 지원 로케일의 경우 API v30 이상 | |||
행 요소
| |||
태그명
| 행 | ||
설명
| 하나 이상의 컨테이너행 요소 | ||
요소의 특성
| |||
(없음) | |||
요소의 콘텐츠
| |||
하나 이상행 요소 | |||
행 요소
| |||
태그명
| 행 | ||
설명
| 가져오는 단일 행의 데이터입니다. | ||
요소의 특성
| |||
(없음) | |||
요소의 콘텐츠
| |||
가져오는 단일 행의 필드에 대한 데이터이며, 각 필드의 값은 세로 막대 또는 파이프 기호로 구분됩니다. 데이터 필드는 헤더 요소의 라인과 순서가 동일해야 합니다. 값의 숫자가 천 단위 구분 기호를 사용하는 경우, 해당 숫자는 요청의 자격증명에 지정된 로케일에서 사용되는 쉼표 구분 기호로 간주됩니다. | |||
응답 형식
다음은 트랜잭션 데이터 가져오기 성공 및 실패에 대한 응답의 예입니다.
성공 예
<?xml version='1.0' encoding='UTF-8'?> <response success="true"> <messages> <message key="row-imported">1 row was imported.</message> </messages> </response>
실패(컨텍스트 있음)
<?xml version='1.0' encoding='UTF-8'?> <response success="false"> <messages> <message key="error-import">Import Failed with the following error: No transactions were imported or deleted during the import.</message> <message key="import-detail">Additional information:</message> <message key="warning-nonexistent-dimension-value">Warning: No data was imported for rows with the following dimension values because the dimension values for Transaction Type do not exist: Invoice12.</message> <message key="invalid-dimension-choice-withCoordinate"> <context> <col header="Posting Date" value="01/02/2011" /> <col header="Transaction Type" value="Invoice12" /> <col header="Account" value="70110" /> <col header="Plan" value="Marketing" /> <col header="Transaction Amount" value="100.0" /> </context> Invalid Dimension Choice: Invoice12 on row 1 column B </message> </messages> </response>
실패(컨텍스트 없음)
<?xml version='1.0' encoding='UTF-8'?> <response success="false"> <messages> <message key="error-import">Import Failed with the following error: No transactions were imported or deleted during the import.</message> <message key="import-detail">Additional information:</message> <message key="warning-nonexistent-dimension-value">Warning: No data was imported for rows with the following dimension values because the dimension values for Transaction Type do not exist: Invoice12.</message> <message key="invalid-dimension-choice-withCoordinate">Invalid Dimension Choice: Invoice12 on row 1 column B</message> </messages> </response>
응답 요소
| |||
태그명
| 응답 | ||
요소의 특성
| |||
특성명
| 필수
| 값
| 예:
|
성공 | 예 | 둘 중 하나true 또는false - API 호출의 성공 여부를 나타냅니다. 성공한 호출의 경우에도 응답에 경고 메시지가 포함될 수 있습니다. | true |
요소의 콘텐츠
| |||
단일 옵션메시지 요소 | |||
메시지 요소
| |||
태그명
| 메시지 | ||
설명
| 하나 이상의 컨테이너메시지 요소 | ||
요소의 특성
| |||
(없음) | |||
요소의 콘텐츠
| |||
하나 이상메시지 요소 | |||
메시지 요소
| |||
태그명
| 메시지 | ||
설명
| 시스템에서 호출자에게 다시 전송되는 메시지를 나타냅니다. 메시지는 요청이 성공하지 못한 경우의 오류 메시지, 요청이 성공한 경우의 경고 메시지, 성공의 경우 확인 메시지에 사용됩니다. | ||
요소의 특성
| |||
특성명
| 필수
| 값
| 예:
|
키 | 아니요 | 지정된 경우 키는 특정 메시지 또는 메시지 유형을 식별하는 방법이며, 클라이언트 프로그램에서 자동화된 오류 기록 및 복구를 위해 유용합니다. 메시지의 언어가 변경되더라도 다른 요청 로케일에서는 키는 변경되지 않습니다. 또한 향후에는 문구 조정 또는 용어 변경으로 인해 키가 변경되지 않을 것입니다. | invalid-attributevalueid |
요소의 콘텐츠
| |||
| |||
컨텍스트 요소
| |||
태그명
| 컨텍스트 | ||
설명
| 하나 이상의 col 요소에 대한 컨테이너입니다. | ||
요소의 특성
| |||
특성명
| 필수
| 값
| 예:
|
없음 | |||
요소의 콘텐츠
| |||
하나 이상의 col 요소 | |||
열 요소
| |||
태그명
| 열 | ||
설명
| 메시지의 컨텍스트를 나타냅니다. 메시지를 생성하는 행을 식별할 수 있도록 헤더/값 쌍을 제공합니다. | ||
요소의 특성
| |||
특성명
| 필수
| 값
| 예:
|
헤더 | 예 | 열의 헤더입니다. | '계정' |
값 | 예 | 열의 값입니다. | "GL-29482-38233" |
요소의 콘텐츠
| |||
(없음) | |||