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

exportData

种类
数据检索
描述
从请求实例中所请求的版本返回一组数据。
调用所需的权限
无（必须是实例的有效凭据）
请求时需要的参数
凭据、版本、格式、筛选器
此方法的请求包含将用于在指定版本中搜索数据的参数，并返回与所请求的筛选器和格式匹配的值。这是用于从 Adaptive Planning 中检索数据的基本方法，可用于从任何账户（包括标准账户、总分类账账户、模型化账户、多维账户、自定义账户、指标账户、假设和汇率）中检索值。
如果您导出某个计划版本，则导出的数据将包括任何实际值覆盖期间的实际值数据。您将看到与在工作表用户界面中一样的实际值或计划数据。
各个拆分中的值在导出时会进行聚合
exportData.
对于 API v16 及更高版本，
exportData
 还可以导出虚拟版本的数据。
请参见 customReportValues了解更有针对性的数据检索方法。
请参见 参考信息：exportData Performance 了解如何确保您的请求利用 2024R1 中针对 API v39 发布的性能和可扩展性改进。

申请格式


<?xml version='1.0' encoding='UTF-8'?>
<call method="exportData" callerName="a string that identifies your client application" stream="true">
<credentials login="sampleuser@company.com" password="my_pwd" instanceCode="INSTANCE1"/>
<version name="Budget 2014" isDefault="false"/>
<format useInternalCodes="true" includeUnmappedItems="false" />
<filters>
<accounts>
<account code="A100" isAssumption="true" includeDescendants="false"/>
<account code="L100" isAssumption="false" includeDescendants="true"/>
</accounts>
<levels>
<level name="Development" isRollup="true" includeDescendants="true"/>
<level name="QA" isRollup="false" includeDescendants="false"/>
</levels>
<dimensionValues>
<dimensionValue dimName="Customer" name="A Corp" directChildren="true"/>
<dimensionValue dimName="Region" name="" uncategorized="true" directChildren="false"/>
</dimensionValues>
<timeSpan start="11/2013" end="12/2014"/>
</filters>
<dimensions>
<dimension name="Product"/>
<dimension name="CountryRegion"/>
</dimensions>
<rules includeZeroRows="false" includeRollups="false" markInvalidValues="false" markBlanks="false" timeRollups="single">
<currency useCorporate="false" useLocal="false" override="AUD"/>
</rules>
</call>
此 API 的每次调用都必须恰好包含以下每种列出类型的一个元素：
  • call
  • credentials
  • 版本
  • format
请求还可以包含以下元素之一：
  • 筛选器
    • 账户 > 账户
    • 层级 > 层级
    • dimensionValues > dimensionValue
    • timeSpan
  • 维度 > 维度
  • 规则 > 币种
通话元素
标记名称
call
描述
指示正在使用 API 方法的方法属性调用该方法。
元素的属性
属性名称
必填？
值
示例
method
是
正在调用的方法。
exportData
callerName
是
一个字符串，用于标识您的客户端应用程序。
“Adaptive Planning 客户端应用程序示例”
stream
适用于 API v39 及更高版本
否
允许 exportData 在数据处理完成后立即开始将数据流式传输回客户端。默认情况下，此选项设置为 false。请注意，在 exportData 中启用流式传输需要更改响应格式。
True
元素的内容
以下每种类型只能有一个元素：
  • credentials
  • 版本
  • format
凭据元素
标记名称
credentials
描述
所有 API 调用都必须包含一个凭据元素，以识别调用 API 的用户。然后，系统会以此用户身份执行 API 调用（系统中的任何审核线索或操作历史记录都将显示此用户执行了该操作），因此，为了使 API 调用成功，该用户必须具有执行该操作所需的权限。 ..
Planning 用户界面中的“导出功能”权限不会影响 exportData。
元素的属性
属性名称
必填？
值
示例
登录
是
调用 API 方法的用户的登录名。此用户必须具有所需的权限才能调用该方法。
sampleuser@company.com
password
是
调用 API 方法的用户的密码。
my_password
locale
否
指定用于解释传入数字和日期的区域设置，以及用于设置传出数字和日期格式的区域设置（使用正确的千位分隔符、月份名称和日期格式）。区域设置还用于指定回复中的任何系统消息应使用的语言。如果未指定，则使用 en_US（美式英语）。
fr_FR
instanceCode
否
如果凭据中指定的用户有权访问多个 Adaptive Planning 实例，则此属性可用于指明该用户打算访问默认实例以外的实例。如果未指定，则将使用用户的默认实例。要确定可用的实例代码，请使用 exportInstances API。
MYINSTANCE1
元素的内容
（无）
版本元素
标记名称
版本
描述
指示应使用哪个版本来检索所请求的数据。必须为每次调用提供版本。
元素的属性
属性名称
必填？
值
示例
名称
否
要用于接收数据的版本的名称。在单个 API 调用中只能访问一个版本。如果未提供名称，则必须将此元素的 isDefault 标志设置为 true。
2014 年预算
isDefault
否
如果调用方希望访问实例的当前默认版本（无论其名称为何），则可以将此属性设置为 true，在这种情况下，标记的 name 属性（如果存在）将被忽略。否则，如果此值为 false 或此属性不存在，则必须存在具有所提供名称的版本，并且该版本可供用户访问，此调用才能成功。
false
元素的内容
（无）
格式元素
标记名称
format
描述
指示应对要返回的数据的各个字段使用的格式设置类型。
元素的属性
属性名称
必填？
值
示例
useInternalCodes
是
如果设置为“true”，则会使用在“账户管理”和“层级管理”中输入的各个代码来发出账户代码和层级代码。如果设置为“false”，则可使用“导出”选项卡中的“导出账户映射”或“导出层级映射”在输出数据中映射代码。
True
useIds
否
设置为“true”时，系统会在响应中使用账户、层级和维度的编号（而非代码）来表示账户、层级和维度。此外，“ ”部分中的账户、层级和维度也必须使用各自的编号来表示。
如果请求中不存在，则默认为“false”。
True
includeUnmappedItems
否
仅当 useInternalCodes 为 false 且使用了导出映射时，此属性才适用。如果未另行指定，则在“导出”选项卡上没有“导出映射”的条目将不会在输出中发出。如果将 includeUnmappedItems 设置为“true”，则系统将使用未设置“导出映射”的账户或层级的内部代码（在“账户管理”或“层级管理”中设置的代码）作为这些账户或层级的代码，从而在导出时混合映射和未映射的条目。数据，而是一组完整的数据。如果此标志设置为“false”，并且某些申请条目没有“导出映射”，则这些条目可能不会被发出。
false
includeCodes
否
仅当“启用有效显示名称”设置为“开启”时，此选项才有意义。
设置为“true”可在 API 响应中包括层级的代码列。
如果设置为“false”，则会在 API 响应中排除层级的代码列。
默认值为 false。
false
includeNames
仅在 API v30+ 中为启用了显示名称的实例提供。
否
仅当“启用有效显示名称”设置为“开启”时，此选项才有意义。
设置为“true”可在 API 响应中包括层级的名称列。
如果设置为“false”，则会在 API 响应中排除层级的名称列。
默认值为 false。
false
includeDisplayNames
仅在 API v30+ 中为启用了显示名称的实例提供。
否
仅当“启用有效显示名称”设置为“开启”时，此选项才有意义。
设置为“true”可在 API 响应中包括层级的显示名称列。
如果设置为“false”，则会在 API 响应中排除层级的显示名称列。
默认值为 false。
false
displayNameEnabled
仅在 API v30+ 中为启用了显示名称的实例提供。
否
displayNameEnabled=true 表示当实例的“启用显示名称”为“开启”时，exportData API 需要请求中的 code 属性来指定层级和维度实体。
displayNameEnabled=false 表示 exportData API 继续遵循 v30 之前的 API 合同，即使实例的“启用显示名称”设置为“开启”也是如此。将使用名称属性，而不是代码属性。
对于每个层级和维度，名称和代码属性值必须匹配。
displayNameEnabled 的默认值为“false”。
false
元素的内容
（无）
筛选器元素
标记名称
筛选器
描述
包含筛选器规范，这些筛选器可确定 API 从所请求版本中检索哪些数据。此元素指定将检索的账户、层级、月份和维度值。
元素的属性
（无）
元素的内容
一个必选的账户元素、一个可选的层级元素、一个必选的 timeSpan 元素和一个可选的单个 dimensionValues 元素。
账户元素
标记名称
账户
描述
一个或多个账户元素的容器。
元素的属性
（无）
元素的内容
一个或多个账户元素
账户元素
标记名称
account
描述
指定要在 exportData API 调用中导出数据的账户。如果在账户元素内放置了多个账户元素，则与任何账户元素匹配的所有账户都将被导出。如果任何给定的账户元素都没有与其匹配的账户，则该元素将被忽略，但其他元素仍然适用。
元素的属性
属性名称
必填？
值
示例
代码
是
要导出的账户的代码。此代码与“账户管理”中指定的代码相同。
Current_Assets
isAssumption
是
指明代码指定的是假设账户还是非假设账户。您可以为假设和账户使用同一个代码。使用此标志可指明账户类型。
false
includeDescendants
是
指示导出数据时是否应包括指定账户的所有后代。如果设置为 true，则系统会导出此账户的所有子级及其子级，依此类推。如果设置为 false，则此账户将作为单个汇总账户值导出。
True
元素的内容
（无）
层级元素
标记名称
层级
描述
一个或多个层级元素的容器。
元素的属性
（无）
元素的内容
一个或多个层级元素如果请求中包含不可访问的层级，则只有一个层级元素，该元素表示组织的最高层级。
层级元素
标记名称
level
描述
指定要在 exportData API 调用中导出数据的组织层级。如果在层级元素中放置了多个层级元素，则系统将导出所有指定的层级。如果任何给定的层级元素在实例中没有匹配的层级，则系统会忽略该元素，但其他元素仍然适用。
满足以下所有条件时，您必须按代码（而非名称）进行筛选：
  • 实例通过启用“显示名称”来允许复制元数据。
  • 调用 API v30 或更高版本。
  • 如果 format 元素的 displayNameEnabled 属性为 true，
元素的属性
属性名称
必填？
值
示例
代码
仅在 API v30+ 中为启用了显示名称的实例提供。
是
代码始终与名称互斥。当以下两个条件同时适用时，您应仅使用以下代码：
  • “启用显示名称”设置为“开启”
  • 格式元素中的 displayNameEnabled="true"
否则请勿包含代码。
要导出的层级的代码。此代码在“组织管理”中指定。
仅当“有效的启用显示名称”设置为“开启”时，才支持代码。
开发部
名称
是
名称始终与代码互斥。如果 format 元素中的 displayNameEnabled="false"，则应仅使用名称。如果未指定，则为默认值。
要导出的层级的名称。此名称与“组织管理”中指定的名称相同。
仅当有效启用显示名称设置为“关闭”时，仅支持对 v30 之前版本的 API 请求使用名称。
由于 API 通过将层级的代码属性与请求中包含的名称字符串进行匹配来检索层级，因此名称属性在功能上将被视为代码属性。要按名称成功检索层级，层级的名称和代码属性必须匹配。
开发部
isRollup
是
如果此层级有子级，则 isRollup="true" 将输出该层级的汇总值（包括其所有子级的值），isRollup="false" 将仅输出该层级的未分类值（在“编辑”中输入的值）。该层级的数据）。如果此层级没有子级，则 isRollup 必须设置为 false（或在标记中完全省略）。
false
includeDescendants
是
指示导出数据时是否应包括指定层级的所有后代。如果设置为 true，则此层级的所有子级及其子级也会被导出，依此类推。如果设置为 false，则系统将单独导出此层级。请注意，这与 isRollup 不同：isRollup 会影响要为此层级输出的值，而 include Descendants 表示是否也应在导出中包括后代。如果 isRollup 和 includeDescendants 都设置为 true，并且该层级是父级层级，则输出将包含此层级及其每个后代的汇总和非汇总（未分类）层级的值。
True
元素的内容
（无）
timeSpan 元素
标记名称
timeSpan
描述
指明应在响应中返回哪些时段。介于指定范围（含）的时段将作为单独的数据列包含在输出中；它们不会被聚合或汇总。
元素的属性
属性名称
必填？
值
示例
开始
是
时段范围内要导出数据的第一个时段的代码。开始时段必须是叶时段。
01/2015
结束
是
时段范围内要导出数据的最后一个时段的代码。结束时段必须是叶时段。
03/2015
stratum
否
导出数据的时间层级代码。指定后，开始时段和结束时段必须在时间层级内。时间层级必须等于或大于请求中具有最高时间层级的账户。请参见：
例如，如果将时间层级指定为“季度”，则所有账户的时间层级必须为“季度”“年度”或更长时间。
month
元素的内容
（无）
dimensionValues 元素
标记名称
dimensionValues
描述
一个或多个 dimensionValue 元素的容器。此元素是可选元素，如果不需要筛选维度值，则不应显示此元素。
元素的属性
（无）
元素的内容
一个或多个 dimensionValue 元素。
dimensionValue 元素
标记名称
dimensionValue
描述
指示导出的数据应仅包含与指定的 dimensionValue 匹配的值。在 dimensionValues 元素中，来自不同维度的多个值的操作方式就像按维度分组一样。如果每个维度中至少有一个维度值匹配，则返回“数据”。对于同一维度内的 dimensionValues，数据可以在任何维度值上进行匹配。例如，如果在请求中指定“Region=East”“Region=West”“Product=Product_A”的维度值，则数据必须与“东部”或“西部”区域匹配，而且还必须与“Product_A Product”匹配才能导出。
满足以下所有条件时，您必须按代码（而非名称）进行筛选：
  • 实例通过启用“显示名称”来允许复制元数据。
  • 调用 API v30 或更高版本。
  • format 元素的 displayNameEnabled 属性为 true。
元素的属性
属性名称
必填？
值
示例
dimName
否
维度值（请参见下面的名称属性）所属维度的名称。
区域
代码
仅在 API v30+ 中为启用了显示名称的实例提供。
否
要导出的维度值的代码。仅当实例的有效启用显示名称设置为“开启”时，代码属性才有意义。
名称
否
要导出的维度值的名称。
仅当有效启用显示名称设置为“关闭”时，仅支持对 v30 之前版本的 API 请求使用名称。
美国西部
directChildren
否
如果设置为 true，将导致 API 导出此维度值的每个直接子级的汇总数据，但不会导出该值本身的汇总。换句话说，这将导致 exportData 从指定的值导出维度树中“下一级”的值。如果未指定，则默认为 false。
false
未分类
否
如果设置为 true，则匹配维度值的“未分类”值，而不匹配其任何后代值（如有）的值。对没有子级的维度值没有影响。如果未指定，则默认为 false。
True
uncategorizedOfDimension
否
指定 uncategorizedOfDimension 代替 dimName/name 属性。
  • 如果已指定，则属性的值应为维度的内部系统编号（而不是维度值），并且筛选器将指定此维度中的数据必须完全未分类，才能匹配筛选器。
  • directChildren 和 uncategorized 属性将被忽略，并分别被假设为 false 和 true。
  • 如果指定了 dimName，则忽略此选项。
15
directChildrenOfDimension
否
指定 directChildrenOfDimension 代替 dimName/name 属性。
  • 如果已指定，则属性的值应为维度的内部系统编号（而非维度值），并且筛选器将指定该维度的所有第一级维度值。
  • directChildren 和 uncategorized 属性将被忽略，并分别被假设为 true 和 false。
  • 如果指定了 dimName 或 uncategorizedOfDimension，则忽略此选项。
12
编号
否
指定编号来代替 dimName/name 属性。
  • 要导出的维度值的内部系统编号。应指定代替 dimName/name 属性，以指定维度值。要确定内部编号，请参见 exportDimensions API。
  • 如果指定了 dimName、uncategorizedOfDimension 或 directChildrenOfDimension，则此选项将被忽略。
14
元素的内容
（无）
维度元素
标记名称
维度
描述
一个或多个维度元素的容器。
元素的属性
（无）
元素的内容
一个或多个维度元素
维度元素
标记名称
维度
描述
表明应按指定维度对导出的数据进行细分或切片。请注意，此标记不是筛选器标记的一部分，也不控制筛选：而是控制为每个账户/层级组合导出的行数。对于维度标记中指定的每个维度，每个现有值组合都将导出为单独的数据行。维度元素中存在的每个维度还会导致在输出中出现一个额外的列，并以该维度名称进行标记。
元素的属性
属性名称
必填？
值
示例
名称
是
用于对导出数据进行切片的维度的名称。导出文件中无法按维度切片的数据行将仅显示一次，并且将在本应显示此维度的维度值名称的列中显示维度名称本身。
客户
元素的内容
（无）
规则元素
标记名称
规则
描述
指定一些额外的输出规则，用于控制发出的行类型以及某些字段值的呈现方式。
元素的属性
属性名称
必填？
值
示例
includeZeroRows
否
如果设置为“true”，则即使行仅包含零值或空值，也会发出行。如果设置为“false”，则会从输出中忽略没有数据的行。默认值为 false。
对于包含维度的导出，此选项在应用程序用户界面中不可用。
对于 API 调用，如果按维度导出数据，则系统会忽略“True”选项。它将仅为具有数据的维度值发出数据。
True
includeRollups
在 API v24 及更低版本中提供。
在 API v25 及更高版本中不可用。
否
如果设置为 true，则除了包括这些账户和层级后代的值外，还包括筛选器标记中所有账户和层级的汇总值。此属性不会影响在 dimensionValue 筛选器或维度标记中指定的自定义维度的行为方式。默认值为 false。仅当未对账户或层级应用显式筛选时，才会应用 includeRollup 标志。如果筛选器中包括任何单个账户，并且您希望将这些账户包括在内，则需要指定各个汇总账户。
false
includeRollupAccounts
在 API v25 及以上版本中提供。
否
如果设置为 true，则除了这些账户后代的值外，还包括筛选器标记中所有账户的汇总值。此属性不会影响在 dimensionValue 筛选器或维度标记中指定的自定义维度的行为方式。默认值为 false。
false
includeRollupLevels
在 API v25 及以上版本中提供。
否
如果设置为 true，则除了这些层级后代的值外，还包括筛选器标记中所有层级的汇总值。此属性不会影响在 dimensionValue 筛选器或维度标记中指定的自定义维度的行为方式。默认值为 false。
false
markInvalidValues
否
如果设置为 true，则导出操作将为无效值添加字母“I”。否则，系统会将“=NA()”添加到无效值，以使其与 Excel 兼容。默认值为 false。
false
markBlanks
已在 API v24 中更新。
否
如果设置为 true，则空白值将输出为“B”。否则，空白值将输出为零。默认值为 false。
当 includeZeroRows=false 时，即使markBlanks=true，也不会在响应中输出仅包含空白和零的组合的行。
false
timeRollups
否
具有三个可能的值：true、false 和single。如果设置为 true，季度汇总和年度汇总将显示在导出的月份范围内的正确位置。季度汇总显示在所属季度的最后一个月之后，年度汇总显示在最后一个季度的季度汇总之后。如果设置为“单个”，则不会返回单个月份、季度或年份，而仅返回 timespan 元素中涵盖的所有月份的一个时间汇总。如果设置为 false，则仅返回单个月份，而不返回时间汇总列。默认值为 false。
false
元素的内容
可选币种元素，用于指定导出时应使用的币种。
币种元素
标记名称
币种
描述
指示在发出币种账户的值时，应在输出中使用的币种。
元素的属性
属性名称
必填？
值
示例
useCorporate
否
只能为币种元素设置这三个属性中的一个。如果将 useCorporate 设置为 true，则表示应使用“公司币种”（位于组织树顶部的币种）。默认值为 false。
false
useLocal
否
只能为币种元素设置这三个属性中的一个。如果将 useLocal 设置为 true，则表示币种值应以币种值所在的组织级别的币种显示。输出的每一行都表示一个 Organization Level，该行的币种值将使用该层级的币种。默认值为 false。
false
重设
否
只能为币种元素设置这三个属性中的一个。如果存在重设值，则必须指定该实例的已配置币种之一的三字母币种代码。指定后，导出文件中的所有币种金额都将转换为该币种。
澳元
元素的内容
（无）
以下元素允许用户（具有相应权限）请求导出任意时间汇总。这些元素要求使用 API v40 及更高版本发出请求。
时间元素
标记名称
time
描述
包含导出数据时应用于映射时段的日历 XML。它应为在中生成的时间 XML 文件的精简格式。 exportTimeAPI此版块中包含的时段应与筛选器中的时间跨度元素匹配。仅当使用任意汇总日历时，才需要使用此元素。
仅适用于 API v40 及更高版本
元素的属性
属性名称
必填？
值
示例
元素的内容
（无）
时间层级元素
标记名称
stratum
描述
表示日历的时间层级。
仅适用于 API v40 及更高版本
元素的属性
属性名称
必填？
值
示例
代码
是
用户定义的时间层级唯一标识符。
年
编号
是
系统生成的时间层级的唯一整数标识符。
7
元素的内容
（无）
期间元素
标记名称
期间
描述
表示单个日历时段。
仅适用于 API v40 及更高版本
元素的属性
属性名称
必填？
值
示例
代码
是
用户定义的时段唯一编号。
Q1-2004
stratumId
是
时段所属时间层级的编号。
2
timeslot
是
时段的时段。
16
编号
是
系统为时段生成的唯一整数标识符。
16002
开始
是
时段的开始日期（含该日期），格式为 YYYY-MM-DD。
2004-01-01
结束
是
时段的结束日期（不含此日期），格式为 YYYY-MM-DD。
2004-01-01
元素的内容
（无）
任意时间汇总请求示例
： 

<call method="exportData" callerName="test caller api name">
<credentials login="admin@example.com" password="password" locale="en_US" instanceCode="EXAMPLEINST" />
<version name="Budget 2004" isDefault="true" />
<format useInternalCodes="true" includeUnmappedItems="false" useIds="false" />
<rules includeZeroRows="false" includeRollupAccounts="true" includeRollupLevels="false" markInvalidValues="false" markBlanks="false" timeRollups="false">
   <currency useCorporate="false" useLocal="true" />
</rules>
<filters>
   <accounts>
       <account code="70310" isAssumption="false" includeDescendants="true" />
   </accounts>
   <timeSpan start="01/1999" end="06/1999" />
</filters>
<time isCustom="1">
   <stratum code="month" label="Month" shortName="Month" id="1" />
   <period code="01/1999" label="Jan-1999" shortName="Jan" stratumId="1" id="-12001" start="1999-01-01" end="1999-02-01" />
 <period code="02/1999" label="Feb-1999" shortName="Feb" stratumId="1" id="-11001" start="1999-02-01" end="1999-03-01" />
 <period code="03/1999" label="Mar-1999" shortName="Mar" stratumId="1" id="-10001" start="1999-03-01" end="1999-04-01" />
 <period code="04/1999" label="Apr-1999" shortName="Apr" stratumId="1" id="-9001" start="1999-04-01" end="1999-05-01" />
 <period code="05/1999" label="May-1999" shortName="May" stratumId="1" id="-8001" start="1999-05-01" end="1999-06-02" />
 <period code="06/1999" label="Jun-1999" shortName="Jun" stratumId="1" id="-7001" start="1999-06-01" end="1999-07-01" />
</time>
</call>

回复格式

非流式传输的回复格式

<?xml version='1.0' encoding='UTF-8'?>
<response success="true">
<messages>
<message key="warning-invalid-timespan-start">Ignoring start of timespan, which precedes start of version; timsepan start: Nov-2009, version start date: Jan-2014</message>
</messages>
<output><![CDATA[
Account Name,Account Code,Level Name,[01/2014,02/2014,03/2014,04/2014,05/2014,06/2014,07/2014,08/2014,09/2014,10/2014,11/2014,12/2014]
"Benefits",30120,"Engineering (Rollup)",10653.75,10653.75,10653.75,11506.05,11506.05,11506.05,11506.05,11506.05,11506.05,10462.05,10426.05,10426.05
"Furniture",70310,"Engineering (Rollup)",1740.0,2610.0,2610.0,2610.0,2610.0,2610.0,2610.0,2610.0,2610.0,2610.0,2610.0,2610.0
...
]]>
</output>
</response>
流式传输的回复格式
 

<?xml version="1.0" encoding="UTF-8"?>
<response>
<output>
<![CDATA[Account Name,Account Code,Level Name,Q1-2004,Q2-2004,Q3-2004,Q4-2004,Q1-2005,Q2-2005
"Current Assets","Current_Assets","Engineering",33.0,33.0,33.0,33.0,33.0,33.0
"Other Assets","Other_Assets","Engineering",41.0,41.0,41.0,41.0,41.0,41.0]]>
</output>
<messages>
<message>Exporting data failed. Retry the export. Contact Support if the export continues to fail. </message>
</messages>
<status success="false" rowCountSent="2"/>
</response>
请注意，流式请求与非流式请求的响应结构有所不同。例如，消息元素和状态发生在输出之后。
回复元素
标记名称
回复
元素的属性
属性名称
必填？
值
示例
成功
是
true 或 false，指示 API 调用是否成功。即使成功调用，响应中也可能包含警告消息。
True
已废弃
否
如果此属性出现在响应标记中并设置为 true，则表示正在调用的方法或 API 的版本已过时，已被正式弃用。虽然此时它仍可继续运行，但可能会在短时间内停止运行。通常情况下，此属性不存在。
false
元素的内容
一个可选的 messages 元素，以及一个必需的输出元素。
messages 元素
标记名称
消息
描述
一个或多个消息元素的容器。
元素的属性
（无）
元素的内容
一个或多个消息元素
消息元素
标记名称
消息
描述
表示从系统发回给调用方的消息。消息用于在请求未成功时显示错误消息，在请求成功时显示警告消息，在成功时显示确认消息。
元素的属性
属性名称
必填？
值
示例
键
否
指定密钥后，密钥可用于识别特定消息或消息类型，可用于在客户端程序中自动记录错误并进行恢复。在不同的请求区域设置下，即使消息的语言发生变化，键也不会发生变化。关键字在将来也不太可能因措辞调整或术语变更而发生变化。
invalid-attributevalueid
元素的内容
消息的文本。此文本使用请求中指定的区域设置的语言（假设该区域设置受支持）。文本还可能包含可变信息，例如已处理的行数，或者导致错误的特定列或值。
输出元素
标记名称
output
描述
在所附的 CDATA 块中包含导出产生的数据。
元素的属性
（无）
元素的内容
一个 CDATA 块，其中包含要导出的 CSV 格式数据。行以换行符分隔。返回数据的第一行是一组“列标题”，用于描述后续每一行的格式。首先列出维度和筛选元素，然后列出所请求的时段值系列。时段代码和系统生成的标签（例如汇总层级上的“（汇总）”后缀）会尽可能转换为申请的区域设置。值以标准化形式发出，不包含逗号，并使用句点作为小数分隔符。
状态元素
标记名称
状态
描述
包含请求和行计数的状态信息（仅适用于流式传输请求）
元素的属性
属性名称
必填？
值
示例
成功
是
“true”或“false”。它会告知请求是否已成功完成。即使成功的请求也可能包含警告消息。
此操作仅在流式传输请求中替换响应中的属性。
"true"
rowCountSent
是
r"\d+".表示响应中表示行数的数值。
“10”