跳至主要内容
Adaptive Planning
上次更新时间 :2023-06-23
层级

层级

版本:v1

支持的 HTTP VERB

HTTP 谓词
状态
描述
POST
支持
删除请求中提及的层级。

POST

请求:
/removeLevels
删除给定层级代码对应的层级。
请求 URI 示例:
https://api.adaptiveplanning.com/api/rest/modeling/v1/globosales/removeLevels
https://api.adaptiveplanning.com/api/rest/modeling/v1/globosales/removeLevels?forceRemove=false&&doValidateOnly=true&&showWarnings=true
请求标头示例:
授权:基本
Content-Type: application/json
请求正文示例
POST 请求示例
{ "levelCodesToDelete": ["testLevel", "HQ"] }
负载参数
名称
描述
必填
levelCodesToDelete
要删除的层级代码名称
路径参数
名称
描述
必填
租户
要操作的租户。例如 globosales
查询参数
名称
描述
必填
默认
forceRemove
当forceRemove=true 时删除正在使用的账户,当forceRemove=false 时忽略正在使用的账户。
默认值始终为forceRemove=false
instanceCode
要从中检索值的 instanceCode。例如,GLOBO。如果未指定 instanceCode,则使用用户的默认实例。
doValidateOnly
在验证模式下处理请求,这意味着变更不会在数据库中持久保存。
false
ShowWarnings
删除操作中忽略/跳过的任何维度值后面的“警告”列表。
false
示例回复:
200 OK
成功回复
{ "total": 1 }
回复成功,但出现警告
{ "total": 0, "warning": { "info": "Some levels were not deleted.", "warnings": [ { "field": "HQ", "warning": "Default Root Plans cannot be deleted." } ] } }
400 错误请求
服务器无法识别该请求。
401 未授权
用户未获授权。
403 禁止访问
用户权限不足。
500 内部服务器错误
内部服务器错误。