Knowledge Suite+ を外部システムから利用する手段として、Webhookや外部連携用APIと言った機能が用意されています。
本ドキュメントでは外部連携 API について説明します。
外部連携 API は、前述通り Knowledge Suite+ の機能を外部のシステムから利用するためのAPIです。
外部連携 API を利用することにより、以下のようなシステム間連携を行う事が出来ます。
- 外部システムで登録された顧客データをKnowledgeSuite+の取引先データとして登録する
- KnowledgeSuite+で登録された取引先担当者の名刺データを取得して外部システム側で情報表示する
【この記事の内容】
外部連携 API で利用可能なKnowledge Suite+の機能
実行系API
| 種別 | API名 | 概要 |
| CRM | 取引先登録 | テナント内のデータとして取引先データを登録する |
| 取引先更新 | テナント内の取引先データを更新する | |
| 取引先削除 | テナント内の取引先データを削除する | |
| 取引先担当者登録 | テナント内のデータとして取引先担当者データを登録する | |
| 取引先担当者更新 | テナント内の取引先担当者データを更新する | |
| 取引先担当者削除 | テナント内の取引先担当者データを削除する |
参照系API
| 種別 | API名 | 概要 |
| CRM | 取引先テンプレート取得 | テナント内の取引先のテンプレートデータを取得する |
| 取引先一覧取得 | テナント内の取引先データを一覧リストとして取得する | |
| 取引先詳細取得 | パラメタの取引先IDに対応する取引先の詳細データを取得する | |
| 取引先担当者テンプレート取得 | テナント内の取引先担当者のテンプレートデータを取得する | |
| 取引先担当者一覧取得 | テナント内の取引先担当者データを一覧リストとして取得する | |
| 取引先担当者詳細取得 | パラメタの取引先担当者IDに対応する取引先担当者の詳細データを取得する | |
| 取引先担当者名刺一覧取得 | パラメタの取引先担当者IDに紐づく取引先担当者の名刺データを一覧リストとして取得する | |
| 組織 | 組織一覧取得 | テナントで登録されている組織データを一覧リストとして取得する |
| ユーザー一覧取得 | テナントで登録されているユーザーデータを一覧リストとして取得する |
外部連携 API へのアクセス方法
各APIのURLに HTTPS の POST メソッドでアクセスすることで利用可能です。
URL
※各API毎の説明を参照
リクエスト
API へのリクエストには以下の HTTP ヘッダを付与してください
| ヘッダ項目 | 設定内容 | 補足 |
| Content-Type | application/json | |
| Origin | 送信URL のホスト部まで | ※このあたりの仕様は RobotID や BFF の話になってきますので、 |
| Authorization | Bearer [アクセス用トークン] | ※アクセス用トークンの取得方法など含めそちらに問い合わせてください |
レスポンス
API からのレスポンスは JSON 文字列として返却されます。レスポンス JSON の内容は基本的に API 毎に異なりますが、AppStatus という項目はどのAPIのレスポンスにも含まれます。AppStatus の内容を参照することで API の成否についての情報を得る事が出来ます。
■ユーザー一覧取得、組織一覧取得の結果
| 必須 | 形式 | 補足 | ||
| AppStatus | 〇 | Object | API の実行情報 | |
| Code | 〇 | String | API の終了コード | |
| Message | String | API 終了コードに関連するメッセージ | ||
■それ以外
| 必須 | 形式 | 補足 | ||
| appStatus | 〇 | Object | API の実行情報 | |
| cpde | 〇 | String | API の終了コード | |
| message | String | API 終了コードに関連するメッセージ | ||
AppStatus.Code について
レスポンスの AppStatus.Code にはAPIの終了コードが格納されます。API の実行が成功している場合は "S000" という値が、API がエラー終了した場合は API・失敗原因毎にエラーの原因を表すコードが格納されます。
※ 各 API の個別説明を参照
全API共通の終了コード
下記の終了コードについては、全API共通です
| コード | メッセージ | 概要 |
| S000 | 正常終了 | |
| E280 | テナントが正しくありません | URL に問題がある可能性があります |
| E281 | トークンが不正です | アクセス時のヘッダ要素に Bearer トークンが存在していません |
| E282 | トークンが不正です | アクセストークンの内容が正しくありません |
| E283 | トークンの有効期限が切れています | アクセストークンの有効期限が切れています |
| E284 | トークンのスコープ外です | ご指定のアクセストークンでは利用できないAPIです |
| E380 | テナントの企業IDが一致しませんでした |
外部連携APIで操作した際の仕様の違いについて
外部連携APIで「取引先」「取引先担当」の登録、変更、削除の際はWebhookは発行されません。
それにより、ループを防ぐ為の仕様となっております。
実行系API
取引先登録API
| URL | https://（ホスト）/api/crm/client/register |
| Content-Type | application/json |
| HTTPメソッド | POST |
APIの概要
テナント内のデータとして取引先データを登録します。登録対象の取引先項目データを項目リストに指定して登録します。
登録成功時に、レスポンスで登録した取引先の取引先IDが返されます。
リクエストボディ（JSON）
| 必須 | 形式 | 内容 | 補足 | ||||||
| param | 〇 | Object | |||||||
| toData | 〇 | Object | |||||||
| clientRegisterInfo | 〇 | Object | |||||||
| clientItemList | 〇 | Object[] | |||||||
| itemID | 〇 | UUID | 取引先項目ID | 取引先項目IDについては、取引先テンプレート取得APIで取得出来るので同APIから取得 | |||||
| itemType | 〇 | String | 項目タイプ | 項目タイプの設定値および項目タイプの説明については、下記に記載 項目タイプ値および項目タイプの説明 |
|||||
| itemTextData | Object | 文字列型項目の値 |
項目タイプ（itemType）が文字列型の場合にこちらに項目データを設定。文字列型以外の場合は項目未設定 文字列型の項目タイプ:text_single,text_multiple,date,datetime,phone_number,url,mail_address,postal_code,prefectures,text_ruby |
||||||
| value | String | 項目値 | |||||||
| ruby | String | フリガナの値 | 項目タイプがtext_rubyの場合に、こちらにフリガナの値を設定する | ||||||
| itemNumericData | Object | 数値型項目の値 | 項目タイプ（itemType）が数値型の場合にこちらに項目データを設定。数値型以外の場合は項目未設定 数値型の項目タイプ:number,amount_integer,amount_decimal |
||||||
| value | String | 項目値 | |||||||
| itemSelectionData | Object | 選択肢型項目の値 | 項目タイプ（itemType）が選択肢型の場合にこちらに項目データを設定。選択肢型以外の場合は項目未設定 選択肢型の項目タイプ:pulldown,linkage_pulldown,checkbox |
||||||
| values | Integer[] | 項目値リスト | |||||||
| itemUuidData | Object | UUID型項目の値 | 項目タイプ（itemType）がUUID型の場合にこちらに項目データを設定。UUID型以外の場合は項目未設定 UUID型の項目タイプ:user_single,user_multiple,division_single,division_multiple,client_single,client_multiple,clientresponsible_single,clientresponsible_multiple,product_single,product_multiple |
||||||
| values | UUID[] | 項目値リスト | |||||||
| itemInquiryRouteDataList | Object[] | 引合経路型項目の値リスト | 項目タイプ（itemType）が引合経路型の場合にこちらに項目データを設定。引合経路型以外の場合は項目未設定 引合経路型の項目タイプ:inquiry_route |
||||||
| inquiryRouteCategoryId | UUID | 引合経路カテゴリID | |||||||
| inquiryRouteId | UUID | 引合経路ID | |||||||
| systemLinkageInfoList | Object[] | システム連携情報リスト | 取引先登録時にシステム連携ID値を併せて登録する場合に指定 | ||||||
| systemLinkageID | Integer | システム連携ID | システム連携設定で登録されたシステム連携IDを設定（999000001～999000020の値） | ||||||
| linkageIDValue | String | 連携ID値 | 登録対象の取引先に紐づく、連携システム側の顧客IDを登録値として設定 | ||||||
リクエストパラメタについての補足事項
①入力値のバリデーションチェックについて
パラメタで指定する登録値については、登録時にバリデーションチェックを行い、エラーの場合はバリデーションエラーとなります。
バリデーションチェックの内容は、項目タイプ（itemType）により異なり、下記に記載のチェックを項目タイプ別に実施します。
②必須項目チェックについて
取引先テンプレート項目の設定で必須となっている（必須フラグがtrueとなっている）項目については、登録対象項目リストに必須項目チェックが含まれているかチェックして、含まれていない場合はパラメタ不正エラーとなります。取引先テンプレートの項目情報については、取引先テンプレート取得APIで取得出来ますので、登録対象の項目が必須項目かどうかについては同APIの取得データを参照して確認可能です。
リクエスト例(JSON)
リクエスト例(JSON)
"{
""param"": {
""toData"": {
""clientRegisterInfo"": {
""clientItemList"": [
{
""itemID"": ""2205f2e3-839f-4ff3-80f2-1ce6f8a86ac7"",
""itemType"": ""text_ruby"",
""itemTextData"": {
""value"": ""TEST"",
""ruby"": ""テスト""
}
},
{
""itemID"": ""81818574-827d-4084-8b12-97b5b9a8d593"",
""itemType"": ""division_single"",
""itemUuidData"": {
""values"": [
""28ca2537-d541-42f9-b444-eca8144e130d""
]
}
},
{
""itemID"": ""88795555-0d22-46fd-bc6d-8a14c5d0dc7a"",
""itemType"": ""user_single"",
""itemUuidData"": {
""values"": [
""c84aa9a5-1390-41a4-9786-7cda5fd9971f""
]
}
},
{
""itemID"": ""a25d97d4-6c0f-43d0-8400-3c22802cbe4f"",
""itemType"": ""linkage_pulldown"",
""itemSelectionData"": {
""values"": [
11,
11,
13
]
}
}
],
""systemLinkageInfoList"": [
{
""systemLinkageID"": 999000001,
""linkageIDValue"": ""string""
}
]
}
}
}
}"
レスポンス JSON
| 必須 | 形式 | 内容 | 補足 | ||
| appStatus | 〇 | Object | API の実行情報 | ||
| code | 〇 | String | 終了コード | ||
| message | String | メッセージ | |||
| registerClientResult | Object | 取引先登録結果情報 | API が正常終了した場合のみ値を格納 | ||
| clientID | UUID | 登録された取引先の取引先ID | |||
レスポンス例(JSON)
{
"registerClientResult": {
"clientID": "5e4ea010-a908-45a1-a70b-ebd2e4feb055"
},
"appStatus": {
"code": "S000",
"message": ""
}
}
API 固有の終了コード
| Code | Message | 概要 | 補足（主な原因など） |
| E041 | INVALID_PARAMETER | パラメータ異常 |
・取引先正式名称などの、取引先テンプレートで必須設定となっている項目が指定されていない ・登録時バリデーションでエラーとなった場合（登録データの最大文字数超過など） |
| E199 | REQUEST_FAILURE | その他のエラー |
レスポンスサンプル
{
"param": {
"toData": {
"clientRegisterInfo": {
"clientItemList": [
{
"itemID": "2205f2e3-839f-4ff3-80f2-1ce6f8a86ac7", // 取引先正式名称
"itemType": "text_ruby",
"itemTextData": {
"value": "株式会社サンプル",
"ruby": "カブシキガイシャサンプル"
}
},
{
"itemID": "f1315967-bac4-4704-aa8d-43d2ac707b84", // 取引先略称
"itemType": "text_single",
"itemTextData": { "value": "サンプル" }
},
{
"itemID": "a7648fba-0dae-4134-9b2e-1311a8108554", // 業種
"itemType": "linkage_pulldown",
"itemSelectionData": { "values": [1, 21] }
},
{
"itemID": "e5866901-5699-412a-b95d-793a4e085d95", // 設立年月日
"itemType": "date",
"itemTextData": { "value": "2024-01-01" }
},
{
"itemID": "a325243e-239d-455a-99bd-84f79f47d523", // 資本金
"itemType": "amount_integer",
"itemNumericData": { "value": "5000000" }
},
{
"itemID": "27446cf0-18ca-4aa1-a38b-299b282ab295", // 年間売上
"itemType": "amount_integer",
"itemNumericData": { "value": "100000000" }
},
{
"itemID": "0fad1224-d8c0-4fe0-bf11-16c97b60d9f3", // 決算日
"itemType": "text_single",
"itemTextData": { "value": "12/31" }
},
{
"itemID": "c8db8268-37fb-4ab5-9760-3d1f1d6a7c9a", // 代表者姓
"itemType": "text_ruby",
"itemTextData": { "value": "山田", "ruby": "ヤマダ" }
},
{
"itemID": "5352da6f-8933-4738-9ee0-da0ae4d132b0", // 代表者名
"itemType": "text_ruby",
"itemTextData": { "value": "太郎", "ruby": "タロウ" }
},
{
"itemID": "b70b0359-fe8d-4293-b227-bb5692871c7a", // 代表電話番号
"itemType": "phone_number",
"itemTextData": { "value": "0312345678" }
},
{
"itemID": "8e33eddf-c66e-410f-b080-6b0149400a57", // 代表FAX番号
"itemType": "phone_number",
"itemTextData": { "value": "0312349999" }
},
{
"itemID": "84e21e7c-5c08-4097-9cd0-b9eaffd4fb6d", // WEBサイト1
"itemType": "url",
"itemTextData": { "value": "https://example.com" }
},
{
"itemID": "c23b818e-1a6b-44d7-8b32-7e95ce0a7d42", // WEBサイト2
"itemType": "url",
"itemTextData": { "value": "https://sub.example.com" }
},
{
"itemID": "9039dddf-9f34-4154-98f8-e3491d11b46f", // 従業員数
"itemType": "number",
"itemNumericData": { "value": "50" }
},
{
"itemID": "09cdb725-3cde-4f53-bc3f-8f9b2fef09f6", // 引合経路
"itemType": "inquiry_route",
"itemInquiryRouteData": {
"values": [
{
"inquiryRouteCategoryId": "UUID-AAA",
"inquiryRouteCategoryName": "Web",
"inquiryRouteId": "UUID-BBB",
"inquiryRouteName": "問い合わせフォーム"
}
]
}
},
{
"itemID": "494cafbb-aa8d-41cc-8aac-2fe37c960c9b", // 郵便番号
"itemType": "postal_code",
"itemTextData": { "value": "1000001" }
},
{
"itemID": "8a87f4ef-19d6-4189-b3ca-6a9788b9ebc7", // 住所(都道府県)
"itemType": "prefectures",
"itemSelectionData": { "values": [13] }
},
{
"itemID": "25c58fef-625c-4a47-a5a2-cc2c0c265bc6", // 住所(市区町村以下)
"itemType": "text_single",
"itemTextData": { "value": "千代田区千代田1-1" }
},
{
"itemID": "844fd803-117d-46ba-ad55-2d7950c2df3b", // 支社支店・拠点
"itemType": "text_single",
"itemTextData": { "value": "東京支店" }
},
{
"itemID": "d154848f-295d-4d27-b4db-8454bcfbf308", // 部署
"itemType": "text_single",
"itemTextData": { "value": "営業部" }
},
{
"itemID": "55567a07-a4a2-4dea-86f6-33bddfd3bcd2", // 取引先種別
"itemType": "checkbox",
"itemSelectionData": { "values": [1] }
},
{
"itemID": "b2e11f58-0ab4-41b7-80ff-166d98e78474", // 評価
"itemType": "pulldown",
"itemSelectionData": { "values": [1] }
},
{
"itemID": "0a244d28-0e66-49ef-8cd9-8aa53760e6d8", // 詳細情報
"itemType": "text_multiple",
"itemTextData": { "value": "詳細メモです。" }
},
{
"itemID": "74595112-d47c-46bd-abd8-2de69cd8df75", // リスト名
"itemType": "text_single",
"itemTextData": { "value": "メインリスト" }
},
{
"itemID": "a5561a04-a219-4f09-b176-44fc37a13683", // メモ
"itemType": "text_single",
"itemTextData": { "value": "内部メモ" }
},
{
"itemID": "ebeba38d-fcfa-4379-b5b2-8e246b8ce385", // 手書きメモ
"itemType": "text_single",
"itemTextData": { "value": "手書きメモ内容" }
},
{
"itemID": "f8ccf472-16db-4fcb-8e94-d0d92eba67e1", // 親取引先
"itemType": "client_single",
"itemUuidDataList": [
{
"itemUuid": "UUID-PARENT-CLIENT",
"itemDisplayValue": "親会社A"
}
]
},
{
"itemID": "81818574-827d-4084-8b12-97b5b9a8d593", // 営業主担当部署（必須）
"itemType": "division_single",
"itemUuidDataList": [
{
"itemUuid": "UUID-DIVISION",
"itemDisplayValue": "営業部"
}
]
},
{
"itemID": "88795555-0d22-46fd-bc6d-8a14c5d0dc7a", // 営業主担当者（必須）
"itemType": "user_single",
"itemUuidDataList": [
{
"itemUuid": "UUID-USER",
"itemDisplayValue": "山田 太郎"
}
]
},
{
"itemID": "8bf11d62-7607-4bc8-bfb3-641f68f6be79", // XXXX
"itemType": "text_single",
"itemTextData": { "value": "XXXXデータ" }
}
],
"systemLinkageInfoList": [
{ "systemLinkageID": 999000001, "linkageIDValue": "" },
{ "systemLinkageID": 999000002, "linkageIDValue": "" },
{ "systemLinkageID": 999000003, "linkageIDValue": "" },
{ "systemLinkageID": 999000004, "linkageIDValue": "" },
{ "systemLinkageID": 999000005, "linkageIDValue": "" },
{ "systemLinkageID": 999000006, "linkageIDValue": "" },
{ "systemLinkageID": 999000007, "linkageIDValue": "" },
{ "systemLinkageID": 999000008, "linkageIDValue": "" },
{ "systemLinkageID": 999000009, "linkageIDValue": "" },
{ "systemLinkageID": 999000010, "linkageIDValue": "" },
{ "systemLinkageID": 999000011, "linkageIDValue": "" },
{ "systemLinkageID": 999000012, "linkageIDValue": "" },
{ "systemLinkageID": 999000013, "linkageIDValue": "" },
{ "systemLinkageID": 999000014, "linkageIDValue": "" },
{ "systemLinkageID": 999000015, "linkageIDValue": "" },
{ "systemLinkageID": 999000016, "linkageIDValue": "" },
{ "systemLinkageID": 999000017, "linkageIDValue": "" },
{ "systemLinkageID": 999000018, "linkageIDValue": "" },
{ "systemLinkageID": 999000019, "linkageIDValue": "" },
{ "systemLinkageID": 999000020, "linkageIDValue": "" }
]
}
}
}
}
取引先更新API
| URL | https://（ホスト）/api/crm/client/update |
| Content-Type | application/json |
| HTTPメソッド | POST |
APIの概要
テナント内の取引先データを更新します。更新対象の取引先項目データを項目リストに指定して更新します。更新については項目リストに設定されたデータをもとに差分更新で更新します。更新成功時に、レスポンスで更新した取引先の取引先IDが返されます。
リクエストボディ（JSON）
| 必須 | 形式 | 内容 | 補足 | ||||||
| param | 〇 | Object | |||||||
| toData | 〇 | Object | |||||||
| clientUpdateInfo | 〇 | Object | |||||||
| clientInfo | 〇(※1) | Object | 取引先情報 | ||||||
| clientID | 〇 | UUID | 取引先ID | 更新対象の取引先の取引先IDを指定 | |||||
| systemLinkageInfo | 〇(※1) | Object | システム連携情報 | ||||||
| systemLinkageID | 〇 | Integer |
システム連携ID te |
連携システムのシステム連携IDを指定 | |||||
| linkageIDValue | 〇 | String | 連携ID値 | 更新対象の取引先の連携システム側の顧客IDを指定 | |||||
| clientItemList | 〇 | Object[] | |||||||
| itemID | 〇 | UUID | 取引先項目ID | 取引先項目IDについては、取引先テンプレート取得APIで取得出来るので同APIから取得 | |||||
| itemType | 〇 | String | 項目タイプ | 項目タイプの設定値および項目タイプの説明については、下記に記載 項目タイプ値および項目タイプの説明 |
|||||
| itemTextData | Object | 文字列型項目の値 | 項目タイプ（itemType）が文字列型の場合にこちらに項目データを設定。文字列型以外の場合は項目未設定 文字列型の項目タイプ:text_single,text_multiple,date,datetime,phone_number,url,mail_address,postal_code,prefectures,text_ruby |
||||||
| value | String | 項目値 | |||||||
| ruby | String | フリガナの値 | 項目タイプがtext_rubyの場合に、こちらにフリガナの値を設定する | ||||||
| itemNumericData | Object | 数値型項目の値 | 項目タイプ（itemType）が数値型の場合にこちらに項目データを設定。数値型以外の場合は項目未設定 数値型の項目タイプ:number,amount_integer,amount_decimal |
||||||
| value | String | 項目値 | |||||||
| itemSelectionData | Object | 選択肢型項目の値 |
項目タイプ（itemType）が選択肢型の場合にこちらに項目データを設定。選択肢型以外の場合は項目未設定 選択肢型の項目タイプ:pulldown,linkage_pulldown,checkbox |
||||||
| values | Integer[] | 項目値リスト | |||||||
| itemUuidData | Object | UUID型項目の値 | 項目タイプ（itemType）がUUID型の場合にこちらに項目データを設定。UUID型以外の場合は項目未設定 UUID型の項目タイプ:user_single,user_multiple,division_single,division_multiple,client_single,client_multiple,clientresponsible_single,clientresponsible_multiple,product_single,product_multiple |
||||||
| values | UUID[] | 項目値リスト | |||||||
| itemInquiryRouteDataList | Object[] | 引合経路型項目の値リスト | 項目タイプ（itemType）が引合経路型の場合にこちらに項目データを設定。引合経路型以外の場合は項目未設定 引合経路型の項目タイプ:inquiry_route |
||||||
| inquiryRouteCategoryId | UUID | 引合経路カテゴリID | |||||||
| inquiryRouteId | UUID | 引合経路ID | |||||||
| systemLinkageInfoList | Object[] | システム連携情報リスト | 取引先更新時にシステム連携ID値を併せて登録・更新する場合に指定 | ||||||
| systemLinkageID | Integer | システム連携ID | システム連携設定で登録されたシステム連携IDを設定（999000001～999000020の値） | ||||||
| linkageIDValue | String | 連携ID値 | 更新対象の取引先に紐づく、連携システム側の顧客IDを登録・更新値として設定 | ||||||
※1：clientInfo、systemLinkageInfoのいずれかのみ必須。両方指定されている場合はエラー。clientInfoが指定された時はclientIDをキーに、systemLinkageInfoが指定された時はsystemLinkageID, linkageIDValueをキーにして更新。
リクエストパラメタについての補足事項
①入力値のバリデーションチェックについて
パラメタで指定する更新値については、更新時にバリデーションチェックを行い、エラーの場合はバリデーションエラーとなります。
バリデーションチェックの内容は、項目タイプ（itemType）により異なり、下記に記載のチェックを項目タイプ別に実施します。
| リクエスト例(JSON)※取引情報で更新 | リクエスト例(JSON)※システム連携情報で更新 |
{
"param": {
"toData": {
"clientUpdateInfo": {
"clientInfo": {
"clientID": "string"
},
"clientItemList": [
{
"itemID": "2205f2e3-839f-4ff3-80f2-1ce6f8a86ac7",
"itemType": "text_ruby",
"itemTextData": {
"value": "TEST_TEST",
"ruby": "テストアンダーバーテスト"
}
},
{
"itemID": "81818574-827d-4084-8b12-97b5b9a8d593",
"itemType": "division_single",
"itemUuidData": {
"values": [
"28ca2537-d541-42f9-b444-eca8144e130d"
]
}
},
{
"itemID": "88795555-0d22-46fd-bc6d-8a14c5d0dc7a",
"itemType": "user_single",
"itemUuidData": {
"values": [
"c84aa9a5-1390-41a4-9786-7cda5fd9971f"
]
}
},
{
"itemID": "a25d97d4-6c0f-43d0-8400-3c22802cbe4f",
"itemType": "linkage_pulldown",
"itemSelectionData": {
"values": [
11,
11
]
}
}
],
"systemLinkageInfoList": [
{
"systemLinkageID": 999000001,
"linkageIDValue": "string"
}
]
}
}
}
} |
{
"param": {
"toData": {
"clientUpdateInfo": {
"systemLinkageInfo": {
"systemLinkageID": 999000001,
"linkageIDValue": "string"
},
"clientItemList": [
{
"itemID": "2205f2e3-839f-4ff3-80f2-1ce6f8a86ac7",
"itemType": "text_ruby",
"itemTextData": {
"value": "TEST_TEST",
"ruby": "テストアンダーバーテスト"
}
},
{
"itemID": "81818574-827d-4084-8b12-97b5b9a8d593",
"itemType": "division_single",
"itemUuidData": {
"values": [
"28ca2537-d541-42f9-b444-eca8144e130d"
]
}
},
{
"itemID": "88795555-0d22-46fd-bc6d-8a14c5d0dc7a",
"itemType": "user_single",
"itemUuidData": {
"values": [
"c84aa9a5-1390-41a4-9786-7cda5fd9971f"
]
}
},
{
"itemID": "a25d97d4-6c0f-43d0-8400-3c22802cbe4f",
"itemType": "linkage_pulldown",
"itemSelectionData": {
"values": [
11,
11
]
}
}
],
"systemLinkageInfoList": [
{
"systemLinkageID": 999000002,
"linkageIDValue": "string"
}
]
}
}
}
} |
レスポンス JSON
| 必須 | 形式 | 内容 | 補足 | ||
| appStatus | 〇 | Object | API の実行情報 | ||
| code | 〇 | String | 終了コード | ||
| message | String | メッセージ | |||
| updateClientResult | Object | 取引先更新結果情報 | API が正常終了した場合のみ値を格納 | ||
| clientID | UUID | 更新された取引先の取引先ID | |||
レスポンス例(JSON)
{
"updateClientResult": {
"clientID": "5e4ea010-a908-45a1-a70b-ebd2e4feb055"
},
"appStatus": {
"code": "S000",
"message": ""
}
}
API 固有の終了コード
| Code | Message | 概要 | 補足（主な原因など） |
| E041 | INVALID_PARAMETER | パラメータ異常 |
・取引先正式名称などの、取引先テンプレートで必須設定となっている項目が指定されていない ・更新時バリデーションでエラーとなった場合（更新データの最大文字数超過など） |
| E199 | REQUEST_FAILURE | その他のエラー |
レスポンスサンプル
{
"param": {
"toData": {
"clientUpdateInfo": {
"clientInfo": {
"clientID": "5e4ea010-a908-45a1-a70b-ebd2e4feb055", // 取引先ID（更新対象）
},
"clientItemList": [
{
"itemID": "2205f2e3-839f-4ff3-80f2-1ce6f8a86ac7", // 取引先正式名称
"itemType": "text_ruby",
"itemTextData": {
"value": "株式会社サンプル",
"ruby": "カブシキガイシャサンプル"
}
},
{
"itemID": "f1315967-bac4-4704-aa9d-43d2ac707b84", // 取引先略称
"itemType": "text_single",
"itemTextData": { "value": "サンプル" }
},
{
"itemID": "a7648fba-0dae-4134-9b2e-1311a8108554", // 業種
"itemType": "linkage_pulldown",
"itemSelectionData": { "values": [1, 21] }
},
{
"itemID": "e5866901-5699-412a-b95d-793a4e085d95", // 設立年月日
"itemType": "date",
"itemTextData": { "value": "2024-01-01" }
},
{
"itemID": "a325243e-239d-455a-99bd-84f79f47d523", // 資本金
"itemType": "amount_integer",
"itemNumericData": { "value": "5000000" }
},
{
"itemID": "27446cf0-18ca-4aa1-a38b-299b282ab295", // 年間売上
"itemType": "amount_integer",
"itemNumericData": { "value": "100000000" }
},
{
"itemID": "0fad1224-d8c0-4fe0-bf11-16c97b60d9f3", // 決算日
"itemType": "text_single",
"itemTextData": { "value": "12/31" }
},
{
"itemID": "c8db8268-37fb-4ab5-9760-3d1f1d6a7c9a", // 代表者姓
"itemType": "text_ruby",
"itemTextData": { "value": "山田", "ruby": "ヤマダ" }
},
{
"itemID": "5352da6f-8933-4738-9ee0-da0ae4d132b0", // 代表者名
"itemType": "text_ruby",
"itemTextData": { "value": "太郎", "ruby": "タロウ" }
},
{
"itemID": "b70b0359-fe8d-4293-b227-bb5692871c7a", // 代表電話番号
"itemType": "phone_number",
"itemTextData": { "value": "0312345678" }
},
{
"itemID": "8e33eddf-c66e-410f-b080-6b0149400a57", // 代表FAX番号
"itemType": "phone_number",
"itemTextData": { "value": "0312349999" }
},
{
"itemID": "84e21e7c-5c08-4097-9cd0-b9eaffd4fb6d", // WEBサイト1
"itemType": "url",
"itemTextData": { "value": "https://example.com" }
},
{
"itemID": "c23b818e-1a6b-44d7-8b32-7e95ce0a7d42", // WEBサイト2
"itemType": "url",
"itemTextData": { "value": "https://sub.example.com" }
},
{
"itemID": "9039dddf-9f34-4154-98f8-e3491d11b46f", // 従業員数
"itemType": "number",
"itemNumericData": { "value": "50" }
},
{
"itemID": "09cdb725-3cde-4f53-bc3f-8f9b2fef09f6", // 引合経路
"itemType": "inquiry_route",
"itemInquiryRouteData": {
"values": [
{
"inquiryRouteCategoryId": "UUID-AAA",
"inquiryRouteCategoryName": "Web",
"inquiryRouteId": "UUID-BBB",
"inquiryRouteName": "問い合わせフォーム"
}
]
}
},
{
"itemID": "494cafbb-aa8d-41cc-8aac-2fe37c960c9b", // 郵便番号
"itemType": "postal_code",
"itemTextData": { "value": "1000001" }
},
{
"itemID": "8a87f4ef-19d6-4189-b3ca-6a9788b9ebc7", // 住所(都道府県)
"itemType": "prefectures",
"itemSelectionData": { "values": [13] }
},
{
"itemID": "25c58fef-625c-4a47-a5a2-cc2c0c265bc6", // 住所(市区町村以下)
"itemType": "text_single",
"itemTextData": { "value": "千代田区千代田1-1" }
},
{
"itemID": "844fd803-117d-46ba-ad55-2d7950c2df3b", // 支社支店・拠点
"itemType": "text_single",
"itemTextData": { "value": "東京支店" }
},
{
"itemID": "d154848f-295d-4d27-b4db-8454bcfbf308", // 部署
"itemType": "text_single",
"itemTextData": { "value": "営業部" }
},
{
"itemID": "55567a07-a4a2-4dea-86f6-33bddfd3bcd2", // 取引先種別
"itemType": "checkbox",
"itemSelectionData": { "values": [1] }
},
{
"itemID": "b2e11f58-0ab4-41b7-80ff-166d98e78474", // 評価
"itemType": "pulldown",
"itemSelectionData": { "values": [1] }
},
{
"itemID": "0a244d28-0e66-49ef-8cd9-8aa53760e6d8", // 詳細情報
"itemType": "text_multiple",
"itemTextData": { "value": "詳細メモです。" }
},
{
"itemID": "74595112-d47c-46bd-abd8-2de69cd8df75", // リスト名
"itemType": "text_single",
"itemTextData": { "value": "メインリスト" }
},
{
"itemID": "a5561a04-a219-4f09-b176-44fc37a13683", // メモ
"itemType": "text_single",
"itemTextData": { "value": "内部メモ" }
},
{
"itemID": "ebeba38d-fcfa-4379-b5b2-8e246b8ce385", // 手書きメモ
"itemType": "text_single",
"itemTextData": { "value": "手書きメモ内容" }
},
{
"itemID": "f8ccf472-16db-4fcb-8e94-d0d92eba67e1", // 親取引先
"itemType": "client_single",
"itemUuidDataList": [
{
"itemUuid": "UUID-PARENT-CLIENT",
"itemDisplayValue": "親会社A"
}
]
},
{
"itemID": "81818574-827d-4084-8b12-97b5b9a8d593", // 営業主担当部署（必須）
"itemType": "division_single",
"itemUuidDataList": [
{
"itemUuid": "UUID-DIVISION",
"itemDisplayValue": "営業部"
}
]
},
{
"itemID": "88795555-0d22-46fd-bc6d-8a14c5d0dc7a", // 営業主担当者（必須）
"itemType": "user_single",
"itemUuidDataList": [
{
"itemUuid": "UUID-USER",
"itemDisplayValue": "山田 太郎"
}
]
},
{
"itemID": "8bf11d62-7607-4bc8-bfb3-641f68f6be79", // XXXX
"itemType": "text_single",
"itemTextData": { "value": "XXXXデータ" }
}
],
"systemLinkageInfoList": [
{ "systemLinkageID": 999000001, "linkageIDValue": "" },
{ "systemLinkageID": 999000002, "linkageIDValue": "" },
{ "systemLinkageID": 999000003, "linkageIDValue": "" },
{ "systemLinkageID": 999000004, "linkageIDValue": "" },
{ "systemLinkageID": 999000005, "linkageIDValue": "" },
{ "systemLinkageID": 999000006, "linkageIDValue": "" },
{ "systemLinkageID": 999000007, "linkageIDValue": "" },
{ "systemLinkageID": 999000008, "linkageIDValue": "" },
{ "systemLinkageID": 999000009, "linkageIDValue": "" },
{ "systemLinkageID": 999000010, "linkageIDValue": "" },
{ "systemLinkageID": 999000011, "linkageIDValue": "" },
{ "systemLinkageID": 999000012, "linkageIDValue": "" },
{ "systemLinkageID": 999000013, "linkageIDValue": "" },
{ "systemLinkageID": 999000014, "linkageIDValue": "" },
{ "systemLinkageID": 999000015, "linkageIDValue": "" },
{ "systemLinkageID": 999000016, "linkageIDValue": "" },
{ "systemLinkageID": 999000017, "linkageIDValue": "" },
{ "systemLinkageID": 999000018, "linkageIDValue": "" },
{ "systemLinkageID": 999000019, "linkageIDValue": "" },
{ "systemLinkageID": 999000020, "linkageIDValue": "" }
]
}
}
}
}
レスポンスサンプル
{
"param": {
"toData": {
"clientUpdateInfo": {
"systemLinkageInfo": {
"systemLinkageID": 999000001,// システム連携ID
"linkageIDValue": "tes12345"// 連携システム側の顧客ID
}
"clientItemList": [
{
"itemID": "2205f2e3-839f-4ff3-80f2-1ce6f8a86ac7", // 取引先正式名称
"itemType": "text_ruby",
"itemTextData": {
"value": "株式会社サンプル",
"ruby": "カブシキガイシャサンプル"
}
},
{
"itemID": "f1315967-bac4-4704-aa9d-43d2ac707b84", // 取引先略称
"itemType": "text_single",
"itemTextData": { "value": "サンプル" }
},
{
"itemID": "a7648fba-0dae-4134-9b2e-1311a8108554", // 業種
"itemType": "linkage_pulldown",
"itemSelectionData": { "values": [1, 21] }
},
{
"itemID": "e5866901-5699-412a-b95d-793a4e085d95", // 設立年月日
"itemType": "date",
"itemTextData": { "value": "2024-01-01" }
},
{
"itemID": "a325243e-239d-455a-99bd-84f79f47d523", // 資本金
"itemType": "amount_integer",
"itemNumericData": { "value": "5000000" }
},
{
"itemID": "27446cf0-18ca-4aa1-a38b-299b282ab295", // 年間売上
"itemType": "amount_integer",
"itemNumericData": { "value": "100000000" }
},
{
"itemID": "0fad1224-d8c0-4fe0-bf11-16c97b60d9f3", // 決算日
"itemType": "text_single",
"itemTextData": { "value": "12/31" }
},
{
"itemID": "c8db8268-37fb-4ab5-9760-3d1f1d6a7c9a", // 代表者姓
"itemType": "text_ruby",
"itemTextData": { "value": "山田", "ruby": "ヤマダ" }
},
{
"itemID": "5352da6f-8933-4738-9ee0-da0ae4d132b0", // 代表者名
"itemType": "text_ruby",
"itemTextData": { "value": "太郎", "ruby": "タロウ" }
},
{
"itemID": "b70b0359-fe8d-4293-b227-bb5692871c7a", // 代表電話番号
"itemType": "phone_number",
"itemTextData": { "value": "0312345678" }
},
{
"itemID": "8e33eddf-c66e-410f-b080-6b0149400a57", // 代表FAX番号
"itemType": "phone_number",
"itemTextData": { "value": "0312349999" }
},
{
"itemID": "84e21e7c-5c08-4097-9cd0-b9eaffd4fb6d", // WEBサイト1
"itemType": "url",
"itemTextData": { "value": "https://example.com" }
},
{
"itemID": "c23b818e-1a6b-44d7-8b32-7e95ce0a7d42", // WEBサイト2
"itemType": "url",
"itemTextData": { "value": "https://sub.example.com" }
},
{
"itemID": "9039dddf-9f34-4154-98f8-e3491d11b46f", // 従業員数
"itemType": "number",
"itemNumericData": { "value": "50" }
},
{
"itemID": "09cdb725-3cde-4f53-bc3f-8f9b2fef09f6", // 引合経路
"itemType": "inquiry_route",
"itemInquiryRouteData": {
"values": [
{
"inquiryRouteCategoryId": "UUID-AAA",
"inquiryRouteCategoryName": "Web",
"inquiryRouteId": "UUID-BBB",
"inquiryRouteName": "問い合わせフォーム"
}
]
}
},
{
"itemID": "494cafbb-aa8d-41cc-8aac-2fe37c960c9b", // 郵便番号
"itemType": "postal_code",
"itemTextData": { "value": "1000001" }
},
{
"itemID": "8a87f4ef-19d6-4189-b3ca-6a9788b9ebc7", // 住所(都道府県)
"itemType": "prefectures",
"itemSelectionData": { "values": [13] }
},
{
"itemID": "25c58fef-625c-4a47-a5a2-cc2c0c265bc6", // 住所(市区町村以下)
"itemType": "text_single",
"itemTextData": { "value": "千代田区千代田1-1" }
},
{
"itemID": "844fd803-117d-46ba-ad55-2d7950c2df3b", // 支社支店・拠点
"itemType": "text_single",
"itemTextData": { "value": "東京支店" }
},
{
"itemID": "d154848f-295d-4d27-b4db-8454bcfbf308", // 部署
"itemType": "text_single",
"itemTextData": { "value": "営業部" }
},
{
"itemID": "55567a07-a4a2-4dea-86f6-33bddfd3bcd2", // 取引先種別
"itemType": "checkbox",
"itemSelectionData": { "values": [1] }
},
{
"itemID": "b2e11f58-0ab4-41b7-80ff-166d98e78474", // 評価
"itemType": "pulldown",
"itemSelectionData": { "values": [1] }
},
{
"itemID": "0a244d28-0e66-49ef-8cd9-8aa53760e6d8", // 詳細情報
"itemType": "text_multiple",
"itemTextData": { "value": "詳細メモです。" }
},
{
"itemID": "74595112-d47c-46bd-abd8-2de69cd8df75", // リスト名
"itemType": "text_single",
"itemTextData": { "value": "メインリスト" }
},
{
"itemID": "a5561a04-a219-4f09-b176-44fc37a13683", // メモ
"itemType": "text_single",
"itemTextData": { "value": "内部メモ" }
},
{
"itemID": "ebeba38d-fcfa-4379-b5b2-8e246b8ce385", // 手書きメモ
"itemType": "text_single",
"itemTextData": { "value": "手書きメモ内容" }
},
{
"itemID": "f8ccf472-16db-4fcb-8e94-d0d92eba67e1", // 親取引先
"itemType": "client_single",
"itemUuidDataList": [
{
"itemUuid": "UUID-PARENT-CLIENT",
"itemDisplayValue": "親会社A"
}
]
},
{
"itemID": "81818574-827d-4084-8b12-97b5b9a8d593", // 営業主担当部署（必須）
"itemType": "division_single",
"itemUuidDataList": [
{
"itemUuid": "UUID-DIVISION",
"itemDisplayValue": "営業部"
}
]
},
{
"itemID": "88795555-0d22-46fd-bc6d-8a14c5d0dc7a", // 営業主担当者（必須）
"itemType": "user_single",
"itemUuidDataList": [
{
"itemUuid": "UUID-USER",
"itemDisplayValue": "山田 太郎"
}
]
},
{
"itemID": "8bf11d62-7607-4bc8-bfb3-641f68f6be79", // XXXX
"itemType": "text_single",
"itemTextData": { "value": "XXXXデータ" }
}
],
"systemLinkageInfoList": [
{ "systemLinkageID": 999000001, "linkageIDValue": "" },
{ "systemLinkageID": 999000002, "linkageIDValue": "" },
{ "systemLinkageID": 999000003, "linkageIDValue": "" },
{ "systemLinkageID": 999000004, "linkageIDValue": "" },
{ "systemLinkageID": 999000005, "linkageIDValue": "" },
{ "systemLinkageID": 999000006, "linkageIDValue": "" },
{ "systemLinkageID": 999000007, "linkageIDValue": "" },
{ "systemLinkageID": 999000008, "linkageIDValue": "" },
{ "systemLinkageID": 999000009, "linkageIDValue": "" },
{ "systemLinkageID": 999000010, "linkageIDValue": "" },
{ "systemLinkageID": 999000011, "linkageIDValue": "" },
{ "systemLinkageID": 999000012, "linkageIDValue": "" },
{ "systemLinkageID": 999000013, "linkageIDValue": "" },
{ "systemLinkageID": 999000014, "linkageIDValue": "" },
{ "systemLinkageID": 999000015, "linkageIDValue": "" },
{ "systemLinkageID": 999000016, "linkageIDValue": "" },
{ "systemLinkageID": 999000017, "linkageIDValue": "" },
{ "systemLinkageID": 999000018, "linkageIDValue": "" },
{ "systemLinkageID": 999000019, "linkageIDValue": "" },
{ "systemLinkageID": 999000020, "linkageIDValue": "" }
]
}
}
}
}
取引先削除API
| URL | https://（ホスト）/api/crm/client/delete |
| Content-Type | application/json |
| HTTPメソッド | POST |
APIの概要
テナント内の取引先データを削除します。削除対象の取引先のIDを削除対象取引先情報リストで指定する事で、複数の取引先データをまとめて削除可能となります。取引先削除時に、取引先に紐づく取引先担当者も併せて削除されます。削除成功時に、レスポンスで削除成功した取引先の取引先IDが返されます。
リクエストボディ（JSON）
| 必須 | 形式 | 内容 | 補足 | |||||
| param | 〇 | Object | ||||||
| toData | 〇 | Object | ||||||
| deleteClientInfo | 〇 | Object | ||||||
| deleteClientList | 〇(※1) | Object[] | 削除対象取引先情報リスト | |||||
| clientID | 〇 | UUID | 取引先ID | 削除対象の取引先の取引先IDを指定 | ||||
| deleteSystemLinkageList | 〇(※1) | Object[] | 削除対象システム連携情報リスト | |||||
| systemLinkageID | 〇 | Integer | システム連携ID | 連携システムのシステム連携IDを指定 | ||||
| linkageIDValue | 〇 | String | 連携ID値 | 削除対象の取引先の連携システム側の顧客IDを指定 | ||||
| forceDeleteFlag | 〇 | Boolean | 強制削除フラグ | |||||
※1：deleteClientList、deleteSystemLinkageListのいずれかのみ必須。両方指定された場合はエラー。
deleteClientListが指定された時はclientIDをキーに、deleteSystemLinkageListが指定された時はsystemLinkageID, linkageIDValueをキーにして削除
| リクエスト例(JSON)※取引先情報で削除 | リクエスト例(JSON）※システム連携情報で削除 |
{
"param": {
"toData": {
"deleteClientInfo": {
"deleteClientList": [
{
"clientID": "string"
}
],
"forceDeleteFlag": true
}
}
}
} |
{
"param": {
"toData": {
"deleteClientInfo": {
"deleteSystemLinkageList": [
{
"systemLinkageID": 999000002,
"linkageIDValue": "string"
}
],
"forceDeleteFlag": true
}
}
}
} |
レスポンス JSON
| 必須 | 形式 | 内容 | 補足 | ||
| appStatus | 〇 | Object | API の実行情報 | ||
| code | 〇 | String | 終了コード | ||
| message | String | メッセージ | |||
| deletedClientList | Object[] | 削除済取引先リスト | API が正常終了した場合のみ値を格納 | ||
| clientID | UUID | 削除された取引先の取引先ID | |||
レスポンス例(JSON)
{
"deletedClientList": [
{
"clientID": "d46c6936-8513-40e2-bc39-4b6298120217"
}
],
"appStatus": {
"code": "S000",
"message": ""
}
}
API 固有の終了コード
| Code | Message | 概要 | 補足（主な原因など） |
| E041 | INVALID_PARAMETER | パラメータ異常 | 必須項目（deleteClientList、deleteSystemLinkageListのいずれか）が指定されていない |
| E051 | NOT_EXIST_DATA | 存在しないデータ | 削除対象システム連携情報リストで指定した、連携IDに紐づく取引先が存在しない |
| E199 | REQUEST_FAILURE | その他のエラー |
取引先担当者登録API
| URL | https://（ホスト）/api/crm/client-responsible/register |
| Content-Type | application/json |
| HTTPメソッド | POST |
APIの概要
テナント内のデータとして取引先担当者データを登録します。登録対象の取引先担当者項目データを項目リストに指定して登録します。登録成功時に、レスポンスで登録した取引先担当者の取引先担当者IDが返されます。
リクエストボディ（JSON）
| 必須 | 形式 | 内容 | 補足 | ||||||
| param | 〇 | Object | |||||||
| toData | 〇 | Object | |||||||
| clientResponsibleRegisterInfo | 〇 | Object | |||||||
| clientID | 〇 | UUID | 取引先ID | ||||||
| clientResponsibleItemList | 〇 | Object[] | |||||||
| itemID | 〇 | UUID | 取引先担当者項目ID | 取引先担当者項目IDについては、取引先担当者テンプレート取得APIで取得出来るので同APIから取得 | |||||
| itemType | 〇 | String | 項目タイプ | 項目タイプの設定値および項目タイプの説明については、下記に記載 項目タイプ値および項目タイプの説明 |
|||||
| itemTextData | Object | 文字列型項目の値 |
項目タイプ（itemType）が文字列型の場合にこちらに項目データを設定。文字列型以外の場合は項目未設定。 文字列型の項目タイプ:text_single,text_multiple,date,datetime,phone_number,url,mail_address,postal_code,prefectures,text_ruby |
||||||
| value | String | 項目値 | |||||||
| ruby | String | フリガナの値 | 項目タイプがtext_rubyの場合に、こちらにフリガナの値を設定する | ||||||
| itemNumericData | Object | 数値型項目の値 | 項目タイプ（itemType）が数値型の場合にこちらに項目データを設定。数値型以外の場合は項目未設定 数値型の項目タイプ:number,amount_integer,amount_decimal |
||||||
| value | String | 項目値 | |||||||
| itemSelectionData | Object | 選択肢型項目の値 | 項目タイプ（itemType）が選択肢型の場合にこちらに項目データを設定。選択肢型以外の場合は項目未設定 選択肢型の項目タイプ:pulldown,linkage_pulldown,checkbox |
||||||
| values | Integer[] | 項目値リスト | |||||||
| itemUuidData | Object | UUID型項目の値 | 項目タイプ（itemType）がUUID型の場合にこちらに項目データを設定。UUID型以外の場合は項目未設定。 UUID型の項目タイプ:user_single,user_multiple,division_single,division_multiple,client_single,client_multiple,clientresponsible_single,clientresponsible_multiple,product_single,product_multiple |
||||||
| values | UUID[] | 項目値リスト | |||||||
| clientResponsibleInquiryRouteDataList | Object[] | 取引先担当者引合経路リスト | 取引先担当者の引合経路（接触履歴）の情報を併せて登録する場合にこちらにデータを設定 | ||||||
| inquiryRouteCategoryId | UUID | 引合経路カテゴリID | |||||||
| inquiryRouteId | UUID | 引合経路ID | |||||||
| systemLinkageInfoList | Object[] | システム連携情報リスト | 取引先担当者登録時にシステム連携ID値を併せて登録する場合に指定 | ||||||
| systemLinkageID | Integer | システム連携ID | システム連携設定で登録されたシステム連携IDを設定（999000001～999000020の値） | ||||||
| linkageIDValue | String | 連携ID値 | 登録対象の取引先担当者に紐づく、連携システム側の顧客担当者IDを登録値として設定 | ||||||
リクエストパラメタについての補足事項
①入力値のバリデーションチェックについて
パラメタで指定する登録値については、登録時にバリデーションチェックを行い、エラーの場合はバリデーションエラーとなります。バリデーションチェックの内容は、項目タイプ（itemType）により異なり、下記に記載のチェックを項目タイプ別に実施します。
②必須項目チェックについて
取引先担当者テンプレート項目の設定で必須となっている（必須フラグがtrueとなっている）項目については、登録対象項目リストに必須項目チェックが含まれているかチェックして、含まれていない場合はパラメタ不正エラーとなります。取引先担当者テンプレートの項目情報については、取引先担当者テンプレート取得APIで取得出来ますので、登録対象の項目が必須項目かどうかについては同APIの取得データを参照して確認可能です。
リクエスト例(JSON)
{
"param": {
"toData": {
"clientResponsibleRegisterInfo": {
"clientID": "7402ce69-57c3-4ea4-8a5d-d5a2765e8b32", // 取引先ID
"clientResponsibleItemList": [
{
"itemID": "9b9e4a9f-2d99-4195-b136-de0ea63c494e", // 取引先担当者姓
"itemType": "text_ruby",
"itemTextData": {
"value": "手須戸",
"ruby": "てすと"
}
},
{
"itemID": "4e797881-4042-4dd5-beb6-d3f2ba0d9790", // 取引先担当者名
"itemType": "text_ruby",
"itemTextData": {
"value": "太朗",
"ruby": "だろう"
}
},
{
"itemID": "e8f4b11d-41c4-4c05-afe8-a3c008fa2ce7", // 取引先
"itemType": "client_single",
"itemUuidData": {
"values": [
"7402ce69-57c3-4ea4-8a5d-d5a2765e8b32"
]
}
},
{
"itemID": "3f5ba10e-40d2-4b29-85b6-b7e7d1fff077", // 支社支店・拠点
"itemType": "text_single",
"itemTextData": {
"value": "虎ノ門支店"
}
},
{
"itemID": "5b558456-d616-4d4f-ae93-cae4023a6dd7", // 部署
"itemType": "text_single",
"itemTextData": {
"value": "営業推進部"
}
},
{
"itemID": "691c9ac2-01e8-4166-81fb-899149fcd416", // 役職
"itemType": "text_single",
"itemTextData": {
"value": "部長",
"ruby": ""
}
},
{
"itemID": "0e92f196-21a7-4a5f-ac8d-82dab042f031", // 誕生日
"itemType": "date",
"itemTextData": {
"value": "1900-01-01"
}
},
{
"itemID": "bd2f1841-f095-48f6-b634-35ea90bba0bd", // 電話番号1
"itemType": "phone_number",
"itemTextData": {
"value": "08012345678"
}
},
{
"itemID": "d3f1bb48-85c2-49ea-b24d-a3e94e4c2221", // 電話番号2
"itemType": "phone_number",
"itemTextData": {
"value": "08012345678"
}
},
{
"itemID": "bcdb231a-14e5-4708-9614-d692cd2245c6", // 内線番号
"itemType": "text_single",
"itemTextData": {
"value": "あいうえお"
}
},
{
"itemID": "41fe574b-712e-4a29-8dd0-e06607a0e962", // 携帯電話番号1
"itemType": "phone_number",
"itemTextData": {
"value": "08012345678"
}
},
{
"itemID": "e543665a-0a0b-4e0a-8212-3ffbe14e1e4f", // 携帯電話番号2
"itemType": "phone_number",
"itemTextData": {
"value": "08012345678"
}
},
{
"itemID": "b307ba2b-3cb2-41a5-90ea-6a30d853ef8e", // FAX番号1"
"itemType": "phone_number",
"itemTextData": {
"value": "08012345678"
}
},
{
"itemID": "35ecbf82-5b78-43fd-b9b2-71b762fd5d7b", // FAX番号2
"itemType": "phone_number",
"itemTextData": {
"value": "08012345678"
}
},
{
"itemID": "4e881466-88b5-46b3-b398-da99ad6cfb79", // メールアドレス1
"itemType": "mail_address",
"itemTextData": {
"value": "test@test.test"
}
},
{
"itemID": "7b9b4c8e-f56c-45a7-93ab-00c7a9e1046e", // メールアドレス2
"itemType": "mail_address",
"itemTextData": {
"value": "test@test.test"
}
},
{
"itemID": "f11a121e-3afa-44ce-9972-6e2d90799fb1", // 郵便番号
"itemType": "postal_code",
"itemTextData": {
"value": "105-0001"
}
},
{
"itemID": "ba86c3a5-bdb4-483b-88ec-a870f9975ed8", // 住所(都道府県)
"itemType": "prefectures",
"itemTextData": {
"value": "静岡県"
}
},
{
"itemID": "9fcc9ed9-586e-4707-8cd5-140d3eca35bc", // 住所(市区町村以下)
"itemType": "text_single",
"itemTextData": {
"value": "港区虎ノ門１−２−３"
}
},
{
"itemID": "eaf06a0c-2660-492d-9316-768db327a7be", // 詳細情報
"itemType": "text_multiple",
"itemTextData": {
"value": "あいうえお"
}
},
{
"itemID": "7e1dbd4d-d146-41e2-ad8d-9905b80ea565", // リスト名
"itemType": "text_single",
"itemTextData": {
"value": "あいうえお"
}
},
{
"itemID": "6963b14d-4a63-447a-af29-3f3b62bb4883", // メモ
"itemType": "text_single",
"itemTextData": {
"value": "あいうえお"
}
},
{
"itemID": "924aa432-138b-43c0-9f89-091417e84aa3", // 手書きメモ
"itemType": "text_single",
"itemTextData": {
"value": "あいうえお"
}
},
{
"itemID": "a214bb83-f81d-4631-9f1e-7c7efca08521", // 営業主担当部署
"itemType": "division_single",
"itemUuidData": {
"values": [
"41573754-0873-4a46-8f54-1cc318dd21a8"
]
}
},
{
"itemID": "e9ba034d-e8de-415c-a059-6c5096aa9daf", // 営業主担当者
"itemType": "user_single",
"itemUuidData": {
"values": [
"0501b83b-1b21-46f0-b21b-609e276c413e"
]
}
},
{
"itemID": "2b939d3d-600b-49e8-af06-8f43d20263c6", // 1行(カスタム)
"itemType": "text_single",
"itemTextData": {
"value": "あいうえお"
}
},
{
"itemID": "d4e91878-157a-4f96-9ace-60a1867c2bc4", // 複数行(カスタム)
"itemType": "text_multiple",
"itemTextData": {
"value": "あいうえお"
}
},
{
"itemID": "fd9a744b-dca1-4fd6-84ee-b01ebaa9e3db", // プルダウン(カスタム)
"itemType": "pulldown",
"itemSelectionData": {
"values": [
3
]
}
},
{
"itemID": "6f7b8c24-e951-4f00-b587-ebced57c0040", // 連携プルダウン(カスタム)
"itemType": "linkage_pulldown",
"itemSelectionData": {
"values": [
2,
4,
6
]
}
},
{
"itemID": "36bd0557-c72e-4e31-9dcd-9cb569375c11", // チェックボックス(カスタム)
"itemType": "checkbox",
"itemSelectionData": {
"values": [
2,
4
]
}
},
{
"itemID": "afd5de7c-5e24-48e6-8f19-05bc25a65c96", // ユーザー選択（単数）(カスタム)
"itemType": "user_single",
"itemUuidData": {
"values": [
"0501b83b-1b21-46f0-b21b-609e276c413e"
]
}
},
{
"itemID": "6c72922a-08dd-4cdd-992e-787cfd9be654",// ユーザー選択（複数）(カスタム)
"itemType": "user_multiple",
"itemUuidData": {
"values": [
"0501b83b-1b21-46f0-b21b-609e276c413e",
"4d62a0df-29c1-49a6-a5df-b3f546b59846",
"a6c837f9-3fc0-4357-94f5-466d9f7ecfa9"
]
}
},
{
"itemID": "5c0600a3-c482-4273-ab93-20743697260c", // 部署選択（単数）(カスタム)
"itemType": "division_single",
"itemUuidData": {
"values": [
"41573754-0873-4a46-8f54-1cc318dd21a8"
]
}
},
{
"itemID": "6aeb68cd-727e-482c-bc67-2b0a202508d4", // 部署選択（複数）(カスタム)
"itemType": "division_multiple",
"itemUuidData": {
"values": [
"1a493c22-c031-4952-9ed7-ca3823f91114",
"41573754-0873-4a46-8f54-1cc318dd21a8",
"be5a42cd-9f28-465f-81a3-b763d74a2300"
]
}
},
{
"itemID": "a888094b-c1fb-403c-a7c1-295f704f286a", // 日付・日時（時間ON）(カスタム)
"itemType": "datetime",
"itemTextData": {
"value": "2025-11-17T10:04:00Z"
}
},
{
"itemID": "84e76c96-a1ca-459e-b8dd-611af8499160", // 日付・日時（時間OFF）(カスタム)
"itemType": "date",
"itemTextData": {
"value": "2025-11-20"
}
},
{
"itemID": "4dcc8d35-6b85-4ab7-a11a-a1d2cd75f6f7", // 金額（小数ON）(カスタム)
"itemType": "amount_decimal",
"itemNumericData": {
"value": "999999999999999.99"
}
},
{
"itemID": "7c30a383-d250-4563-9b59-7191310f79d1", // 金額（小数OFF）(カスタム)
"itemType": "amount_integer",
"itemNumericData": {
"value": "999999999999999"
}
},
{
"itemID": "4540664f-fbca-4d47-9f09-fe1bb1570c1c", // 数字(カスタム)
"itemType": "number",
"itemNumericData": {
"value": "999999999"
}
},
{
"itemID": "9410c663-fb00-4f8e-9d22-dbcbe202104a", // 電話・FAX番号(カスタム)
"itemType": "phone_number",
"itemTextData": {
"value": "+8180-1234-5678"
}
},
{
"itemID": "033a3c04-9bd3-4009-b1cd-1fc64bc8d790", //URL(カスタム)
"itemType": "url",
"itemTextData": {
"value": "http://abcdefg.com"
}
},
{
"itemID": "f552e0b3-2b2a-4730-9859-44c7e52c0d2a", // メールアドレス(カスタム)
"itemType": "mail_address",
"itemTextData": {
"value": "test@test.test"
}
},
{
"itemID": "60f33605-f8fb-4f2d-99a5-45bef952ab4c", // 郵便番号(カスタム)
"itemType": "postal_code",
"itemTextData": {
"value": "105-0001"
}
},
{
"itemID": "bbbc4619-e7eb-4df0-ae1f-3d5e3c0ad8f8", // 都道府県(カスタム)
"itemType": "prefectures",
"itemTextData": {
"value": "東京都"
}
}
],
"systemLinkageInfoList": [
{
"systemLinkageID": 999000001, // システム連携ID
"linkageIDValue": "test1" // 連携ID値
}
]
}
}
}
}
レスポンス JSON
| 必須 | 形式 | 内容 | 補足 | ||
| appStatus | 〇 | Object | API の実行情報 | ||
| code | 〇 | String | 終了コード | ||
| message | String | メッセージ | |||
| registerClientResponsibleResult | Object | 取引先担当者登録結果情報 | API が正常終了した場合のみ値を格納 | ||
| clientResponsibleID | UUID | 登録された取引先担当者の取引先担当者ID | |||
レスポンス例(JSON)
{
"appStatus": {
"code": "S000",
"message": ""
},
"registerClientResponsibleResult": {
"clientResponsibleID": "75dabf15-d268-44c8-b76f-3e7be6a29be8"
}
}
API 固有の終了コード
| Code | Message | 概要 | 補足（主な原因など） |
| E041 | INVALID_PARAMETER | パラメータ異常 | 取引先担当者姓などの、取引先担当者テンプレートで必須設定となっている項目が指定されていない。 登録時バリデーションでエラーとなった場合（登録データの最大文字数超過など） |
| E199 | REQUEST_FAILURE | その他のエラー |
取引先担当者更新API
| URL | https://（ホスト）/api/crm/client-responsible/update |
| Content-Type | application/json |
| HTTPメソッド | POST |
APIの概要
テナント内の取引先担当者データを更新します。更新対象の取引先担当者項目データを項目リストに指定して更新します。更新については項目リストに設定されたデータをもとに差分更新で更新します。更新成功時に、レスポンスで更新した取引先担当者の取引先担当者IDが返されます。
リクエストボディ（JSON）
| 必須 | 形式 | 内容 | 補足 | ||||||
| param | 〇 | Object | |||||||
| toData | 〇 | Object | |||||||
| clientResponsibleUpdateInfo | 〇 | Object | |||||||
| clientResponsibleInfo | 〇(※1) | Object | 取引先担当者情報 | ||||||
| clientID | 〇 | UUID | 取引先ID | 更新対象の取引先担当者の取引先IDを指定 | |||||
| clientResponsibleID | 〇 | UUID | 取引先担当者ID | 更新対象の取引先担当者の取引先担当者IDを指定 | |||||
| systemLinkageInfo | 〇(※1) | Object | システム連携情報 | ||||||
| systemLinkageID | 〇 | Integer | システム連携ID | 連携システムのシステム連携IDを指定 | |||||
| linkageIDValue | 〇 | String | 連携ID値 | 更新対象の取引先担当者の連携システム側の顧客担当者IDを指定 | |||||
| clientResponsibleItemList | 〇 | Object[] | |||||||
| itemID | 〇 | UUID | 取引先担当者項目ID | 取引先担当者項目IDについては、取引先担当者テンプレート取得APIで取得出来るので同APIから取得 | |||||
| itemType | 〇 | String | 項目タイプ |
項目タイプの設定値および項目タイプの説明については、下記に記載。 |
|||||
| itemTextData | Object | 文字列型項目の値 |
項目タイプ（itemType）が文字列型の場合にこちらに項目データを設定。文字列型以外の場合は項目未設定。
|
||||||
| value | String | 項目値 | |||||||
| ruby | String | フリガナの値 | 項目タイプがtext_rubyの場合に、こちらにフリガナの値を設定する | ||||||
| itemNumericData | Object | 数値型項目の値 |
項目タイプ（itemType）が数値型の場合にこちらに項目データを設定。数値型以外の場合は項目未設定。 数値型の項目タイプ:number,amount_integer,amount_decimal |
||||||
| value | String | 項目値 | |||||||
| itemSelectionData | Object | 選択肢型項目の値 |
項目タイプ（itemType）が選択肢型の場合にこちらに項目データを設定。選択肢型以外の場合は項目未設定。 選択肢型の項目タイプ:pulldown,linkage_pulldown,checkbox |
||||||
| values | Integer[] | 項目値リスト | |||||||
| itemUuidData | Object | UUID型項目の値 |
項目タイプ（itemType）がUUID型の場合にこちらに項目データを設定。UUID型以外の場合は項目未設定。 UUID型の項目タイプ:user_single,user_multiple,division_single,division_multiple,client_single,client_multiple,clientresponsible_single,clientresponsible_multiple,product_single,product_multiple |
||||||
| values | UUID[] | 項目値リスト | |||||||
| clientResponsibleInquiryRouteDataList | Object[] | 取引先担当者引合経路リスト | 取引先担当者の引合経路（接触履歴）の情報を併せて登録・更新する場合にこちらにデータを設定 | ||||||
| inquiryRouteCategoryId | UUID | 引合経路カテゴリID | |||||||
| inquiryRouteId | UUID | 引合経路ID | |||||||
| systemLinkageInfoList | Object[] | システム連携情報リスト | 取引先担当者更新時にシステム連携ID値を併せて登録・更新する場合に指定 | ||||||
| systemLinkageID | Integer | システム連携ID | システム連携設定で登録されたシステム連携IDを設定（999000001～999000020の値） | ||||||
| linkageIDValue | String | 連携ID値 | 更新対象の取引先担当者に紐づく、連携システム側の顧客担当者IDを登録・更新値として設定 | ||||||
※1：clientResponsibleInfo、systemLinkageInfoのいずれかのみ必須。両方指定されている場合はエラー。clientResponsibleInfoが指定された時はclientID, clientResponsibleIDをキーに、systemLinkageInfoが指定された時はsystemLinkageID, linkageIDValueをキーにして更新
リクエストパラメタについての補足事項
①入力値のバリデーションチェックについて
パラメタで指定する更新値については、更新時にバリデーションチェックを行い、エラーの場合はバリデーションエラーとなります。バリデーションチェックの内容は、項目タイプ（itemType）により異なり、下記に記載のチェックを項目タイプ別に実施します。
項目タイプ値および項目タイプの説明
| リクエスト例(JSON)※取引先担当者情報で更新 | リクエスト例(JSON)※システム連携情報で更新 |
{
"param": {
"toData": {
"clientResponsibleUpdateInfo": {
"clientResponsibleInfo": {
"clientID": "7402ce69-57c3-4ea4-8a5d-d5a2765e8b32", // 取引先ID
"clientResponsibleID": "45153ad1-ca31-4fe1-9eb3-a90186321613" // 取引先担当者ID
},
"clientResponsibleItemList": [
{
"itemID": "9b9e4a9f-2d99-4195-b136-de0ea63c494e", // 取引先担当者姓
"itemType": "text_ruby",
"itemTextData": {
"value": "手須戸",
"ruby": "てすと"
}
},
{
"itemID": "4e797881-4042-4dd5-beb6-d3f2ba0d9790", // 取引先担当者名
"itemType": "text_ruby",
"itemTextData": {
"value": "太朗",
"ruby": "だろう"
}
},
{
"itemID": "e8f4b11d-41c4-4c05-afe8-a3c008fa2ce7", // 取引先
"itemType": "client_single",
"itemUuidData": {
"values": [
"7402ce69-57c3-4ea4-8a5d-d5a2765e8b32"
]
}
},
{
"itemID": "3f5ba10e-40d2-4b29-85b6-b7e7d1fff077", // 支社支店・拠点
"itemType": "text_single",
"itemTextData": {
"value": "虎ノ門支店"
}
},
{
"itemID": "5b558456-d616-4d4f-ae93-cae4023a6dd7", // 部署
"itemType": "text_single",
"itemTextData": {
"value": "営業推進部"
}
},
{
"itemID": "691c9ac2-01e8-4166-81fb-899149fcd416", // 役職
"itemType": "text_single",
"itemTextData": {
"value": "部長",
"ruby": ""
}
},
{
"itemID": "0e92f196-21a7-4a5f-ac8d-82dab042f031", // 誕生日
"itemType": "date",
"itemTextData": {
"value": "1900-01-01"
}
},
{
"itemID": "bd2f1841-f095-48f6-b634-35ea90bba0bd", // 電話番号1
"itemType": "phone_number",
"itemTextData": {
"value": "08012345678"
}
},
{
"itemID": "d3f1bb48-85c2-49ea-b24d-a3e94e4c2221", // 電話番号2
"itemType": "phone_number",
"itemTextData": {
"value": "08012345678"
}
},
{
"itemID": "bcdb231a-14e5-4708-9614-d692cd2245c6", // 内線番号
"itemType": "text_single",
"itemTextData": {
"value": "あいうえお"
}
},
{
"itemID": "41fe574b-712e-4a29-8dd0-e06607a0e962", // 携帯電話番号1
"itemType": "phone_number",
"itemTextData": {
"value": "08012345678"
}
},
{
"itemID": "e543665a-0a0b-4e0a-8212-3ffbe14e1e4f", // 携帯電話番号2
"itemType": "phone_number",
"itemTextData": {
"value": "08012345678"
}
},
{
"itemID": "b307ba2b-3cb2-41a5-90ea-6a30d853ef8e", // FAX番号1"
"itemType": "phone_number",
"itemTextData": {
"value": "08012345678"
}
},
{
"itemID": "35ecbf82-5b78-43fd-b9b2-71b762fd5d7b", // FAX番号2
"itemType": "phone_number",
"itemTextData": {
"value": "08012345678"
}
},
{
"itemID": "4e881466-88b5-46b3-b398-da99ad6cfb79", // メールアドレス1
"itemType": "mail_address",
"itemTextData": {
"value": "test@test.test"
}
},
{
"itemID": "7b9b4c8e-f56c-45a7-93ab-00c7a9e1046e", // メールアドレス2
"itemType": "mail_address",
"itemTextData": {
"value": "test@test.test"
}
},
{
"itemID": "f11a121e-3afa-44ce-9972-6e2d90799fb1", // 郵便番号
"itemType": "postal_code",
"itemTextData": {
"value": "105-0001"
}
},
{
"itemID": "ba86c3a5-bdb4-483b-88ec-a870f9975ed8", // 住所(都道府県)
"itemType": "prefectures",
"itemTextData": {
"value": "静岡県"
}
},
{
"itemID": "9fcc9ed9-586e-4707-8cd5-140d3eca35bc", // 住所(市区町村以下)
"itemType": "text_single",
"itemTextData": {
"value": "港区虎ノ門１−２−３"
}
},
{
"itemID": "eaf06a0c-2660-492d-9316-768db327a7be", // 詳細情報
"itemType": "text_multiple",
"itemTextData": {
"value": "あいうえお"
}
},
{
"itemID": "7e1dbd4d-d146-41e2-ad8d-9905b80ea565", // リスト名
"itemType": "text_single",
"itemTextData": {
"value": "あいうえお"
}
},
{
"itemID": "6963b14d-4a63-447a-af29-3f3b62bb4883", // メモ
"itemType": "text_single",
"itemTextData": {
"value": "あいうえお"
}
},
{
"itemID": "924aa432-138b-43c0-9f89-091417e84aa3", // 手書きメモ
"itemType": "text_single",
"itemTextData": {
"value": "あいうえお"
}
},
{
"itemID": "a214bb83-f81d-4631-9f1e-7c7efca08521", // 営業主担当部署
"itemType": "division_single",
"itemUuidData": {
"values": [
"41573754-0873-4a46-8f54-1cc318dd21a8"
]
}
},
{
"itemID": "e9ba034d-e8de-415c-a059-6c5096aa9daf", // 営業主担当者
"itemType": "user_single",
"itemUuidData": {
"values": [
"0501b83b-1b21-46f0-b21b-609e276c413e"
]
}
},
{
"itemID": "2b939d3d-600b-49e8-af06-8f43d20263c6", // 1行(カスタム)
"itemType": "text_single",
"itemTextData": {
"value": "あいうえお"
}
},
{
"itemID": "d4e91878-157a-4f96-9ace-60a1867c2bc4", // 複数行(カスタム)
"itemType": "text_multiple",
"itemTextData": {
"value": "あいうえお"
}
},
{
"itemID": "fd9a744b-dca1-4fd6-84ee-b01ebaa9e3db", // プルダウン(カスタム)
"itemType": "pulldown",
"itemSelectionData": {
"values": [
3
]
}
},
{
"itemID": "6f7b8c24-e951-4f00-b587-ebced57c0040", // 連携プルダウン(カスタム)
"itemType": "linkage_pulldown",
"itemSelectionData": {
"values": [
2,
4,
6
]
}
},
{
"itemID": "36bd0557-c72e-4e31-9dcd-9cb569375c11", // チェックボックス(カスタム)
"itemType": "checkbox",
"itemSelectionData": {
"values": [
2,
4
]
}
},
{
"itemID": "afd5de7c-5e24-48e6-8f19-05bc25a65c96", // ユーザー選択（単数）(カスタム)
"itemType": "user_single",
"itemUuidData": {
"values": [
"0501b83b-1b21-46f0-b21b-609e276c413e"
]
}
},
{
"itemID": "6c72922a-08dd-4cdd-992e-787cfd9be654",// ユーザー選択（複数）(カスタム)
"itemType": "user_multiple",
"itemUuidData": {
"values": [
"0501b83b-1b21-46f0-b21b-609e276c413e",
"4d62a0df-29c1-49a6-a5df-b3f546b59846",
"a6c837f9-3fc0-4357-94f5-466d9f7ecfa9"
]
}
},
{
"itemID": "5c0600a3-c482-4273-ab93-20743697260c", // 部署選択（単数）(カスタム)
"itemType": "division_single",
"itemUuidData": {
"values": [
"41573754-0873-4a46-8f54-1cc318dd21a8"
]
}
},
{
"itemID": "6aeb68cd-727e-482c-bc67-2b0a202508d4", // 部署選択（複数）(カスタム)
"itemType": "division_multiple",
"itemUuidData": {
"values": [
"1a493c22-c031-4952-9ed7-ca3823f91114",
"41573754-0873-4a46-8f54-1cc318dd21a8",
"be5a42cd-9f28-465f-81a3-b763d74a2300"
]
}
},
{
"itemID": "a888094b-c1fb-403c-a7c1-295f704f286a", // 日付・日時（時間ON）(カスタム)
"itemType": "datetime",
"itemTextData": {
"value": "2025-11-17T10:04:00Z"
}
},
{
"itemID": "84e76c96-a1ca-459e-b8dd-611af8499160", // 日付・日時（時間OFF）(カスタム)
"itemType": "date",
"itemTextData": {
"value": "2025-11-20"
}
},
{
"itemID": "4dcc8d35-6b85-4ab7-a11a-a1d2cd75f6f7", // 金額（小数ON）(カスタム)
"itemType": "amount_decimal",
"itemNumericData": {
"value": "999999999999999.99"
}
},
{
"itemID": "7c30a383-d250-4563-9b59-7191310f79d1", // 金額（小数OFF）(カスタム)
"itemType": "amount_integer",
"itemNumericData": {
"value": "999999999999999"
}
},
{
"itemID": "4540664f-fbca-4d47-9f09-fe1bb1570c1c", // 数字(カスタム)
"itemType": "number",
"itemNumericData": {
"value": "999999999"
}
},
{
"itemID": "9410c663-fb00-4f8e-9d22-dbcbe202104a", // 電話・FAX番号(カスタム)
"itemType": "phone_number",
"itemTextData": {
"value": "+8180-1234-5678"
}
},
{
"itemID": "033a3c04-9bd3-4009-b1cd-1fc64bc8d790", //URL(カスタム)
"itemType": "url",
"itemTextData": {
"value": "http://abcdefg.com"
}
},
{
"itemID": "f552e0b3-2b2a-4730-9859-44c7e52c0d2a", // メールアドレス(カスタム)
"itemType": "mail_address",
"itemTextData": {
"value": "test@test.test"
}
},
{
"itemID": "60f33605-f8fb-4f2d-99a5-45bef952ab4c", // 郵便番号(カスタム)
"itemType": "postal_code",
"itemTextData": {
"value": "105-0001"
}
},
{
"itemID": "bbbc4619-e7eb-4df0-ae1f-3d5e3c0ad8f8", // 都道府県(カスタム)
"itemType": "prefectures",
"itemTextData": {
"value": "東京都"
}
}
],
"systemLinkageInfoList": [
{
"systemLinkageID": 999000001, // システム連携ID
"linkageIDValue": "test10" // 連携ID値
}
]
}
}
}
}
|
{
"param": {
"toData": {
"clientResponsibleUpdateInfo": {
"systemLinkageInfo": {
"systemLinkageID": 999000001, // システム連携ID
"linkageIDValue": "test10" // 連携ID値
},
"clientResponsibleItemList": [
{
"itemID": "9b9e4a9f-2d99-4195-b136-de0ea63c494e", // 取引先担当者姓
"itemType": "text_ruby",
"itemTextData": {
"value": "手須戸",
"ruby": "てすと"
}
},
{
"itemID": "4e797881-4042-4dd5-beb6-d3f2ba0d9790", // 取引先担当者名
"itemType": "text_ruby",
"itemTextData": {
"value": "太朗",
"ruby": "だろう"
}
},
{
"itemID": "e8f4b11d-41c4-4c05-afe8-a3c008fa2ce7", // 取引先
"itemType": "client_single",
"itemUuidData": {
"values": [
"7402ce69-57c3-4ea4-8a5d-d5a2765e8b32"
]
}
},
{
"itemID": "3f5ba10e-40d2-4b29-85b6-b7e7d1fff077", // 支社支店・拠点
"itemType": "text_single",
"itemTextData": {
"value": "虎ノ門支店"
}
},
{
"itemID": "5b558456-d616-4d4f-ae93-cae4023a6dd7", // 部署
"itemType": "text_single",
"itemTextData": {
"value": "営業推進部"
}
},
{
"itemID": "691c9ac2-01e8-4166-81fb-899149fcd416", // 役職
"itemType": "text_single",
"itemTextData": {
"value": "部長",
"ruby": ""
}
},
{
"itemID": "0e92f196-21a7-4a5f-ac8d-82dab042f031", // 誕生日
"itemType": "date",
"itemTextData": {
"value": "1900-01-01"
}
},
{
"itemID": "bd2f1841-f095-48f6-b634-35ea90bba0bd", // 電話番号1
"itemType": "phone_number",
"itemTextData": {
"value": "08012345678"
}
},
{
"itemID": "d3f1bb48-85c2-49ea-b24d-a3e94e4c2221", // 電話番号2
"itemType": "phone_number",
"itemTextData": {
"value": "08012345678"
}
},
{
"itemID": "bcdb231a-14e5-4708-9614-d692cd2245c6", // 内線番号
"itemType": "text_single",
"itemTextData": {
"value": "あいうえお"
}
},
{
"itemID": "41fe574b-712e-4a29-8dd0-e06607a0e962", // 携帯電話番号1
"itemType": "phone_number",
"itemTextData": {
"value": "08012345678"
}
},
{
"itemID": "e543665a-0a0b-4e0a-8212-3ffbe14e1e4f", // 携帯電話番号2
"itemType": "phone_number",
"itemTextData": {
"value": "08012345678"
}
},
{
"itemID": "b307ba2b-3cb2-41a5-90ea-6a30d853ef8e", // FAX番号1"
"itemType": "phone_number",
"itemTextData": {
"value": "08012345678"
}
},
{
"itemID": "35ecbf82-5b78-43fd-b9b2-71b762fd5d7b", // FAX番号2
"itemType": "phone_number",
"itemTextData": {
"value": "08012345678"
}
},
{
"itemID": "4e881466-88b5-46b3-b398-da99ad6cfb79", // メールアドレス1
"itemType": "mail_address",
"itemTextData": {
"value": "test@test.test"
}
},
{
"itemID": "7b9b4c8e-f56c-45a7-93ab-00c7a9e1046e", // メールアドレス2
"itemType": "mail_address",
"itemTextData": {
"value": "test@test.test"
}
},
{
"itemID": "f11a121e-3afa-44ce-9972-6e2d90799fb1", // 郵便番号
"itemType": "postal_code",
"itemTextData": {
"value": "105-0001"
}
},
{
"itemID": "ba86c3a5-bdb4-483b-88ec-a870f9975ed8", // 住所(都道府県)
"itemType": "prefectures",
"itemTextData": {
"value": "静岡県"
}
},
{
"itemID": "9fcc9ed9-586e-4707-8cd5-140d3eca35bc", // 住所(市区町村以下)
"itemType": "text_single",
"itemTextData": {
"value": "港区虎ノ門１−２−３"
}
},
{
"itemID": "eaf06a0c-2660-492d-9316-768db327a7be", // 詳細情報
"itemType": "text_multiple",
"itemTextData": {
"value": "あいうえお"
}
},
{
"itemID": "7e1dbd4d-d146-41e2-ad8d-9905b80ea565", // リスト名
"itemType": "text_single",
"itemTextData": {
"value": "あいうえお"
}
},
{
"itemID": "6963b14d-4a63-447a-af29-3f3b62bb4883", // メモ
"itemType": "text_single",
"itemTextData": {
"value": "あいうえお"
}
},
{
"itemID": "924aa432-138b-43c0-9f89-091417e84aa3", // 手書きメモ
"itemType": "text_single",
"itemTextData": {
"value": "あいうえお"
}
},
{
"itemID": "a214bb83-f81d-4631-9f1e-7c7efca08521", // 営業主担当部署
"itemType": "division_single",
"itemUuidData": {
"values": [
"41573754-0873-4a46-8f54-1cc318dd21a8"
]
}
},
{
"itemID": "e9ba034d-e8de-415c-a059-6c5096aa9daf", // 営業主担当者
"itemType": "user_single",
"itemUuidData": {
"values": [
"0501b83b-1b21-46f0-b21b-609e276c413e"
]
}
},
{
"itemID": "2b939d3d-600b-49e8-af06-8f43d20263c6", // 1行(カスタム)
"itemType": "text_single",
"itemTextData": {
"value": "あいうえお"
}
},
{
"itemID": "d4e91878-157a-4f96-9ace-60a1867c2bc4", // 複数行(カスタム)
"itemType": "text_multiple",
"itemTextData": {
"value": "あいうえお"
}
},
{
"itemID": "fd9a744b-dca1-4fd6-84ee-b01ebaa9e3db", // プルダウン(カスタム)
"itemType": "pulldown",
"itemSelectionData": {
"values": [
3
]
}
},
{
"itemID": "6f7b8c24-e951-4f00-b587-ebced57c0040", // 連携プルダウン(カスタム)
"itemType": "linkage_pulldown",
"itemSelectionData": {
"values": [
2,
4,
6
]
}
},
{
"itemID": "36bd0557-c72e-4e31-9dcd-9cb569375c11", // チェックボックス(カスタム)
"itemType": "checkbox",
"itemSelectionData": {
"values": [
2,
4
]
}
},
{
"itemID": "afd5de7c-5e24-48e6-8f19-05bc25a65c96", // ユーザー選択（単数）(カスタム)
"itemType": "user_single",
"itemUuidData": {
"values": [
"0501b83b-1b21-46f0-b21b-609e276c413e"
]
}
},
{
"itemID": "6c72922a-08dd-4cdd-992e-787cfd9be654",// ユーザー選択（複数）(カスタム)
"itemType": "user_multiple",
"itemUuidData": {
"values": [
"0501b83b-1b21-46f0-b21b-609e276c413e",
"4d62a0df-29c1-49a6-a5df-b3f546b59846",
"a6c837f9-3fc0-4357-94f5-466d9f7ecfa9"
]
}
},
{
"itemID": "5c0600a3-c482-4273-ab93-20743697260c", // 部署選択（単数）(カスタム)
"itemType": "division_single",
"itemUuidData": {
"values": [
"41573754-0873-4a46-8f54-1cc318dd21a8"
]
}
},
{
"itemID": "6aeb68cd-727e-482c-bc67-2b0a202508d4", // 部署選択（複数）(カスタム)
"itemType": "division_multiple",
"itemUuidData": {
"values": [
"1a493c22-c031-4952-9ed7-ca3823f91114",
"41573754-0873-4a46-8f54-1cc318dd21a8",
"be5a42cd-9f28-465f-81a3-b763d74a2300"
]
}
},
{
"itemID": "a888094b-c1fb-403c-a7c1-295f704f286a", // 日付・日時（時間ON）(カスタム)
"itemType": "datetime",
"itemTextData": {
"value": "2025-11-17T10:04:00Z"
}
},
{
"itemID": "84e76c96-a1ca-459e-b8dd-611af8499160", // 日付・日時（時間OFF）(カスタム)
"itemType": "date",
"itemTextData": {
"value": "2025-11-20"
}
},
{
"itemID": "4dcc8d35-6b85-4ab7-a11a-a1d2cd75f6f7", // 金額（小数ON）(カスタム)
"itemType": "amount_decimal",
"itemNumericData": {
"value": "999999999999999.99"
}
},
{
"itemID": "7c30a383-d250-4563-9b59-7191310f79d1", // 金額（小数OFF）(カスタム)
"itemType": "amount_integer",
"itemNumericData": {
"value": "999999999999999"
}
},
{
"itemID": "4540664f-fbca-4d47-9f09-fe1bb1570c1c", // 数字(カスタム)
"itemType": "number",
"itemNumericData": {
"value": "999999999"
}
},
{
"itemID": "9410c663-fb00-4f8e-9d22-dbcbe202104a", // 電話・FAX番号(カスタム)
"itemType": "phone_number",
"itemTextData": {
"value": "+8180-1234-5678"
}
},
{
"itemID": "033a3c04-9bd3-4009-b1cd-1fc64bc8d790", //URL(カスタム)
"itemType": "url",
"itemTextData": {
"value": "http://abcdefg.com"
}
},
{
"itemID": "f552e0b3-2b2a-4730-9859-44c7e52c0d2a", // メールアドレス(カスタム)
"itemType": "mail_address",
"itemTextData": {
"value": "test@test.test"
}
},
{
"itemID": "60f33605-f8fb-4f2d-99a5-45bef952ab4c", // 郵便番号(カスタム)
"itemType": "postal_code",
"itemTextData": {
"value": "105-0001"
}
},
{
"itemID": "bbbc4619-e7eb-4df0-ae1f-3d5e3c0ad8f8", // 都道府県(カスタム)
"itemType": "prefectures",
"itemTextData": {
"value": "東京都"
}
}
],
"systemLinkageInfoList": [
{
"systemLinkageID": 999000001, // システム連携ID
"linkageIDValue": "test10" // 連携ID値
}
]
}
}
}
}
|
レスポンス JSON
| 必須 | 形式 | 内容 | 補足 | ||
| appStatus | 〇 | Object | API の実行情報 | ||
| code | 〇 | String | 終了コード | ||
| message | String | メッセージ | |||
| updateClientResponsibleResult | Object | 取引先担当者更新結果情報 | API が正常終了した場合のみ値を格納 | ||
| clientResponsibleID | UUID | 更新された取引先担当者の取引先担当者ID | |||
レスポンス例(JSON)
{
"appStatus": {
"code": "S000",
"message": ""
},
"updateClientResponsibleResult": {
"clientResponsibleID": "45153ad1-ca31-4fe1-9eb3-a90186321613"
}
}
API 固有の終了コード
| Code | Message | 概要 | 補足（主な原因など） |
| E041 | INVALID_PARAMETER | パラメータ異常 |
取引先担当者姓などの、取引先担当者テンプレートで必須設定となっている項目が指定されていない。 更新時バリデーションでエラーとなった場合（更新データの最大文字数超過など） |
| E199 | REQUEST_FAILURE | その他のエラー |
取引先担当者削除API
| URL | https://（ホスト）/api/crm/client-responsible/delete |
| Content-Type | application/json |
| HTTPメソッド | POST |
APIの概要
テナント内の取引先担当者データを削除します。削除対象の取引先担当者のIDを削除対象取引先担当者情報リストで指定する事で、複数の取引先担当者データをまとめて削除可能となります。削除成功時に、レスポンスで削除成功した取引先担当者の取引先担当者IDが返されます。
リクエストボディ（JSON）
| 必須 | 形式 | 内容 | 補足 | |||||
| param | 〇 | Object | ||||||
| toData | 〇 | Object | ||||||
| deleteClientResponsibleInfo | 〇 | Object | ||||||
| deleteClientResponsibleList | 〇(※1) | Object[] | 削除対象取引先担当者情報リスト | |||||
| clientID | 〇 | UUID | 取引先ID | 削除対象の取引先担当者の取引先IDを指定 | ||||
| clientResponsibleID | 〇 | UUID | 取引先担当者ID | 削除対象の取引先担当者の取引先担当者IDを指定 | ||||
| deleteSystemLinkageList | 〇(※1) | Object[] | 削除対象システム連携情報リスト | |||||
| systemLinkageID | 〇 | Integer | システム連携ID | 連携システムのシステム連携IDを指定 | ||||
| linkageIDValue | 〇 | String | 連携ID値 | 削除対象の取引先担当者の連携システム側の顧客担当者IDを指定 | ||||
| forceDeleteFlag | 〇 | Boolean | 強制削除フラグ | |||||
※1：deleteClientResponsibleList、deleteSystemLinkageListのいずれかのみ必須。両方指定された場合はエラー。
deleteClientResponsibleListが指定された時はclientID, clientResponsibleIDをキーに、deleteSystemLinkageListが指定された時はsystemLinkageID, linkageIDValueをキーにして削除。
| リクエスト例(JSON)※取引先担当者情報で削除 | リクエスト例(JSON)※システム連携情報で削除 |
{
"param": {
"toData": {
"deleteClientResponsibleInfo": {
"deleteClientResponsibleList": [
{
"clientID": "7402ce69-57c3-4ea4-8a5d-d5a2765e8b32", // 取引先ID
"clientResponsibleID": "45153ad1-ca31-4fe1-9eb3-a90186321613" // 取引先担当者ID
}
],
"forceDeleteFlag": true // 強制削除フラグ
}
}
}
} |
{
"param": {
"toData": {
"deleteClientResponsibleInfo": {
"deleteSystemLinkageList": [
{
"systemLinkageID": 999000001, // システム連携ID
"linkageIDValue": "test10" // 連携ID値
}
],
"forceDeleteFlag": true // 強制削除フラグ
}
}
}
} |
レスポンス JSON
| 必須 | 形式 | 内容 | 補足 | ||
| appStatus | 〇 | Object | API の実行情報 | ||
| code | 〇 | String | 終了コード | ||
| message | String | メッセージ | |||
| deletedClientResponsibleList | Object[] | 削除済取引先担当者リスト | API が正常終了した場合のみ値を格納 | ||
| clientResponsibleID | UUID | 削除された取引先担当者の取引先担当者ID | |||
レスポンス例(JSON)
{
"appStatus": {
"code": "S000",
"message": ""
},
"deletedClientResponsibleList": [
{
"clientResponsibleID": "45153ad1-ca31-4fe1-9eb3-a90186321613"
}
]
}
API 固有の終了コード
| Code | Message | 概要 | 補足（主な原因など） |
| E041 | INVALID_PARAMETER | パラメータ異常 | 必須項目（deleteClientResponsibleList、deleteSystemLinkageListのいずれか）が指定されていない |
| E051 | NOT_EXIST_DATA | 存在しないデータ | 削除対象システム連携情報リストで指定した、連携IDに紐づく取引先担当者が存在しない |
| E199 | REQUEST_FAILURE | その他のエラー |
参照系API
取引先テンプレート取得API
| URL | https://（ホスト）/api/crm/get-client-template |
| Content-Type | application/json |
| HTTPメソッド | GET |
APIの概要
テナント内の取引先のテンプレートデータを取得します。レスポンスで返される取引先テンプレートデータは、KS+の管理者画面の取引先テンプレート編集画面で編集・更新した内容（未編集の場合は契約・開通時に自動で初期設定された取引先テンプレートのデフォルト項目の内容）が返されます。
リクエストパラメタ
特に指定不要。
レスポンス JSON
| 必須 | 形式 | 内容 | 補足 | ||||||
| appStatus | 〇 | Object | API の実行情報 | ||||||
| code | 〇 | String | 終了コード | ||||||
| message | String | メッセージ | |||||||
| clientTemplateInfo | 〇 | Object | |||||||
| templateList | 〇 | Object[] | 取引先テンプレート項目のリスト | ||||||
| itemID | 〇 | UUID | 項目ID | ||||||
| itemType | 〇 | String | 項目タイプ | 項目タイプの設定値および項目タイプの説明については、下記に記載。 項目タイプ値および項目タイプの説明 |
|||||
| itemName | 〇 | String | 項目名 | ||||||
| requiredFlag | 〇 | Boolean | 必須フラグ | 項目が必須入力かどうかを表すフラグ（true:必須、false:必須でない） | |||||
| beforeUnit | String | 単位（前） | 項目タイプがnumber,amount_integer,amount_decimalの場合に設定。 ￥,＄などの金額の前につける通貨の単位などを設定 |
||||||
| afterUnit | String | 単位（後） | 項目タイプがnumber,amount_integer,amount_decimalの場合に設定。 円・ドルなどの金額の後につける通貨の単位などを設定。 |
||||||
| readOnlyFlag | 〇 | Boolean | 読み取り専用フラグ | 項目が読み取り専用項目かどうかを表すフラグ（true:読取専用、false:読取専用でない）。 同フラグがオンの場合、取引先登録・編集での登録は不可で、データは登録時にシステム側で自動で登録される。 |
|||||
| selectionValues | Object[] | 選択肢リスト | itemTypeがpulldown,checkbox,prefecturesの場合のみ値が設定され、それ以外の場合はnull | ||||||
| label | String | 選択肢項目ラベル | 選択肢として表示する文字列を設定 | ||||||
| displayFlag | Boolean | 表示フラグ | 選択肢を表示するかどうかを設定 | ||||||
| value | Integer | 選択肢の値 | 選択肢の値を設定 | ||||||
| linkageSelectionValues | Object[] | 連携選択肢リスト | itemTypeがlinkage_pulldownの場合のみ値が設定され、それ以外の場合はnull | ||||||
| label | String | 選択肢項目ラベル | 選択肢として表示する文字列を設定 | ||||||
| displayFlag | Boolean | 表示フラグ | 選択肢を表示するかどうかを設定 | ||||||
| value | Integer | 選択肢の値 | 選択肢の値を設定 | ||||||
| children | Object[] | 2階層目連携選択肢リスト | 1階層目の選択肢に紐づく2階層目の選択肢のリストを設定 | ||||||
| label | String | 選択肢項目ラベル | 選択肢として表示する文字列を設定 | ||||||
| displayFlag | Boolean | 表示フラグ | 選択肢を表示するかどうかを設定 | ||||||
| value | Integer | 選択肢の値 | 選択肢の値を設定 | ||||||
| children | Object[] | 3階層目連携選択肢リスト | 2階層目の選択肢に紐づく3階層目の選択肢のリストを設定 | ||||||
| label | String | 選択肢項目ラベル | 選択肢として表示する文字列を設定 | ||||||
| displayFlag | Boolean | 表示フラグ | 選択肢を表示するかどうかを設定 | ||||||
| value | Integer | 選択肢の値 | 選択肢の値を設定 | ||||||
| systemLinkageSettingInfoList | Object[] | 連携システム設定情報リスト | システム連携設定で、連携設定されている場合のみ値が設定され、それ以外の場合はnull | ||||||
| systemLinkageID | Integer | システム連携ID | システム連携設定で登録されたシステム連携IDを設定（999000001～999000020の値） | ||||||
| linkageSystemName | String | 連携システム名 | システム連携設定で登録された連携システム名を設定 | ||||||
レスポンス例(JSON)
{
"clientTemplateInfo": {
"templateList": [
{
"itemID": "2205f2e3-839f-4ff3-80f2-1ce6f8a86ac7",
"itemType": "text_ruby",
"itemName": "顧客名",
"requiredFlag": true,
"beforeUnit": null,
"afterUnit": null,
"readOnlyFlag": false,
"selectionValues": [],
"linkageSelectionValues": []
},
{
"itemID": "4bc99121-f618-4758-a452-240aa5c83800",
"itemType": "amount_integer",
"itemName": "カスタム金額１",
"requiredFlag": true,
"beforeUnit": null,
"afterUnit": "円",
"readOnlyFlag": false,
"selectionValues": [],
"linkageSelectionValues": []
},
{
"itemID": "4bc99121-f618-4758-a452-240aa5c83800",
"itemType": "pulldown",
"itemName": "顧客区分",
"requiredFlag": true,
"beforeUnit": null,
"afterUnit": null,
"readOnlyFlag": false,
"selectionValues": [
{ "label": "大口顧客", "displayFlag": true, "value": 1 },
{ "label": "中堅顧客", "displayFlag": true, "value": 2 },
{ "label": "小口顧客", "displayFlag": true, "value": 3 }
],
"linkageSelectionValues": []
},
{
"itemID": "8dcbd9c4-31d2-4531-a19d-85318032a4b1",
"itemType": "linkage_pulldown",
"itemName": "顧客業種",
"requiredFlag": false,
"beforeUnit": null,
"afterUnit": null,
"readOnlyFlag": false,
"selectionValues": [],
"linkageSelectionValues": [
{
"label": "金融業",
"displayFlag": true,
"value": 1,
"children": [
{ "label": "銀行", "displayFlag": true, "value": 1, "children": [] },
{ "label": "証券会社", "displayFlag": true, "value": 2, "children": [] },
{ "label": "消費者金融", "displayFlag": true, "value": 3, "children": [] }
]
},
{
"label": "飲食業",
"displayFlag": true,
"value": 2,
"children": [
{
"label": "レストラン",
"displayFlag": true,
"value": 1,
"children": [
{ "label": "ファミレス", "displayFlag": true, "value": 1, "children": [] },
{ "label": "フレンチ", "displayFlag": true, "value": 2, "children": [] }
]
},
{
"label": "ラーメン屋",
"displayFlag": true,
"value": 2,
"children": [
{ "label": "チェーン店", "displayFlag": true, "value": 1, "children": [] },
{ "label": "個人店", "displayFlag": true, "value": 2, "children": [] }
]
}
]
},
{
"label": "農業",
"displayFlag": true,
"value": 3,
"children": [
{ "label": "稲作", "displayFlag": true, "value": 1, "children": [] },
{ "label": "酪農", "displayFlag": true, "value": 2, "children": [] }
]
}
]
}
]
},
"systemLinkageSettingInfoList": [
{ "systemLinkageID": 999000001, "linkageSystemName": "基幹システムA" }
],
"appStatus": {
"code": "S000",
"message": ""
}
}
API 固有の終了コード
| Code | Message | 概要 | 補足（主な原因など） |
| E199 | REQUEST_FAILURE | その他のエラー |
取引先一覧取得API
| URL | https://（ホスト）/api/crm/get-client-list |
| Content-Type | application/json |
| HTTPメソッド | POST |
APIの概要
テナント内の取引先データを一覧リストとして取得します。パラメタのオフセットで開始位置を指定して、リミットで取得件数を指定して取得します。オプションで取引先の取引先名など、取引先の基本項目を検索条件として指定して検索して一覧取得も可能です。
リクエストボディ（JSON）
| 必須 | 形式 | 内容 | 補足 | ||||
| param | 〇 | Object | |||||
| requiredConditions | 〇 | Object | 必須条件項目 | 必須で指定必要な項目 | |||
| pagination | 〇 | Object | ページネーション | ||||
| offset | 〇 | Integer | オフセット | 検索の開始位置を0オリジンで指定 | |||
| limit | 〇 | Integer | リミット | レスポンスで返す一覧データの件数を指定（指定可能な値 - 最小:1、最大:100） | |||
| optionalConditions | Object | 任意条件項目 | 任意で指定可能な項目 | ||||
| searchConditions | Object | ||||||
| clientName | String | 検索条件：取引先名 | 取引先正式名称で部分一致検索する際に指定 | ||||
| prefectures | String[] | 検索条件：都道府県名 | 取引先の都道府県名で検索する際に指定。都道府県名で完全一致検索で、複数指定可能。「神奈川県」など、県名まで指定必要 | ||||
| address | String | 検索条件：住所 | 取引先の住所で部分一致検索する際に指定 | ||||
| salesPersonDepartmentIDList | UUID[] | 検索条件：営業担当部署 | 取引先の営業担当部署で検索する際に指定。対象の部署の組織IDを指定、複数指定可能 | ||||
| salesPersonUserIDList | UUID[] | 検索条件：営業担当者 | 取引先の営業担当者で検索する際に指定。対象の担当者のユーザーIDを指定、複数指定可能 | ||||
| createDateFrom | String | 検索条件：作成日From | 取引先の作成日以降で検索する際に指定。 | ||||
| createDateTo | String | 検索条件：作成日To | 取引先の作成日以前で検索する際に指定。 | ||||
| updateDateFrom | String | 検索条件：更新日From | 取引先の更新日以降で検索する際に指定。 | ||||
| updateDateTo | String | 検索条件：更新日To | 取引先の更新日以前で検索する際に指定。 | ||||
リクエスト例(JSON)
{
"param": {
"requiredConditions": {
"pagination": {
"offset": 0,
"limit": 10
}
},
"optionalConditions": {
"searchConditions": {}
}
}
}
レスポンス JSON
| 必須 | 形式 | 内容 | 補足 | ||||
| appStatus | 〇 | Object | API の実行情報 | ||||
| code | 〇 | String | 終了コード | ||||
| message | String | メッセージ | |||||
| clientListInfo | 〇 | Object | |||||
| clientList | 〇 | Object[] | 取引先一覧のリスト | 取引先一覧のリスト | |||
| clientID | 〇 | UUID | 取引先ID | ||||
| clientName | 〇 | String | 取引先名 | ||||
| systemLinkageInfoList | Object[] | システム連携情報リスト | システム連携設定で、連携設定されている場合のみ値が設定され、それ以外の場合はnull | ||||
| systemLinkageID | Integer | システム連携ID | システム連携設定で登録されたシステム連携IDを設定（999000001～999000020の値） | ||||
| linkageIDValue | String | 連携ID値 | 取引先IDに紐づく、連携システム側の顧客IDが登録されている場合、登録値が設定される | ||||
| getMoreFlag | 〇 | Boolean | 追加取得フラグ | 追加で取得できる取引先データが残っているかどうかのフラグ | |||
レスポンス例(JSON)
{
"clientListInfo": {
"clientList": [
{
"clientID": "5b32e4e2-2107-4ba5-ad92-f38383343bea",
"clientName": "ブルーテック株式会社",
"systemLinkageInfoList": [
{
"systemLinkageID": 999000001,
"linkageIDValue": "C00000111"
}
]
}
],
"getMoreFlag": false
},
"appStatus": {
"code": "S000",
"message": ""
}
}
API 固有の終了コード
| Code | Message | 概要 | 補足（主な原因など） |
| E041 | INVALID_PARAMETER | パラメータ異常 | オフセット、リミットなどの必須項目が指定されていない |
| E199 | REQUEST_FAILURE | その他のエラー |
追加取得フラグについて
レスポンスJSON の getMoreFlag が true である場合、取得最大件数を超えたため返却しきれなかった取引先データが残っている事を示します。本APIを下記のパラメータで実行することで、未取得となっている取引先リストの続きを取得することができます
| パラメータ | 設定内容 | |
| pagination | ||
| offset | 検索の開始位置を0オリジンで指定。今回のAPI実行でのoffset値にlimit値を加算した値を指定 | |
| limit | レスポンスで返す一覧データの件数を指定（指定可能な値 - 最小:1、最大:100） | |
取引先詳細取得API
| URL | https://（ホスト）/api/crm/get-client-detail |
| Content-Type | application/json |
| HTTPメソッド | POST |
APIの概要
パラメタの取引先IDに対応する取引先の詳細データを取得します。取引先登録・更新または名刺の名寄せで登録された取引先の項目データを詳細データとして取得します。
リクエストボディ（JSON）
| 必須 | 形式 | 内容 | 補足 | ||
| param | 〇 | Object | |||
| clientID | 〇(※1) | UUID | 取引先ID | ||
| systemLinkageID | 〇(※1) | Integer | システム連携ID | ||
| linkageIDValue | 〇(※1) | String | 連携ID値 | ||
※1：「clientID」と「systemLinkageID、linkageIDValue」はどちらか
リクエスト例(JSON)
{
"param": {
"clientID": "003e346b-0447-45fd-8581-66cf4309e264",
"systemLinkageID": 999000001,
"linkageIDValue": "string"
}
}
レスポンス JSON
| 必須 | 形式 | 内容 | 補足 | |||||
| appStatus | 〇 | Object | API の実行情報 | |||||
| code | 〇 | String | 終了コード | |||||
| message | String | メッセージ | ||||||
| clientDetailInfo | 〇 | Object | ||||||
| clientItemList | 〇 | Object[] | 取引先詳細項目のリスト | 取引先詳細項目のリスト | ||||
| itemID | 〇 | UUID | 取引先項目ID | 項目IDをキーに、取引先テンプレート取得APIの情報と照合する事で、項目のメタデータ（項目名や必須かどうかなど）を取得可能 | ||||
| itemType | 〇 | String | 項目タイプ | 項目タイプの設定値および項目タイプの説明については、下記に記載。 項目タイプ値および項目タイプの説明 |
||||
| itemTextData | Object | 文字列型項目の値 | 項目タイプ（itemType）が文字列型の場合にこちらに項目データを設定。文字列型以外の場合は項目未設定 文字列型の項目タイプ:text_single,text_multiple,date,datetime,phone_number,url,mail_address,postal_code,prefectures,text_ruby |
|||||
| value | String | 項目値 | ||||||
| ruby | String | フリガナの値 | 項目タイプがtext_rubyの場合に、こちらにフリガナの値が設定される | |||||
| itemNumericData | Object | 数値型項目の値 | 項目タイプ（itemType）が数値型の場合にこちらに項目データを設定。数値型以外の場合は項目未設定。 数値型の項目タイプ:number,amount_integer,amount_decimal |
|||||
| value | String | 項目値 | ||||||
| itemSelectionData | Object | 選択肢型項目の値 | 項目タイプ（itemType）が選択肢型の場合にこちらに項目データを設定。選択肢型以外の場合は項目未設定。 選択肢型の項目タイプ:pulldown,linkage_pulldown,checkbox |
|||||
| values | Integer[] | 項目値リスト | ||||||
| itemUuidDataList | Object[] | UUID型項目の値のリスト | 項目タイプ（itemType）がUUID型の場合にこちらに項目データを設定。UUID型以外の場合は項目未設定。 UUID型の項目タイプ:user_single,user_multiple,division_single,division_multiple,client_single,client_multiple,clientresponsible_single,clientresponsible_multiple,product_single,product_multiple |
|||||
| itemUuid | UUID | 項目値 | UUIDの項目値（UUID形式のID値）を設定 | |||||
| itemDisplayValue | String | 表示名 | UUIDの項目値に対する表示名を設定。 （例：user_singleの項目タイプの表示名の場合、「山田 太郎」などのユーザー名のデータを設定） |
|||||
| itemInquiryRouteData | Object | 引合経路型項目の値 | 項目タイプ（itemType）が引合経路型の場合にこちらに項目データを設定。引合経路型以外の場合は項目未設定。 引合経路型の項目タイプ:inquiry_route |
|||||
| values | Object[] | 項目値リスト | ||||||
| inquiryRouteCategoryId | UUID | 引合経路カテゴリID | ||||||
| inquiryRouteCategoryName | String | 引合経路カテゴリ名 | ||||||
| inquiryRouteId | UUID | 引合経路ID | ||||||
| inquiryRouteName | String | 引合経路名 | ||||||
| systemLinkageInfoList | Object[] | システム連携情報リスト | システム連携設定で、連携設定されている場合のみ値が設定され、それ以外の場合はnull | |||||
| systemLinkageID | Integer | システム連携ID | システム連携設定で登録されたシステム連携IDを設定（999000001～999000020の値） | |||||
| linkageIDValue | String | 連携ID値 | 取引先IDに紐づく、連携システム側の顧客IDが登録されている場合、登録値が設定される | |||||
レスポンス例(JSON)
{
"clientDetailInfo": {
"clientItemList": [
{
"itemID": "25c58fef-625c-4a47-a5a2-cc2c0c265bc6",
"itemType": "text_single",
"itemTextData": {
"value": "港区六本木1-2-3"
}
},
{
"itemID": "0a244d28-0e66-49ef-8cd9-8aa53760e6d8",
"itemType": "text_multiple",
"itemTextData": {
"value": "ABC株式会社の詳細説明\n説明その2"
}
},
{
"itemID": "e5866901-5699-412a-b95d-793a4e085d95",
"itemType": "date",
"itemTextData": {
"value": "2015-04-01"
}
},
{
"itemID": "abaf7064-0eba-497c-a907-386a41ec71d3",
"itemType": "datetime",
"itemTextData": {
"value": "2025-06-01 12:00:01"
}
},
{
"itemID": "b70b0359-fe8d-4293-b227-bb5692871c7a",
"itemType": "phone_number",
"itemTextData": {
"value": "03-1111-2222"
}
},
{
"itemID": "84e21e7c-5c08-4097-9cd0-b9eaffd4fb6d",
"itemType": "url",
"itemTextData": {
"value": "https://abc.co.jp"
}
},
{
"itemID": "7276fef2-1284-435f-bef5-e7431717d00d",
"itemType": "mail_address",
"itemTextData": {
"value": "support@abc.co.jp"
}
},
{
"itemID": "494cafbb-aa8d-41cc-8aac-2fe37c960c9b",
"itemType": "postal_code",
"itemTextData": {
"value": "111-2222"
}
},
{
"itemID": "8a87f4ef-19d6-4189-b3ca-6a9788b9ebc7",
"itemType": "prefectures",
"itemTextData": {
"value": "東京都"
}
},
{
"itemID": "2205f2e3-839f-4ff3-80f2-1ce6f8a86ac7",
"itemType": "text_ruby",
"itemTextData": {
"value": "ABC株式会社",
"ruby": "エービーシー"
}
},
{
"itemID": "9039dddf-9f34-4154-98f8-e3491d11b46f",
"itemType": "number",
"itemNumericData": {
"value": "1000"
}
},
{
"itemID": "a325243e-239d-455a-99bd-84f79f47d523",
"itemType": "amount_integer",
"itemNumericData": {
"value": "10000000"
}
},
{
"itemID": "69c313b1-823e-4940-aa7c-f9482319227f",
"itemType": "amount_decimal",
"itemNumericData": {
"value": "111.11"
}
},
{
"itemID": "b2e11f58-0ab4-41b7-80ff-166d98e78474",
"itemType": "pulldown",
"itemSelectionData": {
"values": [1]
}
},
{
"itemID": "4dc5bc40-e71f-47ff-ab7a-5328a51acbe1",
"itemType": "linkage_pulldown",
"itemSelectionData": {
"values": [1, 21, 121]
}
},
{
"itemID": "55567a07-a4a2-4dea-86f6-33bddfd3bcd2",
"itemType": "checkbox",
"itemSelectionData": {
"values": [1, 2]
}
},
{
"itemID": "88795555-0d22-46fd-bc6d-8a14c5d0dc7a",
"itemType": "user_single",
"itemUuidData": {
"values": ["aa426c02-561c-4ac7-8f53-7849b2235bbc"]
}
},
{
"itemID": "182651e5-4c24-4190-b41b-5708d2342c22",
"itemType": "user_multiple",
"itemUuidData": {
"values": [
"aa426c02-561c-4ac7-8f53-7849b2235bbc",
"b74922c9-727e-40a1-9034-e2a9446f9df9"
]
}
},
{
"itemID": "09cdb725-3cde-4f53-bc3f-8f9b2fef09f6",
"itemType": "inquiry_route",
"itemInquiryRouteData": {
"values": [
{
"inquiryRouteCategoryId": "0792591a-4e6f-4c8f-9e6d-be0cd0d25679",
"inquiryRouteCategoryName": "展示会",
"inquiryRouteId": "db0deb22-768b-400f-9b93-8cddfd000045",
"inquiryRouteName": "東京ビックサイト"
},
{
"inquiryRouteCategoryId": "d6754848-7174-4b13-a8f6-d1b2b29e79be",
"inquiryRouteCategoryName": "ルート営業",
"inquiryRouteId": "03ee5631-8df8-49e0-8503-1c1c214c8334",
"inquiryRouteName": "川崎ルート"
}
]
}
}
],
"systemLinkageInfoList": [
{
"systemLinkageID": 999000001,
"linkageIDValue": "C00000111"
}
]
},
"appStatus": {
"code": "S000",
"message": ""
}
}
API 固有の終了コード
| Code | Message | 概要 | 補足（主な原因など） |
| E041 | INVALID_PARAMETER | パラメータ異常 | 取引先IDなどの必須項目が指定されていない |
| E051 | NOT_EXIST_DATA | 存在しないデータ | 取引先IDに対応する取引先データが存在しない |
| E199 | REQUEST_FAILURE | その他のエラー |
取引先担当者テンプレート取得API
| URL | https://（ホスト）/api/crm/get-client-responsible-template |
| Content-Type | application/json |
| HTTPメソッド | GET |
APIの概要
テナント内の取引先担当者のテンプレートデータを取得します。レスポンスで返される取引先担当者テンプレートデータは、KS+の管理者画面の取引先担当者テンプレート編集画面で編集・更新した内容（未編集の場合は契約・開通時に自動で初期設定された取引先担当者テンプレートのデフォルト項目の内容）が返されます。
リクエストパラメタ
特に指定不要。
レスポンス JSON
| 必須 | 形式 | 内容 | 補足 | ||||||
| appStatus | 〇 | Object | API の実行情報 | ||||||
| code | 〇 | String | 終了コード | ||||||
| message | String | メッセージ | |||||||
| clientResponsibleTemplateInfo | 〇 | Object | |||||||
| templateList | 〇 | Object[] | 取引先担当者テンプレート項目のリスト | ||||||
| itemID | 〇 | UUID | 項目ID | ||||||
| itemType | 〇 | String | 項目タイプ | 項目タイプの設定値および項目タイプの説明については、下記に記載。 項目タイプ値および項目タイプの説明 |
|||||
| itemName | 〇 | String | 項目名 | ||||||
| requiredFlag | 〇 | Boolean | 必須フラグ | 項目が必須入力かどうかを表すフラグ（true:必須、false:必須でない） | |||||
| beforeUnit | String | 単位（前） | 項目タイプがnumber,amount_integer,amount_decimalの場合に設定。 ￥,＄などの金額の前につける通貨の単位などを設定 |
||||||
| afterUnit | String | 単位（後） | ・項目タイプがnumber,amount_integer,amount_decimalの場合に設定。 ・円・ドルなどの金額の後につける通貨の単位などを設定 |
||||||
| readOnlyFlag | 〇 | Boolean | 読み取り専用フラグ | ・項目が読み取り専用項目かどうかを表すフラグ（true:読取専用、false:読取専用でない）・ ・同フラグがオンの場合、取引先登録・編集での登録は不可で、データは登録時にシステム側で自動で登録される。 |
|||||
| selectionValues | Object[] | 選択肢リスト | itemTypeがpulldown,checkbox,prefecturesの場合のみ値が設定され、それ以外の場合はnull | ||||||
| label | String | 選択肢項目ラベル | 選択肢として表示する文字列を設定 | ||||||
| displayFlag | Boolean | 表示フラグ | 選択肢を表示するかどうかを設定 | ||||||
| value | Integer | 選択肢の値 | 選択肢の値を設定 | ||||||
| linkageSelectionValues | Object[] | 連携選択肢リスト | itemTypeがlinkage_pulldownの場合のみ値が設定され、それ以外の場合はnull | ||||||
| label | String | 選択肢項目ラベル | 選択肢として表示する文字列を設定 | ||||||
| displayFlag | Boolean | 表示フラグ | 選択肢を表示するかどうかを設定 | ||||||
| value | Integer | 選択肢の値 | 選択肢の値を設定 | ||||||
| children | Object[] | 2階層目連携選択肢リスト | 1階層目の選択肢に紐づく2階層目の選択肢のリストを設定 | ||||||
| label | String | 選択肢項目ラベル | 選択肢として表示する文字列を設定 | ||||||
| displayFlag | Boolean | 表示フラグ | 選択肢を表示するかどうかを設定 | ||||||
| value | Integer | 選択肢の値 | 選択肢の値を設定 | ||||||
| children | Object[] | 3階層目連携選択肢リスト | 2階層目の選択肢に紐づく3階層目の選択肢のリストを設定 | ||||||
| label | String | 選択肢項目ラベル | 選択肢として表示する文字列を設定 | ||||||
| displayFlag | Boolean | 表示フラグ | 選択肢を表示するかどうかを設定 | ||||||
| value | Integer | 選択肢の値 | 選択肢の値を設定 | ||||||
| systemLinkageSettingInfoList | Object[] | 連携システム設定情報リスト | システム連携設定で、連携設定されている場合のみ値が設定され、それ以外の場合はnull | ||||||
| systemLinkageID | Integer | システム連携ID | システム連携設定で登録されたシステム連携IDを設定（999000001～999000020の値） | ||||||
| linkageSystemName | String | 連携システム名 | システム連携設定で登録された連携システム名を設定 | ||||||
レスポンス例(JSON)
{
"appStatus": {
"code": "S000",
"message": ""
},
"clientResponsibleTemplateInfo": {
"templateList": [
{
"itemID": "9b9e4a9f-2d99-4195-b136-de0ea63c494e",
"itemType": "text_ruby",
"itemName": "取引先担当者姓",
"requiredFlag": true,
"beforeUnit": null,
"afterUnit": null,
"readOnlyFlag": false,
"selectionValues": null,
"linkageSelectionValues": null
},
{
"itemID": "4e797881-4042-4dd5-beb6-d3f2ba0d9790",
"itemType": "text_ruby",
"itemName": "取引先担当者名",
"requiredFlag": false,
"beforeUnit": null,
"afterUnit": null,
"readOnlyFlag": false,
"selectionValues": null,
"linkageSelectionValues": null
},
{
"itemID": "e8f4b11d-41c4-4c05-afe8-a3c008fa2ce7",
"itemType": "client_single",
"itemName": "取引先",
"requiredFlag": true,
"beforeUnit": null,
"afterUnit": null,
"readOnlyFlag": false,
"selectionValues": null,
"linkageSelectionValues": null
},
{
"itemID": "3f5ba10e-40d2-4b29-85b6-b7e7d1fff077",
"itemType": "text_single",
"itemName": "支社支店・拠点",
"requiredFlag": false,
"beforeUnit": null,
"afterUnit": null,
"readOnlyFlag": false,
"selectionValues": null,
"linkageSelectionValues": null
},
{
"itemID": "5b558456-d616-4d4f-ae93-cae4023a6dd7",
"itemType": "text_single",
"itemName": "部署",
"requiredFlag": false,
"beforeUnit": null,
"afterUnit": null,
"readOnlyFlag": false,
"selectionValues": null,
"linkageSelectionValues": null
},
{
"itemID": "691c9ac2-01e8-4166-81fb-899149fcd416",
"itemType": "text_single",
"itemName": "役職",
"requiredFlag": false,
"beforeUnit": null,
"afterUnit": null,
"readOnlyFlag": false,
"selectionValues": null,
"linkageSelectionValues": null
},
{
"itemID": "0e92f196-21a7-4a5f-ac8d-82dab042f031",
"itemType": "date",
"itemName": "誕生日",
"requiredFlag": false,
"beforeUnit": null,
"afterUnit": null,
"readOnlyFlag": false,
"selectionValues": null,
"linkageSelectionValues": null
},
{
"itemID": "bd2f1841-f095-48f6-b634-35ea90bba0bd",
"itemType": "phone_number",
"itemName": "電話番号1",
"requiredFlag": false,
"beforeUnit": null,
"afterUnit": null,
"readOnlyFlag": false,
"selectionValues": null,
"linkageSelectionValues": null
},
{
"itemID": "d3f1bb48-85c2-49ea-b24d-a3e94e4c2221",
"itemType": "phone_number",
"itemName": "電話番号2",
"requiredFlag": false,
"beforeUnit": null,
"afterUnit": null,
"readOnlyFlag": false,
"selectionValues": null,
"linkageSelectionValues": null
},
{
"itemID": "bcdb231a-14e5-4708-9614-d692cd2245c6",
"itemType": "text_single",
"itemName": "内線番号",
"requiredFlag": false,
"beforeUnit": null,
"afterUnit": null,
"readOnlyFlag": false,
"selectionValues": null,
"linkageSelectionValues": null
},
{
"itemID": "41fe574b-712e-4a29-8dd0-e06607a0e962",
"itemType": "phone_number",
"itemName": "携帯電話番号1",
"requiredFlag": false,
"beforeUnit": null,
"afterUnit": null,
"readOnlyFlag": false,
"selectionValues": null,
"linkageSelectionValues": null
},
{
"itemID": "e543665a-0a0b-4e0a-8212-3ffbe14e1e4f",
"itemType": "phone_number",
"itemName": "携帯電話番号2",
"requiredFlag": false,
"beforeUnit": null,
"afterUnit": null,
"readOnlyFlag": false,
"selectionValues": null,
"linkageSelectionValues": null
},
{
"itemID": "b307ba2b-3cb2-41a5-90ea-6a30d853ef8e",
"itemType": "phone_number",
"itemName": "FAX番号1",
"requiredFlag": false,
"beforeUnit": null,
"afterUnit": null,
"readOnlyFlag": false,
"selectionValues": null,
"linkageSelectionValues": null
},
{
"itemID": "35ecbf82-5b78-43fd-b9b2-71b762fd5d7b",
"itemType": "phone_number",
"itemName": "FAX番号2",
"requiredFlag": false,
"beforeUnit": null,
"afterUnit": null,
"readOnlyFlag": false,
"selectionValues": null,
"linkageSelectionValues": null
},
{
"itemID": "4e881466-88b5-46b3-b398-da99ad6cfb79",
"itemType": "mail_address",
"itemName": "メールアドレス1",
"requiredFlag": false,
"beforeUnit": null,
"afterUnit": null,
"readOnlyFlag": false,
"selectionValues": null,
"linkageSelectionValues": null
},
{
"itemID": "7b9b4c8e-f56c-45a7-93ab-00c7a9e1046e",
"itemType": "mail_address",
"itemName": "メールアドレス2",
"requiredFlag": false,
"beforeUnit": null,
"afterUnit": null,
"readOnlyFlag": false,
"selectionValues": null,
"linkageSelectionValues": null
},
{
"itemID": "f11a121e-3afa-44ce-9972-6e2d90799fb1",
"itemType": "postal_code",
"itemName": "郵便番号",
"requiredFlag": false,
"beforeUnit": null,
"afterUnit": null,
"readOnlyFlag": false,
"selectionValues": null,
"linkageSelectionValues": null
},
{
"itemID": "ba86c3a5-bdb4-483b-88ec-a870f9975ed8",
"itemType": "prefectures",
"itemName": "住所(都道府県)",
"requiredFlag": false,
"beforeUnit": null,
"afterUnit": null,
"readOnlyFlag": false,
"selectionValues": [
{
"label": "北海道",
"displayFlag": true,
"value": 1
},
{
"label": "青森県",
"displayFlag": true,
"value": 2
},
{
"label": "岩手県",
"displayFlag": true,
"value": 3
},
{
"label": "宮城県",
"displayFlag": true,
"value": 4
},
{
"label": "秋田県",
"displayFlag": true,
"value": 5
},
{
"label": "山形県",
"displayFlag": true,
"value": 6
},
{
"label": "福島県",
"displayFlag": true,
"value": 7
},
{
"label": "茨城県",
"displayFlag": true,
"value": 8
},
{
"label": "栃木県",
"displayFlag": true,
"value": 9
},
{
"label": "群馬県",
"displayFlag": true,
"value": 10
},
{
"label": "埼玉県",
"displayFlag": true,
"value": 11
},
{
"label": "千葉県",
"displayFlag": true,
"value": 12
},
{
"label": "東京都",
"displayFlag": true,
"value": 13
},
{
"label": "神奈川県",
"displayFlag": true,
"value": 14
},
{
"label": "山梨県",
"displayFlag": true,
"value": 15
},
{
"label": "長野県",
"displayFlag": true,
"value": 16
},
{
"label": "新潟県",
"displayFlag": true,
"value": 17
},
{
"label": "富山県",
"displayFlag": true,
"value": 18
},
{
"label": "石川県",
"displayFlag": true,
"value": 19
},
{
"label": "福井県",
"displayFlag": true,
"value": 20
},
{
"label": "岐阜県",
"displayFlag": true,
"value": 21
},
{
"label": "静岡県",
"displayFlag": true,
"value": 22
},
{
"label": "愛知県",
"displayFlag": true,
"value": 23
},
{
"label": "三重県",
"displayFlag": true,
"value": 24
},
{
"label": "滋賀県",
"displayFlag": true,
"value": 25
},
{
"label": "京都府",
"displayFlag": true,
"value": 26
},
{
"label": "大阪府",
"displayFlag": true,
"value": 27
},
{
"label": "兵庫県",
"displayFlag": true,
"value": 28
},
{
"label": "奈良県",
"displayFlag": true,
"value": 29
},
{
"label": "和歌山県",
"displayFlag": true,
"value": 30
},
{
"label": "鳥取県",
"displayFlag": true,
"value": 31
},
{
"label": "島根県",
"displayFlag": true,
"value": 32
},
{
"label": "岡山県",
"displayFlag": true,
"value": 33
},
{
"label": "広島県",
"displayFlag": true,
"value": 34
},
{
"label": "山口県",
"displayFlag": true,
"value": 35
},
{
"label": "徳島県",
"displayFlag": true,
"value": 36
},
{
"label": "香川県",
"displayFlag": true,
"value": 37
},
{
"label": "愛媛県",
"displayFlag": true,
"value": 38
},
{
"label": "高知県",
"displayFlag": true,
"value": 39
},
{
"label": "福岡県",
"displayFlag": true,
"value": 40
},
{
"label": "佐賀県",
"displayFlag": true,
"value": 41
},
{
"label": "長崎県",
"displayFlag": true,
"value": 42
},
{
"label": "熊本県",
"displayFlag": true,
"value": 43
},
{
"label": "大分県",
"displayFlag": true,
"value": 44
},
{
"label": "宮崎県",
"displayFlag": true,
"value": 45
},
{
"label": "鹿児島県",
"displayFlag": true,
"value": 46
},
{
"label": "沖縄県",
"displayFlag": true,
"value": 47
}
],
"linkageSelectionValues": null
},
{
"itemID": "9fcc9ed9-586e-4707-8cd5-140d3eca35bc",
"itemType": "text_single",
"itemName": "住所(市区町村以下)",
"requiredFlag": false,
"beforeUnit": null,
"afterUnit": null,
"readOnlyFlag": false,
"selectionValues": null,
"linkageSelectionValues": null
},
{
"itemID": "eaf06a0c-2660-492d-9316-768db327a7be",
"itemType": "text_multiple",
"itemName": "詳細情報",
"requiredFlag": false,
"beforeUnit": null,
"afterUnit": null,
"readOnlyFlag": false,
"selectionValues": null,
"linkageSelectionValues": null
},
{
"itemID": "7e1dbd4d-d146-41e2-ad8d-9905b80ea565",
"itemType": "text_single",
"itemName": "リスト名",
"requiredFlag": false,
"beforeUnit": null,
"afterUnit": null,
"readOnlyFlag": false,
"selectionValues": null,
"linkageSelectionValues": null
},
{
"itemID": "6963b14d-4a63-447a-af29-3f3b62bb4883",
"itemType": "text_single",
"itemName": "メモ",
"requiredFlag": false,
"beforeUnit": null,
"afterUnit": null,
"readOnlyFlag": false,
"selectionValues": null,
"linkageSelectionValues": null
},
{
"itemID": "924aa432-138b-43c0-9f89-091417e84aa3",
"itemType": "text_single",
"itemName": "手書きメモ",
"requiredFlag": false,
"beforeUnit": null,
"afterUnit": null,
"readOnlyFlag": false,
"selectionValues": null,
"linkageSelectionValues": null
},
{
"itemID": "abaf7064-0eba-497c-a907-386a41ec71d3",
"itemType": "datetime",
"itemName": "作成日",
"requiredFlag": false,
"beforeUnit": null,
"afterUnit": null,
"readOnlyFlag": true,
"selectionValues": null,
"linkageSelectionValues": null
},
{
"itemID": "c3fdda6a-9eb5-427b-af55-45037f3889dd",
"itemType": "user_single",
"itemName": "作成者",
"requiredFlag": false,
"beforeUnit": null,
"afterUnit": null,
"readOnlyFlag": true,
"selectionValues": null,
"linkageSelectionValues": null
},
{
"itemID": "b91ed3f4-d0a0-4337-8d25-4117cb823d83",
"itemType": "datetime",
"itemName": "最終更新日",
"requiredFlag": false,
"beforeUnit": null,
"afterUnit": null,
"readOnlyFlag": true,
"selectionValues": null,
"linkageSelectionValues": null
},
{
"itemID": "612017e9-b88e-4ba7-90fe-7322590a6ddc",
"itemType": "user_single",
"itemName": "最終更新者",
"requiredFlag": false,
"beforeUnit": null,
"afterUnit": null,
"readOnlyFlag": true,
"selectionValues": null,
"linkageSelectionValues": null
},
{
"itemID": "a214bb83-f81d-4631-9f1e-7c7efca08521",
"itemType": "division_single",
"itemName": "営業主担当部署",
"requiredFlag": true,
"beforeUnit": null,
"afterUnit": null,
"readOnlyFlag": false,
"selectionValues": null,
"linkageSelectionValues": null
},
{
"itemID": "e9ba034d-e8de-415c-a059-6c5096aa9daf",
"itemType": "user_single",
"itemName": "営業主担当者",
"requiredFlag": true,
"beforeUnit": null,
"afterUnit": null,
"readOnlyFlag": false,
"selectionValues": null,
"linkageSelectionValues": null
},
{
"itemID": "2b939d3d-600b-49e8-af06-8f43d20263c6",
"itemType": "text_single",
"itemName": "1行",
"requiredFlag": false,
"beforeUnit": null,
"afterUnit": null,
"readOnlyFlag": false,
"selectionValues": null,
"linkageSelectionValues": null
},
{
"itemID": "d4e91878-157a-4f96-9ace-60a1867c2bc4",
"itemType": "text_multiple",
"itemName": "複数行",
"requiredFlag": false,
"beforeUnit": null,
"afterUnit": null,
"readOnlyFlag": false,
"selectionValues": null,
"linkageSelectionValues": null
},
{
"itemID": "fd9a744b-dca1-4fd6-84ee-b01ebaa9e3db",
"itemType": "pulldown",
"itemName": "プルダウン",
"requiredFlag": false,
"beforeUnit": null,
"afterUnit": null,
"readOnlyFlag": false,
"selectionValues": [
{
"label": "きょう？",
"displayFlag": true,
"value": 1
},
{
"label": "あした？",
"displayFlag": true,
"value": 2
},
{
"label": "もしかしてあさって？！",
"displayFlag": true,
"value": 3
},
{
"label": "test",
"displayFlag": true,
"value": 4
}
],
"linkageSelectionValues": null
},
{
"itemID": "6f7b8c24-e951-4f00-b587-ebced57c0040",
"itemType": "linkage_pulldown",
"itemName": "連携プルダウン",
"requiredFlag": false,
"beforeUnit": null,
"afterUnit": null,
"readOnlyFlag": false,
"selectionValues": null,
"linkageSelectionValues": [
{
"label": "選択肢1（第一階層）",
"displayFlag": true,
"value": 1,
"children": [
{
"label": "選択肢1（第二階層）",
"displayFlag": true,
"value": 3,
"children": [
{
"label": "選択肢1（第三階層）",
"displayFlag": true,
"value": 5,
"children": []
}
]
},
{
"label": "選択肢2（第二階層）",
"displayFlag": true,
"value": 7,
"children": [
{
"label": "選択肢1（第三階層）",
"displayFlag": true,
"value": 8,
"children": []
}
]
}
]
},
{
"label": "選択肢2（第一階層）",
"displayFlag": true,
"value": 2,
"children": [
{
"label": "選択肢1（第二階層）",
"displayFlag": true,
"value": 4,
"children": [
{
"label": "選択肢1（第三階層）",
"displayFlag": true,
"value": 6,
"children": []
}
]
}
]
}
]
},
{
"itemID": "36bd0557-c72e-4e31-9dcd-9cb569375c11",
"itemType": "checkbox",
"itemName": "チェックボックス",
"requiredFlag": false,
"beforeUnit": null,
"afterUnit": null,
"readOnlyFlag": false,
"selectionValues": [
{
"label": "テスト１",
"displayFlag": true,
"value": 1
},
{
"label": "テスト２",
"displayFlag": true,
"value": 2
},
{
"label": "テスト３",
"displayFlag": true,
"value": 3
},
{
"label": "テスト４",
"displayFlag": true,
"value": 4
}
],
"linkageSelectionValues": null
},
{
"itemID": "afd5de7c-5e24-48e6-8f19-05bc25a65c96",
"itemType": "user_single",
"itemName": "ユーザー選択（単数）",
"requiredFlag": false,
"beforeUnit": null,
"afterUnit": null,
"readOnlyFlag": false,
"selectionValues": null,
"linkageSelectionValues": null
},
{
"itemID": "6c72922a-08dd-4cdd-992e-787cfd9be654",
"itemType": "user_multiple",
"itemName": "ユーザー選択（複数）",
"requiredFlag": false,
"beforeUnit": null,
"afterUnit": null,
"readOnlyFlag": false,
"selectionValues": null,
"linkageSelectionValues": null
},
{
"itemID": "5c0600a3-c482-4273-ab93-20743697260c",
"itemType": "division_single",
"itemName": "部署選択（単数）",
"requiredFlag": false,
"beforeUnit": null,
"afterUnit": null,
"readOnlyFlag": false,
"selectionValues": null,
"linkageSelectionValues": null
},
{
"itemID": "6aeb68cd-727e-482c-bc67-2b0a202508d4",
"itemType": "division_multiple",
"itemName": "部署選択（複数）",
"requiredFlag": false,
"beforeUnit": null,
"afterUnit": null,
"readOnlyFlag": false,
"selectionValues": null,
"linkageSelectionValues": null
},
{
"itemID": "a888094b-c1fb-403c-a7c1-295f704f286a",
"itemType": "datetime",
"itemName": "日付・日時（時間ON）",
"requiredFlag": false,
"beforeUnit": null,
"afterUnit": null,
"readOnlyFlag": false,
"selectionValues": null,
"linkageSelectionValues": null
},
{
"itemID": "84e76c96-a1ca-459e-b8dd-611af8499160",
"itemType": "date",
"itemName": "日付・日時（時間OFF）",
"requiredFlag": false,
"beforeUnit": null,
"afterUnit": null,
"readOnlyFlag": false,
"selectionValues": null,
"linkageSelectionValues": null
},
{
"itemID": "4dcc8d35-6b85-4ab7-a11a-a1d2cd75f6f7",
"itemType": "amount_decimal",
"itemName": "金額（小数ON）",
"requiredFlag": false,
"beforeUnit": "まえ",
"afterUnit": "うしろ",
"readOnlyFlag": false,
"selectionValues": null,
"linkageSelectionValues": null
},
{
"itemID": "7c30a383-d250-4563-9b59-7191310f79d1",
"itemType": "amount_integer",
"itemName": "金額（小数OFF）",
"requiredFlag": false,
"beforeUnit": "まえ",
"afterUnit": "うしろ",
"readOnlyFlag": false,
"selectionValues": null,
"linkageSelectionValues": null
},
{
"itemID": "4540664f-fbca-4d47-9f09-fe1bb1570c1c",
"itemType": "number",
"itemName": "数字",
"requiredFlag": false,
"beforeUnit": null,
"afterUnit": null,
"readOnlyFlag": false,
"selectionValues": null,
"linkageSelectionValues": null
},
{
"itemID": "9410c663-fb00-4f8e-9d22-dbcbe202104a",
"itemType": "phone_number",
"itemName": "電話・FAX番号",
"requiredFlag": false,
"beforeUnit": null,
"afterUnit": null,
"readOnlyFlag": false,
"selectionValues": null,
"linkageSelectionValues": null
},
{
"itemID": "033a3c04-9bd3-4009-b1cd-1fc64bc8d790",
"itemType": "url",
"itemName": "URL",
"requiredFlag": false,
"beforeUnit": null,
"afterUnit": null,
"readOnlyFlag": false,
"selectionValues": null,
"linkageSelectionValues": null
},
{
"itemID": "f552e0b3-2b2a-4730-9859-44c7e52c0d2a",
"itemType": "mail_address",
"itemName": "メールアドレス",
"requiredFlag": false,
"beforeUnit": null,
"afterUnit": null,
"readOnlyFlag": false,
"selectionValues": null,
"linkageSelectionValues": null
},
{
"itemID": "60f33605-f8fb-4f2d-99a5-45bef952ab4c",
"itemType": "postal_code",
"itemName": "郵便番号",
"requiredFlag": false,
"beforeUnit": null,
"afterUnit": null,
"readOnlyFlag": false,
"selectionValues": null,
"linkageSelectionValues": null
},
{
"itemID": "bbbc4619-e7eb-4df0-ae1f-3d5e3c0ad8f8",
"itemType": "prefectures",
"itemName": "都道府県",
"requiredFlag": false,
"beforeUnit": null,
"afterUnit": null,
"readOnlyFlag": false,
"selectionValues": [
{
"label": "北海道",
"displayFlag": true,
"value": 1
},
{
"label": "青森県",
"displayFlag": true,
"value": 2
},
{
"label": "岩手県",
"displayFlag": true,
"value": 3
},
{
"label": "宮城県",
"displayFlag": true,
"value": 4
},
{
"label": "秋田県",
"displayFlag": true,
"value": 5
},
{
"label": "山形県",
"displayFlag": true,
"value": 6
},
{
"label": "福島県",
"displayFlag": true,
"value": 7
},
{
"label": "茨城県",
"displayFlag": true,
"value": 8
},
{
"label": "栃木県",
"displayFlag": true,
"value": 9
},
{
"label": "群馬県",
"displayFlag": true,
"value": 10
},
{
"label": "埼玉県",
"displayFlag": true,
"value": 11
},
{
"label": "千葉県",
"displayFlag": true,
"value": 12
},
{
"label": "東京都",
"displayFlag": true,
"value": 13
},
{
"label": "神奈川県",
"displayFlag": true,
"value": 14
},
{
"label": "新潟県",
"displayFlag": true,
"value": 15
},
{
"label": "富山県",
"displayFlag": true,
"value": 16
},
{
"label": "石川県",
"displayFlag": true,
"value": 17
},
{
"label": "福井県",
"displayFlag": true,
"value": 18
},
{
"label": "山梨県",
"displayFlag": true,
"value": 19
},
{
"label": "長野県",
"displayFlag": true,
"value": 20
},
{
"label": "岐阜県",
"displayFlag": true,
"value": 21
},
{
"label": "静岡県",
"displayFlag": true,
"value": 22
},
{
"label": "愛知県",
"displayFlag": true,
"value": 23
},
{
"label": "三重県",
"displayFlag": true,
"value": 24
},
{
"label": "滋賀県",
"displayFlag": true,
"value": 25
},
{
"label": "京都府",
"displayFlag": true,
"value": 26
},
{
"label": "大阪府",
"displayFlag": true,
"value": 27
},
{
"label": "兵庫県",
"displayFlag": true,
"value": 28
},
{
"label": "奈良県",
"displayFlag": true,
"value": 29
},
{
"label": "和歌山県",
"displayFlag": true,
"value": 30
},
{
"label": "鳥取県",
"displayFlag": true,
"value": 31
},
{
"label": "島根県",
"displayFlag": true,
"value": 32
},
{
"label": "岡山県",
"displayFlag": true,
"value": 33
},
{
"label": "広島県",
"displayFlag": true,
"value": 34
},
{
"label": "山口県",
"displayFlag": true,
"value": 35
},
{
"label": "徳島県",
"displayFlag": true,
"value": 36
},
{
"label": "香川県",
"displayFlag": true,
"value": 37
},
{
"label": "愛媛県",
"displayFlag": true,
"value": 38
},
{
"label": "高知県",
"displayFlag": true,
"value": 39
},
{
"label": "福岡県",
"displayFlag": true,
"value": 40
},
{
"label": "佐賀県",
"displayFlag": true,
"value": 41
},
{
"label": "長崎県",
"displayFlag": true,
"value": 42
},
{
"label": "熊本県",
"displayFlag": true,
"value": 43
},
{
"label": "大分県",
"displayFlag": true,
"value": 44
},
{
"label": "宮崎県",
"displayFlag": true,
"value": 45
},
{
"label": "鹿児島県",
"displayFlag": true,
"value": 46
},
{
"label": "沖縄県",
"displayFlag": true,
"value": 47
}
],
"linkageSelectionValues": null
}
]
},
"systemLinkageSettingInfoList": [
{
"systemLinkageID": 999000001,
"linkageSystemName": "test10"
}
]
}{
"appStatus": {
"code": "S000",
"message": ""
},
"clientResponsibleTemplateInfo": {
"templateList": [
{
"itemID": "9b9e4a9f-2d99-4195-b136-de0ea63c494e",
"itemType": "text_ruby",
"itemName": "取引先担当者姓",
"requiredFlag": true,
"beforeUnit": null,
"afterUnit": null,
"readOnlyFlag": false,
"selectionValues": null,
"linkageSelectionValues": null
},
{
"itemID": "4e797881-4042-4dd5-beb6-d3f2ba0d9790",
"itemType": "text_ruby",
"itemName": "取引先担当者名",
"requiredFlag": false,
"beforeUnit": null,
"afterUnit": null,
"readOnlyFlag": false,
"selectionValues": null,
"linkageSelectionValues": null
},
{
"itemID": "e8f4b11d-41c4-4c05-afe8-a3c008fa2ce7",
"itemType": "client_single",
"itemName": "取引先",
"requiredFlag": true,
"beforeUnit": null,
"afterUnit": null,
"readOnlyFlag": false,
"selectionValues": null,
"linkageSelectionValues": null
},
{
"itemID": "3f5ba10e-40d2-4b29-85b6-b7e7d1fff077",
"itemType": "text_single",
"itemName": "支社支店・拠点",
"requiredFlag": false,
"beforeUnit": null,
"afterUnit": null,
"readOnlyFlag": false,
"selectionValues": null,
"linkageSelectionValues": null
},
{
"itemID": "5b558456-d616-4d4f-ae93-cae4023a6dd7",
"itemType": "text_single",
"itemName": "部署",
"requiredFlag": false,
"beforeUnit": null,
"afterUnit": null,
"readOnlyFlag": false,
"selectionValues": null,
"linkageSelectionValues": null
},
{
"itemID": "691c9ac2-01e8-4166-81fb-899149fcd416",
"itemType": "text_single",
"itemName": "役職",
"requiredFlag": false,
"beforeUnit": null,
"afterUnit": null,
"readOnlyFlag": false,
"selectionValues": null,
"linkageSelectionValues": null
},
{
"itemID": "0e92f196-21a7-4a5f-ac8d-82dab042f031",
"itemType": "date",
"itemName": "誕生日",
"requiredFlag": false,
"beforeUnit": null,
"afterUnit": null,
"readOnlyFlag": false,
"selectionValues": null,
"linkageSelectionValues": null
},
{
"itemID": "bd2f1841-f095-48f6-b634-35ea90bba0bd",
"itemType": "phone_number",
"itemName": "電話番号1",
"requiredFlag": false,
"beforeUnit": null,
"afterUnit": null,
"readOnlyFlag": false,
"selectionValues": null,
"linkageSelectionValues": null
},
{
"itemID": "d3f1bb48-85c2-49ea-b24d-a3e94e4c2221",
"itemType": "phone_number",
"itemName": "電話番号2",
"requiredFlag": false,
"beforeUnit": null,
"afterUnit": null,
"readOnlyFlag": false,
"selectionValues": null,
"linkageSelectionValues": null
},
{
"itemID": "bcdb231a-14e5-4708-9614-d692cd2245c6",
"itemType": "text_single",
"itemName": "内線番号",
"requiredFlag": false,
"beforeUnit": null,
"afterUnit": null,
"readOnlyFlag": false,
"selectionValues": null,
"linkageSelectionValues": null
},
{
"itemID": "41fe574b-712e-4a29-8dd0-e06607a0e962",
"itemType": "phone_number",
"itemName": "携帯電話番号1",
"requiredFlag": false,
"beforeUnit": null,
"afterUnit": null,
"readOnlyFlag": false,
"selectionValues": null,
"linkageSelectionValues": null
},
{
"itemID": "e543665a-0a0b-4e0a-8212-3ffbe14e1e4f",
"itemType": "phone_number",
"itemName": "携帯電話番号2",
"requiredFlag": false,
"beforeUnit": null,
"afterUnit": null,
"readOnlyFlag": false,
"selectionValues": null,
"linkageSelectionValues": null
},
{
"itemID": "b307ba2b-3cb2-41a5-90ea-6a30d853ef8e",
"itemType": "phone_number",
"itemName": "FAX番号1",
"requiredFlag": false,
"beforeUnit": null,
"afterUnit": null,
"readOnlyFlag": false,
"selectionValues": null,
"linkageSelectionValues": null
},
{
"itemID": "35ecbf82-5b78-43fd-b9b2-71b762fd5d7b",
"itemType": "phone_number",
"itemName": "FAX番号2",
"requiredFlag": false,
"beforeUnit": null,
"afterUnit": null,
"readOnlyFlag": false,
"selectionValues": null,
"linkageSelectionValues": null
},
{
"itemID": "4e881466-88b5-46b3-b398-da99ad6cfb79",
"itemType": "mail_address",
"itemName": "メールアドレス1",
"requiredFlag": false,
"beforeUnit": null,
"afterUnit": null,
"readOnlyFlag": false,
"selectionValues": null,
"linkageSelectionValues": null
},
{
"itemID": "7b9b4c8e-f56c-45a7-93ab-00c7a9e1046e",
"itemType": "mail_address",
"itemName": "メールアドレス2",
"requiredFlag": false,
"beforeUnit": null,
"afterUnit": null,
"readOnlyFlag": false,
"selectionValues": null,
"linkageSelectionValues": null
},
{
"itemID": "f11a121e-3afa-44ce-9972-6e2d90799fb1",
"itemType": "postal_code",
"itemName": "郵便番号",
"requiredFlag": false,
"beforeUnit": null,
"afterUnit": null,
"readOnlyFlag": false,
"selectionValues": null,
"linkageSelectionValues": null
},
{
"itemID": "ba86c3a5-bdb4-483b-88ec-a870f9975ed8",
"itemType": "prefectures",
"itemName": "住所(都道府県)",
"requiredFlag": false,
"beforeUnit": null,
"afterUnit": null,
"readOnlyFlag": false,
"selectionValues": [
{
"label": "北海道",
"displayFlag": true,
"value": 1
},
{
"label": "青森県",
"displayFlag": true,
"value": 2
},
{
"label": "岩手県",
"displayFlag": true,
"value": 3
},
{
"label": "宮城県",
"displayFlag": true,
"value": 4
},
{
"label": "秋田県",
"displayFlag": true,
"value": 5
},
{
"label": "山形県",
"displayFlag": true,
"value": 6
},
{
"label": "福島県",
"displayFlag": true,
"value": 7
},
{
"label": "茨城県",
"displayFlag": true,
"value": 8
},
{
"label": "栃木県",
"displayFlag": true,
"value": 9
},
{
"label": "群馬県",
"displayFlag": true,
"value": 10
},
{
"label": "埼玉県",
"displayFlag": true,
"value": 11
},
{
"label": "千葉県",
"displayFlag": true,
"value": 12
},
{
"label": "東京都",
"displayFlag": true,
"value": 13
},
{
"label": "神奈川県",
"displayFlag": true,
"value": 14
},
{
"label": "山梨県",
"displayFlag": true,
"value": 15
},
{
"label": "長野県",
"displayFlag": true,
"value": 16
},
{
"label": "新潟県",
"displayFlag": true,
"value": 17
},
{
"label": "富山県",
"displayFlag": true,
"value": 18
},
{
"label": "石川県",
"displayFlag": true,
"value": 19
},
{
"label": "福井県",
"displayFlag": true,
"value": 20
},
{
"label": "岐阜県",
"displayFlag": true,
"value": 21
},
{
"label": "静岡県",
"displayFlag": true,
"value": 22
},
{
"label": "愛知県",
"displayFlag": true,
"value": 23
},
{
"label": "三重県",
"displayFlag": true,
"value": 24
},
{
"label": "滋賀県",
"displayFlag": true,
"value": 25
},
{
"label": "京都府",
"displayFlag": true,
"value": 26
},
{
"label": "大阪府",
"displayFlag": true,
"value": 27
},
{
"label": "兵庫県",
"displayFlag": true,
"value": 28
},
{
"label": "奈良県",
"displayFlag": true,
"value": 29
},
{
"label": "和歌山県",
"displayFlag": true,
"value": 30
},
{
"label": "鳥取県",
"displayFlag": true,
"value": 31
},
{
"label": "島根県",
"displayFlag": true,
"value": 32
},
{
"label": "岡山県",
"displayFlag": true,
"value": 33
},
{
"label": "広島県",
"displayFlag": true,
"value": 34
},
{
"label": "山口県",
"displayFlag": true,
"value": 35
},
{
"label": "徳島県",
"displayFlag": true,
"value": 36
},
{
"label": "香川県",
"displayFlag": true,
"value": 37
},
{
"label": "愛媛県",
"displayFlag": true,
"value": 38
},
{
"label": "高知県",
"displayFlag": true,
"value": 39
},
{
"label": "福岡県",
"displayFlag": true,
"value": 40
},
{
"label": "佐賀県",
"displayFlag": true,
"value": 41
},
{
"label": "長崎県",
"displayFlag": true,
"value": 42
},
{
"label": "熊本県",
"displayFlag": true,
"value": 43
},
{
"label": "大分県",
"displayFlag": true,
"value": 44
},
{
"label": "宮崎県",
"displayFlag": true,
"value": 45
},
{
"label": "鹿児島県",
"displayFlag": true,
"value": 46
},
{
"label": "沖縄県",
"displayFlag": true,
"value": 47
}
],
"linkageSelectionValues": null
},
{
"itemID": "9fcc9ed9-586e-4707-8cd5-140d3eca35bc",
"itemType": "text_single",
"itemName": "住所(市区町村以下)",
"requiredFlag": false,
"beforeUnit": null,
"afterUnit": null,
"readOnlyFlag": false,
"selectionValues": null,
"linkageSelectionValues": null
},
{
"itemID": "eaf06a0c-2660-492d-9316-768db327a7be",
"itemType": "text_multiple",
"itemName": "詳細情報",
"requiredFlag": false,
"beforeUnit": null,
"afterUnit": null,
"readOnlyFlag": false,
"selectionValues": null,
"linkageSelectionValues": null
},
{
"itemID": "7e1dbd4d-d146-41e2-ad8d-9905b80ea565",
"itemType": "text_single",
"itemName": "リスト名",
"requiredFlag": false,
"beforeUnit": null,
"afterUnit": null,
"readOnlyFlag": false,
"selectionValues": null,
"linkageSelectionValues": null
},
{
"itemID": "6963b14d-4a63-447a-af29-3f3b62bb4883",
"itemType": "text_single",
"itemName": "メモ",
"requiredFlag": false,
"beforeUnit": null,
"afterUnit": null,
"readOnlyFlag": false,
"selectionValues": null,
"linkageSelectionValues": null
},
{
"itemID": "924aa432-138b-43c0-9f89-091417e84aa3",
"itemType": "text_single",
"itemName": "手書きメモ",
"requiredFlag": false,
"beforeUnit": null,
"afterUnit": null,
"readOnlyFlag": false,
"selectionValues": null,
"linkageSelectionValues": null
},
{
"itemID": "abaf7064-0eba-497c-a907-386a41ec71d3",
"itemType": "datetime",
"itemName": "作成日",
"requiredFlag": false,
"beforeUnit": null,
"afterUnit": null,
"readOnlyFlag": true,
"selectionValues": null,
"linkageSelectionValues": null
},
{
"itemID": "c3fdda6a-9eb5-427b-af55-45037f3889dd",
"itemType": "user_single",
"itemName": "作成者",
"requiredFlag": false,
"beforeUnit": null,
"afterUnit": null,
"readOnlyFlag": true,
"selectionValues": null,
"linkageSelectionValues": null
},
{
"itemID": "b91ed3f4-d0a0-4337-8d25-4117cb823d83",
"itemType": "datetime",
"itemName": "最終更新日",
"requiredFlag": false,
"beforeUnit": null,
"afterUnit": null,
"readOnlyFlag": true,
"selectionValues": null,
"linkageSelectionValues": null
},
{
"itemID": "612017e9-b88e-4ba7-90fe-7322590a6ddc",
"itemType": "user_single",
"itemName": "最終更新者",
"requiredFlag": false,
"beforeUnit": null,
"afterUnit": null,
"readOnlyFlag": true,
"selectionValues": null,
"linkageSelectionValues": null
},
{
"itemID": "a214bb83-f81d-4631-9f1e-7c7efca08521",
"itemType": "division_single",
"itemName": "営業主担当部署",
"requiredFlag": true,
"beforeUnit": null,
"afterUnit": null,
"readOnlyFlag": false,
"selectionValues": null,
"linkageSelectionValues": null
},
{
"itemID": "e9ba034d-e8de-415c-a059-6c5096aa9daf",
"itemType": "user_single",
"itemName": "営業主担当者",
"requiredFlag": true,
"beforeUnit": null,
"afterUnit": null,
"readOnlyFlag": false,
"selectionValues": null,
"linkageSelectionValues": null
},
{
"itemID": "2b939d3d-600b-49e8-af06-8f43d20263c6",
"itemType": "text_single",
"itemName": "1行",
"requiredFlag": false,
"beforeUnit": null,
"afterUnit": null,
"readOnlyFlag": false,
"selectionValues": null,
"linkageSelectionValues": null
},
{
"itemID": "d4e91878-157a-4f96-9ace-60a1867c2bc4",
"itemType": "text_multiple",
"itemName": "複数行",
"requiredFlag": false,
"beforeUnit": null,
"afterUnit": null,
"readOnlyFlag": false,
"selectionValues": null,
"linkageSelectionValues": null
},
{
"itemID": "fd9a744b-dca1-4fd6-84ee-b01ebaa9e3db",
"itemType": "pulldown",
"itemName": "プルダウン",
"requiredFlag": false,
"beforeUnit": null,
"afterUnit": null,
"readOnlyFlag": false,
"selectionValues": [
{
"label": "きょう？",
"displayFlag": true,
"value": 1
},
{
"label": "あした？",
"displayFlag": true,
"value": 2
},
{
"label": "もしかしてあさって？！",
"displayFlag": true,
"value": 3
},
{
"label": "test",
"displayFlag": true,
"value": 4
}
],
"linkageSelectionValues": null
},
{
"itemID": "6f7b8c24-e951-4f00-b587-ebced57c0040",
"itemType": "linkage_pulldown",
"itemName": "連携プルダウン",
"requiredFlag": false,
"beforeUnit": null,
"afterUnit": null,
"readOnlyFlag": false,
"selectionValues": null,
"linkageSelectionValues": [
{
"label": "選択肢1（第一階層）",
"displayFlag": true,
"value": 1,
"children": [
{
"label": "選択肢1（第二階層）",
"displayFlag": true,
"value": 3,
"children": [
{
"label": "選択肢1（第三階層）",
"displayFlag": true,
"value": 5,
"children": []
}
]
},
{
"label": "選択肢2（第二階層）",
"displayFlag": true,
"value": 7,
"children": [
{
"label": "選択肢1（第三階層）",
"displayFlag": true,
"value": 8,
"children": []
}
]
}
]
},
{
"label": "選択肢2（第一階層）",
"displayFlag": true,
"value": 2,
"children": [
{
"label": "選択肢1（第二階層）",
"displayFlag": true,
"value": 4,
"children": [
{
"label": "選択肢1（第三階層）",
"displayFlag": true,
"value": 6,
"children": []
}
]
}
]
}
]
},
{
"itemID": "36bd0557-c72e-4e31-9dcd-9cb569375c11",
"itemType": "checkbox",
"itemName": "チェックボックス",
"requiredFlag": false,
"beforeUnit": null,
"afterUnit": null,
"readOnlyFlag": false,
"selectionValues": [
{
"label": "テスト１",
"displayFlag": true,
"value": 1
},
{
"label": "テスト２",
"displayFlag": true,
"value": 2
},
{
"label": "テスト３",
"displayFlag": true,
"value": 3
},
{
"label": "テスト４",
"displayFlag": true,
"value": 4
}
],
"linkageSelectionValues": null
},
{
"itemID": "afd5de7c-5e24-48e6-8f19-05bc25a65c96",
"itemType": "user_single",
"itemName": "ユーザー選択（単数）",
"requiredFlag": false,
"beforeUnit": null,
"afterUnit": null,
"readOnlyFlag": false,
"selectionValues": null,
"linkageSelectionValues": null
},
{
"itemID": "6c72922a-08dd-4cdd-992e-787cfd9be654",
"itemType": "user_multiple",
"itemName": "ユーザー選択（複数）",
"requiredFlag": false,
"beforeUnit": null,
"afterUnit": null,
"readOnlyFlag": false,
"selectionValues": null,
"linkageSelectionValues": null
},
{
"itemID": "5c0600a3-c482-4273-ab93-20743697260c",
"itemType": "division_single",
"itemName": "部署選択（単数）",
"requiredFlag": false,
"beforeUnit": null,
"afterUnit": null,
"readOnlyFlag": false,
"selectionValues": null,
"linkageSelectionValues": null
},
{
"itemID": "6aeb68cd-727e-482c-bc67-2b0a202508d4",
"itemType": "division_multiple",
"itemName": "部署選択（複数）",
"requiredFlag": false,
"beforeUnit": null,
"afterUnit": null,
"readOnlyFlag": false,
"selectionValues": null,
"linkageSelectionValues": null
},
{
"itemID": "a888094b-c1fb-403c-a7c1-295f704f286a",
"itemType": "datetime",
"itemName": "日付・日時（時間ON）",
"requiredFlag": false,
"beforeUnit": null,
"afterUnit": null,
"readOnlyFlag": false,
"selectionValues": null,
"linkageSelectionValues": null
},
{
"itemID": "84e76c96-a1ca-459e-b8dd-611af8499160",
"itemType": "date",
"itemName": "日付・日時（時間OFF）",
"requiredFlag": false,
"beforeUnit": null,
"afterUnit": null,
"readOnlyFlag": false,
"selectionValues": null,
"linkageSelectionValues": null
},
{
"itemID": "4dcc8d35-6b85-4ab7-a11a-a1d2cd75f6f7",
"itemType": "amount_decimal",
"itemName": "金額（小数ON）",
"requiredFlag": false,
"beforeUnit": "まえ",
"afterUnit": "うしろ",
"readOnlyFlag": false,
"selectionValues": null,
"linkageSelectionValues": null
},
{
"itemID": "7c30a383-d250-4563-9b59-7191310f79d1",
"itemType": "amount_integer",
"itemName": "金額（小数OFF）",
"requiredFlag": false,
"beforeUnit": "まえ",
"afterUnit": "うしろ",
"readOnlyFlag": false,
"selectionValues": null,
"linkageSelectionValues": null
},
{
"itemID": "4540664f-fbca-4d47-9f09-fe1bb1570c1c",
"itemType": "number",
"itemName": "数字",
"requiredFlag": false,
"beforeUnit": null,
"afterUnit": null,
"readOnlyFlag": false,
"selectionValues": null,
"linkageSelectionValues": null
},
{
"itemID": "9410c663-fb00-4f8e-9d22-dbcbe202104a",
"itemType": "phone_number",
"itemName": "電話・FAX番号",
"requiredFlag": false,
"beforeUnit": null,
"afterUnit": null,
"readOnlyFlag": false,
"selectionValues": null,
"linkageSelectionValues": null
},
{
"itemID": "033a3c04-9bd3-4009-b1cd-1fc64bc8d790",
"itemType": "url",
"itemName": "URL",
"requiredFlag": false,
"beforeUnit": null,
"afterUnit": null,
"readOnlyFlag": false,
"selectionValues": null,
"linkageSelectionValues": null
},
{
"itemID": "f552e0b3-2b2a-4730-9859-44c7e52c0d2a",
"itemType": "mail_address",
"itemName": "メールアドレス",
"requiredFlag": false,
"beforeUnit": null,
"afterUnit": null,
"readOnlyFlag": false,
"selectionValues": null,
"linkageSelectionValues": null
},
{
"itemID": "60f33605-f8fb-4f2d-99a5-45bef952ab4c",
"itemType": "postal_code",
"itemName": "郵便番号",
"requiredFlag": false,
"beforeUnit": null,
"afterUnit": null,
"readOnlyFlag": false,
"selectionValues": null,
"linkageSelectionValues": null
},
{
"itemID": "bbbc4619-e7eb-4df0-ae1f-3d5e3c0ad8f8",
"itemType": "prefectures",
"itemName": "都道府県",
"requiredFlag": false,
"beforeUnit": null,
"afterUnit": null,
"readOnlyFlag": false,
"selectionValues": [
{
"label": "北海道",
"displayFlag": true,
"value": 1
},
{
"label": "青森県",
"displayFlag": true,
"value": 2
},
{
"label": "岩手県",
"displayFlag": true,
"value": 3
},
{
"label": "宮城県",
"displayFlag": true,
"value": 4
},
{
"label": "秋田県",
"displayFlag": true,
"value": 5
},
{
"label": "山形県",
"displayFlag": true,
"value": 6
},
{
"label": "福島県",
"displayFlag": true,
"value": 7
},
{
"label": "茨城県",
"displayFlag": true,
"value": 8
},
{
"label": "栃木県",
"displayFlag": true,
"value": 9
},
{
"label": "群馬県",
"displayFlag": true,
"value": 10
},
{
"label": "埼玉県",
"displayFlag": true,
"value": 11
},
{
"label": "千葉県",
"displayFlag": true,
"value": 12
},
{
"label": "東京都",
"displayFlag": true,
"value": 13
},
{
"label": "神奈川県",
"displayFlag": true,
"value": 14
},
{
"label": "新潟県",
"displayFlag": true,
"value": 15
},
{
"label": "富山県",
"displayFlag": true,
"value": 16
},
{
"label": "石川県",
"displayFlag": true,
"value": 17
},
{
"label": "福井県",
"displayFlag": true,
"value": 18
},
{
"label": "山梨県",
"displayFlag": true,
"value": 19
},
{
"label": "長野県",
"displayFlag": true,
"value": 20
},
{
"label": "岐阜県",
"displayFlag": true,
"value": 21
},
{
"label": "静岡県",
"displayFlag": true,
"value": 22
},
{
"label": "愛知県",
"displayFlag": true,
"value": 23
},
{
"label": "三重県",
"displayFlag": true,
"value": 24
},
{
"label": "滋賀県",
"displayFlag": true,
"value": 25
},
{
"label": "京都府",
"displayFlag": true,
"value": 26
},
{
"label": "大阪府",
"displayFlag": true,
"value": 27
},
{
"label": "兵庫県",
"displayFlag": true,
"value": 28
},
{
"label": "奈良県",
"displayFlag": true,
"value": 29
},
{
"label": "和歌山県",
"displayFlag": true,
"value": 30
},
{
"label": "鳥取県",
"displayFlag": true,
"value": 31
},
{
"label": "島根県",
"displayFlag": true,
"value": 32
},
{
"label": "岡山県",
"displayFlag": true,
"value": 33
},
{
"label": "広島県",
"displayFlag": true,
"value": 34
},
{
"label": "山口県",
"displayFlag": true,
"value": 35
},
{
"label": "徳島県",
"displayFlag": true,
"value": 36
},
{
"label": "香川県",
"displayFlag": true,
"value": 37
},
{
"label": "愛媛県",
"displayFlag": true,
"value": 38
},
{
"label": "高知県",
"displayFlag": true,
"value": 39
},
{
"label": "福岡県",
"displayFlag": true,
"value": 40
},
{
"label": "佐賀県",
"displayFlag": true,
"value": 41
},
{
"label": "長崎県",
"displayFlag": true,
"value": 42
},
{
"label": "熊本県",
"displayFlag": true,
"value": 43
},
{
"label": "大分県",
"displayFlag": true,
"value": 44
},
{
"label": "宮崎県",
"displayFlag": true,
"value": 45
},
{
"label": "鹿児島県",
"displayFlag": true,
"value": 46
},
{
"label": "沖縄県",
"displayFlag": true,
"value": 47
}
],
"linkageSelectionValues": null
}
]
},
"systemLinkageSettingInfoList": [
{
"systemLinkageID": 999000001,
"linkageSystemName": "test10"
}
]
}
取引先担当者一覧取得API
| URL | https://（ホスト）/api/crm/get-client-responsible-list |
| Content-Type | application/json |
| HTTPメソッド | POST |
APIの概要
テナント内の取引先担当者データを一覧リストとして取得します。パラメタのオフセットで開始位置を指定して、リミットで取得件数を指定して取得します。オプションで取引先担当者の取引先担当者名など、取引先担当者の基本項目を検索条件として指定して検索して一覧取得も可能です。
リクエストボディ（JSON）
| 必須 | 形式 | 内容 | 補足 | ||||
| param | 〇 | Object | |||||
| requiredConditions | 〇 | Object | 必須条件項目 | 必須で指定必要な項目 | |||
| pagination | 〇 | Object | ページネーション | ||||
| offset | 〇 | Integer | オフセット | 検索の開始位置を0オリジンで指定 | |||
| limit | 〇 | Integer | リミット | レスポンスで返す一覧データの件数を指定（指定可能な値 - 最小:1、最大:100） | |||
| optionalConditions | Object | 任意条件項目 | 任意で指定可能な項目 | ||||
| searchConditions | Object | ||||||
| clientResponsibleFamilyName | String | 検索条件：取引先担当者姓 | 取引先担当者姓で部分一致検索する際に指定 | ||||
| clientResponsibleFirstName | String | 検索条件：取引先担当者名 | 取引先担当者名で部分一致検索する際に指定 | ||||
| prefectures | String[] | 検索条件：都道府県名 | 取引先担当者の都道府県名で検索する際に指定。都道府県名で完全一致検索で、複数指定可能。「神奈川県」など、県名まで指定必要 | ||||
| address | String | 検索条件：住所 | 取引先担当者の住所で部分一致検索する際に指定 | ||||
| salesPersonDepartmentIDList | UUID[] | 検索条件：営業担当部署 | 取引先担当者の営業担当部署で検索する際に指定。対象の部署の組織IDを指定、複数指定可能 | ||||
| salesPersonUserIDList | UUID[] | 検索条件：営業担当者 | 取引先担当者の営業担当者で検索する際に指定。対象の担当者のユーザーIDを指定、複数指定可能 | ||||
| createDateFrom | String | 検索条件：作成日時From | 取引先担当者の作成日時以降で検索する際に指定。 | ||||
| createDateTo | String | 検索条件：作成日時To | 取引先担当者の作成日時以前で検索する際に指定。 | ||||
| updateDateFrom | String | 検索条件：更新日時From | 取引先担当者の更新日時以降で検索する際に指定。 | ||||
| updateDateTo | String | 検索条件：更新日時To | 取引先担当者の更新日時以前で検索する際に指定。 | ||||
リクエスト例(JSON)
{
"param": {
"requiredConditions": {
"pagination": {
"offset": 0, // オフセット
"limit": 10 // リミット
}
},
"optionalConditions": {
"searchConditions": {
"clientResponsibleFamilyName": "手須戸", // 検索条件：取引先担当者姓
"clientResponsibleFirstName": "太朗", // 検索条件：取引先担当者名
"prefectures": [ // 検索条件：都道府県名
"東京都",
"神奈川県"
],
"address": "あいうえお", // 検索条件：住所
"salesPersonDepartmentIDList": [ // 検索条件：営業担当部署
"41573754-0873-4a46-8f54-1cc318dd21a8"
],
"salesPersonUserIDList": [ // 検索条件：営業担当者
"0501b83b-1b21-46f0-b21b-609e276c413e",
"4d62a0df-29c1-49a6-a5df-b3f546b59846",
"a6c837f9-3fc0-4357-94f5-466d9f7ecfa9"
],
"createDateFrom": "2025-01-01T00:00:00Z", // 検索条件：作成日時From
"createDateTo": "2025-12-31T23:59:59Z", // 検索条件：作成日時To
"updateDateFrom": "2025-01-01T00:00:00Z", // 検索条件：更新日時From
"updateDateTo": "2025-12-31T23:59:59Z" // 検索条件：更新日時To
}
}
}
}
レスポンス JSON
| 必須 | 形式 | 内容 | 補足 | ||||
| appStatus | 〇 | Object | API の実行情報 | ||||
| code | 〇 | String | 終了コード | ||||
| message | String | メッセージ | |||||
| clientResponsibleListInfo | 〇 | Object | |||||
| clientResponsibleList | 〇 | Object[] | 取引先担当者一覧のリスト | 取引先担当者一覧のリスト | |||
| clientID | 〇 | UUID | 取引先ID | ||||
| clientResponsibleID | 〇 | UUID | 取引先担当者ID | ||||
| clientResponsibleName | 〇 | String | 取引先担当者名 | ||||
| systemLinkageInfoList | Object[] | システム連携情報リスト | システム連携設定で、連携設定されている場合のみ値が設定され、それ以外の場合はnull | ||||
| systemLinkageID | UUID | システム連携ID | システム連携設定で登録されたシステム連携IDを設定（999000001～999000020の値） | ||||
| linkageIDValue | String | 連携ID値 | 取引先担当者IDに紐づく、連携システム側の顧客担当者IDが登録されている場合、登録値が設定される | ||||
| getMoreFlag | 〇 | Boolean | 追加取得フラグ | 追加で取得できる取引先担当者データが残っているかどうかのフラグ | |||
レスポンス例(JSON)
{
"appStatus": {
"code": "S000",
"message": ""
},
"clientResponsibleListInfo": {
"clientResponsibleList": [
{
"clientID": "7402ce69-57c3-4ea4-8a5d-d5a2765e8b32",
"clientResponsibleID": "c10095c7-1bc4-42be-abc2-c19774b3f238",
"clientResponsibleName": "手須戸 太朗",
"systemLinkageInfoList": [
{
"systemLinkageID": 999000001,
"linkageIDValue": ""
}
]
}
],
"getMoreFlag": true
}
}API 固有の終了コード
| Code | Message | 概要 | 補足（主な原因など） |
| E041 | INVALID_PARAMETER | パラメータ異常 | オフセット、リミットなどの必須項目が指定されていない |
| E199 | REQUEST_FAILURE | その他のエラー |
追加取得フラグについて
レスポンスJSON の getMoreFlag が true である場合、取得最大件数を超えたため返却しきれなかった取引先担当者データが残っている事を示します。本APIを下記のパラメータで実行することで、未取得となっている取引先担当者リストの続きを取得することができます
| パラメータ | 設定内容 | |
| pagination | ||
| offset | 検索の開始位置を0オリジンで指定。今回のAPI実行でのoffset値にlimit値を加算した値を指定 | |
| limit | レスポンスで返す一覧データの件数を指定（指定可能な値 - 最小:1、最大:100） | |
取引先担当者詳細取得API
| URL | https://（ホスト）/api/crm/get-client-responsible-detail |
| Content-Type | application/json |
| HTTPメソッド | POST |
APIの概要
パラメタの取引先担当者IDに対応する取引先担当者の詳細データを取得します。取引先担当者登録・更新または名刺の名寄せで登録された取引先担当者の項目データを詳細データとして取得します。
リクエストボディ（JSON）
| 必須 | 形式 | 内容 | 補足 | ||
| param | 〇 | Object | |||
| clientResponsibleID | 〇(※1) | UUID | 取引先担当者ID | ||
| systemLinkageID | 〇(※1) | Integer | システム連携ID | ||
| linkageIDValue | 〇(※1) | String | 連携ID値 | ||
※1：「clientResponsibleID」と「systemLinkageID、linkageIDValue」はどちらか
リクエスト例(JSON)
{
"param": {
"clientResponsibleID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"systemLinkageID": 999000001,
"linkageIDValue": "string"
}
}
レスポンス JSON
| 必須 | 形式 | 内容 | 補足 | ||||
| appStatus | 〇 | Object | API の実行情報 | ||||
| code | 〇 | String | 終了コード | ||||
| message | String | メッセージ | |||||
| clientResponsibleDetailInfo | 〇 | Object | |||||
| clientID | 〇 | UUID | 取引先ID | ||||
| clientResponsibleItemList | 〇 | Object[] | 取引先詳細項目のリスト | 取引先詳細項目のリスト | |||
| itemID | 〇 | UUID | 取引先担当者項目ID | 項目IDをキーに、取引先担当者テンプレート取得APIの情報と照合する事で、項目のメタデータ（項目名や必須かどうかなど）を取得可能 | |||
| itemType | 〇 | String | 項目タイプ | 項目タイプの設定値および項目タイプの説明については、下記に記載。 項目タイプ値および項目タイプの説明 |
|||
| itemTextData | Object | 文字列型項目の値 | 項目タイプ（itemType）が文字列型の場合にこちらに項目データを設定。文字列型以外の場合は項目未設定。 文字列型の項目タイプ:text_single,text_multiple,date,datetime,phone_number,url,mail_address,postal_code,prefectures,text_ruby |
||||
| value | String | 項目値 | |||||
| ruby | String | フリガナの値 | 項目タイプがtext_rubyの場合に、こちらにフリガナの値が設定される | ||||
| itemNumericData | Object | 数値型項目の値 | 項目タイプ（itemType）が数値型の場合にこちらに項目データを設定。数値型以外の場合は項目未設定。 数値型の項目タイプ:number,amount_integer,amount_decimal |
||||
| value | String | 項目値 | |||||
| itemSelectionData | Object | 選択肢型項目の値 | 項目タイプ（itemType）が選択肢型の場合にこちらに項目データを設定。選択肢型以外の場合は項目未設定。 選択肢型の項目タイプ:pulldown,linkage_pulldown,checkbox |
||||
| values | Integer[] | 項目値リスト | |||||
| itemUuidDataList | Object[] | UUID型項目の値のリスト | 項目タイプ（itemType）がUUID型の場合にこちらに項目データを設定。UUID型以外の場合は項目未設定。 UUID型の項目タイプ:user_single,user_multiple,division_single,division_multiple,client_single,client_multiple,clientresponsible_single,clientresponsible_multiple,product_single,product_multiple |
||||
| itemUuid | UUID | 項目値 | UUIDの項目値（UUID形式のID値）を設定 | ||||
| itemDisplayValue | String | 表示名 | UUIDの項目値に対する表示名を設定。（例：user_singleの項目タイプの表示名の場合、「山田 太郎」などのユーザー名のデータを設定） | ||||
| clientResponsibleInquiryRouteDataList | Object[] | 取引先担当者引合経路リスト | 取引先担当者の引合経路（接触履歴）の情報が登録されている場合にこちらにデータを設定 | ||||
| inquiryRouteCategoryId | UUID | 引合経路カテゴリID | |||||
| inquiryRouteCategoryName | String | 引合経路カテゴリ名 | |||||
| inquiryRouteId | UUID | 引合経路ID | |||||
| inquiryRouteName | String | 引合経路名 | |||||
| systemLinkageInfoList | Object[] | システム連携情報リスト | システム連携設定で、連携設定されている場合のみ値が設定され、それ以外の場合はnull | ||||
| systemLinkageID | Integer | システム連携ID | システム連携設定で登録されたシステム連携IDを設定（999000001～999000020の値） | ||||
| linkageIDValue | String | 連携ID値 | 取引先担当者IDに紐づく、連携システム側の顧客担当者IDが登録されている場合、登録値が設定される | ||||
レスポンス例(JSON)
{
"appStatus": {
"code": "S000",
"message": ""
},
"clientResponsibleDetailInfo": {
"clientID": "7402ce69-57c3-4ea4-8a5d-d5a2765e8b32",
"clientResponsibleItemList": [
{
"itemID": "9b9e4a9f-2d99-4195-b136-de0ea63c494e",
"itemType": "text_ruby",
"itemTextData": {
"value": "手須戸",
"ruby": "てすと"
}
},
{
"itemID": "4e797881-4042-4dd5-beb6-d3f2ba0d9790",
"itemType": "text_ruby",
"itemTextData": {
"value": "太朗",
"ruby": "だろう"
}
},
{
"itemID": "e8f4b11d-41c4-4c05-afe8-a3c008fa2ce7",
"itemType": "client_single",
"itemUuidDataList": [
{
"itemUuid": "7402ce69-57c3-4ea4-8a5d-d5a2765e8b32",
"itemDisplayValue": "KDDI株式会社"
}
]
},
{
"itemID": "3f5ba10e-40d2-4b29-85b6-b7e7d1fff077",
"itemType": "text_single",
"itemTextData": {
"value": "虎ノ門支店",
"ruby": null
}
},
{
"itemID": "5b558456-d616-4d4f-ae93-cae4023a6dd7",
"itemType": "text_single",
"itemTextData": {
"value": "営業推進部",
"ruby": null
}
},
{
"itemID": "691c9ac2-01e8-4166-81fb-899149fcd416",
"itemType": "text_single",
"itemTextData": {
"value": "部長",
"ruby": null
}
},
{
"itemID": "0e92f196-21a7-4a5f-ac8d-82dab042f031",
"itemType": "date",
"itemTextData": {
"value": "1900-01-01",
"ruby": null
}
},
{
"itemID": "bd2f1841-f095-48f6-b634-35ea90bba0bd",
"itemType": "phone_number",
"itemTextData": {
"value": "08012345678",
"ruby": null
}
},
{
"itemID": "d3f1bb48-85c2-49ea-b24d-a3e94e4c2221",
"itemType": "phone_number",
"itemTextData": {
"value": "08012345678",
"ruby": null
}
},
{
"itemID": "bcdb231a-14e5-4708-9614-d692cd2245c6",
"itemType": "text_single",
"itemTextData": {
"value": "あいうえお",
"ruby": null
}
},
{
"itemID": "41fe574b-712e-4a29-8dd0-e06607a0e962",
"itemType": "phone_number",
"itemTextData": {
"value": "08012345678",
"ruby": null
}
},
{
"itemID": "e543665a-0a0b-4e0a-8212-3ffbe14e1e4f",
"itemType": "phone_number",
"itemTextData": {
"value": "08012345678",
"ruby": null
}
},
{
"itemID": "b307ba2b-3cb2-41a5-90ea-6a30d853ef8e",
"itemType": "phone_number",
"itemTextData": {
"value": "08012345678",
"ruby": null
}
},
{
"itemID": "35ecbf82-5b78-43fd-b9b2-71b762fd5d7b",
"itemType": "phone_number",
"itemTextData": {
"value": "08012345678",
"ruby": null
}
},
{
"itemID": "4e881466-88b5-46b3-b398-da99ad6cfb79",
"itemType": "mail_address",
"itemTextData": {
"value": "test@test.test",
"ruby": null
}
},
{
"itemID": "7b9b4c8e-f56c-45a7-93ab-00c7a9e1046e",
"itemType": "mail_address",
"itemTextData": {
"value": "test@test.test",
"ruby": null
}
},
{
"itemID": "f11a121e-3afa-44ce-9972-6e2d90799fb1",
"itemType": "postal_code",
"itemTextData": {
"value": "105-0001",
"ruby": null
}
},
{
"itemID": "ba86c3a5-bdb4-483b-88ec-a870f9975ed8",
"itemType": "prefectures",
"itemTextData": {
"value": "静岡県",
"ruby": null
}
},
{
"itemID": "9fcc9ed9-586e-4707-8cd5-140d3eca35bc",
"itemType": "text_single",
"itemTextData": {
"value": "港区虎ノ門１−２−３",
"ruby": null
}
},
{
"itemID": "eaf06a0c-2660-492d-9316-768db327a7be",
"itemType": "text_multiple",
"itemTextData": {
"value": "あいうえお",
"ruby": null
}
},
{
"itemID": "7e1dbd4d-d146-41e2-ad8d-9905b80ea565",
"itemType": "text_single",
"itemTextData": {
"value": "あいうえお",
"ruby": null
}
},
{
"itemID": "6963b14d-4a63-447a-af29-3f3b62bb4883",
"itemType": "text_single",
"itemTextData": {
"value": "あいうえお",
"ruby": null
}
},
{
"itemID": "924aa432-138b-43c0-9f89-091417e84aa3",
"itemType": "text_single",
"itemTextData": {
"value": "あいうえお",
"ruby": null
}
},
{
"itemID": "abaf7064-0eba-497c-a907-386a41ec71d3",
"itemType": "datetime",
"itemTextData": {
"value": "2025-11-20T10:00:28Z",
"ruby": null
}
},
{
"itemID": "c3fdda6a-9eb5-427b-af55-45037f3889dd",
"itemType": "user_single",
"itemUuidDataList": [
{
"itemUuid": "0501b83b-1b21-46f0-b21b-609e276c413e",
"itemDisplayValue": "手須戸 太朗"
}
]
},
{
"itemID": "b91ed3f4-d0a0-4337-8d25-4117cb823d83",
"itemType": "datetime",
"itemTextData": {
"value": "2025-11-20T10:00:28Z",
"ruby": null
}
},
{
"itemID": "612017e9-b88e-4ba7-90fe-7322590a6ddc",
"itemType": "user_single",
"itemUuidDataList": [
{
"itemUuid": "0501b83b-1b21-46f0-b21b-609e276c413e",
"itemDisplayValue": "手須戸 太朗"
}
]
},
{
"itemID": "a214bb83-f81d-4631-9f1e-7c7efca08521",
"itemType": "division_single",
"itemUuidDataList": [
{
"itemUuid": "41573754-0873-4a46-8f54-1cc318dd21a8",
"itemDisplayValue": "開発"
}
]
},
{
"itemID": "e9ba034d-e8de-415c-a059-6c5096aa9daf",
"itemType": "user_single",
"itemUuidDataList": [
{
"itemUuid": "0501b83b-1b21-46f0-b21b-609e276c413e",
"itemDisplayValue": "手須戸 太朗"
}
]
},
{
"itemID": "2b939d3d-600b-49e8-af06-8f43d20263c6",
"itemType": "text_single",
"itemTextData": {
"value": "あいうえお",
"ruby": null
}
},
{
"itemID": "d4e91878-157a-4f96-9ace-60a1867c2bc4",
"itemType": "text_multiple",
"itemTextData": {
"value": "あいうえお",
"ruby": null
}
},
{
"itemID": "fd9a744b-dca1-4fd6-84ee-b01ebaa9e3db",
"itemType": "pulldown",
"itemSelectionData": {
"values": [
3
]
}
},
{
"itemID": "6f7b8c24-e951-4f00-b587-ebced57c0040",
"itemType": "linkage_pulldown",
"itemSelectionData": {
"values": [
2,
4,
6
]
}
},
{
"itemID": "36bd0557-c72e-4e31-9dcd-9cb569375c11",
"itemType": "checkbox",
"itemSelectionData": {
"values": [
2,
4
]
}
},
{
"itemID": "afd5de7c-5e24-48e6-8f19-05bc25a65c96",
"itemType": "user_single",
"itemUuidDataList": [
{
"itemUuid": "0501b83b-1b21-46f0-b21b-609e276c413e",
"itemDisplayValue": "手須戸 太朗"
}
]
},
{
"itemID": "6c72922a-08dd-4cdd-992e-787cfd9be654",
"itemType": "user_multiple",
"itemUuidDataList": [
{
"itemUuid": "0501b83b-1b21-46f0-b21b-609e276c413e",
"itemDisplayValue": "手須戸 太朗"
},
{
"itemUuid": "4d62a0df-29c1-49a6-a5df-b3f546b59846",
"itemDisplayValue": "手須戸 花子"
},
{
"itemUuid": "a6c837f9-3fc0-4357-94f5-466d9f7ecfa9",
"itemDisplayValue": "手須戸 二郎"
}
]
},
{
"itemID": "5c0600a3-c482-4273-ab93-20743697260c",
"itemType": "division_single",
"itemUuidDataList": [
{
"itemUuid": "41573754-0873-4a46-8f54-1cc318dd21a8",
"itemDisplayValue": "開発"
}
]
},
{
"itemID": "6aeb68cd-727e-482c-bc67-2b0a202508d4",
"itemType": "division_multiple",
"itemUuidDataList": [
{
"itemUuid": "1a493c22-c031-4952-9ed7-ca3823f91114",
"itemDisplayValue": "営業"
},
{
"itemUuid": "41573754-0873-4a46-8f54-1cc318dd21a8",
"itemDisplayValue": "開発"
},
{
"itemUuid": "be5a42cd-9f28-465f-81a3-b763d74a2300",
"itemDisplayValue": "サポート"
}
]
},
{
"itemID": "a888094b-c1fb-403c-a7c1-295f704f286a",
"itemType": "datetime",
"itemTextData": {
"value": "2025-11-17T10:04:00Z",
"ruby": null
}
},
{
"itemID": "84e76c96-a1ca-459e-b8dd-611af8499160",
"itemType": "date",
"itemTextData": {
"value": "2025-11-20",
"ruby": null
}
},
{
"itemID": "4dcc8d35-6b85-4ab7-a11a-a1d2cd75f6f7",
"itemType": "amount_decimal",
"itemNumericData": {
"value": "999999999999999.99"
}
},
{
"itemID": "7c30a383-d250-4563-9b59-7191310f79d1",
"itemType": "amount_integer",
"itemNumericData": {
"value": "999999999999999"
}
},
{
"itemID": "4540664f-fbca-4d47-9f09-fe1bb1570c1c",
"itemType": "number",
"itemNumericData": {
"value": "999999999"
}
},
{
"itemID": "9410c663-fb00-4f8e-9d22-dbcbe202104a",
"itemType": "phone_number",
"itemTextData": {
"value": "+8180-1234-5678",
"ruby": null
}
},
{
"itemID": "033a3c04-9bd3-4009-b1cd-1fc64bc8d790",
"itemType": "url",
"itemTextData": {
"value": "http://abcdefg.com",
"ruby": null
}
},
{
"itemID": "f552e0b3-2b2a-4730-9859-44c7e52c0d2a",
"itemType": "mail_address",
"itemTextData": {
"value": "test@test.test",
"ruby": null
}
},
{
"itemID": "60f33605-f8fb-4f2d-99a5-45bef952ab4c",
"itemType": "postal_code",
"itemTextData": {
"value": "105-0001",
"ruby": null
}
},
{
"itemID": "bbbc4619-e7eb-4df0-ae1f-3d5e3c0ad8f8",
"itemType": "prefectures",
"itemTextData": {
"value": "東京都",
"ruby": null
}
}
],
"clientResponsibleInquiryRouteDataList": [],
"systemLinkageInfoList": [
{
"systemLinkageID": 999000001,
"linkageIDValue": "test10"
}
]
}
}
API 固有の終了コード
| Code | Message | 概要 | 補足（主な原因など） |
| E041 | INVALID_PARAMETER | パラメータ異常 | 取引先担当者IDなどの必須項目が指定されていない |
| E051 | NOT_EXIST_DATA | 存在しないデータ | 取引先担当者IDに対応する取引先担当者データが存在しない |
| E199 | REQUEST_FAILURE | その他のエラー |
取引先担当者名刺一覧取得API
| URL | https://（ホスト）/api/crm/get-client-responsible-businesscard-list |
| Content-Type | application/json |
| HTTPメソッド | POST |
APIの概要
パラメタの取引先担当者IDに紐づく取引先担当者の名刺データを一覧リストとして取得します。パラメタのオフセットで開始位置を指定して、リミットで取得件数を指定して取得します。
リクエストボディ（JSON）
| 必須 | 形式 | 内容 | 補足 | ||||
| param | 〇 | Object | |||||
| conditions | 〇 | Object | 必須条件項目 | 必須で指定必要な項目 | |||
| clientResponsibleID | 〇(※1) | UUID | 取引先担当者ID | ||||
| systemLinkageID | 〇(※1) | Integer | システム連携ID | ||||
| linkageIDValue | 〇(※1) | String | 連携ID値 | ||||
| pagination | 〇 | Object | ページネーション | ||||
| offset | 〇 | Integer | オフセット | 検索の開始位置を0オリジンで指定 | |||
| limit | 〇 | Integer | リミット | レスポンスで返す一覧データの件数を指定（指定可能な値 - 最小:1、最大:100） | |||
※1：「clientResponsibleID」と「systemLinkageID、linkageIDValue」はどちらか
リクエスト例(JSON)
{
"param": {
"conditions": {
"clientResponsibleID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"systemLinkageID": 999000001,
"linkageIDValue": "string",
"pagination": {
"offset": 0,
"limit": 10
}
}
}
}
レスポンス JSON
| 必須 | 形式 | 内容 | 補足 | ||||
| appStatus | 〇 | Object | API の実行情報 | ||||
| code | 〇 | String | 終了コード | ||||
| message | String | メッセージ | |||||
| clientResponsibleBusinesscardListInfo | 〇 | Object | |||||
| businessCardList | 〇 | Object[] | 取引先担当者名刺のリスト | 取引先担当者名刺のリスト | |||
| cardID | 〇 | UUID | 名刺ID | ||||
| departmentName | String | 所属部署 | |||||
| titleName | String | 役職 | |||||
| personNameLast | String | 姓 | |||||
| personNameFirst | String | 名 | |||||
| cardMetaInfo | Object | 名刺メタ情報 | |||||
| cardOwnerUserID | UUID | 営業担当者ID | |||||
| cardOwnerName | String | 営業担当者名 | |||||
| cardOwnerDeleteFlag | Boolean | 営業担当者削除フラグ | |||||
| sentDate | String | 取込日時 | |||||
| cardExchangeDate | String | 名刺交換日 | |||||
| inquiryRouteID | UUID | 引合経路ID | |||||
| inquiryRouteName | String | 引合経路名 | |||||
| getMoreFlag | 〇 | Boolean | 追加取得フラグ | 追加で取得できる取引先担当者名刺データが残っているかどうかのフラグ | |||
レスポンス例(JSON)
{
"clientResponsibleBusinesscardListInfo": {
"businessCardList": [
{
"cardID": "f159b73e-e9c6-4dce-9609-2274bb1f8396",
"departmentName": "string",
"titleName": "string",
"personNameLast": "string",
"personNameFirst": "string",
"cardMetaInfo": {
"cardOwnerUserID": "7aa0afca-6351-4ce5-bb66-3772f0ffde43",
"cardOwnerName": "string",
"cardOwnerDeleteFlag": true,
"sentDate": "2019-08-24T14:15:22Z",
"cardExchangeDate": "2019-08-24T14:15:22Z",
"inquiryRouteID": "4cedfc5b-c5cd-4a22-9402-3ab2b841346f",
"inquiryRouteName": "string"
}
}
],
"getMoreFlag": true
},
"appStatus": {
"code": "S000",
"message": ""
}
}
API 固有の終了コード
| Code | Message | 概要 | 補足（主な原因など） |
| E041 | INVALID_PARAMETER | パラメータ異常 | 取引先担当者ID、オフセット、リミットなどの必須項目が指定されていない |
| E199 | REQUEST_FAILURE | その他のエラー |
追加取得フラグについて
レスポンスJSON の getMoreFlag が true である場合、取得最大件数を超えたため返却しきれなかった取引先担当者名刺データが残っている事を示します。本APIを下記のパラメータで実行することで、未取得となっている取引先担当者名刺リストの続きを取得することができます。
| パラメータ | 設定内容 | |
| pagination | ||
| offset | 検索の開始位置を0オリジンで指定。今回のAPI実行でのoffset値にlimit値を加算した値を指定 | |
| limit | レスポンスで返す一覧データの件数を指定（指定可能な値 - 最小:1、最大:100） | |
組織一覧取得API
| URL | https://（ホスト）/api/organization/get-organization-list |
| Content-Type | application/json |
| HTTPメソッド | POST |
APIの概要
テナントで登録されている組織データを一覧リストとして取得します。パラメタのオフセットで開始位置を指定して、リミットで取得件数を指定して取得します。※本APIでは、リクエスト／レスポンスの**キー名は先頭大文字**です。
リクエストボディ（JSON）
| 必須 | 形式 | 内容 | 補足 | ||||
| Param | 〇 | Object | |||||
| Options | 〇 | Object | 任意条件項目 | 任意で指定必要な項目 | |||
| Pagination | 〇 | Object | ページネーション | ||||
| Offset | 〇 | Integer | オフセット | 検索の開始位置を0オリジンで指定 | |||
| Limit | 〇 | Integer | リミット | レスポンスで返す一覧データの件数を指定（指定可能な値 - 最小:1、最大:100） | |||
リクエスト例(JSON)
{
"Param": {
"Options": {
"Pagination": {
"Offset": 0, // オフセット
"Limit": 10 // リミット
}
}
}
}
レスポンス JSON
| 必須 | 形式 | 内容 | 補足 | |||
| AppStatus | 〇 | Object | API の実行情報 | |||
| Code | 〇 | String | 終了コード | |||
| Message | String | メッセージ | ||||
| OrganizationListInfo | 〇 | Object | ||||
| OrganizationList | 〇 | Object[] | 組織情報のリスト | 組織情報のリスト | ||
| OrganizationID | 〇 | UUID | 組織ID | |||
| OrganizationName | 〇 | String | 組織名 | |||
| GetMoreFlag | 〇 | Boolean | 追加取得フラグ | 追加で取得できる組織データが残っているかどうかのフラグ | ||
レスポンス例(JSON)
{
"OrganizationListInfo": {
"OrganizationList": [
{
"OrganizationID": "d548cfe5-6da2-43e3-b12f-6f7b59780172",
"OrganizationName": "先進技術開発部"
}
],
"GetMoreFlag": true
},
"AppStatus": {
"Code": "S000",
"Message": "ok"
}
}
API 固有の終了コード
| Code | Message | 概要 | 補足（主な原因など） |
| E041 | INVALID_PARAMETER | パラメータ異常 | オフセット、リミットが数値形式でない |
| E199 | REQUEST_FAILURE | その他のエラー |
追加取得フラグについて
レスポンスJSON のGetMoreFlag が true である場合、取得最大件数を超えたため返却しきれなかった組織データが残っている事を示します。本APIを下記のパラメータで実行することで、未取得となっている組織情報リストの続きを取得することができます。
| パラメータ | 設定内容 | |
| pagination | ||
| offset | 検索の開始位置を0オリジンで指定。今回のAPI実行でのoffset値にlimit値を加算した値を指定 | |
| limit | レスポンスで返す一覧データの件数を指定（指定可能な値 - 最小:1、最大:100） | |
ユーザー一覧取得API
| URL | https://（ホスト）/api/organization/get-user-list |
| Content-Type | application/json |
| HTTPメソッド | POST |
APIの概要
テナントで登録されているユーザーデータを一覧リストとして取得します。パラメタのオフセットで開始位置を指定して、リミットで取得件数を指定して取得します。※本APIでは、リクエスト／レスポンスの**キー名は先頭大文字**です。
リクエストボディ（JSON）
| 必須 | 形式 | 内容 | 補足 | ||||
| Param | 〇 | Object | |||||
| Options | 〇 | Object | 任意条件項目 | 任意で指定必要な項目 | |||
| Pagination | 〇 | Object | ページネーション | ||||
| Offset | 〇 | Integer | オフセット | 検索の開始位置を0オリジンで指定 | |||
| Limit | 〇 | Integer | リミット | レスポンスで返す一覧データの件数を指定（指定可能な値 - 最小:1、最大:100） | |||
| SearchKeyword | String[] | 検索キーワード | 検索キーワードを指定して絞込みをする場合にキーワードを配列で指定 | ||||
| OrganizationID | UUID | 組織ID | 組織IDを指定して絞込みをする場合に指定 | ||||
リクエスト例(JSON)
{
"Param": {
"Options": {
"Pagination": {
"Offset": 0, // オフセット
"Limit": 10 // リミット
},
"SearchKeyword": [
"bluetec" // 検索キーワード
],
"OrganizationID": "41573754-0873-4a46-8f54-1cc318dd21a8" // 組織ID
}
}
}
レスポンス JSON
| 必須 | 形式 | 内容 | 補足 | |||
| AppStatus | 〇 | Object | API の実行情報 | |||
| Code | 〇 | String | 終了コード | |||
| Message | String | メッセージ | ||||
| UserListInfo | 〇 | Object | ||||
| UserList | 〇 | Object[] | ユーザー情報のリスト | ユーザー情報のリスト | ||
| UserID | 〇 | UUID | ユーザーID | |||
| LoginID | 〇 | String | ログインID | |||
| UserViewName | 〇 | String | ユーザー表示名 | |||
| UserFamilyName | 〇 | String | ユーザー姓 | |||
| UserFirstName | 〇 | String | ユーザー名 | |||
| UserMiddleName | String | ユーザーミドルネーム | ||||
| UserMailAddress | 〇 | String | メールアドレス | |||
| UserDepartment | String | 部門 | ||||
| UserBusinessUnit | String | 事業部 | ||||
| UserStaffID | String | 社員ID | ||||
| UserExtension | String | 内線 | ||||
| UserMobilePhone | String | 携帯電話番号 | ||||
| UserTitle | String | 役職 | ||||
| UserCompanyPhone | String | 会社電話番号 | ||||
| UserRole | 〇 | String | 権限 | |||
| GetMoreFlag | 〇 | Boolean | 追加取得フラグ | 追加で取得できるユーザーデータが残っているかどうかのフラグ | ||
レスポンス例(JSON)
{
"UserListInfo": {
"UserList": [
{
"UserID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"LoginID": "yamada.taro",
"UserViewName": "石見 太郎",
"UserFamilyName": "石見",
"UserFirstName": "太郎",
"UserMiddleName": "",
"UserMailAddress": "ishimi.taro@example.com",
"UserDepartment": "営業部",
"UserBusinessUnit": "首都圏営業本部",
"UserStaffID": "EMP00123",
"UserExtension": "3210",
"UserMobilePhone": "080-1234-5678",
"UserTitle": "営業主任",
"UserCompanyPhone": "03-1234-5678",
"UserRole": "Sales"
},
{
"UserID": "ab0c12de-4567-89ef-abcd-1234567890ab",
"LoginID": "ishimi.hanako",
"UserViewName": "石見 花子",
"UserFamilyName": "石見",
"UserFirstName": "花子",
"UserMiddleName": "",
"UserMailAddress": "ishimi.hanako@example.com",
"UserDepartment": "開発部",
"UserBusinessUnit": "プロダクト開発部門",
"UserStaffID": "EMP00456",
"UserExtension": "4521",
"UserMobilePhone": "090-9876-5432",
"UserTitle": "エンジニア",
"UserCompanyPhone": "03-9876-5432",
"UserRole": "Developer"
}
],
"GetMoreFlag": false
},
"AppStatus": {
"Code": "S000",
"Message": "ok"
}
}
API 固有の終了コード
| Code | Message | 概要 | 補足（主な原因など） |
| E041 | INVALID_PARAMETER | パラメータ異常 | オフセット、リミットが数値形式でない |
| E199 | REQUEST_FAILURE | その他のエラー |
追加取得フラグについて
レスポンスJSON のGetMoreFlag が true である場合、取得最大件数を超えたため返却しきれなかったユーザーデータが残っている事を示します。本APIを下記のパラメータで実行することで、未取得となっているユーザー情報リストの続きを取得することができます。
| パラメータ | 設定内容 | |
| pagination | ||
| offset | 検索の開始位置を0オリジンで指定。今回のAPI実行でのoffset値にlimit値を加算した値を指定 | |
| limit | レスポンスで返す一覧データの件数を指定（指定可能な値 - 最小:1、最大:100） | |
ROBOTID OpenIdConnect API仕様
1. 認可エンドポイント
概要
クライアント情報をもとにユーザーの認証・認可を行うエンドポイント。
リクエストURL
https://[ROBOTIDドメイン]/oidc-auth/authorize
（商用環境の場合のURL）https://robotid.jp/oidc-auth/authorize
リクエストHTTPメソッド
GET
リクエストパラメタ
| パラメタ名 | 必須 | 説明 |
| client_id | ○ | OpenId管理コンソールのクライアント情報登録で登録したクライアントID |
| redirect_uri | ○ | 認可処理完了後に、認可コードをリダイレクトするためのURI OpenId管理コンソールのクライアント情報登録で登録した承認済みリダイレクトURIを指定 |
| response_type | ○ | 認可フロータイプ "code"を固定で指定（Authorization Code Flow） |
| scope | ○ | 要求するアクセス権限を表すスコープID 複数指定する場合は半角スペース区切りで指定 指定可能なスコープIDおよびスコープの詳細については、「OpenIdConnect スコープ仕様に記載 |
| state | CSRF対策として同一のセッションである事を確認するために使用するパラメータ 同パラメタが指定された場合に、レスポンスにstateパラメタを含め、値としてリクエストで受け取ったstate値と同じ値を設定して返却 |
|
| nonce | リプレイアタック攻撃に対する対策を実施するために使用するパラメタ リクエストで同パラメタが指定された場合に、IDトークンにリクエストで送られてきたnonce値と同じ値を設定する。クライアント側でIDトークンに含まれるnonce値と認可リクエスト時に送信したnonce値が同一かを検証する事でリプレイアタック攻撃を防止する |
リクエスト具体例
GET /oidc-auth/authorize?
client_id=client_sample
&redirect_uri=https://example.com/home
&response_type=code
&scope=ks3_user_tenant%20address%20phone%20openid%20profile%20offline_access
&state=bd83xwghJW
&nonce=roWfwEbRU0G8HO0WpuR7R2GTCE5uru
HTTP/1.1
Host: robotid.jp
レスポンス形式
リダイレクト
レスポンスデータ
| パラメタ名 | 必須 | 説明 |
| code | ○ | アクセストークン発行時に使用する認可コード |
| state | リクエストでstateパラメタが指定された場合に、値としてリクエストで受け取ったstate値と同じ値を設定して返却 |
レスポンス具体例
HTTP/1.1 302 Found
Location: https://example.com/home?
code=teqRmyiGXkSqb0Hbjpqnnz
&state=bd83xwghJW
2. トークンエンドポイント（トークン新規発行）
概要
アクセストークン・リフレッシュトークンの新規発行を行いたい場合に、リクエストパラメタに認可コードの識別子および認可コードを指定し、トークンエンドポイントにリクエストを行ってトークンの新規発行をする
リクエストURL
https://[ROBOTIDドメイン]/oidc-auth/token
（商用環境の場合のURL）https://robotid.jp/oidc-auth/token
リクエストHTTPメソッド
POST
リクエストヘッダ
| ヘッダ名 | 必須 | 説明 |
| Authorization | △※1 | クライアント認証用のBasic認証値 値としてOpenId管理コンソールのクライアント情報登録で登録したクライアント情報（IDとシークレット）をBase64エンコードしたものを指定する （指定例）Authorization: Basic XXXXX ※ XXXXXの箇所にクライアントIDとシークレットを":"(コロン)で連結してBase64エンコードした値を指定 |
リクエストボディ
| パラメタ名 | 必須 | 説明 |
| grant_type | ○ | "authorization_code"を固定で設定 |
| code | ○ | 認可エンドポイントのリクエストで取得した認可コードを指定 |
| redirect_uri | ○ | トークン発行処理完了後に、トークンをリダイレクトするためのURI OpenId管理コンソールのクライアント情報登録で登録した承認済みリダイレクトURIを指定 |
| client_id | △※1 | OpenId管理コンソールのクライアント情報登録で登録したクライアントID クライアント認証で使用 |
| client_secret | △※1 | OpenId管理コンソールのクライアント情報登録で登録したクライアントシークレット クライアント認証で使用 |
※1：リクエスト時にクライアント認証を行うため、ヘッダのAuthorization設定、もしくはリクエストボディのclient_id,client_secretのいずれかが必須となる。いずれかが設定されている場合はもう一方のほうは設定不要
リクエスト具体例
POST /oidc-auth/token HTTP/1.1
Host: robotid.jp
Content-Type: application/x-www-form-urlencoded
grant_type=authorization_code
&code=teqRmyiGXkSqb0Hbjpqnnz
&redirect_uri=https://example.com/home
&client_id=client_sample
&client_secret=L3bukGfVnG_AlAGs3gHmVti1tXppcnMjYjpv_kqG0OBvy8b0GY
レスポンス形式
JSON
レスポンスデータ
| パラメタ名 | 必須 | 説明 |
| access_token | ○ | アクセストークン 外部連携APIを実行する際の認証で使用 |
| token_type | ○ | 発行されたトークンタイプ Bearer固定 |
| refresh_token | アクセストークン再発行時に使用するリフレッシュトークン 同トークンが必要な場合、認可リクエスト時のスコープで"offline_access"を指定する必要がある |
|
| expires_in | ○ | アクセストークンの有効期限（秒単位） |
| scope | ○ | アクセストークンに紐づくスコープ スコープが複数ある場合は半角スペース区切りでスコープを返却 |
| id_token | IDトークン OpenIdConnectで認証した際に付与される、個人を識別可能なトークン |
レスポンス具体例
HTTP/1.1 200 OK
cache-control: no-store
pragma: no-cache
content-type: application/json;charset=UTF-8
{
"access_token": "3L5qQWVP0J",
"token_type": "Bearer",
"refresh_token": "cr2R5fEf2y",
"expires_in": 3599,
"scope": "ks3_user_tenant address phone openid offline_access profile",
"id_token": "KoFFk1gEaxjc6b0cTTa2yAwgpoIuYR"
}
3.トークンエンドポイント（アクセストークン再発行）
概要
アクセストークンの再発行（リフレッシュ）を行いたい場合に、リクエストパラメタに再発行の識別子およびリフレッシュトークンを指定し、トークンエンドポイントにリクエストを行って再発行する。
リクエストURL
https://[ROBOTIDドメイン]/oidc-auth/token
（商用環境の場合のURL）https://robotid.jp/oidc-auth/token
リクエストHTTPメソッド
POST
リクエストヘッダ
| ヘッダ名 | 必須 | 説明 |
| Authorization | △※1 | クライアント認証用のBasic認証値 値としてOpenId管理コンソールのクライアント情報登録で登録したクライアント情報（IDとシークレット）をBase64エンコードしたものを指定する （指定例）Authorization: Basic XXXXX ※ XXXXXの箇所にクライアントIDとシークレットを":"(コロン)で連結してBase64エンコードした値を指定 |
リクエストボディ
| パラメタ名 | 必須 | 説明 |
| grant_type | ○ | "refresh_token"を固定で設定 |
| refresh_token | ○ | トークン新規発行リクエストで取得したリフレッシュトークンを指定 |
| client_id | △※1 | OpenId管理コンソールのクライアント情報登録で登録したクライアントID クライアント認証で使用 |
| client_secret | △※1 | OpenId管理コンソールのクライアント情報登録で登録したクライアントシークレット クライアント認証で使用 |
※1：リクエスト時にクライアント認証を行うため、ヘッダのAuthorization設定、もしくはリクエストボディのclient_id,client_secretのいずれかが必須となる。いずれかが設定されている場合はもう一方のほうは設定不要。
リクエスト具体例
POST /oidc-auth/token HTTP/1.1
Host: robotid.jp
Content-Type: application/x-www-form-urlencoded
grant_type=refresh_token
&refresh_token=cr2R5fEf2y
&client_id=client_sample
&client_secret=L3bukGfVnG_AlAGs3gHmVti1tXppcnMjYjpv_kqG0OBvy8b0GY
レスポンス形式
JSON
レスポンスデータ
トークンエンドポイント（トークン新規発行）と同様
4.トークン無効化エンドポイント]
概要
アクセストークンまたはリフレッシュトークンの無効化を行いたい場合に、リクエストパラメタにトークンを指定し、
トークン無効化エンドポイントにリクエストを行ってトークンを無効化する
リクエストURL
https://[ROBOTIDドメイン]/oidc-auth/revoke
（商用環境の場合のURL）https://robotid.jp/oidc-auth/revoke
リクエストHTTPメソッド
POST
リクエストヘッダ
| ヘッダ名 | 必須 | 説明 |
| Authorization | △※1 | クライアント認証用のBasic認証値 値としてOpenId管理コンソールのクライアント情報登録で登録したクライアント情報（IDとシークレット）をBase64エンコードしたものを指定する （指定例）Authorization: Basic XXXXX ※ XXXXXの箇所にクライアントIDとシークレットを":"(コロン)で連結してBase64エンコードした値を指定 |
リクエストボディ
| パラメタ名 | 必須 | 説明 |
| token | ○ | 無効化したいアクセストークンまたは無効化したいリフレッシュトークンを指定 |
| client_id | △※1 | OpenId管理コンソールのクライアント情報登録で登録したクライアントID クライアント認証で使用 |
| client_secret | △※1 | OpenId管理コンソールのクライアント情報登録で登録したクライアントシークレット クライアント認証で使用 |
※1：リクエスト時にクライアント認証を行うため、ヘッダのAuthorization設定、もしくはリクエストボディのclient_id,client_secretのいずれかが必須となる。いずれかが設定されている場合はもう一方のほうは設定不要。
リクエスト具体例
POST /oidc-auth/revoke HTTP/1.1
Host: robotid.jp
Content-Type: application/x-www-form-urlencoded
token=3L5qQWVP0J
&client_id=client_sample
&client_secret=L3bukGfVnG_AlAGs3gHmVti1tXppcnMjYjpv_kqG0OBvy8b0GY
レスポンスデータ
HTTPステータスコード（正常終了時：200(OK)、エラー時：403(Forbidden)）のみ返却
レスポンス具体例
HTTP/1.1 200 OK
cache-control: no-store
pragma: no-cache
5.ユーザー情報エンドポイント
概要
トークンポイントのリクエストで取得したアクセストークンをもとに、ユーザー情報を取得するためのエンドポイント
リクエストURL
https://[ROBOTIDドメイン]/oidc-auth/userinfo
（商用環境の場合のURL）https://robotid.jp/oidc-auth/userinfo
リクエストHTTPメソッド
GET
リクエストヘッダ
| ヘッダ名 | 必須 | 説明 |
| Authorization | ○ | トークンポイントのリクエストで取得したアクセストークンを値として設定して認証 （指定例）Authorization: Bearer XXXXX ※ XXXXXの箇所にアクセストークンを指定 |
リクエスト具体例
GET /oidc-auth/userinfo HTTP/1.1
Host: robotid.jp
Authorization: Bearer 3L5qQWVP0J
レスポンス形式
JSON
レスポンスデータ
| パラメタ名 | 必須 | 説明 |
| sub | アカウントのログインID アクセストークンに紐づくスコープに"openid"が存在する場合に同情報を返却 |
|
| name | アカウントの姓＋名 アクセストークンに紐づくスコープに"profile"が存在する場合に同情報を返却 |
|
| given_name | アカウントの名 アクセストークンに紐づくスコープに"profile"が存在する場合に同情報を返却 |
|
| family_name | アカウントの姓 アクセストークンに紐づくスコープに"profile"が存在する場合に同情報を返却 |
|
| middle_name | アカウントのミドルネーム アクセストークンに紐づくスコープに"profile"が存在する場合に同情報を返却 |
|
| アカウントのメールアドレス アクセストークンに紐づくスコープに"email"が存在する場合に同情報を返却 |
||
| phone_number | アカウントの電話番号 アクセストークンに紐づくスコープに"phone"が存在する場合に同情報を返却 |
|
| address | トークン発行時のクライアントが所属する企業の住所（都道府県＋市区町村＋番地・建物名） アクセストークンに紐づくスコープに"address"が存在する場合に同情報を返却 |
|
| ks3_custom_attribute | トークン発行時のクライアントが所属する企業のカスタム属性について、配列形式（配列の中身はカスタム属性の名前・値を設定したJSON）で設定 アクセストークンに紐づくスコープに"ks3_custom_attribute"が存在する場合に同情報を返却 |
|
| ks3_tenant_id | トークン発行時のクライアントが所属する企業の企業UID アクセストークンに紐づくスコープに"ks3_user_tenant"が存在する場合に同情報を返却 |
|
| ks3_tenant_name | トークン発行時のクライアントが所属する企業の企業名 アクセストークンに紐づくスコープに"ks3_user_tenant"が存在する場合に同情報を返却 |
|
| ks3_tenant_phone | トークン発行時のクライアントが所属する企業の電話番号 アクセストークンに紐づくスコープに"ks3_user_tenant"が存在する場合に同情報を返却 |
|
| ks3_tenant_email | トークン発行時のクライアントが所属する企業のメールアドレス アクセストークンに紐づくスコープに"ks3_user_tenant"が存在する場合に同情報を返却 |
※各スコープの詳細については、「OpenIdConnect スコープ仕様」に記載
レスポンス具体例
HTTP/1.1 200 OK
cache-control: no-store
pragma: no-cache
content-type: application/json;charset=UTF-8
{
"sub": "yamadatest",
"address": "東京都港区1-2-3テストビル5F",
"ks3_tenant_name": "ABC株式会社",
"ks3_tenant_phone": "0312345678",
"name": "太郎 山田",
"ks3_custom_attribute": [
{
"value": "yamada001@example.co.jp",
"key": "サンプルサイト用メールアドレス"
},
{
"value": "1",
"key": "サンプルサイトユーザー権限"
}
],
"given_name": "太郎",
"middle_name": "",
"family_name": "山田",
"email": "tarou.yamada@example.co.jp",
"ks3_tenant_id": "ro7jrw"
}
ROBOTID OpenIdConnect スコープ仕様
概要
スコープとして、大きく以下の3種類を登録・使用可能とする。
①システムスコープ（デフォルト）
OpenIDConnectの仕様で定義されているスコープ。デフォルトでDBに登録しておき、ユーザが使用可能にする。
②システムスコープ（ユーザ定義）
システムスコープについて、ユーザが独自にスコープを登録・編集可能とする。
③APIスコープ
ユーザが利用するAPIのスコープ。システム管理者がスコープを管理画面上から登録。ユーザは管理画面上からAPIの有効設定をする事により利用可能となる。
デフォルトのシステムスコープ一覧
RobotID OpenIdConnectにデフォルトで登録されているシステムスコープは以下の通り。
| パラメタ名 | 表示名 | 説明 |
| openid | OpenID | OpenID Connectの要求スコープ。指定無しの場合もエラーとはしないが、指定無しの場合、IDトークンを返却しない |
| profile | プロフィール | ・認可リクエストで同スコープが指定された場合、アクセストークンでユーザのプロフィール情報の取得を可能とする。 ・同スコープ権限を持つアクセストークンにて、ユーザ情報取得要求がRobotIDにあった場合、アカウント情報のプロフィール（姓、名、ミドルネーム、タイムゾーン）を返却 |
| ・認可リクエストで同スコープが指定された場合、アクセストークンでユーザのe-mail情報の取得を可能とする。 ・同スコープ権限を持つアクセストークンにて、ユーザ情報取得要求がRobotIDにあった場合、アカウント情報のe-mail情報（メールアドレス、通知用メールアドレス）を返却 |
||
| address | 住所 | ・認可リクエストで同スコープが指定された場合、アクセストークンでユーザの住所情報の取得を可能とする。 ・同スコープ権限を持つアクセストークンにて、ユーザ情報取得要求がRobotIDにあった場合、企業情報の住所情報（国、郵便番号、都道府県、市区郡、町名・番地・建物名）を返却 |
| phone | 電話番号 | ・認可リクエストで同スコープが指定された場合、アクセストークンでユーザの電話番号情報の取得を可能とする。 ・同スコープ権限を持つアクセストークンにて、ユーザ情報取得要求がRobotIDにあった場合、アカウント情報の電話番号情報（会社電話番号、携帯電話番号）を返却 |
| offline_access | オフラインアクセス | ユーザがオフライン（RobotIDに未ログイン）の状態でもアクセストークンの再発行・トークン利用によるAPIアクセスを可能にするスコープ。 具体的にはリフレッシュトークンを発行する事によりユーザにオフライン状態でのアクセストークン再発行を可能にさせる。同スコープが指定された場合、RobotIDは以下の挙動とする。 ・同スコープが認可リクエストで指定された場合にリフレッシュトークンを発行する ・同スコープが認可リクエストで指定された場合、同意画面を表示するが、同意画面は初回リクエスト時のみ表示し、以降はリフレッシュトークン有効期限まで表示しない。期限切れの場合は同意画面を再度表示 |
取引先、取引先担当者の項目タイプ値および項目タイプの説明
|
外部連携APIの 項目タイプの値 |
項目タイプの内容 | 説明 | データ登録時のバリデーション |
| text_single | 1:テキスト(1行) | 項目が1行テキストの形式の場合にこの値を設定 | 最大255文字 |
| text_multiple | 2:テキスト(複数行) | 項目が複数行テキストの形式の場合にこの値を設定 | 最大2000文字 |
| number | 3:数字 | 項目が数字の形式の場合にこの値を設定 | 最大9桁、半角数字のみ |
| amount_integer | 4:金額(整数) | 項目が金額（整数）の形式の場合にこの値を設定 | 最大15桁、半角数字のみ |
| amount_decimal | 5:金額(小数) | 項目が金額（小数）の形式の場合にこの値を設定 | 最大15桁(整数部)、最大2桁（小数部）、半角数字,ピリオド（小数点のピリオド）のみ |
| date | 6:日付 | 項目が日付の形式の場合にこの値を設定 | 形式チェック（日付形式） |
| datetime | 7:日時 | 項目が日時の形式の場合にこの値を設定 | 形式チェック（日時形式） |
| pulldown | 8:プルダウン | 項目がプルダウン形式の場合にこの値を設定 | 半角数字のみ |
| linkage_pulldown | 9:連携プルダウン | 項目が連携プルダウン形式の場合にこの値を設定 | 半角数字のみ |
| checkbox | 10:チェックボックス | 項目がチェックボックス形式の場合にこの値を設定 | 半角数字のみ |
| phone_number | 11:電話番号 | 項目が電話番号の形式の場合にこの値を設定 |
最大25文字、半角数字、半角プラス記号、半角ハイフンのみ {
"itemID": "d3f1bb48-85c2-49ea-b24d-a3e94e4c2221",
"itemType": "phone_number",
"itemTextData": {
"value": "0322222222",
"ruby": null
}
}
|
| url | 12:URL | 項目がURLの形式の場合にこの値を設定 | 最大255文字、形式チェック（URL形式） |
| mail_address | 13:メールアドレス | 項目がメールアドレスの形式の場合にこの値を設定 | 最大255文字、形式チェック（メールアドレス形式） |
| postal_code | 14:郵便番号 | 項目が郵便番号の形式の場合にこの値を設定 | 最大8文字、半角数字、半角ハイフンのみ |
| prefectures | 15:都道府県 | 項目が都道府県の形式の場合にこの値を設定 | 都道府県名（「東京都」、「神奈川県」など、県名まで含む） |
| user_single | 16:ユーザー(単数) | 項目がユーザーID（単数）の場合にこの値を設定 | 形式チェック（UUID形式） |
| user_multiple | 17:ユーザー(複数) | 項目がユーザーID（複数）の場合にこの値を設定 | 形式チェック（UUID形式） |
| division_single | 18:部署(単数) | 項目が部署ID（単数）の場合にこの値を設定 | 形式チェック（UUID形式） |
| division_multiple | 19:部署(複数) | 項目が部署ID（複数）の場合にこの値を設定 | 形式チェック（UUID形式） |
| client_single | 20:取引先(単数) | 20:取引先(単数) | 形式チェック（UUID形式） |
| client_multiple | 21:取引先(複数) | 21:取引先(複数) | 形式チェック（UUID形式） |
| clientresponsible_single | 22:取引先担当者(単数) | 22:取引先担当者(単数) | 形式チェック（UUID形式） |
| clientresponsible_multiple | 23:取引先担当者(複数) | 23:取引先担当者(複数) | 形式チェック（UUID形式） |
| product_single | 24:商品(単数) | 24:商品(単数) | 形式チェック（UUID形式） |
| product_multiple | 25:商品(複数) | 25:商品(複数) | 形式チェック（UUID形式） |
| inquiry_route | 28:引合経路 | 28:引合経路 | 形式チェック（UUID形式） |
| text_ruby | 30:フリガナ付きテキスト | 30:フリガナ付きテキスト | 名称：最大255文字、フリガナ：最大255文字 |