2. APIリファレンス詳細
APIリファレンス詳細では各APIの詳細を説明します。
APIは以下に分けて掲載しています。
- 標準提供API：
ユーザー、グループ管理やYAMLファイルの登録状況確認などに使用します。
APIのカスタムはできません。 - カスタムAPI：
チケット管理に使用します。
チケット画面のカスタムをする際はAPIもあわせてカスタムする必要があります。
注意事項
- リクエストボディおよびレスポンスの説明に「（Reserved Field）」と記載があるフィールドは予約フィールドです。
- レスポンスに含まれる予約フィールドの値は参照しないでください。
- POSTメソッドのリクエストボディの予約フィールドには、フィールドの説明に記載された値を設定してください。
- PUTメソッドのリクエストボディには、GETメソッドを実行して取得したレスポンスボディに対して、APIの説明に記載のある更新がサポートされているフィールドだけ変更して設定してください。
章構成