ユーザー詳細登録API
指定されたパラメーターでユーザー詳細を登録する。
メソッド
POST
パス
/user_detail/add/{object_id}
Name | 型 | 概要 |
---|---|---|
object_id (必須) | 文字列 | オブジェクトID |
リクエストボディ
Name | 型 | 概要 |
---|---|---|
tenant_id (必須) | 文字列 | テナントID ※別途お渡しした内容をご利用ください。 |
contents.user_id (必須) | 文字列 | ユーザーID ※顧客番号とユーザーアクセストークンといずれか必須 |
contents.user_no (必須) | 文字列 | 顧客番号 ※ユーザーIDとユーザーアクセストークンといずれか必須 |
contents.user_access_token (必須) | 文字列 | ユーザーアクセストークン ※ユーザーIDと顧客番号といずれか必須 |
contents.free_columns.{field_name} | 文字列 | 自由項目 ※未指定の項目は登録されません。 |
contents.visibility | 文字列 | 公開範囲 ※未指定時は「0001:非公開」が設定されます。 |
ヒント
contents.free_columns.{field_name}
には name
、age_config
などの登録するユーザー詳細の項目名を指定します。
レスポンスボディ
Name | 型 | 概要 |
---|---|---|
status (必須) | 文字列 | ステータスコード |
message (必須) | 文字列 | 実行メッセージ |
contents.detail_message | 文字列、配列 | エラーメッセージ |
レスポンスの例
{
"status": "1001",
"message": "正常終了",
"contents": {
"data": [
{
"id": "abcd1234abcd1234abcd1234abcd1234,1234abcd1234abcd1234abcd1234abcd,abcdefgh12345678abcdef==",
"code": "0000000001",
"sort_no": "1",
"object_sort_no": "1",
"user_id": "210010000000001",
"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"
}
]
}
}