テクニカルサービス認定オープン API
テクニカルサービス認定オープン API は、履行の注文を送信する前にリソースとサービスの可用性を確認するためのエンドポイントを提供します。
この API は、TMF645 サービス認定 API REST 仕様の ServiceNow 実装です。サービス認定要求の詳細については、「 Service qualification requests」を参照してください。
sn_ord_qual_mgmt 名前空間内で提供され、次のプラグインが必要です。- 製品カタログ管理コア [com.sn_prd_pm]
- 製品カタログ Advanced [com.sn_prd_pm_adv]
- 注文認定管理 [com.sn_ord_qual_mgmt]
- Telecom, Media & Tech の注文管理 [com.sn_tmt_core]
- テレコムコア [com.sn_tmt_core]
この API を使用するには、sn_ind_tmt_orm.order_integrator ロールが必要です。
テクニカルサービス認定オープン API - GET sn_ord_qual_mgmt/qualification/checkServiceQualification/{id}
指定された顧客注文 ID に関連付けられている技術認定要求を取得します。
- 顧客注文 [sn_ind_tmt_orm_order]
- オーダー品目 [sn_ind_tmt_orm_order_line_item]
URL 形式
バージョン管理された URL: /api/sn_ord_qual_mgmt/qualification/checkServiceQualification/{id}
サポートされている要求パラメーター
| 名前 | 説明 |
|---|---|
| api_version | オプションアクセスするエンドポイントのバージョン。たとえば、v1 や v2。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ:文字列 |
| id | 取得する認定顧客注文のSys_id。顧客注文 [sn_ind_tmt_orm_order] テーブルにあります。 データタイプ:文字列 |
| 名前 | 説明 |
|---|---|
| なし |
| 名前 | 説明 |
|---|---|
| なし |
ヘッダー
次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。
| ヘッダー | 説明 |
|---|---|
| 承認 | 応答本文のデータフォーマット。サポートされるタイプ:application/json または application/xml。 デフォルト: application/json |
| ヘッダー | 説明 |
|---|---|
| なし |
ステータスコード
この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。
| 200 | 成功。要求が正常に処理されました。 |
| 400 | 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。 |
| 404 | 見つかりません。要求アイテムが見つかりませんでした。 |
応答本文のパラメーター (JSON または XML)
| 名前 | 説明 |
|---|---|
| id | 認定顧客注文のSys_id。顧客注文 [sn_ind_tmt_orm_order] テーブルにあります。 データタイプ:文字列 |
| href | 認定注文レコードへの相対リンク。 データタイプ:文字列 |
| 説明 | 顧客注文の short_description フィールドからフェッチされた認定要求の説明。顧客注文 [sn_ind_tmt_orm_order] テーブルにあります。 データタイプ:文字列 |
| externalId | 顧客注文の [external_id] フィールドの外部 ID。顧客注文 [sn_ind_tmt_orm_order] テーブルにあります。 データタイプ:文字列 |
| 認定結果 | 顧客注文の結果フィールドの認定ステータス。可能な値:
データタイプ:文字列 |
| state | 顧客注文のステータスフィールドにある顧客注文のステータス。 データタイプ:文字列 |
| @type | TMF オープン API 標準の一部。認定の注釈。この値は常に CheckServiceQualification です。この情報は保存されません。データタイプ:文字列 |
| checkServiceQualificationDate | 顧客注文のorder_dateフィールドから作成された認定要求の日時。顧客注文 [sn_ind_tmt_orm_order] テーブルにあります。 形式:YYYY-MM-DDTHH:MM:SS。SSSZの データタイプ:文字列 |
| 有効資格日 | 顧客注文の order_date フィールドからフェッチされた有効な認定日。顧客注文 [sn_ind_tmt_orm_order] テーブルにあります。 形式:YYYY-MM-DDTHH:MM:SS。SSSZの データタイプ:文字列 |
| expectedQualificationDate | 予定されている認定日を保存します。顧客注文のexpected_end_dateフィールドに保持されます。顧客注文 [sn_ind_tmt_orm_order] テーブルにあります。 形式:YYYY-MM-DDTHH:MM:SS。SSSZの データタイプ:文字列 |
| relatedParty | 認定要求の連絡先のリスト。各連絡先はアレイ内のオブジェクトです。 データタイプ:オブジェクトのアレイ |
| relatedParty.id | 注文に関連付けられたアカウント、顧客の連絡先、またはコンシューマーのSys_idまたはexternal_id。アカウント [customer_account] テーブル、連絡先 [customer_contact] テーブル、またはコンシューマー [csm_consumer] テーブルにあります。 データタイプ:文字列 |
| relatedParty.name | アカウント、顧客、またはコンシューマーの名前。 データタイプ:文字列 |
| relatedParty.@type | TMF オープン API 標準の一部。注文品目連絡先の注釈。この値は常に RelatedParty です。この情報は保存されません。データタイプ:文字列 |
| relatedParty.@referredType | 関係者のタイプ。 可能な値:
データタイプ:文字列 |
| serviceQualificationItem | 場所、サービス情報、およびサービスの特性に関する情報を含むサービス認定アイテムのリスト。顧客注文の注文品目として保存されます。 データタイプ:オブジェクトのアレイ |
| 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 オープン API 標準の一部。認定アイテムの注釈。この値は常に ServiceQualificationItem です。この情報は保存されません。 データタイプ:文字列 |
| serviceQualificationItem.service | 場所 (場所)、サービスの仕様、サービスの特性に関する詳細を含むサービス情報。 データタイプ: オブジェクト |
| serviceQualificationItem.service.@type | TMF Open API 標準の一部。サービスの注釈。この値は常に Service です。この情報は保存されません。 データタイプ:文字列 |
| serviceQualificationItem.service.place | サービス資格アイテムの場所情報。 データタイプ:オブジェクトのアレイ 注: この配列には、1 つの場所のみを含めることができます。 |
serviceQualificationItem.service.place.id |
場所 [cmn_location] テーブル内の場所のSys_id。 データタイプ:文字列 |
| serviceQualificationItem.service.place.name | 場所の名前。場所 [cmn_location] テーブルのエントリに対して検証されていません。 データタイプ:文字列 |
| serviceQualificationItem.service.place.@type | TMF オープン API 標準の一部。サービスの注釈。この値は常に GeographicSite です。この情報は保存されません。データタイプ:文字列 |
| serviceQualificationItem.service.serviceSpecification | 認定アイテムのサービス仕様の詳細。 データタイプ:オブジェクトのアレイ |
| serviceQualificationItem.service.serviceSpecification.id | サービス仕様の外部 ID または初期バージョン。 データタイプ:文字列 |
| serviceQualificationItem.service.serviceSpecification.name | サービス仕様の名前。 データタイプ:文字列 |
| serviceQualificationItem.service.serviceSpecification.version | サービス仕様の外部バージョン。 データタイプ:文字列 |
| serviceQualificationItem.service.serviceSpecification.internalVersion | サービス仕様の内部バージョン。 データタイプ:数値 |
| serviceQualificationItem.service.serviceSpecification.internalId | サービス仕様の初期バージョン。 データタイプ:文字列 |
| serviceQualificationItem.service.serviceSpecification.@type | TMF オープン API 標準の一部。サービス仕様の注釈。この値は常に ServiceSpecification です。この情報は保存されません。データタイプ:文字列 |
| serviceQualificationItem.service.serviceCharacteristic | サービス特性のリスト。 データタイプ:オブジェクトのアレイ |
| serviceQualificationItem.service.serviceCharacteristic.valueType | 特性の値タイプ。 データタイプ:文字列 |
| serviceQualificationItem.service.serviceCharacteristic.name | 特性の名前。 データタイプ:文字列 |
| serviceQualificationItem.service.serviceCharacteristic.value | 特性の値。 データタイプ:文字列 |
| ServiceQualificationItem.alternateServiceProposal | 認定注文の代替サービス提案。代替案は、代替案 [sn_ord_qual_mgmt_alternate_proposal] テーブルに保存されます。 データタイプ:文字列 |
| ServiceQualificationItem.alternateServiceProposal.id | 代替提案 [sn_ord_qual_mgmt_alternate_proposal] テーブルの代替提案エントリのSys_id。 データタイプ:文字列 |
| ServiceQualificationItem.alternateServiceProposal.alternateServiceAvailabilityDate | 代替提案 [sn_ord_qual_mgmt_alternate_proposal] テーブルの代替提案エントリのavailable_dateフィールド値。 データタイプ:文字列 |
| serviceQualificationItem.alternateServiceProposal.alternateService | 代替案で表されるサービス情報。 データタイプ: Object |
| 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 オープン API 標準の一部。サービス仕様の注釈。この値は常に ServiceSpecification です。この情報は保存されません。データタイプ:文字列 |
| serviceQualificationItemです。alternateServiceProposal.alternateService.serviceCharacteristic | 代替サービス提案のサービス特性のアレイ。 データタイプ:オブジェクトのアレイ |
| serviceQualificationItemです。alternateServiceProposal.alternateService.serviceCharacteristic.valueType | 代替サービス特性の値タイプ。 データタイプ:文字列 |
| serviceQualificationItemです。alternateServiceProposal.alternateService.serviceCharacteristic.name | 代替サービス特性の名前。 データタイプ:文字列 |
| serviceQualificationItemです。alternateServiceProposal.alternateService.serviceCharacteristic.value | 代替サービス特性の値。 データタイプ:文字列 |
| serviceQualificationItem.eligibilityUnavailabilityReason | サービスが利用できない理由を説明する、サービス適格性利用不可の理由のリスト。この値はunavailability_reasonドメイン注文 [sn_ind_tmt_orm_domain_order] テーブルのフィールドに保持されます。 データタイプ:アレイ |
| 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
サポートされている要求パラメーター
| 名前 | Description (説明) |
|---|---|
| api_version | オプションアクセスするエンドポイントのバージョン。たとえば、v1 や v2。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ:文字列 |
| パラメーター | Description (説明) |
|---|---|
| 説明 | 顧客注文の [short_description] フィールドで認定注文をフィルタリングします。簡単な説明がこのパラメーターの値と一致するの注文のみが応答で返されます。 データタイプ:文字列 |
| fields | 応答で返すフィールド名のリスト。無効なフィールドは無視されます。このパラメーターが要求で指定されていない場合は、すべてのフィールドが返されます。 データタイプ:文字列、カンマ区切り |
| limit | 返されるレコードの最大数。このレコード数を超える要求の場合は、 offset パラメーター を使用してレコード取得をページネーションします。 デフォルト値:20 最大:100 データタイプ:数値 |
| 認定結果 | 認定順序を結果でフィルタリングします。このパラメーターの値に一致する結果を持つ注文のみが応答で返されます。 データタイプ:文字列 |
| state | 認定順序をステータスでフィルタリングします。ステータスがこの パラメーターの値と一致する注文のみが応答で返されます。 データタイプ:文字列 |
| 名前 | 説明 |
|---|---|
| なし |
ヘッダー
次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。
| ヘッダー | 説明 |
|---|---|
| 承認 | 応答本文のデータフォーマット。サポートされるタイプ:application/json または application/xml。 デフォルト: application/json |
| ヘッダー | 説明 |
|---|---|
| なし |
ステータスコード
この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。
| ステータスコード | 説明 |
|---|---|
| 200 | 要求が正常に処理されました。応答で完全なリソースが返されました (ページネーションなし)。 |
| 206 | 応答で部分的なリソースが返されました (ページネーションあり)。 |
| 400 | 要求が正しくありません。考えられる理由:
|
| 404 | フィルター基準に当てはまるレコードが見つかりません。 |
応答本文のパラメーター (JSON または XML)
| 名前 | 説明 |
|---|---|
| id | 認定顧客注文のSys_id。顧客注文 [sn_ind_tmt_orm_order] テーブルにあります。 データタイプ:文字列 |
| href | 認定注文レコードへの相対リンク。 データタイプ:文字列 |
| 説明 | 顧客注文の short_description フィールドからフェッチされた認定要求の説明。顧客注文 [sn_ind_tmt_orm_order] テーブルにあります。 データタイプ:文字列 |
| externalId | 顧客注文の [external_id] フィールドの外部 ID。顧客注文 [sn_ind_tmt_orm_order] テーブルにあります。 データタイプ:文字列 |
| 認定結果 | 顧客注文の結果フィールドの認定ステータス。可能な値:
データタイプ:文字列 |
| state | 顧客注文のステータスフィールドにある顧客注文のステータス。 データタイプ:文字列 |
| @type | TMF オープン API 標準の一部。認定の注釈。この値は常に CheckServiceQualification です。この情報は保存されません。データタイプ:文字列 |
| checkServiceQualificationDate | 顧客注文のorder_dateフィールドから作成された認定要求の日時。顧客注文 [sn_ind_tmt_orm_order] テーブルにあります。 形式:YYYY-MM-DDTHH:MM:SS。SSSZの データタイプ:文字列 |
| 有効資格日 | 顧客注文の order_date フィールドからフェッチされた有効な認定日。顧客注文 [sn_ind_tmt_orm_order] テーブルにあります。 形式:YYYY-MM-DDTHH:MM:SS。SSSZの データタイプ:文字列 |
| expectedQualificationDate | 予定されている認定日を保存します。顧客注文のexpected_end_dateフィールドに保持されます。顧客注文 [sn_ind_tmt_orm_order] テーブルにあります。 形式:YYYY-MM-DDTHH:MM:SS。SSSZの データタイプ:文字列 |
| relatedParty | 認定要求の連絡先のリスト。各連絡先はアレイ内のオブジェクトです。 データタイプ:オブジェクトのアレイ |
| relatedParty.id | 注文に関連付けられたアカウント、顧客の連絡先、またはコンシューマーのSys_idまたはexternal_id。アカウント [customer_account] テーブル、連絡先 [customer_contact] テーブル、またはコンシューマー [csm_consumer] テーブルにあります。 データタイプ:文字列 |
| relatedParty.name | アカウント、顧客、またはコンシューマーの名前。 データタイプ:文字列 |
| relatedParty.@type | TMF オープン API 標準の一部。注文品目連絡先の注釈。この値は常に RelatedParty です。この情報は保存されません。データタイプ:文字列 |
| relatedParty.@referredType | 関係者のタイプ。 可能な値:
データタイプ:文字列 |
| serviceQualificationItem | 場所、サービス情報、およびサービスの特性に関する情報を含むサービス認定アイテムのリスト。顧客注文の注文品目として保存されます。 データタイプ:オブジェクトのアレイ |
| 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 オープン API 標準の一部。認定アイテムの注釈。この値は常に ServiceQualificationItem です。この情報は保存されません。 データタイプ:文字列 |
| serviceQualificationItem.service | 場所 (場所)、サービスの仕様、サービスの特性に関する詳細を含むサービス情報。 データタイプ: オブジェクト |
| serviceQualificationItem.service.@type | TMF Open API 標準の一部。サービスの注釈。この値は常に Service です。この情報は保存されません。 データタイプ:文字列 |
| serviceQualificationItem.service.place | サービス資格アイテムの場所情報。 データタイプ:オブジェクトのアレイ 注: この配列には、1 つの場所のみを含めることができます。 |
serviceQualificationItem.service.place.id |
場所 [cmn_location] テーブル内の場所のSys_id。 データタイプ:文字列 |
| serviceQualificationItem.service.place.name | 場所の名前。場所 [cmn_location] テーブルのエントリに対して検証されていません。 データタイプ:文字列 |
| serviceQualificationItem.service.place.@type | TMF オープン API 標準の一部。サービスの注釈。この値は常に GeographicSite です。この情報は保存されません。データタイプ:文字列 |
| serviceQualificationItem.service.serviceSpecification | 認定アイテムのサービス仕様の詳細。 データタイプ:オブジェクトのアレイ |
| serviceQualificationItem.service.serviceSpecification.id | サービス仕様の外部 ID または初期バージョン。 データタイプ:文字列 |
| serviceQualificationItem.service.serviceSpecification.name | サービス仕様の名前。 データタイプ:文字列 |
| serviceQualificationItem.service.serviceSpecification.version | サービス仕様の外部バージョン。 データタイプ:文字列 |
| serviceQualificationItem.service.serviceSpecification.internalVersion | サービス仕様の内部バージョン。 データタイプ:数値 |
| serviceQualificationItem.service.serviceSpecification.internalId | サービス仕様の初期バージョン。 データタイプ:文字列 |
| serviceQualificationItem.service.serviceSpecification.@type | TMF オープン API 標準の一部。サービス仕様の注釈。この値は常に ServiceSpecification です。この情報は保存されません。データタイプ:文字列 |
| serviceQualificationItem.service.serviceCharacteristic | サービス特性のリスト。 データタイプ:オブジェクトのアレイ |
| serviceQualificationItem.service.serviceCharacteristic.valueType | 特性の値タイプ。 データタイプ:文字列 |
| serviceQualificationItem.service.serviceCharacteristic.name | 特性の名前。 データタイプ:文字列 |
| serviceQualificationItem.service.serviceCharacteristic.value | 特性の値。 データタイプ:文字列 |
| ServiceQualificationItem.alternateServiceProposal | 認定注文の代替サービス提案。代替案は、代替案 [sn_ord_qual_mgmt_alternate_proposal] テーブルに保存されます。 データタイプ:文字列 |
| ServiceQualificationItem.alternateServiceProposal.id | 代替提案 [sn_ord_qual_mgmt_alternate_proposal] テーブルの代替提案エントリのSys_id。 データタイプ:文字列 |
| ServiceQualificationItem.alternateServiceProposal.alternateServiceAvailabilityDate | 代替提案 [sn_ord_qual_mgmt_alternate_proposal] テーブルの代替提案エントリのavailable_dateフィールド値。 データタイプ:文字列 |
| serviceQualificationItem.alternateServiceProposal.alternateService | 代替案で表されるサービス情報。 データタイプ: Object |
| 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 オープン API 標準の一部。サービス仕様の注釈。この値は常に ServiceSpecification です。この情報は保存されません。データタイプ:文字列 |
| serviceQualificationItemです。alternateServiceProposal.alternateService.serviceCharacteristic | 代替サービス提案のサービス特性のアレイ。 データタイプ:オブジェクトのアレイ |
| serviceQualificationItemです。alternateServiceProposal.alternateService.serviceCharacteristic.valueType | 代替サービス特性の値タイプ。 データタイプ:文字列 |
| serviceQualificationItemです。alternateServiceProposal.alternateService.serviceCharacteristic.name | 代替サービス特性の名前。 データタイプ:文字列 |
| serviceQualificationItemです。alternateServiceProposal.alternateService.serviceCharacteristic.value | 代替サービス特性の値。 データタイプ:文字列 |
| serviceQualificationItem.eligibilityUnavailabilityReason | サービスが利用できない理由を説明する、サービス適格性利用不可の理由のリスト。この値はunavailability_reasonドメイン注文 [sn_ind_tmt_orm_domain_order] テーブルのフィールドに保持されます。 データタイプ:アレイ |
| 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] テーブルに顧客品目注文として保持されます。
このエンドポイントの使用
- 指定された住所でのサービスの認定を要求します。
- 既存のアクティブなアクセスサービスと同じ場所で新しいサービスを認定することを要求します。
- 既存のサービスのアップグレードまたはダウングレードを要求します。
各ユースケースには同じ要求構造が必要ですが、異なる要求パラメーターを使用します。各ユースケースと受け入れられるパラメーターの詳細が提供されます。
- 指定した住所でサービスを認定するには、 place 配列 (serviceQualificationItem.service.place) を使用して、特定の場所とサービスの仕様を指定します。オプションで、要求に追加のサービス特性を定義できます。
- 既存のアクティブなサービスと同じ場所で新しいサービスを認定するには、place 配列の代わりに referenceServiceInventory オブジェクト (serviceQualificationItem.service.referenceServiceInventory) を使用します。このオブジェクトを使用すると、場所の詳細を指定しなくても、要求を作成し、サービス仕様を定義できます。オプションで、要求に追加のサービス特性を定義できます。
- 既存のサービスをアップグレードまたはダウングレードするには、place アレイまたは referenceServiceInventory オブジェクトの代わりに、serviceInventory オブジェクト (serviceQualificationItem.service.ServiceInventory) を使用します。このユースケースでは、場所情報と仕様の詳細は既存のサービスから取得されます。要求で、変更するサービス特性を定義します。
たとえば、既存のアクティブなサービスのダウンロード速度を 100 Mb/s から 600 Mb/s にアップグレードできることを確認するとします。この場合、 serviceInventory パラメーターを使用して、「速度」特性を「低」から「高」に変更することで要求を定義できます。API は、既存のサービスから残りの特性を取得します。
特定のユースケースごとに API 要求を形成する方法を理解するには、このページの 「例 」セクションにある呼び出し例を参照してください。
URL 形式
バージョン管理された URL: /api/sn_ord_qual_mgmt/qualification/checkServiceQualification
サポートされている要求パラメーター
| 名前 | 説明 |
|---|---|
| なし |
| 名前 | 説明 |
|---|---|
| なし |
| パラメーター | Description (説明) |
|---|---|
| @type | オプション。TMF オープン API 標準の一部。認定の注釈。この値は常に CheckServiceQualification です。この情報は保存されません。データタイプ:文字列 |
| checkServiceQualificationDate | オプション。認定要求が作成された日時。顧客注文 [sn_ind_tmt_orm_order] テーブルの [order_date] フィールドにあります。指定しない場合、order_dateは現在の日付と時刻に設定されます。 データタイプ:文字列 形式:YYYY-MM-DDTHH:MM:SS。SSSZの |
| 説明 | オプション。認定要求の説明。顧客注文 [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 フィールドに保持されます。 データタイプ:文字列 |
| relatedParty | 認定要求の連絡先のリスト。各連絡先はアレイ内のオブジェクトです。顧客アカウント、顧客連絡先、またはコンシューマーアカウント情報を含む少なくとも 1 つのアイテムをリストする必要があります。 データタイプ:オブジェクトのアレイ |
| relatedParty.@referredType | 関係者のタイプ。 可能な値:
データタイプ:文字列 |
| relatedParty.@type | オプション。TMF オープン API 標準の一部。注文品目連絡先の注釈。この値は常に RelatedParty です。この情報は保存されません。データタイプ:文字列 |
| relatedParty.id | 関係者のsys_idまたはexternal_id (該当する場合)。アカウント [customer_account] テーブル、連絡先 [customer_contact] テーブル、またはコンシューマー [csm_consumer] テーブルにあります。 データタイプ:文字列 |
| relatedParty.name | アカウント、顧客、またはコンシューマーの名前。 データタイプ:文字列 |
| serviceQualificationItem | 場所、サービス情報、および特性を含むサービス認定アイテムのリスト。顧客注文の注文品目として保存されます。リストに少なくとも 1 つのサービス資格アイテムが含まれている必要があります。 データタイプ:オブジェクトのアレイ |
| serviceQualificationItem.@type | オプション。TMF オープン API 標準の一部。認定アイテムの注釈。この値は常に ServiceQualificationItem です。この情報は保存されません。データタイプ:文字列 |
| serviceQualificationItem.qualificationItemRelationship | オプション。同じ要求内の他のサービス資格アイテムとの関係のリスト。この情報は、親注文品目を持つ注文品目を作成するのに役立ちます。 データタイプ:オブジェクトのアレイ |
|
serviceQualificationItem.qualificationItemRelationship.id |
必須。関係内のターゲット資格アイテムの ID。 データタイプ:文字列 |
| serviceQualificationItem.qualificationItemRelationship.relationshipType | 必須。品目関係のタイプ。 有効な値:
データタイプ:文字列 |
| serviceQualificationItem.quantity | オプション。認定アイテムの数量。顧客の注文明細品目の [数量] フィールドに保持されます。 データタイプ:数値 指定しない場合の既定値: 1 |
| serviceQualificationItem.service | 必須。場所、サービス仕様、サービス特性などの変数を含むサービス情報。 データタイプ:オブジェクト |
| serviceQualificationItem.service.@type | オプション。TMF オープン API 標準の一部。認定アイテムのサービス情報の注釈。この値は常に Service です。この情報は保存されません。データタイプ:文字列 |
| serviceQualificationItem.service.place | オプション。サービス認定アイテムの要求された場所情報。場所 [cmn_location] テーブルにあります。 注: 配列はサポートされていますが、1 つの場所のみを含める必要があります。 データタイプ:オブジェクトのアレイ |
| serviceQualificationItem.service.place.@type | オプション。TMF オープン 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 はエラーを返します。 データタイプ: オブジェクト |
| serviceQualificationItem.service.referenceServiceInventory.id | 要求で serviceQualificationItem.service.referenceServiceInventory を使用する場合は必須です。必要な場所のアクティブなサービスを参照する有効なサービスインベントリエンティティのsys_id。この情報は、注文作業メモにのみ記載されています。 データタイプ:文字列 |
| serviceQualificationItem.service.serviceCharacteristic | オプション。サービス特性のアレイ。 データタイプ:オブジェクトのアレイ |
| serviceQualificationItem.service.serviceCharacteristic.name | 必須。特性の名前。 データタイプ:文字列 |
| serviceQualificationItem.service.serviceCharacteristic.value | オプション。特性の値。TMF オープン API 標準の一部。認定アイテムの注釈。この値は常に ServiceQualificationItem です。この情報は保存されません。データタイプ:文字列 |
| serviceQualificationItem.service.serviceCharacteristic.valueType | オプション。特性の値タイプ。 データタイプ:文字列 |
| serviceQualificationItem.service.serviceInventory | オプション。アップグレードまたはダウングレードが必要なアクティブなサービスを参照する有効なサービスインベントリエンティティ。 重要: サービスのアップグレードまたはダウングレードには、 serviceInventory オブジェクトを使用します。これを行うには、要求から場所 array と referenceServiceInventory オブジェクトを省略する必要があります。省略しないと、API はエラーを返します。 データタイプ: オブジェクト
|
| serviceQualificationItem.service.serviceSpecification | 必須。認定アイテムのサービス仕様。注文品目 [sn_ind_tmt_orm_order_line_item] テーブルの顧客注文品目の service_specification フィールドに保存されます。認定アイテムのサービス仕様をリソース向けにすることはできません。 データタイプ:オブジェクト |
| serviceQualificationItem.service.serviceSpecification.@type | オプション。TMF オープン API 標準の一部。サービス仕様の注釈。この値は常に ServiceSpecification です。この情報は保存されません。データタイプ:文字列 |
| serviceQualificationItem.service.serviceSpecification.id | 必須。サービス仕様の外部 ID または初期バージョン。 データタイプ:文字列 |
| serviceQualificationItem.service.serviceSpecification.internalVersion | オプション。サービス仕様の内部バージョン。 データタイプ:数値 |
| serviceQualificationItem.service.serviceSpecification.name | 必須。サービス仕様の名前。 データタイプ:文字列 |
| serviceQualificationItem.service.serviceSpecification.version | オプション。サービス仕様の外部バージョン。 データタイプ:文字列 |
ヘッダー
次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。
| ヘッダー | 説明 |
|---|---|
| 承認 | 応答本文のデータフォーマット。サポートされるタイプ:application/json または application/xml。 デフォルト: application/json |
| Content-Type | 要求本文のデータ形式。サポートされるタイプ:application/json または application/xml。 デフォルト: application/json |
| ヘッダー | 説明 |
|---|---|
| なし |
ステータスコード
この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。
| ステータスコード | 説明 |
|---|---|
| 201 | 要求が正常に処理されました。 注: 特性または特性オプション情報に問題がある場合、エンドポイントは、既存の配送注文と同様に、関連する顧客注文明細品目レコードの作業メモフィールドに次のコメントを保存します |
| 400 | 要求が正しくありません。以下のいずれかの理由が考えられます。
|
| 500 | 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。 |
応答本文のパラメーター (JSON または XML)
| 要素 | Description (説明) |
|---|---|
| id | 認定顧客注文のSys_id。顧客注文 [sn_ind_tmt_orm_order] テーブルにあります。 データタイプ:文字列 |
| href | 認定注文レコードへの相対リンク。 データタイプ:文字列 |
| 説明 | 顧客注文の short_description フィールドからフェッチされた認定要求の説明。顧客注文 [sn_ind_tmt_orm_order] テーブルにあります。 データタイプ:文字列 |
| externalId | 顧客注文の [external_id] フィールドの外部 ID。顧客注文 [sn_ind_tmt_orm_order] テーブルにあります。 データタイプ:文字列 |
| 認定結果 | 顧客注文の結果フィールドの認定ステータス。可能な値:
データタイプ:文字列 |
| state | 顧客注文のステータスフィールドにある顧客注文のステータス。 データタイプ:文字列 |
| @type | TMF オープン API 標準の一部。認定の注釈。この値は常に CheckServiceQualification です。この情報は保存されません。データタイプ:文字列 |
| checkServiceQualificationDate | 顧客注文のorder_dateフィールドから作成された認定要求の日時。顧客注文 [sn_ind_tmt_orm_order] テーブルにあります。 形式:YYYY-MM-DDTHH:MM:SS。SSSZの データタイプ:文字列 |
| 有効資格日 | 顧客注文の order_date フィールドからフェッチされた有効な認定日。顧客注文 [sn_ind_tmt_orm_order] テーブルにあります。 形式:YYYY-MM-DDTHH:MM:SS。SSSZの データタイプ:文字列 |
| expectedQualificationDate | 予定されている認定日を保存します。顧客注文のexpected_end_dateフィールドに保持されます。顧客注文 [sn_ind_tmt_orm_order] テーブルにあります。 形式:YYYY-MM-DDTHH:MM:SS。SSSZの データタイプ:文字列 |
| relatedParty | 認定要求の連絡先のリスト。各連絡先はアレイ内のオブジェクトです。 データタイプ:オブジェクトのアレイ |
| relatedParty.id | 注文に関連付けられたアカウント、顧客の連絡先、またはコンシューマーのSys_idまたはexternal_id。アカウント [customer_account] テーブル、連絡先 [customer_contact] テーブル、またはコンシューマー [csm_consumer] テーブルにあります。 データタイプ:文字列 |
| relatedParty.name | アカウント、顧客、またはコンシューマーの名前。 データタイプ:文字列 |
| relatedParty.@type | TMF オープン API 標準の一部。注文品目連絡先の注釈。この値は常に RelatedParty です。この情報は保存されません。データタイプ:文字列 |
| relatedParty.@referredType | 関係者のタイプ。 可能な値:
データタイプ:文字列 |
| serviceQualificationItem | 場所、サービス情報、およびサービスの特性に関する情報を含むサービス認定アイテムのリスト。顧客注文の注文品目として保存されます。 データタイプ:オブジェクトのアレイ |
| 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 オープン API 標準の一部。認定アイテムの注釈。この値は常に ServiceQualificationItem です。この情報は保存されません。 データタイプ:文字列 |
| serviceQualificationItem.service | 場所 (場所)、サービスの仕様、サービスの特性に関する詳細を含むサービス情報。 データタイプ: オブジェクト |
| serviceQualificationItem.service.@type | TMF Open API 標準の一部。サービスの注釈。この値は常に Service です。この情報は保存されません。 データタイプ:文字列 |
| serviceQualificationItem.service.place | サービス資格アイテムの場所情報。 データタイプ:オブジェクトのアレイ 注: この配列には、1 つの場所のみを含めることができます。 |
serviceQualificationItem.service.place.id |
場所 [cmn_location] テーブル内の場所のSys_id。 データタイプ:文字列 |
| serviceQualificationItem.service.place.name | 場所の名前。場所 [cmn_location] テーブルのエントリに対して検証されていません。 データタイプ:文字列 |
| serviceQualificationItem.service.place.@type | TMF オープン API 標準の一部。サービスの注釈。この値は常に GeographicSite です。この情報は保存されません。データタイプ:文字列 |
| serviceQualificationItem.service.serviceSpecification | 認定アイテムのサービス仕様の詳細。 データタイプ:オブジェクトのアレイ |
| serviceQualificationItem.service.serviceSpecification.id | サービス仕様の外部 ID または初期バージョン。 データタイプ:文字列 |
| serviceQualificationItem.service.serviceSpecification.name | サービス仕様の名前。 データタイプ:文字列 |
| serviceQualificationItem.service.serviceSpecification.version | サービス仕様の外部バージョン。 データタイプ:文字列 |
| serviceQualificationItem.service.serviceSpecification.internalVersion | サービス仕様の内部バージョン。 データタイプ:数値 |
| serviceQualificationItem.service.serviceSpecification.internalId | サービス仕様の初期バージョン。 データタイプ:文字列 |
| serviceQualificationItem.service.serviceSpecification.@type | TMF オープン API 標準の一部。サービス仕様の注釈。この値は常に ServiceSpecification です。この情報は保存されません。データタイプ:文字列 |
| serviceQualificationItem.service.serviceCharacteristic | サービス特性のリスト。 データタイプ:オブジェクトのアレイ |
| 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 を使用して簡単なサービス資格を要求し、既存のサービスで顧客の場所を取得する方法を示しています。
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"
}
応答。 place は要求内の referenceServiceInventory から入力されます。
{
"id": "1683497138b35110f877c8d44c4b890a",
"href":"/api/sn_ord_qual_mgmt/qualification/checkServiceQualification/1683497138b35110f877c8d44c4b890a",
"description": "check service qualification illustration",
"externalId": "CSQ1",
"qualificationResult": "none",
"state": "new",
"@type": "CheckServiceQualification",
"checkServiceQualificationDate": "2022-12-14T23:44:44.000Z",
"relatedParty": [
{
"id": "eaf68911c35420105252716b7d40ddde",
"name": "Sally Thomas",
"@type": "RelatedParty",
"@referredType": "CustomerContact"
},
{
"id": "ffc68911c35420105252716b7d40dd55",
"name": "Funco Intl",
"@type": "RelatedParty",
"@referredType": "Customer"
},
{
"id": "59f16de1c3b67110ff00ed23a140dd9e",
"name": "Funco External",
"@type": "RelatedParty",
"@referredType": "Consumer"
}
],
"serviceQualificationItem": [
{
"id": "100",
"qualificationResult": "none",
"state": "new",
"quantity": "1",
"@type": "ServiceQualificationItem",
"service": {
"@type": "Service",
"serviceCharacteristic": [
{
"name": "Speed",
"valueType": "choice",
"value": "High"
}
],
"serviceSpecification": {
"id": "91478553b7969910ff00f203ae11a97d",
"name": "Broadband Service",
"version": "",
"internalVersion": "1",
"internalId": "91478553b7969910ff00f203ae11a97d",
"@type": "ServiceSpecification"
},
"place": {
"id": "25aba4010a0a0bb3008f329002f12211",
"name": "20220 Bow Willow, Houston,TX",
"@referredType": "GeographicSite"
}
}
}
],
"effectiveQualificationDate": "2022-12-14T23:44:44.000Z",
"expectedQualificationDate": "2023-10-11T15:20:39.000Z"
}
ユースケース 3
次の例は、ユーザーのブロードバンド サービスを高速にアップグレードする方法を示しています。ID = のサービスインベントリは、サービス仕様 = 'ブロードバンドサービス'、場所 = 20220 Bow Willow, Houston, TX, Characteristics=[{Speed:Medium}] の製品インベントリです。
{
"description": "check service qualification illustration",
"checkServiceQualificationDate": "2022-12-14T23:44:44.000Z",
"effectiveQualificationDate": "2023-12-14T23:44:44.000Z",
"expectedQualificationDate": "2023-10-11T15:20:39.000Z",
"externalId": "CSQ1",
"relatedParty": [
{
"id": "eaf68911c35420105252716b7d40ddde",
"name": "Sally Thomas",
"@type": "RelatedParty",
"@referredType": "CustomerContact"
},
{
"id": "ffc68911c35420105252716b7d40dd55",
"name": "Funco Intl",
"@type": "RelatedParty",
"@referredType": "Customer"
},
{
"id": "59f16de1c3b67110ff00ed23a140dd9e",
"name": "Funco External",
"@type": "RelatedParty",
"@referredType": "Consumer"
}
],
"serviceQualificationItem": [
{
"id": "100",
"service": {
"@type": "Service",
"serviceInventory": {
"id": "f1b2d99e777301108e191e599a5a99d2"
},
"serviceCharacteristic": [
{
"valueType": "choice",
"name": "Speed",
"value": "High"
}
]
},
"@type": "ServiceQualificationItem"
}
],
"@type": "CheckServiceQualification"
}
{
"id": " db8485b138b35110f877c8d44c4b892b",
"href": "/api/sn_ord_qual_mgmt/qualification/checkServiceQualification/ db8485b138b35110f877c8d44c4b892b",
"description": "check service qualification illustration",
"externalId": "CSQ1",
"qualificationResult": "none",
"state": "new",
"@type": "CheckServiceQualification",
"checkServiceQualificationDate": "2022-12-14T23:44:44.000Z",
"relatedParty": [
{
"id": "eaf68911c35420105252716b7d40ddde",
"name": "Sally Thomas",
"@type": "RelatedParty",
"@referredType": "CustomerContact"
},
{
"id": "ffc68911c35420105252716b7d40dd55",
"name": "Funco Intl",
"@type": "RelatedParty",
"@referredType": "Customer"
},
{
"id": "59f16de1c3b67110ff00ed23a140dd9e",
"name": "Funco External",
"@type": "RelatedParty",
"@referredType": "Consumer"
}
],
"serviceQualificationItem": [
{
"id": "100",
"qualificationResult": "none",
"state": "new",
"quantity": "1",
"@type": "ServiceQualificationItem",
"service": {
"@type": "Service",
"serviceCharacteristic": [
{
"name": "Speed",
"valueType": "choice",
"value": "High"
}
],
"serviceSpecification": {
"id": "91478553b7969910ff00f203ae11a97d",
"name": "Broadband Service",
"version": "",
"internalVersion": "1",
"internalId": "91478553b7969910ff00f203ae11a97d",
"@type": "ServiceSpecification"
},
"place": {
"id": "25aba4010a0a0bb3008f329002f12211",
"name": "20220 Bow Willow, Houston,TX",
"@referredType": "GeographicSite"
}
}
}
],
"effectiveQualificationDate": "2022-12-14T23:44:44.000Z",
"expectedQualificationDate": "2023-10-11T15:20:39.000Z"
}
ユースケース 4
親と子の品目とその関係タイプの階層について説明します。quantity [数量] 属性を使用して複数の広告申込情報を作成する方法を示します。
curl -X POST "https://instance.service-now.com/api/sn_ord_qual_mgmt/qualification/checkServiceQualification " \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-u "username":"password" \
-d {
"description": "check service qualification illustration",
"checkServiceQualificationDate": "2022-12-14T23:44:44.000Z",
"effectiveQualificationDate": "2023-12-14T23:44:44.000Z",
"expectedQualificationDate": "2023-10-11T15:20:39.000Z",
"externalId": "CSQ1",
"relatedParty": [
{
"id": "eaf68911c35420105252716b7d40ddde",
"name": "Sally Thomas",
"@type": "RelatedParty",
"@referredType": "CustomerContact"
},
{
"id": "ffc68911c35420105252716b7d40dd55",
"name": "Funco Intl",
"@type": "RelatedParty",
"@referredType": "Customer"
},
{
"id": "59f16de1c3b67110ff00ed23a140dd9e",
"name": "Funco External",
"@type": "RelatedParty",
"@referredType": "Consumer"
}
],
"serviceQualificationItem": [
{
"id": "100",
"quantity": 2,
"qualificationItemRelationship": [
{
"relationshipType": "HasChild",
"id": "110"
},
{
"relationshipType": "HasChild",
"id": "120"
},
{
"relationshipType": "HasChild",
"id": "130"
}
],
"service": {
"@type": "Service",
"place": [
{
"id": "5671dd2ec3a53010188473ce3640dd81",
"name": "Jean Pontus home",
"@referredType": "GeographicSite"
}
],
"serviceCharacteristic": [
{
"valueType": "string",
"name": "Speed",
"value": "High"
}
],
"serviceSpecification": {
"id": "b3933d9d45f31150f877e0588eca21fc",
"name": "Access Service"
}
},
"@type": "ServiceQualificationItem"
},
{
"id": "110",
"action": "add",
"expectedServiceAvailabilityDate": "2022-12-10T19:20:39.239Z",
"qualificationItemRelationship": [
{
"relationshipType": "HasParent",
"id": "100"
}
],
"service": {
"@type": "Service",
"place": [
{
"id": "5671dd2ec3a53010188473ce3640dd81",
"name": "Jean Pontus home",
"@referredType": "GeographicSite"
}
],
"serviceCharacteristic": [
{
"valueType": "choice",
"name": "Fiber Speed",
"value": "1Gbps"
}
],
"serviceSpecification": {
"name": "CFS3",
"internalVersion": "1",
"id": "4d2b5799457b1150f877e0588eca2116"
},
"state": "new"
},
"@type": "ServiceQualificationItem"
},
{
"id": "120",
"action": "add",
"qualificationItemRelationship": [
{
"relationshipType": "HasParent",
"id": "100"
}
],
"expectedServiceAvailabilityDate": "2022-11-12T19:20:39.239Z",
"service": {
"@type": "Service",
"place": [
{
"id": "5671dd2ec3a53010188473ce3640dd81",
"name": "Jean Pontus home",
"@referredType": "GeographicSite"
}
],
"serviceCharacteristic": [
{
"valueType": "choice",
"name": "DSL Speed",
"value": "500 Mbps"
}
],
"serviceSpecification": {
"name": "CF1",
"internalVersion": "1",
"id": "1d43f91d45f31150f877e0588eca21cd"
},
"state": "new"
},
"@type": "ServiceQualificationItem"
},
{
"id": "130",
"action": "add",
"expectedServiceAvailabilityDate": "2020-04-11T19:20:39.239Z",
"qualificationItemRelationship": [
{
"relationshipType": "HasParent",
"id": "100"
}
],
"service": {
"@type": "Service",
"place": [
{
"id": "5671dd2ec3a53010188473ce3640dd81",
"name": "Jean Pontus home",
"@referredType": "GeographicSite"
}
],
"serviceCharacteristic": [
{
"valueType": "choice",
"name": "Wireless Speed",
"value": "100 Mbps"
}
],
"serviceSpecification": {
"name": "CFS2",
"internalVersion": "1",
"id": "28733d1d45f31150f877e0588eca2163"
},
"state": "new"
},
"@type": "ServiceQualificationItem"
}
],
"@type": "CheckServiceQualification"
}
応答:
{
"id": "7bf9cd7538b35110f877c8d44c4b89e4",
"href": "/api/sn_ord_qual_mgmt/qualification/checkServiceQualification/7bf9cd7538b35110f877c8d44c4b89e4",
"description": "check service qualification illustration",
"externalId": "CSQ1",
"qualificationResult": "none",
"state": "new",
"@type": "CheckServiceQualification",
"checkServiceQualificationDate": "2022-12-14T23:44:44.000Z",
"relatedParty": [
{
"id": "eaf68911c35420105252716b7d40ddde",
"name": "Sally Thomas",
"@type": "RelatedParty",
"@referredType": "CustomerContact"
},
{
"id": "ffc68911c35420105252716b7d40dd55",
"name": "Funco Intl",
"@type": "RelatedParty",
"@referredType": "Customer"
},
{
"id": "59f16de1c3b67110ff00ed23a140dd9e",
"name": "Funco External",
"@type": "RelatedParty",
"@referredType": "Consumer"
}
],
"serviceQualificationItem": [
{
"id": "120",
"qualificationResult": "none",
"state": "new",
"quantity": "1",
"@type": "ServiceQualificationItem",
"service": {
"@type": "Service",
"serviceCharacteristic": [
{
"name": "DSL Speed",
"valueType": "choice",
"value": "500 Mbps"
}
],
"serviceSpecification": {
"id": "1d43f91d45f31150f877e0588eca21cd",
"name": "CFS1",
"version": "",
"internalVersion": "1",
"internalId": "1d43f91d45f31150f877e0588eca21cd",
"@type": "ServiceSpecification"
},
"place": {
"id": "5671dd2ec3a53010188473ce3640dd81",
"name": "3000 Main Street, Santa Clara, CA",
"@referredType": "GeographicSite"
}
}
},
{
"id": "110",
"qualificationResult": "none",
"state": "new",
"quantity": "1",
"@type": "ServiceQualificationItem",
"service": {
"@type": "Service",
"serviceCharacteristic": [
{
"name": "Fiber Speed",
"valueType": "choice",
"value": "1Gbps"
}
],
"serviceSpecification": {
"id": "4d2b5799457b1150f877e0588eca2116",
"name": "CFS3",
"version": "",
"internalVersion": "1",
"internalId": "4d2b5799457b1150f877e0588eca2116",
"@type": "ServiceSpecification"
},
"place": {
"id": "5671dd2ec3a53010188473ce3640dd81",
"name": "3000 Main Street, Santa Clara, CA",
"@referredType": "GeographicSite"
}
}
},
{
"id": "130",
"qualificationResult": "none",
"state": "new",
"quantity": "1",
"@type": "ServiceQualificationItem",
"service": {
"@type": "Service",
"serviceCharacteristic": [
{
"name": "Wireless Speed",
"valueType": "choice",
"value": "100 Mbps"
}
],
"serviceSpecification": {
"id": "28733d1d45f31150f877e0588eca2163",
"name": "CFS2",
"version": "",
"internalVersion": "1",
"internalId": "28733d1d45f31150f877e0588eca2163",
"@type": "ServiceSpecification"
},
"place": {
"id": "5671dd2ec3a53010188473ce3640dd81",
"name": "3000 Main Street, Santa Clara, CA",
"@referredType": "GeographicSite"
}
}
},
{
"id": "100",
"qualificationResult": "none",
"state": "new",
"quantity": "2",
"@type": "ServiceQualificationItem",
"service": {
"@type": "Service",
"serviceCharacteristic": [
{
"name": "Speed",
"valueType": "choice",
"value": "High"
}
],
"serviceSpecification": {
"id": "b3933d9d45f31150f877e0588eca21fc",
"name": "Access Service",
"version": "",
"internalVersion": "1",
"internalId": "b3933d9d45f31150f877e0588eca21fc",
"@type": "ServiceSpecification"
},
"place": {
"id": "5671dd2ec3a53010188473ce3640dd81",
"name": "3000 Main Street, Santa Clara, CA",
"@referredType": "GeographicSite"
}
}
}
],
"effectiveQualificationDate": "2023-12-14T23:44:44.000Z",
"expectedQualificationDate": "2023-10-11T15:20:39.000Z"
}
テクニカルサービス認定オープン API - POST sn_ord_qual_mgmt/qualification/checkServiceQualification/processResult
プロセステクニカルサービス認定オープン API に送信されるテクニカルサービスの認定結果。
URL 形式
バージョン管理された URL: /api/sn_ord_qual_mgmt/qualification/checkServiceQualification/processResult
サポートされている要求パラメーター
| 名前 | 説明 |
|---|---|
| api_version | オプションアクセスするエンドポイントのバージョン。たとえば、v1 や v2。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ:文字列 |
| 名前 | 説明 |
|---|---|
| なし |
| パラメーター | Description (説明) |
|---|---|
| serviceQualificationItem | 必須。要求された上位注文明細品目のサービス注文テーブル [sn_ind_tmt_orm_service_order] でドメイン注文を表すサービス資格認定アイテムのリスト。各サービス資格品目によって表されるすべてのドメイン注文は、同じ最上位注文品目に属している必要があります。 データタイプ:オブジェクトのアレイ |
| serviceQualificationItem.@type | オプション。TMF オープン API 標準の一部。認定アイテムの注釈。この値は常に ServiceQualificationItem です。この情報は保存されません。データタイプ:文字列 |
| serviceQualificationItem.alternateProposal | オプション。認定アイテムに提供される代替提案。代替案 [sn_ord_qual_mgmt_alternate_proposal] テーブルに保存されます。 データタイプ:オブジェクトのアレイ |
| serviceQualificationItem.alternateProposal.@type | オプション。TMF オープン API 標準の一部。認定アイテムのサービス情報の注釈。この値は常に Service です。この情報は保存されません。データタイプ:文字列 |
| serviceQualificationItem.alternateProposal.alternateService | 必須。サービスの仕様と特性を含む代替提案のサービス情報。 データタイプ: オブジェクト |
| serviceQualificationItem.alternateProposal.alternateService.alternateService.serviceCharacteristic.valueType | 代替サービス提案の特性の値タイプ。 データタイプ:文字列 |
| serviceQualificationItem.alternateProposal.alternateService.serviceCharacteristic | 代替サービス提案のサービス特性のアレイ。代替提案テーブル [sn_ord_qual_mgmt_alternate_proposal] の「order_characteristics」フィールドに文字列として保存されます。 データタイプ:オブジェクトのアレイ |
| serviceQualificationItem.alternateProposal.alternateService.serviceCharacteristic.name | 必須。代替サービス提案に属する特性の名前。 データタイプ:文字列 |
| serviceQualificationItem.alternateProposal.alternateService.serviceCharacteristic.value | 代替サービス提案に属する特性の値。 データタイプ:文字列 |
| serviceQualificationItem.alternateProposal.alternateService .serviceSpecification | 必須。代替提案のサービス仕様。代替提案 [sn_ord_qual_mgmt_alternate_proposal] テーブルの代替提案エントリの仕様フィールドに保存されます。 データタイプ:オブジェクト |
| serviceQualificationItem.alternateProposal.alternateService .serviceSpecification.@type | TMF オープン 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 | オプション。代替サービス利用可能日。代替提案テーブル [sn_ord_qual_mgmt_alternate_proposal] の「available_date」フィールドにあり、ドメイン注文情報は、現在のサービス資格アイテムによって表されるドメイン注文に属しています。 形式:YYYY-MM-DDTHH:MM:SS。SSSZの データタイプ:文字列 |
| serviceQualificationItem.alternateProposal.id | オプション。代替案のユーザー定義 ID。このデータは保持されません。 データタイプ:文字列 |
| serviceQualificationItem.eligibilityUnavailabilityReason | オプション。サービス資格が不適格である理由。理由のリスト全体は、ドメイン注文 [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 ヘッダー」を参照してください。
| ヘッダー | 説明 |
|---|---|
| 承認 | 応答本文のデータフォーマット。サポートされるタイプ:application/json または application/xml。 デフォルト: application/json |
| ヘッダー | 説明 |
|---|---|
| なし |
ステータスコード
この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。
| ステータスコード | 説明 |
|---|---|
| 201 | 成功。要求が正常に処理されました。 |
| 400 | 要求が正しくありません。以下のいずれかの理由が考えられます。
|
応答本文のパラメーター (JSON または XML)
| 名前 | 説明 |
|---|---|
| id | 認定顧客注文のSys_id。顧客注文 [sn_ind_tmt_orm_order] テーブルにあります。 データタイプ:文字列 |
| href | 認定注文レコードへの相対リンク。 データタイプ:文字列 |
| 説明 | 顧客注文の short_description フィールドからフェッチされた認定要求の説明。顧客注文 [sn_ind_tmt_orm_order] テーブルにあります。 データタイプ:文字列 |
| externalId | 顧客注文の [external_id] フィールドの外部 ID。顧客注文 [sn_ind_tmt_orm_order] テーブルにあります。 データタイプ:文字列 |
| 認定結果 | 顧客注文の結果フィールドの認定ステータス。可能な値:
データタイプ:文字列 |
| state | 顧客注文のステータスフィールドにある顧客注文のステータス。 データタイプ:文字列 |
| @type | TMF オープン API 標準の一部。認定の注釈。この値は常に CheckServiceQualification です。この情報は保存されません。データタイプ:文字列 |
| checkServiceQualificationDate | 顧客注文のorder_dateフィールドから作成された認定要求の日時。顧客注文 [sn_ind_tmt_orm_order] テーブルにあります。 形式:YYYY-MM-DDTHH:MM:SS。SSSZの データタイプ:文字列 |
| 有効資格日 | 顧客注文の order_date フィールドからフェッチされた有効な認定日。顧客注文 [sn_ind_tmt_orm_order] テーブルにあります。 形式:YYYY-MM-DDTHH:MM:SS。SSSZの データタイプ:文字列 |
| expectedQualificationDate | 予定されている認定日を保存します。顧客注文のexpected_end_dateフィールドに保持されます。顧客注文 [sn_ind_tmt_orm_order] テーブルにあります。 形式:YYYY-MM-DDTHH:MM:SS。SSSZの データタイプ:文字列 |
| relatedParty | 認定要求の連絡先のリスト。各連絡先はアレイ内のオブジェクトです。 データタイプ:オブジェクトのアレイ |
| relatedParty.id | 注文に関連付けられたアカウント、顧客の連絡先、またはコンシューマーのSys_idまたはexternal_id。アカウント [customer_account] テーブル、連絡先 [customer_contact] テーブル、またはコンシューマー [csm_consumer] テーブルにあります。 データタイプ:文字列 |
| relatedParty.name | アカウント、顧客、またはコンシューマーの名前。 データタイプ:文字列 |
| relatedParty.@type | TMF オープン API 標準の一部。注文品目連絡先の注釈。この値は常に RelatedParty です。この情報は保存されません。データタイプ:文字列 |
| relatedParty.@referredType | 関係者のタイプ。 可能な値:
データタイプ:文字列 |
| serviceQualificationItem | 場所、サービス情報、およびサービスの特性に関する情報を含むサービス認定アイテムのリスト。顧客注文の注文品目として保存されます。 データタイプ:オブジェクトのアレイ |
| 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 オープン API 標準の一部。認定アイテムの注釈。この値は常に ServiceQualificationItem です。この情報は保存されません。 データタイプ:文字列 |
| serviceQualificationItem.service | 場所 (場所)、サービスの仕様、サービスの特性に関する詳細を含むサービス情報。 データタイプ: オブジェクト |
| serviceQualificationItem.service.@type | TMF Open API 標準の一部。サービスの注釈。この値は常に Service です。この情報は保存されません。 データタイプ:文字列 |
| serviceQualificationItem.service.place | サービス資格アイテムの場所情報。 データタイプ:オブジェクトのアレイ 注: この配列には、1 つの場所のみを含めることができます。 |
serviceQualificationItem.service.place.id |
場所 [cmn_location] テーブル内の場所のSys_id。 データタイプ:文字列 |
| serviceQualificationItem.service.place.name | 場所の名前。場所 [cmn_location] テーブルのエントリに対して検証されていません。 データタイプ:文字列 |
| serviceQualificationItem.service.place.@type | TMF オープン API 標準の一部。サービスの注釈。この値は常に GeographicSite です。この情報は保存されません。データタイプ:文字列 |
| serviceQualificationItem.service.serviceSpecification | 認定アイテムのサービス仕様の詳細。 データタイプ:オブジェクトのアレイ |
| serviceQualificationItem.service.serviceSpecification.id | サービス仕様の外部 ID または初期バージョン。 データタイプ:文字列 |
| serviceQualificationItem.service.serviceSpecification.name | サービス仕様の名前。 データタイプ:文字列 |
| serviceQualificationItem.service.serviceSpecification.version | サービス仕様の外部バージョン。 データタイプ:文字列 |
| serviceQualificationItem.service.serviceSpecification.internalVersion | サービス仕様の内部バージョン。 データタイプ:数値 |
| serviceQualificationItem.service.serviceSpecification.internalId | サービス仕様の初期バージョン。 データタイプ:文字列 |
| serviceQualificationItem.service.serviceSpecification.@type | TMF オープン API 標準の一部。サービス仕様の注釈。この値は常に ServiceSpecification です。この情報は保存されません。データタイプ:文字列 |
| serviceQualificationItem.service.serviceCharacteristic | サービス特性のリスト。 データタイプ:オブジェクトのアレイ |
| serviceQualificationItem.service.serviceCharacteristic.valueType | 特性の値タイプ。 データタイプ:文字列 |
| serviceQualificationItem.service.serviceCharacteristic.name | 特性の名前。 データタイプ:文字列 |
| serviceQualificationItem.service.serviceCharacteristic.value | 特性の値。 データタイプ:文字列 |
| ServiceQualificationItem.alternateServiceProposal | 認定注文の代替サービス提案。代替案は、代替案 [sn_ord_qual_mgmt_alternate_proposal] テーブルに保存されます。 データタイプ:文字列 |
| ServiceQualificationItem.alternateServiceProposal.id | 代替提案 [sn_ord_qual_mgmt_alternate_proposal] テーブルの代替提案エントリのSys_id。 データタイプ:文字列 |
| ServiceQualificationItem.alternateServiceProposal.alternateServiceAvailabilityDate | 代替提案 [sn_ord_qual_mgmt_alternate_proposal] テーブルの代替提案エントリのavailable_dateフィールド値。 データタイプ:文字列 |
| serviceQualificationItem.alternateServiceProposal.alternateService | 代替案で表されるサービス情報。 データタイプ: Object |
| 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 オープン API 標準の一部。サービス仕様の注釈。この値は常に ServiceSpecification です。この情報は保存されません。データタイプ:文字列 |
| serviceQualificationItemです。alternateServiceProposal.alternateService.serviceCharacteristic | 代替サービス提案のサービス特性のアレイ。 データタイプ:オブジェクトのアレイ |
| serviceQualificationItemです。alternateServiceProposal.alternateService.serviceCharacteristic.valueType | 代替サービス特性の値タイプ。 データタイプ:文字列 |
| serviceQualificationItemです。alternateServiceProposal.alternateService.serviceCharacteristic.name | 代替サービス特性の名前。 データタイプ:文字列 |
| serviceQualificationItemです。alternateServiceProposal.alternateService.serviceCharacteristic.value | 代替サービス特性の値。 データタイプ:文字列 |
| serviceQualificationItem.eligibilityUnavailabilityReason | サービスが利用できない理由を説明する、サービス適格性利用不可の理由のリスト。この値はunavailability_reasonドメイン注文 [sn_ind_tmt_orm_domain_order] テーブルのフィールドに保持されます。 データタイプ:アレイ |
| 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"
}