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

  • リリースバージョン: Australia
  • 更新日 2026年03月12日
  • 所要時間:131分
  • テクニカルサービス認定オープン API は、フルフィルメントのために注文を送信する前に、リソースとサービスの可用性を確認するためのエンドポイントを提供します。

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

    クニカルサービス認定オープン API は sn_ord_qual_mgmt 名前空間内で提供され、次のプラグインが必要です。
    • 製品カタログ管理コア [com.sn_prd_pm]
    • 製品カタログ Advanced [com.sn_prd_pm_adv]
    • 注文認定管理 [com.sn_ord_qual_mgmt]
    • 通信事業、メディア、テクノロジー向け注文管理 [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. パスパラメーター
    名前 説明
    ID 取得する認定顧客注文のSys_id。

    データタイプ:文字列

    テーブル:顧客注文 [sn_ind_tmt_orm_order]

    表 : 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 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。
    404 見つかりません。要求されたアイテムが見つかりませんでした。

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

    名前 説明
    ID 認定顧客注文のSys_id。

    データタイプ:文字列

    テーブル:顧客注文 [sn_ind_tmt_orm_order]

    href 認定オーダーレコードへの相対リンク。

    データタイプ:文字列

    description 顧客注文の [short_description] フィールドからフェッチされる認定要求の説明。

    データタイプ:文字列

    テーブル:顧客注文 [sn_ind_tmt_orm_order]

    externalId 顧客注文の外部 ID。

    データタイプ:文字列

    テーブル:顧客注文 [sn_ind_tmt_orm_order] テーブルのexternal_idフィールド内。

    認定結果 顧客注文の結果フィールドの認定ステータス。
    可能な値:
    • 代替
    • なし
    • 保留中
    • 認定済み
    • 資格認定なし

    データタイプ:文字列

    状況 顧客注文のステータスフィールドからの顧客注文のステータス。

    データタイプ:文字列

    @type TMF Open API 標準の一部です。検定の注釈。この値は常に CheckServiceQualification です。この情報は保存されません。

    データタイプ:文字列

    checkServiceQualificationDate 顧客注文のorder_dateフィールドから作成された認定要求の日時。

    データタイプ:文字列

    形式:YYYY-MM-DDTHH:MM:SS。SSSZ

    テーブル:顧客注文 [sn_ind_tmt_orm_order]

    有効な認定日 顧客注文の [order_date] フィールドから取得された有効な認定日。

    データタイプ:文字列

    形式:YYYY-MM-DDTHH:MM:SS。SSSZ

    テーブル:顧客注文 [sn_ind_tmt_orm_order]

    expectedQualificationDate 予定されている認定日を保存します。顧客注文のexpected_end_dateフィールドに保持されます。

    データタイプ:文字列

    形式:YYYY-MM-DDTHH:MM:SS。SSSZ

    テーブル:顧客注文 [sn_ind_tmt_orm_order]

    関連パーティー 認定要求の連絡先のリスト。各連絡先はアレイ内のオブジェクトです。

    データタイプ:オブジェクトのアレイ

    "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 Open API 標準の一部です。注文明細品目の連絡先の注釈。この値は常に RelatedParty です。この情報は保存されません。

    データタイプ:文字列

    relatedParty.@referredType 関係者のタイプ。
    可能な値:
    • コンシューマー
    • 顧客
    • 顧客連絡先

    データタイプ:文字列

    サービス認定アイテム 場所、サービス情報、およびサービス特性に関する情報を含むサービス認定アイテムのリスト。顧客注文の注文明細品目として保存されます。

    データタイプ:オブジェクトのアレイ

    "serviceQualificationItem": [
      {
        "id": "String",
        "action": "String",
        "expectedServiceAvailabilityDate": "Number",
        "service": {Object},
        "@type": "String"
      }
    ]
    serviceQualificationItem.id 認定アイテムの ID。

    データタイプ:文字列

    保存場所:注文明細品目 [sn_ind_tmt_orm_order_line_item] テーブルの顧客注文明細品目のexternal_idフィールド。

    serviceQualificationItem.qualificationResult 認定アイテムの結果。顧客の注文明細品目の [結果] フィールドに保存されます。

    可能な値:

    • 代替
    • なし
    • 保留中
    • 認定済み
    • 資格認定なし

    データタイプ:文字列

    テーブル:注文明細品目 [sn_ind_tmt_orm_order_line_item]

    serviceQualificationItem.state 顧客の注文明細品目の [ステータス] フィールドから導出された認定アイテムのステータス。

    データタイプ:文字列

    テーブル:注文明細品目 [sn_ind_tmt_orm_order_line_item]

    serviceQualificationItem.quantity 顧客の注文明細品目の [数量] フィールドから導出された認定品目の数量。

    データタイプ:数値

    テーブル:注文明細品目 [sn_ind_tmt_orm_order_line_item]

    serviceQualificationItem.@type TMF Open API 標準の一部です。認定アイテムの注釈。この値は常に ServiceQualificationItem です。この情報は保存されません。

    データタイプ:文字列

    serviceQualificationItem.service 場所 (場所)、サービス仕様、サービス特性に関する詳細を含むサービス情報。

    データタイプ: オブジェクト

    "service": {
      "@type": "String",
      "place": [Array],
      "serviceCharacteristic": [Array],
      "serviceSpecification": {Object}
    }
    serviceQualificationItem.service.@type TMF Open API 標準の一部です。サービスの注釈。この値は常に サービスです。この情報は保存されません。

    データタイプ:文字列

    serviceQualificationItem.service.place サービス認定アイテムの場所情報。

    データタイプ:オブジェクトのアレイ

    注:
    このアレイには 1 つの場所のみを含めることができます。
    "place": [
      {
        "id": "String",
        "name": "String",
        "@referredType": "String"
      }
    ]

    serviceQualificationItem.service.place.id

    場所のSys_id。

    データタイプ:文字列

    テーブル:場所 [cmn_location]

    serviceQualificationItem.service.place.name 場所の名前。場所 [cmn_location] テーブルのエントリに対して検証されていません。

    データタイプ:文字列

    serviceQualificationItem.service.place.@type TMF Open 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 Open API 標準の一部です。サービス仕様の注釈。この値は常に ServiceSpecification です。この情報は保存されません。

    データタイプ:文字列

    serviceQualificationItem.service.serviceCharacteristic サービス特性のリスト。

    データタイプ:オブジェクトのアレイ

    "serviceCharacteristic": [
      {
        "name": "String",
        "value": "String",
        "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 代替案レコードのSys_id。

    データタイプ:文字列

    テーブル:代替案 [sn_ord_qual_mgmt_alternate_proposal]

    ServiceQualificationItem.alternateServiceProposal.alternateServiceAvailabilityDate 代替提案 [sn_ord_qual_mgmt_alternate_proposal] テーブルの代替提案エントリのavailable_dateフィールド値。

    データタイプ:文字列

    serviceQualificationItem.alternateServiceProposal.alternateService 代替案で表されるサービス情報。

    データタイプ: オブジェクト

    serviceQualificationItem.alternateServiceProposal.alternateService.serviceSpecification 仕様に保持される代替案のサービス仕様。

    データタイプ: オブジェクト

    テーブル:代替案 [sn_ord_qual_mgmt_alternate_proposal]

    serviceQualificationItem です。alternateServiceProposal.alternateService.serviceSpecification.id 代替サービス仕様の外部 ID または初期バージョン。

    データタイプ:文字列

    serviceQualificationItem です。alternateServiceProposal.alternateService.serviceSpecification.name 代替サービス仕様の名前。

    データタイプ:文字列

    serviceQualificationItem です。alternateServiceProposal.alternateService.serviceSpecification.version 代替サービス仕様の外部バージョン。

    データタイプ:文字列

    serviceQualificationItem です。alternateServiceProposal.alternateService.serviceSpecification.internalVersion 代替サービス仕様の内部バージョン。

    データタイプ:数値

    serviceQualificationItem です。alternateServiceProposal.alternateService.serviceSpecification.internalId 代替サービス仕様の初期バージョン。

    データタイプ:文字列

    ServiceQualificationItem。alternateServiceProposal.alternateService.serviceSpecification.@type TMF Open API 標準の一部です。サービス仕様の注釈。この値は常に ServiceSpecification です。この情報は保存されません。

    データタイプ:文字列

    serviceQualificationItem です。alternateServiceProposal.alternateService.serviceCharacteristic 代替サービス提案のサービス特性のリスト。

    データタイプ:オブジェクトのアレイ

    "serviceCharacteristic": [
      {
        "name": "String",
        "value": "String",
        "valueType": "String"
      }
    ]
    serviceQualificationItem です。alternateServiceProposal.alternateService.serviceCharacteristic.valueType 代替サービス特性の値のタイプ。

    データタイプ:文字列

    serviceQualificationItem です。alternateServiceProposal.alternateService.serviceCharacteristic.name 代替サービス特性の名前。

    データタイプ:文字列

    serviceQualificationItem です。alternateServiceProposal.alternateService.serviceCharacteristic.value 代替サービス特性の値。

    データタイプ:文字列

    serviceQualificationItem.eligibilityUnavailabilityReason サービスを利用できない理由を説明する、サービスの適格性、利用不可理由のリスト。

    データタイプ:アレイ

    格納場所:ドメイン注文 [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. パスパラメーター
    名前 説明
    なし
    表 : 8. クエリ パラメーター
    パラメーター 説明
    description 顧客注文の [short_description] フィールドで認定注文をフィルタリングします。簡単な説明がこのパラメーターの値と一致gの注文のみが応答に返されます。

    データタイプ:文字列

    フィールド 応答で返すフィールド名のリスト。無効なフィールドは無視されます。このパラメーターが要求で指定されていない場合は、すべてのフィールドが返されます。

    データタイプ:文字列、カンマ区切り

    limit 返されるレコードの最大数。このレコード数を超える要求の場合は、offset パラメーター を使用して レコード取得をページネーションします。

    デフォルト値:20

    最大:100

    データタイプ:数値

    認定結果 認定オーダーを結果でフィルタリングします。このパラメーターの値と一致する結果を持つ注文のみが応答に返されます。

    データタイプ:文字列

    状況 認定オーダーをステータスでフィルタリングします。このパラメーターの値と一致するステータスの注文のみ 応答に返されます。

    データタイプ:文字列

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

    ヘッダー

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

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

    デフォルト: application/json

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

    ステータスコード

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

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

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

    名前 説明
    ID 認定顧客注文のSys_id。

    データタイプ:文字列

    テーブル:顧客注文 [sn_ind_tmt_orm_order]

    href 認定オーダーレコードへの相対リンク。

    データタイプ:文字列

    description 顧客注文の [short_description] フィールドからフェッチされる認定要求の説明。

    データタイプ:文字列

    テーブル:顧客注文 [sn_ind_tmt_orm_order]

    externalId 顧客注文の外部 ID。

    データタイプ:文字列

    テーブル:顧客注文 [sn_ind_tmt_orm_order] テーブルのexternal_idフィールド内。

    認定結果 顧客注文の結果フィールドの認定ステータス。
    可能な値:
    • 代替
    • なし
    • 保留中
    • 認定済み
    • 資格認定なし

    データタイプ:文字列

    状況 顧客注文のステータスフィールドからの顧客注文のステータス。

    データタイプ:文字列

    @type TMF Open API 標準の一部です。検定の注釈。この値は常に CheckServiceQualification です。この情報は保存されません。

    データタイプ:文字列

    checkServiceQualificationDate 顧客注文のorder_dateフィールドから作成された認定要求の日時。

    データタイプ:文字列

    形式:YYYY-MM-DDTHH:MM:SS。SSSZ

    テーブル:顧客注文 [sn_ind_tmt_orm_order]

    有効な認定日 顧客注文の [order_date] フィールドから取得された有効な認定日。

    データタイプ:文字列

    形式:YYYY-MM-DDTHH:MM:SS。SSSZ

    テーブル:顧客注文 [sn_ind_tmt_orm_order]

    expectedQualificationDate 予定されている認定日を保存します。顧客注文のexpected_end_dateフィールドに保持されます。

    データタイプ:文字列

    形式:YYYY-MM-DDTHH:MM:SS。SSSZ

    テーブル:顧客注文 [sn_ind_tmt_orm_order]

    関連パーティー 認定要求の連絡先のリスト。各連絡先はアレイ内のオブジェクトです。

    データタイプ:オブジェクトのアレイ

    "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 Open API 標準の一部です。注文明細品目の連絡先の注釈。この値は常に RelatedParty です。この情報は保存されません。

    データタイプ:文字列

    relatedParty.@referredType 関係者のタイプ。
    可能な値:
    • コンシューマー
    • 顧客
    • 顧客連絡先

    データタイプ:文字列

    サービス認定アイテム 場所、サービス情報、およびサービス特性に関する情報を含むサービス認定アイテムのリスト。顧客注文の注文明細品目として保存されます。

    データタイプ:オブジェクトのアレイ

    "serviceQualificationItem": [
      {
        "id": "String",
        "action": "String",
        "expectedServiceAvailabilityDate": "Number",
        "service": {Object},
        "@type": "String"
      }
    ]
    serviceQualificationItem.id 認定アイテムの ID。

    データタイプ:文字列

    保存場所:注文明細品目 [sn_ind_tmt_orm_order_line_item] テーブルの顧客注文明細品目のexternal_idフィールド。

    serviceQualificationItem.qualificationResult 認定アイテムの結果。顧客の注文明細品目の [結果] フィールドに保存されます。

    可能な値:

    • 代替
    • なし
    • 保留中
    • 認定済み
    • 資格認定なし

    データタイプ:文字列

    テーブル:注文明細品目 [sn_ind_tmt_orm_order_line_item]

    serviceQualificationItem.state 顧客の注文明細品目の [ステータス] フィールドから導出された認定アイテムのステータス。

    データタイプ:文字列

    テーブル:注文明細品目 [sn_ind_tmt_orm_order_line_item]

    serviceQualificationItem.quantity 顧客の注文明細品目の [数量] フィールドから導出された認定品目の数量。

    データタイプ:数値

    テーブル:注文明細品目 [sn_ind_tmt_orm_order_line_item]

    serviceQualificationItem.@type TMF Open API 標準の一部です。認定アイテムの注釈。この値は常に ServiceQualificationItem です。この情報は保存されません。

    データタイプ:文字列

    serviceQualificationItem.service 場所 (場所)、サービス仕様、サービス特性に関する詳細を含むサービス情報。

    データタイプ: オブジェクト

    "service": {
      "@type": "String",
      "place": [Array],
      "serviceCharacteristic": [Array],
      "serviceSpecification": {Object}
    }
    serviceQualificationItem.service.@type TMF Open API 標準の一部です。サービスの注釈。この値は常に サービスです。この情報は保存されません。

    データタイプ:文字列

    serviceQualificationItem.service.place サービス認定アイテムの場所情報。

    データタイプ:オブジェクトのアレイ

    注:
    このアレイには 1 つの場所のみを含めることができます。
    "place": [
      {
        "id": "String",
        "name": "String",
        "@referredType": "String"
      }
    ]

    serviceQualificationItem.service.place.id

    場所のSys_id。

    データタイプ:文字列

    テーブル:場所 [cmn_location]

    serviceQualificationItem.service.place.name 場所の名前。場所 [cmn_location] テーブルのエントリに対して検証されていません。

    データタイプ:文字列

    serviceQualificationItem.service.place.@type TMF Open 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 Open API 標準の一部です。サービス仕様の注釈。この値は常に ServiceSpecification です。この情報は保存されません。

    データタイプ:文字列

    serviceQualificationItem.service.serviceCharacteristic サービス特性のリスト。

    データタイプ:オブジェクトのアレイ

    "serviceCharacteristic": [
      {
        "name": "String",
        "value": "String",
        "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 代替案レコードのSys_id。

    データタイプ:文字列

    テーブル:代替案 [sn_ord_qual_mgmt_alternate_proposal]

    ServiceQualificationItem.alternateServiceProposal.alternateServiceAvailabilityDate 代替提案 [sn_ord_qual_mgmt_alternate_proposal] テーブルの代替提案エントリのavailable_dateフィールド値。

    データタイプ:文字列

    serviceQualificationItem.alternateServiceProposal.alternateService 代替案で表されるサービス情報。

    データタイプ: オブジェクト

    serviceQualificationItem.alternateServiceProposal.alternateService.serviceSpecification 仕様に保持される代替案のサービス仕様。

    データタイプ: オブジェクト

    テーブル:代替案 [sn_ord_qual_mgmt_alternate_proposal]

    serviceQualificationItem です。alternateServiceProposal.alternateService.serviceSpecification.id 代替サービス仕様の外部 ID または初期バージョン。

    データタイプ:文字列

    serviceQualificationItem です。alternateServiceProposal.alternateService.serviceSpecification.name 代替サービス仕様の名前。

    データタイプ:文字列

    serviceQualificationItem です。alternateServiceProposal.alternateService.serviceSpecification.version 代替サービス仕様の外部バージョン。

    データタイプ:文字列

    serviceQualificationItem です。alternateServiceProposal.alternateService.serviceSpecification.internalVersion 代替サービス仕様の内部バージョン。

    データタイプ:数値

    serviceQualificationItem です。alternateServiceProposal.alternateService.serviceSpecification.internalId 代替サービス仕様の初期バージョン。

    データタイプ:文字列

    ServiceQualificationItem。alternateServiceProposal.alternateService.serviceSpecification.@type TMF Open API 標準の一部です。サービス仕様の注釈。この値は常に ServiceSpecification です。この情報は保存されません。

    データタイプ:文字列

    serviceQualificationItem です。alternateServiceProposal.alternateService.serviceCharacteristic 代替サービス提案のサービス特性のリスト。

    データタイプ:オブジェクトのアレイ

    "serviceCharacteristic": [
      {
        "name": "String",
        "value": "String",
        "valueType": "String"
      }
    ]
    serviceQualificationItem です。alternateServiceProposal.alternateService.serviceCharacteristic.valueType 代替サービス特性の値のタイプ。

    データタイプ:文字列

    serviceQualificationItem です。alternateServiceProposal.alternateService.serviceCharacteristic.name 代替サービス特性の名前。

    データタイプ:文字列

    serviceQualificationItem です。alternateServiceProposal.alternateService.serviceCharacteristic.value 代替サービス特性の値。

    データタイプ:文字列

    serviceQualificationItem.eligibilityUnavailabilityReason サービスを利用できない理由を説明する、サービスの適格性、利用不可理由のリスト。

    データタイプ:アレイ

    格納場所:ドメイン注文 [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 つの特定のユースケースに使用できます。
    1. 指定された住所のサービスを認定する要求。
    2. 既存のアクティブなアクセスサービスの同じ場所で新しいサービスを認定するよう要求します。
    3. 既存のサービスのアップグレードまたはダウングレードを要求します。

    各ユースケースには同じ要求構造が必要ですが、使用する要求パラメーターは異なります。各ユースケースの詳細と承認されるパラメーターは以下のとおりです。

    • 指定された住所のサービスを認定するには、 place アレイ (serviceQualificationItem.service.place) を使用して、特定の場所とサービス仕様を指定します。オプションで、要求で追加のサービス特性を定義できます。
    • 既存のアクティブなサービスの同じ場所で新しいサービスを認定するには、place アレイの代わりにreferenceServiceInventoryオブジェクト (serviceQualificationItem.service.referenceServiceInventory) を使用します。このオブジェクトを使用すると、場所の詳細を指定しなくても要求を作成し、サービス仕様を定義できます。オプションで、要求で追加のサービス特性を定義できます。
    • 既存のサービスをアップグレードまたはダウングレードするには、place アレイまたは referenceServiceInventory オブジェクトの代わりに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)
    パラメーター 説明
    @type オプション。TMF Open API 標準の一部です。検定の注釈。この値は常に CheckServiceQualification です。この情報は保存されません。

    データタイプ:文字列

    checkServiceQualificationDate オプション。認定要求が作成された日時。顧客注文 [sn_ind_tmt_orm_order] テーブルの order_date フィールドにあります。指定しない場合、order_dateは現在の日時に設定されます。

    データタイプ:文字列

    形式:YYYY-MM-DDTHH:MM:SS。SSSZ

    description オプション。認定要求の説明。顧客注文 [sn_ind_tmt_orm_order] テーブルの「short_description」フィールドにあります。

    データタイプ:文字列

    最大文字数:100

    有効な認定日 オプション。認定が有効になる日付。顧客注文 [sn_ind_tmt_orm_order] テーブルの顧客注文の「actual_end_date」フィールドに保持されます。

    データタイプ:文字列

    形式:YYYY-MM-DDTHH:MM:SS。SSSZ

    expectedQualificationDate オプション。予想される認定日。顧客注文の expected_end_date フィールドに保持されます。顧客注文 [sn_ind_tmt_orm_order] テーブルにあります。

    データタイプ:文字列

    形式:YYYY-MM-DDTHH:MM:SS。SSSZ

    externalId オプション。顧客注文にアサインされた外部 ID。顧客注文 [sn_ind_tmt_orm_order] テーブルの顧客注文の external_id フィールドに保持されます。

    データタイプ:文字列

    関連パーティー 認定要求の連絡先のリスト。各連絡先はアレイ内のオブジェクトです。顧客アカウント、顧客連絡先、またはコンシューマーアカウント情報を含むアイテムを少なくとも 1 つリストする必要があります。

    データタイプ:オブジェクトのアレイ

    "relatedParty": [
      {
      "@referredType": "String",
      "@type": "String",
      "id": "String",
      "name": "String"
      }
    ]
    relatedParty.@referredType 関係者のタイプ。
    可能な値:
    • consumer
    • カスタマー
    • 顧客連絡先

    データタイプ:文字列

    relatedParty.@type オプション。TMF Open API 標準の一部です。注文明細品目の連絡先の注釈。この値は常に RelatedParty です。この情報は保存されません。

    データタイプ:文字列

    relatedParty.id 関係者のsys_idまたはexternal_id (該当する場合)。アカウント [customer_account] テーブル、連絡先 [customer_contact] テーブル、またはコンシューマー [csm_consumer] テーブルにあります。

    データタイプ:文字列

    relatedParty.name アカウント、顧客、またはコンシューマーの名前。

    データタイプ:文字列

    サービス認定アイテム 場所、サービス情報、および特性を含むサービス認定アイテムのリスト。顧客注文の注文明細品目として保存されます。リストに少なくとも 1 つのサービス認定アイテムを含める必要があります。

    データタイプ:オブジェクトのアレイ

    "serviceQualificationItem": [{
      "@type": "String",
      "id": "String",
      "qualificationResult": "String",
      "quantity": "Number",
      "service": {Object},
      "state": "String"
    ]
    serviceQualificationItem.@type オプション。TMF Open API 標準の一部です。認定アイテムの注釈。この値は常に ServiceQualificationItem です。この情報は保存されません。

    データタイプ:文字列

    serviceQualificationItem.qualificationItemRelationship オプション。同じ要求内の他のサービス認定アイテムとの関係のリスト。この情報は、親注文明細品目を含む注文明細品目を作成する際に役立ちます。

    データタイプ:オブジェクトのアレイ

    "qualificationItemRelationship": [
      {
      "id": "String"
      "relationshipType": "String"
       }
    ]

    serviceQualificationItem.qualificationItemRelationship.id

    必須です。関係内のターゲット認定アイテムの ID。

    データタイプ:文字列

    serviceQualificationItem.qualificationItemRelationship.relationshipType 必須です。品目関係のタイプ。

    有効な値:

    • HasChild:子アイテムを示します。
    • HasParent:親アイテムを示します。

    データタイプ:文字列

    serviceQualificationItem.quantity オプション。認定アイテムの数量。顧客の注文明細品目の [数量] フィールドに保持されます。

    データタイプ:数値

    指定しない場合のデフォルト:1

    serviceQualificationItem.service 必須です。場所、サービス仕様、サービス特性などの変数を含めることができるサービス情報。

    データタイプ:オブジェクト

    "service": {
      "@type": "String",
      "place": [Array],
      "serviceCharacteristic": [Array],
      "serviceSpecification": {Object}
    }
    serviceQualificationItem.service.@type オプション。TMF Open API 標準の一部です。認定アイテムのサービス情報の注釈。この値は常に サービスです。この情報は保存されません。

    データタイプ:文字列

    serviceQualificationItem.service.place オプション。サービス認定アイテムについて要求された場所情報。場所 [cmn_location] テーブルにあります。
    注:
    アレイはサポートされていますが、1 つの場所のみを含める必要があります。

    データタイプ:オブジェクトのアレイ

    "place": [
      {
      "@type": "String"
      "id": "String",
      "name": "String"
      }
    ]
    serviceQualificationItem.service.place.@type オプション。TMF Open API 標準の一部です。サービスの注釈。この値は常に GeographicSite です。この情報は保存されません。

    データタイプ:文字列

    serviceQualificationItem.service.place.id 必須です。場所 [cmn_location] テーブル内の場所のSys_id。この場所 ID は、場所 [cmn_location] テーブルの有効なエントリである必要があります。

    データタイプ:文字列

    serviceQualificationItem.service.place.name オプション。場所の名前。この値は、場所 [cmn_location] テーブルのエントリに対しては検証されません。

    データタイプ:文字列

    serviceQualificationItem.service.referenceServiceInventory 必須です。必要な場所のアクティブなサービスを参照する有効なサービスインベントリエンティティ。認定注文の場所情報は、このサービスインベントリの場所から取得されます。
    重要:
    referenceServiceInventory オブジェクトを使用して、既存のアクティブな Access サービスの同じ場所にある新しいサービスを認定します。これを行うには、要求から place アレイと serviceInventory オブジェクトも省略する必要があります。省略しないと、API はエラーを返します。

    データタイプ: オブジェクト

    "referenceServiceInventory": {
    "id": "String"
    }
    serviceQualificationItem.service.referenceServiceInventory.id 要求で serviceQualificationItem.service.referenceServiceInventory を使用する場合は必須です。必要な場所のアクティブなサービスを参照する有効なサービスインベントリエンティティのsys_id。この情報は、注文作業メモにのみ記載されています。

    データタイプ:文字列

    serviceQualificationItem.service.serviceCharacteristic オプション。サービス特性のアレイ。

    データタイプ:オブジェクトのアレイ

    "serviceCharacteristic": [
      {
      "name": "String",
      "value": "String",
      "valueType": "String",
      }
    ]
    serviceQualificationItem.service.serviceCharacteristic.name 必須です。特性の名前。

    データタイプ:文字列

    serviceQualificationItem.service.serviceCharacteristic.value オプション。特性の値。TMF Open API 標準の一部です。認定アイテムの注釈。この値は常に ServiceQualificationItem です。この情報は保存されません。

    データタイプ:文字列

    serviceQualificationItem.service.serviceCharacteristic.valueType オプション。特性の値タイプ。

    データタイプ:文字列

    serviceQualificationItem.service.serviceInventory オプション。アップグレードまたはダウングレードが必要なアクティブなサービスを参照する有効なサービスインベントリエンティティ。
    重要:
    serviceInventoryオブジェクトは、サービスのアップグレードまたはダウングレードに使用します。これを行うには、リクエストから place arrayreferenceServiceInventory オブジェクトを省略する必要があります。省略しないと、API はエラーを返します。

    データタイプ: オブジェクト

    "serviceInventory": {
      "id": "String"
    }
    serviceQualificationItem.service.serviceSpecification 必須です。認定アイテムのサービス仕様。注文明細品目 [sn_ind_tmt_orm_order_line_item] テーブルの顧客注文明細品目のservice_specificationフィールドに保存されます。認定アイテムのサービス仕様をリソースに向けすることはできません。

    データタイプ:オブジェクト

    "serviceSpecification": {
      “@type”: ”String”,
      "id": "String",
      "name": "String"
    }
    
    serviceQualificationItem.service.serviceSpecification.@type オプション。TMF Open API 標準の一部です。サービス仕様の注釈。この値は常に ServiceSpecification です。この情報は保存されません。

    データタイプ:文字列

    serviceQualificationItem.service.serviceSpecification.id 必須です。サービス仕様の外部 ID または初期バージョン。

    データタイプ:文字列

    serviceQualificationItem.service.serviceSpecification.internalVersion オプション。サービス仕様の内部バージョン。

    データタイプ:数値

    serviceQualificationItem.service.serviceSpecification.name 必須です。サービス仕様の名前。

    データタイプ:文字列

    serviceQualificationItem.service.serviceSpecification.version オプション。サービス仕様の外部バージョン。

    データタイプ:文字列

    ヘッダー

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

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

    デフォルト: application/json

    Content-Type 要求本文のデータ形式。サポートされるタイプ:application/json または application/xml

    デフォルト: application/json

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

    ステータスコード

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

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

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

    表 : 19. 応答本文で返される要素
    要素 説明
    ID 認定顧客注文のSys_id。

    データタイプ:文字列

    テーブル:顧客注文 [sn_ind_tmt_orm_order]

    href 認定オーダーレコードへの相対リンク。

    データタイプ:文字列

    description 顧客注文の [short_description] フィールドからフェッチされる認定要求の説明。

    データタイプ:文字列

    テーブル:顧客注文 [sn_ind_tmt_orm_order]

    externalId 顧客注文の外部 ID。

    データタイプ:文字列

    テーブル:顧客注文 [sn_ind_tmt_orm_order] テーブルのexternal_idフィールド内。

    認定結果 顧客注文の結果フィールドの認定ステータス。
    可能な値:
    • 代替
    • なし
    • 保留中
    • 認定済み
    • 資格認定なし

    データタイプ:文字列

    状況 顧客注文のステータスフィールドからの顧客注文のステータス。

    データタイプ:文字列

    @type TMF Open API 標準の一部です。検定の注釈。この値は常に CheckServiceQualification です。この情報は保存されません。

    データタイプ:文字列

    checkServiceQualificationDate 顧客注文のorder_dateフィールドから作成された認定要求の日時。

    データタイプ:文字列

    形式:YYYY-MM-DDTHH:MM:SS。SSSZ

    テーブル:顧客注文 [sn_ind_tmt_orm_order]

    有効な認定日 顧客注文の [order_date] フィールドから取得された有効な認定日。

    データタイプ:文字列

    形式:YYYY-MM-DDTHH:MM:SS。SSSZ

    テーブル:顧客注文 [sn_ind_tmt_orm_order]

    expectedQualificationDate 予定されている認定日を保存します。顧客注文のexpected_end_dateフィールドに保持されます。

    データタイプ:文字列

    形式:YYYY-MM-DDTHH:MM:SS。SSSZ

    テーブル:顧客注文 [sn_ind_tmt_orm_order]

    関連パーティー 認定要求の連絡先のリスト。各連絡先はアレイ内のオブジェクトです。

    データタイプ:オブジェクトのアレイ

    "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 Open API 標準の一部です。注文明細品目の連絡先の注釈。この値は常に RelatedParty です。この情報は保存されません。

    データタイプ:文字列

    relatedParty.@referredType 関係者のタイプ。
    可能な値:
    • コンシューマー
    • 顧客
    • 顧客連絡先

    データタイプ:文字列

    サービス認定アイテム 場所、サービス情報、およびサービス特性に関する情報を含むサービス認定アイテムのリスト。顧客注文の注文明細品目として保存されます。

    データタイプ:オブジェクトのアレイ

    "serviceQualificationItem": [
      {
        "id": "String",
        "action": "String",
        "expectedServiceAvailabilityDate": "Number",
        "service": {Object},
        "@type": "String"
      }
    ]
    serviceQualificationItem.id 認定アイテムの ID。

    データタイプ:文字列

    保存場所:注文明細品目 [sn_ind_tmt_orm_order_line_item] テーブルの顧客注文明細品目のexternal_idフィールド。

    serviceQualificationItem.qualificationResult 認定アイテムの結果。顧客の注文明細品目の [結果] フィールドに保存されます。

    可能な値:

    • 代替
    • なし
    • 保留中
    • 認定済み
    • 資格認定なし

    データタイプ:文字列

    テーブル:注文明細品目 [sn_ind_tmt_orm_order_line_item]

    serviceQualificationItem.state 顧客の注文明細品目の [ステータス] フィールドから導出された認定アイテムのステータス。

    データタイプ:文字列

    テーブル:注文明細品目 [sn_ind_tmt_orm_order_line_item]

    serviceQualificationItem.quantity 顧客の注文明細品目の [数量] フィールドから導出された認定品目の数量。

    データタイプ:数値

    テーブル:注文明細品目 [sn_ind_tmt_orm_order_line_item]

    serviceQualificationItem.@type TMF Open API 標準の一部です。認定アイテムの注釈。この値は常に ServiceQualificationItem です。この情報は保存されません。

    データタイプ:文字列

    serviceQualificationItem.service 場所 (場所)、サービス仕様、サービス特性に関する詳細を含むサービス情報。

    データタイプ: オブジェクト

    "service": {
      "@type": "String",
      "place": [Array],
      "serviceCharacteristic": [Array],
      "serviceSpecification": {Object}
    }
    serviceQualificationItem.service.@type TMF Open API 標準の一部です。サービスの注釈。この値は常に サービスです。この情報は保存されません。

    データタイプ:文字列

    serviceQualificationItem.service.place サービス認定アイテムの場所情報。

    データタイプ:オブジェクトのアレイ

    注:
    このアレイには 1 つの場所のみを含めることができます。
    "place": [
      {
        "id": "String",
        "name": "String",
        "@referredType": "String"
      }
    ]

    serviceQualificationItem.service.place.id

    場所のSys_id。

    データタイプ:文字列

    テーブル:場所 [cmn_location]

    serviceQualificationItem.service.place.name 場所の名前。場所 [cmn_location] テーブルのエントリに対して検証されていません。

    データタイプ:文字列

    serviceQualificationItem.service.place.@type TMF Open 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 Open API 標準の一部です。サービス仕様の注釈。この値は常に ServiceSpecification です。この情報は保存されません。

    データタイプ:文字列

    serviceQualificationItem.service.serviceCharacteristic サービス特性のリスト。

    データタイプ:オブジェクトのアレイ

    "serviceCharacteristic": [
      {
        "name": "String",
        "value": "String",
        "valueType": "String"
      }
    ]
    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 の製品インベントリです Bow Willow、ヒューストン、テキサス州
    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、ヒューストン、テキサス州、特性 =[{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"
    }
    応答。要求のserviceInventoryからplacespecificationが入力されます。
    注:
    最初に要求ペイロードから特性が取得され、次に残りの特性 (存在する場合) が 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

    親品目と子品目の階層とその関係タイプについて説明します。数量属性を使用して複数の品目を作成する方法を示します。

    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. パスパラメーター
    名前 説明
    なし
    表 : 21. クエリパラメーター
    名前 説明
    なし
    表 : 22. 要求本文パラメーター (XML または JSON)
    パラメーター 説明
    サービス認定アイテム 必須です。要求された上位注文品目のサービス注文テーブル [sn_ind_tmt_orm_service_order] 内のドメイン注文を表すサービス認定アイテムのリスト。各サービス認定品目によって表されるすべてのドメイン注文は、同じ上位注文品目に属している必要があります。

    データタイプ:オブジェクトのアレイ

    "serviceQualificationItem": [
    {
      "@type": "String",
      "alternateServiceProposal": [Array],
      "id": "String",
      "qualificationResult": "String"
    }
    ]
    serviceQualificationItem.@type オプション。TMF Open API 標準の一部です。認定アイテムの注釈。この値は常に ServiceQualificationItem です。この情報は保存されません。

    データタイプ:文字列

    serviceQualificationItem.alternateProposal 認定アイテムに提供された代替案。

    データタイプ:オブジェクトのアレイ

    "alternateServiceProposal": [
      {
      "@type": "String",
      "alternateService": {Object},
      "alternateServiceAvailabilityDate": "Number",
      "id": "String",
      "serviceCharacteristic": [Array]
      }
    ]

    保存場所:代替案 [sn_ord_qual_mgmt_alternate_proposal]

    serviceQualificationItem.alternateProposal.@type TMF Open API 標準の一部です。認定アイテムのサービス情報の注釈。この値は常に サービスです。この情報は保存されません。

    データタイプ:文字列

    serviceQualificationItem.alternateProposal.alternateService 必須です。サービスの仕様と特性を含む代替案のサービス情報。

    データタイプ: オブジェクト

    "alternateService": {
      "@type": "String",
      "serviceSpecification": {Object},
      "serviceCharacteristic": [Array]
    }
    serviceQualificationItem.alternateProposal.alternateService.alternateService.serviceCharacteristic.valueType 代替サービス提案に基づく特性の値タイプ。

    データタイプ:文字列

    serviceQualificationItem.alternateProposal.alternateService.serviceCharacteristic 代替サービス提案のサービス特性。

    データタイプ:オブジェクトのアレイ

    "serviceCharacteristic": [
      {
        "name": "String",
        "value": "String",
        "valueType": "String"
      }
    ]

    格納場所:代替提案 [sn_ord_qual_mgmt_alternate_proposal] テーブルのorder_characteristicsフィールド。

    serviceQualificationItem.alternateProposal.alternateService.serviceCharacteristic.name 必須です。代替サービス提案に属する特性の名前。

    データタイプ:文字列

    serviceQualificationItem.alternateProposal.alternateService.serviceCharacteristic.value 代替サービス提案に属する特性の値。

    データタイプ:文字列

    serviceQualificationItem.alternateProposal.alternateService.serviceCharacteristic.valueType 特性のタイプ。

    データタイプ:文字列

    serviceQualificationItem.alternateProposal.alternateService .serviceSpecification 必須です。代替案のサービス仕様。

    データタイプ: オブジェクト

    "serviceSpecification": {
      “@type”: ”String”
      "id": "String",
      "name": "String"
    }

    格納場所:代替案 [sn_ord_qual_mgmt_alternate_proposal] テーブルの代替案エントリの仕様フィールド。

    serviceQualificationItem.alternateProposal.alternateService .serviceSpecification.@type TMF Open API 標準の一部です。サービス仕様の注釈。この値は常に ServiceSpecification です。この情報は保存されません。

    データタイプ:文字列

    serviceQualificationItem.alternateProposal.alternateService.serviceSpecification.id 必須です。サービス仕様の外部 ID または初期バージョン。

    データタイプ:文字列

    serviceQualificationItem.alternateProposal.alternateService.serviceSpecification.internalVersion サービス仕様の内部バージョン。

    データタイプ:文字列

    serviceQualificationItem.alternateProposal.alternateService.serviceSpecification.name サービス仕様の名前。

    データタイプ:文字列

    serviceQualificationItem.alternateProposal.alternateService.serviceSpecification.version サービス仕様の外部バージョン。

    データタイプ:文字列

    serviceQualificationItem.alternateProposal.alternateServiceAvailabilityDate 代替サービス利用可能日。

    データタイプ:文字列

    形式:YYYY-MM-DDTHH:MM:SS。SSSZ

    テーブル:代替案 [sn_ord_qual_mgmt_alternate_proposal] テーブルの [available_date] フィールド。ドメイン注文情報は、現在のサービス認定アイテムによって表されるドメイン注文に属しています。

    serviceQualificationItem.alternateProposal.id 代替案のユーザー定義 ID。このデータは永続化されません。

    データタイプ:文字列

    serviceQualificationItem.eligibilityUnavailabilityReason サービス資格が対象外である理由。

    データタイプ: オブジェクト

    "eligibilityUnavailabilityReason": [
      {
        "code": "String",
        "label": "String"
      }
    ]

    保存場所:理由のリスト全体が、ラベルフィールドとともに文字列としてドメイン注文 [sn_ind_tmt_orm_domain_order] テーブルのunavailability_reasonフィールドに保持されます。

    serviceQualificationItem.eligibilityUnavailabilityReason.code 適格性を使用できない理由のコード。この情報は保持されません。

    データタイプ:文字列

    serviceQualificationItem.eligibilityUnavailabilityReason.label 必須です。適格性を利用できない理由のラベル。複数の不適格理由がある場合、ラベルはカンマで区切られます。

    データタイプ:文字列

    格納場所:ドメイン注文 [sn_ind_tmt_orm_domain_order] テーブルのunavailability_reasonフィールド。

    serviceQualificationItem.id

    必須です。認定アイテムによって表されるドメイン順序のSys_id。

    データタイプ:文字列

    保存場所:ドメイン注文 [sn_ind_tmt_orm_service_order] テーブルのSys_idフィールド。

    serviceQualificationItem.qualificationResult 必須です。各サービス認定アイテムの認定結果。

    データタイプ:文字列

    格納場所:ドメイン注文テーブル [sn_ind_tmt_orm_service_order] の結果フィールド。

    ヘッダー

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

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

    デフォルト: application/json

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

    ステータスコード

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

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

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

    名前 説明
    ID 認定顧客注文のSys_id。

    データタイプ:文字列

    テーブル:顧客注文 [sn_ind_tmt_orm_order]

    href 認定オーダーレコードへの相対リンク。

    データタイプ:文字列

    description 顧客注文の [short_description] フィールドからフェッチされる認定要求の説明。

    データタイプ:文字列

    テーブル:顧客注文 [sn_ind_tmt_orm_order]

    externalId 顧客注文の外部 ID。

    データタイプ:文字列

    テーブル:顧客注文 [sn_ind_tmt_orm_order] テーブルのexternal_idフィールド内。

    認定結果 顧客注文の結果フィールドの認定ステータス。
    可能な値:
    • 代替
    • なし
    • 保留中
    • 認定済み
    • 資格認定なし

    データタイプ:文字列

    状況 顧客注文のステータスフィールドからの顧客注文のステータス。

    データタイプ:文字列

    @type TMF Open API 標準の一部です。検定の注釈。この値は常に CheckServiceQualification です。この情報は保存されません。

    データタイプ:文字列

    checkServiceQualificationDate 顧客注文のorder_dateフィールドから作成された認定要求の日時。

    データタイプ:文字列

    形式:YYYY-MM-DDTHH:MM:SS。SSSZ

    テーブル:顧客注文 [sn_ind_tmt_orm_order]

    有効な認定日 顧客注文の [order_date] フィールドから取得された有効な認定日。

    データタイプ:文字列

    形式:YYYY-MM-DDTHH:MM:SS。SSSZ

    テーブル:顧客注文 [sn_ind_tmt_orm_order]

    expectedQualificationDate 予定されている認定日を保存します。顧客注文のexpected_end_dateフィールドに保持されます。

    データタイプ:文字列

    形式:YYYY-MM-DDTHH:MM:SS。SSSZ

    テーブル:顧客注文 [sn_ind_tmt_orm_order]

    関連パーティー 認定要求の連絡先のリスト。各連絡先はアレイ内のオブジェクトです。

    データタイプ:オブジェクトのアレイ

    "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 Open API 標準の一部です。注文明細品目の連絡先の注釈。この値は常に RelatedParty です。この情報は保存されません。

    データタイプ:文字列

    relatedParty.@referredType 関係者のタイプ。
    可能な値:
    • コンシューマー
    • 顧客
    • 顧客連絡先

    データタイプ:文字列

    サービス認定アイテム 場所、サービス情報、およびサービス特性に関する情報を含むサービス認定アイテムのリスト。顧客注文の注文明細品目として保存されます。

    データタイプ:オブジェクトのアレイ

    "serviceQualificationItem": [
      {
        "id": "String",
        "action": "String",
        "expectedServiceAvailabilityDate": "Number",
        "service": {Object},
        "@type": "String"
      }
    ]
    serviceQualificationItem.id 認定アイテムの ID。

    データタイプ:文字列

    保存場所:注文明細品目 [sn_ind_tmt_orm_order_line_item] テーブルの顧客注文明細品目のexternal_idフィールド。

    serviceQualificationItem.qualificationResult 認定アイテムの結果。顧客の注文明細品目の [結果] フィールドに保存されます。

    可能な値:

    • 代替
    • なし
    • 保留中
    • 認定済み
    • 資格認定なし

    データタイプ:文字列

    テーブル:注文明細品目 [sn_ind_tmt_orm_order_line_item]

    serviceQualificationItem.state 顧客の注文明細品目の [ステータス] フィールドから導出された認定アイテムのステータス。

    データタイプ:文字列

    テーブル:注文明細品目 [sn_ind_tmt_orm_order_line_item]

    serviceQualificationItem.quantity 顧客の注文明細品目の [数量] フィールドから導出された認定品目の数量。

    データタイプ:数値

    テーブル:注文明細品目 [sn_ind_tmt_orm_order_line_item]

    serviceQualificationItem.@type TMF Open API 標準の一部です。認定アイテムの注釈。この値は常に ServiceQualificationItem です。この情報は保存されません。

    データタイプ:文字列

    serviceQualificationItem.service 場所 (場所)、サービス仕様、サービス特性に関する詳細を含むサービス情報。

    データタイプ: オブジェクト

    "service": {
      "@type": "String",
      "place": [Array],
      "serviceCharacteristic": [Array],
      "serviceSpecification": {Object}
    }
    serviceQualificationItem.service.@type TMF Open API 標準の一部です。サービスの注釈。この値は常に サービスです。この情報は保存されません。

    データタイプ:文字列

    serviceQualificationItem.service.place サービス認定アイテムの場所情報。

    データタイプ:オブジェクトのアレイ

    注:
    このアレイには 1 つの場所のみを含めることができます。
    "place": [
      {
        "id": "String",
        "name": "String",
        "@referredType": "String"
      }
    ]

    serviceQualificationItem.service.place.id

    場所のSys_id。

    データタイプ:文字列

    テーブル:場所 [cmn_location]

    serviceQualificationItem.service.place.name 場所の名前。場所 [cmn_location] テーブルのエントリに対して検証されていません。

    データタイプ:文字列

    serviceQualificationItem.service.place.@type TMF Open 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 Open API 標準の一部です。サービス仕様の注釈。この値は常に ServiceSpecification です。この情報は保存されません。

    データタイプ:文字列

    serviceQualificationItem.service.serviceCharacteristic サービス特性のリスト。

    データタイプ:オブジェクトのアレイ

    "serviceCharacteristic": [
      {
        "name": "String",
        "value": "String",
        "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 代替案レコードのSys_id。

    データタイプ:文字列

    テーブル:代替案 [sn_ord_qual_mgmt_alternate_proposal]

    ServiceQualificationItem.alternateServiceProposal.alternateServiceAvailabilityDate 代替提案 [sn_ord_qual_mgmt_alternate_proposal] テーブルの代替提案エントリのavailable_dateフィールド値。

    データタイプ:文字列

    serviceQualificationItem.alternateServiceProposal.alternateService 代替案で表されるサービス情報。

    データタイプ: オブジェクト

    serviceQualificationItem.alternateServiceProposal.alternateService.serviceSpecification 仕様に保持される代替案のサービス仕様。

    データタイプ: オブジェクト

    テーブル:代替案 [sn_ord_qual_mgmt_alternate_proposal]

    serviceQualificationItem です。alternateServiceProposal.alternateService.serviceSpecification.id 代替サービス仕様の外部 ID または初期バージョン。

    データタイプ:文字列

    serviceQualificationItem です。alternateServiceProposal.alternateService.serviceSpecification.name 代替サービス仕様の名前。

    データタイプ:文字列

    serviceQualificationItem です。alternateServiceProposal.alternateService.serviceSpecification.version 代替サービス仕様の外部バージョン。

    データタイプ:文字列

    serviceQualificationItem です。alternateServiceProposal.alternateService.serviceSpecification.internalVersion 代替サービス仕様の内部バージョン。

    データタイプ:数値

    serviceQualificationItem です。alternateServiceProposal.alternateService.serviceSpecification.internalId 代替サービス仕様の初期バージョン。

    データタイプ:文字列

    ServiceQualificationItem。alternateServiceProposal.alternateService.serviceSpecification.@type TMF Open API 標準の一部です。サービス仕様の注釈。この値は常に ServiceSpecification です。この情報は保存されません。

    データタイプ:文字列

    serviceQualificationItem です。alternateServiceProposal.alternateService.serviceCharacteristic 代替サービス提案のサービス特性のリスト。

    データタイプ:オブジェクトのアレイ

    "serviceCharacteristic": [
      {
        "name": "String",
        "value": "String",
        "valueType": "String"
      }
    ]
    serviceQualificationItem です。alternateServiceProposal.alternateService.serviceCharacteristic.valueType 代替サービス特性の値のタイプ。

    データタイプ:文字列

    serviceQualificationItem です。alternateServiceProposal.alternateService.serviceCharacteristic.name 代替サービス特性の名前。

    データタイプ:文字列

    serviceQualificationItem です。alternateServiceProposal.alternateService.serviceCharacteristic.value 代替サービス特性の値。

    データタイプ:文字列

    serviceQualificationItem.eligibilityUnavailabilityReason サービスを利用できない理由を説明する、サービスの適格性、利用不可理由のリスト。

    データタイプ:アレイ

    格納場所:ドメイン注文 [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"
    }