テクニカルサービス認定オープン API

リリースバージョン: Washingtondc

更新日 2024年02月01日

読む137読むのに数分

テクニカルサービス認定オープン API を使用すると、フルフィルメントのために注文を送信する前に、リソースとサービスの可用性を確認できます。

この API は、 ServiceNow TMF645 Service Qualification API REST 仕様の実装です。サービス認定要求の詳細については、次を参照してください Service qualification requests。

テクニカルサービス資格オープン API は sn_ord_qual_mgmt 名前空間内で提供され、次のプラグインが必要です。

Product Catalog 管理コア [com.sn_prd_pm]
Product Catalog アドバンスト [com.sn_prd_pm_adv]
注文資格管理 [com.sn_ord_qual_mgmt]
Order Management for Telecom, Media & Tech [com.sn_tmt_core]
テレコムコア [com.sn_tmt_core]

この API を使用するには、sn_ind_tmt_orm.order_integrator ロールが必要です。

テクニカルサービス認定オープン API - GET sn_ord_qual_mgmt/qualification/checkServiceQualification/{id}

指定された顧客オーダー ID に関連付けられている技術認定要求を取得します。

このエンドポイントは、次のテーブルから注文情報を取得します。

顧客注文 [sn_ind_tmt_orm_order]
オーダー品目 [sn_ind_tmt_orm_order_line_item]

URL 形式

バージョニングされた URL:/ api/sn_ord_qual_mgmt/qualification/checkServiceQualification/{id}

サポートされている要求パラメーター

表 : 1. パスパラメーター
名前	説明
api_version	オプションアクセスするエンドポイントのバージョン。たとえば、`v1` や `v2`。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。データタイプ：文字列
ID	取得する認定顧客注文のSys_id。データタイプ：文字列

表 : 2. クエリパラメーター
名前	説明
なし

表 : 3. 要求本文パラメーター (XML または JSON)
名前	説明
なし

ヘッダー

次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「サポートされている REST API ヘッダー」を参照してください。

表 : 4. 要求ヘッダー
ヘッダー	説明
承認	応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。デフォルト： application/json

表 : 5. 応答ヘッダー
ヘッダー	説明
なし

ステータスコード

この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。

表 : 6. ステータスコード

200	要求が正常に処理されました。
400	要求が正しくありません。考えられる理由：無効なパスパラメーター無効な URI
404	見つかりません。要求アイテムが見つかりませんでした。

応答本文のパラメーター (JSON または XML)


名前	説明
ID	認定顧客注文のSys_id。データタイプ：文字列
href	認定オーダーレコードへの相対リンク。データタイプ：文字列
description	顧客注文のshort_descriptionフィールドからフェッチされる認定要求の説明。データタイプ：文字列
externalId	顧客注文の [external_id] フィールドの外部 ID。データタイプ：文字列
qualificationResult	顧客注文の結果フィールドの検定ステータス。可能な値：代替保留中なし認定済み無条件データタイプ：文字列
ステータス	顧客注文のステータスフィールドからの顧客注文のステータス。データタイプ：文字列
@type	TMF オープン API 標準の一部。認定の注釈。この値は常に CheckServiceQualification です。この情報は保存されません。データタイプ：文字列
checkServiceQualificationDate	顧客注文の [order_date] フィールドから作成された認定要求の日時。形式:YYYY-MM-DDTHH:MM:SS。ティッカーデータタイプ：文字列
有効な資格認定日	顧客注文の [order_date] フィールドからフェッチされた有効な認定日。形式:YYYY-MM-DDTHH:MM:SS。ティッカーデータタイプ：文字列
expectedQualificationDate	予定されている認定日を保存します。顧客注文expected_end_dateフィールドに保持されます。形式:YYYY-MM-DDTHH:MM:SS。ティッカーデータタイプ：文字列
relatedParty	認定要求の連絡先のリスト。各連絡先はアレイ内のオブジェクトです。データタイプ：オブジェクトのアレイ `"relatedParty": [ { "id": "String", "name": "String", "@type": "String", "@referredType": "String" } ]`
relatedParty.id	注文に関連付けられたアカウント、お客様の連絡先、またはコンシューマーのSys_idまたはexternal_id。アカウント [customer_account] テーブル、連絡先 [customer_contact] テーブル、またはコンシューマー [csm_consumer] テーブルにあります。データタイプ：文字列
relatedParty.name	アカウント、顧客、またはコンシューマーの名前。データタイプ：文字列
relatedParty.@type	TMF オープン API 標準の一部。オーダー品目に関する連絡先の注釈。この値は常に RelatedParty です。この情報は保存されません。データタイプ：文字列
relatedParty.@referredType	関連するパーティのタイプ。可能な値： Customer CustomerContact コンシューマーデータタイプ：文字列
serviceQualificationItem	場所、サービス情報、およびサービス特性に関する情報を含むサービス認定アイテムのリスト。顧客注文の注文品目として保存されます。データタイプ：オブジェクトのアレイ `"serviceQualificationItem": [ { "id": "string", "action": "string", "expectedServiceAvailabilityDate": "number", "service": { "place": [ { "id": "string", "name": "string" } ], "serviceCharacteristic": [ { "valueType": "string", "name": "string", "value": "string" } ], "serviceSpecification": { "id": "string", "name": "string" } }, "@type": "ServiceQualificationItem" } ],`
serviceQualificationItem.id	認定アイテムの ID。顧客注文品目の [external_id] フィールドに保存されます。データタイプ：文字列
serviceQualificationItem.qualificationResult	認定項目の結果。顧客の注文品目の [結果] フィールドに保存されます。可能な値：代替なし保留中認定済み無条件データタイプ：文字列
serviceQualificationItem.state	顧客の注文品目の [status] フィールドから導出された認定品目のステータス。データタイプ：文字列
serviceQualificationItem.quantity	顧客の注文品目の [数量] フィールドから導出された認定品目の数量。データタイプ：数値
serviceQualificationItem.@type	TMF オープン API 標準の一部。認定アイテムの注釈。この値は常に ServiceQualificationItem です。この情報は保存されません。データタイプ：文字列
serviceQualificationItem.service	場所 (場所)、サービス仕様、およびサービス特性に関する詳細を含むサービス情報。データタイプ: オブジェクト `"service": { "place": [ { "id": "String", "name": "String" } ], "serviceCharacteristic": [ { "valueType": "String", "name": "String", "value": "String" } ], "serviceSpecification": { "id": "String", "name": "String" } }`
serviceQualificationItem.service.@type	TMF Open API 標準の一部。サービスの注釈。この値は常に Service です。この情報は保存されません。データタイプ：文字列
serviceQualificationItem.service.place	サービス認定アイテムの場所情報。データタイプ:オブジェクトのアレイ。注: この配列には、1 つの場所のみを含めることができます。 `"place": [ { "id": "5671dd2ec3a53010188473ce3640dd81", "name": "Jean Pontus home", "@referredType": "GeographicSite" } ]`
serviceQualificationItem.service.place.id	場所 [cmn_location] テーブル内の場所Sys_id。データタイプ：文字列
serviceQualificationItem.service.place.name	場所の名前。場所 [cmn_location] テーブルのエントリに対して検証されていません。データタイプ：文字列
serviceQualificationItem.service.place.@type	TMF オープン API 標準の一部。サービスの注釈。この値は常に GeographicSite です。この情報は保存されません。データタイプ：文字列
serviceQualificationItem.service.serviceSpecification	認定アイテムのサービス仕様の詳細。データタイプ:オブジェクトのアレイ。 `"serviceSpecification": { "id": "String", "internalVersion": "Number", "internalId": "String", "name": "String" "@type": "ServiceSpecification" "version": "String", }`
serviceQualificationItem.service.serviceSpecification.id	外部 ID またはサービス仕様の初期バージョン。データタイプ：文字列
serviceQualificationItem.service.serviceSpecification.name	サービス仕様の名前。データタイプ：文字列
serviceQualificationItem.service.serviceSpecification.version	サービス仕様の外部バージョン。データタイプ：文字列
serviceQualificationItem.service.serviceSpecification.internalVersion	サービス仕様の内部バージョン。データタイプ：数値
serviceQualificationItem.service.serviceSpecification.internalId	サービス仕様の初期バージョン。データタイプ：文字列
serviceQualificationItem.service.serviceSpecification.@type	TMF オープン API 標準の一部。サービス仕様の注釈。この値は常に ServiceSpecification です。この情報は保存されません。データタイプ：文字列
serviceQualificationItem.service.serviceCharacteristic	サービス特性のリスト。データタイプ：オブジェクトのアレイ `"serviceCharacteristic": [ { "name": "Speed", "value": "High" "valueType": "string", } ]`
serviceQualificationItem.service.serviceCharacteristic.valueType	特性の値タイプ。データタイプ：文字列
serviceQualificationItem.service.serviceCharacteristic.name	特性の名前。データタイプ：文字列
serviceQualificationItem.service.serviceCharacteristic.value	特性の値。データタイプ：文字列
ServiceQualificationItem.alternateServiceProposal	認定オーダーの代替サービス提案。代替提案は代替提案 [sn_ord_qual_mgmt_alternate_proposal] テーブルに保存されます。データタイプ：文字列
ServiceQualificationItem.alternateServiceProposal.id	代替提案 [sn_ord_qual_mgmt_alternate_proposal] テーブルの代替提案エントリのSys_id。データタイプ：文字列
ServiceQualificationItem.alternateServiceProposal.alternateServiceAvailabilityDate	代替提案 [sn_ord_qual_mgmt_alternate_proposal] テーブルの代替提案エントリのavailable_dateフィールド値。データタイプ：文字列
serviceQualificationItem.alternateServiceProposal.alternateService	代替提案によって表されるサービス情報。データタイプ: オブジェクト
serviceQualificationItem.alternateServiceProposal.alternateService.serviceSpecification	代替提案のサービス仕様は、代替提案 [sn_ord_qual_mgmt_alternate_proposal] テーブルの仕様に保持されます。データタイプ: オブジェクト
serviceQualificationItemalternateServiceProposal.alternateService.serviceSpecification.id	外部 ID または代替サービス仕様の初期バージョン。データタイプ：文字列
serviceQualificationItemalternateServiceProposal.alternateService.serviceSpecification.name	代替サービス仕様の名前。データタイプ：文字列
serviceQualificationItemalternateServiceProposal.alternateService.serviceSpecification.version	代替サービス仕様の外部バージョン。データタイプ：文字列
serviceQualificationItemalternateServiceProposal.alternateService.serviceSpecification.internalVersion	代替サービス仕様の内部バージョン。データタイプ：数値
serviceQualificationItemalternateServiceProposal.alternateService.serviceSpecification.internalId	代替サービス仕様の初期バージョン。データタイプ：文字列
ServiceQualificationItemalternateServiceProposal.alternateService.serviceSpecification.@type	TMF オープン API 標準の一部。サービス仕様の注釈。この値は常に ServiceSpecification です。この情報は保存されません。データタイプ：文字列
serviceQualificationItemalternateServiceProposal.alternateService.serviceCharacteristic	代替サービス提案のサービス特性のアレイ。データタイプ：オブジェクトのアレイ `"serviceCharacteristic": [ { "valueType": "String", "name": "String", "value": "String" } ]`
serviceQualificationItemalternateServiceProposal.alternateService.serviceCharacteristic.valueType	代替サービス特性の値タイプ。データタイプ：文字列
serviceQualificationItemalternateServiceProposal.alternateService.serviceCharacteristic.name	代替サービス特性の名前。データタイプ：文字列
serviceQualificationItemalternateServiceProposal.alternateService.serviceCharacteristic.value	代替サービス特性の値。データタイプ：文字列
serviceQualificationItem.eligibilityUnunavailableReason	サービスを利用できない理由を説明する、サービス適格性を使用できない理由のリスト。この値は、ドメインオーダー [sn_ind_tmt_orm_domain_order] テーブルの「unavailability_reason」に保存されます。データタイプ：アレイ
serviceQualificationItem.eligibilityUnavailabilityReason.code	サービス適格性使用不可の理由コード。データタイプ：文字列
serviceQualificationItem.eligibilityUnavailabilityReason.label	サービス適格性を使用不可の理由ラベル。データタイプ：文字列

サンプル cURL 要求

次の例では、認定顧客注文の特定のSys_idに関連付けられた特定の認定注文全体を取得します。

curl -location --request GET "https://instance.service-now.com/api/sn_ord_qual_mgmt/qualification/checkServiceQualification/4b5aa0a538b31110f877c8d44c4b8947" \ 
--user "username":"password"

応答：

[
  {
    "id": "001b359545371150f877e0588eca21ca",
    "href": "/api/sn_ord_qual_mgmt/qualification/checkServiceQualification/001b359545371150f877e0588eca21ca",
    "description": "check service qualification illustration",
    "externalId": "CSQ1",
    "qualificationResult": "none",
    "state": "new",
    "@type": "CheckServiceQualification",
    "checkServiceQualificationDate": "2022-12-14T23:44:44.000Z",
    "relatedParty": [
      {
        "id": "eaf68911c35420105252716b7d40ddde",
        "name": "Sally Thomas",
        "@type": "RelatedParty",
        "@referredType": "CustomerContact"
      },
      {
        "id": "ffc68911c35420105252716b7d40dd55",
        "name": "Funco Intl",
        "@type": "RelatedParty",
        "@referredType": "Customer"
      },
      {
        "id": "59f16de1c3b67110ff00ed23a140dd9e",
        "name": "Funco External",
        "@type": "RelatedParty",
        "@referredType": "Consumer"
      }
    ],
    "serviceSpecification": {
      "id": "91478553b7969910ff00f203ae11a97d",
      "name": "Broadband Service",
      "version": "",
      "internalVersion": "1",
      "internalId": "91478553b7969910ff00f203ae11a97d",
      "@type": "ServiceSpecification"
    },
    "place": {
      "id": "5671dd2ec3a53010188473ce3640dd81",
      "name": "3000 Main Street, Santa Clara, CA",
      "@referredType": "GeographicSite"
    },
    "expectedQualificationDate": "2022-10-11T15:20:39.000Z"
  },
  {
    "id": "0236b75145fb1150f877e0588eca2145",
    "href": "/api/sn_ord_qual_mgmt/qualification/checkServiceQualification/0236b75145fb1150f877e0588eca2145",
    "description": "check service qualification illustration",
    "externalId": "CSQ1",
    "qualificationResult": "none",
    "state": "new",
    "@type": "CheckServiceQualification",
    "checkServiceQualificationDate": "2022-12-15T08:57:50.000Z",
    "relatedParty": [
      {
        "id": "eaf68911c35420105252716b7d40ddde",
        "name": "Sally Thomas",
        "@type": "RelatedParty",
        "@referredType": "CustomerContact"
      },
      {
        "id": "ffc68911c35420105252716b7d40dd55",
        "name": "Funco Intl",
        "@type": "RelatedParty",
        "@referredType": "Customer"
      },
      {
        "id": "59f16de1c3b67110ff00ed23a140dd9e",
        "name": "Funco External",
        "@type": "RelatedParty",
        "@referredType": "Consumer"
      }
    ],
    "serviceQualificationItem": [
      {
        "id": "110",
        "qualificationResult": "none",
        "state": "new",
        "quantity": "1",
        "@type": "ServiceQualificationItem",
        "service": {
          "@type": "Service",
          "serviceCharacteristic": [
            {
              "name": "Fiber Speed",
              "valueType": "choice",
              "value": "1Gbps"
            }
          ],
          "serviceSpecification": {
            "id": "4d2b5799457b1150f877e0588eca2116",
            "name": "CFS3",
            "version": "",
            "internalVersion": "1",
            "internalId": "4d2b5799457b1150f877e0588eca2116",
            "@type": "ServiceSpecification"
          },
          "place": {
            "id": "5671dd2ec3a53010188473ce3640dd81",
            "name": "3000 Main Street, Santa Clara, CA",
            "@referredType": "GeographicSite"
          }
        }
      },
      {
        "id": "130",
        "qualificationResult": "none",
        "state": "new",
        "quantity": "1",
        "@type": "ServiceQualificationItem",
        "service": {
          "@type": "Service",
          "serviceCharacteristic": [
            {
              "name": "Wireless Speed",
              "valueType": "choice",
              "value": "100 Mbps"
            }
          ],
          "serviceSpecification": {
            "id": "28733d1d45f31150f877e0588eca2163",
            "name": "CFS2",
            "version": "",
            "internalVersion": "1",
            "internalId": "28733d1d45f31150f877e0588eca2163",
            "@type": "ServiceSpecification"
          },
          "place": {
            "id": "5671dd2ec3a53010188473ce3640dd81",
            "name": "3000 Main Street, Santa Clara, CA",
            "@referredType": "GeographicSite"
          }
        }
      },
      {
        "id": "100",
        "qualificationResult": "none",
        "state": "new",
        "quantity": "1",
        "@type": "ServiceQualificationItem",
        "service": {
          "@type": "Service",
          "serviceCharacteristic": [
            {
              "name": "Speed",
              "valueType": "choice",
              "value": ""
            }
          ],
          "serviceSpecification": {
            "id": "b3933d9d45f31150f877e0588eca21fc",
            "name": "Access Service",
            "version": "",
            "internalVersion": "1",
            "internalId": "b3933d9d45f31150f877e0588eca21fc",
            "@type": "ServiceSpecification"
          },
          "place": {
            "id": "5671dd2ec3a53010188473ce3640dd81",
            "name": "3000 Main Street, Santa Clara, CA",
            "@referredType": "GeographicSite"
          }
        }
      },
      {
        "id": "120",
        "qualificationResult": "none",
        "state": "new",
        "quantity": "1",
        "@type": "ServiceQualificationItem",
        "service": {
          "@type": "Service",
          "serviceCharacteristic": [
            {
              "name": "DSL Speed",
              "valueType": "choice",
              "value": "500 Mbps"
            }
          ],
          "serviceSpecification": {
            "id": "1d43f91d45f31150f877e0588eca21cd",
            "name": "CFS1",
            "version": "",
            "internalVersion": "1",
            "internalId": "1d43f91d45f31150f877e0588eca21cd",
            "@type": "ServiceSpecification"
          },
          "place": {
            "id": "5671dd2ec3a53010188473ce3640dd81",
            "name": "3000 Main Street, Santa Clara, CA",
            "@referredType": "GeographicSite"
          }
        }
      }
    ],
    "expectedQualificationDate": "2022-10-11T15:20:39.000Z"
  }
]

テクニカルサービス認定オープン API - GET sn_ord_qual_mgmt/qualification/checkServiceQualification

すべての技術認定要求のリストを取得します。

このエンドポイントは、次のテーブルから注文情報を取得します。

顧客注文 [sn_ind_tmt_orm_order]
オーダー品目 [sn_ind_tmt_orm_order_line_item]

このエンドポイントはデフォルトで 20 レコードを返しますが、最大 100 レコードを返すことができます。クエリフィルターを使用し、ステータス、フィールド名、説明、および認定結果に従って結果を絞り込みます。

URL 形式

バージョニングされた URL:/ api/sn_ord_qual_mgmt/qualification/checkServiceQualification

サポートされている要求パラメーター

表 : 7. パスパラメーター
名前	説明
api_version	オプションアクセスするエンドポイントのバージョン。たとえば、`v1` や `v2`。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。データタイプ：文字列

表 : 8. クエリパラメーター
パラメーター	説明
フィールド	応答で返すフィールド名のリスト。無効なフィールドは無視されます。このパラメーターが要求で指定されていない場合は、すべてのフィールドが返されます。データタイプ:文字列、カンマ区切り
limit	返されるレコードの最大数。このレコード数を超える要求の場合は、offset パラメーターを使用してレコード取得をページネーションします。デフォルト：20 最大：100 データタイプ：数値
ステータス	認定オーダーをステータス別にフィルタリングします。ステータスがこのパラメーターの値に一致する注文のみが応答で返されます。データタイプ：文字列
description	顧客注文の [short_description] フィールドで認定注文をフィルタリングします。簡単な説明がこのパラメーターの値と一致する注文のみが応答で返されます。データタイプ：文字列
qualificationResult	認定オーダーを結果でフィルタリングします。結果がこのパラメーターの値に一致する注文のみが応答で返されます。データタイプ：文字列形式：

表 : 9. 要求本文パラメーター (XML または JSON)
名前	説明
なし

ヘッダー

表 : 10. 要求ヘッダー
ヘッダー	説明
承認	応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。デフォルト： application/json

表 : 11. 応答ヘッダー
ヘッダー	説明
なし

ステータスコード

表 : 12. ステータスコード
ステータスコード	説明
200	要求が正常に処理されました。応答で完全なリソースが返されました (ページネーションなし)。
206	応答で部分的なリソースが返されました (ページネーションあり)。
400	要求が正しくありません。考えられる理由：無効なパスパラメーター無効な URI
404	フィルター基準のレコードが見つかりません。

応答本文のパラメーター (JSON または XML)


名前	説明
ID	認定顧客注文のSys_id。データタイプ：文字列
href	認定オーダーレコードへの相対リンク。データタイプ：文字列
description	顧客注文のshort_descriptionフィールドからフェッチされる認定要求の説明。データタイプ：文字列
externalId	顧客注文の [external_id] フィールドの外部 ID。データタイプ：文字列
qualificationResult	顧客注文の結果フィールドの検定ステータス。可能な値：代替保留中なし認定済み無条件データタイプ：文字列
ステータス	顧客注文のステータスフィールドからの顧客注文のステータス。データタイプ：文字列
@type	TMF オープン API 標準の一部。認定の注釈。この値は常に CheckServiceQualification です。この情報は保存されません。データタイプ：文字列
checkServiceQualificationDate	顧客注文の [order_date] フィールドから作成された認定要求の日時。形式:YYYY-MM-DDTHH:MM:SS。ティッカーデータタイプ：文字列
有効な資格認定日	顧客注文の [order_date] フィールドからフェッチされた有効な認定日。形式:YYYY-MM-DDTHH:MM:SS。ティッカーデータタイプ：文字列
expectedQualificationDate	予定されている認定日を保存します。顧客注文expected_end_dateフィールドに保持されます。形式:YYYY-MM-DDTHH:MM:SS。ティッカーデータタイプ：文字列
relatedParty	認定要求の連絡先のリスト。各連絡先はアレイ内のオブジェクトです。データタイプ：オブジェクトのアレイ `"relatedParty": [ { "id": "String", "name": "String", "@type": "String", "@referredType": "String" } ]`
relatedParty.id	注文に関連付けられたアカウント、お客様の連絡先、またはコンシューマーのSys_idまたはexternal_id。アカウント [customer_account] テーブル、連絡先 [customer_contact] テーブル、またはコンシューマー [csm_consumer] テーブルにあります。データタイプ：文字列
relatedParty.name	アカウント、顧客、またはコンシューマーの名前。データタイプ：文字列
relatedParty.@type	TMF オープン API 標準の一部。オーダー品目に関する連絡先の注釈。この値は常に RelatedParty です。この情報は保存されません。データタイプ：文字列
relatedParty.@referredType	関連するパーティのタイプ。可能な値： Customer CustomerContact コンシューマーデータタイプ：文字列
serviceQualificationItem	場所、サービス情報、およびサービス特性に関する情報を含むサービス認定アイテムのリスト。顧客注文の注文品目として保存されます。データタイプ：オブジェクトのアレイ `"serviceQualificationItem": [ { "id": "string", "action": "string", "expectedServiceAvailabilityDate": "number", "service": { "place": [ { "id": "string", "name": "string" } ], "serviceCharacteristic": [ { "valueType": "string", "name": "string", "value": "string" } ], "serviceSpecification": { "id": "string", "name": "string" } }, "@type": "ServiceQualificationItem" } ],`
serviceQualificationItem.id	認定アイテムの ID。顧客注文品目の [external_id] フィールドに保存されます。データタイプ：文字列
serviceQualificationItem.qualificationResult	認定項目の結果。顧客の注文品目の [結果] フィールドに保存されます。可能な値：代替なし保留中認定済み無条件データタイプ：文字列
serviceQualificationItem.state	顧客の注文品目の [status] フィールドから導出された認定品目のステータス。データタイプ：文字列
serviceQualificationItem.quantity	顧客の注文品目の [数量] フィールドから導出された認定品目の数量。データタイプ：数値
serviceQualificationItem.@type	TMF オープン API 標準の一部。認定アイテムの注釈。この値は常に ServiceQualificationItem です。この情報は保存されません。データタイプ：文字列
serviceQualificationItem.service	場所 (場所)、サービス仕様、およびサービス特性に関する詳細を含むサービス情報。データタイプ: オブジェクト `"service": { "place": [ { "id": "String", "name": "String" } ], "serviceCharacteristic": [ { "valueType": "String", "name": "String", "value": "String" } ], "serviceSpecification": { "id": "String", "name": "String" } }`
serviceQualificationItem.service.@type	TMF Open API 標準の一部。サービスの注釈。この値は常に Service です。この情報は保存されません。データタイプ：文字列
serviceQualificationItem.service.place	サービス認定アイテムの場所情報。データタイプ:オブジェクトのアレイ。注: この配列には、1 つの場所のみを含めることができます。 `"place": [ { "id": "5671dd2ec3a53010188473ce3640dd81", "name": "Jean Pontus home", "@referredType": "GeographicSite" } ]`
serviceQualificationItem.service.place.id	場所 [cmn_location] テーブル内の場所Sys_id。データタイプ：文字列
serviceQualificationItem.service.place.name	場所の名前。場所 [cmn_location] テーブルのエントリに対して検証されていません。データタイプ：文字列
serviceQualificationItem.service.place.@type	TMF オープン API 標準の一部。サービスの注釈。この値は常に GeographicSite です。この情報は保存されません。データタイプ：文字列
serviceQualificationItem.service.serviceSpecification	認定アイテムのサービス仕様の詳細。データタイプ:オブジェクトのアレイ。 `"serviceSpecification": { "id": "String", "internalVersion": "Number", "internalId": "String", "name": "String" "@type": "ServiceSpecification" "version": "String", }`
serviceQualificationItem.service.serviceSpecification.id	外部 ID またはサービス仕様の初期バージョン。データタイプ：文字列
serviceQualificationItem.service.serviceSpecification.name	サービス仕様の名前。データタイプ：文字列
serviceQualificationItem.service.serviceSpecification.version	サービス仕様の外部バージョン。データタイプ：文字列
serviceQualificationItem.service.serviceSpecification.internalVersion	サービス仕様の内部バージョン。データタイプ：数値
serviceQualificationItem.service.serviceSpecification.internalId	サービス仕様の初期バージョン。データタイプ：文字列
serviceQualificationItem.service.serviceSpecification.@type	TMF オープン API 標準の一部。サービス仕様の注釈。この値は常に ServiceSpecification です。この情報は保存されません。データタイプ：文字列
serviceQualificationItem.service.serviceCharacteristic	サービス特性のリスト。データタイプ：オブジェクトのアレイ `"serviceCharacteristic": [ { "name": "Speed", "value": "High" "valueType": "string", } ]`
serviceQualificationItem.service.serviceCharacteristic.valueType	特性の値タイプ。データタイプ：文字列
serviceQualificationItem.service.serviceCharacteristic.name	特性の名前。データタイプ：文字列
serviceQualificationItem.service.serviceCharacteristic.value	特性の値。データタイプ：文字列
ServiceQualificationItem.alternateServiceProposal	認定オーダーの代替サービス提案。代替提案は代替提案 [sn_ord_qual_mgmt_alternate_proposal] テーブルに保存されます。データタイプ：文字列
ServiceQualificationItem.alternateServiceProposal.id	代替提案 [sn_ord_qual_mgmt_alternate_proposal] テーブルの代替提案エントリのSys_id。データタイプ：文字列
ServiceQualificationItem.alternateServiceProposal.alternateServiceAvailabilityDate	代替提案 [sn_ord_qual_mgmt_alternate_proposal] テーブルの代替提案エントリのavailable_dateフィールド値。データタイプ：文字列
serviceQualificationItem.alternateServiceProposal.alternateService	代替提案によって表されるサービス情報。データタイプ: オブジェクト
serviceQualificationItem.alternateServiceProposal.alternateService.serviceSpecification	代替提案のサービス仕様は、代替提案 [sn_ord_qual_mgmt_alternate_proposal] テーブルの仕様に保持されます。データタイプ: オブジェクト
serviceQualificationItemalternateServiceProposal.alternateService.serviceSpecification.id	外部 ID または代替サービス仕様の初期バージョン。データタイプ：文字列
serviceQualificationItemalternateServiceProposal.alternateService.serviceSpecification.name	代替サービス仕様の名前。データタイプ：文字列
serviceQualificationItemalternateServiceProposal.alternateService.serviceSpecification.version	代替サービス仕様の外部バージョン。データタイプ：文字列
serviceQualificationItemalternateServiceProposal.alternateService.serviceSpecification.internalVersion	代替サービス仕様の内部バージョン。データタイプ：数値
serviceQualificationItemalternateServiceProposal.alternateService.serviceSpecification.internalId	代替サービス仕様の初期バージョン。データタイプ：文字列
ServiceQualificationItemalternateServiceProposal.alternateService.serviceSpecification.@type	TMF オープン API 標準の一部。サービス仕様の注釈。この値は常に ServiceSpecification です。この情報は保存されません。データタイプ：文字列
serviceQualificationItemalternateServiceProposal.alternateService.serviceCharacteristic	代替サービス提案のサービス特性のアレイ。データタイプ：オブジェクトのアレイ `"serviceCharacteristic": [ { "valueType": "String", "name": "String", "value": "String" } ]`
serviceQualificationItemalternateServiceProposal.alternateService.serviceCharacteristic.valueType	代替サービス特性の値タイプ。データタイプ：文字列
serviceQualificationItemalternateServiceProposal.alternateService.serviceCharacteristic.name	代替サービス特性の名前。データタイプ：文字列
serviceQualificationItemalternateServiceProposal.alternateService.serviceCharacteristic.value	代替サービス特性の値。データタイプ：文字列
serviceQualificationItem.eligibilityUnunavailableReason	サービスを利用できない理由を説明する、サービス適格性を使用できない理由のリスト。この値は、ドメインオーダー [sn_ind_tmt_orm_domain_order] テーブルの「unavailability_reason」に保存されます。データタイプ：アレイ
serviceQualificationItem.eligibilityUnavailabilityReason.code	サービス適格性使用不可の理由コード。データタイプ：文字列
serviceQualificationItem.eligibilityUnavailabilityReason.label	サービス適格性を使用不可の理由ラベル。データタイプ：文字列

サンプル cURL 要求

次の GET 呼び出しは、インスタンスのすべての認定オーダーを取得します。

curl -location --request GET "https://instance.service-now.com/api/sn_ord_qual_mgmt/qualification/checkServiceQualification" \ 
--user "username":"password"

応答：

[{
        "id": "001b359545371150f877e0588eca21ca",
        "href": "/api/sn_ord_qual_mgmt/qualification/checkServiceQualification/001b359545371150f877e0588eca21ca",
        "description": "check service qualification illustration",
        "externalId": "CSQ1",
        "qualificationResult": "none",
        "state": "new",
        "@type": "CheckServiceQualification",
        "checkServiceQualificationDate": "2022-12-14T23:44:44.000Z",
        "relatedParty": [{
                "id": "eaf68911c35420105252716b7d40ddde",
                "name": "Sally Thomas",
                "@type": "RelatedParty",
                "@referredType": "CustomerContact"
            },
            {
                "id": "ffc68911c35420105252716b7d40dd55",
                "name": "Funco Intl",
                "@type": "RelatedParty",
                "@referredType": "Customer"
            },
            {
                "id": "59f16de1c3b67110ff00ed23a140dd9e",
                "name": "Funco External",
                "@type": "RelatedParty",
                "@referredType": "Consumer"
            }
            {
                "id": "59f16de1c3b67110ff00ed23a140dd9e",
                "name": "Funco External",
                "@type": "RelatedParty",
                "@referredType": "Consumer"
            }
        ],
        "serviceSpecification": {
            "id": "91478553b7969910ff00f203ae11a97d",
            "name": "Broadband Service",
            "version": "",
            "internalVersion": "1",
            "internalId": "91478553b7969910ff00f203ae11a97d",
            "@type": "ServiceSpecification"
        },
        "place": {
            "id": "5671dd2ec3a53010188473ce3640dd81",
            "name": "3000 Main Street, Santa Clara, CA",
            "@referredType": "GeographicSite"
        }
    }
}],
"expectedQualificationDate": "2022-10-11T15:20:39.000Z"
}, {
    "id": "0236b75145fb1150f877e0588eca2145",
    "href": "/api/sn_ord_qual_mgmt/qualification/checkServiceQualification/0236b75145fb1150f877e0588eca2145",
    "description": "check service qualification illustration",
    "externalId": "CSQ1",
    "qualificationResult": "none",
    "state": "new",
    "@type": "CheckServiceQualification",
    "checkServiceQualificationDate": "2022-12-15T08:57:50.000Z",
    "relatedParty": [{
            "id": "ffc68911c35420105252716b7d40dd55",
            "name": "Funco Intl",
            "@type": "RelatedParty",
            "@referredType": "Customer"
        },
        {
            "id": "eaf68911c35420105252716b7d40ddde",
            "name": "Sally Thomas",
            "@type": "RelatedParty",
            "@referredType": "CustomerContact"
        }
            {
                "id": "59f16de1c3b67110ff00ed23a140dd9e",
                "name": "Funco External",
                "@type": "RelatedParty",
                "@referredType": "Consumer"
            }
    ],
    "serviceQualificationItem": [{
            "id": "110",
            "qualificationResult": "none",
            "state": "new",
            "quantity": "1",
            "@type": "ServiceQualificationItem",
            "service": {
                "@type": "Service",
                "serviceCharacteristic": [{
                    "name": "Fiber Speed",
                    "valueType": "choice",
                    "value": "1Gbps"
                }],
                "serviceSpecification": {
                    "id": "4d2b5799457b1150f877e0588eca2116",
                    "name": "CFS3",
                    "version": "",
                    "internalVersion": "1",
                    "internalId": "4d2b5799457b1150f877e0588eca2116",
                    "@type": "ServiceSpecification"
                },
                "place": {
                    "id": "5671dd2ec3a53010188473ce3640dd81",
                    "name": "3000 Main Street, Santa Clara, CA",
                    "@referredType": "GeographicSite"
                }
            }
        },
        {
            "id": "130",
            "qualificationResult": "none",
            "state": "new",
            "quantity": "1",
            "@type": "ServiceQualificationItem",
            "service": {
                "@type": "Service",
                "serviceCharacteristic": [{
                    "name": "Wireless Speed",
                    "valueType": "choice",
                    "value": "100 Mbps"
                }],
                "serviceSpecification": {
                    "id": "28733d1d45f31150f877e0588eca2163",
                    "name": "CFS2",
                    "version": "",
                    "internalVersion": "1",
                    "internalId": "28733d1d45f31150f877e0588eca2163",
                    "@type": "ServiceSpecification"
                },
                "place": {
                    "id": "5671dd2ec3a53010188473ce3640dd81",
                    "name": "3000 Main Street, Santa Clara, CA",
                    "@referredType": "GeographicSite"
                }
            }
        },
        {
            "id": "100",
            "qualificationResult": "none",
            "state": "new",
            "quantity": "1",
            "@type": "ServiceQualificationItem",
            "service": {
                "@type": "Service",
                "serviceCharacteristic": [{
                    "name": "Speed",
                    "valueType": "choice",
                    "value": ""
                }],
                "serviceSpecification": {
                    "id": "b3933d9d45f31150f877e0588eca21fc",
                    "name": "Access Service",
                    "version": "",
                    "internalVersion": "1",
                    "internalId": "b3933d9d45f31150f877e0588eca21fc",
                    "@type": "ServiceSpecification"
                },
                "place": {
                    "id": "5671dd2ec3a53010188473ce3640dd81",
                    "name": "3000 Main Street, Santa Clara, CA",
                    "@referredType": "GeographicSite"
                }
            }
        },
        {
            "id": "120",
            "qualificationResult": "none",
            "state": "new",
            "quantity": "1",
            "@type": "ServiceQualificationItem",
            "service": {
                "@type": "Service",
                "serviceCharacteristic": [{
                    "name": "DSL Speed",
                    "valueType": "choice",
                    "value": "500 Mbps"
                }],
                "serviceSpecification": {
                    "id": "1d43f91d45f31150f877e0588eca21cd",
                    "name": "CFS1",
                    "version": "",
                    "internalVersion": "1",
                    "internalId": "1d43f91d45f31150f877e0588eca21cd",
                    "@type": "ServiceSpecification"
                },
                "place": {
                    "id": "5671dd2ec3a53010188473ce3640dd81",
                    "name": "3000 Main Street, Santa Clara, CA",
                    "@referredType": "GeographicSite"
                }
            }
        }
    ],
    "expectedQualificationDate": "2022-10-11T15:20:39.000Z"
}
]

テクニカルサービス認定オープン API - POST sn_ord_qual_mgmt/qualification/checkServiceQualification

認定アイテムのリストを含むテクニカルサービス認定要求エンティティを作成します。

サービス認定要求は、「認定」履行タイプの顧客注文として保持されます。各認定アイテムは、注文 [sn_ind_tmt_orm_order_line_item] テーブルに顧客明細注文として保持されます。

このエンドポイントの使用

この API メソッドは、次の 3 つの特定のユースケースで使用できます。

指定されたアドレスでのサービスの認定を要求します。
既存のアクティブな Access サービスと同じ場所で新しいサービスの認定を要求します。
既存のサービスのアップグレードまたはダウングレードを要求します。

各ユースケースでは、同じ要求構造が必要ですが、異なる要求パラメーターを使用します。各ユースケースと許可されるパラメーターの詳細が表示されます。

指定したアドレスのサービスを認定するには、 place 配列 (serviceQualificationItem.service.place) 特定の場所とサービス仕様を指定します。オプションで、要求で追加のサービス特性を定義できます。
既存のアクティブなサービスと同じ場所にある新しいサービスを認定するには、アレイの代わりにplaceオブジェクト referenceServiceInventory (serviceQualificationItem.service.referenceServiceInventory) を使用します。このオブジェクトを使用すると、場所の詳細を指定しなくても、要求を作成し、サービス仕様を定義できます。オプションで、要求で追加のサービス特性を定義できます。
既存のサービスをアップグレードまたはダウングレードするには、アレイまたはreferenceServiceInventoryオブジェクトの代わりにplaceオブジェクト serviceInventory (serviceQualificationItem.service.ServiceInventory) を使用します。このユースケースでは、場所情報と仕様の詳細が既存のサービスから取得されます。要求で、変更するサービス特性を定義します。
たとえば、既存のアクティブなサービスのダウンロード速度を 100Mb/s から 600Mb/s にアップグレードできることを確認するとします。この場合、「速度」特性を「低」から「高」に変更することで、パラメーターを使用して serviceInventory 要求を定義できます。API は、既存のサービスから残りの特性を取得します。

特定のユースケースごとにAPIリクエストを形成する方法を理解するには、このページの「例」セクションにある呼び出しの例を参照してください。

URL 形式

バージョニングされた URL:/ api/sn_ord_qual_mgmt/qualification/checkServiceQualification

サポートされている要求パラメーター

表 : 13. パスパラメーター
名前	説明
なし

表 : 14. クエリパラメータ
名前	説明
なし

表 : 15. 要求本文パラメーター (XML または JSON)
パラメーター	説明
description	オプション。顧客注文の [short_description] フィールドに保存されて保持される認定要求の説明。データタイプ：文字列
checkServiceQualificationDate	オプション。認定要求が作成された日時を保存します。顧客注文の [order_date] フィールドに保持されます。指定しない場合、'order_date' は現在の日時に設定されます。データタイプ: 文字列形式:YYYY-MM-DDTHH:MM:SS。ティッカー
有効な資格認定日	オプション。予定されている認定日を保存します。顧客注文の「actual_end_date」フィールドに保持されます。データタイプ：文字列形式:YYYY-MM-DDTHH:MM:SS。ティッカー
expectedQualificationDate	オプション。予定されている認定日を保存します。顧客注文のexpected_end_dateフィールドに保持されます。データタイプ：文字列形式:YYYY-MM-DDTHH:MM:SS。ティッカー
externalId	オプション。顧客注文の「external_id」に保持される、顧客注文の外部 ID。データタイプ：文字列
relatedParty	必須です。認定要求に関連付けられた連絡先のリスト (顧客アカウント、連絡先など)。配列として書式設定し、 relatedParty 顧客またはコンシューマーアカウント情報を含むオブジェクトを少なくとも 1 つリストする必要があります。データタイプ：オブジェクトのアレイ `"relatedParty": [ { "id": "String", "name": "String", "@referredType": "String" "@type": "String", }, ]`
relatedParty.id	必須です。注文に関連付けられたアカウント、お客様の連絡先、またはコンシューマーのSys_idまたはexternal_id。アカウント [customer_account] テーブル、連絡先 [customer_contact] テーブル、またはコンシューマー [csm_consumer] テーブルにあります。データタイプ：文字列
relatedParty.name	オプション。アカウント、顧客、またはコンシューマーの名前。データタイプ：文字列
relatedParty.@type	オプション。TMF オープン API 標準の一部。オーダー品目に関する連絡先の注釈。この値は常に RelatedParty です。彼の情報は保存されません。データタイプ：文字列
relatedParty.@referredType	必須です。関連するパーティのタイプ。有効な値：顧客 CustomerContact コンシューマーデータタイプ：文字列
serviceQualificationItem	必須です。場所、サービス仕様、およびサービス特性に関する情報を含むサービス認定アイテムのリスト。顧客注文の注文品目として保存されます。リストに少なくとも 1 つのサービス資格アイテムを含めます。データタイプ：オブジェクトのアレイ `"serviceQualificationItem": [ { "id": "100", "action": "add", "expectedServiceAvailabilityDate": "2022-12-11T19:20:39.239Z", "service": { "place": [ { "id": "5671dd2ec3a53010188473ce3640dd81", "name": "Jean Pontus home" } ], "serviceCharacteristic": [ { "valueType": "string", "name": "Speed", "value": "High" } ], "serviceSpecification": { "id": "91478553b7969910ff00f203ae11a97d", "name": "Broadband Service" } }, "@type": "ServiceQualificationItem" } ],`
serviceQualificationItem.id	必須です。認定アイテムの ID。顧客注文品目の [external_id] フィールドに保存されます。データタイプ：文字列
serviceQualificationItem.quantity	オプション。認定アイテムの数量。顧客の注文品目の [数量] フィールドに保持されます。データタイプ：数値デフォルト値：1
serviceQualificationItem.qualificationItemRelationship	オプション。同じ要求内の他のサービス認定アイテムとの関係のリスト。この情報は、親注文品目で注文品目を作成するのに役立ちます。データタイプ:オブジェクトのアレイ `"qualificationItemRelationship": [ { "relationshipType": "HasChild", "id": "110" }, { "relationshipType": "HasChild", "id": "120" }, { "relationshipType": "HasChild", "id": "130" } ] "qualificationItemRelationship": [ { "relationshipType": "HasParent", "id": "100" } ]`
serviceQualificationItem QualificationItemRelationship.relationshipType	必須です。関係のタイプが子品目か親品目かを示します。許容値: HasChild: 子アイテムを示します。 HasParent:親品目を示します。データタイプ：文字列
serviceQualificationItem.QualificationItemRelationship.id	必須です。関係内の tar取得修飾アイテムの ID。データタイプ：文字列
serviceQualificationItem.service	必須です。場所、サービス仕様、およびサービス特性に関する詳細を提供するサービス情報。データタイプ:オブジェクト `"service": { "place": [ { "id": "5671dd2ec3a53010188473ce3640dd81", "name": "Jean Pontus home" } ], "serviceCharacteristic": [ { "valueType": "string", "name": "Speed", "value": "High" } ], "serviceSpecification": { "id": "91478553b7969910ff00f203ae11a97d", "name": "Broadband Service" } }`
serviceQualificationItem.service.@type	オプション。TMF オープン API 標準の一部。認定アイテムのサービス情報の注釈。この値は常に Service です。この情報は保存されません。データタイプ：文字列
serviceQualificationItem.service.place	必須です。サービス認定アイテムの要求された場所情報を格納します。この場所 ID は、場所 [cmn_location] テーブルの有効なエントリである必要があります。重要: place 配列を使用して、特定の住所のサービスを認定します。これを行うには、要求から and referenceServiceInventoryserviceInventory オブジェクトの両方を省略する必要があります。省略しないと、API はエラーを返します。データタイプ: オブジェクトのアレイ注: アレイはサポートされていますが、アレイには 1 つの場所のみを含める必要があります。アレイの例: `"place": [ { "id": "5671dd2ec3a53010188473ce3640dd81", "name": "Jean Pontus home" } ]`
serviceQualificationItem.service.place.id	要求で使用する場合はserviceQualificationItem.service.place必須です。場所 [cmn_location] テーブル内の場所のsys_id。データタイプ：文字列
serviceQualificationItem.service.place.name	要求で使用する場合は serviceQualificationItem.service.place オプションです。場所の名前。名前の値は、場所 [cmn_location] エントリに対して検証されません。データタイプ：文字列
serviceQualificationItem.service.place.@type	要求で使用する場合は serviceQualificationItem.service.place オプションです。 TMF オープン API 標準の一部。サービスの注釈。この値は常に GeographicSite です。この情報は保存されません。データタイプ：文字列
serviceQualificationItem.service.referenceServiceInventory	必須です。必要な場所のアクティブなサービスを参照する有効なサービス在庫エンティティ。認定オーダーの場所情報は、このサービス在庫の場所から取得されます。重要: この referenceServiceInventory オブジェクトを使用して、既存のアクティブな Access サービスの同じ場所で新しいサービスを修飾します。これを行うには、要求から配列とserviceInventoryオブジェクトも省略placeする必要があります。省略しないと、API はエラーを返します。データタイプ: オブジェクト `"referenceServiceInventory": { "id": "f1b2d99e777301108e191e599a5a99d2" },`
serviceQualificationItem.service.referenceServiceInventory.id	要求で使用する場合は serviceQualificationItem.service.referenceServiceInventory 必須です。必要な場所のアクティブなサービスを参照する有効なサービス在庫エンティティのsys_id。この情報は注文作業メモにのみ記載され、保持されません。データタイプ：文字列
serviceQualificationItem.service.serviceInventory	必須です。アップグレードまたはダウングレードを必要とするアクティブなサービスを指す有効なサービス在庫エンティティ。重要: serviceInventoryこのオブジェクトは、サービスのアップグレードまたはダウングレードに使用します。そのためには、リクエストから場所 array と referenceServiceInventory オブジェクトを省略しないと、APIがエラーを返します。データタイプ: オブジェクト `"serviceInventory": { "id": "f1b2d99e777301108e191e599a5a99d2" },` serviceCharacteristicsこのパラメーターは、サービス変更の定義に使用するserviceInventory場合に必要です。認定オーダーの場所およびサービス仕様情報は、それぞれこのサービス在庫の場所と仕様から取得されます。
serviceQualificationItem.service.serviceInventory.id	要求で使用する場合は serviceQualificationItem.service.serviceInventory 必須です。アップグレードまたはダウングレードが必要な有効な既存のサービス在庫エンティティのsys_id。この情報は注文作業メモにのみ記載され、保持されません。データタイプ：文字列
serviceQualificationItem.service.serviceSpecification	必須です。認定アイテムのサービス仕様。顧客注文品目の [service_specification] フィールドに保存されます。認定アイテムのサービス仕様は、リソース向けであってはなりません。データタイプ: オブジェクト `"serviceSpecification": { "id": "91478553b7969910ff00f203ae11a97d", "name": "Broadband Service", “@type”: ”ServiceSpecification” }`
serviceQualificationItem.service.serviceSpecification.id	必須です。サービス仕様の外部 ID または初期バージョン。データタイプ：文字列
serviceQualificationItem.service.serviceSpecification.name	必須です。サービス仕様の名前。データタイプ：文字列
serviceQualificationItem.service.serviceSpecificationバージョン	オプション。外部サービス仕様のバージョン。データタイプ：文字列
serviceQualificationItem.service.serviceSpecification内部バージョン	オプション。サービス仕様の内部バージョンデータタイプ：数値
ServiceQualificationItem.service.serviceSpecification.@type	オプション。TMF オープン API 標準の一部。サービス仕様の注釈。この値は常に ServiceSpecification です。この情報は保存されません。データタイプ：文字列
serviceQualificationItem.service.serviceCharacteristic	オプション。サービス特性のアレイ。データタイプ:オブジェクトのアレイ
serviceQualificationItem.service.serviceCharacteristic。Valuetype	オプション。特性の値タイプ。データタイプ：文字列
serviceQualificationItem.service.serviceCharacteristic.name	必須です。特性の名前。データタイプ：文字列
serviceQualificationItem.service.serviceCharacteristic.value	オプション。特性の値。TMF オープン API 標準の一部。認定アイテムの注釈。この値は常に ServiceQualificationItem です。この情報は保存されません。データタイプ：文字列
serviceQualificationItem.@type	オプション。TMF オープン API 標準の一部。認定アイテムの注釈。この値は常に ServiceQualificationItem です。この情報は保存されません。データタイプ：文字列
@type	オプション。TMF オープン API 標準の一部。認定の注釈。この値は常に CheckServiceQualification です。この情報は保存されません。データタイプ：文字列

ヘッダー

表 : 16. 要求ヘッダー
ヘッダー	説明
承認	応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。デフォルト： application/json

表 : 17. 応答ヘッダー
ヘッダー	説明
なし

ステータスコード

表 : 18. ステータスコード
ステータスコード	説明
201	要求が正常に処理されました。注: 特性または特性オプション情報に問題がある場合、エンドポイントは、既存の配送注文と同様に、関連する顧客オーダー品目レコードの作業メモフィールドに次のコメントを保存します
400	要求が正しくありません。以下のいずれかの理由が考えられます。空のペイロード。無効なペイロード:必須フィールドがありません:<フィールド名> 無効なペイロード：要求本文がありません - ペイロードが要求本文で渡されませんでした。無効なペイロード:relatedParty がありません。無効なペイロード:serviceQualificationItem がありません。無効なペイロード:serviceQualificationItem id がありません。無効なペイロード:serviceQualificationItem サービスがありません。無効なペイロード:場所情報がありません。場所、サービス在庫、または参照サービス在庫を指定してください。無効なペイロード:仕様情報がありません。serviceSpecification または serviceInventory を指定してください。無効なペイロード:サービス仕様が存在しません。無効なペイロード:顧客アカウントが存在しません。無効なペイロード:コンシューマーが存在しません。
500	内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。

応答本文のパラメーター (JSON または XML)

表 : 19. 応答本文で返される要素
要素	説明
ID	この要求に対して更新された認定顧客注文のSys_id。データタイプ：文字列
href	認定オーダーレコードへの相対リンク。データタイプ：文字列
description	顧客注文の [short_description] フィールドから使用される認定要求の説明。データタイプ：文字列
externalId	顧客注文の「external_id」からの外部 ID 。データタイプ：文字列
qualificationResult	[結果] フィールドからの顧客注文の結果。可能な値: 認定済み無条件代替保留中なしデータタイプ：文字列
ステータス	顧客注文の [ステータス] フィールドからの顧客注文のステータス。
@type	TMF オープン API 標準の一部。認定の注釈。この値は常に CheckServiceQualification です。この情報は保存されません。データタイプ：文字列
checkServiceQualificationDate	顧客注文の [order_date] フィールドから認定要求が作成された日時。データタイプ：文字列形式:YYYY-MM-DDTHH:MM:SS。ティッカー
有効な資格認定日	顧客注文の [order_date] フィールドからの有効な認定日。データタイプ：文字列形式:YYYY-MM-DDTHH:MM:SS。ティッカー
expectedQualificationDate	予定されている認定日を保存します。顧客注文のexpected_end_dateフィールドに保持されます。データタイプ：文字列形式:YYYY-MM-DDTHH:MM:SS。ティッカー
relatedParty	必須です。認定要求に関連付けられた連絡先のリスト (顧客アカウント、連絡先など)。配列として書式設定し、 relatedParty 顧客またはコンシューマーアカウント情報を含むオブジェクトを少なくとも 1 つリストする必要があります。データタイプ：オブジェクトのアレイアレイの例: `"relatedParty": [ { "id": "String", "name": "String", "@type": "String", "@referredType": "String" }, ]`
relatedParty.id	必須です。注文に関連付けられたアカウント、お客様の連絡先、またはコンシューマーのSys_idまたはexternal_id。アカウント [customer_account] テーブル、連絡先 [customer_contact] テーブル、またはコンシューマー [csm_consumer] テーブルにあります。データタイプ：文字列
relatedParty.name	オプション。アカウント、顧客、またはコンシューマーの名前。データタイプ：文字列
relatedParty.@type	TMF オープン API 標準の一部。オーダー品目に関する連絡先の注釈。この値は常に RelatedParty です。この情報は保存されません。データタイプ：文字列
relatedParty.@referredType	関連するパーティのタイプ。可能な値： Customer CustomerContact コンシューマーデータタイプ：文字列
serviceQualificationItem	場所、サービス情報、および特性を含むサービス資格アイテムのリスト。顧客注文の注文品目として保存されます。リストに少なくとも 1 つのサービス資格アイテムを含める必要があります。データタイプ：オブジェクトのアレイ `"serviceQualificationItem": [ { "id": "100", "action": "add", "expectedServiceAvailabilityDate": "2022-12-11T19:20:39.239Z", "service": { "place": [ { "id": "5671dd2ec3a53010188473ce3640dd81", "name": "Jean Pontus home" } ], "serviceCharacteristic": [ { "valueType": "string", "name": "Speed", "value": "High" } ], "serviceSpecification": { "id": "91478553b7969910ff00f203ae11a97d", "name": "Broadband Service" } }, "@type": "ServiceQualificationItem" } ],`
serviceQualificationItem.id	認定アイテムの ID。この ID はexternal_id顧客注文品目のフィールドに保存されます。データタイプ：文字列
serviceQualificationItem.qualificationResult	認定項目の結果。顧客の注文品目の「結果」に保存されます。結果は、なし、保留中、認定済み、非修飾、代替のいずれかです。データタイプ：文字列
serviceQualificationItem.state	顧客の注文品目の [status] フィールドから派生した認定品目のステータス。データタイプ：文字列
serviceQualificationItem.quantity	顧客の注文品目の [数量] フィールドから導出された認定品目の数量。データタイプ：数値
serviceQualificationItem.@type	TMF オープン API 標準の一部。認定アイテムの注釈。この値は常に ServiceQualificationItem です。この情報は保存されません。データタイプ：文字列
serviceQualificationItem.service	サービス情報には、場所、仕様、特性が含まれます。データタイプ:オブジェクト `"service": { "place": [ { "id": "5671dd2ec3a53010188473ce3640dd81", "name": "Jean Pontus home" } ], "serviceCharacteristic": [ { "valueType": "string", "name": "Speed", "value": "High" } ], "serviceSpecification": { "id": "91478553b7969910ff00f203ae11a97d", "name": "Broadband Service" } }`
serviceQualificationItem.service.@type	TMF オープン API 標準の一部。サービスの注釈。この値は常に Service です。この情報は保存されません。データタイプ：文字列
serviceQualificationItem.service.place	サービス認定アイテムの場所情報。データタイプ:オブジェクトのアレイ。注: アレイはサポートされていますが、1 つの場所のみを含めることができます。 `"place": [ { "id": "5671dd2ec3a53010188473ce3640dd81", "name": "Jean Pontus home", "@referredType": "GeographicSite" } ]`
serviceQualificationItem.service.place.id	テーブル内の場所cmn_location Sys_id。データタイプ：文字列
serviceQualificationItem.service.place.name	場所の名前。cmn_location のエントリに対して検証されません。データタイプ：文字列
serviceQualificationItem.service.place.@type	TMF オープン API 標準の一部。サービスの注釈。この値は常に GeographicSite です。この情報は保存されません。データタイプ：文字列
serviceQualificationItem.service.serviceSpecification	認定アイテムのサービス仕様。データタイプ: オブジェクト `"serviceSpecification": { "id": "91478553b7969910ff00f203ae11a97d", "name": "Broadband Service", "version": "", "internalVersion": "1", "internalId": "91478553b7969910ff00f203ae11a97d", "@type": "ServiceSpecification" }`
serviceQualificationItem.service.serviceSpecification.id	外部 ID またはサービス仕様の初期バージョン。データタイプ：文字列
serviceQualificationItem.service.serviceSpecification.name	サービス仕様の名前。データタイプ：文字列
serviceQualificationItem.service.serviceSpecification.version	サービス仕様の外部バージョンデータタイプ：文字列
serviceQualificationItem.service.serviceSpecification.internalVersion	サービス仕様の内部バージョンデータタイプ：文字列
serviceQualificationItem.service.serviceSpecification.internalId	サービス仕様の内部 ID データタイプ：文字列
serviceQualificationItem.service.serviceSpecification.@type	TMF オープン API 標準の一部。サービス仕様の注釈。この値は常に ServiceSpecification です。この情報は保存されません。データタイプ：文字列
serviceQualificationItem.service.serviceCharacteristic	サービス特性のリスト。データタイプ：アレイ `"serviceCharacteristic": [ { "valueType": "string", "name": "Speed", "value": "High" } ]`
serviceQualificationItem.service.serviceCharacteristic.valueType	特性の値タイプ。データタイプ：文字列
serviceQualificationItem.service.serviceCharacteristic.name	特性の名前。データタイプ：文字列
serviceQualificationItem.service.serviceCharacteristic.value	特性の値。データタイプ：文字列

ユースケース 1

次の例は、単一の認定アイテムを含む単純な要求を示しています。

curl -X POST "https://instance.service-now.com/api/sn_ord_qual_mgmt/qualification/checkServiceQualification " \ 
-H "Accept: application/json" \ 
-H "Content-Type: application/json" \ 
-u "username":"password" \ 
-d {
  "description": "check service qualification illustration",
  "checkServiceQualificationDate": "2022-12-14T23:44:44.000Z",
  "effectiveQualificationDate": "2023-12-14T23:44:44.000Z",
  "expectedQualificationDate": "2023-10-11T15:20:39.000Z",
  "externalId": "CSQ1",
  "relatedParty": [
    {
      "id": "eaf68911c35420105252716b7d40ddde",
      "name": "Sally Thomas",
      "@type": "RelatedParty",
      "@referredType": "CustomerContact"
    },
    {
      "id": "ffc68911c35420105252716b7d40dd55",
      "name": "Funco Intl",
      "@type": "RelatedParty",
      "@referredType": "Customer"
    },
    {
      "id": "59f16de1c3b67110ff00ed23a140dd9e",
      "name": "Funco External",
      "@type": "RelatedParty",
      "@referredType": "Consumer"
    }
  ],
  "serviceQualificationItem": [
    {
      "id": "100",
      "service": {
        "@type": "Service",
        "place": [
          {
            "id": "5671dd2ec3a53010188473ce3640dd81",
            "name": "Jean Pontus home",
            "@type": "GeographicSite"
          }
        ],
        "serviceCharacteristic": [
          {
            "valueType": "choice",
            "name": "Speed",
            "value": "High"
          }
        ],
        "serviceSpecification": {
          "id": "91478553b7969910ff00f203ae11a97d",
          "name": "Broadband Service",
          "@type": "ServiceSpecification"
        }
      },
      "@type": "ServiceQualificationItem"
    }
  ],
  "@type": "CheckServiceQualification"
}

応答：

{
  "id": "0b45c47938bf1110f877c8d44c4b895d",
  "href": "/api/sn_ord_qual_mgmt/qualification/checkServiceQualification/0b45c47938bf1110f877c8d44c4b895d",
  "description": "check service qualification illustration",
  "externalId": "CSQ1",
  "qualificationResult": "none",
  "state": "new",
  "@type": "CheckServiceQualification",
  "checkServiceQualificationDate": "2022-12-14T23:44:44.000Z",
  "relatedParty": [
    {
      "id": "eaf68911c35420105252716b7d40ddde",
      "name": "Sally Thomas",
      "@type": "RelatedParty",
      "@referredType": "CustomerContact"
    },
    {
      "id": "ffc68911c35420105252716b7d40dd55",
      "name": "Funco Intl",
      "@type": "RelatedParty",
      "@referredType": "Customer"
    },
    {
      "id": "59f16de1c3b67110ff00ed23a140dd9e",
      "name": "Funco External",
      "@type": "RelatedParty",
      "@referredType": "Consumer"
    }
  ],
  "serviceQualificationItem": [
    {
      "id": "100",
      "qualificationResult": "none",
      "state": "new",
      "quantity": "1",
      "@type": "ServiceQualificationItem",
      "service": {
        "@type": "Service",
        "serviceCharacteristic": [
          {
            "name": "Speed",
            "valueType": "choice",
            "value": "High"
          }
        ],
        "serviceSpecification": {
          "id": "91478553b7969910ff00f203ae11a97d",
          "name": "Broadband Service",
          "version": "",
          "internalVersion": "1",
          "internalId": "91478553b7969910ff00f203ae11a97d",
          "@type": "ServiceSpecification"
        },
        "place": {
          "id": "5671dd2ec3a53010188473ce3640dd81",
          "name": "3000 Main Street, Santa Clara, CA",
          "@referredType": "GeographicSite"
        }
      }
    }
  ],
  "effectiveQualificationDate": "2023-12-14T23:44:44.000Z",
  "expectedQualificationDate": "2023-10-11T15:20:39.000Z"
}

ユースケース 2

次の例は、ID を使用して簡単なサービス認定を要求し、既存のサービスで顧客の場所を取得する方法を示しています。

注:

id = の参照サービス在庫は、場所 = 20220 の製品在庫ですテキサス州ヒューストン、ボウウィロー

curl -X POST "https://instance.service-now.com/api/sn_ord_qual_mgmt/qualification/checkServiceQualification " \ 
-H "Accept: application/json" \ 
-H "Content-Type: application/json" \ 
-u "username":"password" \ 
-d {
  "description": "check service qualification illustration",
  "checkServiceQualificationDate": "2022-12-14T23:44:44.000Z",
  "effectiveQualificationDate": "2023-12-14T23:44:44.000Z",
  "expectedQualificationDate": "2023-10-11T15:20:39.000Z",
  "externalId": "CSQ1",
  "relatedParty": [
    {
      "id": "eaf68911c35420105252716b7d40ddde",
      "name": "Sally Thomas",
      "@type": "RelatedParty",
      "@referredType": "CustomerContact"
    },
    {
      "id": "ffc68911c35420105252716b7d40dd55",
      "name": "Funco Intl",
      "@type": "RelatedParty",
      "@referredType": "Customer"
    },
    {
      "id": "59f16de1c3b67110ff00ed23a140dd9e",
      "name": "Funco External",
      "@type": "RelatedParty",
      "@referredType": "Consumer"
    }
  ],
  "serviceQualificationItem": [
    {
      "id": "100",
      "service": {
        "@type": "Service",
        "referenceServiceInventory": {
          "id": "f1b2d99e777301108e191e599a5a99d2"
        },
        "serviceCharacteristic": [
          {
            "valueType": "choice",
            "name": "Speed",
            "value": "High"
          }
        ],
        "serviceSpecification": {
          "id": "91478553b7969910ff00f203ae11a97d",
          "name": "Broadband Service",
          "@type": "ServiceSpecification"
        }
      },
      "@type": "ServiceQualificationItem"
    }
  ],
  "@type": "CheckServiceQualification"
}

要求内の入力元であるreferenceServiceInventory「応答place」です

{
    "id": "1683497138b35110f877c8d44c4b890a",
   "href":"/api/sn_ord_qual_mgmt/qualification/checkServiceQualification/1683497138b35110f877c8d44c4b890a",
    "description": "check service qualification illustration",
    "externalId": "CSQ1",
    "qualificationResult": "none",
    "state": "new",
    "@type": "CheckServiceQualification",
    "checkServiceQualificationDate": "2022-12-14T23:44:44.000Z",
    "relatedParty": [
        {
            "id": "eaf68911c35420105252716b7d40ddde",
            "name": "Sally Thomas",
            "@type": "RelatedParty",
            "@referredType": "CustomerContact"
        },
        {
            "id": "ffc68911c35420105252716b7d40dd55",
            "name": "Funco Intl",
            "@type": "RelatedParty",
            "@referredType": "Customer"
        },
        {
            "id": "59f16de1c3b67110ff00ed23a140dd9e",
            "name": "Funco External",
            "@type": "RelatedParty",
            "@referredType": "Consumer"
        }
    ],
    "serviceQualificationItem": [
        {
            "id": "100",
            "qualificationResult": "none",
            "state": "new",
            "quantity": "1",
            "@type": "ServiceQualificationItem",
            "service": {
                "@type": "Service",
                "serviceCharacteristic": [
                    {
                        "name": "Speed",
                        "valueType": "choice",
                        "value": "High"
                    }
                ],
                "serviceSpecification": {
                    "id": "91478553b7969910ff00f203ae11a97d",
                    "name": "Broadband Service",
                    "version": "",
                    "internalVersion": "1",
                    "internalId": "91478553b7969910ff00f203ae11a97d",
                    "@type": "ServiceSpecification"
                },
                "place": {
                    "id": "25aba4010a0a0bb3008f329002f12211",
                    "name": "20220 Bow Willow, Houston,TX",
                    "@referredType": "GeographicSite"
                }
            }
        }
    ],
    "effectiveQualificationDate": "2022-12-14T23:44:44.000Z",
    "expectedQualificationDate": "2023-10-11T15:20:39.000Z"
}

ユースケース 3

次の例は、ユーザーのブロードバンドサービスを高速にアップグレードする方法を示しています。ID = のサービス在庫は、サービス仕様 = 'ブロードバンドサービス'、場所 = 20220 Bow Willow, Houston, TX, Characteristics=[{Speed:Medium}] の製品在庫です。

{
  "description": "check service qualification illustration",
  "checkServiceQualificationDate": "2022-12-14T23:44:44.000Z",
  "effectiveQualificationDate": "2023-12-14T23:44:44.000Z",
  "expectedQualificationDate": "2023-10-11T15:20:39.000Z",
  "externalId": "CSQ1",
  "relatedParty": [
    {
      "id": "eaf68911c35420105252716b7d40ddde",
      "name": "Sally Thomas",
      "@type": "RelatedParty",
      "@referredType": "CustomerContact"
    },
    {
      "id": "ffc68911c35420105252716b7d40dd55",
      "name": "Funco Intl",
      "@type": "RelatedParty",
      "@referredType": "Customer"
    },
    {
      "id": "59f16de1c3b67110ff00ed23a140dd9e",
      "name": "Funco External",
      "@type": "RelatedParty",
      "@referredType": "Consumer"
    }
  ],
  "serviceQualificationItem": [
    {
      "id": "100",
      "service": {
        "@type": "Service",
        "serviceInventory": {
          "id": "f1b2d99e777301108e191e599a5a99d2"
        },
        "serviceCharacteristic": [
          {
            "valueType": "choice",
            "name": "Speed",
            "value": "High"
          }
        ]
      },
      "@type": "ServiceQualificationItem"
    }
  ],
  "@type": "CheckServiceQualification"
}

要求place内の serviceInventory と specification が入力されます。

注:

特性は最初に要求ペイロードから取得され、残りの特性 (存在する場合) はから取得 serviceInventoryされます。

{
    "id": " db8485b138b35110f877c8d44c4b892b",
    "href": "/api/sn_ord_qual_mgmt/qualification/checkServiceQualification/ db8485b138b35110f877c8d44c4b892b",
    "description": "check service qualification illustration",
    "externalId": "CSQ1",
    "qualificationResult": "none",
    "state": "new",
    "@type": "CheckServiceQualification",
    "checkServiceQualificationDate": "2022-12-14T23:44:44.000Z",
    "relatedParty": [
        {
            "id": "eaf68911c35420105252716b7d40ddde",
            "name": "Sally Thomas",
            "@type": "RelatedParty",
            "@referredType": "CustomerContact"
        },
        {
            "id": "ffc68911c35420105252716b7d40dd55",
            "name": "Funco Intl",
            "@type": "RelatedParty",
            "@referredType": "Customer"
        },
        {
            "id": "59f16de1c3b67110ff00ed23a140dd9e",
            "name": "Funco External",
            "@type": "RelatedParty",
            "@referredType": "Consumer"
        }
    ],
    "serviceQualificationItem": [
        {
            "id": "100",
            "qualificationResult": "none",
            "state": "new",
            "quantity": "1",
            "@type": "ServiceQualificationItem",
            "service": {
                "@type": "Service",
                "serviceCharacteristic": [
                    {
                        "name": "Speed",
                        "valueType": "choice",
                        "value": "High"
                    }
                ],
                "serviceSpecification": {
                    "id": "91478553b7969910ff00f203ae11a97d",
                    "name": "Broadband Service",
                    "version": "",
                    "internalVersion": "1",
                    "internalId": "91478553b7969910ff00f203ae11a97d",
                    "@type": "ServiceSpecification"
                },
                "place": {
                    "id": "25aba4010a0a0bb3008f329002f12211",
                    "name": "20220 Bow Willow, Houston,TX",
                    "@referredType": "GeographicSite"
                }
            }
        }
    ],
    "effectiveQualificationDate": "2022-12-14T23:44:44.000Z",
    "expectedQualificationDate": "2023-10-11T15:20:39.000Z"
}

ユースケース 4

親と子の品目の階層とそれらの関係タイプについて説明します。これは、quantity 属性を使用して複数の広告申込情報を作成する方法を示しています。

curl -X POST "https://instance.service-now.com/api/sn_ord_qual_mgmt/qualification/checkServiceQualification " \ 
-H "Accept: application/json" \ 
-H "Content-Type: application/json" \ 
-u "username":"password" \ 
-d {
  "description": "check service qualification illustration",
  "checkServiceQualificationDate": "2022-12-14T23:44:44.000Z",
  "effectiveQualificationDate": "2023-12-14T23:44:44.000Z",
  "expectedQualificationDate": "2023-10-11T15:20:39.000Z",
  "externalId": "CSQ1",
  "relatedParty": [
    {
      "id": "eaf68911c35420105252716b7d40ddde",
      "name": "Sally Thomas",
      "@type": "RelatedParty",
      "@referredType": "CustomerContact"
    },
    {
      "id": "ffc68911c35420105252716b7d40dd55",
      "name": "Funco Intl",
      "@type": "RelatedParty",
      "@referredType": "Customer"
    },
    {
      "id": "59f16de1c3b67110ff00ed23a140dd9e",
      "name": "Funco External",
      "@type": "RelatedParty",
      "@referredType": "Consumer"
    }
  ],
  "serviceQualificationItem": [
    {
      "id": "100",
      "quantity": 2,
      "qualificationItemRelationship": [
        {
          "relationshipType": "HasChild",
          "id": "110"
        },
        {
          "relationshipType": "HasChild",
          "id": "120"
        },
        {
          "relationshipType": "HasChild",
          "id": "130"
        }
      ],
      "service": {
        "@type": "Service",
        "place": [
          {
            "id": "5671dd2ec3a53010188473ce3640dd81",
            "name": "Jean Pontus home",
            "@referredType": "GeographicSite"
          }
        ],
        "serviceCharacteristic": [
          {
            "valueType": "string",
            "name": "Speed",
            "value": "High"
          }
        ],
        "serviceSpecification": {
          "id": "b3933d9d45f31150f877e0588eca21fc",
          "name": "Access Service"
        }
      },
      "@type": "ServiceQualificationItem"
    },
    {
      "id": "110",
      "action": "add",
      "expectedServiceAvailabilityDate": "2022-12-10T19:20:39.239Z",
      "qualificationItemRelationship": [
        {
          "relationshipType": "HasParent",
          "id": "100"
        }
      ],
      "service": {
        "@type": "Service",
        "place": [
          {
            "id": "5671dd2ec3a53010188473ce3640dd81",
            "name": "Jean Pontus home",
            "@referredType": "GeographicSite"
          }
        ],
        "serviceCharacteristic": [
          {
            "valueType": "choice",
            "name": "Fiber Speed",
            "value": "1Gbps"
          }
        ],
        "serviceSpecification": {
          "name": "CFS3",
          "internalVersion": "1",
          "id": "4d2b5799457b1150f877e0588eca2116"
        },
        "state": "new"
      },
      "@type": "ServiceQualificationItem"
    },
    {
      "id": "120",
      "action": "add",
      "qualificationItemRelationship": [
        {
          "relationshipType": "HasParent",
          "id": "100"
        }
      ],
      "expectedServiceAvailabilityDate": "2022-11-12T19:20:39.239Z",
      "service": {
        "@type": "Service",
        "place": [
          {
            "id": "5671dd2ec3a53010188473ce3640dd81",
            "name": "Jean Pontus home",
            "@referredType": "GeographicSite"
          }
        ],
        "serviceCharacteristic": [
          {
            "valueType": "choice",
            "name": "DSL Speed",
            "value": "500 Mbps"
          }
        ],
        "serviceSpecification": {
          "name": "CF1",
          "internalVersion": "1",
          "id": "1d43f91d45f31150f877e0588eca21cd"
        },
        "state": "new"
      },
      "@type": "ServiceQualificationItem"
    },
    {
      "id": "130",
      "action": "add",
      "expectedServiceAvailabilityDate": "2020-04-11T19:20:39.239Z",
      "qualificationItemRelationship": [
        {
          "relationshipType": "HasParent",
          "id": "100"
        }
      ],
      "service": {
        "@type": "Service",
        "place": [
          {
            "id": "5671dd2ec3a53010188473ce3640dd81",
            "name": "Jean Pontus home",
            "@referredType": "GeographicSite"
          }
        ],
        "serviceCharacteristic": [
          {
            "valueType": "choice",
            "name": "Wireless Speed",
            "value": "100 Mbps"
          }
        ],
        "serviceSpecification": {
          "name": "CFS2",
          "internalVersion": "1",
          "id": "28733d1d45f31150f877e0588eca2163"
        },
        "state": "new"
      },
      "@type": "ServiceQualificationItem"
    }
  ],
  "@type": "CheckServiceQualification"
}

応答：

{
  "id": "7bf9cd7538b35110f877c8d44c4b89e4",
  "href": "/api/sn_ord_qual_mgmt/qualification/checkServiceQualification/7bf9cd7538b35110f877c8d44c4b89e4",
  "description": "check service qualification illustration",
  "externalId": "CSQ1",
  "qualificationResult": "none",
  "state": "new",
  "@type": "CheckServiceQualification",
  "checkServiceQualificationDate": "2022-12-14T23:44:44.000Z",
  "relatedParty": [
    {
      "id": "eaf68911c35420105252716b7d40ddde",
      "name": "Sally Thomas",
      "@type": "RelatedParty",
      "@referredType": "CustomerContact"
    },
    {
      "id": "ffc68911c35420105252716b7d40dd55",
      "name": "Funco Intl",
      "@type": "RelatedParty",
      "@referredType": "Customer"
    },
    {
      "id": "59f16de1c3b67110ff00ed23a140dd9e",
      "name": "Funco External",
      "@type": "RelatedParty",
      "@referredType": "Consumer"
    }
  ],
  "serviceQualificationItem": [
    {
      "id": "120",
      "qualificationResult": "none",
      "state": "new",
      "quantity": "1",
      "@type": "ServiceQualificationItem",
      "service": {
        "@type": "Service",
        "serviceCharacteristic": [
          {
            "name": "DSL Speed",
            "valueType": "choice",
            "value": "500 Mbps"
          }
        ],
        "serviceSpecification": {
          "id": "1d43f91d45f31150f877e0588eca21cd",
          "name": "CFS1",
          "version": "",
          "internalVersion": "1",
          "internalId": "1d43f91d45f31150f877e0588eca21cd",
          "@type": "ServiceSpecification"
        },
        "place": {
          "id": "5671dd2ec3a53010188473ce3640dd81",
          "name": "3000 Main Street, Santa Clara, CA",
          "@referredType": "GeographicSite"
        }
      }
    },
    {
      "id": "110",
      "qualificationResult": "none",
      "state": "new",
      "quantity": "1",
      "@type": "ServiceQualificationItem",
      "service": {
        "@type": "Service",
        "serviceCharacteristic": [
          {
            "name": "Fiber Speed",
            "valueType": "choice",
            "value": "1Gbps"
          }
        ],
        "serviceSpecification": {
          "id": "4d2b5799457b1150f877e0588eca2116",
          "name": "CFS3",
          "version": "",
          "internalVersion": "1",
          "internalId": "4d2b5799457b1150f877e0588eca2116",
          "@type": "ServiceSpecification"
        },
        "place": {
          "id": "5671dd2ec3a53010188473ce3640dd81",
          "name": "3000 Main Street, Santa Clara, CA",
          "@referredType": "GeographicSite"
        }
      }
    },
    {
      "id": "130",
      "qualificationResult": "none",
      "state": "new",
      "quantity": "1",
      "@type": "ServiceQualificationItem",
      "service": {
        "@type": "Service",
        "serviceCharacteristic": [
          {
            "name": "Wireless Speed",
            "valueType": "choice",
            "value": "100 Mbps"
          }
        ],
        "serviceSpecification": {
          "id": "28733d1d45f31150f877e0588eca2163",
          "name": "CFS2",
          "version": "",
          "internalVersion": "1",
          "internalId": "28733d1d45f31150f877e0588eca2163",
          "@type": "ServiceSpecification"
        },
        "place": {
          "id": "5671dd2ec3a53010188473ce3640dd81",
          "name": "3000 Main Street, Santa Clara, CA",
          "@referredType": "GeographicSite"
        }
      }
    },
    {
      "id": "100",
      "qualificationResult": "none",
      "state": "new",
      "quantity": "2",
      "@type": "ServiceQualificationItem",
      "service": {
        "@type": "Service",
        "serviceCharacteristic": [
          {
            "name": "Speed",
            "valueType": "choice",
            "value": "High"
          }
        ],
        "serviceSpecification": {
          "id": "b3933d9d45f31150f877e0588eca21fc",
          "name": "Access Service",
          "version": "",
          "internalVersion": "1",
          "internalId": "b3933d9d45f31150f877e0588eca21fc",
          "@type": "ServiceSpecification"
        },
        "place": {
          "id": "5671dd2ec3a53010188473ce3640dd81",
          "name": "3000 Main Street, Santa Clara, CA",
          "@referredType": "GeographicSite"
        }
      }
    }
  ],
  "effectiveQualificationDate": "2023-12-14T23:44:44.000Z",
  "expectedQualificationDate": "2023-10-11T15:20:39.000Z"
}

テクニカルサービス認定オープン API - POST sn_ord_qual_mgmt/qualification/checkServiceQualification/processResult

テクニカルサービス認定オープン API に送信されたテクニカルサービス認定結果を処理します。

URL 形式

バージョニングされた URL:/ api/sn_ord_qual_mgmt/qualification/checkServiceQualification/processResult

サポートされている要求パラメーター

表 : 20. パスパラメーター
名前	説明
api_version	オプションアクセスするエンドポイントのバージョン。たとえば、`v1` や `v2`。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。データタイプ：文字列

表 : 21. クエリパラメーター
名前	説明
なし

表 : 22. 要求本文パラメーター (XML または JSON)
パラメーター	説明
serviceQualificationItem	必須です。要求された上位注文品目のサービス注文テーブル [sn_ind_tmt_orm_service_order] 内のドメイン注文をそれぞれ表すサービス認定アイテムのリスト。各サービス認定品目によって表されるすべてのドメイン注文は、同じ最上位注文品目に属している必要があります。データタイプ：オブジェクトのアレイアレイの例: "serviceQualificationItem": [ { "qualificationResult": "alternate", "alternateServiceProposal": [ { "alternateServiceAvailabilityDate": "2022-12-15T19:20:39.239Z", "@type": "AlternateServiceProposal", "id": "1", "alternateService": { "@type": "Service", "serviceSpecification": { "@type": "ServiceSpecification", "name": "Mobile Service", "id": "23", "href": "string" }, "serviceCharacteristic": [ { "@type": "ServiceCharacteristic", "valueType": "string", "name": "BroadcastQuality", "id": "1", "value": "HD" } ] } } ], "@type": "ServiceQualificationItem", "id": "295580b938bf1110f877c8d44c4b8912" } ]
serviceQualificationItem.qualificationResult	必須です。ドメイン注文テーブル [sn_ind_tmt_orm_service_order] の結果フィールドに保持される各サービス認定アイテムの認定結果。データタイプ：文字列
serviceQualificationItem.id	必須です。認定アイテムによって表されるドメイン注文のSys_id。ドメインオーダー [sn_ind_tmt_orm_service_order] のSys_idフィールドに保存されます。データタイプ：文字列
serviceQualificationItem.alternateProposal	オプション。認定項目に提供される代替提案。代替提案テーブル [sn_ord_qual_mgmt_alternate_proposal] に保存されます。データタイプ：オブジェクトのアレイ `"alternateServiceProposal": [ { "alternateServiceAvailabilityDate": "2022-12-15T19:20:39.239Z", "@type": "AlternateServiceProposal", "id": "1", "alternateService": { "@type": "Service", "serviceSpecification": { "@type": "ServiceSpecification", "name": "Mobile Service", "id": "23", "href": "string" }, "serviceCharacteristic": [ { "@type": "ServiceCharacteristic", "valueType": "string", "name": "BroadcastQuality", "id": "1", "value": "HD" } ] } } ]`
serviceQualificationItem.alternateProposal.alternateServiceAvailabilityDate	オプション。現在のサービス認定アイテムによって表されるドメイン注文にドメイン注文情報が属する代替提案テーブル [sn_ord_qual_mgmt_alternate_proposal] の [available_date] フィールドに保存されている代替サービス可用性日付。形式:YYYY-MM-DDTHH:MM:SS。ティッカーデータタイプ：文字列
serviceQualificationItem.alternateProposal.@type	オプション。TMF オープン API 標準の一部。認定アイテムのサービス情報の注釈。この値は常に Service です。この情報は保存されません。データタイプ：文字列
serviceQualificationItem.alternateProposal.id	オプション。代替プロポーザルのユーザー定義 ID。このデータは保持されません。データタイプ：文字列
serviceQualificationItem.alternateProposal.alternateService	必須です。サービス仕様と特性を含む代替提案のサービス情報。データタイプ: オブジェクト `"alternateService": { "@type": "Service", "serviceSpecification": { "@type": "ServiceSpecification", "name": "Mobile Service", "id": "23", "href": "string" }, "serviceCharacteristic": [ { "@type": "ServiceCharacteristic", "valueType": "string", "name": "BroadcastQuality", "id": "1", "value": "HD" } ] }`
serviceQualificationItem.alternateProposal.alternateService .serviceSpecification	必須です。代替提案のサービス仕様。代替提案エントリの [仕様] フィールドに保存されます。データタイプ:オブジェクト `"serviceSpecification": { "id": "91478553b7969910ff00f203ae11a97d", "name": "Broadband Service", “@type”: ”ServiceSpecification” }`
serviceQualificationItem.alternateProposal.alternateService.serviceSpecification.id	必須です。外部 ID またはサービス仕様の初期バージョン。データタイプ：文字列
serviceQualificationItem.alternateProposal.alternateService.serviceSpecification.name	オプション。サービス仕様の名前。データタイプ：文字列
serviceQualificationItem.alternateProposal.alternateService.serviceSpecification.version	オプション。外部サービス仕様のバージョン。データタイプ：文字列
serviceQualificationItem.alternateProposal.alternateService.serviceSpecification.internalVersion	オプション。サービス仕様の内部バージョン。データタイプ：文字列
serviceQualificationItem.alternateProposal.alternateService .serviceSpecification.@type	オプション。TMF オープン API 標準の一部。サービス仕様の注釈。この値は常に ServiceSpecification です。この情報は保存されません。データタイプ：文字列
serviceQualificationItem.alternateProposal.alternateService .serviceCharacteristic	代替サービス提案のサービス特性のアレイ。代替提案テーブル [sn_ord_qual_mgmt_alternate_proposal] の「order_characteristics」フィールドに文字列として格納されます。データタイプ:オブジェクト `"serviceCharacteristic": [ { "valueType": "string", "name": "Speed", "value": "High" } ]`
serviceQualificationItem.alternateProposal.alternateService.service.serviceCharacteristic.valueType	オプション。代替サービス提案における特性の値タイプ。データタイプ：文字列
serviceQualificationItem.alternateProposal.alternateService.serviceCharacteristic.name	必須です。代替サービス提案に属する特性の名称。データタイプ：文字列
serviceQualificationItem.alternateProposal.alternateService.serviceCharacteristic.value	オプション。代替サービス提案に属する特性の値。データタイプ：文字列
serviceQualificationItem.eligibilityUnunavailableReason	オプション。適格性利用不可サービス認定の理由。指定された eligibilityUnavailabilityReason のリスト全体は、ドメイン注文テーブルの「unavailability_reason」フィールドに文字列としてラベルフィールドとともに保持されます。データタイプ:オブジェクト `"eligibilityUnavailabilityReason": [ { "code": "26-001", "label": "not enough bandwith at this place" } ]`
serviceQualificationItem.eligibilityUnavailabilityReason.code	オプション。適格利用不可の理由コード。この情報は保持されません。データタイプ：文字列
serviceQualificationItem.eligibilityUnavailabilityReason.label	必須です。適格性利用不可の理由ラベル。不適格な理由が複数ある場合、ラベルは「,」で区切られ、ドメイン注文 [sn_ind_tmt_orm_domain_order] テーブルの「unavailability_reason」フィールドに保存されます。データタイプ：文字列
serviceQualificationItem.@type	オプション。TMF オープン API 標準の一部。認定アイテムの注釈。この値は常に ServiceQualificationItem です。この情報は保存されません。データタイプ：文字列

ヘッダー

表 : 23. 要求ヘッダー
ヘッダー	説明
承認	応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。デフォルト： application/json

表 : 24. 応答ヘッダー
ヘッダー	説明
なし

ステータスコード

表 : 25. ステータスコード
ステータスコード	説明
201	要求が正常に処理されました。
400	要求が正しくありません。以下のいずれかの理由が考えられます。無効なペイロード:認定結果は、[代替、保留中、認定済み、認定なし] のいずれかである必要があります。無効なペイロード:認定アイテム ID が存在しません。すべての認定品目は、同じ上位注文品目に属している必要があります。無効なペイロード:serviceQualificationItem qualificationResult がありません。無効なペイロード:コンシューマーが存在しません。

応答本文のパラメーター (JSON または XML)


名前	説明
ID	認定顧客注文のSys_id。データタイプ：文字列
href	認定オーダーレコードへの相対リンク。データタイプ：文字列
description	顧客注文のshort_descriptionフィールドからフェッチされる認定要求の説明。データタイプ：文字列
externalId	顧客注文の [external_id] フィールドの外部 ID。データタイプ：文字列
qualificationResult	顧客注文の結果フィールドの検定ステータス。可能な値：代替保留中なし認定済み無条件データタイプ：文字列
ステータス	顧客注文のステータスフィールドからの顧客注文のステータス。データタイプ：文字列
@type	TMF オープン API 標準の一部。認定の注釈。この値は常に CheckServiceQualification です。この情報は保存されません。データタイプ：文字列
checkServiceQualificationDate	顧客注文の [order_date] フィールドから作成された認定要求の日時。形式:YYYY-MM-DDTHH:MM:SS。ティッカーデータタイプ：文字列
有効な資格認定日	顧客注文の [order_date] フィールドからフェッチされた有効な認定日。形式:YYYY-MM-DDTHH:MM:SS。ティッカーデータタイプ：文字列
expectedQualificationDate	予定されている認定日を保存します。顧客注文expected_end_dateフィールドに保持されます。形式:YYYY-MM-DDTHH:MM:SS。ティッカーデータタイプ：文字列
relatedParty	認定要求の連絡先のリスト。各連絡先はアレイ内のオブジェクトです。データタイプ：オブジェクトのアレイ `"relatedParty": [ { "id": "String", "name": "String", "@type": "String", "@referredType": "String" } ]`
relatedParty.id	注文に関連付けられたアカウント、お客様の連絡先、またはコンシューマーのSys_idまたはexternal_id。アカウント [customer_account] テーブル、連絡先 [customer_contact] テーブル、またはコンシューマー [csm_consumer] テーブルにあります。データタイプ：文字列
relatedParty.name	アカウント、顧客、またはコンシューマーの名前。データタイプ：文字列
relatedParty.@type	TMF オープン API 標準の一部。オーダー品目に関する連絡先の注釈。この値は常に RelatedParty です。この情報は保存されません。データタイプ：文字列
relatedParty.@referredType	関連するパーティのタイプ。可能な値： Customer CustomerContact コンシューマーデータタイプ：文字列
serviceQualificationItem	場所、サービス情報、およびサービス特性に関する情報を含むサービス認定アイテムのリスト。顧客注文の注文品目として保存されます。データタイプ：オブジェクトのアレイ `"serviceQualificationItem": [ { "id": "string", "action": "string", "expectedServiceAvailabilityDate": "number", "service": { "place": [ { "id": "string", "name": "string" } ], "serviceCharacteristic": [ { "valueType": "string", "name": "string", "value": "string" } ], "serviceSpecification": { "id": "string", "name": "string" } }, "@type": "ServiceQualificationItem" } ],`
serviceQualificationItem.id	認定アイテムの ID。顧客注文品目の [external_id] フィールドに保存されます。データタイプ：文字列
serviceQualificationItem.qualificationResult	認定項目の結果。顧客の注文品目の [結果] フィールドに保存されます。可能な値：代替なし保留中認定済み無条件データタイプ：文字列
serviceQualificationItem.state	顧客の注文品目の [status] フィールドから導出された認定品目のステータス。データタイプ：文字列
serviceQualificationItem.quantity	顧客の注文品目の [数量] フィールドから導出された認定品目の数量。データタイプ：数値
serviceQualificationItem.@type	TMF オープン API 標準の一部。認定アイテムの注釈。この値は常に ServiceQualificationItem です。この情報は保存されません。データタイプ：文字列
serviceQualificationItem.service	場所 (場所)、サービス仕様、およびサービス特性に関する詳細を含むサービス情報。データタイプ: オブジェクト `"service": { "place": [ { "id": "String", "name": "String" } ], "serviceCharacteristic": [ { "valueType": "String", "name": "String", "value": "String" } ], "serviceSpecification": { "id": "String", "name": "String" } }`
serviceQualificationItem.service.@type	TMF Open API 標準の一部。サービスの注釈。この値は常に Service です。この情報は保存されません。データタイプ：文字列
serviceQualificationItem.service.place	サービス認定アイテムの場所情報。データタイプ:オブジェクトのアレイ。注: この配列には、1 つの場所のみを含めることができます。 `"place": [ { "id": "5671dd2ec3a53010188473ce3640dd81", "name": "Jean Pontus home", "@referredType": "GeographicSite" } ]`
serviceQualificationItem.service.place.id	場所 [cmn_location] テーブル内の場所Sys_id。データタイプ：文字列
serviceQualificationItem.service.place.name	場所の名前。場所 [cmn_location] テーブルのエントリに対して検証されていません。データタイプ：文字列
serviceQualificationItem.service.place.@type	TMF オープン API 標準の一部。サービスの注釈。この値は常に GeographicSite です。この情報は保存されません。データタイプ：文字列
serviceQualificationItem.service.serviceSpecification	認定アイテムのサービス仕様の詳細。データタイプ:オブジェクトのアレイ。 `"serviceSpecification": { "id": "String", "internalVersion": "Number", "internalId": "String", "name": "String" "@type": "ServiceSpecification" "version": "String", }`
serviceQualificationItem.service.serviceSpecification.id	外部 ID またはサービス仕様の初期バージョン。データタイプ：文字列
serviceQualificationItem.service.serviceSpecification.name	サービス仕様の名前。データタイプ：文字列
serviceQualificationItem.service.serviceSpecification.version	サービス仕様の外部バージョン。データタイプ：文字列
serviceQualificationItem.service.serviceSpecification.internalVersion	サービス仕様の内部バージョン。データタイプ：数値
serviceQualificationItem.service.serviceSpecification.internalId	サービス仕様の初期バージョン。データタイプ：文字列
serviceQualificationItem.service.serviceSpecification.@type	TMF オープン API 標準の一部。サービス仕様の注釈。この値は常に ServiceSpecification です。この情報は保存されません。データタイプ：文字列
serviceQualificationItem.service.serviceCharacteristic	サービス特性のリスト。データタイプ：オブジェクトのアレイ `"serviceCharacteristic": [ { "name": "Speed", "value": "High" "valueType": "string", } ]`
serviceQualificationItem.service.serviceCharacteristic.valueType	特性の値タイプ。データタイプ：文字列
serviceQualificationItem.service.serviceCharacteristic.name	特性の名前。データタイプ：文字列
serviceQualificationItem.service.serviceCharacteristic.value	特性の値。データタイプ：文字列
ServiceQualificationItem.alternateServiceProposal	認定オーダーの代替サービス提案。代替提案は代替提案 [sn_ord_qual_mgmt_alternate_proposal] テーブルに保存されます。データタイプ：文字列
ServiceQualificationItem.alternateServiceProposal.id	代替提案 [sn_ord_qual_mgmt_alternate_proposal] テーブルの代替提案エントリのSys_id。データタイプ：文字列
ServiceQualificationItem.alternateServiceProposal.alternateServiceAvailabilityDate	代替提案 [sn_ord_qual_mgmt_alternate_proposal] テーブルの代替提案エントリのavailable_dateフィールド値。データタイプ：文字列
serviceQualificationItem.alternateServiceProposal.alternateService	代替提案によって表されるサービス情報。データタイプ: オブジェクト
serviceQualificationItem.alternateServiceProposal.alternateService.serviceSpecification	代替提案のサービス仕様は、代替提案 [sn_ord_qual_mgmt_alternate_proposal] テーブルの仕様に保持されます。データタイプ: オブジェクト
serviceQualificationItemalternateServiceProposal.alternateService.serviceSpecification.id	外部 ID または代替サービス仕様の初期バージョン。データタイプ：文字列
serviceQualificationItemalternateServiceProposal.alternateService.serviceSpecification.name	代替サービス仕様の名前。データタイプ：文字列
serviceQualificationItemalternateServiceProposal.alternateService.serviceSpecification.version	代替サービス仕様の外部バージョン。データタイプ：文字列
serviceQualificationItemalternateServiceProposal.alternateService.serviceSpecification.internalVersion	代替サービス仕様の内部バージョン。データタイプ：数値
serviceQualificationItemalternateServiceProposal.alternateService.serviceSpecification.internalId	代替サービス仕様の初期バージョン。データタイプ：文字列
ServiceQualificationItemalternateServiceProposal.alternateService.serviceSpecification.@type	TMF オープン API 標準の一部。サービス仕様の注釈。この値は常に ServiceSpecification です。この情報は保存されません。データタイプ：文字列
serviceQualificationItemalternateServiceProposal.alternateService.serviceCharacteristic	代替サービス提案のサービス特性のアレイ。データタイプ：オブジェクトのアレイ `"serviceCharacteristic": [ { "valueType": "String", "name": "String", "value": "String" } ]`
serviceQualificationItemalternateServiceProposal.alternateService.serviceCharacteristic.valueType	代替サービス特性の値タイプ。データタイプ：文字列
serviceQualificationItemalternateServiceProposal.alternateService.serviceCharacteristic.name	代替サービス特性の名前。データタイプ：文字列
serviceQualificationItemalternateServiceProposal.alternateService.serviceCharacteristic.value	代替サービス特性の値。データタイプ：文字列
serviceQualificationItem.eligibilityUnunavailableReason	サービスを利用できない理由を説明する、サービス適格性を使用できない理由のリスト。この値は、ドメインオーダー [sn_ind_tmt_orm_domain_order] テーブルの「unavailability_reason」に保存されます。データタイプ：アレイ
serviceQualificationItem.eligibilityUnavailabilityReason.code	サービス適格性使用不可の理由コード。データタイプ：文字列
serviceQualificationItem.eligibilityUnavailabilityReason.label	サービス適格性を使用不可の理由ラベル。データタイプ：文字列

サンプル cURL 要求

次の例は、API 要求で送信された認定オーダーをエンドポイントで処理する方法を示しています。

curl -X POST "https://instance.service-now.com/api/sn_ord_qual_mgmt/qualification/checkServiceQualification/processResult " \ 
-H "Accept: application/json" \ 
-H "Content-Type: application/json" \ 
-u "username":"password" \ 
-d {
  "serviceQualificationItem": [
    {
      "eligibilityUnavailabilityReason": [
        {
          "code": "26-001",
          "label": "not enough bandwith at this place"
        }
      ],
      "qualificationResult": "alternate",
      "alternateServiceProposal": [
        {
          "alternateServiceAvailabilityDate": "2022-12-15T19:20:39.239Z",
          "@type": "AlternateServiceProposal",
          "id": "1",
          "alternateService": {
            "@type": "Service",
            "serviceSpecification": {
              "@type": "ServiceSpecification",
              "name": "Mobile Service",
              "id": "23",
              "href": "string"
            },
            "serviceCharacteristic": [
              {
                "@type": "ServiceCharacteristic",
                "valueType": "string",
                "name": "BroadcastQuality",
                "id": "1",
                "value": "HD"
              }
            ]
          }
        }
      ],
      "@type": "ServiceQualificationItem",
      "id": "295580b938bf1110f877c8d44c4b8912"
    },
    {
      "qualificationResult": "alternate",
      "alternateServiceProposal": [
        {
          "alternateServiceAvailabilityDate": "2022-12-15T19:20:39.239Z",
          "@type": "AlternateServiceProposal",
          "id": "1",
          "alternateService": {
            "@type": "Service",
            "serviceSpecification": {
              "@type": "ServiceSpecification",
              "name": "Mobile Service",
              "id": "23",
              "href": "string"
            },
            "serviceCharacteristic": [
              {
                "@type": "ServiceCharacteristic",
                "valueType": "string",
                "name": "BroadcastQuality",
                "id": "1",
                "value": "HD"
              }
            ]
          }
        }
      ],
      "@type": "ServiceQualificationItem",
      "action": "add",
      "id": "295580b938bf1110f877c8d44c4b8915"
    },
    {
      "qualificationResult": "alternate",
      "alternateServiceProposal": [
        {
          "alternateServiceAvailabilityDate": "2022-12-15T19:20:39.239Z",
          "@type": "AlternateServiceProposal",
          "id": "1",
          "alternateService": {
            "@type": "Service",
            "serviceSpecification": {
              "@type": "ServiceSpecification",
              "name": "Mobile Service",
              "id": "23",
              "href": "string"
            },
            "serviceCharacteristic": [
              {
                "@type": "ServiceCharacteristic",
                "valueType": "string",
                "name": "BroadcastQuality",
                "id": "1",
                "value": "HD"
              }
            ]
          }
        }
      ],
      "@type": "ServiceQualificationItem",
      "id": "2d5580b938bf1110f877c8d44c4b8902"
    }
  ],
  "@type": "CheckServiceQualification",
  "description": "check service qualification illustration"
}

応答本文：

{
  "id": "0b45c47938bf1110f877c8d44c4b895d",
  "href": "/api/sn_ord_qual_mgmt/qualification/checkServiceQualification/0b45c47938bf1110f877c8d44c4b895d",
  "description": "check service qualification illustration",
  "externalId": "CSQ1",
  "qualificationResult": "alternate",
  "state": "new",
  "@type": "CheckServiceQualification",
  "checkServiceQualificationDate": "2022-12-14T23:44:44.000Z",
  "relatedParty": [
    {
      "id": "eaf68911c35420105252716b7d40ddde",
      "name": "Sally Thomas",
      "@type": "RelatedParty",
      "@referredType": "CustomerContact"
    },
    {
      "id": "ffc68911c35420105252716b7d40dd55",
      "name": "Funco Intl",
      "@type": "RelatedParty",
      "@referredType": "Customer"
    },
    {
      "id": "59f16de1c3b67110ff00ed23a140dd9e",
      "name": "Funco External",
      "@type": "RelatedParty",
      "@referredType": "Consumer"
    }
  ],
  "serviceQualificationItem": [
    {
      "id": "100",
      "qualificationResult": "alternate",
      "state": "in_progress",
      "quantity": "1",
      "@type": "ServiceQualificationItem",
      "service": {
        "@type": "Service",
        "serviceCharacteristic": [
          {
            "name": "Speed",
            "valueType": "choice",
            "value": "High"
          }
        ],
        "serviceSpecification": {
          "id": "91478553b7969910ff00f203ae11a97d",
          "name": "Broadband Service",
          "version": "",
          "internalVersion": "1",
          "internalId": "91478553b7969910ff00f203ae11a97d",
          "@type": "ServiceSpecification"
        },
        "place": {
          "id": "5671dd2ec3a53010188473ce3640dd81",
          "name": "3000 Main Street, Santa Clara, CA",
          "@referredType": "GeographicSite"
        }
      },
      "alternateServiceProposal": [
        {
          "id": "350e66a2e5331110f87741b459ef19b0",
          "alternateServiceAvailabilityDate": "2022-12-15 19:20:39",
          "alternateService": {
            "serviceCharacteristic": [
              {
                "@type": "ServiceCharacteristic",
                "valueType": "string",
                "name": "BroadcastQuality",
                "id": "1",
                "value": "HD"
              }
            ],
            "serviceSpecification": {
              "id": "23e7ed67c32310105252716b7d40dd80",
              "name": "Mobile Service",
              "version": "",
              "internalVersion": "1",
              "internalId": "23e7ed67c32310105252716b7d40dd80",
              "@type": "ServiceSpecification"
            },
            "@type": "Service"
          },
          "@type": "AlternateServiceProposal"
        }
      ],
      "eligibilityUnavailabilityReason": [
        {
          "label": "not enough bandwith at this place",
          "@type": "string"
        }
      ]
    }
  ],
  "effectiveQualificationDate": "2023-12-14T23:44:44.000Z",
  "expectedQualificationDate": "2023-10-11T15:20:39.000Z"
}