4.1.7. 処理制御API¶

この章では Senju Configuration Manager の処理制御APIの操作方法について説明します。

設定変更メニューの各項目で作成したデータは、有効/無効の設定を持ちます。この有効/無効を切り替えることで、タスクやルールアクションの処理を制御することができます。

注釈

このAPIはManagerロールまたはOperatorロールのユーザーが利用できます。

注釈

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

注釈

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

4.1.7.1. 基本構造¶

処理制御APIの基本的な構造は以下のパターンがあります。なお全てPATCHメソッドでリクエストします。

表 4.16 エンドポイントのパターン¶
エンドポイント	ペイロード
`api/{version}/{Type}?Id={id}&IsEnabled=false`
`api/{version}/{Type}`	`{"Id":{id} , "IsEnabled":true}`
`api/{version}/{Type}/{id}?IsEnabled=true`
`api/{version}/{Type}/{id}`	`{"IsEnabled":true}`
`api/{version}/{Type}?IsEnabled=false`	`{"Id":{id}}`
`api/{version}/{Type}/{id}/IsEnabled`	`false`

以下はURL構造の例です。

https://{server}:{port}/api/{version}/{Type}/{id}?IsEnabled=true

上述の {Type} 部分には以下の項目を指定できます。

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

表 4.18 処理失敗時のHTTPステータスコード¶
コード	メッセージ	発生条件
400	`The {param} field is required.`	IDまたIsEnableが未指定です
401	`Token access permission expired.`	指定したトークンが不正です
404	`Not Found.`	IDが範囲外であるなど条件不正です