メインコンテンツにスキップ
ドキュメント
ドキュメント
Adaptive Planning
exportTime

exportTime

この API はユーザーのみをサポートします 概念: アクセス ルール API v21 以上
カテゴリ
Metadata retrieval
説明
特定のバージョン、または指定されていない場合はすべてのバージョンの時間メタデータを返します。
起動に必要な権限
なし (インスタンスに対して有効な認証情報である必要があります)
リクエストに応じてパラメータが必要
認証情報
このメソッドのリクエストには、呼び出しユーザーを識別および認証する認証情報タグと、情報を取得するバージョンを指定するオプションのバージョン タグが含まれています。バージョンが指定されていない場合、このメソッドはすべてのバージョンの開始時間と終了時間を含む時間範囲の時間情報を返します。呼び出し元が確認されると、このメソッドはバージョンの完全な時間情報セットをネストされたツリー形式で記述した XML ドキュメントを返します。

リクエストのフォーマット


<?xml version='1.0' encoding='UTF-8'?>
<call method="exportTime" callerName="a string that identifies your client application">
<credentials login="sampleuser@company.com" password="my_pwd" locale="fr_FR" instanceCode="INSTANCE1"/>
<options includeAllLocales="1" includeLegacyInformation="1" />
</call>
認証情報要素
タグ名
認証情報
説明
すべての API 呼び出しには、API を呼び出したユーザーを識別するための単一の認証情報要素が含まれている必要があります。その後、この API 呼び出しはこのユーザーとして実行されます (システムの監査証跡やアクション履歴は、このユーザーがアクションを実行したことを示します)。そのため、API 呼び出しが成功:
要素の特性
特性名
必須？
値
例
ログイン
あり
API メソッドを呼び出すユーザーのログイン名。このユーザーは、メソッドを呼び出すために必要な権限を持っている必要があります。
sampleuser@company.com
password
あり
API メソッドを呼び出すユーザーのパスワード。
my_password
ロケール
なし
入力される数値と日付の解釈、および出力する数値と日付の形式設定 (適切な千単位の区切り文字、月名、日付の形式設定を使用) に使用されるロケールを指定します。ロケールは、応答内のシステム メッセージを表示する言語を指定するためにも使用されます。指定しない場合は、en_US (米国英語) が使用されます。
fr_FR
instanceCode
なし
認証情報で指定されたユーザーが の複数のインスタンスにアクセスできる場合、
Adaptive Planning
、この属性は、ユーザーがデフォルトのインスタンス以外のインスタンスにアクセスしようとしていることを指定するのに使用できます。指定しない場合、ユーザーのデフォルトのインスタンスが使用されます。使用可能なインスタンス コードを決定するには、exportInstances API を使用します。
MYINSTANCE1
エレメントの内容
(なし)
オプション要素
タグ名
オプション
説明
時間をエクスポートするときに使用するオプションを指定します。
要素の特性
特性名
必須？
値
例
includeAllLocales
なし
任意で、エクスポート時間によって各層/期間のすべての換算をエクスポートします。指定しない場合、認証情報ブロックで指定されたロケールのみがエクスポートされます。
"1"
includeLegacyInformation
なし
必要に応じて、エクスポート時間により、レガシーの時間情報を含む追加の属性をエクスポートするようにします。isCustom = 1 の場合、これらの追加の特性は含まれません
"1"
leafStratumId
API v16 以上でサポート
なし
任意で、最下位として扱う時間層の ID を指定します。指定された時間層よりも細かい時間層は回答に含まれません。また、指定された時間層よりも細かい時間層に属する期間も回答に含まれません。
"5"
calendarId
API v33 以上でサポート
なし
必要に応じて、取得するカレンダー/階層の ID を指定します。指定されていない場合、API はデフォルト階層の時間値のみを返します。
"1"
エレメントの内容
(なし)
バージョン要素
タグ名
バージョン
説明
リクエストされたデータの取得に使用するバージョンを示します。ユーザーは指定したバージョンにアクセスできる必要があります。また、フォルダを指定することはできません。バージョン要素は必須ではありませんが、バージョン要素が含まれる場合、指定したバージョンが有効でなければなりません。
要素の特性
特性名
必須？
値
例
オプション
API v18 で更新済
なし
エクスポートする期間の範囲を設定します。"すべて"、"単一"、または省略可能な値に設定できます。デフォルトは "単一" です。単一の場合は、"name" または "ID" のいずれかを指定する必要があります。指定した単一バージョンの期間範囲と、そのバージョンの初期残高を返します。name と ID の両方が指定された場合、それらは同じバージョンを参照する必要があります。すべての場合、最小値から最大値の時間範囲の最初の層の初期累積期間を含む、すべてのバージョンの最小値から最大値までの期間を返します。すべての場合、バージョンの "名前" または "ID" を指定することはできません。省略した場合は、定義された時間をすべて返します。
単一のバージョンを指定した場合、ユーザーがそのバージョンへのアクセス権を持っている場合にのみ呼び出しが成功します。
シングル
名前
なし
データの取得に使用されるバージョンの名前。1 つの API コールでアクセスできるバージョンは 1 つだけです。名前が指定されていない場合、ID を指定する必要があります。両方が指定された場合、それらは同じバージョンに対応している必要があります。
2014 年予算
ID
なし
データの取得に使用されるバージョンの ID。1 つの API コールでアクセスできるバージョンは 1 つだけです。オプションが "単一" で ID が指定されていない場合は、名前を入力する必要があります。両方が指定された場合、それらは同じバージョンに対応している必要があります。
3
エレメントの内容
(なし)

回答形式 (includeAllLocales="0" であるか指定なし)


<?xml version='1.0' encoding='UTF-8'?>
<response success="true">
  <output>
    <time isCustom="1" seqNo="24">
      <stratum code="year" label="Year" shortName="Yr" id="3" inUse="1">
        <stratum code="qtr" label="Quarter" shortName="Qtr" id="2" inUse="1">
          <stratum code="month" label="Month" shortName="Mon" id="1" inUse="1" isDefault="1" />
        </stratum>
      </stratum>
      <period code="2015" label="FY2015" shortName="FY2015" stratumId="3" timeslot="15" encodedTimePeriod="3::15" id="15003" end="2016-01-01">
        <period code="Q1-2015" label="Q1-FY15" shortName="Q1-FY15" stratumId="2" timeslot="60" encodedTimePeriod="2::60" id="60002" end="2015-04-01">
          <period code="01/2015" label="Jan-2015" shortName="Jan-2015" stratumId="1"timeslot="180" encodedTimePeriod="1::180" id="180001" end="2015-02-01" />
          <period code="02/2015" label="Feb-2015" shortName="Feb-2015" stratumId="1" timeslot="181" encodedTimePeriod="1::181" id="181001" end="2015-03-01" />
          <period code="03/2015" label="Mar-2015" shortName="Mar-2015" stratumId="1" timeslot="182" encodedTimePeriod="1::182" id="182001" end="2015-04-01" />
        </period>
        <period code="Q2-2015" label="Q2-FY15" shortName="Q2-FY15" stratumId="2" timeslot="61" encodedTimePeriod="2::61" id="61002" end="2015-07-01">
          <period code="04/2015" label="Apr-2015" shortName="Apr-2015" stratumId="1" timeslot="183" encodedTimePeriod="1::183" id="183001" end="2015-05-01" />
          <period code="05/2015" label="May-2015" shortName="May-2015" stratumId="1" timeslot="184" encodedTimePeriod="1::184" id="184001" end="2015-06-01" />
          <period code="06/2015" label="Jun-2015" shortName="Jun-2015" stratumId="1" timeslot="185" encodedTimePeriod="1::185" id="185001" end="2015-07-01" />
        </period>
        <period code="Q3-2015" label="Q3-FY15" shortName="Q3-FY15" stratumId="2" timeslot="62" encodedTimePeriod="2::62" id="62002" end="2015-10-01">
          <period code="07/2015" label="Jul-2015" shortName="Jul-2015" stratumId="1" timeslot="186" encodedTimePeriod="1::186" id="186001" end="2015-08-01" />
          <period code="08/2015" label="Aug-2015" shortName="Aug-2015" stratumId="1" timeslot="187" encodedTimePeriod="1::187" id="187001" end="2015-09-01" />
          <period code="09/2015" label="Sep-2015" shortName="Sep-2015" stratumId="1" timeslot="188" encodedTimePeriod=""1::188" id="188001" end="2015-10-01" />
        </period>
        <period code="Q4-2015" label="Q4-FY15" shortName="Q4-FY15" stratumId="2" timeslot="63" encodedTimePeriod="2::63" id="63002" end="2016-01-01">
          <period code="10/2015" label="Oct-2015" shortName="Oct-2015" stratumId="1" timeslot="189" encodedTimePeriod="1::189" id="189001" end="2015-11-01" />
          <period code="11/2015" label="Nov-2015" shortName="Nov-2015" stratumId="1" timeslot="190" encodedTimePeriod="1::190" id="190001" end="2015-12-01" />
          <period code="12/2015" label="Dec-2015" shortName="Dec-2015" stratumId="1" timeslot="191" encodedTimePeriod="1::191" id="191001" end="2016-01-01" />
        </period>
      </period>
      <period code="2016" label="FY2016" shortName="FY2016" stratumId="3" timeslot="16" encodedTimePeriod="3::16" id="16003" end="2017-01-01">
        <period code="Q1-2016" label="Q1-FY16" shortName="Q1-FY16" stratumId="2" timeslot="64" encodedTimePeriod="2::64" id="64002" end="2016-04-01">
          <period code="01/2016" label="Jan-2016" shortName="Jan-2016" stratumId="1" timeslot="192" encodedTimePeriod="1::192" id="192001" end="2016-02-01" />
          <period code="02/2016" label="Feb-2016" shortName="Feb-2016" stratumId="1" timeslot="193" encodedTimePeriod="1::193" id="193001" end="2016-03-01" />
          <period code="03/2016" label="Mar-2016" shortName="Mar-2016" stratumId="1" timeslot="194" encodedTimePeriod="1::194" id="194001" end="2016-04-01" />
        </period>
        <period code="Q2-2016" label="Q2-FY16" shortName="Q2-FY16" stratumId="2" timeslot="65" encodedTimePeriod="2::65" id="65002" end="2016-07-01">
          <period code="04/2016" label="Apr-2016" shortName="Apr-2016" stratumId="1" timeslot="195" encodedTimePeriod="1::195" id="195001" end="2016-05-01" />
          <period code="05/2016" label="May-2016" shortName="May-2016" stratumId="1" timeslot="196" encodedTimePeriod="1::196" id="196001" end="2016-06-01" />
          <period code="06/2016" label="Jun-2016" shortName="Jun-2016" stratumId="1" timeslot="197" encodedTimePeriod="1::197" id="197001" end="2016-07-01" />
        </period>
        <period code="Q3-2016" label="Q3-FY16" shortName="Q3-FY16" stratumId="2" timeslot="66" encodedTimePeriod="2::66" id="66002" end="2016-10-01">
          <period code="07/2016" label="Jul-2016" shortName="Jul-2016" stratumId="1" timeslot="198" encodedTimePeriod="1::198" id="198001" end="2016-08-01" />
          <period code="08/2016" label="Aug-2016" shortName="Aug-2016" stratumId="1" timeslot="199" encodedTimePeriod="1::199" id="199001" end="2016-09-01" />
          <period code="09/2016" label="Sep-2016" shortName="Sep-2016" stratumId="1" timeslot="200" encodedTimePeriod="1::200" id="200001" end="2016-10-01" />
        </period>
        <period code="Q4-2016" label="Q4-FY16" shortName="Q4-FY16" stratumId="2" timeslot="67" encodedTimePeriod="2::67" id="67002" end="2017-01-01">
          <period code="10/2016" label="Oct-2016" shortName="Oct-2016" stratumId="1" timeslot="201" encodedTimePeriod="1::201" id="201001" end="2016-11-01" />
          <period code="11/2016" label="Nov-2016" shortName="Nov-2016" stratumId="1" timeslot="202" encodedTimePeriod="1::202" id="202001" end="2016-12-01" />
          <period code="12/2016" label="Dec-2016" shortName="Dec-2016" stratumId="1" timeslot="203" encodedTimePeriod="2::203" id="203001" end="2017-01-01" />
        </period>
      </period>
    </time>
  </output>
</response>

一部回答フォーマット (includeAllLocales="1" を含む)

通常、すべての期間と層にロケール ブロックがあります。以下には、層セクションのみが表示されています。期間のロケールとロケール ブロックの形式は同じです。

          <stratum code="year" label="Year" shortName="Year" id="3">
            <locales>
                <locale locale="en" label="Year" shortName="Year" />
                <locale locale="de" label="Jahr" shortName="Jahr" />
                <locale locale="fr" label="Anne" shortName="Anne" />
                <locale locale="es" label="Ao" shortName="Ao" />
                <locale locale="pt" label="Ano" shortName="Ano" />
                <locale locale="nl" label="Jaar" shortName="Jaar" />
                <locale locale="ja" label="年" shortName="年" />
            </locales>
            <stratum code="qtr" label="Quarter" shortName="Quarter" id="2">
                <locales>
                    <locale locale="en" label="Quarter" shortName="Quarter" />
                    <locale locale="de" label="Quartal" shortName="Quartal" />
                    <locale locale="fr" label="Trimestre" shortName="Trimestre" />
                    <locale locale="es" label="Trimestre" shortName="Trimestre" />
                    <locale locale="pt" label="Trimestre" shortName="Trimestre" />
                    <locale locale="nl" label="Kwartaal" shortName="Kwartaal" />
                    <locale locale="ja" label="四半期" shortName="四半期" />
                </locales>
                <stratum code="month" label="Month" shortName="Month" id="1" isDefault="1">
                    <locales>
                        <locale locale="en" label="Month" shortName="Month" />
                        <locale locale="de" label="Monat" shortName="Monat" />
                        <locale locale="fr" label="Mois" shortName="Mois" />
                        <locale locale="es" label="Mes" shortName="Mes" />
                        <locale locale="pt" label="Ms" shortName="Ms" />
                        <locale locale="nl" label="Maand" shortName="Maand" />
                        <locale locale="ja" label="月" shortName="月" />
                    </locales>
                </stratum>
            </stratum>
        </stratum>
回答エレメント
タグ名
response
要素の特性
特性名
必須？
値
例
成功
あり
真偽のいずれか。API 呼び出しが成功したかどうかを示します。呼び出しが成功した場合でも、警告メッセージが応答に含まれる場合があります。
真
廃止
なし
レスポンス タグに存在し、true に設定されている場合、この属性は呼び出しているメソッドまたは API のバージョンが廃止されており、正式に廃止されたことを示します。現時点では機能し続けていますが、まもなく機能が停止する可能性があります。通常、この属性は存在しません。
false
エレメントの内容
単一の任意のメッセージ要素と、厳密に 1 つの必須の出力要素。
メッセージ要素
タグ名
メッセージ
説明
1 つ以上のメッセージ要素のコンテナです。
要素の特性
特性名
必須？
値
例
(なし)
エレメントの内容
1 つ以上のメッセージ要素
メッセージ要素
タグ名
message
説明
システムから呼び出し元に送り返されるメッセージを表します。メッセージは、リクエストが成功しない場合のエラー メッセージ、リクエストが成功した場合の警告メッセージ、成功した場合の確認メッセージに使用されます。
要素の特性
特性名
必須？
値
例
キー
なし
キーを入力すると、特定のメッセージやメッセージのタイプを識別することができ、クライアント プログラムにおけるエラーの記録と復旧の自動化に役立ちます。メッセージの言語が変わってもキーはリクエストのロケールの中で変更されません。また、単語の調整や用語の変更によってキーが将来変更される可能性も低いです。
invalid-attributevalueid
エレメントの内容
メッセージのテキスト。このテキストは、リクエストで指定されたロケールの言語になります (そのロケールがサポートされている場合)。テキストには、処理された行数や、エラーの原因となった特定の列や値などの可変情報を含めることもできます。
出力要素
タグ名
出力
要素の特性
(なし)
エレメントの内容
単一の必須の時間要素。この出力ラベンダーはすべての API 応答の標準であり、成功した API 呼び出しの有効な出力を囲みます。
時間要素
タグ名
time
説明
1 つのルート層要素、0 または 1 つの初期残高要素、1 つ以上のルート層の期間要素のコンテナです。
要素の特性
特性名
必須？
値
例
isCustom
あり
1 または 0。このインスタンスのカレンダーがカスタマイズ済かどうかを示します。
1
q1FirstMonth
なし
会計年度の開始月 (0 から開始)この属性が表示されるのは、リクエストで includeLegacyInformation が 1 であり、isCustom が 0 の場合のみです。
8
lastMonthIsFY
なし
会計年度が、その会計年度が終了する暦年と同等かどうかを示します。この属性は、リクエストで includeLegacyInformation が 1 で、isCustom が 0 の場合にのみ表示されます。
0
連番
API v17 で追加されましたが、将来の使用のために予約されています。
エレメントの内容
正確に 1 つの層要素、0 または 1 つの初期残高要素、および 1 つ以上のルート層期間要素。
層要素
タグ名
層
説明
exportTime API コールから返されるカレンダーの層を表します。
要素の特性
特性名
必須？
値
例
code
あり
時間層の一意のユーザー定義識別子。
年
ラベル
あり
時間層の一意でないユーザー定義のテキスト識別子。
会計年度
shortName
あり
より短い名前が要求される場合に使用される一意でないユーザー定義のテキスト識別子。短縮名が定義されていない場合、ラベルはここに表示されます。
Year
ID
あり
システムによって生成される時間層の一意の整数識別子。
7
で使用
API v16 以上でサポート
なし
キューブ シートまたはモデル シートが時間層に関連付けられているか、あるいはこれがデフォルトの時間層であるかを示すフラグ。
1
isDefault
API v16 以上でサポート
なし
時間層がデフォルトの層であるかどうかを示すフラグ。
1
エレメントの内容
ゼロまたは 1 つのロケール要素これは、includeAllLocales が設定されている場合にのみ含まれます。
0 または 1 つの層要素最下位以外の各層には、正確に 1 つの層要素があります。最下位層要素に含まれる層要素はゼロです。
初期残高要素
タグ名
初期の残高
説明
exportTime API コールの応答で返されるバージョンの開始月より前の最後の最下位期間を表します。これは、1 つのバージョンのみがリクエストされた場合にのみ含まれます。
要素の特性
特性名
必須？
値
例
code
あり
初期の累積期間におけるユーザー定義の一意の識別子。
12/2003
ラベル
あり
初期の残高期間の一意でないユーザー定義のテキスト識別子。
2003 年 12 月
短縮名
あり
初期残高期間の一意でないユーザー定義の短いテキスト識別子。短縮名が定義されていない場合は、ラベルが表示されます。
12 月
stratumId
あり
初期残高が属する層の ID。
1
タイム スロット
あり
初期残高が属する期間のタイムスロット
47
encodedTimePeriod
あり
StrutumId::timeslot の形式の期間のエンコードされたデータ。
1::47
ID
あり
初期の累積期間の一意のシステム生成整数識別子。
47001
開始
あり
YYYY-MM-DD の形式で指定された初期残高の開始日 (含む)。
2003-12-01
終了
あり
YYYY-MM-DD の形式での、初期残高の終了日 (除外)。
2004-01-01
legacyReportTimeId
なし
古いバージョンのこの API でこの期間に表示されていたレポート ID。この属性は、リクエストで includeLegacyInformation が 1 で、isCustom が 0 の場合にのみ表示されます。
200312
legacySheetTimeId
なし
古いバージョンのこの API でこの期間に使用されていたシート時間 IDこの属性は、リクエストで includeLegacyInformation が 1 で、isCustom が 0 の場合にのみ表示されます。
48、Q63、または Y72
エレメントの内容
ゼロまたは 1 つの
ロケール
 要素
期間要素
タグ名
期間
説明
exportTime API 呼び出しから返される単一の暦期間を表します。
要素の特性
特性名
必須？
値
例
code
あり
期間の一意のユーザー定義の識別子。
2004 年第 1 四半期
ラベル
あり
期間の一意でないユーザー定義のテキスト識別子。
Q1-FY04
shortName
あり
より短い名前が要求される場合に使用される一意でないユーザー定義のテキスト識別子。短縮名が定義されていない場合、ラベルはここに表示されます。
Q1
stratumId
あり
期間が属する層の ID。
2
ID
あり
システムによって生成される一意の整数識別子。
16002
開始
あり
YYYY-MM-DD の形式で指定された期間の開始日 (含む)。
2004-01-01
終了
あり
YYYY-MM-DD の形式での、期間の終了日 (除外)。
2004-04-01
legacyReportTimeId
なし
古いバージョンのこの API でこの期間に表示されていたレポート ID。この属性は、リクエストで includeLegacyInformation が 1 で、isCustom が 0 の場合にのみ表示されます。
200491
legacySheetTimeId
なし
古いバージョンのこの API でこの期間に使用されていたシート時間 IDこの属性は、リクエストで includeLegacyInformation が 1 で、isCustom が 0 の場合にのみ表示されます。
48、Q63、または Y72
エレメントの内容
ゼロまたは 1 つのロケール要素
ロケール要素
タグ名
ロケール
説明
1 つ以上の
ロケール
 要素のコンテナです。
要素の特性
特性名
必須？
値
例
(なし)
エレメントの内容
1 つ以上のロケール要素
ロケール要素
タグ名
ロケール
説明
ロケールの説明。テキストはロケールの折り畳みルールに従うことに注意してください。
要素の特性
特性名
必須？
値
例
ロケール
あり
ロケールのコード。
ja
ラベル
あり
期間/層のローカライズ済みラベル
2016 会計年度
shortName
あり
期間/層のローカライズ済みの短い名前。
2016
エレメントの内容
(なし)