組織更新
概要¶
APIを使用してレコードを更新する事ができます。
事前準備¶
- APIの操作を行う前にAPIキーの作成を実施してください。
- この機能を実行するための API キーを払い出すユーザにはテナント管理者権限が付与されている必要があります。
リクエスト¶
下記のリクエスト形式で、jsonデータを送信します。
| 設定項目 | 値 |
|---|---|
| HTTPメソッド | POST |
| Content-Type | application/json |
| 文字コード | UTF-8 |
| URL | http://{サーバー名}/api/depts/{組織ID}/update(※1) |
| Body | 以下のjsonデータを参考のこと |
(※1){サーバー名}、{組織ID}の部分は、適宜、環境に合わせて編集してください。
pleasanter.netの場合は以下の形式になります。
https://pleasanter.net/fs/api/depts/{組織ID}/update
JSON¶
{
"ApiVersion": 1.1,
"ApiKey": "8s63Aiigd98h51Dfda7951...",
"DeptCode": "[更新後の組織の組織コード]",
"DeptName": "[更新後の組織の名前]",
"Body": "[更新後の組織の説明]"
}
レスポンス¶
下記の形式のjsonデータが返却されます。
JSON¶
エラー時の確認事項¶
・API使用時の注意点やエラーが発生する場合の確認事項
・FAQ:変更後の設定ファイルやAPIリクエスト(JSON形式)が正しく認識されない場合の確認事項
