跳至主要内容
文档
文档
Adaptive Planning
exportTime

exportTime

此 API 仅支持用户 概念：访问规则 在 API v21 及更高版本中。
种类
元数据检索
描述
返回特定版本的时间元数据，如果未指定时间元数据，则返回所有版本的时间元数据。
调用所需的权限
无（必须是实例的有效凭据）
请求时需要的参数
凭据
此方法的请求包含一个凭据标记（用于识别调用用户并对其进行授权），以及一个可选的版本标记（用于指定要检索其信息的版本）。如果未指定版本，则此方法将返回包含所有版本开始时间和结束时间的时间范围的时间信息。验证调用方后，该方法会返回一个 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
密码
是
调用 API 方法的用户的密码。
my_password
区域设置
否
指定用于解释传入数字和日期的区域设置，以及用于设置传出数字和日期格式的区域设置（使用正确的千位分隔符、月份名称和日期格式）。区域设置还用于指定回复中的任何系统消息应使用的语言。如果未指定，则使用 en_US（美式英语）。
fr_FR
instanceCode
否
如果凭据中指定的用户有权访问多个实例，
Adaptive Planning
，此属性可用于指定用户打算访问默认实例以外的实例。如果未指定，则将使用用户的默认实例。要确定可用的实例代码，请使用 exportInstances API。
MYINSTANCE1
元素的内容
（无）
选项元素
标记名称
选项
描述
指定导出时间时要使用的选项。
元素的属性
属性名称
必填？
值
示例
includeAllLocales
否
（可选）将导出时间设置为导出每个时间层级/时段的所有折算。如果未指定，则仅导出凭据块中指定的区域设置。
"1"
includeLegacyInformation
否
（可选）导出包含原有时间信息的附加属性。如果 isCustom = 1，则将不包括这些附加属性
"1"
leafStratumId
在 API v16 及更高版本中受支持
否
（可选）提供时间层级的编号，以将其视为叶时间层级。任何精细于给定时间层级的时间层级都不会包括在响应中，任何属于精细于给定时间层级的时间层级的时段也不会包括在响应中。
"5"
calendarId
在 API v33 及更高版本中受支持
否
（可选）提供要检索的日历/层次结构的编号。如果未指定，则 API 将仅返回默认层次结构中的时间值。
"1"
元素的内容
（无）
版本元素
标记名称
版本
描述
指示应使用哪个版本来检索所请求的数据。用户必须能够访问指定的版本，并且该版本不能是文件夹。版本元素不是必需的，但如果包含版本元素，则指定的版本必须有效。
元素的属性
属性名称
必填？
值
示例
选项
在 API v18 中更新
否
设置要导出的时间范围。可设置为“全部”、“单个”或忽略。默认为“单个”。如果是单身，则用户还必须指定“name”或“id”。返回指定的单个版本的时间范围以及该版本的初始余额。如果同时指定了 name 和 id，则它们必须引用相同的版本。如果为 all，则返回所有版本的从 min 到 max 的时间范围，包括最小-最大时间范围内第一个时间层级的初始余额期间。如果包含所有版本，则不得指定版本“name”或“id”。如果省略，则返回所有已定义的时间。
指定单个版本时，仅当用户有权访问该版本时，调用才会成功。
单身
名称
否
要用于检索数据的版本的名称。在单个 API 调用中只能访问一个版本。如果未提供名称，则必须提供编号。如果同时指定了两者，则它们必须对应于同一版本。
2014 年预算
编号
否
要用于检索数据的版本编号。在单个 API 调用中只能访问一个版本。如果选项为“single”且未提供编号，则必须提供名称。如果同时指定了两者，则它们必须对应于同一版本。
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>
回复元素
标记名称
回复
元素的属性
属性名称
必填？
值
示例
成功
是
true 或 false，指示 API 调用是否成功。即使呼叫成功，其响应中也可能包含警告消息。
True
已废弃
否
如果此属性出现在响应标记中并设置为 true，则表示正在调用的方法或 API 的版本已过时，已被正式弃用。虽然此时它仍可继续运行，但可能会在短时间内停止运行。通常情况下，此属性不存在。
false
元素的内容
一个可选的 messages 元素，以及一个必需的输出元素。
messages 元素
标记名称
消息
描述
一个或多个消息元素的容器。
元素的属性
属性名称
必填？
值
示例
（无）
元素的内容
一个或多个消息元素
消息元素
标记名称
消息
描述
表示从系统发回给调用方的消息。消息用于在请求未成功时显示错误消息，在请求成功时显示警告消息，在成功时显示确认消息。
元素的属性
属性名称
必填？
值
示例
键
否
指定密钥后，密钥可用于识别特定消息或消息类型，可用于在客户端程序中自动记录错误并进行恢复。在不同的请求区域设置下，即使消息的语言发生变化，键也不会发生变化。关键字在将来也不太可能因措辞调整或术语变更而发生变化。
invalid-attributevalueid
元素的内容
消息的文本。此文本使用请求中指定的区域设置的语言（假设该区域设置受支持）。文本还可能包含可变信息，例如已处理的行数，或者导致错误的特定列或值。
输出元素
标记名称
输出
元素的属性
（无）
元素的内容
单个必需的时间元素。此输出包装器是所有 API 响应的标准输出，并包含任何成功的 API 调用的有效输出。
时间元素
标记名称
time
描述
用于存放一个根时间层级元素、零个或一个初始余额元素以及一个或多个根时间层级期间元素的容器。
元素的属性
属性名称
必填？
值
示例
isCustom
是
1 或 0，表示此实例的日历是否已自定义。
1
q1FirstMonth
否
会计年度开始的月份（从 0 开始）。仅当 includeLegacyInformation 在请求中为 1 并且 isCustom 为 0 时，才会显示此属性。
8
lastMonthIsFY
否
指明会计年度是否等于会计年度结束时所在的日历年度。此属性仅在请求中的 includeLegacyInformation 为 1，并且 isCustom 为 0 时显示。
0
seqNo
在 API v17 中添加，但保留以供将来使用。
元素的内容
恰好包含一个时间层级元素、零个或一个初始余额元素以及一个或多个根时间层级元素。
时间层级元素
标记名称
stratum
描述
表示从 exportTime API 调用返回的日历时间层级。
元素的属性
属性名称
必填？
值
示例
代码
是
用户定义的时间层级唯一标识符。
年
标签
是
用户定义的非唯一文本标识符，用于时间层级。
会计年度
shortName
是
用户定义的非唯一文本标识符，在需要较短名称时使用。如果未定义短名称，则此处将显示标签。
年
编号
是
系统生成的时间层级的唯一整数标识符。
7
使用中
在 API v16 及更高版本中受支持
否
此标志指示多维工作表或模型化工作表是否与时间层级相关联，或者是否为默认时间层级。
1
isDefault
在 API v16 及更高版本中受支持
否
指示时间层级是否为默认时间层级的标志。
1
元素的内容
零个或一个区域设置元素。仅当设置了 includeAllLocales 时，才会包括此项。
零个或一个时间层级元素。除叶节点外，每个时间层级都只有一个时间层级元素。叶时间层级元素包含零个时间层级元素。
Initial-balance 元素
标记名称
初始余额
描述
表示在对 exportTime API 调用的响应中返回的版本开始前的最后一个叶时段。仅当请求一个且仅一个版本时，才会包括此选项。
元素的属性
属性名称
必填？
值
示例
代码
是
初始余额时段的用户定义的唯一编号。
12/2003
标签
是
初始余额时段的用户定义的非唯一文本标识符。
2003 年 12 月
短名称
是
初始余额时段的用户定义的非唯一短文本标识符。如果未定义短名称，则会显示标签。
12 月
stratumId
是
初始余额所属时间层级的编号。
1
timeslot
是
初始余额所属时段的时段。
47
encodedTimePeriod
是
时段的已编码数据，格式为 struumId::timeslot。
1::47
编号
是
系统生成的唯一整数标识符，用于初始余额时段。
47001
开始
是
初始余额的开始日期（含该日期），格式为 YYYY-MM-DD。
2003-12-01
结束
是
初始余额的结束日期（不含此日期），格式为 YYYY-MM-DD。
2004-01-01
legacyReportTimeId
否
在此时间段的旧版本 API 中，报告编号会显示。此属性仅在请求中的 includeLegacyInformation 为 1，并且 isCustom 为 0 时显示。
200312
legacySheetTimeId
否
在此 API 的较早版本中，将用于此时段的工作表时间编号。此属性仅在请求中的 includeLegacyInformation 为 1，并且 isCustom 为 0 时显示。
48、Q63 或 Y72
元素的内容
零个或一个
区域设置
 元素。
期间元素
标记名称
期间
描述
表示从 exportTime API 调用返回的单个日历时段。
元素的属性
属性名称
必填？
值
示例
代码
是
用户定义的时段唯一编号。
Q1-2004
标签
是
用户定义的非唯一文本时段标识符。
Q1-FY04
shortName
是
用户定义的非唯一文本标识符，在需要较短名称时使用。如果未定义短名称，则此处将显示标签。
第 1 季度
stratumId
是
时段所属时间层级的编号。
2
编号
是
16002
开始
是
2004-01-01
结束
是
2004-04-01
legacyReportTimeId
否
在此时间段的旧版本 API 中，报告编号会显示。此属性仅在请求中的 includeLegacyInformation 为 1，并且 isCustom 为 0 时显示。
200491
legacySheetTimeId
否
在此 API 的较早版本中，将用于此时段的工作表时间编号。此属性仅在请求中的 includeLegacyInformation 为 1，并且 isCustom 为 0 时显示。
48、Q63 或 Y72
元素的内容
标记名称
描述
元素的属性
属性名称
必填？
值
示例
（无）
元素的内容
标记名称
区域设置
描述
元素的属性
属性名称
必填？
值
示例
区域设置
是
英语
标签
是
FY2016
shortName
是
2016
元素的内容
（无）