Hitachi

uCosminexus Service Coordinator Interactive Workflow システム構築・運用ガイド


付録I.10 運用管理REST APIの記述形式

運用管理REST APIのURL,リクエスト,レスポンスの仕様を次に示します。ここではURLスキーム,ドメイン名およびコンテキストルートは省略します。例えば,ドメイン名がrestserverの場合,ジョブレコードの一覧取得のAPIのURLは,http://restserver/csciwmngws/v1/jobのようになります。

●メソッドとURL

メソッドとURLの形式を説明しています。

●クエリパラメタまたはリクエストボディ

各クエリパラメタまたはリクエストボディに指定する名前,型,省略可否,および内容について説明しています。APIによって,クエリパラメタまたはリクエストボディのどちらかを使用します。

●リクエスト例

リクエストURLおよびリクエストボディの指定例を示しています。

●レスポンス

レスポンスの形式を説明しています。レスポンスがXML形式またはJSON形式の場合,その構造も説明しています。

●ステータスコード

ステータスコード,メディアタイプおよび内容を説明しています。

●レスポンス例

レスポンス例を示しています。