跳至主要内容
文档
文档
Adaptive Planning
上次更新时间 ：2023-06-23
工作表可用性

工作表可用性

URL 端点

HTTPS://api.adaptiveinsights.com/api/rest/modeling/<version>/<tenant>/sheet/availability
版本：v1
种类
元数据修改
描述
检索或更新维度或属性值在给定工作表和列中的可用性。
调用所需的权限
模型管理访问权限
模型包括：工作表、账户、维度和公式
请求时必须提供参数
工作表名称, 列名称

支持的 HTTP VERB

HTTP 谓词
单一资源
收款资源
描述
GET
不支持
支持
检索给定工作表和列的所有值的可用性。
POST
不支持
支持
更新给定工作表和列的值的可用性。
选项
支持
支持
返回此集合资源支持的 HTTP 谓词列表。

GET：

请求：
/sheet/availability:
检索值可用性的集合。
检索工作表维度中所有值的可用性。您可以按 instanceCode、sheetName 和 columnName 进行筛选。
请求 URI 示例：
HTTPS://api.adaptiveinsights.com/api/rest/modeling/v1/globosales/sheet/availability?sheetName=ExpenseCube&columnName=Level&columnType=Level
请求标头示例：
接受-语言：en
请求正文示例
查询参数
名称
描述
必填
sheetName
要从中检索可用性值的工作表的名称。
是
columnName
要从中检索可用性值的工作表列的名称。仅对于多维工作表为必填。
仅支持可修改值可用性的列。
对于多维工作表账户列和层级列，列名称遵循“Accept-Language”标头中设置的区域设置。
是
columnCode
要从中检索可用性值的工作表列的代码。仅对于模型化工作表为必填。
仅支持可修改值可用性的列。
是
columnType
给定的 columnName 或 columnCode 对应的列类型。
可接受的值：账户、层级、维度、属性
是
instanceCode
要从中检索值的 instanceCode。例如，GLOBO。如果未指定 instanceCode，则使用用户的默认实例。
否
limit
单个响应中的最大对象数。
否
offset
响应集合中第一个对象的索引（从零开始）。默认值为 0。
将 offset 与 limit 参数结合使用，可控制回复集合的分页。
否
示例回复
200
成功响应。
示例回复
 
{
    "data": [
        {
            "code": "Corporate Plan",
            "name": "Corporate Plan",
            "available": true
        },
        {
            "code": "Engineering",
            "name": "Engineering",
            "available": true
        },
        {
            "code": "Development",
            "name": "Development",
            "available": true
        },
        {
            "code": "Documentation",
            "name": "Documentation",
            "available": true
        },
        {
            "code": "QA",
            "name": "QA",
            "available": true
        },
        {
            "code": "2014-Development Organization",
            "name": "2014-Development Organization",
            "available": false
        },
        {
            "code": "Development-India",
            "name": "Development-India",
            "available": false
        },
        {
            "code": "QA-India",
            "name": "QA-India",
            "available": false
        },
        {
            "code": "G & A",
            "name": "G & A",
            "available": false
        },
        {
            "code": "Hosting",
            "name": "Hosting",
            "available": true
        },
        {
            "code": "Professional Services",
            "name": "Professional Services",
            "available": true
        },
        {
            "code": "Sales",
            "name": "Sales",
            "available": true
        },
        {
            "code": "Marketing",
            "name": "Marketing",
            "available": true
        },
        {
            "code": "US Sales",
            "name": "US Sales",
            "available": false
        },
        {
            "code": "Worldwide Sales",
            "name": "Worldwide Sales",
            "available": true
        },
        {
            "code": "Asia Sales",
            "name": "Asia Sales",
            "available": false
        },
        {
            "code": "Europe Sales",
            "name": "Europe Sales",
            "available": true
        },
        {
            "code": "Latin America Sales",
            "name": "Latin America Sales",
            "available": true
        }
    ],
    "total": 18
}

发布：

请求：
/sheet/availability:
更新值集合的可用性。
更新工作表维度中所有值的可用性。
请求 URI 示例：
https://api.adaptiveplanning.com/api/rest/modeling/v1/globosales/sheet/availability?sheetName=ExpenseCube&columnName=Level&columnType=Level
请求标头示例：
接受-语言：en
请求正文：
可用性对象的 JSON 数组，与导出的“data”属性匹配。每个 JSON 对象都具有以下结构：
名称
描述
必填
代码
值的代码。用于唯一标识值。
是
名称
值的名称。
是
accountGroup
值是否为账户组。对于账户为必填。
否
有空
值是否可用。如果不存在，则不会进行任何更改。
否
deleteIfDataIsPresent
是否删除数据（如果存在）。在多维工作表上禁用自定义维度值时为必填。
否
actionIfDataIsPresent
存在数据时要执行的操作。在模型化工作表上禁用自定义维度值时为必填。
否
请求正文示例
请求正文
 
[
    {
        "code": "SalesCube.DiscountPercent",
        "name": "Discount Percent",
        "accountGroup": false,
        "available": false
    }
]
查询参数
名称
描述
必填
sheetName
要从中检索可用性值的工作表的名称。
是
columnName
要从中检索可用性值的工作表列的名称。仅对于多维工作表为必填。
仅支持可修改值可用性的列。
对于多维工作表账户列和层级列，列名称遵循“Accept-Language”标头中设置的区域设置。
是
columnCode
要从中检索可用性的工作表列的代码。仅对于模型化工作表为必填。
仅支持可修改值可用性的列。
是
columnType
给定的 columnName 或 columnCode 对应的列类型。
可接受的值：账户、层级、维度、属性。
是
instanceCode
要从中检索值的 instanceCode。例如，GLOBO。如果未指定 instanceCode，则使用用户的默认实例。
否
示例回复：
204
成功响应为空，状态代码为 204。