SFA API仕様

Knowledge Suite+を外部システムから利用する手段として、Webhookや外部連携用APIといった機能が用意されています。
本ドキュメントではSFAの外部連携用APIについて説明します。
外部連携用APIは、前述のとおりKnowledgeSuite+の機能を外部のシステムから利用するためのAPIです。
外部連携用APIを利用することにより、以下のようなシステム間連携を行うことができます。

・外部システムで登録された商談データをKnowledgeSuite+の案件データとして登録する
・KnowledgeSuite+で登録された取引先担当者の名刺データを取得して外部システム側で情報表示する
 

【この記事の内容】

APIの機能概要

参照系API

実行系API

APIの認証仕様

ROBOT IDは、各種SaaSとの安全なID一元管理およびシングルサインオン（SSO）を実現するために、弊社ブルーテックが提供する認証ソリューションです。その認証APIであるOpen Id Connect APIは、標準的なプロトコルに準拠したセキュアな認証連携を提供しています。

認可エンドポイント

概要

クライアント情報をもとにユーザーの認証・認可を行うエンドポイント。

リクエストURL

https://[ROBOTIDドメイン]/oidc-auth/authorize
（商用環境の場合のURL）https://robotid.jp/oidc-auth/authorize
 

リクエストHTTPメソッド

GET

リクエストパラメタ

リクエスト具体例

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

レスポンス形式

リダイレクト

レスポンスデータ

レスポンス具体例

HTTP/1.1 302 Found
Location: https://example.com/home?
  code=teqRmyiGXkSqb0Hbjpqnnz
  &state=bd83xwghJW

目次に戻る

トークン発行エンドポイント

概要

アクセストークン・リフレッシュトークンの新規発行を行いたい場合に、リクエストパラメタに認可コードの識別子および認可コードを指定し、トークンエンドポイントにリクエストを行ってトークンの新規発行をする
 

リクエストURL

https://[ROBOTIDドメイン]/oidc-auth/token
（商用環境の場合のURL）https://robotid.jp/oidc-auth/token
 

リクエストHTTPメソッド

POST

リクエストヘッダ

リクエストボディ

※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

レスポンスデータ

レスポンス具体例

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"
}

目次に戻る

トークン再発行エンドポイント

概要

アクセストークンの再発行（リフレッシュ）を行いたい場合に、リクエストパラメタに再発行の識別子およびリフレッシュトークンを指定し、トークンエンドポイントにリクエストを行って再発行する。

リクエストURL

https://[ROBOTIDドメイン]/oidc-auth/token
（商用環境の場合のURL）https://robotid.jp/oidc-auth/token

リクエストHTTPメソッド

POST

リクエストヘッダ

リクエストボディ

※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

レスポンスデータ

トークン発行エンドポイントと同様

目次に戻る

トークン無効化エンドポイント

概要

アクセストークンまたはリフレッシュトークンの無効化を行いたい場合に、リクエストパラメタにトークンを指定し、
トークン無効化エンドポイントにリクエストを行ってトークンを無効化する
 

リクエストURL

https://[ROBOTIDドメイン]/oidc-auth/revoke
（商用環境の場合のURL）https://robotid.jp/oidc-auth/revoke
 

リクエストHTTPメソッド

POST

リクエストヘッダ

リクエストボディ

※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

目次に戻る

ユーザー情報エンドポイント

概要

トークンエンドポイントのリクエストで取得したアクセストークンをもとに、ユーザー情報を取得するためのエンドポイント

リクエストURL

https://[ROBOTIDドメイン]/oidc-auth/userinfo
（商用環境の場合のURL）https://robotid.jp/oidc-auth/userinfo
 

リクエストHTTPメソッド

GET

リクエストヘッダ

リクエスト具体例

GET  /oidc-auth/userinfo  HTTP/1.1
Host: robotid.jp
Authorization: Bearer 3L5qQWVP0J

レスポンス形式

JSON

レスポンスデータ

※各スコープの詳細については、「認証スコープ仕様」に記載

レスポンス具体例

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"
}

目次に戻る

認証スコープ仕様

概要

スコープとして、大きく以下の3種類を登録・使用可能とする。

①システムスコープ（デフォルト）

OpenIDConnectの仕様で定義されているスコープ。デフォルトでDBに登録しておき、ユーザが使用可能にする。

②システムスコープ（ユーザ定義）

システムスコープについて、ユーザが独自にスコープを登録・編集可能とする。

③APIスコープ

ユーザが利用するAPIのスコープ。システム管理者がスコープを管理画面上から登録。ユーザは管理画面上からAPIの有効設定をする事により利用可能となる。
 

デフォルトのシステムスコープ一覧

RobotID OpenIdConnectにデフォルトで登録されているシステムスコープは以下の通り。

目次に戻る

APIの共通仕様

本APIの通信方式は、各APIのURLにHTTPSのPOSTまたはGETメソッド（各APIの説明を参照）でアクセスすることで利用可能です。
※テンプレート系API（商品テンプレート取得、案件テンプレート一覧取得、案件テンプレート取得、レポートテンプレート一覧取得、レポートテンプレート取得）はGET

リクエストの際はROBOTID Open Id Connect APIの認証アクセストークンが必要となります。具体的な発行手順は「APIの認証仕様」をご覧ください。​

URL

※各API毎の説明を参照

リクエスト

API へのリクエストには以下の HTTP ヘッダを付与してください

レスポンス

API からのレスポンスは JSON 文字列として返却されます。レスポンス JSON の内容は基本的に API 毎に異なりますが、AppStatus という項目はどのAPIのレスポンスにも含まれます。AppStatus の内容を参照することで API の成否についての情報を得る事が出来ます。

■ユーザー一覧取得、組織一覧取得の結果

■それ以外

AppStatus.Code について

レスポンスの AppStatus.Code にはAPIの終了コードが格納されます。API の実行が成功している場合は "S000" という値が、API がエラー終了した場合は API・失敗原因毎にエラーの原因を表すコードが格納されます。
※ 各 API の個別説明を参照

全API共通の終了コード

下記の終了コードについては、全API共通です

目次に戻る

API利用時の注意事項

外部連携APIで「取引先」「取引先担当」の登録、変更、削除の際はWebhookは発行されません。
それにより、ループを防ぐ為の仕様となっております。

【利用規約について】
API連携・Webhook通知・MCP連携をご利用の場合は、以下の利用規約をご一読ください。
　Knowledge Suite+サービス利用規約
　Knowledge Suite+ API・MCP利用規約
※API・Webhook・MCPを利用した不正利用は一切禁止しております。また情報漏洩等のトラブルにつきましては当方では責任を負いかねます。
　セキュリティ対策等の管理は、ユーザー様の責任において実施いただきますようお願い申し上げます。

【クライアントIDやAPIキー等の取り扱いについて】
初期設定で扱うROBOTIDの企業ユニークID、ユーザーID、パスワード、およびクライアントID、クライアントシークレット等の認証情報は厳重に管理してください。
外部への漏洩防止はもちろん、生成AIに入力・読み込ませることがないよう、細心の注意を払ってご利用ください。

【Knowledge Suite+管理者設定について】
・API連携・MCP連携をご利用の場合は「外部連携API」のロールが付与されている事をご確認ください。
・Webhook通知をご利用の場合は管理者設定画面の設定をご確認ください。

参照系API

商品テンプレート取得

APIの概要

テナント内の商品のテンプレートデータを取得します。
レスポンスで返される商品テンプレートデータは、KS+の管理者画面の商品テンプレート編集画面で編集・更新した内容（未編集の場合は契約・開通時に自動で初期設定された商品テンプレートのデフォルト項目の内容）が返されます。
 

リクエストパラメタ

特に指定不要

レスポンス JSON

レスポンス例(JSON)

{
  ""appStatus"": {
    ""code"": ""S000"",
    ""message"": """"
  },
  ""productTemplateInfo"": {
    ""templateList"": [
      {
        ""itemID"": ""783fcf8e-01f9-489a-98ef-3a147c7b920c"",
        ""itemType"": ""text_single"",
        ""itemName"": ""商品名"",
        ""requiredFlag"": true,
        ""beforeUnit"": null,
        ""afterUnit"": null,
        ""readOnlyFlag"": false,
        ""selectionValues"": null,
        ""linkageSelectionValues"": null
      },
      {
        ""itemID"": ""86330dff-b4db-46d5-adce-4372319e41e4"",
        ""itemType"": ""toggle"",
        ""itemName"": ""提案商品として利用"",
        ""requiredFlag"": false,
        ""beforeUnit"": null,
        ""afterUnit"": null,
        ""readOnlyFlag"": false,
        ""selectionValues"": null,
        ""linkageSelectionValues"": null
      },
      {
        ""itemID"": ""23908c8e-ab4b-415a-a9a9-f8e0f2a5f0f6"",
        ""itemType"": ""amount_decimal"",
        ""itemName"": ""販売価格"",
        ""requiredFlag"": true,
        ""beforeUnit"": null,
        ""afterUnit"": ""円"",
        ""readOnlyFlag"": false,
        ""selectionValues"": null,
        ""linkageSelectionValues"": null
      },
      {
        ""itemID"": ""139f91ba-8e84-44e7-aa02-857989f6695d"",
        ""itemType"": ""text_multiple"",
        ""itemName"": ""商品説明"",
        ""requiredFlag"": false,
        ""beforeUnit"": null,
        ""afterUnit"": null,
        ""readOnlyFlag"": false,
        ""selectionValues"": [],
        ""linkageSelectionValues"": []
      },
      {
        ""itemID"": ""0b2dc74b-8be3-48a5-adbc-c8711ad77ca0"",
        ""itemType"": ""linkage_pulldown"",
        ""itemName"": ""商品ファミリー"",
        ""requiredFlag"": false,
        ""beforeUnit"": null,
        ""afterUnit"": null,
        ""readOnlyFlag"": false,
        ""selectionValues"": null,
        ""linkageSelectionValues"": [
          {
            ""label"": ""医薬品系（第一階層）"",
            ""displayFlag"": true,
            ""value"": 1,
            ""children"": [
              {
                ""label"": ""一般用医薬品（第二階層）"",
                ""displayFlag"": true,
                ""value"": 3,
                ""children"": [
                  {
                    ""label"": ""選択肢1（第三階層）"",
                    ""displayFlag"": true,
                    ""value"": 4,
                    ""children"": []
                  },
                  {
                    ""label"": ""選択肢2（第三階層）"",
                    ""displayFlag"": true,
                    ""value"": 9,
                    ""children"": []
                  }
                ]
              },
              {
                ""label"": ""医療用医薬品（第二階層）"",
                ""displayFlag"": true,
                ""value"": 8,
                ""children"": []
              }
            ]
          },
          {
            ""label"": ""健康食品・サプリメント系（第一階層）"",
            ""displayFlag"": true,
            ""value"": 2,
            ""children"": [
              {
                ""label"": ""栄養補助食品（第二階層）"",
                ""displayFlag"": true,
                ""value"": 11,
                ""children"": []
              },
              {
                ""label"": ""機能性表示食品（第二階層）"",
                ""displayFlag"": true,
                ""value"": 12,
                ""children"": []
              }
            ]
          },
          {
            ""label"": ""衛生・ケア用品系（第一階層）"",
            ""displayFlag"": true,
            ""value"": 10,
            ""children"": [
              {
                ""label"": ""衛生用品（第二階層）"",
                ""displayFlag"": true,
                ""value"": 13,
                ""children"": []
              }
            ]
          },
          {
            ""label"": ""選択してください"",
            ""displayFlag"": true,
            ""value"": 14,
            ""children"": [
              {
                ""label"": ""選択肢1（第二階層）"",
                ""displayFlag"": true,
                ""value"": 16,
                ""children"": []
              }
            ]
          }
        ]
      },
      {
        ""itemID"": ""580dcc22-f7f3-4594-9b7e-dabda3601fa1"",
        ""itemType"": ""amount_decimal"",
        ""itemName"": ""原価"",
        ""requiredFlag"": true,
        ""beforeUnit"": ""＄"",
        ""afterUnit"": ""円"",
        ""readOnlyFlag"": false,
        ""selectionValues"": null,
        ""linkageSelectionValues"": null
      },
      {
        ""itemID"": ""182318ed-f42b-4e21-947d-73f58a9989d3"",
        ""itemType"": ""text_single"",
        ""itemName"": ""商品コード"",
        ""requiredFlag"": false,
        ""beforeUnit"": null,
        ""afterUnit"": null,
        ""readOnlyFlag"": false,
        ""selectionValues"": null,
        ""linkageSelectionValues"": null
      },
      {
        ""itemID"": ""176b1aad-1c48-4c1b-8e82-985de2ba9225"",
        ""itemType"": ""subscription"",
        ""itemName"": ""サブスクリプション"",
        ""requiredFlag"": false,
        ""beforeUnit"": null,
        ""afterUnit"": null,
        ""readOnlyFlag"": false,
        ""selectionValues"": null,
        ""linkageSelectionValues"": null
      },
      {
        ""itemID"": ""5321eaf2-a1af-4c9a-9150-77d3a19cc0ac"",
        ""itemType"": ""url"",
        ""itemName"": ""商品URLテスト"",
        ""requiredFlag"": false,
        ""beforeUnit"": null,
        ""afterUnit"": null,
        ""readOnlyFlag"": false,
        ""selectionValues"": null,
        ""linkageSelectionValues"": null
      },
      {
        ""itemID"": ""c3fdda6a-9eb5-427b-af55-45037f3889dd"",
        ""itemType"": ""user_single"",
        ""itemName"": ""作成者j"",
        ""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"": ""abaf7064-0eba-497c-a907-386a41ec71d3"",
        ""itemType"": ""datetime"",
        ""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"": ""54a9f809-f7a1-4750-a23d-d06be6754c54"",
        ""itemType"": ""division_multiple"",
        ""itemName"": ""部署（複数）"",
        ""requiredFlag"": false,
        ""beforeUnit"": null,
        ""afterUnit"": null,
        ""readOnlyFlag"": true,
        ""selectionValues"": null,
        ""linkageSelectionValues"": null
      },
      {
        ""itemID"": ""714b5b83-2df3-4e26-97f0-831b157a4ea7"",
        ""itemType"": ""text_single"",
        ""itemName"": ""必須テキスト一行"",
        ""requiredFlag"": true,
        ""beforeUnit"": null,
        ""afterUnit"": null,
        ""readOnlyFlag"": false,
        ""selectionValues"": null,
        ""linkageSelectionValues"": null
      },
      {
        ""itemID"": ""f8ae186f-f4b1-4ab1-8d35-bf7c8369b01c"",
        ""itemType"": ""text_single"",
        ""itemName"": ""テキスト一行"",
        ""requiredFlag"": false,
        ""beforeUnit"": null,
        ""afterUnit"": null,
        ""readOnlyFlag"": false,
        ""selectionValues"": null,
        ""linkageSelectionValues"": null
      },
      {
        ""itemID"": ""953e7157-9215-42d8-9de5-b01afef26e5b"",
        ""itemType"": ""text_multiple"",
        ""itemName"": ""テキスト複数行"",
        ""requiredFlag"": false,
        ""beforeUnit"": null,
        ""afterUnit"": null,
        ""readOnlyFlag"": false,
        ""selectionValues"": null,
        ""linkageSelectionValues"": null
      },
      {
        ""itemID"": ""7b1de9ce-095a-496f-8830-cb6839415ad6"",
        ""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"": ""休憩中"",
            ""displayFlag"": true,
            ""value"": 4
          },
          {
            ""label"": ""退席中"",
            ""displayFlag"": true,
            ""value"": 5
          }
        ],
        ""linkageSelectionValues"": null
      },
      {
        ""itemID"": ""bffff0e3-9dc8-4592-91e5-16c47ea31a44"",
        ""itemType"": ""user_single"",
        ""itemName"": ""ユーザー選択（単数）"",
        ""requiredFlag"": false,
        ""beforeUnit"": null,
        ""afterUnit"": null,
        ""readOnlyFlag"": false,
        ""selectionValues"": null,
        ""linkageSelectionValues"": null
      },
      {
        ""itemID"": ""8dc45454-6fbe-4b7f-8e4d-7c9ab36901c2"",
        ""itemType"": ""user_multiple"",
        ""itemName"": ""ユーザー選択（複数）"",
        ""requiredFlag"": false,
        ""beforeUnit"": null,
        ""afterUnit"": null,
        ""readOnlyFlag"": false,
        ""selectionValues"": null,
        ""linkageSelectionValues"": null
      },
      {
        ""itemID"": ""91cdcb3c-e868-43ee-98b1-aece0439d6bb"",
        ""itemType"": ""division_single"",
        ""itemName"": ""部署選択（単数）"",
        ""requiredFlag"": false,
        ""beforeUnit"": null,
        ""afterUnit"": null,
        ""readOnlyFlag"": false,
        ""selectionValues"": null,
        ""linkageSelectionValues"": null
      },
      {
        ""itemID"": ""e1648d20-ed36-46be-93e8-952e00f68c5b"",
        ""itemType"": ""division_multiple"",
        ""itemName"": ""部署選択（複数）"",
        ""requiredFlag"": false,
        ""beforeUnit"": null,
        ""afterUnit"": null,
        ""readOnlyFlag"": false,
        ""selectionValues"": null,
        ""linkageSelectionValues"": null
      },
      {
        ""itemID"": ""30881d96-2cbc-4ad2-923e-b53b22c5d826"",
        ""itemType"": ""date"",
        ""itemName"": ""日付"",
        ""requiredFlag"": false,
        ""beforeUnit"": null,
        ""afterUnit"": null,
        ""readOnlyFlag"": false,
        ""selectionValues"": null,
        ""linkageSelectionValues"": null
      },
      {
        ""itemID"": ""0d9a3264-4193-48d6-b7c3-0b3841aeaaa0"",
        ""itemType"": ""datetime"",
        ""itemName"": ""日時"",
        ""requiredFlag"": false,
        ""beforeUnit"": null,
        ""afterUnit"": null,
        ""readOnlyFlag"": false,
        ""selectionValues"": null,
        ""linkageSelectionValues"": null
      },
      {
        ""itemID"": ""d9ed7281-a13b-4128-9970-56a12b3c44a6"",
        ""itemType"": ""amount_decimal"",
        ""itemName"": ""金額（小数）"",
        ""requiredFlag"": false,
        ""beforeUnit"": ""￥"",
        ""afterUnit"": """",
        ""readOnlyFlag"": false,
        ""selectionValues"": null,
        ""linkageSelectionValues"": null
      },
      {
        ""itemID"": ""80a5ef34-0c89-472e-8005-5361f79c9f5d"",
        ""itemType"": ""amount_integer"",
        ""itemName"": ""金額"",
        ""requiredFlag"": false,
        ""beforeUnit"": ""￥"",
        ""afterUnit"": """",
        ""readOnlyFlag"": false,
        ""selectionValues"": null,
        ""linkageSelectionValues"": null
      },
      {
        ""itemID"": ""d44c5767-4a6e-43c2-808e-4dd4f73adf65"",
        ""itemType"": ""number"",
        ""itemName"": ""数字"",
        ""requiredFlag"": false,
        ""beforeUnit"": null,
        ""afterUnit"": null,
        ""readOnlyFlag"": false,
        ""selectionValues"": null,
        ""linkageSelectionValues"": null
      },
      {
        ""itemID"": ""1b9fa4d7-a137-494b-a236-1a0bb799dcde"",
        ""itemType"": ""phone_number"",
        ""itemName"": ""電話・FAX番号"",
        ""requiredFlag"": false,
        ""beforeUnit"": null,
        ""afterUnit"": null,
        ""readOnlyFlag"": false,
        ""selectionValues"": null,
        ""linkageSelectionValues"": null
      },
      {
        ""itemID"": ""f081b73b-9825-40de-a568-e4ebcce77cf3"",
        ""itemType"": ""url"",
        ""itemName"": ""URL"",
        ""requiredFlag"": false,
        ""beforeUnit"": null,
        ""afterUnit"": null,
        ""readOnlyFlag"": false,
        ""selectionValues"": null,
        ""linkageSelectionValues"": null
      },
      {
        ""itemID"": ""21fc9919-8fcd-41af-87d4-24397953c69f"",
        ""itemType"": ""postal_code"",
        ""itemName"": ""郵便番号"",
        ""requiredFlag"": false,
        ""beforeUnit"": null,
        ""afterUnit"": null,
        ""readOnlyFlag"": false,
        ""selectionValues"": null,
        ""linkageSelectionValues"": null
      },
      {
        ""itemID"": ""0daca4d2-ba59-4455-ab81-f991150b84e7"",
        ""itemType"": ""mail_address"",
        ""itemName"": ""メールアドレス"",
        ""requiredFlag"": false,
        ""beforeUnit"": null,
        ""afterUnit"": null,
        ""readOnlyFlag"": false,
        ""selectionValues"": null,
        ""linkageSelectionValues"": null
      }
    ]
  },
  ""systemLinkageSettingInfoList"": [
    {
      ""systemLinkageID"": 999000001,
      ""linkageSystemName"": ""test""
    },
    {
      ""systemLinkageID"": 999000002,
      ""linkageSystemName"": ""bb""
    }
  ]
}														

API 固有の終了コード

目次に戻る

商品一覧取得

APIの概要

テナント内の商品データを一覧リストとして取得します。
パラメタのオフセットで開始位置を指定して、リミットで取得件数を指定して取得します。
オプションで商品の商品名など、商品の基本項目を検索条件として指定して検索して一覧取得も可能です。

リクエストボディ（JSON）

リクエスト例(JSON)

{
        "param": {
                "requiredConditions": {
                        "pagination": {
                                "offset": 0,
                                "limit": 10
                        }
                },
                "optionalConditions": {
                        "searchConditions": {
                                "productName": "テスト商品",
                                "productCode": "test"
                        }
                }
        }
}

レスポンス JSON

レスポンス例(JSON)

{
  "appStatus": {
    "code": "S000",
    "message": ""
  },
  "productListInfo": {
    "productList": [
      {
        "productID": "a83a7978-c924-4c63-b65b-ec35b33893d5",
        "productName": "テスト商品_0910",
        "productCode": "test",
        "systemLinkageInfoList": [
          {
            "systemLinkageID": 999000011,
            "linkageIDValue": "20260910_連携"
          }
        ]
      },
      {
        "productID": "c3574dc5-b4d4-4905-a04d-51f49653c443",
        "productName": "テスト商品2026/09/10",
        "productCode": "test001",
        "systemLinkageInfoList": null
      }
    ],
    "getMoreFlag": false
  }

API 固有の終了コード

追加取得フラグについて
レスポンスJSON の getMoreFlag が true である場合、取得最大件数を超えたため返却しきれなかった商品データが残っている事を示します。
本APIを下記のパラメータで実行することで、未取得となっている商品リストの続きを取得することができます。

目次に戻る

商品詳細取得

APIの概要

パラメタの商品IDに対応する商品の詳細データを取得します。商品登録・更新で登録された商品の項目データを詳細データとして取得します。

リクエストボディ（JSON）

リクエスト例(JSON)

{
	"param": {
		"productID": "fee05285-40d5-4410-8c57-422472eb8942"
	}
}

レスポンス JSON

レスポンス例(JSON)

{
  ""appStatus"": {
    ""code"": ""S000"",
    ""message"": """"
  },
  ""productDetailInfo"": {
    ""productItemList"": [
      {
        ""itemID"": ""783fcf8e-01f9-489a-98ef-3a147c7b920c"",
        ""itemType"": ""text_single"",
        ""itemTextData"": {
          ""value"": ""テスト_商品05"",
          ""ruby"": null,
          ""datetimeTo"": null
        }
      },
      {
        ""itemID"": ""86330dff-b4db-46d5-adce-4372319e41e4"",
        ""itemType"": ""toggle"",
        ""itemToggleData"": {
          ""value"": true,
          ""term"": 0
        }
      },
      {
        ""itemID"": ""23908c8e-ab4b-415a-a9a9-f8e0f2a5f0f6"",
        ""itemType"": ""amount_decimal"",
        ""itemNumericData"": {
          ""value"": ""100000""
        }
      },
      {
        ""itemID"": ""139f91ba-8e84-44e7-aa02-857989f6695d"",
        ""itemType"": ""text_multiple"",
        ""itemTextData"": {
          ""value"": ""商品説明１\n"",
          ""ruby"": null,
          ""datetimeTo"": null
        }
      },
      {
        ""itemID"": ""0b2dc74b-8be3-48a5-adbc-c8711ad77ca0"",
        ""itemType"": ""linkage_pulldown"",
        ""itemSelectionData"": {
          ""values"": [
            1,
            3,
            4
          ]
        }
      },
      {
        ""itemID"": ""580dcc22-f7f3-4594-9b7e-dabda3601fa1"",
        ""itemType"": ""amount_decimal"",
        ""itemNumericData"": {
          ""value"": ""100.11""
        }
      },
      {
        ""itemID"": ""182318ed-f42b-4e21-947d-73f58a9989d3"",
        ""itemType"": ""text_single"",
        ""itemTextData"": {
          ""value"": ""商品コード"",
          ""ruby"": null,
          ""datetimeTo"": null
        }
      },
      {
        ""itemID"": ""176b1aad-1c48-4c1b-8e82-985de2ba9225"",
        ""itemType"": ""subscription"",
        ""itemToggleData"": {
          ""value"": true,
          ""term"": 6
        }
      },
      {
        ""itemID"": ""5321eaf2-a1af-4c9a-9150-77d3a19cc0ac"",
        ""itemType"": ""url"",
        ""itemTextData"": {
          ""value"": ""http://test.com"",
          ""ruby"": null,
          ""datetimeTo"": null
        }
      },
      {
        ""itemID"": ""c3fdda6a-9eb5-427b-af55-45037f3889dd"",
        ""itemType"": ""user_single"",
        ""itemUuidDataList"": [
          {
            ""itemUuid"": ""f156d2ab-0d93-4149-946d-0adbaaae9303"",
            ""itemDisplayValue"": ""テストユーザー""
          }
        ]
      },
      {
        ""itemID"": ""612017e9-b88e-4ba7-90fe-7322590a6ddc"",
        ""itemType"": ""user_single"",
        ""itemUuidDataList"": [
          {
            ""itemUuid"": ""c84aa9a5-1390-41a4-9786-7cda5fd9971f"",
            ""itemDisplayValue"": ""山田 太郎""
          }
        ]
      },
      {
        ""itemID"": ""abaf7064-0eba-497c-a907-386a41ec71d3"",
        ""itemType"": ""datetime"",
        ""itemTextData"": {
          ""value"": ""2026-07-29T02:41:52Z"",
          ""ruby"": null,
          ""datetimeTo"": null
        }
      },
      {
        ""itemID"": ""b91ed3f4-d0a0-4337-8d25-4117cb823d83"",
        ""itemType"": ""datetime"",
        ""itemTextData"": {
          ""value"": ""2026-07-31T05:22:09Z"",
          ""ruby"": null,
          ""datetimeTo"": null
        }
      },
      {
        ""itemID"": ""2dd479d5-2066-4807-8b51-67ddd1e830a1"",
        ""itemType"": ""prefectures"",
        ""itemTextData"": {
          ""value"": ""北海道"",
          ""ruby"": null,
          ""datetimeTo"": null
        }
      },
      {
        ""itemID"": ""714b5b83-2df3-4e26-97f0-831b157a4ea7"",
        ""itemType"": ""text_single"",
        ""itemTextData"": {
          ""value"": ""test"",
          ""ruby"": null,
          ""datetimeTo"": null
        }
      },
      {
        ""itemID"": ""f8ae186f-f4b1-4ab1-8d35-bf7c8369b01c"",
        ""itemType"": ""text_single"",
        ""itemTextData"": {
          ""value"": ""テキスト一行"",
          ""ruby"": null,
          ""datetimeTo"": null
        }
      },
      {
        ""itemID"": ""953e7157-9215-42d8-9de5-b01afef26e5b"",
        ""itemType"": ""text_multiple"",
        ""itemTextData"": {
          ""value"": ""テキスト複数行"",
          ""ruby"": null,
          ""datetimeTo"": null
        }
      },
      {
        ""itemID"": ""7b1de9ce-095a-496f-8830-cb6839415ad6"",
        ""itemType"": ""pulldown"",
        ""itemSelectionData"": {
          ""values"": [
            1
          ]
        }
      },
      {
        ""itemID"": ""fc48bffc-4639-4e7f-bd72-72d1b94d026f"",
        ""itemType"": ""linkage_pulldown"",
        ""itemSelectionData"": {
          ""values"": [
            1,
            4,
            6
          ]
        }
      },
      {
        ""itemID"": ""51b86754-0515-47c1-a797-23a0d34b1ba2"",
        ""itemType"": ""checkbox"",
        ""itemSelectionData"": {
          ""values"": [
            1,
            2,
            3
          ]
        }
      },
      {
        ""itemID"": ""8dc45454-6fbe-4b7f-8e4d-7c9ab36901c2"",
        ""itemType"": ""user_multiple"",
        ""itemUuidDataList"": [
          {
            ""itemUuid"": ""62ad9f89-8b34-4600-9b03-582e7d210eba"",
            ""itemDisplayValue"": ""佐藤 次郎""
          }
        ]
      },
      {
        ""itemID"": ""91cdcb3c-e868-43ee-98b1-aece0439d6bb"",
        ""itemType"": ""division_single"",
        ""itemUuidDataList"": [
          {
            ""itemUuid"": ""4dce2f99-cb5d-44e3-baed-543115a1a91c"",
            ""itemDisplayValue"": ""組織01""
          }
        ]
      },
      {
        ""itemID"": ""e1648d20-ed36-46be-93e8-952e00f68c5b"",
        ""itemType"": ""division_multiple"",
        ""itemUuidDataList"": [
          {
            ""itemUuid"": ""4dce2f99-cb5d-44e3-baed-543115a1a91c"",
            ""itemDisplayValue"": ""組織02""
          }
        ]
      },
      {
        ""itemID"": ""30881d96-2cbc-4ad2-923e-b53b22c5d826"",
        ""itemType"": ""date"",
        ""itemTextData"": {
          ""value"": ""2026/07/29"",
          ""ruby"": null,
          ""datetimeTo"": null
        }
      },
      {
        ""itemID"": ""0d9a3264-4193-48d6-b7c3-0b3841aeaaa0"",
        ""itemType"": ""datetime"",
        ""itemTextData"": {
          ""value"": ""2026-07-30T05:18:00Z"",
          ""ruby"": null,
          ""datetimeTo"": null
        }
      },
      {
        ""itemID"": ""d9ed7281-a13b-4128-9970-56a12b3c44a6"",
        ""itemType"": ""amount_decimal"",
        ""itemNumericData"": {
          ""value"": ""1000.11""
        }
      },
      {
        ""itemID"": ""80a5ef34-0c89-472e-8005-5361f79c9f5d"",
        ""itemType"": ""amount_integer"",
        ""itemNumericData"": {
          ""value"": ""1000000""
        }
      },
      {
        ""itemID"": ""d44c5767-4a6e-43c2-808e-4dd4f73adf65"",
        ""itemType"": ""number"",
        ""itemNumericData"": {
          ""value"": ""1111""
        }
      },
      {
        ""itemID"": ""1b9fa4d7-a137-494b-a236-1a0bb799dcde"",
        ""itemType"": ""phone_number"",
        ""itemTextData"": {
          ""value"": ""11111"",
          ""ruby"": null,
          ""datetimeTo"": null
        }
      },
      {
        ""itemID"": ""f081b73b-9825-40de-a568-e4ebcce77cf3"",
        ""itemType"": ""url"",
        ""itemTextData"": {
          ""value"": ""http://test.com"",
          ""ruby"": null,
          ""datetimeTo"": null
        }
      },
      {
        ""itemID"": ""21fc9919-8fcd-41af-87d4-24397953c69f"",
        ""itemType"": ""postal_code"",
        ""itemTextData"": {
          ""value"": ""1111111"",
          ""ruby"": null,
          ""datetimeTo"": null
        }
      },
      {
        ""itemID"": ""0daca4d2-ba59-4455-ab81-f991150b84e7"",
        ""itemType"": ""mail_address"",
        ""itemTextData"": {
          ""value"": ""test@test.com"",
          ""ruby"": null,
          ""datetimeTo"": null
        }
      }
    ],
    ""systemLinkageInfoList"": [
      {
        ""systemLinkageID"": 999000001,
        ""linkageIDValue"": ""test_01""
      },
      {
        ""systemLinkageID"": 999000002,
        ""linkageIDValue"": ""test_02""
      }
    ]
  }
}													

API 固有の終了コード

目次に戻る

案件テンプレート一覧取得

APIの概要

テナント内の案件のテンプレート一覧を取得します。
 

リクエストパラメタ

特に指定不要

レスポンス JSON

レスポンス例(JSON)

{
  "appStatus": {
    "code": "S000",
    "message": ""
  },
 "orderTemplateListInfo": {
  "orderTemplateList": [
   {
    "templateID": "c9391af7-4d88-4a7c-9621-4a80aa0c011a",
    "templateName": "TEST0911"
   },
   {
    "templateID": "95b50e7e-8ef9-459c-b558-9ae928c718ca",
    "templateName": "山田テスト1001"
   }
  ]
 }
}

API 固有の終了コード

目次に戻る

案件テンプレート取得

APIの概要

テナント内の案件のテンプレートデータを取得します。
レスポンスで返される案件テンプレートデータは、KS+の管理者画面の案件テンプレート編集画面で編集・更新した内容（未編集の場合は契約・開通またはテンプレート新規追加時に自動で初期設定された案件テンプレートのデフォルト項目の内容）が返されます。
 

リクエストパラメタ

レスポンス JSON

レスポンス例(JSON)

{
  ""appStatus"": {
    ""code"": ""S000"",
    ""message"": """"
  },
 ""orderTemplateInfo"": {
  ""templateList"": [
   {
    ""itemID"": ""92a51904-d677-4b3d-a774-d0a852950778"",
    ""itemType"": ""text_single"",
    ""itemName"": ""案件名"",
    ""requiredFlag"": true,
    ""beforeUnit"": null,
    ""afterUnit"": null,
    ""readOnlyFlag"": false,
    ""selectionValues"": [],
    ""linkageSelectionValues"": []
   },
   {
    ""itemID"": ""b5261a9d-63e0-439f-901b-0bc9c3e335af"",
    ""itemType"": ""client_single"",
    ""itemName"": ""取引先"",
    ""requiredFlag"": true,
    ""beforeUnit"": null,
    ""afterUnit"": null,
    ""readOnlyFlag"": false,
    ""selectionValues"": [],
    ""linkageSelectionValues"": []
   },
   {
    ""itemID"": ""7df90208-14a6-42b9-87e3-7cc1aee99869"",
    ""itemType"": ""toggle"",
    ""itemName"": ""重要"",
    ""requiredFlag"": false,
    ""beforeUnit"": null,
    ""afterUnit"": null,
    ""readOnlyFlag"": false,
    ""selectionValues"": [],
    ""linkageSelectionValues"": []
   },
   {
    ""itemID"": ""357dd67c-46bf-49d5-83eb-3ad8d201f20e"",
    ""itemType"": ""inquiry_route_single"",
    ""itemName"": ""引合経路"",
    ""requiredFlag"": false,
    ""beforeUnit"": null,
    ""afterUnit"": null,
    ""readOnlyFlag"": false,
    ""selectionValues"": [],
    ""linkageSelectionValues"": []
   },
   {
    ""itemID"": ""13a00aaf-9739-40f1-ac46-fa69b8ed9dae"",
    ""itemType"": ""date"",
    ""itemName"": ""初回面談日"",
    ""requiredFlag"": false,
    ""beforeUnit"": null,
    ""afterUnit"": null,
    ""readOnlyFlag"": false,
    ""selectionValues"": [],
    ""linkageSelectionValues"": []
   },
   {
    ""itemID"": ""a7440de8-7671-41b4-ba32-5fc079c4c629"",
    ""itemType"": ""pulldown"",
    ""itemName"": ""受注見込"",
    ""requiredFlag"": false,
    ""beforeUnit"": null,
    ""afterUnit"": null,
    ""readOnlyFlag"": false,
    ""selectionValues"": [
     {
      ""label"": ""A"",
      ""displayFlag"": true,
      ""value"": 1
     },
     {
      ""label"": ""B"",
      ""displayFlag"": true,
      ""value"": 2
     },
     {
      ""label"": ""C"",
      ""displayFlag"": true,
      ""value"": 3
     },
     {
      ""label"": ""D"",
      ""displayFlag"": true,
      ""value"": 4
     },
     {
      ""label"": ""E"",
      ""displayFlag"": true,
      ""value"": 5
     }
    ],
    ""linkageSelectionValues"": []
   },
   {
    ""itemID"": ""cd4c9a95-9e15-4900-9bf2-1eb139311b75"",
    ""itemType"": ""text_single"",
    ""itemName"": ""次回アクション内容"",
    ""requiredFlag"": false,
    ""beforeUnit"": null,
    ""afterUnit"": null,
    ""readOnlyFlag"": false,
    ""selectionValues"": [],
    ""linkageSelectionValues"": []
   },
   {
    ""itemID"": ""abaf7064-0eba-497c-a907-386a41ec71d3"",
    ""itemType"": ""datetime"",
    ""itemName"": ""作成日"",
    ""requiredFlag"": false,
    ""beforeUnit"": null,
    ""afterUnit"": null,
    ""readOnlyFlag"": true,
    ""selectionValues"": [],
    ""linkageSelectionValues"": []
   },
   {
    ""itemID"": ""c3fdda6a-9eb5-427b-af55-45037f3889dd"",
    ""itemType"": ""user_single"",
    ""itemName"": ""作成者"",
    ""requiredFlag"": false,
    ""beforeUnit"": null,
    ""afterUnit"": null,
    ""readOnlyFlag"": true,
    ""selectionValues"": [],
    ""linkageSelectionValues"": []
   },
   {
    ""itemID"": ""71657f77-19af-40aa-a574-0099f8299a35"",
    ""itemType"": ""phase"",
    ""itemName"": ""フェーズ"",
    ""requiredFlag"": true,
    ""beforeUnit"": null,
    ""afterUnit"": null,
    ""readOnlyFlag"": false,
    ""selectionValues"": [],
    ""linkageSelectionValues"": [],
    ""phaseSelectionValues"": [
     {
      ""phaseID"": 1,
      ""phaseName"": ""アプローチ中"",
      ""phaseProgress"": 20,
      ""displayFlag"": true,
      ""isItemDelete"": true
     },
     {
      ""phaseID"": 2,
      ""phaseName"": ""アポ獲得"",
      ""phaseProgress"": 40,
      ""displayFlag"": true,
      ""isItemDelete"": true
     },
     {
      ""phaseID"": 3,
      ""phaseName"": ""商談中"",
      ""phaseProgress"": 60,
      ""displayFlag"": true,
      ""isItemDelete"": true
     },
     {
      ""phaseID"": 4,
      ""phaseName"": ""クロージング"",
      ""phaseProgress"": 80,
      ""displayFlag"": true,
      ""isItemDelete"": true
     }
    ]
   },
   {
    ""itemID"": ""aaba5314-7277-429b-b890-2582e1c1d922"",
    ""itemType"": ""division_single"",
    ""itemName"": ""営業主担当部署"",
    ""requiredFlag"": true,
    ""beforeUnit"": null,
    ""afterUnit"": null,
    ""readOnlyFlag"": false,
    ""selectionValues"": [],
    ""linkageSelectionValues"": []
   },
   {
    ""itemID"": ""13a5fbf1-84c0-4a18-b7f7-dc049981f96f"",
    ""itemType"": ""user_single"",
    ""itemName"": ""営業主担当者"",
    ""requiredFlag"": true,
    ""beforeUnit"": null,
    ""afterUnit"": null,
    ""readOnlyFlag"": false,
    ""selectionValues"": [],
    ""linkageSelectionValues"": []
   },
   {
    ""itemID"": ""94a448d0-3094-49d8-a034-66c16c045d61"",
    ""itemType"": ""order_participants"",
    ""itemName"": ""案件参加者"",
    ""requiredFlag"": false,
    ""beforeUnit"": null,
    ""afterUnit"": null,
    ""readOnlyFlag"": false,
    ""selectionValues"": [
     {
      ""label"": ""案件参加者１"",
      ""displayFlag"": true,
      ""value"": 1
     },
     {
      ""label"": ""案件参加者２"",
      ""displayFlag"": true,
      ""value"": 2
     }
    ],
    ""linkageSelectionValues"": []
   },
   {
    ""itemID"": ""91327239-2f7e-45bc-a363-ca0ac0f22b5a"",
    ""itemType"": ""proposal_product"",
    ""itemName"": ""提案商品"",
    ""requiredFlag"": false,
    ""beforeUnit"": null,
    ""afterUnit"": ""円"",
    ""readOnlyFlag"": false,
    ""selectionValues"": [],
    ""linkageSelectionValues"": []
   }
  ],
  ""systemLinkageSettingInfoList"": [
   {
    ""systemLinkageID"": 999000001,
    ""linkageSystemName"": ""test""
   },
   {
    ""systemLinkageID"": 999000002,
    ""linkageSystemName"": ""test2""
   }
  ]
 }
}

API 固有の終了コード

目次に戻る

案件一覧取得

APIの概要

テナント内の、ユーザー自身が参照・更新可能となっている案件データを一覧リストとして取得します。
パラメタのオフセットで開始位置を指定して、リミットで取得件数を指定して取得します。
オプションで案件の案件名など、案件の基本項目を検索条件として指定して検索して一覧取得も可能です。

リクエストボディ（JSON）

リクエスト例(JSON)

{
        "param": {
                "requiredConditions": {
                        "pagination": {
                                "offset": 0,
                                "limit": 10
                        }
                },
                "optionalConditions": {
                        "searchConditions": {
                                "orderName": "案件テスト",
                                "phase": 3
                        }
                }
        }
}

レスポンス JSON

レスポンス例(JSON)

{
  ""appStatus"": {
    ""code"": ""S000"",
    ""message"": """"
  },
  ""orderListInfo"": {
    ""orderList"": [
      {
        ""orderID"": ""06f505e2-f5bf-4cbf-8e97-7e6a5eaf5449"",
        ""orderName"": ""案件テスト"",
        ""orderTemplateID"": ""a9dfe4bc-d0e0-44d8-bdaf-1d07496bca21"",
        ""orderTemplateName"": ""テスト案件テンプレート"",
        ""systemLinkageInfoList"": null
      },
      {
        ""orderID"": ""654fbd3a-afa3-4090-829a-c8d2a7b22e0e"",
        ""orderName"": ""案件テスト３"",
        ""orderTemplateID"": ""22fc215f-8ef2-4a92-a721-b5816d634411"",
        ""orderTemplateName"": ""案件 - 全デフォルト項目"",
        ""systemLinkageInfoList"": null
      }
    ],
    ""getMoreFlag"": false
  }
}

API 固有の終了コード

追加取得フラグについて
レスポンスJSON の getMoreFlag が true である場合、取得最大件数を超えたため返却しきれなかった商品データが残っている事を示します。
本APIを下記のパラメータで実行することで、未取得となっている案件リストの続きを取得することができます。

目次に戻る

案件詳細取得

APIの概要

パラメタの案件IDに対応する案件の詳細データを取得します。
案件登録・更新で登録された案件の項目データを詳細データとして取得します。

リクエストボディ（JSON）

リクエスト例(JSON)

{
        ""param"": {
                ""orderID"": ""58f843d1-a0cc-456a-b2ff-7fbbf98c39df""
        }
}

レスポンス JSON

レスポンス例(JSON)

{
  ""appStatus"": {
    ""code"": ""S000"",
    ""message"": """"
  },
  ""orderDetailInfo"": {
    ""participantMember"": {
      ""userList"": [
        {
          ""userID"": ""62ad9f89-8b34-4600-9b03-582e7d210eba"",
          ""userViewName"": ""山田 太郎""
        }
      ],
      ""organizationList"": [
        {
          ""organizationID"": ""4dce2f99-cb5d-44e3-baed-543115a1a91c"",
          ""organizationName"": ""組織01""
        }
      ]
    },
    ""readerMember"": {
      ""userList"": [],
      ""organizationList"": []
    },
    ""orderItemList"": [
      {
        ""itemID"": ""92a51904-d677-4b3d-a774-d0a852950778"",
        ""itemType"": ""text_single"",
        ""itemTextData"": {
          ""value"": ""テスト_20260722"",
          ""ruby"": null,
          ""datetimeTo"": null
        }
      },
      {
        ""itemID"": ""b5261a9d-63e0-439f-901b-0bc9c3e335af"",
        ""itemType"": ""client_single"",
        ""itemUuidDataList"": [
          {
            ""itemUuid"": ""388c6bd2-e8b5-4b7e-8ee9-02dcbbf34937"",
            ""itemDisplayValue"": ""テスト""
          }
        ]
      },
      {
        ""itemID"": ""7df90208-14a6-42b9-87e3-7cc1aee99869"",
        ""itemType"": ""toggle"",
        ""itemToggleData"": {
          ""value"": true,
          ""term"": 0
        }
      },
      {
        ""itemID"": ""357dd67c-46bf-49d5-83eb-3ad8d201f20e"",
        ""itemType"": ""inquiry_route_single"",
        ""itemInquiryRouteData"": {
          ""values"": [
            {
              ""inquiryRouteCategoryId"": ""b776132c-288c-4ccd-a4c9-cc24a87566e1"",
              ""inquiryRouteCategoryName"": ""テスト"",
              ""inquiryRouteId"": ""65a29a22-4198-4343-b4c9-1618d6b2abd4"",
              ""inquiryRouteName"": ""テスト01""
            }
          ]
        }
      },
      {
        ""itemID"": ""71657f77-19af-40aa-a574-0099f8299a35"",
        ""itemType"": ""phase"",
        ""itemSelectionData"": {
          ""values"": [
            3
          ]
        }
      },
      {
        ""itemID"": ""10b97b58-f032-4108-8426-8f7e77cca065"",
        ""itemType"": ""date"",
        ""itemTextData"": {
          ""value"": ""2026-10-01"",
          ""ruby"": null,
          ""datetimeTo"": null
        }
      },
      {
        ""itemID"": ""cd4c9a95-9e15-4900-9bf2-1eb139311b75"",
        ""itemType"": ""text_single"",
        ""itemTextData"": {
          ""value"": ""1211"",
          ""ruby"": null,
          ""datetimeTo"": null
        }
      },
      {
        ""itemID"": ""abaf7064-0eba-497c-a907-386a41ec71d3"",
        ""itemType"": ""datetime"",
        ""itemTextData"": {
          ""value"": ""2026-07-22T05:43:51Z"",
          ""ruby"": null,
          ""datetimeTo"": null
        }
      },
      {
        ""itemID"": ""c3fdda6a-9eb5-427b-af55-45037f3889dd"",
        ""itemType"": ""user_single"",
        ""itemUuidDataList"": [
          {
            ""itemUuid"": ""62ad9f89-8b34-4600-9b03-582e7d210eba"",
            ""itemDisplayValue"": ""山田 太郎""
          }
        ]
      },
      {
        ""itemID"": ""eda17357-f56a-4877-bdc3-1cd74d8fa4fa"",
        ""itemType"": ""user_multiple"",
        ""itemUuidDataList"": [
          {
            ""itemUuid"": ""62ad9f89-8b34-4600-9b03-582e7d210eba"",
            ""itemDisplayValue"": ""山田 太郎""
          },
          {
            ""itemUuid"": ""f156d2ab-0d93-4149-946d-0adbaaae9303"",
            ""itemDisplayValue"": ""佐藤 次郎""
          }
        ]
      },
      {
        ""itemID"": ""5d7dca4f-71fb-4b78-ba12-a95c9d9e08d0"",
        ""itemType"": ""division_single"",
        ""itemUuidDataList"": [
          {
            ""itemUuid"": ""4dce2f99-cb5d-44e3-baed-543115a1a91c"",
            ""itemDisplayValue"": ""組織01""
          }
        ]
      },
      {
        ""itemID"": ""2c5a87a7-08eb-420e-9af7-21df2a74a780"",
        ""itemType"": ""division_multiple"",
        ""itemUuidDataList"": [
          {
            ""itemUuid"": ""1b9d285b-6946-4144-b887-1182d245364e"",
            ""itemDisplayValue"": ""0629""
          },
          {
            ""itemUuid"": ""4dce2f99-cb5d-44e3-baed-543115a1a91c"",
            ""itemDisplayValue"": ""組織01""
          }
        ]
      },
      {
        ""itemID"": ""8fa7fbc6-e12d-468e-8205-aac9dbf025f6"",
        ""itemType"": ""datetime"",
        ""itemTextData"": {
          ""value"": ""2026-07-22T05:43:00Z"",
          ""ruby"": null,
          ""datetimeTo"": null
        }
      },
      {
        ""itemID"": ""10be3be2-9479-479d-b6b9-fc5dfce51f0d"",
        ""itemType"": ""date"",
        ""itemTextData"": {
          ""value"": ""2026-07-22"",
          ""ruby"": null,
          ""datetimeTo"": null
        }
      },
      {
        ""itemID"": ""9eb499d3-275f-4d98-ab48-808942165ddf"",
        ""itemType"": ""datetime"",
        ""itemTextData"": {
          ""value"": ""2026-07-23T05:43:00Z"",
          ""ruby"": null,
          ""datetimeTo"": null
        }
      }
    ],
    ""orderParticipantList"": [
      {
        ""clientID"": ""388c6bd2-e8b5-4b7e-8ee9-02dcbbf34937"",
        ""clientName"": ""テスト参加会社"",
        ""clientResponsibleID"": ""6f0cbf22-7e18-44a7-bbb5-ec6f7e6db830"",
        ""clientResponsibleName"": ""テスト参加者"",
        ""clientResponsibleRole"": 0,
        ""clientResponsibleRoleName"": null
      }
    ],
    ""proposalProductInfo"": {
      ""proposalProductSummaryInfo"": {
        ""flowSalesAmount"": 0,
        ""stockSalesAmount"": 1100000,
        ""flowCostPriceTotal"": 0,
        ""stockCostPriceTotal"": 1100,
        ""flowGrossProfitTotal"": 0,
        ""stockGrossProfitTotal"": 1098900
      },
      ""proposalProductInfoList"": [
        {
          ""proposalProductID"": ""26a2dedf-3d75-4ffd-8b06-0fe7b4ae360c"",
          ""productName"": ""テスト商品2"",
          ""productID"": ""c9393414-8008-4d91-ad07-d008b3cb65a6"",
          ""costPrice"": 100,
          ""salesPrice"": 100000,
          ""quantity"": 11,
          ""amount"": 1100000,
          ""discount"": 0,
          ""subTotal"": 1100000,
          ""subscriptionFlag"": true,
          ""subscriptionTerm"": 12,
          ""productDeleteFlag"": false
        }
      ]
    },
    ""systemLinkageInfoList"": null
  }
}

API 固有の終了コード

目次に戻る

案件アクティビティ一覧取得

APIの概要

テナント内の、案件に紐づく案件アクティビティの一覧リストを取得します。
パラメタのオフセットで開始位置を指定して、リミットで取得件数を指定して取得します。

リクエストボディ（JSON）

リクエスト例(JSON)

{
        ""param"": {
                ""requiredConditions"": {
                        ""orderID"": ""fd8e7875-782b-41c9-8291-c0ce178675d9"",
                        ""pagination"": {
                                ""offset"": 0,
                                ""limit"": 10
                        }
                }
        }
}

レスポンス JSON

レスポンス例(JSON)

{
  ""appStatus"": {
    ""code"": ""S000"",
    ""message"": """"
  },
  ""orderActivityListInfo"": {
    ""activityInfoList"": [
      {
        ""contentsKind"": ""MEMO"",
        ""dateTime"": ""2026-08-20T05:23:00Z"",
        ""actionKindName"": ""架電"",
        ""title"": ""テスト"",
        ""userID"": ""31fb9c3c-e8b2-4c1f-a3b3-a4f29a3566ed"",
        ""userViewName"": ""山田 太郎"",
        ""userDeleteFlag"": false
      },
      {
        ""contentsKind"": ""MEMO"",
        ""dateTime"": ""2026-08-06T02:00:42.529Z"",
        ""actionKindName"": ""21"",
        ""title"": ""SFA案件メモ"",
        ""userID"": ""31fb9c3c-e8b2-4c1f-a3b3-a4f29a3566ed"",
        ""userViewName"": ""山田 太郎"",
        ""userDeleteFlag"": false
      }
    ],
    ""getMoreFlag"": false
  }
}

API 固有の終了コード

追加取得フラグについて
レスポンスJSON の getMoreFlag が true である場合、取得最大件数を超えたため返却しきれなかった商品データが残っている事を示します。
本APIを下記のパラメータで実行することで、未取得となっている案件アクティビティリストの続きを取得することができます。

目次に戻る

レポートテンプレート一覧取得

APIの概要

テナント内のレポートのテンプレート一覧を取得します。
 

リクエストパラメタ

特に指定不要

レスポンス JSON

レスポンス例(JSON)

{
  ""appStatus"": {
    ""code"": ""S000"",
    ""message"": """"
  },
  ""reportTemplateListInfo"": {
    ""reportTemplateList"": [
      {
        ""templateID"": ""e9fa441c-b6b1-45b5-bfb5-8836f2cb4c8f"",
        ""templateName"": ""山田テスト""
      },
      {
        ""templateID"": ""e07e29e3-67dc-4c9f-b8b0-98a007b8e3d8"",
        ""templateName"": ""テスト用テンプレート""
      }
    ]
  }
}						

API 固有の終了コード

目次に戻る

レポートテンプレート取得

APIの概要

テナント内のレポートのテンプレートデータを取得します。
レスポンスで返されるレポートテンプレートデータは、KS+の管理者画面のレポートテンプレート編集画面で編集・更新した内容（未編集の場合は契約・開通またはテンプレート新規追加時に自動で初期設定されたレポートテンプレートのデフォルト項目の内容）が返されます。
 

リクエストパラメタ

レスポンス JSON

レスポンス例(JSON)

{
  ""appStatus"": {
    ""code"": ""S000"",
    ""message"": """"
  },
  ""reportTemplateInfo"": {
    ""templateList"": [
      {
        ""itemID"": ""d7efeaf0-51c6-4ec9-908c-3f84e84603db"",
        ""itemType"": ""text_single"",
        ""itemName"": ""レポート名"",
        ""requiredFlag"": true,
        ""beforeUnit"": null,
        ""afterUnit"": null,
        ""readOnlyFlag"": false,
        ""selectionValues"": [],
        ""linkageSelectionValues"": []
      },
      {
        ""itemID"": ""3d9981ec-afed-4bfe-bbe2-cd034a2df92c"",
        ""itemType"": ""date"",
        ""itemName"": ""報告日"",
        ""requiredFlag"": true,
        ""beforeUnit"": null,
        ""afterUnit"": null,
        ""readOnlyFlag"": true,
        ""selectionValues"": [],
        ""linkageSelectionValues"": []
      },
      {
        ""itemID"": ""081bc161-6ab5-4859-9d89-2190ee48bbb1"",
        ""itemType"": ""user_single"",
        ""itemName"": ""報告者"",
        ""requiredFlag"": true,
        ""beforeUnit"": null,
        ""afterUnit"": null,
        ""readOnlyFlag"": true,
        ""selectionValues"": [],
        ""linkageSelectionValues"": []
      },
      {
        ""itemID"": ""506a5039-a5ee-416e-b4ff-a25cae559c3c"",
        ""itemType"": ""datetime_fromto"",
        ""itemName"": ""活動日時"",
        ""requiredFlag"": true,
        ""beforeUnit"": null,
        ""afterUnit"": null,
        ""readOnlyFlag"": false,
        ""selectionValues"": [],
        ""linkageSelectionValues"": []
      },
      {
        ""itemID"": ""5c690489-463c-4ee0-a43d-3d389dd62d29"",
        ""itemType"": ""division_single"",
        ""itemName"": ""報告者所属部署"",
        ""requiredFlag"": true,
        ""beforeUnit"": null,
        ""afterUnit"": null,
        ""readOnlyFlag"": false,
        ""selectionValues"": [],
        ""linkageSelectionValues"": []
      },
      {
        ""itemID"": ""3c2e6448-0088-4b3d-8cef-a4cb6a8d0a02"",
        ""itemType"": ""user_multiple"",
        ""itemName"": ""同行者"",
        ""requiredFlag"": false,
        ""beforeUnit"": null,
        ""afterUnit"": null,
        ""readOnlyFlag"": false,
        ""selectionValues"": [],
        ""linkageSelectionValues"": []
      },
      {
        ""itemID"": ""6084c371-9f03-482d-a430-4065bd0d0f83"",
        ""itemType"": ""action_kind"",
        ""itemName"": ""アクション種別"",
        ""requiredFlag"": false,
        ""beforeUnit"": null,
        ""afterUnit"": null,
        ""readOnlyFlag"": false,
        ""selectionValues"": [],
        ""linkageSelectionValues"": []
      },
      {
        ""itemID"": ""1494a1f1-1280-4e9f-9262-65d247628aa7"",
        ""itemType"": ""text_multiple"",
        ""itemName"": ""報告内容"",
        ""requiredFlag"": true,
        ""beforeUnit"": null,
        ""afterUnit"": null,
        ""readOnlyFlag"": false,
        ""selectionValues"": [],
        ""linkageSelectionValues"": []
      },
      {
        ""itemID"": ""7a905396-224b-4ea0-82da-ad9bbe856158"",
        ""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"": ""微妙"",
            ""displayFlag"": true,
            ""value"": 4
          },
          {
            ""label"": ""厳しい"",
            ""displayFlag"": true,
            ""value"": 5
          },
          {
            ""label"": ""全然ダメ"",
            ""displayFlag"": true,
            ""value"": 6
          }
        ],
        ""linkageSelectionValues"": []
      },
      {
        ""itemID"": ""86a05dcc-f6fd-4874-90cd-0db449177615"",
        ""itemType"": ""pulldown"",
        ""itemName"": ""選択肢3個"",
        ""requiredFlag"": false,
        ""beforeUnit"": null,
        ""afterUnit"": null,
        ""readOnlyFlag"": false,
        ""selectionValues"": [
          {
            ""label"": ""選択肢1"",
            ""displayFlag"": true,
            ""value"": 1
          },
          {
            ""label"": ""選択肢2"",
            ""displayFlag"": true,
            ""value"": 2
          },
          {
            ""label"": ""選択肢3"",
            ""displayFlag"": true,
            ""value"": 3
          }
        ],
        ""linkageSelectionValues"": []
      },
      {
        ""itemID"": ""20134d76-7eac-4aa1-aac1-b1e179aec42b"",
        ""itemType"": ""participants"",
        ""itemName"": ""参加"",
        ""requiredFlag"": false,
        ""beforeUnit"": null,
        ""afterUnit"": null,
        ""readOnlyFlag"": false,
        ""selectionValues"": [],
        ""linkageSelectionValues"": []
      }
    ],
    ""actionKindInfo"": {
      ""actionKindList"": [
        {
          ""actionKindID"": ""0096fbb6-0cf0-468b-9962-a9fa9b6d2211"",
          ""actionKindName"": ""商談""
        },
        {
          ""actionKindID"": ""96d7216a-fd86-479b-aafc-e5b8f18991be"",
          ""actionKindName"": ""架電""
        }
      ]
    },
    ""systemLinkageSettingInfoList"": [
      {
        ""systemLinkageID"": 999000001,
        ""linkageSystemName"": ""test""
      },
      {
        ""systemLinkageID"": 999000002,
        ""linkageSystemName"": ""test2""
      }
    ]
  }
}

API 固有の終了コード

目次に戻る

レポート一覧取得

APIの概要

テナント内の、ユーザー自身が参照・更新可能となっているレポートデータを一覧リストとして取得します。
パラメタのオフセットで開始位置を指定して、リミットで取得件数を指定して取得します。
オプションでレポートのレポート名など、レポートの基本項目を検索条件として指定して検索して一覧取得も可能です。

リクエストボディ（JSON）

リクエスト例(JSON)

{
        ""param"": {
                ""requiredConditions"": {
                        ""pagination"": {
                                ""offset"": 0,
                                ""limit"": 10
                        }
                },
                ""optionalConditions"": {
                        ""searchConditions"": {
                                ""reportName"": ""テスト""
                        }
                }
        }
}														

レスポンス JSON

レスポンス例(JSON)

{
  ""appStatus"": {
    ""code"": ""S000"",
    ""message"": """"
  },
  ""reportListInfo"": {
    ""reportList"": [
      {
        ""reportID"": ""21243bdf-179a-4cbc-9cef-99a7ac9a4c4f"",
        ""reportName"": ""テストレポート"",
        ""reportTemplateID"": ""3c0e2183-1621-4534-9cf1-1ff955238bcf"",
        ""reportTemplateName"": """",
        ""systemLinkageInfoList"": null
      },
      {
        ""reportID"": ""26ead594-a8bc-4adc-a66e-294764d67775"",
        ""reportName"": ""山田テストレポート080701"",
        ""reportTemplateID"": ""e9fa441c-b6b1-45b5-bfb5-8836f2cb4c8f"",
        ""reportTemplateName"": ""山田テスト0807"",
        ""systemLinkageInfoList"": null
      }
    ],
    ""getMoreFlag"": true
  }
}

API 固有の終了コード

追加取得フラグについて
レスポンスJSON の getMoreFlag が true である場合、取得最大件数を超えたため返却しきれなかった商品データが残っている事を示します。
本APIを下記のパラメータで実行することで、未取得となっているレポートリストの続きを取得することができます。

目次に戻る

レポート詳細取得

APIの概要

パラメタのレポートIDに対応するレポートの詳細データを取得します。レポート登録・更新で登録されたレポートの項目データを詳細データとして取得します。

リクエストボディ（JSON）

リクエスト例(JSON)

{
        ""param"": {
                ""reportID"": ""1b5f1a9a-3954-4495-b9c1-370b41297961""
        }
}

レスポンス JSON

レスポンス例(JSON)

{
  ""appStatus"": {
    ""code"": ""S000"",
    ""message"": """"
  },
  ""reportDetailInfo"": {
    ""draftFlag"": false,
    ""participantMember"": {
      ""userList"": [
        {
          ""userID"": ""c84aa9a5-1390-41a4-9786-7cda5fd9971f"",
          ""userViewName"": ""山田 太郎""
        },
        {
          ""userID"": ""ce88555d-46fd-42dd-ad2e-26490a593015"",
          ""userViewName"": ""佐藤 次郎""
        }
      ],
      ""organizationList"": []
    },
    ""readerMember"": {
      ""userList"": [],
      ""organizationList"": []
    },
    ""reportItemList"": [
      {
        ""itemID"": ""3d9981ec-afed-4bfe-bbe2-cd034a2df92c"",
        ""itemType"": ""date"",
        ""itemTextData"": {
          ""value"": ""2026-07-24"",
          ""ruby"": null,
          ""datetimeTo"": null
        }
      },
      {
        ""itemID"": ""d7efeaf0-51c6-4ec9-908c-3f84e84603db"",
        ""itemType"": ""text_single"",
        ""itemTextData"": {
          ""value"": ""レポート名_テスト"",
          ""ruby"": null,
          ""datetimeTo"": null
        }
      },
      {
        ""itemID"": ""506a5039-a5ee-416e-b4ff-a25cae559c3c"",
        ""itemType"": ""datetime_fromto"",
        ""itemTextData"": {
          ""value"": ""2026-06-30T01:00:00Z"",
          ""ruby"": null,
          ""datetimeTo"": ""2026-06-30T10:00:00Z""
        }
      },
      {
        ""itemID"": ""6084c371-9f03-482d-a430-4065bd0d0f83"",
        ""itemType"": ""action_kind"",
        ""itemUuidDataList"": [
          {
            ""itemUuid"": ""3fa85f64-5717-4562-b3fc-2c963f66a080"",
            ""itemDisplayValue"": ""80""
          }
        ]
      },
      {
        ""itemID"": ""7a905396-224b-4ea0-82da-ad9bbe856158"",
        ""itemType"": ""pulldown"",
        ""itemSelectionData"": {
          ""values"": [
            5
          ]
        }
      },
      {
        ""itemID"": ""1494a1f1-1280-4e9f-9262-65d247628aa7"",
        ""itemType"": ""text_multiple"",
        ""itemTextData"": {
          ""value"": ""報告内容\nアイウエオ"",
          ""ruby"": null,
          ""datetimeTo"": null
        }
      },
      {
        ""itemID"": ""081bc161-6ab5-4859-9d89-2190ee48bbb1"",
        ""itemType"": ""user_single"",
        ""itemUuidDataList"": [
          {
            ""itemUuid"": ""c84aa9a5-1390-41a4-9786-7cda5fd9971f"",
            ""itemDisplayValue"": ""山田 太郎""
          }
        ]
      },
      {
        ""itemID"": ""5c690489-463c-4ee0-a43d-3d389dd62d29"",
        ""itemType"": ""division_single"",
        ""itemUuidDataList"": [
          {
            ""itemUuid"": ""ba8482ef-8c08-4f3c-b5e2-aded302feecd"",
            ""itemDisplayValue"": ""新組織""
          }
        ]
      },
      {
        ""itemID"": ""3c2e6448-0088-4b3d-8cef-a4cb6a8d0a02"",
        ""itemType"": ""user_multiple"",
        ""itemUuidDataList"": [
          {
            ""itemUuid"": ""c84aa9a5-1390-41a4-9786-7cda5fd9971f"",
            ""itemDisplayValue"": ""山田 太郎""
          }
        ]
      },
      {
        ""itemID"": ""357d2eec-222a-491b-80bf-7d732467934c"",
        ""itemType"": ""linkage_pulldown"",
        ""itemSelectionData"": {
          ""values"": [
            2,
            14
          ]
        }
      },
      {
        ""itemID"": ""1a7d745b-492c-4248-b0e9-555506ac3ce9"",
        ""itemType"": ""checkbox"",
        ""itemSelectionData"": {
          ""values"": [
            2,
            4
          ]
        }
      },
      {
        ""itemID"": ""83143cea-0d07-4a1f-be16-9f72ddcf3c55"",
        ""itemType"": ""division_single"",
        ""itemUuidDataList"": [
          {
            ""itemUuid"": ""ba8482ef-8c08-4f3c-b5e2-aded302feecd"",
            ""itemDisplayValue"": ""新組織""
          }
        ]
      },
      {
        ""itemID"": ""a9613a60-5ed1-4a82-9e5f-c7c26c69e4fc"",
        ""itemType"": ""division_multiple"",
        ""itemUuidDataList"": [
          {
            ""itemUuid"": ""8142b05d-ef7c-4dc5-9d12-1567dbec53e7"",
            ""itemDisplayValue"": ""開発部""
          },
          {
            ""itemUuid"": ""ba8482ef-8c08-4f3c-b5e2-aded302feecd"",
            ""itemDisplayValue"": ""新組織""
          }
        ]
      },
      {
        ""itemID"": ""9809c29a-309f-4e72-a6ca-4eb435406c5a"",
        ""itemType"": ""product_single"",
        ""itemUuidDataList"": [
          {
            ""itemUuid"": ""a0e6142f-b367-461c-a80e-366a3eecc091"",
            ""itemDisplayValue"": ""商品名_アイウエオ""
          }
        ]
      },
      {
        ""itemID"": ""3c4427e2-441b-4d12-8bd2-bb425095d417"",
        ""itemType"": ""product_multiple"",
        ""itemUuidDataList"": [
          {
            ""itemUuid"": ""a0e6142f-b367-461c-a80e-366a3eecc091"",
            ""itemDisplayValue"": ""商品名_アイウエオ""
          }
        ]
      },
      {
        ""itemID"": ""c143c12b-aa56-457a-aca1-342053ad5682"",
        ""itemType"": ""date"",
        ""itemTextData"": {
          ""value"": ""2026-06-30"",
          ""ruby"": null,
          ""datetimeTo"": null
        }
      },
      {
        ""itemID"": ""e943f9c3-5e18-4ac6-8107-e484475489ca"",
        ""itemType"": ""datetime"",
        ""itemTextData"": {
          ""value"": ""2026-06-30T03:00:00Z"",
          ""ruby"": null,
          ""datetimeTo"": null
        }
      },
      {
        ""itemID"": ""5b01681e-beb3-4c8a-b708-d1179b8f330c"",
        ""itemType"": ""amount_integer"",
        ""itemNumericData"": {
          ""value"": ""1100""
        }
      },
      {
        ""itemID"": ""98ba3706-0bee-4fa8-9b49-e053f158ed87"",
        ""itemType"": ""amount_decimal"",
        ""itemNumericData"": {
          ""value"": ""11000.11""
        }
      },
      {
        ""itemID"": ""c7ff3033-5476-4f16-919b-2e3e2a6947bc"",
        ""itemType"": ""number"",
        ""itemNumericData"": {
          ""value"": ""110""
        }
      },
      {
        ""itemID"": ""de046b39-38d5-4780-b6c1-dd1301eb6079"",
        ""itemType"": ""phone_number"",
        ""itemTextData"": {
          ""value"": ""090-0010-0013"",
          ""ruby"": null,
          ""datetimeTo"": null
        }
      },
      {
        ""itemID"": ""d8a9f125-c28b-4e2b-9493-54f13d143a61"",
        ""itemType"": ""url"",
        ""itemTextData"": {
          ""value"": ""https://example.com/?no=11"",
          ""ruby"": null,
          ""datetimeTo"": null
        }
      },
      {
        ""itemID"": ""8476e729-76a3-40a3-bc64-f9401744d8d0"",
        ""itemType"": ""mail_address"",
        ""itemTextData"": {
          ""value"": ""test.11@example.com"",
          ""ruby"": null,
          ""datetimeTo"": null
        }
      },
      {
        ""itemID"": ""e6644461-b0a9-499e-8496-53d3ea23a505"",
        ""itemType"": ""postal_code"",
        ""itemTextData"": {
          ""value"": ""330-9301"",
          ""ruby"": null,
          ""datetimeTo"": null
        }
      },
      {
        ""itemID"": ""629e5d45-eea9-46c2-ad78-f2be824f07cd"",
        ""itemType"": ""prefectures"",
        ""itemTextData"": {
          ""value"": ""埼玉県"",
          ""ruby"": null,
          ""datetimeTo"": null
        }
      }
    ],
    ""participantsInfoList"": [
      {
        ""clientResponsibleID"": ""626c500d-b6e9-4b46-a11f-87a98783b1fb"",
        ""clientResponsibleName"": ""姓アイウエオ 名アイウエオ"",
        ""clientResponsibleDeleteFlag"": false,
        ""clientResponsibleDepartment"": ""部署_アイウエオ"",
        ""clientResponsibleTitle"": null,
        ""clientID"": ""23abdb85-2541-4017-a21c-286b4bef0abf"",
        ""clientName"": ""取引先正式名称_アイウエオ"",
        ""clientDeleteFlag"": false
      }
    ],
    ""linkingOrderInfoList"": [
      {
        ""orderID"": ""dd5cd265-71bc-42cd-85e9-feaeef427066"",
        ""orderName"": ""案件名_アイウエオ_更新"",
        ""clientID"": ""23abdb85-2541-4017-a21c-286b4bef0abf"",
        ""clientName"": ""取引先正式名称_アイウエオ"",
        ""phaseName"": ""クロージング"",
        ""orderAcceptanceProspect"": ""A"",
        ""orderAcceptanceDueDate"": ""2026-06-30T00:00:00Z"",
        ""flowSalesAmount"": 0,
        ""stockSalesAmount"": 219900.22
      }
    ],
    ""systemLinkageInfoList"": null
  }
}

API 固有の終了コード

目次に戻る

レポートコメント一覧取得

APIの概要

テナント内の、レポートに紐づくレポートコメントデータを一覧リストとして取得します。
パラメタのオフセットで開始位置を指定して、リミットで取得件数を指定して取得します。

リクエストボディ（JSON）

リクエスト例(JSON)

{
        ""param"": {
                ""requiredConditions"": {
                        ""reportID"": ""bbf5441d-eb59-4e16-8513-c86ecf549173"",
                        ""pagination"": {
                                ""offset"": 0,
                                ""limit"": 10
                        }
                }
        }
}

レスポンス JSON

レスポンス例(JSON)

{
  ""appStatus"": {
    ""code"": ""S000"",
    ""message"": """"
  },
 ""reportCommentListInfo"": {
  ""reportCommentList"": [
   {
    ""reportCommentID"": ""27bebbc9-0158-4b43-b4ba-dd3dfef5878f"",
    ""commentUserID"": ""c84aa9a5-1390-41a4-9786-7cda5fd9971f"",
    ""commentUserName"": ""山田 太郎"",
    ""commentUserDeleteFlag"": false,
    ""commentDateTime"": ""2026-09-25T10:02:40.796034562Z"",
    ""commentContent"": ""テストコメント2""
   },
   {
    ""reportCommentID"": ""4dd05769-7175-4370-b7fa-bf399f8273f7"",
    ""commentUserID"": ""ce88555d-46fd-42dd-ad2e-26490a593015"",
    ""commentUserName"": ""佐藤 次郎"",
    ""commentUserDeleteFlag"": false,
    ""commentDateTime"": ""2026-09-25T10:02:24.096421764Z"",
    ""commentContent"": ""テストコメント""
   }
  ],
  ""getMoreFlag"": false
 }
}

API 固有の終了コード

追加取得フラグについて
レスポンスJSON の getMoreFlag が true である場合、取得最大件数を超えたため返却しきれなかったレポートコメントデータが残っている事を示します。
本APIを下記のパラメータで実行することで、未取得となっているレポートコメントリストの続きを取得することができます。

目次に戻る

実行系API

商品登録

APIの概要

テナント内のデータとして商品データを登録します。
登録対象の商品項目データを項目リストに指定して登録します。
登録成功時に、レスポンスで登録した商品の商品IDが返されます。

リクエストボディ（JSON）

リクエストパラメタについての補足事項

①入力値のバリデーションチェックについて
　パラメタで指定する登録値については、登録時にバリデーションチェックを行い、エラーの場合はバリデーションエラーとなります。
　バリデーションチェックの内容は、項目タイプ（itemType）により異なり、下記シートに記載のチェックを項目タイプ別に実施します。
　項目タイプ値および項目タイプの説明

②必須項目チェックについて
　商品テンプレート項目の設定で必須となっている（必須フラグがtrueとなっている）項目については、登録対象項目リストに含まれていない場合にパラメタ不正エラーとなります。
　商品テンプレートの項目情報については、商品テンプレート取得APIのデータより確認可能です。

リクエスト例(JSON)

{
        ""param"": {
                ""toData"": {
                        ""productRegisterInfo"": {
                                ""systemLinkageInfoList"": [
                                        {
                                                ""systemLinkageID"": 999000001,
                                                ""linkageIDValue"": ""test_20260904_02""
                                        }
                                ],
                                ""productItemList"": [
                                        {
                                                ""itemID"": ""783fcf8e-01f9-489a-98ef-3a147c7b920c"",
                                                ""itemType"": ""text_single"",
                                                ""itemTextData"": {
                                                        ""value"": ""テスト_外部連携_TEST2"",
                                                        ""ruby"": """",
                                                        ""datetimeTo"": """"
                                                }
                                        },
                                        {
                                                ""itemID"": ""86330dff-b4db-46d5-adce-4372319e41e4"",
                                                ""itemType"": ""toggle"",
                                                ""itemToggleData"": {
                                                        ""value"": true
                                                }
                                        },
                                        {
                                                ""itemID"": ""23908c8e-ab4b-415a-a9a9-f8e0f2a5f0f6"",
                                                ""itemType"": ""amount_decimal"",
                                                ""itemNumericData"": {
                                                        ""value"": ""100000""
                                                }
                                        },
                                        {
                                                ""itemID"": ""139f91ba-8e84-44e7-aa02-857989f6695d"",
                                                ""itemType"": ""text_multiple"",
                                                ""itemTextData"": {
                                                        ""value"": ""test"",
                                                        ""ruby"": """",
                                                        ""datetimeTo"": """"
                                                }
                                        },
                                        {
                                                ""itemID"": ""0b2dc74b-8be3-48a5-adbc-c8711ad77ca0"",
                                                ""itemType"": ""linkage_pulldown"",
                                                ""itemSelectionData"": {
                                                        ""values"": [
                                                                1,
                                                                3,
                                                                4
                                                        ]
                                                }
                                        },
                                        {
                                                ""itemID"": ""580dcc22-f7f3-4594-9b7e-dabda3601fa1"",
                                                ""itemType"": ""amount_decimal"",
                                                ""itemNumericData"": {
                                                        ""value"": ""100""
                                                }
                                        },
                                        {
                                                ""itemID"": ""182318ed-f42b-4e21-947d-73f58a9989d3"",
                                                ""itemType"": ""text_single"",
                                                ""itemTextData"": {
                                                        ""value"": ""test"",
                                                        ""ruby"": """",
                                                        ""datetimeTo"": """"
                                                }
                                        },
                                        {
                                                ""itemID"": ""176b1aad-1c48-4c1b-8e82-985de2ba9225"",
                                                ""itemType"": ""subscription"",
                                                ""itemToggleData"": {
                                                        ""value"": false
                                                }
                                        },
                                        {
                                                ""itemID"": ""5321eaf2-a1af-4c9a-9150-77d3a19cc0ac"",
                                                ""itemType"": ""url"",
                                                ""itemTextData"": {
                                                        ""value"": ""http://ex.com"",
                                                        ""ruby"": """",
                                                        ""datetimeTo"": """"
                                                }
                                        },
                                        {
                                                ""itemID"": ""2dd479d5-2066-4807-8b51-67ddd1e830a1"",
                                                ""itemType"": ""pulldown"",
                                                ""itemSelectionData"": {
                                                        ""values"": [
                                                                1
                                                        ]
                                                }
                                        },
                                        {
                                                ""itemID"": ""714b5b83-2df3-4e26-97f0-831b157a4ea7"",
                                                ""itemType"": ""text_single"",
                                                ""itemTextData"": {
                                                        ""value"": ""test"",
                                                        ""ruby"": """",
                                                        ""datetimeTo"": """"
                                                }
                                        },
                                        {
                                                ""itemID"": ""f8ae186f-f4b1-4ab1-8d35-bf7c8369b01c"",
                                                ""itemType"": ""text_single"",
                                                ""itemTextData"": {
                                                        ""value"": ""test"",
                                                        ""ruby"": """",
                                                        ""datetimeTo"": """"
                                                }
                                        },
                                        {
                                                ""itemID"": ""953e7157-9215-42d8-9de5-b01afef26e5b"",
                                                ""itemType"": ""text_multiple"",
                                                ""itemTextData"": {
                                                        ""value"": ""test"",
                                                        ""ruby"": """",
                                                        ""datetimeTo"": """"
                                                }
                                        },
                                        {
                                                ""itemID"": ""7b1de9ce-095a-496f-8830-cb6839415ad6"",
                                                ""itemType"": ""pulldown"",
                                                ""itemSelectionData"": {
                                                        ""values"": [
                                                                1
                                                        ]
                                                }
                                        },
                                        {
                                                ""itemID"": ""fc48bffc-4639-4e7f-bd72-72d1b94d026f"",
                                                ""itemType"": ""linkage_pulldown"",
                                                ""itemSelectionData"": {
                                                        ""values"": [
                                                                1,
                                                                4,
                                                                6
                                                        ]
                                                }
                                        },
                                        {
                                                ""itemID"": ""51b86754-0515-47c1-a797-23a0d34b1ba2"",
                                                ""itemType"": ""checkbox"",
                                                ""itemSelectionData"": {
                                                        ""values"": [
                                                                1,
                                                                2
                                                        ]
                                                }
                                        },
                                        {
                                                ""itemID"": ""bffff0e3-9dc8-4592-91e5-16c47ea31a44"",
                                                ""itemType"": ""user_single"",
                                                ""itemUuidData"": {
                                                        ""values"": [
                                                                ""62ad9f89-8b34-4600-9b03-582e7d210eba""
                                                        ]
                                                }
                                        },
                                        {
                                                ""itemID"": ""8dc45454-6fbe-4b7f-8e4d-7c9ab36901c2"",
                                                ""itemType"": ""user_multiple"",
                                                ""itemUuidData"": {
                                                        ""values"": [
                                                                ""62ad9f89-8b34-4600-9b03-582e7d210eba""
                                                        ]
                                                }
                                        },
                                        {
                                                ""itemID"": ""91cdcb3c-e868-43ee-98b1-aece0439d6bb"",
                                                ""itemType"": ""division_single"",
                                                ""itemUuidData"": {
                                                        ""values"": [
                                                                ""4dce2f99-cb5d-44e3-baed-543115a1a91c""
                                                        ]
                                                }
                                        },
                                        {
                                                ""itemID"": ""e1648d20-ed36-46be-93e8-952e00f68c5b"",
                                                ""itemType"": ""division_multiple"",
                                                ""itemUuidData"": {
                                                        ""values"": [
                                                                ""4dce2f99-cb5d-44e3-baed-543115a1a91c""
                                                        ]
                                                }
                                        },
                                        {
                                                ""itemID"": ""30881d96-2cbc-4ad2-923e-b53b22c5d826"",
                                                ""itemType"": ""date"",
                                                ""itemTextData"": {
                                                        ""value"": ""2026-07-15"",
                                                        ""ruby"": """",
                                                        ""datetimeTo"": """"
                                                }
                                        },
                                        {
                                                ""itemID"": ""0d9a3264-4193-48d6-b7c3-0b3841aeaaa0"",
                                                ""itemType"": ""datetime"",
                                                ""itemTextData"": {
                                                        ""value"": ""2026-07-15T04:51:00Z"",
                                                        ""ruby"": """",
                                                        ""datetimeTo"": """"
                                                }
                                        },
                                        {
                                                ""itemID"": ""d9ed7281-a13b-4128-9970-56a12b3c44a6"",
                                                ""itemType"": ""amount_decimal"",
                                                ""itemNumericData"": {
                                                        ""value"": ""100000""
                                                }
                                        },
                                        {
                                                ""itemID"": ""80a5ef34-0c89-472e-8005-5361f79c9f5d"",
                                                ""itemType"": ""amount_integer"",
                                                ""itemNumericData"": {
                                                        ""value"": ""100000""
                                                }
                                        },
                                        {
                                                ""itemID"": ""d44c5767-4a6e-43c2-808e-4dd4f73adf65"",
                                                ""itemType"": ""number"",
                                                ""itemNumericData"": {
                                                        ""value"": ""1""
                                                }
                                        },
                                        {
                                                ""itemID"": ""1b9fa4d7-a137-494b-a236-1a0bb799dcde"",
                                                ""itemType"": ""phone_number"",
                                                ""itemTextData"": {
                                                        ""value"": ""000000000"",
                                                        ""ruby"": """",
                                                        ""datetimeTo"": """"
                                                }
                                        },
                                        {
                                                ""itemID"": ""f081b73b-9825-40de-a568-e4ebcce77cf3"",
                                                ""itemType"": ""url"",
                                                ""itemTextData"": {
                                                        ""value"": ""http://ex.com"",
                                                        ""ruby"": """",
                                                        ""datetimeTo"": """"
                                                }
                                        },
                                        {
                                                ""itemID"": ""21fc9919-8fcd-41af-87d4-24397953c69f"",
                                                ""itemType"": ""postal_code"",
                                                ""itemTextData"": {
                                                        ""value"": ""1111111"",
                                                        ""ruby"": """",
                                                        ""datetimeTo"": """"
                                                }
                                        },
                                        {
                                                ""itemID"": ""0daca4d2-ba59-4455-ab81-f991150b84e7"",
                                                ""itemType"": ""mail_address"",
                                                ""itemTextData"": {
                                                        ""value"": ""test@test.com"",
                                                        ""ruby"": """",
                                                        ""datetimeTo"": """"
                                                }
                                        },
                                        {
                                                ""itemID"": ""fd5081ac-e48c-4aa0-9251-f977efadb51a"",
                                                ""itemType"": ""linkage_pulldown"",
                                                ""itemSelectionData"": {
                                                        ""values"": [
                                                                1
                                                        ]
                                                }
                                        }
                                ]
                        }
                }
        }
}

レスポンス JSON

レスポンス例(JSON)

{
  "appStatus": {
    "code": "S000",
    "message": ""
  },
  "registerProductResult": {
    "productID": "1f8cc493-1b3e-4c08-9bdc-c47e76f64287"
  }
}

API 固有の終了コード

目次に戻る

商品更新

APIの概要

テナント内の商品データを更新します。更新対象の商品項目データを項目リストに指定して更新します。
更新については項目リストに設定されたデータをもとに差分更新で更新します。
更新成功時に、レスポンスで更新した商品の商品IDが返されます。

リクエストボディ（JSON）

※1
productInfo、systemLinkageInfoのいずれかのみ必須。両方指定されている場合はエラー。
productInfoが指定された時はproductIDをキーに、systemLinkageInfoが指定された時はsystemLinkageID, linkageIDValueをキーにして更新。
 

リクエストパラメタについての補足事項

①入力値のバリデーションチェックについて
　パラメタで指定する更新値については、更新時にバリデーションチェックを行い、エラーの場合はバリデーションエラーとなります。
　バリデーションチェックの内容は、項目タイプ（itemType）により異なり、下記シートに記載のチェックを項目タイプ別に実施します。
　項目タイプ値および項目タイプの説明

リクエスト例(JSON)※商品情報で更新

{
        ""param"": {
                ""toData"": {
                        ""productUpdateInfo"": {
                                ""productInfo"": {
                                        ""productID"": ""1f8cc493-1b3e-4c08-9bdc-c47e76f64287""
                                },
                                ""productItemList"": [
                                        {
                                                ""itemID"": ""783fcf8e-01f9-489a-98ef-3a147c7b920c"",
                                                ""itemType"": ""text_single"",
                                                ""itemTextData"": {
                                                        ""value"": ""テスト_外部連携02_upd"",
                                                        ""ruby"": """",
                                                        ""datetimeTo"": """"
                                                }
                                        },
                                        {
                                                ""itemID"": ""86330dff-b4db-46d5-adce-4372319e41e4"",
                                                ""itemType"": ""toggle"",
                                                ""itemToggleData"": {
                                                        ""value"": true
                                                }
                                        },
                                        {
                                                ""itemID"": ""23908c8e-ab4b-415a-a9a9-f8e0f2a5f0f6"",
                                                ""itemType"": ""amount_decimal"",
                                                ""itemNumericData"": {
                                                        ""value"": ""1100000""
                                                }
                                        },
                                        {
                                                ""itemID"": ""139f91ba-8e84-44e7-aa02-857989f6695d"",
                                                ""itemType"": ""text_multiple"",
                                                ""itemTextData"": {
                                                        ""value"": ""test1"",
                                                        ""ruby"": """",
                                                        ""datetimeTo"": """"
                                                }
                                        },
                                        {
                                                ""itemID"": ""0b2dc74b-8be3-48a5-adbc-c8711ad77ca0"",
                                                ""itemType"": ""linkage_pulldown"",
                                                ""itemSelectionData"": {
                                                        ""values"": [
                                                                1,
                                                                3,
                                                                4
                                                        ]
                                                }
                                        },
                                        {
                                                ""itemID"": ""580dcc22-f7f3-4594-9b7e-dabda3601fa1"",
                                                ""itemType"": ""amount_decimal"",
                                                ""itemNumericData"": {
                                                        ""value"": ""1100""
                                                }
                                        },
                                        {
                                                ""itemID"": ""176b1aad-1c48-4c1b-8e82-985de2ba9225"",
                                                ""itemType"": ""subscription"",
                                                ""itemToggleData"": {
                                                        ""value"": true,
                                                        ""term"": ""12""
                                                }
                                        },
                                        {
                                                ""itemID"": ""5321eaf2-a1af-4c9a-9150-77d3a19cc0ac"",
                                                ""itemType"": ""url"",
                                                ""itemTextData"": {
                                                        ""value"": ""http://ex.com1"",
                                                        ""ruby"": """",
                                                        ""datetimeTo"": """"
                                                }
                                        },
                                        {
                                                ""itemID"": ""2dd479d5-2066-4807-8b51-67ddd1e830a1"",
                                                ""itemType"": ""pulldown"",
                                                ""itemSelectionData"": {
                                                        ""values"": [
                                                                1
                                                        ]
                                                }
                                        },
                                        {
                                                ""itemID"": ""953e7157-9215-42d8-9de5-b01afef26e5b"",
                                                ""itemType"": ""text_multiple"",
                                                ""itemTextData"": {
                                                        ""value"": ""test1"",
                                                        ""ruby"": """",
                                                        ""datetimeTo"": """"
                                                }
                                        },
                                        {
                                                ""itemID"": ""fc48bffc-4639-4e7f-bd72-72d1b94d026f"",
                                                ""itemType"": ""linkage_pulldown"",
                                                ""itemSelectionData"": {
                                                        ""values"": [
                                                                1,
                                                                4,
                                                                6
                                                        ]
                                                }
                                        },
                                        {
                                                ""itemID"": ""51b86754-0515-47c1-a797-23a0d34b1ba2"",
                                                ""itemType"": ""checkbox"",
                                                ""itemSelectionData"": {
                                                        ""values"": [
                                                                1,
                                                                2
                                                        ]
                                                }
                                        },
                                        {
                                                ""itemID"": ""bffff0e3-9dc8-4592-91e5-16c47ea31a44"",
                                                ""itemType"": ""user_single"",
                                                ""itemUuidData"": {
                                                        ""values"": [
                                                                ""62ad9f89-8b34-4600-9b03-582e7d210eba""
                                                        ]
                                                }
                                        },
                                        {
                                                ""itemID"": ""8dc45454-6fbe-4b7f-8e4d-7c9ab36901c2"",
                                                ""itemType"": ""user_multiple"",
                                                ""itemUuidData"": {
                                                        ""values"": [
                                                                ""62ad9f89-8b34-4600-9b03-582e7d210eba""
                                                        ]
                                                }
                                        },
                                        {
                                                ""itemID"": ""91cdcb3c-e868-43ee-98b1-aece0439d6bb"",
                                                ""itemType"": ""division_single"",
                                                ""itemUuidData"": {
                                                        ""values"": [
                                                                ""4dce2f99-cb5d-44e3-baed-543115a1a91c""
                                                        ]
                                                }
                                        },
                                        {
                                                ""itemID"": ""e1648d20-ed36-46be-93e8-952e00f68c5b"",
                                                ""itemType"": ""division_multiple"",
                                                ""itemUuidData"": {
                                                        ""values"": [
                                                                ""4dce2f99-cb5d-44e3-baed-543115a1a91c""
                                                        ]
                                                }
                                        },
                                        {
                                                ""itemID"": ""d9ed7281-a13b-4128-9970-56a12b3c44a6"",
                                                ""itemType"": ""amount_decimal"",
                                                ""itemNumericData"": {
                                                        ""value"": ""110000""
                                                }
                                        },
                                        {
                                                ""itemID"": ""80a5ef34-0c89-472e-8005-5361f79c9f5d"",
                                                ""itemType"": ""amount_integer"",
                                                ""itemNumericData"": {
                                                        ""value"": ""110000""
                                                }
                                        },
                                        {
                                                ""itemID"": ""d44c5767-4a6e-43c2-808e-4dd4f73adf65"",
                                                ""itemType"": ""number"",
                                                ""itemNumericData"": {
                                                        ""value"": ""1""
                                                }
                                        }
                                ],
                                ""systemLinkageInfoList"": [
                                        {
                                                ""systemLinkageID"": 999000001,
                                                ""linkageIDValue"": ""linkagetest""
                                        }
                                ]
                        }
                }
        }
}

リクエスト例(JSON)※システム連携情報で更新

{
        ""param"": {
                ""toData"": {
                        ""productUpdateInfo"": {
                                ""systemLinkageInfo"": {
                                        ""systemLinkageID"": 999000001,
                                        ""linkageIDValue"": ""linkagetest""
                                },
                                ""productItemList"": [
                                        {
                                                ""itemID"": ""783fcf8e-01f9-489a-98ef-3a147c7b920c"",
                                                ""itemType"": ""text_single"",
                                                ""itemTextData"": {
                                                        ""value"": ""テスト_外部連携02_upd"",
                                                        ""ruby"": """",
                                                        ""datetimeTo"": """"
                                                }
                                        },
                                        {
                                                ""itemID"": ""86330dff-b4db-46d5-adce-4372319e41e4"",
                                                ""itemType"": ""toggle"",
                                                ""itemToggleData"": {
                                                        ""value"": true
                                                }
                                        },
                                        {
                                                ""itemID"": ""23908c8e-ab4b-415a-a9a9-f8e0f2a5f0f6"",
                                                ""itemType"": ""amount_decimal"",
                                                ""itemNumericData"": {
                                                        ""value"": ""1100000""
                                                }
                                        },
                                        {
                                                ""itemID"": ""139f91ba-8e84-44e7-aa02-857989f6695d"",
                                                ""itemType"": ""text_multiple"",
                                                ""itemTextData"": {
                                                        ""value"": ""test1"",
                                                        ""ruby"": """",
                                                        ""datetimeTo"": """"
                                                }
                                        },
                                        {
                                                ""itemID"": ""0b2dc74b-8be3-48a5-adbc-c8711ad77ca0"",
                                                ""itemType"": ""linkage_pulldown"",
                                                ""itemSelectionData"": {
                                                        ""values"": [
                                                                1,
                                                                3,
                                                                4
                                                        ]
                                                }
                                        },
                                        {
                                                ""itemID"": ""580dcc22-f7f3-4594-9b7e-dabda3601fa1"",
                                                ""itemType"": ""amount_decimal"",
                                                ""itemNumericData"": {
                                                        ""value"": ""1100""
                                                }
                                        },
                                        {
                                                ""itemID"": ""176b1aad-1c48-4c1b-8e82-985de2ba9225"",
                                                ""itemType"": ""subscription"",
                                                ""itemToggleData"": {
                                                        ""value"": true,
                                                        ""term"": ""12""
                                                }
                                        },
                                        {
                                                ""itemID"": ""5321eaf2-a1af-4c9a-9150-77d3a19cc0ac"",
                                                ""itemType"": ""url"",
                                                ""itemTextData"": {
                                                        ""value"": ""http://ex.com1"",
                                                        ""ruby"": """",
                                                        ""datetimeTo"": """"
                                                }
                                        },
                                        {
                                                ""itemID"": ""2dd479d5-2066-4807-8b51-67ddd1e830a1"",
                                                ""itemType"": ""pulldown"",
                                                ""itemSelectionData"": {
                                                        ""values"": [
                                                                1
                                                        ]
                                                }
                                        },
                                        {
                                                ""itemID"": ""953e7157-9215-42d8-9de5-b01afef26e5b"",
                                                ""itemType"": ""text_multiple"",
                                                ""itemTextData"": {
                                                        ""value"": ""test1"",
                                                        ""ruby"": """",
                                                        ""datetimeTo"": """"
                                                }
                                        },
                                        {
                                                ""itemID"": ""fc48bffc-4639-4e7f-bd72-72d1b94d026f"",
                                                ""itemType"": ""linkage_pulldown"",
                                                ""itemSelectionData"": {
                                                        ""values"": [
                                                                1,
                                                                4,
                                                                6
                                                        ]
                                                }
                                        },
                                        {
                                                ""itemID"": ""51b86754-0515-47c1-a797-23a0d34b1ba2"",
                                                ""itemType"": ""checkbox"",
                                                ""itemSelectionData"": {
                                                        ""values"": [
                                                                1,
                                                                2
                                                        ]
                                                }
                                        },
                                        {
                                                ""itemID"": ""bffff0e3-9dc8-4592-91e5-16c47ea31a44"",
                                                ""itemType"": ""user_single"",
                                                ""itemUuidData"": {
                                                        ""values"": [
                                                                ""62ad9f89-8b34-4600-9b03-582e7d210eba""
                                                        ]
                                                }
                                        },
                                        {
                                                ""itemID"": ""8dc45454-6fbe-4b7f-8e4d-7c9ab36901c2"",
                                                ""itemType"": ""user_multiple"",
                                                ""itemUuidData"": {
                                                        ""values"": [
                                                                ""62ad9f89-8b34-4600-9b03-582e7d210eba""
                                                        ]
                                                }
                                        },
                                        {
                                                ""itemID"": ""91cdcb3c-e868-43ee-98b1-aece0439d6bb"",
                                                ""itemType"": ""division_single"",
                                                ""itemUuidData"": {
                                                        ""values"": [
                                                                ""4dce2f99-cb5d-44e3-baed-543115a1a91c""
                                                        ]
                                                }
                                        },
                                        {
                                                ""itemID"": ""e1648d20-ed36-46be-93e8-952e00f68c5b"",
                                                ""itemType"": ""division_multiple"",
                                                ""itemUuidData"": {
                                                        ""values"": [
                                                                ""4dce2f99-cb5d-44e3-baed-543115a1a91c""
                                                        ]
                                                }
                                        },
                                        {
                                                ""itemID"": ""d9ed7281-a13b-4128-9970-56a12b3c44a6"",
                                                ""itemType"": ""amount_decimal"",
                                                ""itemNumericData"": {
                                                        ""value"": ""110000""
                                                }
                                        },
                                        {
                                                ""itemID"": ""80a5ef34-0c89-472e-8005-5361f79c9f5d"",
                                                ""itemType"": ""amount_integer"",
                                                ""itemNumericData"": {
                                                        ""value"": ""110000""
                                                }
                                        },
                                        {
                                                ""itemID"": ""d44c5767-4a6e-43c2-808e-4dd4f73adf65"",
                                                ""itemType"": ""number"",
                                                ""itemNumericData"": {
                                                        ""value"": ""1""
                                                }
                                        }
                                ]
                        }
                }
        }
}

レスポンス JSON

レスポンス例(JSON)

{
  ""appStatus"": {
    ""code"": ""S000"",
    ""message"": """"
  },
  ""updateProductResult"": {
    ""productID"": ""1f8cc493-1b3e-4c08-9bdc-c47e76f64287""
  }
}

API 固有の終了コード

目次に戻る

商品削除

APIの概要

テナント内の商品データを削除します。
削除対象の商品のIDを削除対象商品情報リストで指定する事で、複数の商品データをまとめて削除可能となります。
削除成功時に、レスポンスで削除成功した商品の商品IDが返されます。

リクエストボディ（JSON）

※1
deleteProductList、deleteSystemLinkageListのいずれかのみ必須。両方指定された場合はエラー。
deleteProductListが指定された時はproductIDをキーに、deleteSystemLinkageListが指定された時はsystemLinkageID, linkageIDValueをキーにして削除。

リクエスト例(JSON)※商品情報で削除

{
        ""param"": {
                ""toData"": {
                        ""deleteProductInfo"": {
                                ""deleteProductList"": [
                                        {
                                                ""productID"": ""1f8cc493-1b3e-4c08-9bdc-c47e76f64287""
                                        }
                                ]
                        }
                }
        }
}

リクエスト例(JSON)※システム連携情報で削除

{
        ""param"": {
                ""toData"": {
                        ""deleteProductInfo"": {
                                ""deleteSystemLinkageList"": [
                                        {
                                                ""systemLinkageID"": 999000002,
                                                ""linkageIDValue"": ""linkagetest""
                                        }
                                ]
                        }
                }
        }
}

レスポンス JSON

レスポンス例(JSON)

{
  ""appStatus"": {
    ""code"": ""S000"",
    ""message"": """"
  },
  ""deletedProductList"": [
    {
      ""productID"": ""1f8cc493-1b3e-4c08-9bdc-c47e76f64287""
    }
  ]
}

API 固有の終了コード

目次に戻る

案件登録

APIの概要

テナント内のデータとして案件データを登録します。
登録対象の案件項目データを項目リストに指定して登録します。
登録成功時に、レスポンスで登録した案件の案件IDが返されます。

リクエストボディ（JSON）

※1
participantMember、readerMemberのいずれかでユーザーID、組織IDいずれかは必須。
participantMember、readerMemberのuserList、organizationList全てが未指定の場合はエラー。
 

リクエストパラメタについての補足事項

①入力値のバリデーションチェックについて
　パラメタで指定する登録値については、登録時にバリデーションチェックを行い、エラーの場合はバリデーションエラーとなります。
　バリデーションチェックの内容は、項目タイプ（itemType）により異なり、下記シートに記載のチェックを項目タイプ別に実施します。
　項目タイプ値および項目タイプの説明

②必須項目チェックについて
　案件テンプレート項目の設定で必須となっている（必須フラグがtrueとなっている）項目については、登録対象項目リストに含まれていない場合にパラメタ不正エラーとなります。
　案件テンプレートの項目情報については、案件テンプレート取得APIのデータより確認可能です。

リクエスト例(JSON)

{
	""param"": {
		""toData"": {
			""orderRegisterInfo"": {
				""orderTemplateID"": ""94501146-e383-4e1c-90d5-d7e2907b64ec"",
				""participantMember"": {
					""userList"": [
						{
							""userID"": ""62ad9f89-8b34-4600-9b03-582e7d210eba""
						}
					],
					""organizationList"": [
						{
							""organizationID"": ""4dce2f99-cb5d-44e3-baed-543115a1a91c""
						}
					]
				},
				""readerMember"": {
					""userList"": [
						{
							""userID"": ""62ad9f89-8b34-4600-9b03-582e7d210eba""
						}
					],
					""organizationList"": [
						{
							""organizationID"": ""4dce2f99-cb5d-44e3-baed-543115a1a91c""
						}
					]
				},
				""orderItemList"": [
					{
						""itemID"": ""92a51904-d677-4b3d-a774-d0a852950778"",
						""itemType"": ""text_single"",
						""itemTextData"": {
							""value"": ""テスト0914_連携2""
						}
					},
					{
						""itemID"": ""05ca22d3-299c-4e8f-86cd-9078028b69e9"",
						""itemType"": ""number"",
						""itemNumericData"": {
							""value"": ""111""
						}
					},
					{
						""itemID"": ""b5261a9d-63e0-439f-901b-0bc9c3e335af"",
						""itemType"": ""client_single"",
						""itemUuidData"": {
							""values"": [
								""388c6bd2-e8b5-4b7e-8ee9-02dcbbf34937""
							]
						}
					},
					{
						""itemID"": ""aaba5314-7277-429b-b890-2582e1c1d922"",
						""itemType"": ""division_single"",
						""itemUuidData"": {
							""values"": [
								""4dce2f99-cb5d-44e3-baed-543115a1a91c""
							]
						}
					},
					{
						""itemID"": ""0857e3da-085d-4ee1-beee-9f7b76f891f8"",
						""itemType"": ""product_single"",
						""itemUuidData"": {
							""values"": [
								""c9393414-8008-4d91-ad07-d008b3cb65a6""
							]
						}
					},
					{
						""itemID"": ""092ce9ac-012c-41a6-979c-11d775d7a3a5"",
						""itemType"": ""amount_integer"",
						""itemNumericData"": {
							""value"": ""111""
						}
					},
					{
						""itemID"": ""13a00aaf-9739-40f1-ac46-fa69b8ed9dae"",
						""itemType"": ""date"",
						""itemTextData"": {
							""value"": ""2026-08-12"",
							""ruby"": """",
							""datetimeTo"": """"
						}
					},
					{
						""itemID"": ""13a5fbf1-84c0-4a18-b7f7-dc049981f96f"",
						""itemType"": ""user_single"",
						""itemUuidData"": {
							""values"": [
								""62ad9f89-8b34-4600-9b03-582e7d210eba""
							]
						}
					},
					{
						""itemID"": ""17b815f9-872d-4516-b53a-200601c43db6"",
						""itemType"": ""division_single"",
						""itemUuidData"": {
							""values"": [
								""4dce2f99-cb5d-44e3-baed-543115a1a91c""
							]
						}
					},
					{
						""itemID"": ""211a6a36-7a06-4b04-b0f5-f2934576ba22"",
						""itemType"": ""amount_integer"",
						""itemNumericData"": {
							""value"": ""111""
						}
					},
					{
						""itemID"": ""217f49d0-43ea-4b04-8eb9-c0f96f5a3342"",
						""itemType"": ""url"",
						""itemTextData"": {
							""value"": ""http://test.com"",
							""ruby"": """",
							""datetimeTo"": """"
						}
					},
					{
						""itemID"": ""357dd67c-46bf-49d5-83eb-3ad8d201f20e"",
						""itemType"": ""inquiry_route_single"",
						""itemInquiryRouteData"": {
							""inquiryRouteCategoryId"": ""b776132c-288c-4ccd-a4c9-cc24a87566e1"",
							""inquiryRouteId"": ""65a29a22-4198-4343-b4c9-1618d6b2abd4""
						}
					},
					{
						""itemID"": ""36343196-0e05-4c73-acfb-4b09c461ce98"",
						""itemType"": ""amount_decimal"",
						""itemNumericData"": {
							""value"": ""111.11""
						}
					},
					{
						""itemID"": ""421ca487-31ad-4be2-85cf-2f94b7fdd890"",
						""itemType"": ""linkage_pulldown"",
						""itemSelectionData"": {
							""values"": [
								1,
								5,
								8
							]
						}
					},
					{
						""itemID"": ""474c6064-ace8-48c9-9758-2b835cc6ecf3"",
						""itemType"": ""checkbox"",
						""itemSelectionData"": {
							""values"": [
								1,
								3,
								4
							]
						}
					},
					{
						""itemID"": ""4b7acf5f-cb17-49ea-8c25-08ee52c04ac4"",
						""itemType"": ""prefectures"",
						""itemTextData"": {
							""value"": ""1"",
							""ruby"": """",
							""datetimeTo"": """"
						}
					},
					{
						""itemID"": ""5cf1b874-453b-4702-8c33-fc09f78bd7ec"",
						""itemType"": ""clientresponsible_single"",
						""itemUuidData"": {
							""values"": [
								""6f0cbf22-7e18-44a7-bbb5-ec6f7e6db830""
							]
						}
					},
					{
						""itemID"": ""5d7dca4f-71fb-4b78-ba12-a95c9d9e08d0"",
						""itemType"": ""division_single"",
						""itemUuidData"": {
							""values"": [
								""4dce2f99-cb5d-44e3-baed-543115a1a91c""
							]
						}
					},
					{
						""itemID"": ""6569ec62-ee50-4a29-896d-a2a03b9e5802"",
						""itemType"": ""postal_code"",
						""itemTextData"": {
							""value"": ""1111111"",
							""ruby"": """",
							""datetimeTo"": """"
						}
					},
					{
						""itemID"": ""6a119c15-672a-4a18-8efa-f104f0c4f8c1"",
						""itemType"": ""pulldown"",
						""itemSelectionData"": {
							""values"": [
								0
							]
						}
					},
					{
						""itemID"": ""71657f77-19af-40aa-a574-0099f8299a35"",
						""itemType"": ""phase"",
						""itemSelectionData"": {
							""values"": [
								1
							]
						}
					},
					{
						""itemID"": ""7df90208-14a6-42b9-87e3-7cc1aee99869"",
						""itemType"": ""toggle"",
						""itemToggleData"": {
							""value"": true,
							""term"": """"
						}
					},
					{
						""itemID"": ""8fa7fbc6-e12d-468e-8205-aac9dbf025f6"",
						""itemType"": ""datetime"",
						""itemTextData"": {
							""value"": ""2026-08-03T00:49:00Z"",
							""ruby"": """",
							""datetimeTo"": """"
						}
					},
					{
						""itemID"": ""92c5a8f2-efd7-447a-a36d-cc149e20d6c3"",
						""itemType"": ""client_single"",
						""itemUuidData"": {
							""values"": [
								""388c6bd2-e8b5-4b7e-8ee9-02dcbbf34937""
							]
						}
					},
					{
						""itemID"": ""a32c50f3-9d38-441e-97b5-efdec63c761f"",
						""itemType"": ""mail_address"",
						""itemTextData"": {
							""value"": ""test@test.com"",
							""ruby"": """",
							""datetimeTo"": """"
						}
					},
					{
						""itemID"": ""cd4c9a95-9e15-4900-9bf2-1eb139311b75"",
						""itemType"": ""text_single"",
						""itemTextData"": {
							""value"": ""test"",
							""ruby"": """",
							""datetimeTo"": """"
						}
					},
					{
						""itemID"": ""e4501741-bd76-4e0e-b4ae-cc3273012180"",
						""itemType"": ""clientresponsible_single"",
						""itemUuidData"": {
							""values"": [
								""6f0cbf22-7e18-44a7-bbb5-ec6f7e6db830""
							]
						}
					},
					{
						""itemID"": ""e9dfe0c2-401d-4735-8bee-7752dfa587e2"",
						""itemType"": ""phone_number"",
						""itemTextData"": {
							""value"": ""11111"",
							""ruby"": """",
							""datetimeTo"": """"
						}
					}
				],
				""proposalProductInfoList"": [
					{
						""productID"": ""f993da30-14e8-4662-b79d-e2bb14925949"",
						""costPrice"": 1000,
						""salesPrice"": 1,
						""quantity"": 1,
						""discount"": 1,
						""subscriptionFlag"": true,
						""subscriptionTerm"": 6
					}
				],
				""orderParticipantList"": [
					{
						""clientResponsibleID"": ""6f0cbf22-7e18-44a7-bbb5-ec6f7e6db830"",
						""clientResponsibleRole"": 2
					}
				],
				""systemLinkageInfoList"": [
					{
						""systemLinkageID"": 999000001,
						""linkageIDValue"": ""test_0924_02""
					}
				]
			}
		}
	}
}

レスポンス JSON

レスポンス例(JSON)

{
  ""appStatus"": {
    ""code"": ""S000"",
    ""message"": """"
  },
  ""registerOrderResult"": {
    ""orderID"": ""62684b49-496e-4f06-972c-bac6e66a3b78""
  }
}

API 固有の終了コード

目次に戻る

案件更新

APIの概要

テナント内の案件データを更新します。更新対象の案件項目データを項目リストに指定して更新します。
更新については項目リストに設定されたデータをもとに差分更新で更新します。
更新成功時に、レスポンスで更新した案件の案件IDが返されます。

リクエストボディ（JSON）

※1
orderInfo、systemLinkageInfoのいずれかのみ必須。両方指定されている場合はエラー。
orderInfoが指定された時はorderIDをキーに、systemLinkageInfoが指定された時はsystemLinkageID, linkageIDValueをキーにして更新。
 

リクエストパラメタについての補足事項

①入力値のバリデーションチェックについて
　パラメタで指定する更新値については、更新時にバリデーションチェックを行い、エラーの場合はバリデーションエラーとなります。
　バリデーションチェックの内容は、項目タイプ（itemType）により異なり、下記シートに記載のチェックを項目タイプ別に実施します。
　項目タイプ値および項目タイプの説明

②参加者・閲覧者について
　参加者、閲覧者の指定がされた場合、参加者、閲覧者についても他のデータと同様に差分更新するようにします。
　参加者・閲覧者からユーザー・組織を削除する場合は、削除対象となる参加者・閲覧者のユーザーID・組織IDおよび削除フラグをオンに指定する事で削除ができます。

③案件参加者について
　案件参加者の指定がされた場合、案件参加者についても他のデータと同様に差分更新するようにします。
　案件参加者を削除する場合は、削除対象となる案件参加者の取引先担当者IDおよび削除フラグをオンに指定する事で削除ができます。

④提案商品について
　提案商品の指定がされた場合、提案商品についても他のデータと同様に差分更新するようにします。
　提案商品の金額と小計のデータ、金額の合計値のデータについては、案件登録APIと同様に案件更新APIの処理内で計算・算出して登録・更新します。
　提案商品を登録する場合は、案件登録APIと同様のパラメタを指定して、更新する場合は更新対象となる提案商品のIDを指定して他項目は登録する場合と同様にパラメタ指定します。
　提案商品を削除する場合は、削除対象となる提案商品のIDおよび削除フラグをオンに指定する事で削除ができます。

リクエスト例(JSON)※案件情報で更新

{
        ""param"": {
                ""toData"": {
                        ""orderUpdateInfo"": {
                                ""orderInfo"": {
                                        ""orderID"": ""62684b49-496e-4f06-972c-bac6e66a3b78""
                                },
                                ""participantMember"": {
                                        ""userList"": [
                                                {
                                                        ""userID"": ""62ad9f89-8b34-4600-9b03-582e7d210eba""
                                                }
                                        ],
                                        ""organizationList"": [
                                                {
                                                        ""organizationID"": ""4dce2f99-cb5d-44e3-baed-543115a1a91c""
                                                }
                                        ]
                                },
                                ""readerMember"": {
                                        ""userList"": [
                                                {
                                                        ""userID"": ""62ad9f89-8b34-4600-9b03-582e7d210eba""
                                                }
                                        ],
                                        ""organizationList"": [
                                                {
                                                        ""organizationID"": ""4dce2f99-cb5d-44e3-baed-543115a1a91c""
                                                }
                                        ]
                                },
                                ""orderItemList"": [
                                        {
                                                ""itemID"": ""92a51904-d677-4b3d-a774-d0a852950778"",
                                                ""itemType"": ""text_single"",
                                                ""itemTextData"": {
                                                        ""value"": ""テスト0908_連携222"",
                                                        ""ruby"": """",
                                                        ""datetimeTo"": """"
                                                }
                                        },
                                        {
                                                ""itemID"": ""474c6064-ace8-48c9-9758-2b835cc6ecf3"",
                                                ""itemType"": ""checkbox"",
                                                ""itemSelectionData"": {
                                                        ""values"": [
                                                                1
                                                        ]
                                                }
                                        },
                                        {
                                                ""itemID"": ""bd5fda55-06d2-46c3-8a11-cb6bc701c7cb"",
                                                ""itemType"": ""checkbox"",
                                                ""itemSelectionData"": {
                                                        ""values"": [
                                                                1
                                                        ]
                                                }
                                        },
                                        {
                                                ""itemID"": ""aaba5314-7277-429b-b890-2582e1c1d922"",
                                                ""itemType"": ""division_single"",
                                                ""itemUuidData"": {
                                                        ""values"": [
                                                                ""4dce2f99-cb5d-44e3-baed-543115a1a91c""
                                                        ]
                                                }
                                        }
                                ],
                                ""orderParticipantList"": [
                                        {
                                                ""clientResponsibleID"": ""6f0cbf22-7e18-44a7-bbb5-ec6f7e6db830"",
                                                ""clientResponsibleRole"": 3
                                        }
                                ],
                                ""proposalProductInfoList"": [
                                        {
                                                ""proposalProductID"": ""22afb1bc-e8ea-468f-b23b-d660ab8b75b4"",
                                                ""productID"": ""6664610b-b1c6-430c-a926-f6e0972830c2"",
                                                ""costPrice"": 10,
                                                ""salesPrice"": 103,
                                                ""quantity"": 2,
                                                ""discount"": 30,
                                                ""subscriptionFlag"": true,
                                                ""subscriptionTerm"": 3
                                        },
                                        {
                                                ""proposalProductID"": ""b4a19102-8182-4c87-ac4e-e0aab91748fc"",
                                                ""productID"": ""f993da30-14e8-4662-b79d-e2bb14925949"",
                                                ""costPrice"": 96,
                                                ""salesPrice"": 4869,
                                                ""quantity"": 4,
                                                ""discount"": 0,
                                                ""subscriptionFlag"": false,
                                                ""subscriptionTerm"": 0
                                        }
                                ]
                        }
                }
        }
}

リクエスト例(JSON)※システム連携情報で更新

{
        ""param"": {
                ""toData"": {
                        ""orderUpdateInfo"": {
                                ""systemLinkageInfo"": {
                                        ""systemLinkageID"": 999000001,
                                        ""linkageIDValue"": ""linkagetest""
                                },
                                ""participantMember"": {
                                        ""userList"": [
                                                {
                                                        ""userID"": ""62ad9f89-8b34-4600-9b03-582e7d210eba""
                                                }
                                        ],
                                        ""organizationList"": [
                                                {
                                                        ""organizationID"": ""4dce2f99-cb5d-44e3-baed-543115a1a91c""
                                                }
                                        ]
                                },
                                ""readerMember"": {
                                        ""userList"": [
                                                {
                                                        ""userID"": ""62ad9f89-8b34-4600-9b03-582e7d210eba""
                                                }
                                        ],
                                        ""organizationList"": [
                                                {
                                                        ""organizationID"": ""4dce2f99-cb5d-44e3-baed-543115a1a91c""
                                                }
                                        ]
                                },
                                ""orderItemList"": [
                                        {
                                                ""itemID"": ""92a51904-d677-4b3d-a774-d0a852950778"",
                                                ""itemType"": ""text_single"",
                                                ""itemTextData"": {
                                                        ""value"": ""テスト0908_連携222"",
                                                        ""ruby"": """",
                                                        ""datetimeTo"": """"
                                                }
                                        },
                                        {
                                                ""itemID"": ""474c6064-ace8-48c9-9758-2b835cc6ecf3"",
                                                ""itemType"": ""checkbox"",
                                                ""itemSelectionData"": {
                                                        ""values"": [
                                                                1
                                                        ]
                                                }
                                        },
                                        {
                                                ""itemID"": ""bd5fda55-06d2-46c3-8a11-cb6bc701c7cb"",
                                                ""itemType"": ""checkbox"",
                                                ""itemSelectionData"": {
                                                        ""values"": [
                                                                1
                                                        ]
                                                }
                                        },
                                        {
                                                ""itemID"": ""aaba5314-7277-429b-b890-2582e1c1d922"",
                                                ""itemType"": ""division_single"",
                                                ""itemUuidData"": {
                                                        ""values"": [
                                                                ""4dce2f99-cb5d-44e3-baed-543115a1a91c""
                                                        ]
                                                }
                                        }
                                ],
                                ""orderParticipantList"": [
                                        {
                                                ""clientResponsibleID"": ""6f0cbf22-7e18-44a7-bbb5-ec6f7e6db830"",
                                                ""clientResponsibleRole"": 3
                                        }
                                ],
                                ""proposalProductInfoList"": [
                                        {
                                                ""proposalProductID"": ""22afb1bc-e8ea-468f-b23b-d660ab8b75b4"",
                                                ""productID"": ""6664610b-b1c6-430c-a926-f6e0972830c2"",
                                                ""costPrice"": 10,
                                                ""salesPrice"": 103,
                                                ""quantity"": 2,
                                                ""discount"": 30,
                                                ""subscriptionFlag"": true,
                                                ""subscriptionTerm"": 3
                                        },
                                        {
                                                ""proposalProductID"": ""b4a19102-8182-4c87-ac4e-e0aab91748fc"",
                                                ""productID"": ""f993da30-14e8-4662-b79d-e2bb14925949"",
                                                ""costPrice"": 96,
                                                ""salesPrice"": 4869,
                                                ""quantity"": 4,
                                                ""discount"": 0,
                                                ""subscriptionFlag"": false,
                                                ""subscriptionTerm"": 0
                                        }
                                ]
                        }
                }
        }
}

レスポンス JSON

レスポンス例(JSON)

{
  ""appStatus"": {
    ""code"": ""S000"",
    ""message"": """"
  },
  ""updateOrderResult"": {
    ""orderID"": ""62684b49-496e-4f06-972c-bac6e66a3b78""
  }
}

API 固有の終了コード

目次に戻る

案件削除

APIの概要

テナント内の案件データを削除します。
削除対象の案件のIDを削除対象案件情報リストで指定する事で、複数の案件データをまとめて削除可能となります。
削除成功時に、レスポンスで削除成功した案件の案件IDが返されます。

リクエストボディ（JSON）

※1
deleteOrderList、deleteSystemLinkageListのいずれかのみ必須。両方指定された場合はエラー。
deleteOrderListが指定された時はorderIDをキーに、deleteSystemLinkageListが指定された時はsystemLinkageID, linkageIDValueをキーにして削除。

リクエスト例(JSON)※案件情報で削除

{
        ""param"": {
                ""toData"": {
                        ""deleteOrderInfo"": {
                                ""deleteOrderList"": [
                                        {
                                                ""orderID"": ""62684b49-496e-4f06-972c-bac6e66a3b78""
                                        }
                                ]
                        }
                }
        }
}

リクエスト例(JSON)※システム連携情報で更新

{
        ""param"": {
                ""toData"": {
                        ""deleteOrderInfo"": {
                                ""deleteSystemLinkageList"": [
                                        {
                                                ""systemLinkageID"": 999000002,
                                                ""linkageIDValue"": ""linkagetest""
                                        }
                                ]
                        }
                }
        }
}

レスポンス JSON

レスポンス例(JSON)

{
  ""appStatus"": {
    ""code"": ""S000"",
    ""message"": """"
  },
  ""deletedOrderList"": [
    {
      ""orderID"": ""62684b49-496e-4f06-972c-bac6e66a3b78""
    }
  ]
}

API 固有の終了コード

目次に戻る

案件メモ登録

APIの概要

テナント内のデータとして案件メモデータを登録します。
登録対象の案件メモデータを指定して登録します。
登録成功時に、レスポンスで登録した案件のメモIDが返されます。

リクエストボディ（JSON）

リクエスト例(JSON)

{
        ""param"": {
                ""toData"": {
                        ""orderMemoRegisterInfo"": {
                                ""orderID"": ""fd8e7875-782b-41c9-8291-c0ce178675d9"",
                                ""titleName"": ""SFA案件メモ"",
                                ""content"": ""メモの内容"",
                                ""memoDateTime"": ""2026-08-06T02:00:42.529Z"",
                                ""actionKindID"": ""78b0cec3-01c3-7180-7d24-ca01f3a7cbf8"",
                                ""linkingClientResponsibleIDList"": [
                                        ""5fcb22bd-131f-46b4-b501-2d8ae6d30fb8""
                                ]
                        }
                }
        }
}

レスポンス JSON

レスポンス例(JSON)

{
  ""appStatus"": {
    ""code"": ""S000"",
    ""message"": """"
  },
  ""registerOrderMemoResult"": {
    ""memoID"": ""4c2c3e40-cf18-4cbb-b7c7-f248170c4392""
  }
}

API 固有の終了コード

目次に戻る

案件メモ更新

APIの概要

テナント内の案件メモデータを更新します。
更新対象の案件メモデータを指定して更新します。
更新についてはパラメタで設定されたデータをもとに差分更新で更新します。
更新成功時に、レスポンスで更新した案件のメモIDが返されます。

リクエストボディ（JSON）