# 転送グループ情報の一覧取得

登録済みの転送グループ情報の一覧を取得します。

「QUERY PARAMETERS」で指定された内容に基づき、該当する転送グループ情報を取得します。

指定方法については、以下の例を参照してください。

例1）

全件取得したい場合

- パラメータ「limit」に登録済みの転送グループ情報の件数以上の値を指定

例2）

管理情報の有効期間が「2025/10/1～2026/3/31」の管理情報を「ファイルID」の「昇順」で取得したい場合

- パラメータ「order-column」に「id」を指定

- パラメータ「order」に「asc」を指定

- パラメータ「from-valid-term-start」に「2025-10-01T00:00:00%2B09:00」を指定

- パラメータ「to-valid-term-start」に「2025-10-02T00:00:00%2B09:00」を指定

- パラメータ「from-valid-term-end」に「2026-03-31T00:00:00%2B09:00」を指定

- パラメータ「to-valid-term-end」に「2026-04-01T00:00:00%2B09:00」を指定

## Request Interface

    https://ControlURL/api/v1/managements/transfer-groups/list

= 備考 =

WebAPIのControlURLで指定するパスはHULFTの管理画面にアクセスするためのURLと同じURLです。

詳細は以下を参照してください。

スタートアップガイド（EC2）

  : 導入手順

スタートアップガイド（Fargate）

  : 導入手順

QUERY PARAMETERS

limit : integer

  検索件数の上限

  省略すると、“100”が設定されます。

offset : integer

  検索結果のオフセット

  省略すると、“0”が設定されます。

order-column : string

  並び替え

  検索結果の並び替えを行うフィールド

  省略すると、“id”が設定されます。

order : string

  並び替え

  検索結果の並び替え順序

  省略すると、“asc”が設定されます。

  以下のいずれかを指定します。

  asc

    : 昇順

  desc

    : 降順

id : string

  転送グループID

  転送グループを認識するためのID

modified-datetime : string <date-time>

  管理情報の更新日時

from-modified-datetime : string <date-time>

  管理情報の更新日時の範囲指定

  指定した日時以後を表示

to-modified-datetime : string <date-time>

  管理情報の更新日時の範囲指定

  指定した日時以前を表示

modified-user : string

  更新ユーザー

display-name : string

  表示名

comment : string

  コメント

valid-term-start : string <date-time>

  管理情報の有効期間（開始）

from-valid-term-start : string <date-time>

  管理情報の有効期間（開始）の範囲指定

  指定した日時以後を表示

to-valid-term-start : string <date-time>

  管理情報の有効期間（開始）の範囲指定

  指定した日時以前を表示

valid-term-end : string <date-time>

  管理情報の有効期間（終了）

from-valid-term-end : string <date-time>

  管理情報の有効期間（終了）の範囲指定

  指定した日時以後を表示

to-valid-term-end : string <date-time>

  管理情報の有効期間（終了）の範囲指定

  指定した日時以前を表示

## Response Interface

### 200 管理情報の取得に成功

RESPONSE HEADERS

X-Request-ID : string

  WebAPI履歴のリクエストID

RESPONSE SCHEMA : application/json

meta : object

  メタ情報

  total : integer

    検索条件に一致するレコードの総数

  request_user : object

    ロール情報

    systems_role : string

      APIを実行したユーザーの「ユーザーの権限」

records : Array of objects

  検索結果に一致するレコードのうちオフセットからリミットまで取り出したもの

  以下の構造の情報（Array[]）が複数取得されます。

  Array[

  id : string

    転送グループID

  meta : object

    メタ情報

    modified_datetime : string <date-time>

      更新日時

    modified_user : string

      更新ユーザー

    display_name : string

      表示名

    comment : string

      コメント

    valid_term : object

      管理情報の有効期間

      start : string <date-time>

        有効期間 (開始)

      end : string <date-time>

        有効期間 (終了)

  ]

### 400 リクエストパラメーターの指定が不正

RESPONSE HEADERS

X-Request-ID : string

  WebAPI履歴のリクエストID

RESPONSE SCHEMA : application/json

request_id : string

  リクエストID

accept_datetime : string <date-time>

  受付日時

api_path : string

  APIパス

http_method : string

  HTTPリクエストのメソッド形式

  以下のいずれかが取得されます。

  GET

  HEAD

  POST

  OPTIONS

  PUT

  DELETE

  TRACE

  PATCH

  LINK

  UNLINK

errors : Array of objects

  エラー詳細情報

  以下の構造の情報（Array[]）が複数取得されます。

  Array[

  kind : string

    エラー種別

  description : string

    エラーの説明

  measure : string

    対処方法

  detail : string

    詳細エラー情報

  additional : (Error1(object or null)) or (Error2(object or null)) or (Error3(object or null))

    "Error1"、"Error2"、"Error3"のいずれかが取得されます。

    Error1
      message : string

        エラーメッセージ

      tables : Array of strings

        テーブル情報

      query : string

        クエリ情報

    Error2
      hulft_id : string

        HULFT ID

      code : integer

        実行結果

      detail : integer

        詳細コード

      message : string

        エラーメッセージ

    Error3
      message : string

        エラーメッセージ

      fields : string

        クエリ情報

  ]

### 401 認証エラー

RESPONSE HEADERS

X-Request-ID : string

  WebAPI履歴のリクエストID

RESPONSE SCHEMA : application/json

request_id : string

  リクエストID

accept_datetime : string <date-time>

  受付日時

api_path : string

  APIパス

http_method : string

  HTTPリクエストのメソッド形式

  以下のいずれかが取得されます。

  GET

  HEAD

  POST

  OPTIONS

  PUT

  DELETE

  TRACE

  PATCH

  LINK

  UNLINK

### 403 認可エラー

RESPONSE HEADERS

X-Request-ID : string

  WebAPI履歴のリクエストID

RESPONSE SCHEMA : application/json

request_id : string

  リクエストID

accept_datetime : string <date-time>

  受付日時

api_path : string

  APIパス

http_method : string

  HTTPリクエストのメソッド形式

  以下のいずれかが取得されます。

  GET

  HEAD

  POST

  OPTIONS

  PUT

  DELETE

  TRACE

  PATCH

  LINK

  UNLINK

errors : Array of objects

  エラー詳細情報

  以下の構造の情報（Array[]）が複数取得されます。

  Array[

  kind : string

    エラー種別

  description : string

    エラーの説明

  measure : string

    対処方法

  detail : string

    詳細エラー情報

  additional : (Error1(object or null)) or (Error2(object or null)) or (Error3(object or null))

    "Error1"、"Error2"、"Error3"のいずれかが取得されます。

    Error1
      message : string

        エラーメッセージ

      tables : Array of strings

        テーブル情報

      query : string

        クエリ情報

    Error2
      hulft_id : string

        HULFT ID

      code : integer

        実行結果

      detail : integer

        詳細コード

      message : string

        エラーメッセージ

    Error3
      message : string

        エラーメッセージ

      fields : string

        クエリ情報

  ]