ユーザー詳細情報取得API

指定されたパラメーターでユーザー詳細情報を取得する。

メソッド

POST

パス

/user_detail/ex/get/{object_id}

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

リクエストボディ

Name	型	概要
tenant_id(必須)	文字列	テナントID ※別途お渡しした内容をご利用ください。
contents.user_id(必須)	文字列	ユーザーID ※顧客番号とユーザーアクセストークンといずれか必須
contents.user_no(必須)	文字列	顧客番号 ※ユーザーIDとユーザーアクセストークンといずれか必須
contents.user_access_token(必須)	文字列	ユーザーアクセストークン ※ユーザーIDと顧客番号といずれか必須
contents.search_condition	オブジェクト	検索条件
contents.order_condition	オブジェクト	ソート条件 ※取得結果の並び順を指定してください。
contents.limit	数値	取得する件数の上限数
contents.offset	数値	取得開始位置
contents.visibility	文字列	公開範囲 ※未指定時は「0001:非公開」が設定されます。

ヒント

contents.search_condition.{field_name}には name、age_configなどの取得するユーザーの検索条件の項目名を指定します。

レスポンスボディ

Name	型	概要
status(必須)	文字列	ステータスコード
contents.detail_message	文字列、配列	エラーメッセージ
contents.object_label	オブジェクト	取得したオブジェクトID
contents.data	配列	結果の配列 配列内の個々の内容はフィールド管理に準拠します。

レスポンスの例

{
  "status": "1001",
  "message": "正常終了",
  "contents": {
    "master_label": "test_user_detail",
    "result_cnt": 2,
    "data": [
      {
        "id": "abcd1234abcd1234abcd1234abcd1234,1234abcd1234abcd1234abcd1234abcd,abcdefgh12345678abcdef==",
        "code": "0000000001",
        "sort_no": "1",
        "object_sort_no": "1",
        "user_id": "210110000000001",
        "user_tenant_id": "21001",
        "user_no": "APP00001",
        "visibility": "0001",
        "visibility_name": null,
        "name": "shop_review",
        "sys_insert_date": "2024-01-01 00:00:00",
        "sys_update_date": "2024-01-01 00:00:00"
      },
      {
        "id": "ab12cd34ab12cd34ab12cd34ab12cd34,12ab34cd12ab34cd12ab34cd,a1b2c3d4e5f6g7h8a1b2c3==",
        "code": "0000000002",
        "sort_no": "2",
        "object_sort_no": "2",
        "user_id": "210110000000002",
        "user_tenant_id": "21001",
        "user_no": "APP00002",
        "visibility": "0001",
        "visibility_name": null,
        "name": "shop_review2",
        "sys_insert_date": "2024-01-01 00:00:00",
        "sys_update_date": "2024-01-01 00:00:00"
      }
    ]
  }
}