跳至主要内容
文档
文档
Adaptive Planning
上次更新时间 ：2023-06-23
多维工作表定义

多维工作表定义

URL 端点

HTTPS://api.adaptiveplanning.com/api/rest/modeling/<version>/<tenant>/sheet/cube/definition
版本：v1
种类
数据提交
描述
元数据修改
调用所需的权限
模型管理
模型包括：工作表、账户、维度和公式
请求时必须提供参数
名称

支持的 HTTP VERB

HTTP 谓词
单一资源
描述
PATCH
支持
插入或更新多维工作表定义
DELETE
支持
删除多维工作表定义
选项
支持
返回此集合资源支持的 HTTP 谓词列表。

PATCH

请求 URI
/sheet/cube/definition
更新与提供的查询参数匹配的多维工作表定义。
如果不存在名称匹配的工作表，则系统将新建一个具有给定属性的多维工作表。
请求示例（按名称）
https://api.adaptiveplanning.com/api/rest/modeling/v1/globosales/sheet/cube/definition?name=Sales Cube
请求标头示例
接受-语言：en
请求正文示例
请参见“请求正文”版块
查询参数
名称
描述
必填
instanceCode
要从中检索值的 instanceCode。例如，GLOBO。如果未指定 instanceCode，则使用用户的默认实例。
否
名称
工作表的名称。
否
reorderColumns
将此查询参数设置为 true 将更改列列表的顺序，以反映 API 请求主体中给定的列顺序。默认情况下，此选项设置为 false。请参见 Reference: Re-ordering Columns for Modeled and Cube Sheet Definition JSON APIs。
否
请求正文
请求正文示例
两个端点的 JSON 负载使用相同的多维工作表定义格式。
申请格式
 
{
   "properties": {
       "description": "Expense Cube",
       "prefix": "Expense",
       "horizontalAxis": {
           "type": "level"
       },
       "verticalAxis": [
           {
               "type": "account"
           },
           {
               "type": "dimension",
               "name": "ProductFurniture"
           }
       ]
   },
   "columns": [
       {
           "properties": {
               "name": "Base Pay",
               "type": "dimension"
           },
           "availability":List<SheetAvaliabilityDTO>,
           "defaultAvailability": false
       }
   ],
   "accounts": [
       {
           "name": "AccountName",
           "code": "AccountCode"
       }
   ],
   "accessibility": {
       "usernames": [ "test@greenco.com" ],
       "excludedFromWorkflow": true
   }
}
请求示例：
工作表创建请求示例
 
{
   "properties": {
       "description": "Test description",
       "prefix": "TestPrefix",
       "horizontalAxis": {
           "type": "level"
       },
       "verticalAxis": [
           {
               "type": "account"
           },
           {
               "type": "dimension",
               "name": "Base Pay"
           }
       ]
   },
   "columns": [
       {
           "properties": {
               "type": "Account"
           },
           "defaultAvailability": true
       },
       {
           "properties": {
               "type": "Level"
           },
           "defaultAvailability": true
       },
       {
           "properties": {
               "type": "Time"
           }
       },
       {
           "properties": {
               "name": "Base Pay",
               "type": "dimension"
           },
           "defaultAvailability": true
       }
   ],
   "accounts": [
       {
           "name": "AccountName",
           "code": "AccountCode",
           "type": "Standard"
       }
   ]
}
工作表定义对象
名称
描述
必填
属性
包含常规工作表属性的对象
否
列
多维工作表列对象的列表。
否
账户
账户对象列表
否
辅助功能
该对象包含用于定义按用户指定的工作表的辅助功能。
否
工作表属性对象
名称
描述
必填
类型
默认
描述
工作表描述
否
字符串
空字符串
前缀
用于账户代码的工作表前缀。
否
字符串
userAssigned
工作表是按用户指定的工作表，还是按层级指定的工作表（默认情况下）。
否
布尔值
false
timeStratumCode
与工作表中的数据关联的时间层级代码。
否
字符串
总分类账时间层级
recalculateOnDemand
是否为工作表启用了“按需重新计算”。
否
布尔值
false
重新排列总分类账和自定义账户
是否允许用户将添加到多维工作表的账户与其他多维账户重新排列。仅当存在或正在请求中创建多维标准账户时，才能启用此功能。
否
布尔值
false
hideRollupTotals
是否隐藏汇总总计以提高工作表性能。
否
布尔值
false
horizontalAxis
列引用对象，用于标识水平轴上的列。
否
列对象
Time
verticalAxis
列引用对象的列表，用于标识垂直轴上的列。如果提供，垂直轴将覆盖之前的任何选择。
否
列对象数组
Account
maxColumnWidth
每列的最大宽度（以像素为单位）。应介于 10 和 1000 之间，如果未指定宽度，则应为 0。
否
整数
0
suppressZeroRows
是否不显示零行。
否
布尔值
false
工作表列引用对象
名称
描述
必填
名称
列名称对于自定义维度和属性为必填字段。
是
type
列类型
是
工作表列对象
名称
描述
必填
属性
包含工作表列属性的对象。
是
空闲情况
当前列的工作表可用性对象列表。请参见 Sheet Availability ，查看有关列表格式的详细信息。
否
defaultAvailability
要应用于所有值的默认可用性，除非在可用性中另行指定。对层级列和维度列有效。
否
删除
请求从给定工作表中删除列。不适用于以下列：依赖于未标记为删除的现有列的列（例如维度属性）。
否
工作表列属性对象
名称
描述
必填
类型
默认
名称
列名称 对于自定义维度列和属性列，名称将与相应自定义维度或属性的名称匹配。
是
字符串
type
列的类型
可能的值：LEVEL、ACCOUNT、TIME、DIMENSION、LEVEL_ATTRIBUTE、ACCOUNT_ATTRIBUTE、DIMENSION_ATTRIBUTE
是
字符串
初始余额
初始余额是否在工作表上可见。仅对时间列有效。
否
布尔值
True
visibleTimeStratumCodes
定义工作表上可见时间层级的列表。仅对时间列有效。
否
字符串数组
所有时间层级
editableOnSheet
是否可以将新值添加到工作表中的维度列。仅对维度选择器列和文本选择器列有效。
否
布尔值
false
newValueBehavior
定义在将新值添加到基础维度时，是启用还是禁用新值。仅对维度列有效。支持的值：AVAILABLE、UNAVAILABLE 或 PARENT
否
字符串
可用
工作表列查询表对象
名称
描述
必填
类型
默认
名称
查询表名称
是
字符串
displayAs
此查询表的“显示格式”。可能的值：NUMBER 和 PERCENT。仅对值查询表有效。
否
字符串
NUMBER
decimalPrecision
此查询表中值的小数精度。可能的值：0 到 9。
否
整数
0
type
查询表的类型。可能的值：VALUE、SPREAD。
是
字符串
工作表账户对象
有关更多详细信息，请参见 Reference: Properties in Account JSON Import Payload
名称
描述
必填
名称
账户名称
是
代码
账户代码。
是
父级
父级账户
否
类型
账户类型
是
描述
账户描述。
否
shortName
账户短名称。
否
isCuculative
返回该账户是否为累计账户。
否
isPlanByDelta
返回该账户是否为按差额输入计划的账户。
否
isActualsByDelta
返回账户是否为按差额输入的实际值。
否
isLink
返回此值用于判断账户是否为源关联账户。
否
timeRollupType
要对时间汇总执行的汇总类型。
否
timeWeightAccount
用于时间汇总的权重账户。
否
levelDimRollupType
要对层级/自定义维度汇总执行的汇总类型。
否
levelDimWeightAccount
用于层级/自定义维度汇总的权重账户。
否
levelDimRollupText
在层级/自定义维度汇总中使用的汇总文本值。
否
actualsOverlay
账户的实际值覆盖设置。
否
attributeValues
此账户的账户属性值对象列表。
否
displayAs
账户的显示格式设置。
否
公式
账户公式
否
decimalPrecision
账户的默认小数精度。
否
exchangeRateType
此账户的汇率类型。
否
suppressZeros
返回是否应为工作表上的账户隐藏零行。
否
startExpanded
返回账户在工作表上是否开始展开。
否
dataEntryType
此账户的数据输入类型设置。
否
dataPrivacy
此账户的数据隐私设置。
否
linkedAccountMappings
LinkedAccountMapping 列表
否
工作表辅助功能对象
名称
描述
必填
类型
默认
用户名
要添加到工作表的用户名列表。
必须采用有效电子邮件地址的形式。
否
字符串数组
excludedFromWorkflow
更新工作表辅助功能设置中的“不显示在工作流中”复选框。
否
布尔值
false
示例回复
204
成功回复为空，状态代码为 204。

DELETE

请求 URI
/sheet/cube/definition
删除与给定查询参数匹配的多维工作表定义。如果不存在具有匹配编号的工作表，则会出现“未找到”错误。
请求示例（按名称）
https://api.adaptiveplanning.com/api/rest/modeling/v1/globosales/sheet/cube/definition?name=Sales Cube
请求标头示例
接受-语言：en
请求正文示例
<无>
查询参数
名称
描述
必填
名称
多维工作表的名称。
否
instanceCode
要从中检索值的 instanceCode。例如，GLOBO。如果未指定 instanceCode，则使用用户的默认实例。
否
示例回复
204
成功响应为 blane，状态代码为 204。