11.3 REST APIの記述形式
「各REST APIの詳細」でのAPIの記述形式を示します。ここではURLスキーム，ドメイン名およびコンテキストルートは省略します。例えば，ドメイン名がrestserverの場合，案件一覧を取得するREST APIのURLは，http://restserver/csciwws/v1/process-instanceのようになります。
メソッドとURL
メソッドとURLの形式を説明しています。
クエリパラメタまたはリクエストボディ
各クエリパラメタまたはリクエストボディに指定する名前，型，省略可否，および内容について説明しています。APIによって，クエリパラメタまたはリクエストボディのどちらかを使用します。
- ヒント
-
一覧を取得するAPIの場合に，クエリパラメタのfilter，sort，offset，およびmaxcountに指定できる内容の詳細については，マニュアルuCosminexus Service Coordinator Interactive Workflow AP開発ガイドの「2.7 一覧情報の取得」および「付録B.1 指定できる属性一覧」を参照してください。
案件を生成して開始するAPIの場合に，リクエストボディのName，Deadline，Priorityに指定できる内容の詳細については，マニュアルuCosminexus Service Coordinator Interactive Workflow AP開発ガイドの「5.6 CIWServer（ワーク管理システム全般にかかわる処理を行うための機能を提供するインタフェース）」の「createAndStartProcessInstance」を参照してください。
リクエスト例
リクエストURLおよびリクエストボディの指定例を示しています。
レスポンス
レスポンスの形式を説明しています。レスポンスがXML形式またはJSON形式の場合，その構造も説明しています。
ステータスコード
ステータスコード，メディアタイプおよび内容を説明しています。
レスポンス例
レスポンス例を示しています。