categories

SIDfmVMサーバに登録されているカテゴリ一覧を取得するためのエンドポイントです。

エンドポイント	categories
機能	カテゴリ一覧取得
実装バージョン	2.7.0
認証	有り
HTTPメソッド	GET/POST

パラメータ

入力値	機能	入力値の型	デフォルト値
q[api_key]	パラメータで認証を行う場合に API キーを指定します。 X-API-Key としてリクエストヘッダに API キーを設定した場合は、このパラメータは X-API-Key での認証に失敗した場合にのみ参照されます。	String	なし
q[offset]	取得するデータの先頭位置を指定します。	Number	0
q[per_page]	1～200 の値で、1 度に取得するデータの数を指定します。指定した値が 1～200 を超えている場合は 10 として扱われます。 ※ 全データ数の指定は不可です。	Number	10
q[filters][name]	カテゴリ名の部分一致で、取得するカテゴリを絞り込みます。配列で複数指定すると、指定した全ての文字列がカテゴリ名に部分一致するカテゴリに絞り込みます。 1 つ指定する場合は、文字列でも指定可能です。	String/Array<String>	なし
q[filters][is_system]	true の場合システムカテゴリを、false の場合カスタムカテゴリに取得するカテゴリを絞り込みます。	Boolean	なし
q[filters][id]	カテゴリの ID で、取得するカテゴリを絞り込みます。配列で複数指定すると、指定したいずれかの ID のカテゴリに絞り込みます。 1 つ指定する場合は、数値でも指定可能です。	Number/Array<Number>	なし

レスポンス

key	value の内容	value の型
success	認証の成否	Boolean
response	エラー等の補足情報	Hash
total_size	取得したカテゴリの数	Number
categories	カテゴリ一覧	Array<Hash>
id	カテゴリID	Number
name	カテゴリ名	String
desc	概要	String
hostlim	ホスト登録上限数	Number/Null
is_system	trueの場合: システムカテゴリ falseの場合: カスタムカテゴリ	Boolean

レスポンス例

{
  "success": true,
  "response": {},
  "total_size": 1,
  "categories": [
    {
      "id": 23,
      "name": "業務 部",
      "desc": "業務部",
      "hostlim": 7,
      "is_system": false
    }
  ]
}

サンプルコード

※ 実際にサンプルコードを試す場合は、色のついている箇所をご自身の環境に合わせて変更しご利用ください。
サンプルコードを試す場合、変更箇所の「http(s)://hostname/redmine」は、システム設定の「メール通知設定用のURL」を、「apikey」は、VM APIキー設定画面で登録済みのAPIキーを設定する必要があります。