createDimension
在 API v20 + 中不受支持。使用 updateDimensions。
种类
| 元数据修改 |
描述
| 创建维度。如果成功，API 将返回刚刚创建的维度的详细信息。 |
调用所需的权限
| 模型报告 |
请求时需要的参数
| 凭据 |
此方法的请求包含凭据标记，用于识别调用方用户并为其授权。用户必须具有“模型”权限才能创建维度。
申请格式
<?xml version='1.0' encoding='UTF-8'?> <call method="createDimension" callerName="fred"> <credentials login="sampleuser@company.com" password="my_pwd" /> <dimension name="New Dimension Name" /> </call>
凭据元素
| |||
标记名称
| 凭据 | ||
描述
| 所有 API 调用都必须包含一个凭据元素，以识别调用 API 的用户。然后，系统会以此用户身份执行 API 调用（系统中的任何审核线索或操作历史记录都将显示此用户执行了该操作），因此，用户必须具有执行该操作所需的权限，才能执行 API 调用。成功。 | ||
元素的属性
| |||
属性名称
| 必填？
| 值
| 示例
|
登录 | 是 | 调用 API 方法的用户的登录名。此用户必须具有所需的权限才能调用此方法 | sampleuser@company.com |
密码 | 是 | 调用 API 方法的用户的密码。 | my_password |
区域设置 | 否 | 指定用于解释传入数字和日期的区域设置，以及用于设置传出数字和日期格式的区域设置（使用正确的千位分隔符、月份名称和日期格式）。区域设置还用于指定回复中的任何系统消息应使用的语言。如果未指定，则使用 en_US（美式英语）。 | fr_FR |
instanceCode | 否 | 如果凭据中指定的用户有权访问多个实例， Adaptive Planning ，此属性可用于指定用户打算访问默认实例以外的实例。如果未指定，则将使用用户的默认实例。要确定可用的实例代码，请使用 exportInstances API。 | MYINSTANCE1 |
元素的内容
| |||
（无） | |||
维度元素
| |||
标记名称
| 维度 | ||
描述
| 指定要创建的维度。 | ||
元素的属性
| |||
属性名称
| 必填？
| 值
| 示例
|
名称 | 是 | 维度的名称。名称必须唯一。 | NewDimensionName（新建维度名称） |
shortName | 否 | 列的可显示标题，如工作表上所示。 | NewDimensionShortName |
listDimension | 否 | “1”表示这是列表维度，“0”（或未指定）表示不是列表维度。 | 0 |
useOnLevels | 否 | “1”表示此维度可用于层级，“0”（或未指定）表示不能 | 0 |
autoCreate | 否 | “1”表示可以通过导入创建此维度的值，“0”（或未指定）表示不能。 | 0 |
keepSorted | 否 | “1”表示此维度的值始终按字母顺序排序，“0”（或未指定）表示可以手动排序。 | 0 |
元素的内容
| |||
（无） | |||
回复格式
<?xml version='1.0' encoding='UTF-8'?> <response success="true"> <output> <dimensions> <dimension id="41" name="New Dimension Name" shortName="" autoCreate="0" listDimension="0" keepSorted="0" useOnLevels="0"> </dimension> </dimensions> </output> </response>
维度元素
| |
标记名称
| 维度 |
描述
| 一个或多个维度元素的容器。 |
元素的属性
| |
（无） | |
元素的内容
| |
一个或多个维度元素 | |
维度元素
| |||
标记名称
| 维度 | ||
描述
| 表示在对 exportDimensions API 调用的响应中返回的单个自定义维度。 | ||
元素的属性
| |||
属性名称
| 必填？
| 值
| 示例
|
编号 | 是 | 维度的内部系统编号。此字段可用于识别其他 API 调用（例如 exportDimensionFamilies）中的维度。 | 16 |
名称 | 是 | 维度在报告和工作表中显示的名称。 | 客户 |
shortName | 否 | 在“维度管理”中输入的维度短名称（如有） | cust。 |
autoCreate | 是 | 为所选维度设置了“导入数据时自动创建维度值”字段，则为 1；否则为 0。 | 0 |
listDimension | 是 | 如果所选维度是列表维度，则为 1；否则为 1。否则为 0。 | 1 |
keepSorted | 是 | 如果所选维度保持排序状态，则返回 1，否则返回 0。 | 1 |
useOnLevels | 是 | 如果所选维度可用于层级，则返回 1，否则返回 0。 | 1 |
元素的内容
| |||
零个或多个 dimensionValue 元素。每个括起来的 dimensionValue 元素都表示维度中的一个“根维度值”，该值没有父级值。 | |||