4.1.6. 設定変更API¶

この章では Senju Configuration Manager の設定変更APIの操作方法について説明します。

注釈

このAPIはユーザーのロールにより利用できる内容が異なります。また、Administratorロールのユーザーでは利用できません。

注釈

APIの利用にあたっては、ログインユーザーごとに予め発行したAPIトークンをリクエストに含める必要があります。 APIトークンはHTTPヘッダにてキー名 sjcm-api-token の値として指定してください。

注釈

対象データを特定するための条件として、クエリ文字列に検索条件を指定することができます。なお、クエリ文字列はURLエンコードされている必要があります。

4.1.6.1. ロール別の可能な操作¶

このAPIについて、ユーザーのロール別の利用可能な内容は以下のとおりです。

設定変更APIの基本的なURL構造は以下のとおりです。

https://{server}:{port}/api/{version}/Settings?type={type}

{type} 部分に指定可能な種別には以下があります。

対象データの設定内容を参照する場合、GETメソッドでリクエストします。

指定可能なパラメータは以下のとおりです。

表 4.10 Parameter¶
パラメータ名	値の型	指定要否	説明
`type`	string	必須
`common`	string	任意	検索条件を指定します
`search`	string	任意	検索条件を指定します

パラメータ common には以下の項目を指定できます。

対象データの設定を新規作成する場合、POSTメソッドでリクエストします。

指定可能なパラメータは以下のとおりです。

表 4.12 Parameter¶
パラメータ名	値の型	指定要否	説明
`type`	string	必須

また、HTTPリクエストのペイロードにて、対象データの各プロパティ値をJSON構造で指定します。各データのJSON構造は、設定内容の参照APIにより応答されるデータと同様です。

対象データの設定を更新する場合、PUTメソッドでリクエストします。

指定可能なパラメータは以下のとおりです。

表 4.13 Parameter¶
パラメータ名	値の型	指定要否	説明
`type`	string	必須
`id`	int	必須	対象データのId値を指定します。

対象データの設定を更新する場合、DELETEメソッドでリクエストします。

指定可能なパラメータは以下のとおりです。

表 4.14 Parameter¶
パラメータ名	値の型	指定要否	説明
`type`	string	必須
`id`	int	必須	対象データのId値を指定します。

APIのレスポンスに失敗した場合、以下のHTTPステータスコードを応答します。

表 4.15 処理失敗時のHTTPステータスコード¶
コード	メッセージ	発生条件
400	`The type field is required.`	typeが未指定です
400	`Type is illegal`	typeが不正値です
400	`Not supported for the value. (Key: xxx, Val: x)`	指定したパラメータが不正値です
401	`sjcm-api-token HTTP Header Not Found.`	tokenが未指定です
401	`Token access permission expired`	tokenが不正値です
401	`The current user does not have permission to access`	tokenの権限不足です