メインコンテンツにスキップ
Adaptive Planning
最終更新: 2023-06-23
組織

組織

バージョン: v1

サポートされている HTTP VERB

HTTP Verb
ステータス
説明
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
リクエスト ヘッダーの例:
認証: 基本
コンテンツ タイプ: application/json
リクエスト本文の例
POST リクエストの例
{ "levelCodesToDelete": ["testLevel", "HQ"] }
ペイロード パラメータ
名前
説明
必須
levelCodesToDelete
削除される組織コードの名前
あり
パス パラメータ
名前
説明
必須
テナント
操作対象のテナント。例: グローバル営業
あり
クエリー パラメータ
名前
説明
必須
デフォルト
forceRemove
forceRemove=true の場合は使用中の科目を削除し、forceRemove=false の場合は使用中の科目を無視します
デフォルトは常にforceRemove=falseです
なし
instanceCode
値の取得元の instanceCode 。たとえば、GLOBO。instanceCode が指定されていない場合は、ユーザーのデフォルトのインスタンスが使用されます。
なし
doValidateOnly
検証モードでリクエストを処理します。これは、変更が DB に残らないことを意味します。
なし
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 内部サーバー エラー
内部サーバー エラーです。