データ取得API

指定されたパラメーターでデータを取得する。

メソッド

POST

パス

/masters/ex/get/{object_id}

Name概要
object_id(必須)文字列オブジェクトID

リクエストボディ

Name概要
tenant_id(必須)文字列テナントID
※別途お渡しした内容をご利用ください。
contents.search_condition.{field_name}文字列検索条件
{field_name}には取得するデータの項目名を指定します。
※指定可能な条件については検索条件を参照ください。
contents.order_condition.{field_name}オブジェクトソート条件
{field_name}にはソートするデータの項目名を指定します。
※指定可能な条件についてはソート条件を参照ください。
contents.limit数値取得する件数の上限数
contents.offset数値取得開始位置

レスポンスボディ

Name概要
status(必須)文字列ステータスコード
message(必須)文字列実行メッセージ
contents.detail_message文字列、配列エラーメッセージ
contents.master_label文字列オブジェクト名称
contents.result_cnt数値検索結果の件数
contents.offsetcontents.limitに設定した条件を含まない、検索結果の総件数が設定されます。
contents.data配列結果の配列
配列内の個々の内容はフィールド管理に準拠します。

レスポンスの例

{
  "status": "1001",
  "message": "正常終了",
  "contents": {
    "detail_message": "",
    "master_label": "店舗",
    "result_cnt": 2,
    "data": [
      {
        "code": "0001",
        "name": "People Cafe Okayama",
        "short_name": "Okayama",
        "category_cd": "0001",
        "category_cd_name": "飲食店",
        "sort_no": "1",
        "not_use_flg": "0",
        "not_edit_flg": "0",
        "not_delete_flg": "0",
        "sys_insert_date": "2021-11-16 17:57:37",
        "sys_update_date": "2025-11-16 10:11:57"
      },
      {
        "code": "0002",
        "name": "People Cafe Kurashiki",
        "short_name": "Kurashiki",
        "category_cd": "0001",
        "category_cd_name": "飲食店",
        "sort_no": "2",
        "not_use_flg": "0",
        "not_edit_flg": "0",
        "not_delete_flg": "0",
        "sys_insert_date": "2024-05-10 20:17:05",
        "sys_update_date": "2024-05-10 20:17:05"
      }
    ]
  }
}