2. APIリファレンス詳細
APIリファレンス詳細では各APIの詳細を説明します。
APIは以下にわけて掲載しています。
- 標準提供API：
ユーザー、グループ管理やYAMLファイルの登録状況確認などに使用します。
APIのカスタムはできません。 - カスタムAPI：
チケット管理に使用します。
チケット画面のカスタムをする際はAPIもあわせてカスタムする必要があります。
注意事項
- リクエストボディおよびレスポンスの説明に「（Reserved Field）」と記載があるフィールドは予約フィールドです。
- レスポンスに含まれる予約フィールドの値は参照しないでください。
- POSTメソッドのリクエストボディの予約フィールドには、フィールドの説明に記載された値を設定してください。
- PUTメソッドのリクエストボディには、GETメソッドを実行して取得したレスポンスボディに対して、APIの説明に記載のある更新がサポートされているフィールドだけ変更して設定してください。
- APIが返却するステータスコードを、以下の「（表）APIが返却するステータスコード」に記載します。
| ステータスコード | 説明 |
|---|---|
| 400 | リクエストボディのJSON構文が不適切な場合 |
| リクエストボディが求められているオブジェクトと異なる場合 | |
| 401 | Ops Iトークンが不正な値の場合 |
| 403 | ユーザーにAPIを実行可能な権限が割り当てられていない場合 |
| APIのパスの指定が間違っている場合 | |
| 上記以外 | API ごとに異なります。 「標準提供API」および「カスタムAPI」を参照してください。 |
章構成