---
sourceDocument: オーストラリア API リファレンス
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/ja-JP/api-reference
Release :
- australia
ft:locale :
- ja-JP
ft:publication_title :
- オーストラリア API リファレンス
ft:clusterId :
- crapiref
bundleId :
- crapiref
workflow :
- Creator
---
# 見積管理 API
# 見積管理 API {#ariaid-title1}
* リリースバージョン: Australia
*
* 更新日 2026年03月12日
*
*  所要時間：102分
見積管理 API は、顧客見積もりデータを作成、更新、および取得するためのエンドポイントを提供します。
見積管理オープン API は、TM フォーラム見積管理 API REST 仕様のServiceNow実装です。この実装は に基づいています。
この API を拡張して、必須パラメーター、要求本文の検証、追加の REST 操作、およびフィールドマッピングをカスタマイズできます。
見積管理 API には、見積管理 (com.sn_quote_mgmt) プラグインと quote_integrator ロールが必要です。この API は sn_tmf_api 名前空間に属しています。「」を参照してください。
見積もり管理 API は、次のテーブルのデータを作成または更新します。
* 見積もり \[sn_quote_mgmt_core_quote\]
* 販売契約 \[sn_sales_agmt_core_sales_agreement\]
* 見積もりラインアイテム \[sn_quote_mgmt_core_quote_line_item\]
* 見積品目の特性 \[sn_quote_mgmt_core_quote_line_characteristic\]
* 見積価格調整 \[sn_quote_mgmt_core_pricing_adjustment\]
{#quote-management-api__ul_lxc_kxm_t4b}
## 見積管理 API - 削除 /sn_tmf_api/quote_management_api/quote/{id} {#ariaid-title2}
指定された見積もりを削除します。
### URL 形式 {#quotemgmt-DELETE-id__section_uk2_4v2_yfc}
バージョニングされた URL: /api/sn_tmf_api/{api_version}/quote_management_api/quote/{id}
デフォルト URL: /api/sn_tmf_api/quote_management_api/quote/{id}
### サポートされている要求パラメーター
{#quotemgmt-DELETE-id__entry__2}
| 名前 | 説明 |
|-|-|
| ID | 削除する見積もりSys_id。 データタイプ：文字列 テーブル:見積もり \[sn_quote_mgmt_core_quote\] |
[表 : 1. パスパラメーター]
{#quotemgmt-DELETE-id__entry__6}
| 名前 | 説明 |
|-|-|
| なし | |
[表 : 2. クエリパラメーター]
{#quotemgmt-DELETE-id__table_m32_1l1_hwb__entry__2}
| 名前 | 説明 |
|-|-|
| なし | |
[表 : 3. 要求本文パラメーター (JSON)]
{#quotemgmt-DELETE-id__table_m32_1l1_hwb}
### ヘッダー
次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")を参照してください。
{#quotemgmt-DELETE-id__table_omb_dvk_5rb__entry__2}{#quotemgmt-DELETE-id__accept-JSON-only-entry-RESTAPI}
| ヘッダー | 説明 |
|-|-|
| 承認 | 応答本文のデータフォーマット。application/json のみをサポートします。 |
[表 : 4. 要求ヘッダー]
{#quotemgmt-DELETE-id__table_omb_dvk_5rb} {#quotemgmt-DELETE-id__table_tzy_thy_ksb__entry__2}
| ヘッダー | 説明 |
|-|-|
| なし | |
[表 : 5. 応答ヘッダー]
{#quotemgmt-DELETE-id__table_tzy_thy_ksb}
### ステータスコード
この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")」を参照してください。
{#quotemgmt-DELETE-id__table_xfv_2vk_5rb__entry__2}
| ステータスコード | 説明 |
|-|-|
| 204 | 成功。要求が正常に完了し、指定された見積もりが削除されました。コンテンツがありません。 |
| 400 | 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。 |
[表 : 6. ステータスコード]
{#quotemgmt-DELETE-id__table_xfv_2vk_5rb}
### 応答本文のパラメーター (JSON) {#quotemgmt-DELETE-id__section_b1v_xpk_5rb}
{#quotemgmt-DELETE-id__table_t5s_hm1_hwb__entry__2}
| ヘッダー | 説明 |
|-|-|
| なし | |
[ ]
{#quotemgmt-DELETE-id__table_t5s_hm1_hwb}
### cURL 要求 {#quotemgmt-DELETE-id__example_jsc_1dc_vrb}
この例では、見積もりを削除する方法を示します。
curl "http://instance.servicenow.com/api/sn_tmf_api/quote_management_api/quote/cb15734fd5692a10f8774663edf0ac19" \
--request DELETE\
--header "Accept:application/json" \
--user 'username':'password'
## 見積管理 API -- GET /sn_tmf_api/quote_management_api/見積 {#ariaid-title3}
すべての見積もりを取得します。
この API は、次の関連テーブルから見積もり情報を取得します。
* 見積もり \[sn_quote_mgmt_core_quote\]
* 販売契約 \[sn_sales_agmt_core_sales_agreement\]
* 見積もりラインアイテム \[sn_quote_mgmt_core_quote_line_item\]
* 見積品目の特性 \[sn_quote_mgmt_core_quote_line_characteristic\]
* 見積価格調整 \[sn_quote_mgmt_core_pricing_adjustment\]
{#quotemgmt-GET__ul_lxc_kxm_t4b}
### URL 形式 {#quotemgmt-GET__section_uk2_4v2_yfc}
バージョニングされた URL: /api/sn_tmf_api/{api_version}/quote_management_api/quote
デフォルト URL: /api/sn_tmf_api/quote_management_api/quote
### サポートされている要求パラメーター
{#quotemgmt-GET__table_ofr_vgy_fsb__entry__2}
| 名前 | 説明 |
|-|-|
| なし | |
[表 : 7. パスパラメーター]
{#quotemgmt-GET__table_ofr_vgy_fsb} {#quotemgmt-GET__table_pfr_vgy_fsb__entry__2}
| 名前 | 説明 |
|-|-|
| フィールド | 応答で返すフィールドのリスト。無効なフィールドは無視されます。 有効なフィールド： * quoteNumber * href * ID * 説明 * externalId * ExpectedQuoteCompletionDate * バージョン * @type {#quotemgmt-GET__ul_vsb_ztr_xfc} データタイプ：文字列 デフォルト:すべてのフィールドが返されます。 |
| ID | 見積もりsys_idで結果をフィルタリングします。 テーブル:見積もり \[sn_quote_mgmt_core_quote\] データタイプ：文字列 デフォルト：空 |
| limit | 返されるレコードの最大数。このレコード数を超える要求の場合は、 offset パラメーターを使用してレコード取得をページネーションします。 データタイプ：数値 デフォルト値：20 最大:100 |
| オフセット | レコードの取得を開始する開始インデックス。この値を使用して、レコード取得をページネーションします。この機能を使用すると、レコードの数に関係なく、すべてのレコードを小さな管理可能なチャンクで取得できます。 データタイプ：数値 デフォルト：0 |
[表 : 8. クエリパラメーター]
{#quotemgmt-GET__table_pfr_vgy_fsb} {#quotemgmt-GET__table_xcm_cvr_nsb__entry__2}
| 名前 | 説明 |
|-|-|
| なし | |
[表 : 9. 要求本文パラメーター (JSON)]
{#quotemgmt-GET__table_xcm_cvr_nsb}
### ヘッダー
次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")を参照してください。
{#quotemgmt-GET__table_kqy_wgy_fsb__entry__2}
| ヘッダー | 説明 |
|-|-|
| なし | |
[表 : 10. 要求ヘッダー]
{#quotemgmt-GET__table_kqy_wgy_fsb} {#quotemgmt-GET__table_h4r_fxr_nsb__entry__2}{#quotemgmt-GET__content-range-row}{#quotemgmt-GET__content-type-row}{#quotemgmt-GET__links-pagination-row}{#quotemgmt-GET__x-total-count-descr}
| ヘッダー | 説明 |
|-|-|
| Content-Range | ページネーションされた呼び出しで返されるコンテンツの範囲。 たとえば、 `offset=2` で `limit=3` の場合、 Content-Range ヘッダーの値は `アイテム 3 から 5` です。 |
| Content-Type | 応答本文のデータフォーマット。application/json のみをサポートします。 |
| 「リンク」 | クエリ結果間を移動するための次のリンクが含まれています。 * 第 1 * 最終 * 次へ * 前へ {#quotemgmt-GET__ul_zzk_sdm_lsb} |
| X-合計-数 | ページネーションされたクエリの場合、このヘッダーはサーバーで使用可能なレコードの合計数を指定します。 |
[表 : 11. 応答ヘッダー]
{#quotemgmt-GET__table_h4r_fxr_nsb}
### ステータスコード
この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")」を参照してください。
{#quotemgmt-GET__table_abf_sn5_4sb__entry__2}{#quotemgmt-GET__tmf-get-status-200-p}{#quotemgmt-GET__tmf-get-status-206-entry}{#quotemgmt-GET__tmf-get-status-400-entry}{#quotemgmt-GET__tmf-get-status-404-entry}
| ステータスコード | 説明 |
|-|-|
| 200 | 要求が正常に処理されました。応答で返された完全なリソース (ページネーションなし)。 |
| 206 | 応答で返された部分的なリソース (ページネーションあり)。 |
| 400 | 要求が正しくありません。考えられる理由: * 無効なパスパラメーター * 無効な URI {#quotemgmt-GET__ul_rys_1gy_fsb} |
| 404 | レコードが見つかりません。クエリパラメーターに一致するレコードがテーブルに見つかりません。 |
[表 : 12. ステータスコード]
{#quotemgmt-GET__table_abf_sn5_4sb}
### 応答本文のパラメーター (JSON) {#quotemgmt-GET__section_ilb_1qx_kqb}
{#quotemgmt-GET__table_jlb_1qx_kqb__entry__2}
| 名前 | 説明 |
|-|-|
| contactMedium | 連絡先メディアのリスト。見積もり依頼者に関連する連絡先情報。 "contactMedium": [ { "city": "String", "country": "String", "locationId": "String", "mediumType": "String", "postCode": "String", "stateOrProvince": "String", "street": "String", "@type": "String" } ] |
| contactMedium.city | 見積もり依頼者が居住する市区町村。 データタイプ：文字列 |
| contactMedium.country | 見積もり依頼者が居住する国。 データタイプ：文字列 |
| contactMedium.locationId | 場所 \[cmn_location\] テーブルまたはカスタム住所にリストされている場所のSys_id。 データタイプ：文字列 |
| contactMedium.mediumType | メールアドレス、電話番号、住所などの連絡先メディアのタイプ。 データタイプ：文字列 |
| contactMedium.postCode | 見積もり依頼者の郵便番号。 データタイプ：文字列 |
| contactMedium.stateOrProvince | 見積もり依頼者が所在する都道府県。 データタイプ：文字列 |
| contactMedium.street | 見積もり依頼者の番地。 データタイプ：文字列 |
| contactMedium.@type | TMF Open API 標準に従ったメディアのタイプ。たとえば、「 GeographicalAddressContactMedium」のように入力します。 データタイプ：文字列 |
| 説明 | 見積もりの説明。 データタイプ：文字列 |
| ExpectedQuoteCompletionDate | 見積もりサプライヤーがこの見積もりに対する応答を返送できるようになる予定日。 データタイプ：文字列 |
| externalId | コンシューマーが提供する見積もりの一意の ID。 データタイプ：文字列 |
| href | 見積もりにアクセスするための相対リンク。 データタイプ：文字列 デフォルト:空の文字列 |
| ID | 要求された見積もりのSys_id。 テーブル:見積もり \[sn_quote_mgmt_core_quote\] データタイプ：文字列 |
| 注意 | 見積もりに関連付けられたメモのリスト。 データタイプ：アレイ "note": [ { "author": "String", "date": "String", "text": "String", "@type": "String" } ] |
| note.author | 関連するメモの作成者のユーザー名。 データタイプ：文字列 |
| note.date | メモが作成された日付。 データタイプ：文字列 |
| note.text | メモの内容。 データタイプ：文字列 |
| note.@type | この値は常に Noteです。 データタイプ：文字列 |
| 見積日 | 見積もりが作成された日時。 データタイプ：文字列 |
| 見積もりアイテム | 見積もりアイテムのリスト。各見積もりアイテムは、見積もり対象の製品のアクションを記述します。 "quoteItem": [ { "action": "String", "id": "String", "product": {Object}, "productOffering": {Object}, "quantity": Number, "state": "String", "@type": "String" } ] データタイプ：オブジェクトのアレイ |
| quoteItem.action | この見積アイテムに対して実行するアクション (追加、変更、削除など)。 データタイプ：文字列 |
| quoteItem.id | 見積もりアイテムのSys_id。 テーブル:見積品目 \[sn_quote_mgmt_core_quote_line_item\] データタイプ：文字列 |
| quoteItem.product | 見積もりに含まれる製品のリスト。 "product": { "characteristic": "String", "specification": "String", "@type": "String" } データタイプ: オブジェクト |
| quoteItem.product. 特性 | 製品特性のリスト。 データタイプ：オブジェクトのアレイ "characteristic": [ { "id": "String", "name": "String", "@type": "String", "value": "String" } ] 「[Create product characteristics and characteristic options](https://www.servicenow.com/docs/access?context=som-product-config-add-characteristics&version=australia&pubname=australia-order-management&ft:locale=en-US)」を参照してください。 |
| quoteItem.product. characteristic.id | 製品特性のSys_id。 テーブル:見積品目の特性 \[sn_quote_mgmt_core_quote_line_characteristic\] データタイプ：文字列 |
| quoteItem.product. characteristic.name | 製品特性の名前。 データタイプ：文字列 |
| quoteItem.product. characteristic.@type | この値は常に StringCharacteristic です。 データタイプ：文字列 |
| quoteItem.product. characteristic.value | 特性の値。 データタイプ：文字列 |
| quoteItem.product を指定します。 | 顧客または関係者の役割を果たすその他の関係者に対して、ProductOffering の形式で外部から提供される有形または無形のオブジェクトの詳細な説明。 データタイプ：文字列 |
| quoteItem.product.@type | この値は常に Product です。 データタイプ：文字列 |
| quoteItem.productOffering | 製品オファリング参照 (ProductOfferingRef)。製品オファリングは、カタログのプロバイダーから注文可能なエンティティを表します。 "productOffering": { "href": "String", "name": "String", "name": "String", "@type": "String" } データタイプ: オブジェクト |
| quoteItem です。productOffering.href | 関連エンティティの参照。 データタイプ：文字列 |
| quoteItem です。productOffering.id | 製品オファリングのSys_id。 テーブル:製品オファリング \[sn_prd_pm_product_offering\] データタイプ：文字列 |
| quoteItem です。productOffering.name | 関連エンティティの名前。 データタイプ：文字列 |
| quoteItem です。productOffering.@type | この値は常に ProductOfferingRef です。 データタイプ：文字列 |
| quoteItem.quantity | この見積アイテムに要求された数量。 データタイプ：数値 |
| quoteItem.state | 見積もり状態の種類 (QuoteStateType)。見積もりのステータス。 データタイプ：文字列 |
| quoteItem.@type | この値は常に QuoteItem です。 データタイプ：文字列 |
| quoteNumber | 見積もりにアサインされた見積品目レコード番号。 テーブル:見積品目 \[sn_quote_mgmt_core_quote_line_item\] データタイプ：文字列 |
| 関連パーティー | 注文の連絡先のリスト。 データタイプ：オブジェクトのアレイ "relatedParty": [ { "id": "String", "name": "String", "@referredType": "String", "role": "String", "@type": "String" } ] |
| relatedParty.id | アカウント、連絡先、または顧客を取得する見積もりテーブルSys_id。 テーブル:見積もり \[sn_quote_mgmt_core_quote\] データタイプ：文字列 |
| relatedParty.name | アカウント、顧客、またはコンシューマーの名前。 データタイプ：文字列 |
| relatedParty.@referredType | 顧客のタイプ。 可能な値： * コンシューマー * 顧客 * 顧客連絡先 {#quotemgmt-GET__ul_oc5_dc2_hqb} データタイプ：文字列 |
| relatedParty.role | 見積もりのコンテキストでの関係者のロール (アカウント、連絡先、顧客など)。 データタイプ：文字列 |
| relatedParty.@type | この値は常に ProductOfferingRef です。 データタイプ：文字列 |
| requestedQuoteCompletionDate | 日時 (DateTime)。この値は、見積もり依頼者が指定した、この見積もりに対する完全な応答を受信する日付を表します。 データタイプ：文字列 |
| 状況 | 見積もりアイテムのステータス。 データタイプ：文字列 |
| @type | リソースのタイプ。この値は常に [見積もり] です。この情報は保存されません。 データタイプ：文字列 |
[ ]
{#quotemgmt-GET__table_jlb_1qx_kqb}
### cURL 要求
この例では、すべての見積もりを取得します。
curl "https://instance.service-now.com/api/sn_tmf_api/quote_management_api/quote" \
--request GET \
--header "Accept:application/json" \
--user 'userName':'password'
応答本文。
{
"id": "47e562bad565a610f8774663edf0ac10",
"quoteNumber": "QT0001001",
"href": "api/sn_tmf_api/quote_management_api/quote/47e562bad565a610f8774663edf0ac10",
"@type": "Quote",
"description": "Testing Quote",
"expectedQuoteCompletionDate": "2025-05-23 11:12:08",
"externalId": "Test_1234",
"quoteDate": "2025-05-20 11:11:13",
"requestedQuoteCompletionDate": "2025-05-23 11:12:08",
"version": "3",
"agreement": [],
"contactMedium": [
{
"@type": "GeographicalAddressContactMedium",
"mediumType": "ShippingAddressRef",
"locationId": "6774fee611383110f877366201dea64f",
"city": "Santa Clara",
"country": "USA",
"postCode": "94560",
"stateOrProvince": "CA",
"street": "222 Star St"
}
],
"note": [],
"quoteItem": [
{
"id": "8be562bad565a610f8774663edf0ac16",
"@type": "QuoteItem",
"action": "add",
"quantity": "1",
"state": "Draft",
"product": {
"@type": "Product",
"productCharacteristic": [
{
"id": "0fe562bad565a610f8774663edf0ac17",
"name": "Voice Pack",
"value": "1500 Minutes/Month"
},
{
"id": "4be562bad565a610f8774663edf0ac17",
"name": "SMS Pack",
"value": "700 /Month"
},
{
"id": "83e562bad565a610f8774663edf0ac18",
"name": "Data Pack",
"value": "20 GB/Month"
},
{
"id": "87e562bad565a610f8774663edf0ac17",
"name": "Mobile Number",
"value": ""
},
{
"id": "cfe562bad565a610f8774663edf0ac17",
"name": "Shipping Address",
"value": ""
}
],
"productSpecification": {
"id": "3ee1fdb1c3331010d216b5183c40dd81",
"href": "api/sn_tmf_api/catalogmanagement/productSpecification/3ee1fdb1c3331010d216b5183c40dd81",
"name": "Mobile Plan",
"@type": "ProductSpecificationRef"
}
},
"productOffering": {
"id": "2cb5588fc30020105252716b7d40dddd",
"href": "api/sn_tmf_api/catalogmanagement/productOffering/2cb5588fc30020105252716b7d40dddd",
"name": "All in one mobile plan starting from $49/month",
"@type": "ProductOfferingRef"
},
"quoteItemPrice": [
{
"description": "Standard Price List",
"name": "Standard Price List",
"priceType": "Recurring",
"recurringChargePeriod": "",
"unitOfMeasure": "",
"unitMarginPercentage": "",
"price": {
"totalOneTimePrice": {
"unit": "USD",
"value": 0
},
"monthlyRecurringPrice": {
"unit": "USD",
"value": 0
},
"annualRecurringPrice": {
"unit": "USD",
"value": 0
},
"cumulativeRecurringPrice": {
"unit": "USD",
"value": 0
},
"cumulativeAnnualRecurringPrice": {
"unit": "USD",
"value": 0
},
"cumulativeNetPrice": {
"unit": "USD",
"value": 0
},
"unitMarginAmount": {
"unit": "USD",
"value": 0
},
"unitMarginBasePrice": {
"unit": "USD",
"value": 0
},
"listPrice": {
"unit": "USD",
"value": 0
},
"unitCost": {
"unit": "USD",
"value": 0
},
"unitPrice": {
"unit": "USD",
"value": 0
},
"dutyFreeAmount": {
"unit": "USD",
"value": 0
},
"taxIncludedAmount": {
"unit": "USD",
"value": 0
}
},
"priceAlteration": []
}
]
}
],
"relatedParty": [
{
"role": "Customer",
"id": "9e2fd2ee11b43110f877366201dea674",
"name": "Startech svcs",
"@type": "RelatedPartyRef",
"@referredType": "Organization"
},
{
"role": "CustomerContact",
"id": "dca96eaa11f43110f877366201dea6c1",
"name": "Alex Star",
"@type": "RelatedPartyRef",
"@referredType": "Individual"
}
],
"state": "Draft"
}
## 見積管理 API -- GET /sn_tmf_api/quote_management_api/quote/{id} {#ariaid-title4}
指定された見積もりを取得します。
この API は、次の関連テーブルから見積もり情報を取得します。
* 見積もり \[sn_quote_mgmt_core_quote\]
* 販売契約 \[sn_sales_agmt_core_sales_agreement\]
* 見積もりラインアイテム \[sn_quote_mgmt_core_quote_line_item\]
* 見積品目の特性 \[sn_quote_mgmt_core_quote_line_characteristic\]
* 見積価格調整 \[sn_quote_mgmt_core_pricing_adjustment\]
{#quotemgmt-GET-id__ul_lxc_kxm_t4b}
### URL 形式 {#quotemgmt-GET-id__section_uk2_4v2_yfc}
バージョニングされた URL: /api/sn_tmf_api/{api_version}/quote_management_api/quote/{id}
デフォルト URL: /api/sn_tmf_api/quote_management_api/quote/{id}
### サポートされている要求パラメーター
{#quotemgmt-GET-id__entry__2}
| 名前 | 説明 |
|-|-|
| ID | 取得する見積もりのSys_id。 データタイプ：文字列 テーブル:見積もり \[sn_quote_mgmt_core_quote\] |
[表 : 13. パスパラメーター]
{#quotemgmt-GET-id__entry__6}
| 名前 | 説明 |
|-|-|
| なし | |
[表 : 14. クエリパラメーター]
{#quotemgmt-GET-id__entry__10}
| 名前 | 説明 |
|-|-|
| なし | |
[表 : 15. 要求本文パラメーター (JSON)]
### ヘッダー
次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")を参照してください。
{#quotemgmt-GET-id__table_ed2_jl5_4sb__entry__2}
| ヘッダー | 説明 |
|-|-|
| なし | |
[表 : 16. 要求ヘッダー]
{#quotemgmt-GET-id__table_ed2_jl5_4sb} {#quotemgmt-GET-id__table_tzy_thy_ksb__entry__2}
| ヘッダー | 説明 |
|-|-|
| Content-Type | 応答本文のデータフォーマット。application/json のみをサポートします。 |
[表 : 17. 応答ヘッダー]
{#quotemgmt-GET-id__table_tzy_thy_ksb}
### ステータスコード
この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")」を参照してください。
{#quotemgmt-GET-id__table_abf_sn5_4sb__entry__2}{#quotemgmt-GET-id__tmf-get-status-200-p}{#quotemgmt-GET-id__tmf-get-status-206-entry}{#quotemgmt-GET-id__tmf-get-status-400-entry}{#quotemgmt-GET-id__tmf-get-status-404-entry}
| ステータスコード | 説明 |
|-|-|
| 200 | 要求が正常に処理されました。応答で返された完全なリソース (ページネーションなし)。 |
| 206 | 応答で返された部分的なリソース (ページネーションあり)。 |
| 400 | 要求が正しくありません。考えられる理由: * 無効なパスパラメーター * 無効な URI {#quotemgmt-GET-id__ul_rys_1gy_fsb} |
| 404 | レコードが見つかりません。クエリパラメーターに一致するレコードがテーブルに見つかりません。 |
[表 : 18. ステータスコード]
{#quotemgmt-GET-id__table_abf_sn5_4sb}
### 応答本文のパラメーター (JSON) {#quotemgmt-GET-id__section_ilb_1qx_kqb}
{#quotemgmt-GET-id__table_jlb_1qx_kqb__entry__2}
| 名前 | 説明 |
|-|-|
| contactMedium | 連絡先メディアのリスト。見積もり依頼者に関連する連絡先情報。 "contactMedium": [ { "city": "String", "country": "String", "locationId": "String", "mediumType": "String", "postCode": "String", "stateOrProvince": "String", "street": "String", "@type": "String" } ] |
| contactMedium.city | 見積もり依頼者が居住する市区町村。 データタイプ：文字列 |
| contactMedium.country | 見積もり依頼者が居住する国。 データタイプ：文字列 |
| contactMedium.locationId | 場所 \[cmn_location\] テーブルまたはカスタム住所にリストされている場所のSys_id。 データタイプ：文字列 |
| contactMedium.mediumType | メールアドレス、電話番号、住所などの連絡先メディアのタイプ。 データタイプ：文字列 |
| contactMedium.postCode | 見積もり依頼者の郵便番号。 データタイプ：文字列 |
| contactMedium.stateOrProvince | 見積もり依頼者が所在する都道府県。 データタイプ：文字列 |
| contactMedium.street | 見積もり依頼者の番地。 データタイプ：文字列 |
| contactMedium.@type | TMF Open API 標準に従ったメディアのタイプ。たとえば、「 GeographicalAddressContactMedium」のように入力します。 データタイプ：文字列 |
| 説明 | 見積もりの説明。 データタイプ：文字列 |
| ExpectedQuoteCompletionDate | 見積もりサプライヤーがこの見積もりに対する応答を返送できるようになる予定日。 データタイプ：文字列 |
| externalId | コンシューマーが提供する見積もりの一意の ID。 データタイプ：文字列 |
| href | 見積もりにアクセスするための相対リンク。 データタイプ：文字列 デフォルト:空の文字列 |
| ID | 要求された見積もりのSys_id。 テーブル:見積もり \[sn_quote_mgmt_core_quote\] データタイプ：文字列 |
| 注意 | 見積もりに関連付けられたメモのリスト。 データタイプ：アレイ "note": [ { "author": "String", "date": "String", "text": "String", "@type": "String" } ] |
| note.author | 関連するメモの作成者のユーザー名。 データタイプ：文字列 |
| note.date | メモが作成された日付。 データタイプ：文字列 |
| note.text | メモの内容。 データタイプ：文字列 |
| note.@type | この値は常に Noteです。 データタイプ：文字列 |
| 見積日 | 見積もりが作成された日時。 データタイプ：文字列 |
| 見積もりアイテム | 見積もりアイテムのリスト。各見積もりアイテムは、見積もり対象の製品のアクションを記述します。 "quoteItem": [ { "action": "String", "id": "String", "product": {Object}, "productOffering": {Object}, "quantity": Number, "state": "String", "@type": "String" } ] データタイプ：オブジェクトのアレイ |
| quoteItem.action | この見積アイテムに対して実行するアクション (追加、変更、削除など)。 データタイプ：文字列 |
| quoteItem.id | 見積もりアイテムのSys_id。 テーブル:見積品目 \[sn_quote_mgmt_core_quote_line_item\] データタイプ：文字列 |
| quoteItem.product | 見積もりに含まれる製品のリスト。 "product": { "characteristic": "String", "specification": "String", "@type": "String" } データタイプ: オブジェクト |
| quoteItem.product. 特性 | 製品特性のリスト。 データタイプ：オブジェクトのアレイ "characteristic": [ { "id": "String", "name": "String", "@type": "String", "value": "String" } ] 「[Create product characteristics and characteristic options](https://www.servicenow.com/docs/access?context=som-product-config-add-characteristics&version=australia&pubname=australia-order-management&ft:locale=en-US)」を参照してください。 |
| quoteItem.product. characteristic.id | 製品特性のSys_id。 テーブル:見積品目の特性 \[sn_quote_mgmt_core_quote_line_characteristic\] データタイプ：文字列 |
| quoteItem.product. characteristic.name | 製品特性の名前。 データタイプ：文字列 |
| quoteItem.product. characteristic.@type | この値は常に StringCharacteristic です。 データタイプ：文字列 |
| quoteItem.product. characteristic.value | 特性の値。 データタイプ：文字列 |
| quoteItem.product を指定します。 | 顧客または関係者の役割を果たすその他の関係者に対して、ProductOffering の形式で外部から提供される有形または無形のオブジェクトの詳細な説明。 データタイプ：文字列 |
| quoteItem.product.@type | この値は常に Product です。 データタイプ：文字列 |
| quoteItem.productOffering | 製品オファリング参照 (ProductOfferingRef)。製品オファリングは、カタログのプロバイダーから注文可能なエンティティを表します。 "productOffering": { "href": "String", "name": "String", "name": "String", "@type": "String" } データタイプ: オブジェクト |
| quoteItem です。productOffering.href | 関連エンティティの参照。 データタイプ：文字列 |
| quoteItem です。productOffering.id | 製品オファリングのSys_id。 テーブル:製品オファリング \[sn_prd_pm_product_offering\] データタイプ：文字列 |
| quoteItem です。productOffering.name | 関連エンティティの名前。 データタイプ：文字列 |
| quoteItem です。productOffering.@type | この値は常に ProductOfferingRef です。 データタイプ：文字列 |
| quoteItem.quantity | この見積アイテムに要求された数量。 データタイプ：数値 |
| quoteItem.state | 見積もり状態の種類 (QuoteStateType)。見積もりのステータス。 データタイプ：文字列 |
| quoteItem.@type | この値は常に QuoteItem です。 データタイプ：文字列 |
| quoteNumber | 見積もりにアサインされた見積品目レコード番号。 テーブル:見積品目 \[sn_quote_mgmt_core_quote_line_item\] データタイプ：文字列 |
| 関連パーティー | 注文の連絡先のリスト。 データタイプ：オブジェクトのアレイ "relatedParty": [ { "id": "String", "name": "String", "@referredType": "String", "role": "String", "@type": "String" } ] |
| relatedParty.id | アカウント、連絡先、または顧客を取得する見積もりテーブルSys_id。 テーブル:見積もり \[sn_quote_mgmt_core_quote\] データタイプ：文字列 |
| relatedParty.name | アカウント、顧客、またはコンシューマーの名前。 データタイプ：文字列 |
| relatedParty.@referredType | 顧客のタイプ。 可能な値： * コンシューマー * 顧客 * 顧客連絡先 {#quotemgmt-GET-id__ul_oc5_dc2_hqb} データタイプ：文字列 |
| relatedParty.role | 見積もりのコンテキストでの関係者のロール (アカウント、連絡先、顧客など)。 データタイプ：文字列 |
| relatedParty.@type | この値は常に ProductOfferingRef です。 データタイプ：文字列 |
| requestedQuoteCompletionDate | 日時 (DateTime)。この値は、見積もり依頼者が指定した、この見積もりに対する完全な応答を受信する日付を表します。 データタイプ：文字列 |
| 状況 | 見積もりアイテムのステータス。 データタイプ：文字列 |
| @type | リソースのタイプ。この値は常に [見積もり] です。この情報は保存されません。 データタイプ：文字列 |
[ ]
{#quotemgmt-GET-id__table_jlb_1qx_kqb}
### cURL 要求
次の例では、指定された見積もりを取得します。
curl "https://instance.service-now.com/api/sn_tmf_api/quote_management_api/quote/04ba9004f11f3110f8777d7194f166f6" \
--request GET \
--header "Accept:application/json" \
--user 'userName':'password'
応答本文。
{
"id": "47e562bad565a610f8774663edf0ac10",
"quoteNumber": "QT0001001",
"href": "api/sn_tmf_api/quote_management_api/quote/47e562bad565a610f8774663edf0ac10",
"@type": "Quote",
"description": "Testing Quote",
"expectedQuoteCompletionDate": "2025-05-23 11:12:08",
"externalId": "Test_1234",
"quoteDate": "2025-05-20 11:11:13",
"requestedQuoteCompletionDate": "2025-05-23 11:12:08",
"version": "3",
"agreement": [],
"contactMedium": [
{
"@type": "GeographicalAddressContactMedium",
"mediumType": "ShippingAddressRef",
"locationId": "6774fee611383110f877366201dea64f",
"city": "Santa Clara",
"country": "USA",
"postCode": "94560",
"stateOrProvince": "CA",
"street": "222 Star St"
}
],
"note": [],
"quoteItem": [
{
"id": "8be562bad565a610f8774663edf0ac16",
"@type": "QuoteItem",
"action": "add",
"quantity": "1",
"state": "Draft",
"product": {
"@type": "Product",
"productCharacteristic": [
{
"id": "0fe562bad565a610f8774663edf0ac17",
"name": "Voice Pack",
"value": "1500 Minutes/Month"
},
{
"id": "4be562bad565a610f8774663edf0ac17",
"name": "SMS Pack",
"value": "700 /Month"
},
{
"id": "83e562bad565a610f8774663edf0ac18",
"name": "Data Pack",
"value": "20 GB/Month"
},
{
"id": "87e562bad565a610f8774663edf0ac17",
"name": "Mobile Number",
"value": ""
},
{
"id": "cfe562bad565a610f8774663edf0ac17",
"name": "Shipping Address",
"value": ""
}
],
"productSpecification": {
"id": "3ee1fdb1c3331010d216b5183c40dd81",
"href": "api/sn_tmf_api/catalogmanagement/productSpecification/3ee1fdb1c3331010d216b5183c40dd81",
"name": "Mobile Plan",
"@type": "ProductSpecificationRef"
}
},
"productOffering": {
"id": "2cb5588fc30020105252716b7d40dddd",
"href": "api/sn_tmf_api/catalogmanagement/productOffering/2cb5588fc30020105252716b7d40dddd",
"name": "All in one mobile plan starting from $49/month",
"@type": "ProductOfferingRef"
},
"quoteItemPrice": [
{
"description": "Standard Price List",
"name": "Standard Price List",
"priceType": "Recurring",
"recurringChargePeriod": "",
"unitOfMeasure": "",
"unitMarginPercentage": "",
"price": {
"totalOneTimePrice": {
"unit": "USD",
"value": 0
},
"monthlyRecurringPrice": {
"unit": "USD",
"value": 0
},
"annualRecurringPrice": {
"unit": "USD",
"value": 0
},
"cumulativeRecurringPrice": {
"unit": "USD",
"value": 0
},
"cumulativeAnnualRecurringPrice": {
"unit": "USD",
"value": 0
},
"cumulativeNetPrice": {
"unit": "USD",
"value": 0
},
"unitMarginAmount": {
"unit": "USD",
"value": 0
},
"unitMarginBasePrice": {
"unit": "USD",
"value": 0
},
"listPrice": {
"unit": "USD",
"value": 0
},
"unitCost": {
"unit": "USD",
"value": 0
},
"unitPrice": {
"unit": "USD",
"value": 0
},
"dutyFreeAmount": {
"unit": "USD",
"value": 0
},
"taxIncludedAmount": {
"unit": "USD",
"value": 0
}
},
"priceAlteration": []
}
]
}
],
"relatedParty": [
{
"role": "Customer",
"id": "9e2fd2ee11b43110f877366201dea674",
"name": "Startech svcs",
"@type": "RelatedPartyRef",
"@referredType": "Organization"
},
{
"role": "CustomerContact",
"id": "dca96eaa11f43110f877366201dea6c1",
"name": "Alex Star",
"@type": "RelatedPartyRef",
"@referredType": "Individual"
}
],
"state": "Draft"
}
## 見積管理 API - PATCH /sn_tmf_api/quote_management_api/quote/{id} {#ariaid-title5}
指定された見積もりを更新します。
### URL 形式 {#quotemgmt-PATCH-id__section_uk2_4v2_yfc}
バージョニングされた URL: /api/sn_tmf_api/{api_version}/quote_management_api/quote/{id}
デフォルト URL: /api/sn_tmf_api/quote_management_api/quote/{id}
### サポートされている要求パラメーター
{#quotemgmt-PATCH-id__entry__2}
| 名前 | 説明 |
|-|-|
| ID | 更新する見積もりのSys_id。 データタイプ：文字列 テーブル:見積もり \[sn_quote_mgmt_core_quote\] |
[表 : 19. パスパラメーター]
{#quotemgmt-PATCH-id__entry__6}
| 名前 | 説明 |
|-|-|
| なし | |
[表 : 20. クエリパラメーター]
{#quotemgmt-PATCH-id__table_m32_1l1_hwb__entry__2}
| 名前 | 説明 |
|-|-|
| contactMedium | 連絡先メディアのリスト。見積もり依頼者に関連する連絡先情報。 "contactMedium": [ { "city": "String", "country": "String", "locationId": "String", "mediumType": "String", "postCode": "String", "stateOrProvince": "String", "street": "String", "@type": "String" } ] |
| contactMedium.city | 見積もり依頼者が居住する市区町村。 データタイプ：文字列 |
| contactMedium.country | 見積もり依頼者が居住する国。 データタイプ：文字列 |
| contactMedium.locationId | 場所 \[cmn_location\] テーブルまたはカスタム住所にリストされている場所のSys_id。 データタイプ：文字列 |
| contactMedium.mediumType | メールアドレス、電話番号、住所などの連絡先メディアのタイプ。 データタイプ：文字列 |
| contactMedium.postCode | 見積もり依頼者の郵便番号。 データタイプ：文字列 |
| contactMedium.stateOrProvince | 見積もり依頼者が所在する都道府県。 データタイプ：文字列 |
| contactMedium.street | 見積もり依頼者の番地。 データタイプ：文字列 |
| contactMedium.@type | TMF Open API 標準に従ったメディアのタイプ。たとえば、「 GeographicalAddressContactMedium」のように入力します。 データタイプ：文字列 |
| 説明 | 見積もりの説明。 データタイプ：文字列 |
| 手記 | 見積もりに関連付けられたメモのリスト。 データタイプ：アレイ "note": [ { "text": "String", "@type": "String" } ] |
| note.text | メモの内容。 データタイプ：文字列 |
| note.@type | この値は常に Noteです。 データタイプ：文字列 |
| 見積日 | 見積もりが作成された日時。 データタイプ：文字列 |
| 見積もりアイテム | 見積もりアイテムのリスト。各見積もりアイテムは、見積もり対象の製品のアクションを記述します。 "quoteItem": [ { "action": "String", "id": "String", "product": {Object}, "productOffering": {Object}, "productRelationship": {Object}, "quantity": Number, "state": "String", "@type": "String" } ] データタイプ：オブジェクトのアレイ |
| quoteItem.action | この見積アイテムに対して実行するアクション (追加、変更、削除など)。 データタイプ：文字列 |
| quoteItem.id | 見積もりアイテムのSys_id。 テーブル:見積品目 \[sn_quote_mgmt_core_quote_line_item\] データタイプ：文字列 |
| quoteItem.product | 見積もりに含まれる製品のリスト。 "product": { "characteristic": "String", "specification": "String", "@type": "String" } データタイプ: オブジェクト |
| quoteItem.product. 特性 | 製品特性のリスト。 データタイプ：オブジェクトのアレイ "characteristic": [ { "id": "String", "name": "String", "@type": "String", "value": "String" } ] 「[Create product characteristics and characteristic options](https://www.servicenow.com/docs/access?context=som-product-config-add-characteristics&version=australia&pubname=australia-order-management&ft:locale=en-US)」を参照してください。 |
| quoteItem.product. characteristic.id | 製品特性のSys_id。 テーブル:見積品目の特性 \[sn_quote_mgmt_core_quote_line_characteristic\] データタイプ：文字列 |
| quoteItem.product. characteristic.name | 製品特性の名前。 データタイプ：文字列 |
| quoteItem.product. characteristic.@type | この値は常に StringCharacteristic です。 データタイプ：文字列 |
| quoteItem.product. characteristic.value | 特性の値。 データタイプ：文字列 |
| quoteItem.product を指定します。 | 顧客または関係者の役割を果たすその他の関係者に対して、ProductOffering の形式で外部から提供される有形または無形のオブジェクトの詳細な説明。 データタイプ：文字列 |
| quoteItem.product.@type | この値は常に Product です。 データタイプ：文字列 |
| quoteItem.productOffering | 製品オファリング参照 (ProductOfferingRef)。製品オファリングは、カタログのプロバイダーから注文可能なエンティティを表します。 "productOffering": { "href": "String", "name": "String", "name": "String", "@type": "String" } データタイプ: オブジェクト |
| quoteItem です。productOffering.href | 関連エンティティの参照。 データタイプ：文字列 |
| quoteItem です。productOffering.id | 製品オファリングのSys_id。 テーブル:製品オファリング \[sn_prd_pm_product_offering\] データタイプ：文字列 |
| quoteItem です。productOffering.name | 関連エンティティの名前。 データタイプ：文字列 |
| quoteItem です。productOffering.@type | この値は常に ProductOfferingRef です。 データタイプ：文字列 |
| quoteItem.productRelationship | 見積もりアイテムのリスト。各見積もりアイテムは、見積もり対象の製品のアクションを記述します。 "productRelationship": [ { "product": "String", "relationshipType": "String" } ] データタイプ：オブジェクトのアレイ |
| quoteItem.productRelationship. 製品 | 製品の参照または値 (ProductRefOrValue)。値によって定義される作成される製品、または参照によって定義される既存の製品。 製品は次のいずれかの基準を満たしています。 * 値で定義された保留中の製品の作成。 * 参照により定義された既存の製品。 {#quotemgmt-PATCH-id__ul_wyw_n2d_zfc} データタイプ：文字列 |
| quoteItem.productRelationship. relationshipType | 製品がバンドルであり、その中のバンドル製品を説明する場合は「 バンドル」 など、製品の関係のタイプ。 データタイプ：文字列 |
| quoteItem.quantity | この見積アイテムに要求された数量。 データタイプ：数値 |
| quoteItem.state | 見積もり状態の種類 (QuoteStateType)。見積もりのステータス。 データタイプ：文字列 |
| quoteItem.@type | この値は常に QuoteItem です。 データタイプ：文字列 |
| 関連パーティー | 注文の連絡先のリスト。 データタイプ：オブジェクトのアレイ "relatedParty": [ { "id": "String", "name": "String", "@referredType": "String", "role": "String", "@type": "String" } ] |
| relatedParty.id | アカウント、連絡先、または顧客を取得する見積もりテーブルSys_id。 テーブル:見積もり \[sn_quote_mgmt_core_quote\] データタイプ：文字列 |
| relatedParty.name | アカウント、顧客、またはコンシューマーの名前。 データタイプ：文字列 |
| relatedParty.@referredType | 顧客のタイプ。 可能な値： * コンシューマー * 顧客 * 顧客連絡先 {#quotemgmt-PATCH-id__ul_oc5_dc2_hqb} データタイプ：文字列 |
| relatedParty.role | 見積もりのコンテキストでの関係者のロール (アカウント、連絡先、顧客など)。 データタイプ：文字列 |
| relatedParty.@type | この値は常に ProductOfferingRef です。 データタイプ：文字列 |
| 状況 | 見積もりアイテムのステータス。 データタイプ：文字列 |
| @type | リソースのタイプ。この値は常に [見積もり] です。この情報は保存されません。 データタイプ：文字列 |
[表 : 21. 要求本文パラメーター (JSON)]
{#quotemgmt-PATCH-id__table_m32_1l1_hwb}
### ヘッダー
次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")を参照してください。
{#quotemgmt-PATCH-id__table_omb_dvk_5rb__entry__2}{#quotemgmt-PATCH-id__accept-JSON-only-entry-RESTAPI}{#quotemgmt-PATCH-id__content_type-JSON-only-entry-RESTAPI}
| ヘッダー | 説明 |
|-|-|
| 承認 | 応答本文のデータフォーマット。application/json のみをサポートします。 |
| Content-Type | 要求本文のデータ形式。application/json のみをサポートします。 |
[表 : 22. 要求ヘッダー]
{#quotemgmt-PATCH-id__table_omb_dvk_5rb} {#quotemgmt-PATCH-id__table_tzy_thy_ksb__entry__2}
| ヘッダー | 説明 |
|-|-|
| Content-Type | 応答本文のデータフォーマット。application/json のみをサポートします。 |
[表 : 23. 応答ヘッダー]
{#quotemgmt-PATCH-id__table_tzy_thy_ksb}
### ステータスコード
この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")」を参照してください。
{#quotemgmt-PATCH-id__table_xfv_2vk_5rb__entry__2}{#quotemgmt-PATCH-id__tmf-get-status-200-p}
| ステータスコード | 説明 |
|-|-|
| 200 | 要求が正常に処理されました。応答で返された完全なリソース (ページネーションなし)。 |
| 400 | 要求が正しくありません。考えられる理由: * 無効なパスパラメーター * 無効な URI {#quotemgmt-PATCH-id__ul_rys_1gy_fsb} |
| 404 | レコードが見つかりません。クエリパラメーターに一致するレコードがテーブルに見つかりません。 |
[表 : 24. ステータスコード]
{#quotemgmt-PATCH-id__table_xfv_2vk_5rb}
### 応答本文のパラメーター (JSON) {#quotemgmt-PATCH-id__section_b1v_xpk_5rb}
{#quotemgmt-PATCH-id__table_t5s_hm1_hwb__entry__2}
| 名前 | 説明 |
|-|-|
| contactMedium | 連絡先メディアのリスト。見積もり依頼者に関連する連絡先情報。 "contactMedium": [ { "city": "String", "country": "String", "locationId": "String", "mediumType": "String", "postCode": "String", "stateOrProvince": "String", "street": "String", "@type": "String" } ] |
| contactMedium.city | 見積もり依頼者が居住する市区町村。 データタイプ：文字列 |
| contactMedium.country | 見積もり依頼者が居住する国。 データタイプ：文字列 |
| contactMedium.locationId | 場所 \[cmn_location\] テーブルまたはカスタム住所にリストされている場所のSys_id。 データタイプ：文字列 |
| contactMedium.mediumType | メールアドレス、電話番号、住所などの連絡先メディアのタイプ。 データタイプ：文字列 |
| contactMedium.postCode | 見積もり依頼者の郵便番号。 データタイプ：文字列 |
| contactMedium.stateOrProvince | 見積もり依頼者が所在する都道府県。 データタイプ：文字列 |
| contactMedium.street | 見積もり依頼者の番地。 データタイプ：文字列 |
| contactMedium.@type | TMF Open API 標準に従ったメディアのタイプ。たとえば、「 GeographicalAddressContactMedium」のように入力します。 データタイプ：文字列 |
| 説明 | 見積もりの説明。 データタイプ：文字列 |
| 手記 | 見積もりに関連付けられたメモのリスト。 データタイプ：アレイ "note": [ { "text": "String", "@type": "String" } ] |
| note.text | メモの内容。 データタイプ：文字列 |
| note.@type | この値は常に Noteです。 データタイプ：文字列 |
| 見積日 | 見積もりが作成された日時。 データタイプ：文字列 |
| 見積もりアイテム | 見積もりアイテムのリスト。各見積もりアイテムは、見積もり対象の製品のアクションを記述します。 "quoteItem": [ { "action": "String", "id": "String", "product": {Object}, "productOffering": {Object}, "productRelationship": {Object}, "quantity": Number, "state": "String", "@type": "String" } ] データタイプ：オブジェクトのアレイ |
| quoteItem.action | この見積アイテムに対して実行するアクション (追加、変更、削除など)。 データタイプ：文字列 |
| quoteItem.id | 見積もりアイテムのSys_id。 テーブル:見積品目 \[sn_quote_mgmt_core_quote_line_item\] データタイプ：文字列 |
| quoteItem.product | 見積もりに含まれる製品のリスト。 "product": { "characteristic": "String", "specification": "String", "@type": "String" } データタイプ: オブジェクト |
| quoteItem.product. 特性 | 製品特性のリスト。 データタイプ：オブジェクトのアレイ "characteristic": [ { "id": "String", "name": "String", "@type": "String", "value": "String" } ] 「[Create product characteristics and characteristic options](https://www.servicenow.com/docs/access?context=som-product-config-add-characteristics&version=australia&pubname=australia-order-management&ft:locale=en-US)」を参照してください。 |
| quoteItem.product. characteristic.id | 製品特性のSys_id。 テーブル:見積品目の特性 \[sn_quote_mgmt_core_quote_line_characteristic\] データタイプ：文字列 |
| quoteItem.product. characteristic.name | 製品特性の名前。 データタイプ：文字列 |
| quoteItem.product. characteristic.@type | この値は常に StringCharacteristic です。 データタイプ：文字列 |
| quoteItem.product. characteristic.value | 特性の値。 データタイプ：文字列 |
| quoteItem.product を指定します。 | 顧客または関係者の役割を果たすその他の関係者に対して、ProductOffering の形式で外部から提供される有形または無形のオブジェクトの詳細な説明。 データタイプ：文字列 |
| quoteItem.product.@type | この値は常に Product です。 データタイプ：文字列 |
| quoteItem.productOffering | 製品オファリング参照 (ProductOfferingRef)。製品オファリングは、カタログのプロバイダーから注文可能なエンティティを表します。 "productOffering": { "href": "String", "name": "String", "name": "String", "@type": "String" } データタイプ: オブジェクト |
| quoteItem です。productOffering.href | 関連エンティティの参照。 データタイプ：文字列 |
| quoteItem です。productOffering.id | 製品オファリングのSys_id。 テーブル:製品オファリング \[sn_prd_pm_product_offering\] データタイプ：文字列 |
| quoteItem です。productOffering.name | 関連エンティティの名前。 データタイプ：文字列 |
| quoteItem です。productOffering.@type | この値は常に ProductOfferingRef です。 データタイプ：文字列 |
| quoteItem.productRelationship | 見積もりアイテムのリスト。各見積もりアイテムは、見積もり対象の製品のアクションを記述します。 "productRelationship": [ { "product": "String", "relationshipType": "String" } ] データタイプ：オブジェクトのアレイ |
| quoteItem.productRelationship. 製品 | 製品の参照または値 (ProductRefOrValue)。値によって定義される作成される製品、または参照によって定義される既存の製品。 製品は次のいずれかの基準を満たしています。 * 値で定義された保留中の製品の作成。 * 参照により定義された既存の製品。 {#quotemgmt-PATCH-id__ul_wwj_yb3_zfc} データタイプ：文字列 |
| quoteItem.productRelationship. relationshipType | 製品がバンドルであり、その中のバンドル製品を説明する場合は「 バンドル」 など、製品の関係のタイプ。 データタイプ：文字列 |
| quoteItem.quantity | この見積アイテムに要求された数量。 データタイプ：数値 |
| quoteItem.state | 見積もり状態の種類 (QuoteStateType)。見積もりのステータス。 データタイプ：文字列 |
| quoteItem.@type | この値は常に QuoteItem です。 データタイプ：文字列 |
| 関連パーティー | 注文の連絡先のリスト。 データタイプ：オブジェクトのアレイ "relatedParty": [ { "id": "String", "name": "String", "@referredType": "String", "role": "String", "@type": "String" } ] |
| relatedParty.id | アカウント、連絡先、または顧客を取得する見積もりテーブルSys_id。 テーブル:見積もり \[sn_quote_mgmt_core_quote\] データタイプ：文字列 |
| relatedParty.name | アカウント、顧客、またはコンシューマーの名前。 データタイプ：文字列 |
| relatedParty.@referredType | 顧客のタイプ。 可能な値： * コンシューマー * 顧客 * 顧客連絡先 {#quotemgmt-PATCH-id__ul_xwj_yb3_zfc} データタイプ：文字列 |
| relatedParty.role | 見積もりのコンテキストでの関係者のロール (アカウント、連絡先、顧客など)。 データタイプ：文字列 |
| relatedParty.@type | この値は常に ProductOfferingRef です。 データタイプ：文字列 |
| 状況 | 見積もりアイテムのステータス。 データタイプ：文字列 |
| @type | リソースのタイプ。この値は常に [見積もり] です。この情報は保存されません。 データタイプ：文字列 |
[ ]
{#quotemgmt-PATCH-id__table_t5s_hm1_hwb}
### cURL 要求 {#quotemgmt-PATCH-id__example_jsc_1dc_vrb}
この例では、見積もりを更新する方法を示します。
curl "https://k8s0747687-node1.thunder.devsnc.com/api/sn_tmf_api/quote_management_api/quote/cb15734fd5692a10f8774663edf0ac19" \
--request PATCH \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
\"@type\": \"Quote\",
\"description\": \"Quote for Internet and OTT Bundle\",
\"contactMedium\": [
{
\"@type\": \"GeographicalAddressContactMedium\",
\"mediumType\": \"ShippingAddressRef\",
\"locationId\": \"25ab96060a0a0bb300a6d66ce72095f2\",
\"city\": \"Santa Clara\",
\"country\": \"USA\",
\"postCode\": \"95050\",
\"stateOrProvince\": \"CA\",
\"street\": \"2866 Stevens Creek Blvd\"
}
],
\"note\": [
{
\"@type\": \"Note\",
\"text\": \"This is a quote request following today call\"
}
],
\"quoteItem\": [
{
\"id\": \"086be79bd5e1aa10f8774663edf0acba\",
\"@type\": \"QuoteItem\",
\"action\": \"add\",
\"quantity\": \"1\",
\"state\": \"Draft\",
\"product\": {
\"@type\": \"Product\"
},
\"productOffering\": {
\"id\": \"ffeb447211bc3110f877366201dea6df\",
\"name\": \"Internet and OTT Bundle\",
\"@type\": \"ProductOfferingRef\"
},
\"productRelationship\": [
{
\"product\": \"597bab9bd5e1aa10f8774663edf0ac1b\",
\"relationshipType\": \"HasChild\"
},
{
\"product\": \"d57bab9bd5e1aa10f8774663edf0ac1a\",
\"relationshipType\": \"HasChild\"
},
{
\"product\": \"d57bab9bd5e1aa10f8774663edf0ac1c\",
\"relationshipType\": \"HasChild\"
}
]
},
{
\"id\": \"d57bab9bd5e1aa10f8774663edf0ac1a\",
\"@type\": \"QuoteItem\",
\"action\": \"add\",
\"quantity\": \"1\",
\"state\": \"Draft\",
\"product\": {
\"@type\": \"Product\"
},
\"productOffering\": {
\"id\": \"0761dd9fd0a63110f8770dbf976be173\",
\"name\": \"Solana Modem N Series\",
\"@type\": \"ProductOfferingRef\"
},
\"productRelationship\": [
{
\"product\": \"086be79bd5e1aa10f8774663edf0acba\",
\"relationshipType\": \"HasParent\"
}
]
},
{
\"id\": \"597bab9bd5e1aa10f8774663edf0ac1b\",
\"@type\": \"QuoteItem\",
\"action\": \"add\",
\"quantity\": \"1\",
\"state\": \"Draft\",
\"product\": {
\"@type\": \"Product\"
},
\"productOffering\": {
\"id\": \"8b61dd9fd0a63110f8770dbf976be140\",
\"name\": \"Basic internet - 100 Mbps Plan\",
\"@type\": \"ProductOfferingRef\"
},
\"productRelationship\": [
{
\"product\": \"086be79bd5e1aa10f8774663edf0acba\",
\"relationshipType\": \"HasParent\"
}
]
},
{
\"id\": \"d57bab9bd5e1aa10f8774663edf0ac1c\",
\"@type\": \"QuoteItem\",
\"action\": \"add\",
\"quantity\": \"1\",
\"state\": \"Draft\",
\"product\": {
\"@type\": \"Product\"
},
\"productOffering\": {
\"id\": \"62619d9fd0a63110f8770dbf976be180\",
\"name\": \"Solana Movie streaming channel\",
\"@type\": \"ProductOfferingRef\"
},
\"productRelationship\": [
{
\"product\": \"086be79bd5e1aa10f8774663edf0acba\",
\"relationshipType\": \"HasParent\"
}
]
},
{
\"id\": \"797ca71fd5e1aa10f8774663edf0ac2b\",
\"@type\": \"QuoteItem\",
\"action\": \"add\",
\"quantity\": \"1\",
\"state\": \"Draft\",
\"product\": {
\"@type\": \"Product\",
\"productCharacteristic\": [
{
\"name\": \"Internet breakout\",
\"value\": \"No\"
},
{
\"name\": \"Quality of Service\",
\"value\": \"Basic\"
},
{
\"name\": \"Speed\",
\"value\": \"High\"
}
],
\"productSpecification\": {
\"id\": \"cd81594e74ae4a10f877468e695efa81\",
\"name\": \"VPN Site PS\",
\"@type\": \"ProductSpecificationRef\"
}
},
\"productOffering\": {
\"id\": \"6c3d1e86a5e20210f8774c9b4be6ce42\",
\"name\": \"VPN Site\",
\"@type\": \"ProductOfferingRef\"
},
\"productRelationship\": [
{
\"product\": \"7f8c6b1fd5e1aa10f8774663edf0ac71\",
\"relationshipType\": \"HasChild\"
},
{
\"product\": \"bb8c6b1fd5e1aa10f8774663edf0ac73\",
\"relationshipType\": \"HasChild\"
},
{
\"product\": \"bf8c6b1fd5e1aa10f8774663edf0ac70\",
\"relationshipType\": \"HasChild\"
},
{
\"product\": \"fb8c6b1fd5e1aa10f8774663edf0ac72\",
\"relationshipType\": \"HasChild\"
}
]
},
{
\"id\": \"bf8c6b1fd5e1aa10f8774663edf0ac70\",
\"@type\": \"QuoteItem\",
\"action\": \"add\",
\"quantity\": \"1\",
\"state\": \"Draft\",
\"product\": {
\"@type\": \"Product\"
},
\"productOffering\": {
\"id\": \"2c265d4274ee4a10f877468e695efa45\",
\"name\": \"Maintenance Fee\",
\"@type\": \"ProductOfferingRef\"
},
\"productRelationship\": [
{
\"product\": \"797ca71fd5e1aa10f8774663edf0ac2b\",
\"relationshipType\": \"HasParent\"
}
]
},
{
\"id\": \"7f8c6b1fd5e1aa10f8774663edf0ac71\",
\"@type\": \"QuoteItem\",
\"action\": \"add\",
\"quantity\": \"1\",
\"state\": \"Draft\",
\"product\": {
\"@type\": \"Product\"
},
\"productOffering\": {
\"id\": \"4466d50674ee4a10f877468e695efa0d\",
\"name\": \"Security Fee\",
\"@type\": \"ProductOfferingRef\"
},
\"productRelationship\": [
{
\"product\": \"797ca71fd5e1aa10f8774663edf0ac2b\",
\"relationshipType\": \"HasParent\"
}
]
},
{
\"id\": \"fb8c6b1fd5e1aa10f8774663edf0ac72\",
\"@type\": \"QuoteItem\",
\"action\": \"add\",
\"quantity\": \"1\",
\"state\": \"Draft\",
\"product\": {
\"@type\": \"Product\",
\"productCharacteristic\": [
{
\"name\": \"Speed\",
\"value\": \"High\"
},
{
\"name\": \"Internet breakout\",
\"value\": \"No\"
}
],
\"productSpecification\": {
\"id\": \"ee4f8d8a74ae4a10f877468e695efa3f\",
\"name\": \"VPN Endpoint PS\",
\"@type\": \"ProductSpecificationRef\"
}
},
\"productOffering\": {
\"id\": \"7acc9e46a5e20210f8774c9b4be6ce9e\",
\"name\": \"VPN Endpoint\",
\"@type\": \"ProductOfferingRef\"
},
\"productRelationship\": [
{
\"product\": \"797ca71fd5e1aa10f8774663edf0ac2b\",
\"relationshipType\": \"HasParent\"
}
]
},
{
\"id\": \"bb8c6b1fd5e1aa10f8774663edf0ac73\",
\"@type\": \"QuoteItem\",
\"action\": \"add\",
\"quantity\": \"1\",
\"state\": \"Draft\",
\"product\": {
\"@type\": \"Product\",
\"productCharacteristic\": [
{
\"name\": \"Quality of Service\",
\"value\": \"Basic\"
}
],
\"productSpecification\": {
\"id\": \"3ba0914e74ae4a10f877468e695efa6e\",
\"name\": \"VPN Firewall PS\",
\"@type\": \"ProductSpecificationRef\"
}
},
\"productOffering\": {
\"id\": \"4407d90674ee4a10f877468e695efaab\",
\"name\": \"VPN Firewall\",
\"@type\": \"ProductOfferingRef\"
},
\"productRelationship\": [
{
\"product\": \"797ca71fd5e1aa10f8774663edf0ac2b\",
\"relationshipType\": \"HasParent\"
}
]
}
],
\"relatedParty\": [
{
\"role\": \"Customer\",
\"id\": \"9e2fd2ee11b43110f877366201dea674\",
\"name\": \"Startech svcs\",
\"@type\": \"RelatedPartyRef\",
\"@referredType\": \"Organization\"
}
],
\"state\": \"Draft\"
}" \
--user 'userName':'password'
応答本文。
{
"@type": "Quote",
"description": "Quote for Internet and OTT Bundle",
"contactMedium": [
{
"@type": "GeographicalAddressContactMedium",
"mediumType": "ShippingAddressRef",
"locationId": "25ab96060a0a0bb300a6d66ce72095f2",
"city": "Santa Clara",
"country": "USA",
"postCode": "95050",
"stateOrProvince": "CA",
"street": "2866 Stevens Creek Blvd"
}
],
"note": [
{
"@type": "Note",
"text": "This is a quote request following today call"
}
],
"quoteItem": [
{
"id": "086be79bd5e1aa10f8774663edf0acba",
"@type": "QuoteItem",
"action": "add",
"quantity": "1",
"state": "Draft",
"product": {
"@type": "Product"
},
"productOffering": {
"id": "ffeb447211bc3110f877366201dea6df",
"name": "Internet and OTT Bundle",
"@type": "ProductOfferingRef"
},
"productRelationship": [
{
"product": "597bab9bd5e1aa10f8774663edf0ac1b",
"relationshipType": "HasChild"
},
{
"product": "d57bab9bd5e1aa10f8774663edf0ac1a",
"relationshipType": "HasChild"
},
{
"product": "d57bab9bd5e1aa10f8774663edf0ac1c",
"relationshipType": "HasChild"
}
]
},
{
"id": "d57bab9bd5e1aa10f8774663edf0ac1a",
"@type": "QuoteItem",
"action": "add",
"quantity": "1",
"state": "Draft",
"product": {
"@type": "Product"
},
"productOffering": {
"id": "0761dd9fd0a63110f8770dbf976be173",
"name": "Solana Modem N Series",
"@type": "ProductOfferingRef"
},
"productRelationship": [
{
"product": "086be79bd5e1aa10f8774663edf0acba",
"relationshipType": "HasParent"
}
]
},
{
"id": "597bab9bd5e1aa10f8774663edf0ac1b",
"@type": "QuoteItem",
"action": "add",
"quantity": "1",
"state": "Draft",
"product": {
"@type": "Product"
},
"productOffering": {
"id": "8b61dd9fd0a63110f8770dbf976be140",
"name": "Basic internet - 100 Mbps Plan",
"@type": "ProductOfferingRef"
},
"productRelationship": [
{
"product": "086be79bd5e1aa10f8774663edf0acba",
"relationshipType": "HasParent"
}
]
},
{
"id": "d57bab9bd5e1aa10f8774663edf0ac1c",
"@type": "QuoteItem",
"action": "add",
"quantity": "1",
"state": "Draft",
"product": {
"@type": "Product"
},
"productOffering": {
"id": "62619d9fd0a63110f8770dbf976be180",
"name": "Solana Movie streaming channel",
"@type": "ProductOfferingRef"
},
"productRelationship": [
{
"product": "086be79bd5e1aa10f8774663edf0acba",
"relationshipType": "HasParent"
}
]
},
{
"id": "797ca71fd5e1aa10f8774663edf0ac2b",
"@type": "QuoteItem",
"action": "add",
"quantity": "1",
"state": "Draft",
"product": {
"@type": "Product",
"productCharacteristic": [
{
"name": "Internet breakout",
"value": "No"
},
{
"name": "Quality of Service",
"value": "Basic"
},
{
"name": "Speed",
"value": "High"
}
],
"productSpecification": {
"id": "cd81594e74ae4a10f877468e695efa81",
"name": "VPN Site PS",
"@type": "ProductSpecificationRef"
}
},
"productOffering": {
"id": "6c3d1e86a5e20210f8774c9b4be6ce42",
"name": "VPN Site",
"@type": "ProductOfferingRef"
},
"productRelationship": [
{
"product": "7f8c6b1fd5e1aa10f8774663edf0ac71",
"relationshipType": "HasChild"
},
{
"product": "bb8c6b1fd5e1aa10f8774663edf0ac73",
"relationshipType": "HasChild"
},
{
"product": "bf8c6b1fd5e1aa10f8774663edf0ac70",
"relationshipType": "HasChild"
},
{
"product": "fb8c6b1fd5e1aa10f8774663edf0ac72",
"relationshipType": "HasChild"
}
]
},
{
"id": "bf8c6b1fd5e1aa10f8774663edf0ac70",
"@type": "QuoteItem",
"action": "add",
"quantity": "1",
"state": "Draft",
"product": {
"@type": "Product"
},
"productOffering": {
"id": "2c265d4274ee4a10f877468e695efa45",
"name": "Maintenance Fee",
"@type": "ProductOfferingRef"
},
"productRelationship": [
{
"product": "797ca71fd5e1aa10f8774663edf0ac2b",
"relationshipType": "HasParent"
}
]
},
{
"id": "7f8c6b1fd5e1aa10f8774663edf0ac71",
"@type": "QuoteItem",
"action": "add",
"quantity": "1",
"state": "Draft",
"product": {
"@type": "Product"
},
"productOffering": {
"id": "4466d50674ee4a10f877468e695efa0d",
"name": "Security Fee",
"@type": "ProductOfferingRef"
},
"productRelationship": [
{
"product": "797ca71fd5e1aa10f8774663edf0ac2b",
"relationshipType": "HasParent"
}
]
},
{
"id": "fb8c6b1fd5e1aa10f8774663edf0ac72",
"@type": "QuoteItem",
"action": "add",
"quantity": "1",
"state": "Draft",
"product": {
"@type": "Product",
"productCharacteristic": [
{
"name": "Speed",
"value": "High"
},
{
"name": "Internet breakout",
"value": "No"
}
],
"productSpecification": {
"id": "ee4f8d8a74ae4a10f877468e695efa3f",
"name": "VPN Endpoint PS",
"@type": "ProductSpecificationRef"
}
},
"productOffering": {
"id": "7acc9e46a5e20210f8774c9b4be6ce9e",
"name": "VPN Endpoint",
"@type": "ProductOfferingRef"
},
"productRelationship": [
{
"product": "797ca71fd5e1aa10f8774663edf0ac2b",
"relationshipType": "HasParent"
}
]
},
{
"id": "bb8c6b1fd5e1aa10f8774663edf0ac73",
"@type": "QuoteItem",
"action": "add",
"quantity": "1",
"state": "Draft",
"product": {
"@type": "Product",
"productCharacteristic": [
{
"name": "Quality of Service",
"value": "Basic"
}
],
"productSpecification": {
"id": "3ba0914e74ae4a10f877468e695efa6e",
"name": "VPN Firewall PS",
"@type": "ProductSpecificationRef"
}
},
"productOffering": {
"id": "4407d90674ee4a10f877468e695efaab",
"name": "VPN Firewall",
"@type": "ProductOfferingRef"
},
"productRelationship": [
{
"product": "797ca71fd5e1aa10f8774663edf0ac2b",
"relationshipType": "HasParent"
}
]
}
],
"relatedParty": [
{
"role": "Customer",
"id": "9e2fd2ee11b43110f877366201dea674",
"name": "Startech svcs",
"@type": "RelatedPartyRef",
"@referredType": "Organization"
}
],
"state": "Draft",
"id": "cb15734fd5692a10f8774663edf0ac19",
"version": "2",
"quoteDate": "2025-05-21 04:56:50",
"href": "api/sn_tmf_api/quote_management_api/quote/cb15734fd5692a10f8774663edf0ac19"
}
## 見積管理 API -- POST /sn_tmf_api/quote_management_api/quote {#ariaid-title6}
見積もりを作成します。
新しい見積もりレコードが次のテーブルに作成されます。
* 見積もり \[sn_quote_mgmt_core_quote\]
* 販売契約 \[sn_sales_agmt_core_sales_agreement\]
* 見積もりラインアイテム \[sn_quote_mgmt_core_quote_line_item\]
* 見積品目の特性 \[sn_quote_mgmt_core_quote_line_characteristic\]
* 見積価格調整 \[sn_quote_mgmt_core_pricing_adjustment\]
{#quotemgmt-POST__ul_lxc_kxm_t4b}
### URL 形式 {#quotemgmt-POST__section_uk2_4v2_yfc}
バージョニングされた URL: /api/sn_tmf_api/{api_version}/quote_management_api/quote
デフォルト URL: /api/sn_tmf_api/quote_management_api/quote
### サポートされている要求パラメーター
{#quotemgmt-POST__table_jlb_1qx_kqb__entry__2}
| 名前 | 説明 |
|-|-|
| なし | |
[表 : 25. パスパラメーター]
{#quotemgmt-POST__table_jlb_1qx_kqb} {#quotemgmt-POST__entry__6}
| 名前 | 説明 |
|-|-|
| なし | |
[表 : 26. クエリパラメーター]
{#quotemgmt-POST__entry__10}
| 名前 | 説明 |
|-|-|
| contactMedium | 連絡先メディアのリスト。見積もり依頼者に関連する連絡先情報。 "contactMedium": [ { "city": "String", "country": "String", "locationId": "String", "mediumType": "String", "postCode": "String", "stateOrProvince": "String", "street": "String", "@type": "String" } ] |
| contactMedium.city | 見積もり依頼者が居住する市区町村。 データタイプ：文字列 |
| contactMedium.country | 見積もり依頼者が居住する国。 データタイプ：文字列 |
| contactMedium.locationId | 場所 \[cmn_location\] テーブルまたはカスタム住所にリストされている場所のSys_id。 データタイプ：文字列 |
| contactMedium.mediumType | メールアドレス、電話番号、住所などの連絡先メディアのタイプ。 データタイプ：文字列 |
| contactMedium.postCode | 見積もり依頼者の郵便番号。 データタイプ：文字列 |
| contactMedium.stateOrProvince | 見積もり依頼者が所在する都道府県。 データタイプ：文字列 |
| contactMedium.street | 見積もり依頼者の番地。 データタイプ：文字列 |
| contactMedium.@type | TMF Open API 標準に従ったメディアのタイプ。たとえば、「 GeographicalAddressContactMedium」のように入力します。 データタイプ：文字列 |
| 説明 | 見積もりの説明。 データタイプ：文字列 |
| externalId | コンシューマーが提供する見積もりの一意の ID。 データタイプ：文字列 |
| href | 見積もりにアクセスするための相対リンク。 データタイプ：文字列 デフォルト:空の文字列 |
| 手記 | 見積もりに関連付けられたメモのリスト。 データタイプ：アレイ "note": [ { "text": "String", "@type": "String" } ] |
| note.text | メモの内容。 データタイプ：文字列 |
| note.@type | この値は常に Noteです。 データタイプ：文字列 |
| 見積日 | 見積もりが作成された日時。 データタイプ：文字列 |
| 見積もりアイテム | 見積もりアイテムのリスト。各見積もりアイテムは、見積もり対象の製品のアクションを記述します。 "quoteItem": [ { "action": "String", "id": "String", "product": {Object}, "productOffering": {Object}, "productRelationship": {Object}, "quantity": Number, "state": "String", "@type": "String" } ] データタイプ：オブジェクトのアレイ |
| quoteItem.action | この見積アイテムに対して実行するアクション (追加、変更、削除など)。 データタイプ：文字列 |
| quoteItem.id | 見積もりアイテムのSys_id。 テーブル:見積品目 \[sn_quote_mgmt_core_quote_line_item\] データタイプ：文字列 |
| quoteItem.product | 見積もりに含まれる製品のリスト。 "product": { "characteristic": "String", "specification": "String", "@type": "String" } データタイプ: オブジェクト |
| quoteItem.product. 特性 | 製品特性のリスト。 データタイプ：オブジェクトのアレイ "characteristic": [ { "id": "String", "name": "String", "@type": "String", "value": "String" } ] 「[Create product characteristics and characteristic options](https://www.servicenow.com/docs/access?context=som-product-config-add-characteristics&version=australia&pubname=australia-order-management&ft:locale=en-US)」を参照してください。 |
| quoteItem.product. characteristic.id | 製品特性のSys_id。 テーブル:見積品目の特性 \[sn_quote_mgmt_core_quote_line_characteristic\] データタイプ：文字列 |
| quoteItem.product. characteristic.name | 製品特性の名前。 データタイプ：文字列 |
| quoteItem.product. characteristic.@type | この値は常に StringCharacteristic です。 データタイプ：文字列 |
| quoteItem.product. characteristic.value | 特性の値。 データタイプ：文字列 |
| quoteItem.product を指定します。 | 顧客または関係者の役割を果たすその他の関係者に対して、ProductOffering の形式で外部から提供される有形または無形のオブジェクトの詳細な説明。 データタイプ：文字列 |
| quoteItem.product.@type | この値は常に Product です。 データタイプ：文字列 |
| quoteItem.productOffering | 製品オファリング参照 (ProductOfferingRef)。製品オファリングは、カタログのプロバイダーから注文可能なエンティティを表します。 "productOffering": { "href": "String", "name": "String", "name": "String", "@type": "String" } データタイプ: オブジェクト |
| quoteItem です。productOffering.href | 関連エンティティの参照。 データタイプ：文字列 |
| quoteItem です。productOffering.id | 製品オファリングのSys_id。 テーブル:製品オファリング \[sn_prd_pm_product_offering\] データタイプ：文字列 |
| quoteItem です。productOffering.name | 関連エンティティの名前。 データタイプ：文字列 |
| quoteItem です。productOffering.@type | この値は常に ProductOfferingRef です。 データタイプ：文字列 |
| quoteItem.productRelationship | 見積もりアイテムのリスト。各見積もりアイテムは、見積もり対象の製品のアクションを記述します。 "productRelationship": [ { "product": "String", "relationshipType": "String" } ] データタイプ：オブジェクトのアレイ |
| quoteItem.productRelationship. 製品 | 製品の参照または値 (ProductRefOrValue)。値によって定義される作成される製品、または参照によって定義される既存の製品。 製品は次のいずれかの基準を満たしています。 * 値で定義された保留中の製品の作成。 * 参照により定義された既存の製品。 {#quotemgmt-POST__ul_m5n_gc3_zfc} データタイプ：文字列 |
| quoteItem.productRelationship. relationshipType | 製品がバンドルであり、その中のバンドル製品を説明する場合は「 バンドル」 など、製品の関係のタイプ。 データタイプ：文字列 |
| quoteItem.quantity | この見積アイテムに要求された数量。 データタイプ：数値 |
| quoteItem.state | 見積もり状態の種類 (QuoteStateType)。見積もりのステータス。 データタイプ：文字列 |
| quoteItem.@type | この値は常に QuoteItem です。 データタイプ：文字列 |
| 関連パーティー | 注文の連絡先のリスト。 データタイプ：オブジェクトのアレイ "relatedParty": [ { "id": "String", "name": "String", "@referredType": "String", "role": "String", "@type": "String" } ] |
| relatedParty.id | アカウント、連絡先、または顧客を取得する見積もりテーブルSys_id。 テーブル:見積もり \[sn_quote_mgmt_core_quote\] データタイプ：文字列 |
| relatedParty.name | アカウント、顧客、またはコンシューマーの名前。 データタイプ：文字列 |
| relatedParty.@referredType | 顧客のタイプ。 可能な値： * コンシューマー * 顧客 * 顧客連絡先 {#quotemgmt-POST__ul_n5n_gc3_zfc} データタイプ：文字列 |
| relatedParty.role | 見積もりのコンテキストでの関係者のロール (アカウント、連絡先、顧客など)。 データタイプ：文字列 |
| relatedParty.@type | この値は常に ProductOfferingRef です。 データタイプ：文字列 |
| 状況 | 見積もりアイテムのステータス。 データタイプ：文字列 |
| @type | リソースのタイプ。この値は常に [見積もり] です。この情報は保存されません。 データタイプ：文字列 |
[表 : 27. 要求本文パラメーター (JSON)]
### ヘッダー
次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")を参照してください。
{#quotemgmt-POST__entry__104}{#quotemgmt-POST__accept-JSON-only-entry-RESTAPI}
| ヘッダー | 説明 |
|-|-|
| 承認 | 応答本文のデータフォーマット。application/json のみをサポートします。 |
[表 : 28. 要求ヘッダー]
{#quotemgmt-POST__table_tzy_thy_ksb__entry__2}
| ヘッダー | 説明 |
|-|-|
| Content-Type | 応答本文のデータフォーマット。application/json のみをサポートします。 |
[表 : 29. 応答ヘッダー]
{#quotemgmt-POST__table_tzy_thy_ksb}
### ステータスコード
この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")」を参照してください。
{#quotemgmt-POST__table_kmf_3jm_gqb__entry__2}
| ステータスコード | 説明 |
|-|-|
| 201 | 成功。要求が正常に処理されました。 |
| 400 | 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。 考えられる理由: * 空のペイロード。 * 無効なペイロードです。必須フィールドがありません:\<フィールド名\>。 {#quotemgmt-POST__ul_smv_xxn_yfc} |
[表 : 30. ステータスコード]
{#quotemgmt-POST__table_kmf_3jm_gqb}
### 応答本文のパラメーター (JSON)
{#quotemgmt-POST__entry__118}
| 名前 | 説明 |
|-|-|
| contactMedium | 連絡先メディアのリスト。見積もり依頼者に関連する連絡先情報。 "contactMedium": [ { "city": "String", "country": "String", "locationId": "String", "mediumType": "String", "postCode": "String", "stateOrProvince": "String", "street": "String", "@type": "String" } ] |
| contactMedium.city | 見積もり依頼者が居住する市区町村。 データタイプ：文字列 |
| contactMedium.country | 見積もり依頼者が居住する国。 データタイプ：文字列 |
| contactMedium.locationId | 場所 \[cmn_location\] テーブルまたはカスタム住所にリストされている場所のSys_id。 データタイプ：文字列 |
| contactMedium.mediumType | メールアドレス、電話番号、住所などの連絡先メディアのタイプ。 データタイプ：文字列 |
| contactMedium.postCode | 見積もり依頼者の郵便番号。 データタイプ：文字列 |
| contactMedium.stateOrProvince | 見積もり依頼者が所在する都道府県。 データタイプ：文字列 |
| contactMedium.street | 見積もり依頼者の番地。 データタイプ：文字列 |
| contactMedium.@type | TMF Open API 標準に従ったメディアのタイプ。たとえば、「 GeographicalAddressContactMedium」のように入力します。 データタイプ：文字列 |
| 説明 | 見積もりの説明。 データタイプ：文字列 |
| externalId | コンシューマーが提供する見積もりの一意の ID。 データタイプ：文字列 |
| href | 見積もりにアクセスするための相対リンク。 データタイプ：文字列 デフォルト:空の文字列 |
| 手記 | 見積もりに関連付けられたメモのリスト。 データタイプ：アレイ "note": [ { "text": "String", "@type": "String" } ] |
| note.text | メモの内容。 データタイプ：文字列 |
| note.@type | この値は常に Noteです。 データタイプ：文字列 |
| 見積日 | 見積もりが作成された日時。 データタイプ：文字列 |
| 見積もりアイテム | 見積もりアイテムのリスト。各見積もりアイテムは、見積もり対象の製品のアクションを記述します。 "quoteItem": [ { "action": "String", "id": "String", "product": {Object}, "productOffering": {Object}, "productRelationship": {Object}, "quantity": Number, "state": "String", "@type": "String" } ] データタイプ：オブジェクトのアレイ |
| quoteItem.action | この見積アイテムに対して実行するアクション (追加、変更、削除など)。 データタイプ：文字列 |
| quoteItem.id | 見積もりアイテムのSys_id。 テーブル:見積品目 \[sn_quote_mgmt_core_quote_line_item\] データタイプ：文字列 |
| quoteItem.product | 見積もりに含まれる製品のリスト。 "product": { "characteristic": "String", "specification": "String", "@type": "String" } データタイプ: オブジェクト |
| quoteItem.product. 特性 | 製品特性のリスト。 データタイプ：オブジェクトのアレイ "characteristic": [ { "id": "String", "name": "String", "@type": "String", "value": "String" } ] 「[Create product characteristics and characteristic options](https://www.servicenow.com/docs/access?context=som-product-config-add-characteristics&version=australia&pubname=australia-order-management&ft:locale=en-US)」を参照してください。 |
| quoteItem.product. characteristic.id | 製品特性のSys_id。 テーブル:見積品目の特性 \[sn_quote_mgmt_core_quote_line_characteristic\] データタイプ：文字列 |
| quoteItem.product. characteristic.name | 製品特性の名前。 データタイプ：文字列 |
| quoteItem.product. characteristic.@type | この値は常に StringCharacteristic です。 データタイプ：文字列 |
| quoteItem.product. characteristic.value | 特性の値。 データタイプ：文字列 |
| quoteItem.product を指定します。 | 顧客または関係者の役割を果たすその他の関係者に対して、ProductOffering の形式で外部から提供される有形または無形のオブジェクトの詳細な説明。 データタイプ：文字列 |
| quoteItem.product.@type | この値は常に Product です。 データタイプ：文字列 |
| quoteItem.productOffering | 製品オファリング参照 (ProductOfferingRef)。製品オファリングは、カタログのプロバイダーから注文可能なエンティティを表します。 "productOffering": { "href": "String", "name": "String", "name": "String", "@type": "String" } データタイプ: オブジェクト |
| quoteItem です。productOffering.href | 関連エンティティの参照。 データタイプ：文字列 |
| quoteItem です。productOffering.id | 製品オファリングのSys_id。 テーブル:製品オファリング \[sn_prd_pm_product_offering\] データタイプ：文字列 |
| quoteItem です。productOffering.name | 関連エンティティの名前。 データタイプ：文字列 |
| quoteItem です。productOffering.@type | この値は常に ProductOfferingRef です。 データタイプ：文字列 |
| quoteItem.productRelationship | 見積もりアイテムのリスト。各見積もりアイテムは、見積もり対象の製品のアクションを記述します。 "productRelationship": [ { "product": "String", "relationshipType": "String" } ] データタイプ：オブジェクトのアレイ |
| quoteItem.productRelationship. 製品 | 製品の参照または値 (ProductRefOrValue)。値によって定義される作成される製品、または参照によって定義される既存の製品。 製品は次のいずれかの基準を満たしています。 * 値で定義された保留中の製品の作成。 * 参照により定義された既存の製品。 {#quotemgmt-POST__ul_lg5_qb3_zfc} データタイプ：文字列 |
| quoteItem.productRelationship. relationshipType | 製品がバンドルであり、その中のバンドル製品を説明する場合は「 バンドル」 など、製品の関係のタイプ。 データタイプ：文字列 |
| quoteItem.quantity | この見積アイテムに要求された数量。 データタイプ：数値 |
| quoteItem.state | 見積もり状態の種類 (QuoteStateType)。見積もりのステータス。 データタイプ：文字列 |
| quoteItem.@type | この値は常に QuoteItem です。 データタイプ：文字列 |
| 関連パーティー | 注文の連絡先のリスト。 データタイプ：オブジェクトのアレイ "relatedParty": [ { "id": "String", "name": "String", "@referredType": "String", "role": "String", "@type": "String" } ] |
| relatedParty.id | アカウント、連絡先、または顧客を取得する見積もりテーブルSys_id。 テーブル:見積もり \[sn_quote_mgmt_core_quote\] データタイプ：文字列 |
| relatedParty.name | アカウント、顧客、またはコンシューマーの名前。 データタイプ：文字列 |
| relatedParty.@referredType | 顧客のタイプ。 可能な値： * コンシューマー * 顧客 * 顧客連絡先 {#quotemgmt-POST__ul_mg5_qb3_zfc} データタイプ：文字列 |
| relatedParty.role | 見積もりのコンテキストでの関係者のロール (アカウント、連絡先、顧客など)。 データタイプ：文字列 |
| relatedParty.@type | この値は常に ProductOfferingRef です。 データタイプ：文字列 |
| 状況 | 見積もりアイテムのステータス。 データタイプ：文字列 |
| @type | リソースのタイプ。この値は常に [見積もり] です。この情報は保存されません。 データタイプ：文字列 |
[ ]
次の例は、見積もりを作成する方法を示しています。
curl "http://localhost:8080/api/sn_tmf_api/quote_management_api/quote" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
\"@type\": \"Quote\",
\"description\": \"Quote for Internet and OTT Bundle\",
\"state\": \"Draft\",
\"externalId\": \"12233\",
\"contactMedium\": [
{
\"@type\": \"GeographicalAddressContactMedium\",
\"mediumType\": \"ShippingAddressRef\",
\"locationId\": \"6774fee611383110f877366201dea64f\",
\"city\": \"Santa Clara\",
\"country\": \"USA\",
\"postCode\": \"95050\",
\"stateOrProvince\": \"CA\",
\"street\": \"2866 Stevens Creek Blvd\"
}
],
\"note\": [
{
\"@type\": \"Note\",
\"text\": \"This is a quote request for the Internet and OTT Bundle\"
}
],
\"quoteItem\": [
{
\"id\": \"ea88d77c4165ae10f8776348db5f9196\",
\"@type\": \"QuoteItem\",
\"action\": \"add\",
\"quantity\": \"1\",
\"state\": \"Draft\",
\"product\": {
\"@type\": \"Product\"
},
\"productOffering\": {
\"id\": \"ffeb447211bc3110f877366201dea6df\",
\"href\": \"api/sn_tmf_api/catalogmanagement/productOffering/ffeb447211bc3110f877366201dea6df\",
\"name\": \"Internet and OTT Bundle\",
\"@type\": \"ProductOfferingRef\"
},
\"productRelationship\": [
{
\"product\": \"3688d77c4165ae10f8776348db5f91cf\",
\"relationshipType\": \"HasChild\"
},
{
\"product\": \"3a881b7c4165ae10f8776348db5f911b\",
\"relationshipType\": \"HasChild\"
},
{
\"product\": \"7e88d77c4165ae10f8776348db5f91fb\",
\"relationshipType\": \"HasChild\"
}
]
},
{
\"id\": \"3688d77c4165ae10f8776348db5f91cf\",
\"@type\": \"QuoteItem\",
\"action\": \"add\",
\"quantity\": \"1\",
\"state\": \"Draft\",
\"product\": {
\"@type\": \"Product\"
},
\"productOffering\": {
\"id\": \"0761dd9fd0a63110f8770dbf976be173\",
\"href\": \"api/sn_tmf_api/catalogmanagement/productOffering/0761dd9fd0a63110f8770dbf976be173\",
\"name\": \"Solana Modem N Series\",
\"@type\": \"ProductOfferingRef\"
},
\"productRelationship\": [
{
\"product\": \"ea88d77c4165ae10f8776348db5f9196\",
\"relationshipType\": \"HasParent\"
}
]
},
{
\"id\": \"7e88d77c4165ae10f8776348db5f91fb\",
\"@type\": \"QuoteItem\",
\"action\": \"add\",
\"quantity\": \"1\",
\"state\": \"Draft\",
\"product\": {
\"@type\": \"Product\"
},
\"productOffering\": {
\"id\": \"8b61dd9fd0a63110f8770dbf976be140\",
\"href\": \"api/sn_tmf_api/catalogmanagement/productOffering/8b61dd9fd0a63110f8770dbf976be140\",
\"name\": \"Basic internet - 100 Mbps Plan\",
\"@type\": \"ProductOfferingRef\"
},
\"productRelationship\": [
{
\"product\": \"ea88d77c4165ae10f8776348db5f9196\",
\"relationshipType\": \"HasParent\"
}
]
},
{
\"id\": \"3a881b7c4165ae10f8776348db5f911b\",
\"@type\": \"QuoteItem\",
\"action\": \"add\",
\"quantity\": \"1\",
\"state\": \"Draft\",
\"product\": {
\"@type\": \"Product\"
},
\"productOffering\": {
\"id\": \"62619d9fd0a63110f8770dbf976be180\",
\"href\": \"api/sn_tmf_api/catalogmanagement/productOffering/62619d9fd0a63110f8770dbf976be180\",
\"name\": \"Solana Movie streaming channel\",
\"@type\": \"ProductOfferingRef\"
},
\"productRelationship\": [
{
\"product\": \"ea88d77c4165ae10f8776348db5f9196\",
\"relationshipType\": \"HasParent\"
}
]
}
],
\"relatedParty\": [
{
\"role\": \"Customer\",
\"id\": \"ab9a0e8b2fc9a610b79db3bf42faf3a6\",
\"name\": \"Funco Intl\",
\"@type\": \"RelatedPartyRef\",
\"@referredType\": \"Organization\"
}
]
}" \
--user 'userName':'password'
応答本文。
{
"@type": "Quote",
"description": "Quote for Internet and OTT Bundle",
"state": "Draft",
"externalId": "12233",
"contactMedium": [
{
"@type": "GeographicalAddressContactMedium",
"mediumType": "ShippingAddressRef",
"locationId": "6774fee611383110f877366201dea64f",
"city": "Santa Clara",
"country": "USA",
"postCode": "95050",
"stateOrProvince": "CA",
"street": "2866 Stevens Creek Blvd"
}
],
"note": [
{
"@type": "Note",
"text": "This is a quote request for the Internet and OTT Bundle"
}
],
"quoteItem": [
{
"id": "ea88d77c4165ae10f8776348db5f9196",
"@type": "QuoteItem",
"action": "add",
"quantity": "1",
"state": "Draft",
"product": {
"@type": "Product"
},
"productOffering": {
"id": "ffeb447211bc3110f877366201dea6df",
"href": "api/sn_tmf_api/catalogmanagement/productOffering/ffeb447211bc3110f877366201dea6df",
"name": "Internet and OTT Bundle",
"@type": "ProductOfferingRef",
"internalVersion": "1",
"version": "",
"internalId": "ffeb447211bc3110f877366201dea6df"
},
"productRelationship": [
{
"product": "3688d77c4165ae10f8776348db5f91cf",
"relationshipType": "HasChild"
},
{
"product": "3a881b7c4165ae10f8776348db5f911b",
"relationshipType": "HasChild"
},
{
"product": "7e88d77c4165ae10f8776348db5f91fb",
"relationshipType": "HasChild"
}
]
},
{
"id": "3688d77c4165ae10f8776348db5f91cf",
"@type": "QuoteItem",
"action": "add",
"quantity": "1",
"state": "Draft",
"product": {
"@type": "Product"
},
"productOffering": {
"id": "0761dd9fd0a63110f8770dbf976be173",
"href": "api/sn_tmf_api/catalogmanagement/productOffering/0761dd9fd0a63110f8770dbf976be173",
"name": "Solana Modem N Series",
"@type": "ProductOfferingRef",
"internalVersion": "1",
"version": "",
"internalId": "0761dd9fd0a63110f8770dbf976be173"
},
"productRelationship": [
{
"product": "ea88d77c4165ae10f8776348db5f9196",
"relationshipType": "HasParent"
}
]
},
{
"id": "7e88d77c4165ae10f8776348db5f91fb",
"@type": "QuoteItem",
"action": "add",
"quantity": "1",
"state": "Draft",
"product": {
"@type": "Product"
},
"productOffering": {
"id": "8b61dd9fd0a63110f8770dbf976be140",
"href": "api/sn_tmf_api/catalogmanagement/productOffering/8b61dd9fd0a63110f8770dbf976be140",
"name": "Basic internet - 100 Mbps Plan",
"@type": "ProductOfferingRef",
"internalVersion": "1",
"version": "",
"internalId": "8b61dd9fd0a63110f8770dbf976be140"
},
"productRelationship": [
{
"product": "ea88d77c4165ae10f8776348db5f9196",
"relationshipType": "HasParent"
}
]
},
{
"id": "3a881b7c4165ae10f8776348db5f911b",
"@type": "QuoteItem",
"action": "add",
"quantity": "1",
"state": "Draft",
"product": {
"@type": "Product"
},
"productOffering": {
"id": "62619d9fd0a63110f8770dbf976be180",
"href": "api/sn_tmf_api/catalogmanagement/productOffering/62619d9fd0a63110f8770dbf976be180",
"name": "Solana Movie streaming channel",
"@type": "ProductOfferingRef",
"internalVersion": "1",
"version": "",
"internalId": "62619d9fd0a63110f8770dbf976be180"
},
"productRelationship": [
{
"product": "ea88d77c4165ae10f8776348db5f9196",
"relationshipType": "HasParent"
}
]
}
],
"relatedParty": [
{
"role": "Customer",
"id": "ab9a0e8b2fc9a610b79db3bf42faf3a6",
"name": "Funco Intl",
"@type": "RelatedPartyRef",
"@referredType": "Organization"
}
],
"id": "acc805bcfff5a610b79dffffffffffe6",
"href": "api/sn_tmf_api/quote_management_api/quote/acc805bcfff5a610b79dffffffffffe6"
}