Technische Servicequalifizierung – Open API

Freigeben Version: Xanadu

Aktualisiert 1. August 2024

43 Minuten Lesedauer

Die offene API für die technische Servicequalifizierung bietet Endpunkte, um die Verfügbarkeit von Ressourcen und Services zu überprüfen, bevor Aufträge zur Erfüllung gesendet werden.

Diese API ist eine ServiceNow -Implementierung der REST-Spezifikation TMF645-Servicequalifizierungs-API. Weitere Informationen zu Servicequalifizierungsanforderungen finden Sie unter Service qualification requests.

Die Open API für die technische Servicequalifizierung wird im Namespace sn_ord_qual_mgmt bereitgestellt und erfordert die folgenden Plugins:

Product Catalog Management Core [com.sn_prd_pm]
Product Catalog Advanced [com.sn_prd_pm_adv]
Auftragsqualifizierungsmanagement [com.sn_ord_qual_mgmt]
Order Management for Telecom, Media & Tech [com.sn_tmt_core]
Telecom Core [com.sn_tmt_core]

Zur Verwendung dieser API ist die Rolle sn_ind_tmt_orm.order_integrator erforderlich.

Open API für technische Servicequalifizierung – GET sn_ord_qual_mgmt/qualification/checkServiceQualification/{id}

Ruft eine technische Qualifizierungsanforderung ab, die einer bestimmten Kundenauftrags-ID zugeordnet ist.

Dieser Endpunkt ruft Bestellinformationen aus den folgenden Tabellen ab:

Kundenbestellung [sn_ind_tmt_orm_order]
Bestellposition [sn_ind_tmt_orm_order_line_item]

URL-Format

URL mit Versionsnummer: /api/sn_ord_qual_mgmt/qualification/checkServiceQualification/{id}

Unterstützte Anforderungsparameter

Tabelle : 1. Pfadparameter
Name	Beschreibung
api_version	Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel `v1` oder `v2`. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge
id	Sys_id des abzurufenden Qualifizierungs-Kundenauftrags. Befindet sich in der Tabelle „Kundenauftrag“ [sn_ind_tmt_orm_order]. Datentyp: Zeichenfolge

Tabelle : 2. Abfrageparameter
Name	Beschreibung
Keine

Tabelle : 3. Anforderungstextparameter (XML oder JSON)
Name	Beschreibung
Keine

Kopfzeilen

Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST API-Header.

Tabelle : 4. Anforderungskopfzeilen
Kopfzeile	Beschreibung
Akzeptieren	Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json

Tabelle : 5. Antwortkopfzeilen
Kopfzeile	Beschreibung
Keine

Statuscodes

Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter HTTP-Antwortcodesder REST-API.

Tabelle : 6. Statuscodes

200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
400	Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt.
404	Nicht gefunden. Das angeforderte Element wurde nicht gefunden.

Parameter des Antworttexts (JSON oder XML)


Name	Beschreibung
id	Sys_id des Qualifizierungskundenauftrags. Befindet sich in der Tabelle „Kundenauftrag“ [sn_ind_tmt_orm_order]. Datentyp: Zeichenfolge
href	Relativer Link zum Qualifizierungsreihenfolge-Datensatz. Datentyp: Zeichenfolge
Beschreibung	Beschreibung der Qualifizierungsanforderung, die aus dem Feld „short_description“ des Kundenauftrags abgerufen wird. Befindet sich in der Tabelle „Kundenauftrag“ [sn_ind_tmt_orm_order]. Datentyp: Zeichenfolge
externalId	Externe ID aus dem Feld „external_id“ des Kundenauftrags Befindet sich in der Tabelle „Kundenauftrag“ [sn_ind_tmt_orm_order]. Datentyp: Zeichenfolge
Qualifizierungsergebnis	Qualifizierungsstatus des Ergebnisfelds des Kundenauftrags Mögliche Werte: Alternative Keine Ausstehend Qualifiziert nicht qualifiziert Datentyp: Zeichenfolge
Staat	Status des Kundenauftrags aus dem Statusfeld des Kundenauftrags. Datentyp: Zeichenfolge
@type	Teil des TMF Open API-Standards. Anmerkung für die Qualifizierung. Dieser Wert ist immer `CheckServiceQualification`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
checkServiceQualificationDate	Datum und Uhrzeit der Qualifizierungsanforderung, die aus dem Feld „order_date“ des Kundenauftrags erstellt wurde. Befindet sich in der Tabelle „Kundenauftrag“ [sn_ind_tmt_orm_order]. Format: JJJJ-MM-TTTHH:MM:SS.SSZZ Datentyp: Zeichenfolge
effektivQualifizierungsdatum	Gültigkeitsdatum der Qualifizierung, abgerufen aus dem Feld „order_date“ des Kundenauftrags. Befindet sich in der Tabelle „Kundenauftrag“ [sn_ind_tmt_orm_order]. Format: JJJJ-MM-TTTHH:MM:SS.SSZZ Datentyp: Zeichenfolge
erwartetes Qualifizierungsdatum	Speichert das erwartete Qualifizierungsdatum. Im Feld „expected_end_date“ des Kundenauftrags beibehalten Befindet sich in der Tabelle „Kundenauftrag“ [sn_ind_tmt_orm_order]. Format: JJJJ-MM-TTTHH:MM:SS.SSZZ Datentyp: Zeichenfolge
Zugehörige Partei	Liste der Kontakte für die Qualifizierungsanforderung. Jeder Kontakt ist ein Objekt im Array. Datentyp: Array von Objekten `"relatedParty": [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ]`
Zugehörigepartei.id	Sys_id oder external_id des Accounts, Kundenkontakts oder Verbrauchers, der dem Auftrag zugeordnet ist. Zu finden in der Tabelle „Account“ [customer_account], „Kontakt“ [customer_contact] oder „Verbraucher“ [csm_consumer]. Datentyp: Zeichenfolge
Zugehörigepartei.name	Name des Accounts, Kunden oder Verbrauchers. Datentyp: Zeichenfolge
zugehörigepartei.@typ	Teil des TMF Open API-Standards. Anmerkung für den Kontakt des Bestellpositionselements. Dieser Wert ist immer `RelatedParty`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
zugehörigepartei.@referenztyp	Typ der zugehörigen Partei. Mögliche Werte: Verbraucher Kunde Kundenkontakt Datentyp: Zeichenfolge
serviceQualificationItem	Liste der Servicequalifizierungselemente mit Informationen zu Standort, Serviceinformationen und Servicemerkmalen. Werden als Bestellpositionen für den Kundenauftrag gespeichert. Datentyp: Array von Objekten `"serviceQualificationItem": [ { "id": "String", "action": "String", "expectedServiceAvailabilityDate": "Number", "service": {Object}, "@type": "String" } ],`
serviceQualificationItem.id	ID des Qualifizierungselements. Wird im Feld „external_id“ der Kundenauftragsposition in der Tabelle „Auftragspositionselement“ [sn_ind_tmt_orm_order_line_item] gespeichert. Datentyp: Zeichenfolge
serviceQualifikationselement.qualifizierungsergebnis	Ergebnis des Qualifizierungselements. Wird im Feld „Ergebnis“ der Kundenauftragsposition gespeichert. Befindet sich in der Tabelle „Auftragspositionselement“ [sn_ind_tmt_orm_order_line_item]. Mögliche Werte: Alternative Keine Ausstehend Qualifiziert nicht qualifiziert Datentyp: Zeichenfolge
serviceQualifikationselement.status	Status des Qualifizierungselements, der aus dem Feld „Status“ der Kundenauftragsposition abgeleitet wird. Befindet sich in der Tabelle „Auftragspositionselement“ [sn_ind_tmt_orm_order_line_item]. Datentyp: Zeichenfolge
serviceQualificationItem.menge	Menge des Qualifizierungsartikels, abgeleitet aus dem Feld „Menge“ der Kundenauftragsposition. Befindet sich in der Tabelle „Auftragspositionselement“ [sn_ind_tmt_orm_order_line_item]. Datentyp: Zahl
serviceQualificationItem.@type	Teil des TMF Open API-Standards. Anmerkung für das Qualifizierungselement. Dieser Wert ist immer ServiceQualificationItem. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
serviceQualificationItem.service	Serviceinformationen, die Details zu Standort (Ort), Servicespezifikationen und Servicemerkmalen enthalten. Datentyp: Objekt `"service": { "@type": "String", "place": [Array], "serviceCharacteristic": [Array], "serviceSpecification": {Object} }`
serviceQualifikationselement.service.@type	Teil des API-Standards TMF Open. Anmerkung für den Service. Dieser Wert ist immer `Service`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
serviceQualifikationsElement.service.Ort	Standortinformationen für das Servicequalifizierungselement. Datentyp: Array von Objekten Hinweis: Dieses Array kann nur einen Ort enthalten. `"place": [ { "id": "String", "name": "String", "@referredType": "String" } ]`
serviceQualificationItem.service.place.id	Sys_id eines Standorts in der Standorttabelle [cmn_location]. Datentyp: Zeichenfolge
serviceQualificationItem.service.place.name	Name des Standorts. Nicht anhand eines Eintrags in der Standorttabelle [cmn_location] verifiziert. Datentyp: Zeichenfolge
serviceQualifikationsElement.service.Ort.@Typ	Teil des TMF Open API-Standards. Anmerkung für Service. Dieser Wert ist immer `GeographicSite`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
serviceQualifikationsElement.service.serviceSpezifikation	Servicespezifikationsdetails für das Qualifizierungselement. Datentyp: Array von Objekten `"serviceSpecification": { "id": "String", "internalVersion": "Number", "internalId": "String", "name": "String" "@type": "ServiceSpecification" "version": "String", }`
serviceQualificationItem.service.serviceSpecification.id	Externe ID oder Anfangsversion der Servicespezifikation. Datentyp: Zeichenfolge
serviceQualificationItem.service.serviceSpecification.name	Name der Servicespezifikation. Datentyp: Zeichenfolge
serviceQualifikationselement.service.servicespezifikation.version	Externe Version der Servicespezifikation. Datentyp: Zeichenfolge
serviceQualifikationselement.service.serviceSpezifikation.interneVersion	Interne Version der Servicespezifikation. Datentyp: Zahl
serviceQualifikationselement.service.serviceSpezifikation.interneID	Anfangsversion der Servicespezifikation. Datentyp: Zeichenfolge
serviceQualificationItem.service.serviceSpecification.@type	Teil des TMF Open API-Standards. Anmerkung für Servicespezifikation. Dieser Wert ist immer `ServiceSpecification`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
serviceQualificationItem.service.serviceMerkmal	Liste der Servicemerkmale. Datentyp: Array von Objekten `"serviceCharacteristic": [ { "name": "String", "value": "String" "valueType": "String", } ]`
serviceQualifikationsElement.service.serviceMerkmal.wertTyp	Werttyp des Merkmals. Datentyp: Zeichenfolge
serviceQualificationItem.service.serviceMerkmal.name	Name des Merkmals. Datentyp: Zeichenfolge
serviceQualificationItem.service.serviceMerkmal.wert	Wert des Merkmals. Datentyp: Zeichenfolge
Servicequalifizierungselement.alternativesServicevorschlag	Alternativer Servicevorschlag für den Qualifizierungsauftrag. Alternative Vorschläge werden in der Tabelle „Alternative Vorschläge“ [sn_ord_qual_mgmt_alterate_proposal] gespeichert. Datentyp: Zeichenfolge
ServiceQualificationItem.alternateServiceProposal.id	Sys_id des alternativen Vorschlagseintrags in der Tabelle „Alternative Vorschläge“ [sn_ord_qual_mgmt_alterate_proposal]. Datentyp: Zeichenfolge
ServiceQualifizierungselement.alternativesServicevorschlag.alternatServiceverfügbarkeitsdatum	Der Wert im Feld „available_date“ des alternativen Vorschlagseintrags in der Tabelle „Alternativer Vorschlag“ [sn_ord_qual_mgmt_alterate_proposal] Datentyp: Zeichenfolge
serviceQualifizierungselement.alternativesServiceangebot.alternativerService	Serviceinformationen, die durch den alternativen Vorschlag dargestellt werden. Datentyp: Objekt
serviceQualificationItem.alternatServiceVorschlag.alternatService.serviceSpezifikation	Die Servicespezifikation des alternativen Vorschlags wurde in der Spezifikation der Tabelle „Alternatives Angebot“ [sn_ord_qual_mgmt_alternat_proposal] beibehalten. Datentyp: Objekt
serviceQualificationItem alternativeServiceProposal.alterateService.serviceSpecification.id	Externe ID oder Anfangsversion der alternativen Servicespezifikation. Datentyp: Zeichenfolge
serviceQualificationItem alternativeServiceVorschlag.alternatService.serviceSpezifikation.name	Name der alternativen Servicespezifikation. Datentyp: Zeichenfolge
serviceQualificationItem alternativeServiceVorschlag.alternatService.serviceSpezifikation.version	Externe Version der alternativen Servicespezifikation. Datentyp: Zeichenfolge
serviceQualificationItem alternativeServiceVorschlag.alternatService.serviceSpezifikation.interneVersion	Interne Version der alternativen Servicespezifikation. Datentyp: Zahl
serviceQualificationItem alternativeServiceVorschlag.alternatService.serviceSpezifikation.interneID	Ursprüngliche Version der alternativen Servicespezifikation. Datentyp: Zeichenfolge
ServiceQualificationItem alternativeServiceProposal.alternatService.serviceSpecification.@type	Teil des TMF Open API-Standards. Anmerkung für Servicespezifikation. Dieser Wert ist immer `ServiceSpecification`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
serviceQualificationItem alternativeServiceProposal.alterateService.serviceCharacterificent	Array von Servicemerkmalen für den alternativen Servicevorschlag. Datentyp: Array von Objekten `"serviceCharacteristic": [ { "name": "String", "value": "String", "valueType": "String" } ]`
serviceQualificationItem alternativeServiceVorschlag.alternatService.serviceMerkmal.wertTyp	Werttyp des alternativen Servicemerkmals. Datentyp: Zeichenfolge
serviceQualificationItem alternativeServiceVorschlag.alternatService.serviceMerkmal.name	Name des alternativen Servicemerkmals. Datentyp: Zeichenfolge
serviceQualificationItem alternativeServiceVorschlag.alternatService.serviceMerkmal.wert	Wert des alternativen Servicemerkmals. Datentyp: Zeichenfolge
serviceQualificationItem.eligibilityUnavailabilityReason	Eine Liste der Gründe für die Nichtverfügbarkeit der Serviceberechtigung, um zu erklären, warum der Service nicht verfügbar ist. Dieser Wert wird im Feld „unavailability_reason“ der Tabelle „Domänenauftrag“ [sn_ind_tmt_orm_domain_order] gespeichert. Datentyp: Array
serviceQualificationItem.eligibilityUnavailabilityReason.code	Ursachencode für Nichtverfügbarkeit von Serviceberechtigung. Datentyp: Zeichenfolge
serviceQualifikationselement.BerechtigungNichtverfügbarkeitGrund.Bezeichnung	Bezeichnung des Grunds für Nichtverfügbarkeit von Serviceberechtigung. Datentyp: Zeichenfolge

Beispiel für eine cURL-Anforderung

Im folgenden Beispiel wird ein ganzer bestimmter Qualifizierungsauftrag abgerufen, der der angegebenen Sys_id eines Qualifizierungs-Kundenauftrags zugeordnet ist.

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

Antwort:

[
  {
    "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"
  }
]

Offene API für die technische Servicequalifizierung – GET sn_ord_qual_mgmt/qualification/checkServiceQualification

Ruft eine Liste aller technischen Qualifizierungsanforderungen ab.

Dieser Endpunkt ruft Bestellinformationen aus den folgenden Tabellen ab:

Kundenbestellung [sn_ind_tmt_orm_order]
Bestellposition [sn_ind_tmt_orm_order_line_item]

Dieser Endpunkt gibt standardmäßig 20 Datensätze zurück, kann jedoch maximal 100 Datensätze zurückgeben. Verwenden Sie Abfragefilter, um die Ergebnisse nach Status, Feldname(n), Beschreibung und Qualifizierungsergebnis einzugrenzen.

URL-Format

URL mit Versionsnummer: /api/sn_ord_qual_mgmt/qualification/checkServiceQualification

Unterstützte Anforderungsparameter

Tabelle : 7. Pfadparameter
Name	Beschreibung
api_version	Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel `v1` oder `v2`. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge

Tabelle : 8. Abfrageparameter .
Parameter	Beschreibung
Beschreibung	Filtert Qualifizierungsreihenfolgen nach dem Feld „short_description“ des Kundenauftrags. Nur Aufträge mit einer Kurzbeschreibung, dieg dem Wert dieses Parameters entspricht, werden in der Antwort zurückgegeben. Datentyp: Zeichenfolge
Felder	Liste der Feldnamen, die in der Antwortzurückgegeben werden sollen. Ungültige Felder werden ignoriert. Wenn dieser Parameter in der Anforderung nicht angegeben wird, werden alle Felder zurückgegeben. Datentyp: Zeichenfolge, durch Kommas getrennt
limit	Maximale Anzahl der zurückzugebenden Datensätze. Verwenden Sie für Anforderungen, die diese Anzahl von Datensätzen überschreiten, den Offsetparameter, um den Datensatzabruf zu paginieren. Standard: 20 Maximum: 100 Datentyp: Zahl
Qualifizierungsergebnis	Filtert Qualifizierungsreihenfolgen nach Ergebnis. In der Antwort werden nur Aufträge zurückgegeben, deren Ergebnis dem Wert dieses Parameters entspricht. Datentyp: Zeichenfolge
Staat	Filtert Qualifizierungsreihenfolgen nach Status. Nur Aufträge mit einem Status, der dem Wert dieses Parameters entspricht, werden in der Antwort zurückgegeben. Datentyp: Zeichenfolge

Tabelle : 9. Anforderungstextparameter (XML oder JSON)
Name	Beschreibung
Keine

Kopfzeilen

Tabelle : 10. Anforderungskopfzeilen
Kopfzeile	Beschreibung
Akzeptieren	Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json

Tabelle : 11. Antwortkopfzeilen
Kopfzeile	Beschreibung
Keine

Statuscodes

Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter HTTP-Antwortcodesder REST-API.

Tabelle : 12. Statuscodes
Statuscode	Beschreibung
200	Anforderung erfolgreich verarbeitet. Vollständige Ressource, die als Antwort zurückgegeben wird (keine Paginierung).
206	Teilressource, die als Antwort zurückgegeben wird (mit Paginierung).
400	Ungültige Anforderung. Mögliche Gründe: Ungültiger Pfadparameter Ungültiger URI
404	Kein Datensatz für die Filterkriterien gefunden.

Parameter des Antworttexts (JSON oder XML)


Name	Beschreibung
id	Sys_id des Qualifizierungskundenauftrags. Befindet sich in der Tabelle „Kundenauftrag“ [sn_ind_tmt_orm_order]. Datentyp: Zeichenfolge
href	Relativer Link zum Qualifizierungsreihenfolge-Datensatz. Datentyp: Zeichenfolge
Beschreibung	Beschreibung der Qualifizierungsanforderung, die aus dem Feld „short_description“ des Kundenauftrags abgerufen wird. Befindet sich in der Tabelle „Kundenauftrag“ [sn_ind_tmt_orm_order]. Datentyp: Zeichenfolge
externalId	Externe ID aus dem Feld „external_id“ des Kundenauftrags Befindet sich in der Tabelle „Kundenauftrag“ [sn_ind_tmt_orm_order]. Datentyp: Zeichenfolge
Qualifizierungsergebnis	Qualifizierungsstatus des Ergebnisfelds des Kundenauftrags Mögliche Werte: Alternative Keine Ausstehend Qualifiziert nicht qualifiziert Datentyp: Zeichenfolge
Staat	Status des Kundenauftrags aus dem Statusfeld des Kundenauftrags. Datentyp: Zeichenfolge
@type	Teil des TMF Open API-Standards. Anmerkung für die Qualifizierung. Dieser Wert ist immer `CheckServiceQualification`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
checkServiceQualificationDate	Datum und Uhrzeit der Qualifizierungsanforderung, die aus dem Feld „order_date“ des Kundenauftrags erstellt wurde. Befindet sich in der Tabelle „Kundenauftrag“ [sn_ind_tmt_orm_order]. Format: JJJJ-MM-TTTHH:MM:SS.SSZZ Datentyp: Zeichenfolge
effektivQualifizierungsdatum	Gültigkeitsdatum der Qualifizierung, abgerufen aus dem Feld „order_date“ des Kundenauftrags. Befindet sich in der Tabelle „Kundenauftrag“ [sn_ind_tmt_orm_order]. Format: JJJJ-MM-TTTHH:MM:SS.SSZZ Datentyp: Zeichenfolge
erwartetes Qualifizierungsdatum	Speichert das erwartete Qualifizierungsdatum. Im Feld „expected_end_date“ des Kundenauftrags beibehalten Befindet sich in der Tabelle „Kundenauftrag“ [sn_ind_tmt_orm_order]. Format: JJJJ-MM-TTTHH:MM:SS.SSZZ Datentyp: Zeichenfolge
Zugehörige Partei	Liste der Kontakte für die Qualifizierungsanforderung. Jeder Kontakt ist ein Objekt im Array. Datentyp: Array von Objekten `"relatedParty": [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ]`
Zugehörigepartei.id	Sys_id oder external_id des Accounts, Kundenkontakts oder Verbrauchers, der dem Auftrag zugeordnet ist. Zu finden in der Tabelle „Account“ [customer_account], „Kontakt“ [customer_contact] oder „Verbraucher“ [csm_consumer]. Datentyp: Zeichenfolge
Zugehörigepartei.name	Name des Accounts, Kunden oder Verbrauchers. Datentyp: Zeichenfolge
zugehörigepartei.@typ	Teil des TMF Open API-Standards. Anmerkung für den Kontakt des Bestellpositionselements. Dieser Wert ist immer `RelatedParty`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
zugehörigepartei.@referenztyp	Typ der zugehörigen Partei. Mögliche Werte: Verbraucher Kunde Kundenkontakt Datentyp: Zeichenfolge
serviceQualificationItem	Liste der Servicequalifizierungselemente mit Informationen zu Standort, Serviceinformationen und Servicemerkmalen. Werden als Bestellpositionen für den Kundenauftrag gespeichert. Datentyp: Array von Objekten `"serviceQualificationItem": [ { "id": "String", "action": "String", "expectedServiceAvailabilityDate": "Number", "service": {Object}, "@type": "String" } ],`
serviceQualificationItem.id	ID des Qualifizierungselements. Wird im Feld „external_id“ der Kundenauftragsposition in der Tabelle „Auftragspositionselement“ [sn_ind_tmt_orm_order_line_item] gespeichert. Datentyp: Zeichenfolge
serviceQualifikationselement.qualifizierungsergebnis	Ergebnis des Qualifizierungselements. Wird im Feld „Ergebnis“ der Kundenauftragsposition gespeichert. Befindet sich in der Tabelle „Auftragspositionselement“ [sn_ind_tmt_orm_order_line_item]. Mögliche Werte: Alternative Keine Ausstehend Qualifiziert nicht qualifiziert Datentyp: Zeichenfolge
serviceQualifikationselement.status	Status des Qualifizierungselements, der aus dem Feld „Status“ der Kundenauftragsposition abgeleitet wird. Befindet sich in der Tabelle „Auftragspositionselement“ [sn_ind_tmt_orm_order_line_item]. Datentyp: Zeichenfolge
serviceQualificationItem.menge	Menge des Qualifizierungsartikels, abgeleitet aus dem Feld „Menge“ der Kundenauftragsposition. Befindet sich in der Tabelle „Auftragspositionselement“ [sn_ind_tmt_orm_order_line_item]. Datentyp: Zahl
serviceQualificationItem.@type	Teil des TMF Open API-Standards. Anmerkung für das Qualifizierungselement. Dieser Wert ist immer ServiceQualificationItem. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
serviceQualificationItem.service	Serviceinformationen, die Details zu Standort (Ort), Servicespezifikationen und Servicemerkmalen enthalten. Datentyp: Objekt `"service": { "@type": "String", "place": [Array], "serviceCharacteristic": [Array], "serviceSpecification": {Object} }`
serviceQualifikationselement.service.@type	Teil des API-Standards TMF Open. Anmerkung für den Service. Dieser Wert ist immer `Service`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
serviceQualifikationsElement.service.Ort	Standortinformationen für das Servicequalifizierungselement. Datentyp: Array von Objekten Hinweis: Dieses Array kann nur einen Ort enthalten. `"place": [ { "id": "String", "name": "String", "@referredType": "String" } ]`
serviceQualificationItem.service.place.id	Sys_id eines Standorts in der Standorttabelle [cmn_location]. Datentyp: Zeichenfolge
serviceQualificationItem.service.place.name	Name des Standorts. Nicht anhand eines Eintrags in der Standorttabelle [cmn_location] verifiziert. Datentyp: Zeichenfolge
serviceQualifikationsElement.service.Ort.@Typ	Teil des TMF Open API-Standards. Anmerkung für Service. Dieser Wert ist immer `GeographicSite`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
serviceQualifikationsElement.service.serviceSpezifikation	Servicespezifikationsdetails für das Qualifizierungselement. Datentyp: Array von Objekten `"serviceSpecification": { "id": "String", "internalVersion": "Number", "internalId": "String", "name": "String" "@type": "ServiceSpecification" "version": "String", }`
serviceQualificationItem.service.serviceSpecification.id	Externe ID oder Anfangsversion der Servicespezifikation. Datentyp: Zeichenfolge
serviceQualificationItem.service.serviceSpecification.name	Name der Servicespezifikation. Datentyp: Zeichenfolge
serviceQualifikationselement.service.servicespezifikation.version	Externe Version der Servicespezifikation. Datentyp: Zeichenfolge
serviceQualifikationselement.service.serviceSpezifikation.interneVersion	Interne Version der Servicespezifikation. Datentyp: Zahl
serviceQualifikationselement.service.serviceSpezifikation.interneID	Anfangsversion der Servicespezifikation. Datentyp: Zeichenfolge
serviceQualificationItem.service.serviceSpecification.@type	Teil des TMF Open API-Standards. Anmerkung für Servicespezifikation. Dieser Wert ist immer `ServiceSpecification`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
serviceQualificationItem.service.serviceMerkmal	Liste der Servicemerkmale. Datentyp: Array von Objekten `"serviceCharacteristic": [ { "name": "String", "value": "String" "valueType": "String", } ]`
serviceQualifikationsElement.service.serviceMerkmal.wertTyp	Werttyp des Merkmals. Datentyp: Zeichenfolge
serviceQualificationItem.service.serviceMerkmal.name	Name des Merkmals. Datentyp: Zeichenfolge
serviceQualificationItem.service.serviceMerkmal.wert	Wert des Merkmals. Datentyp: Zeichenfolge
Servicequalifizierungselement.alternativesServicevorschlag	Alternativer Servicevorschlag für den Qualifizierungsauftrag. Alternative Vorschläge werden in der Tabelle „Alternative Vorschläge“ [sn_ord_qual_mgmt_alterate_proposal] gespeichert. Datentyp: Zeichenfolge
ServiceQualificationItem.alternateServiceProposal.id	Sys_id des alternativen Vorschlagseintrags in der Tabelle „Alternative Vorschläge“ [sn_ord_qual_mgmt_alterate_proposal]. Datentyp: Zeichenfolge
ServiceQualifizierungselement.alternativesServicevorschlag.alternatServiceverfügbarkeitsdatum	Der Wert im Feld „available_date“ des alternativen Vorschlagseintrags in der Tabelle „Alternativer Vorschlag“ [sn_ord_qual_mgmt_alterate_proposal] Datentyp: Zeichenfolge
serviceQualifizierungselement.alternativesServiceangebot.alternativerService	Serviceinformationen, die durch den alternativen Vorschlag dargestellt werden. Datentyp: Objekt
serviceQualificationItem.alternatServiceVorschlag.alternatService.serviceSpezifikation	Die Servicespezifikation des alternativen Vorschlags wurde in der Spezifikation der Tabelle „Alternatives Angebot“ [sn_ord_qual_mgmt_alternat_proposal] beibehalten. Datentyp: Objekt
serviceQualificationItem alternativeServiceProposal.alterateService.serviceSpecification.id	Externe ID oder Anfangsversion der alternativen Servicespezifikation. Datentyp: Zeichenfolge
serviceQualificationItem alternativeServiceVorschlag.alternatService.serviceSpezifikation.name	Name der alternativen Servicespezifikation. Datentyp: Zeichenfolge
serviceQualificationItem alternativeServiceVorschlag.alternatService.serviceSpezifikation.version	Externe Version der alternativen Servicespezifikation. Datentyp: Zeichenfolge
serviceQualificationItem alternativeServiceVorschlag.alternatService.serviceSpezifikation.interneVersion	Interne Version der alternativen Servicespezifikation. Datentyp: Zahl
serviceQualificationItem alternativeServiceVorschlag.alternatService.serviceSpezifikation.interneID	Ursprüngliche Version der alternativen Servicespezifikation. Datentyp: Zeichenfolge
ServiceQualificationItem alternativeServiceProposal.alternatService.serviceSpecification.@type	Teil des TMF Open API-Standards. Anmerkung für Servicespezifikation. Dieser Wert ist immer `ServiceSpecification`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
serviceQualificationItem alternativeServiceProposal.alterateService.serviceCharacterificent	Array von Servicemerkmalen für den alternativen Servicevorschlag. Datentyp: Array von Objekten `"serviceCharacteristic": [ { "name": "String", "value": "String", "valueType": "String" } ]`
serviceQualificationItem alternativeServiceVorschlag.alternatService.serviceMerkmal.wertTyp	Werttyp des alternativen Servicemerkmals. Datentyp: Zeichenfolge
serviceQualificationItem alternativeServiceVorschlag.alternatService.serviceMerkmal.name	Name des alternativen Servicemerkmals. Datentyp: Zeichenfolge
serviceQualificationItem alternativeServiceVorschlag.alternatService.serviceMerkmal.wert	Wert des alternativen Servicemerkmals. Datentyp: Zeichenfolge
serviceQualificationItem.eligibilityUnavailabilityReason	Eine Liste der Gründe für die Nichtverfügbarkeit der Serviceberechtigung, um zu erklären, warum der Service nicht verfügbar ist. Dieser Wert wird im Feld „unavailability_reason“ der Tabelle „Domänenauftrag“ [sn_ind_tmt_orm_domain_order] gespeichert. Datentyp: Array
serviceQualificationItem.eligibilityUnavailabilityReason.code	Ursachencode für Nichtverfügbarkeit von Serviceberechtigung. Datentyp: Zeichenfolge
serviceQualifikationselement.BerechtigungNichtverfügbarkeitGrund.Bezeichnung	Bezeichnung des Grunds für Nichtverfügbarkeit von Serviceberechtigung. Datentyp: Zeichenfolge

Beispiel für eine cURL-Anforderung

Der folgende GET-Aufruf ruft alle Qualifizierungsreihenfolgen für eine Instanz ab.

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

Antwort:

[{
        "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"
}
]

Open API für die technische Servicequalifizierung – POST sn_ord_qual_mgmt/qualification/checkServiceQualification

Erstellt eine Entität für die Anforderung der technischen Servicequalifizierung, die eine Liste von Qualifizierungselementen enthält.

Die Servicequalifizierungsanforderung wird als Kundenauftrag mit dem Erfüllungstyp „Qualifizieren“ beibehalten. Jedes Qualifizierungselement wird als Kundenpositionsauftrag in der Tabelle „Auftrag“ [sn_ind_tmt_orm_order_line_item] gespeichert.

Dieser Endpunkt wird verwendet

Sie können diese API-Methode für drei spezifische Anwendungsfälle verwenden:

Anforderung zum Qualifizieren eines Services an einer angegebenen Adresse
Fordert die Qualifizierung eines neuen Service am selben Standort eines vorhandenen und aktiven Zugriffsservice an.
Anforderung zum Upgraden oder Downgraden eines vorhandenen Service.

Jeder Anwendungsfall erfordert dieselbe Anforderungsstruktur, verwendet jedoch unterschiedliche Anforderungsparameter. Detailinformationen zu jedem Anwendungsfall und zu den akzeptierten Parametern:

Um einen Service an einer bestimmten Adresse zu qualifizieren, verwenden Sie das Array [ place (serviceQualificationItem.service.place), um einen bestimmten Standort und die Servicespezifikation anzugeben. Sie können optional zusätzliche Servicemerkmale in Ihrer Anforderung definieren.
Um einen neuen Service am selben Standort eines vorhandenen und aktiven Service zu qualifizieren, verwenden Sie das Objekt referenceServiceInventory (serviceQualificationItem.service.referenceServiceInventory) anstelle des Arrays place. Mit diesem Objekt können Sie eine Anforderung erstellen und Servicespezifikationen definieren, ohne Standortdetails angeben zu müssen. Sie können optional zusätzliche Servicemerkmale in Ihrer Anforderung definieren.
Verwenden Sie zum Upgraden oder Downgrade eines vorhandenen Service das Objekt serviceInventory (serviceQualificationItem.service.ServiceInventory) anstelle des Arrays place oder des Objekts referenceServiceInventory. In diesem Anwendungsfall werden Standortinformationen und Spezifikationsdetails von einem vorhandenen Service abgerufen. Definieren Sie in Ihrer Anforderung alle Servicemerkmale, die Sie ändern möchten.
Angenommen, Sie möchten überprüfen, ob Sie die Download-Geschwindigkeit eines vorhandenen, aktiven Service von 100 Mbit/s auf 600 Mbit/s aktualisieren können. In diesem Fall können Sie den Parameter serviceInventory verwenden, um die Anforderung zu definieren, indem Sie das Merkmal „Geschwindigkeit“ von „Niedrig“ in „Hoch“ ändern. Die API ruft die verbleibenden Merkmale vom vorhandenen Service ab.

Um zu verstehen, wie Sie Ihre API-Anforderung für Ihren jeweiligen Anwendungsfall gestalten, sehen Sie sich die Beispielaufrufe im Abschnitt „Beispiel“ auf dieser Seite an.

URL-Format

URL mit Versionsnummer: /api/sn_ord_qual_mgmt/qualification/checkServiceQualification

Unterstützte Anforderungsparameter

Tabelle : 13. Pfadparameter
Name	Beschreibung
Keine

Tabelle : 14. Abfrageparameter
Name	Beschreibung
Keine

Tabelle : 15. Anforderungstextparameter (XML oder JSON)
Parameter	Beschreibung
@type	Optional. Teil des TMF Open API-Standards. Anmerkung für die Qualifizierung. Dieser Wert ist immer `CheckServiceQualification`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
checkServiceQualificationDate	Optional. Datum und Uhrzeit der Erstellung der Qualifizierungsanforderung. Im Feld „order_date“ der Tabelle „Kundenauftrag“ [sn_ind_tmt_orm_order] Wenn nicht angegeben, wird „order_date“ auf das aktuelle Datum und die aktuelle Uhrzeit festgelegt. Datentyp: Zeichenfolge Format: JJJJ-MM-TTTHH:MM:SS.SSZZ
Beschreibung	Optional. Die Beschreibung der Qualifizierungsanforderung. Befindet sich im Feld „short_description“ der Tabelle „Kundenauftrag“ [sn_ind_tmt_orm_order]. Datentyp: Zeichenfolge Maximale Zeichenlänge: 100
effektivQualifizierungsdatum	Optional. Das Datum, an dem die Qualifizierung gültig ist. Im Feld „actual_end_date“ des Kundenauftrags der Tabelle „Kundenauftrag“ [sn_ind_tmt_orm_order] beibehalten. Datentyp: Zeichenfolge Format: JJJJ-MM-TTTHH:MM:SS.SSZZ
erwartetes Qualifizierungsdatum	Optional. Das erwartete Qualifizierungsdatum. Persistiert im Feld „expected_end_date“ des Kundenauftrags Befindet sich in der Tabelle „Kundenauftrag“ [sn_ind_tmt_orm_order]. Datentyp: Zeichenfolge Format: JJJJ-MM-TTTHH:MM:SS.SSZZ
externalId	Optional. Externe ID, die dem Kundenauftrag zugewiesen ist. Persistiert im Feld „external_id“ des Kundenauftrags in der Tabelle „Kundenauftrag“ [sn_ind_tmt_orm_order]. Datentyp: Zeichenfolge
Zugehörige Partei	Liste der Kontakte für die Qualifizierungsanforderung. Jeder Kontakt ist ein Objekt im Array. Muss mindestens ein Element auflisten, das Informationen zu Kundenaccounts, Kundenkontakten oder Verbraucheraccounts enthält. Datentyp: Array von Objekten `"relatedParty": [ { "@referredType": "String", "@type": "String", "id": "String", "name": "String" } ]`
zugehörigepartei.@referenztyp	Typ der zugehörigen Partei. Mögliche Werte: consumer Kunde CustomerContact Datentyp: Zeichenfolge
zugehörigepartei.@typ	Optional. Teil des TMF Open API-Standards. Anmerkung für den Kontakt des Bestellpositionselements. Dieser Wert ist immer `RelatedParty`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
relatedParty.id	Die sys_id oder external_id, falls zutreffend, der zugehörigen Partei. Zu finden in der Tabelle „Account“ [customer_account], „Kontakt“ [customer_contact] oder „Verbraucher“ [csm_consumer]. Datentyp: Zeichenfolge
relatedParty.name	Name des Accounts, Kunden oder Verbrauchers. Datentyp: Zeichenfolge
serviceQualificationItem	Liste der Servicequalifizierungselemente mit Standort, Serviceinformationen und Merkmalen. Werden als Bestellpositionen für den Kundenauftrag gespeichert. Muss mindestens ein Servicequalifizierungselement in der Liste enthalten. Datentyp: Array von Objekten `"serviceQualificationItem": [{ "@type": "String", "id": "String", "qualificationResult": "String", "quantity": "Number", "service": {Object}, "state": "String" ]`
serviceQualificationItem.@type	Optional. Teil des TMF Open API-Standards. Anmerkung zum Qualifizierungselement. Dieser Wert ist immer `ServiceQualificationItem`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
serviceQualificationItem.qualificationItemBeziehung	Optional. Liste der Beziehungen zu anderen Servicequalifizierungselementen in derselben Anforderung. Diese Informationen helfen beim Erstellen von Bestellpositionen mit einer übergeordneten Bestellposition. Datentyp: Array von Objekten `"qualificationItemRelationship": [ { "id": "String" "relationshipType": "String" } ]`
serviceQualificationItem.qualificationItemRelationship.id	Erforderlich. Die ID des Zielqualifizierungselements in der Beziehung. Datentyp: Zeichenfolge
serviceQualificationItem.qualificationItemRelationship.relationshipType	Erforderlich. Der Typ der Einzelposten-Beziehung. Gültige Werte: HasChild: Gibt das untergeordnete Element an. HatParent: Gibt das übergeordnete Element an. Datentyp: Zeichenfolge
serviceQualificationItem.menge	Optional. Menge des Qualifizierungsartikels. Wird im Feld „Menge“ der Kundenauftragsposition beibehalten. Datentyp: Zahl Standard, wenn nicht angegeben: 1
serviceQualificationItem.service	Erforderlich. Serviceinformationen, die Variablen wie Ort, Servicespezifikation und Servicemerkmale enthalten können. Datentyp: Objekt `"service": { "@type": "String", "place": [Array], "serviceCharacteristic": [Array], "serviceSpecification": {Object} }`
serviceQualifikationselement.service.@type	Optional. Teil des TMF Open API-Standards. Anmerkung zu Serviceinformationen für Qualifizierungselement. Dieser Wert ist immer `Service`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
serviceQualificationItem.service.place	Optional. Die angeforderten Standortinformationen für das Servicequalifizierungselement. Befindet sich in der Standorttabelle [cmn_location]. Hinweis: Ein Array wird zwar unterstützt, darf jedoch nur einen Ort enthalten. Datentyp: Array von Objekten `"place": [ { "@type": "String" "id": "String", "name": "String" } ]`
serviceQualificationItem.service.place.@type	Optional. Teil des TMF Open API-Standards. Anmerkung für Service. Dieser Wert ist immer `GeographicSite`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
serviceQualificationItem.service.place.id	Erforderlich. Sys_id eines Standorts in der Standorttabelle [cmn_location]. Diese Standort-ID muss ein gültiger Eintrag in der Tabelle „Standort“ [cmn_location] sein. Datentyp: Zeichenfolge
serviceQualificationItem.service.place.name	Optional. Name des Standorts. Dieser Wert wird nicht anhand von Einträgen in der Standorttabelle [cmn_location] verifiziert. Datentyp: Zeichenfolge
serviceQualificationItem.service.referenceServiceInventory	Erforderlich. Gültige Servicebestandsentität, die auf einen aktiven Service für den erforderlichen Standort verweist. Die Standortinformationen für den Qualifizierungsauftrag werden vom Standort dieses Servicebestands abgerufen. Wichtig: Verwenden Sie das Objekt referenceServiceInventory, um einen neuen Service am selben Speicherort eines vorhandenen und aktiven Access-Service zu qualifizieren. Dazu müssen Sie auch das Array serviceInventoryplace und das Objekt [] in Ihrer Anforderung weglassen. Andernfalls gibt die API einen Fehler zurück. Datentyp: Objekt `"referenceServiceInventory": { "id": "String" }`
serviceQualificationItem.service.referenceServiceInventory.id	Erforderlich, wenn serviceQualificationItem.service.referenceServiceInventory in der Anforderung verwendet wird. Die sys_id einer gültigen Servicebestandsentität, die auf einen aktiven Service für den erforderlichen Standort verweist. Diese Informationen werden nur in den Arbeitsnotizen zum Auftrag erwähnt. Datentyp: Zeichenfolge
serviceQualificationItem.service.serviceMerkmal	Optional. Array von Servicemerkmalen. Datentyp: Array von Objekten `"serviceCharacteristic": [ { "name": "String", "value": "String", "valueType": "String", } ]`
serviceQualificationItem.service.serviceCharacteristic.name	Erforderlich. Name des Merkmals. Datentyp: Zeichenfolge
serviceQualificationItem.service.serviceMerkmal.wert	Optional. Wert des Merkmals. Teil des TMF Open API-Standards. Anmerkung für Qualifizierungselement. Dieser Wert ist immer `ServiceQualificationItem`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
serviceQualifikationsElement.service.serviceMerkmal.wertTyp	Optional. Werttyp des Merkmals. Datentyp: Zeichenfolge
serviceQualifikationsElement.service.serviceBestand	Optional. Gültige Servicebestandsentität, die sich auf einen aktiven Service bezieht, der ein Upgrade oder Downgrade erfordert. Wichtig: Verwenden Sie das Objekt serviceInventory für Service-Upgrades oder -Downgrades. Dazu müssen Sie den Ort array und das Objekt referenceServiceInventory in Ihrer Anforderung weglassen. Andernfalls gibt die API einen Fehler zurück. Datentyp: Objekt `"serviceInventory": { "id": "String" }`
serviceQualifikationsElement.service.serviceSpezifikation	Erforderlich. Servicespezifikation für das Qualifizierungselement. Wird im Feld „service_specification“ der Kundenauftragsposition in der Tabelle „Auftragspositionselement“ [sn_ind_tmt_orm_order_line_item] gespeichert. Servicespezifikationen für ein Qualifizierungselement können nicht ressourcenorientiert sein. Datentyp: Objekt `"serviceSpecification": { “@type”: ”String”, "id": "String", "name": "String" }`
serviceQualificationItem.service.serviceSpecification.@type	Optional. Teil des TMF Open API-Standards. Anmerkung für die Servicespezifikation. Dieser Wert ist immer `ServiceSpecification`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
serviceQualificationItem.service.serviceSpecification.id	Erforderlich. Externe ID oder Anfangsversion der Servicespezifikation. Datentyp: Zeichenfolge
serviceQualifikationselement.service.serviceSpezifikation.interneVersion	Optional. Interne Version der Servicespezifikation. Datentyp: Zahl
serviceQualificationItem.service.serviceSpecification.name	Erforderlich. Name der Servicespezifikation. Datentyp: Zeichenfolge
serviceQualifikationselement.service.servicespezifikation.version	Optional. Externe Version der Servicespezifikation. Datentyp: Zeichenfolge

Header

Tabelle : 16. Anforderungskopfzeilen
Kopfzeile	Beschreibung
Akzeptieren	Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json
Content-Type	Datenformat des Anforderungstexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json

Tabelle : 17. Antwortkopfzeilen
Kopfzeile	Beschreibung
Keine

Statuscodes

Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter HTTP-Antwortcodesder REST-API.

Tabelle : 18. Statuscodes
Statuscode	Beschreibung
201	Anforderung erfolgreich verarbeitet. Hinweis: Wenn Probleme mit den Merkmalen oder Merkmalsoptionsinformationen auftreten, speichert der Endpunkt die folgenden Kommentare in den Arbeitsnotizfeldern des zugehörigen Kundenauftragspositionselements-Datensatzes, ähnlich wie bei vorhandenen Lieferaufträgen
400	Ungültige Anforderung. Kann einer der folgenden Gründe sein: Leere Nutzlast. Ungültige Nutzlast: Pflichtfeld fehlt:<field name> Ungültige Nutzlast: Anforderungstext fehlt – Nutzlast wurde im Anforderungstext nicht übergeben. Ungültige Nutzlast: „relatedParty“ fehlt. Ungültige Nutzlast: „serviceQualificationItem“ fehlt. Ungültige Nutzlast: serviceQualificationItem-ID fehlt. Ungültige Nutzlast: serviceQualificationItem-Service fehlt. Ungültige Nutzlast: Die Standortinformationen fehlen. Geben Sie Ort, ServiceInventory oder ReferenzServiceInventory an. Ungültige Nutzlast: Die Spezifikationsinformationen fehlen. Geben Sie „serviceSpecification“ oder „serviceInventory“ an. Ungültige Nutzlast: Servicespezifikation ist nicht vorhanden. Ungültige Nutzlast: Kunden-Account ist nicht vorhanden. Ungültige Nutzlast: Verbraucher ist nicht vorhanden.
500	Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

Parameter des Antworttexts (JSON oder XML)

Tabelle : 19. Im Antwort-Haupttext zurückgegebene Elemente
Elemente	Beschreibung
id	Sys_id des Qualifizierungskundenauftrags. Befindet sich in der Tabelle „Kundenauftrag“ [sn_ind_tmt_orm_order]. Datentyp: Zeichenfolge
href	Relativer Link zum Qualifizierungsreihenfolge-Datensatz. Datentyp: Zeichenfolge
Beschreibung	Beschreibung der Qualifizierungsanforderung, die aus dem Feld „short_description“ des Kundenauftrags abgerufen wird. Befindet sich in der Tabelle „Kundenauftrag“ [sn_ind_tmt_orm_order]. Datentyp: Zeichenfolge
externalId	Externe ID aus dem Feld „external_id“ des Kundenauftrags Befindet sich in der Tabelle „Kundenauftrag“ [sn_ind_tmt_orm_order]. Datentyp: Zeichenfolge
Qualifizierungsergebnis	Qualifizierungsstatus des Ergebnisfelds des Kundenauftrags Mögliche Werte: Alternative Keine Ausstehend Qualifiziert nicht qualifiziert Datentyp: Zeichenfolge
Staat	Status des Kundenauftrags aus dem Statusfeld des Kundenauftrags. Datentyp: Zeichenfolge
@type	Teil des TMF Open API-Standards. Anmerkung für die Qualifizierung. Dieser Wert ist immer `CheckServiceQualification`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
checkServiceQualificationDate	Datum und Uhrzeit der Qualifizierungsanforderung, die aus dem Feld „order_date“ des Kundenauftrags erstellt wurde. Befindet sich in der Tabelle „Kundenauftrag“ [sn_ind_tmt_orm_order]. Format: JJJJ-MM-TTTHH:MM:SS.SSZZ Datentyp: Zeichenfolge
effektivQualifizierungsdatum	Gültigkeitsdatum der Qualifizierung, abgerufen aus dem Feld „order_date“ des Kundenauftrags. Befindet sich in der Tabelle „Kundenauftrag“ [sn_ind_tmt_orm_order]. Format: JJJJ-MM-TTTHH:MM:SS.SSZZ Datentyp: Zeichenfolge
erwartetes Qualifizierungsdatum	Speichert das erwartete Qualifizierungsdatum. Im Feld „expected_end_date“ des Kundenauftrags beibehalten Befindet sich in der Tabelle „Kundenauftrag“ [sn_ind_tmt_orm_order]. Format: JJJJ-MM-TTTHH:MM:SS.SSZZ Datentyp: Zeichenfolge
Zugehörige Partei	Liste der Kontakte für die Qualifizierungsanforderung. Jeder Kontakt ist ein Objekt im Array. Datentyp: Array von Objekten `"relatedParty": [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ]`
Zugehörigepartei.id	Sys_id oder external_id des Accounts, Kundenkontakts oder Verbrauchers, der dem Auftrag zugeordnet ist. Zu finden in der Tabelle „Account“ [customer_account], „Kontakt“ [customer_contact] oder „Verbraucher“ [csm_consumer]. Datentyp: Zeichenfolge
Zugehörigepartei.name	Name des Accounts, Kunden oder Verbrauchers. Datentyp: Zeichenfolge
zugehörigepartei.@typ	Teil des TMF Open API-Standards. Anmerkung für den Kontakt des Bestellpositionselements. Dieser Wert ist immer `RelatedParty`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
zugehörigepartei.@referenztyp	Typ der zugehörigen Partei. Mögliche Werte: Verbraucher Kunde Kundenkontakt Datentyp: Zeichenfolge
serviceQualificationItem	Liste der Servicequalifizierungselemente mit Informationen zu Standort, Serviceinformationen und Servicemerkmalen. Werden als Bestellpositionen für den Kundenauftrag gespeichert. Datentyp: Array von Objekten `"serviceQualificationItem": [ { "id": "String", "action": "String", "expectedServiceAvailabilityDate": "Number", "service": {Object}, "@type": "String" } ],`
serviceQualificationItem.id	ID des Qualifizierungselements. Wird im Feld „external_id“ der Kundenauftragsposition in der Tabelle „Auftragspositionselement“ [sn_ind_tmt_orm_order_line_item] gespeichert. Datentyp: Zeichenfolge
serviceQualifikationselement.qualifizierungsergebnis	Ergebnis des Qualifizierungselements. Wird im Feld „Ergebnis“ der Kundenauftragsposition gespeichert. Befindet sich in der Tabelle „Auftragspositionselement“ [sn_ind_tmt_orm_order_line_item]. Mögliche Werte: Alternative Keine Ausstehend Qualifiziert nicht qualifiziert Datentyp: Zeichenfolge
serviceQualifikationselement.status	Status des Qualifizierungselements, der aus dem Feld „Status“ der Kundenauftragsposition abgeleitet wird. Befindet sich in der Tabelle „Auftragspositionselement“ [sn_ind_tmt_orm_order_line_item]. Datentyp: Zeichenfolge
serviceQualificationItem.menge	Menge des Qualifizierungsartikels, abgeleitet aus dem Feld „Menge“ der Kundenauftragsposition. Befindet sich in der Tabelle „Auftragspositionselement“ [sn_ind_tmt_orm_order_line_item]. Datentyp: Zahl
serviceQualificationItem.@type	Teil des TMF Open API-Standards. Anmerkung für das Qualifizierungselement. Dieser Wert ist immer ServiceQualificationItem. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
serviceQualificationItem.service	Serviceinformationen, die Details zu Standort (Ort), Servicespezifikationen und Servicemerkmalen enthalten. Datentyp: Objekt `"service": { "@type": "String", "place": [Array], "serviceCharacteristic": [Array], "serviceSpecification": {Object} }`
serviceQualifikationselement.service.@type	Teil des API-Standards TMF Open. Anmerkung für den Service. Dieser Wert ist immer `Service`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
serviceQualifikationsElement.service.Ort	Standortinformationen für das Servicequalifizierungselement. Datentyp: Array von Objekten Hinweis: Dieses Array kann nur einen Ort enthalten. `"place": [ { "id": "String", "name": "String", "@referredType": "String" } ]`
serviceQualificationItem.service.place.id	Sys_id eines Standorts in der Standorttabelle [cmn_location]. Datentyp: Zeichenfolge
serviceQualificationItem.service.place.name	Name des Standorts. Nicht anhand eines Eintrags in der Standorttabelle [cmn_location] verifiziert. Datentyp: Zeichenfolge
serviceQualifikationsElement.service.Ort.@Typ	Teil des TMF Open API-Standards. Anmerkung für Service. Dieser Wert ist immer `GeographicSite`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
serviceQualifikationsElement.service.serviceSpezifikation	Servicespezifikationsdetails für das Qualifizierungselement. Datentyp: Array von Objekten `"serviceSpecification": { "id": "String", "internalVersion": "Number", "internalId": "String", "name": "String" "@type": "ServiceSpecification" "version": "String", }`
serviceQualificationItem.service.serviceSpecification.id	Externe ID oder Anfangsversion der Servicespezifikation. Datentyp: Zeichenfolge
serviceQualificationItem.service.serviceSpecification.name	Name der Servicespezifikation. Datentyp: Zeichenfolge
serviceQualifikationselement.service.servicespezifikation.version	Externe Version der Servicespezifikation. Datentyp: Zeichenfolge
serviceQualifikationselement.service.serviceSpezifikation.interneVersion	Interne Version der Servicespezifikation. Datentyp: Zahl
serviceQualifikationselement.service.serviceSpezifikation.interneID	Anfangsversion der Servicespezifikation. Datentyp: Zeichenfolge
serviceQualificationItem.service.serviceSpecification.@type	Teil des TMF Open API-Standards. Anmerkung für Servicespezifikation. Dieser Wert ist immer `ServiceSpecification`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
serviceQualificationItem.service.serviceMerkmal	Liste der Servicemerkmale. Datentyp: Array von Objekten `"serviceCharacteristic": [ { "name": "String", "value": "String" "valueType": "String", } ]`
serviceQualifikationsElement.service.serviceMerkmal.wertTyp	Werttyp des Merkmals. Datentyp: Zeichenfolge
serviceQualificationItem.service.serviceMerkmal.name	Name des Merkmals. Datentyp: Zeichenfolge
serviceQualificationItem.service.serviceMerkmal.wert	Wert des Merkmals. Datentyp: Zeichenfolge

Anwendungsfall 1

Das folgende Beispiel zeigt eine einfache Anforderung, die ein einzelnes Qualifizierungselement enthält.

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

Antwort:

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

Anwendungsfall 2

Im folgenden Beispiel wird gezeigt, wie Sie eine einfache Servicequalifizierung mit einer ID anfordern, um den Standort des Kunden mit einem vorhandenen Service zu erhalten.

Hinweis:

Referenzservicebestand mit ID = ist ein Produktbestand mit Standort = 20220 Bow Weillow, Ford, TX

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

Antwort, wobei place aus referenceServiceInventory in der Anforderung ausgefüllt wird.

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

Anwendungsfall 3

Das folgende Beispiel zeigt, wie der Breitbandservice eines Benutzers auf eine höhere Geschwindigkeit aktualisiert wird. Servicebestand mit ID = ist ein Produktbestand mit Servicespezifikation = 'Breitbandservice', Standort = 20220 Bow Weillow, Ford, TX, Merkmale=[{Geschwindigkeit:Mittel}].

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

Antwort, wobei place und specification anhand von serviceInventory in der Anforderung ausgefüllt werden.

Hinweis:

Merkmale werden zuerst aus der Anforderungsnutzlast übernommen, dann werden die verbleibenden Merkmale (falls vorhanden) von serviceInventoryabgerufen.

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

Anwendungsfall 4

Beschreibt die Hierarchie von über- und untergeordneten Einzelposten und ihre Beziehungstypen. Es zeigt, wie mehrere Einzelposten über das Mengenattribut erstellt werden können.

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

Antwort:

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

Open API für die technische Servicequalifizierung – POST sn_ord_qual_mgmt/qualification/checkServiceQualification/processResult

Verarbeitet ein Ergebnis einer technischen Servicequalifizierung, das an die Open API für die technische Servicequalifizierung gesendet wird.

URL-Format

URL mit Versionsnummer: /api/sn_ord_qual_mgmt/qualification/checkServiceQualification/processResult

Unterstützte Anforderungsparameter

Tabelle : 20. Pfadparameter
Name	Beschreibung
api_version	Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel `v1` oder `v2`. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge

Tabelle : 21. Abfrageparameter
Name	Beschreibung
Keine

Tabelle : 22. Anforderungstextparameter (XML oder JSON)
Parameter	Beschreibung
serviceQualificationItem	Erforderlich. Liste der Servicequalifizierungselemente, die jeweils einen Domänenauftrag in der Serviceauftragstabelle [sn_ind_tmt_orm_service_order] für die angeforderte oberste Auftragsposition darstellen. Alle Domänenaufträge, die von den einzelnen Servicequalifizierungselementen dargestellt werden, müssen zu derselben obersten Auftragsposition gehören. Datentyp: Array von Objekten `"serviceQualificationItem": [ { "@type": "String", "alternateServiceProposal": [Array], "id": "String", "qualificationResult": "String" } ]`
serviceQualificationItem.@type	Optional. Teil des TMF Open API-Standards. Anmerkung zum Qualifizierungselement. Dieser Wert ist immer `ServiceQualificationItem`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
serviceQualificationItem.alternatProposal	Optional. Alternative Vorschläge für das Qualifizierungselement bereitgestellt. Wird in der Tabelle „Alternative Vorschläge“ [sn_ord_qual_mgmt_alternat_proposal] gespeichert. Datentyp: Array von Objekten `"alternateServiceProposal": [ { "@type": "String", "alternateService": {Object}, "alternateServiceAvailabilityDate": "Number", "id": "String", "serviceCharacteristic": [Array] } ]`
serviceQualificationItem.alternatProposal.@type	Optional. Teil des TMF Open API-Standards. Anmerkung zu Serviceinformationen für das Qualifizierungselement. Dieser Wert ist immer `Service`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
serviceQualifizierungselement.alternativesVorschlag.alternativerService	Erforderlich. Serviceinformationen für den alternativen Vorschlag, der Servicespezifikationen und -merkmale enthält. Datentyp: Objekt `"alternateService": { "@type": "String", "serviceSpecification": {Object}, "serviceCharacteristic": [Array] }`
serviceQualificationItem.alternatProposal.alternatService.alternatService.serviceMerkmal.WertTyp	Werttyp des Merkmals unter dem alternativen Servicevorschlag. Datentyp: Zeichenfolge
serviceQualificationItem.alternatProposal.alternatService.serviceMerkmal	Array von Servicemerkmalen für den alternativen Servicevorschlag, gespeichert als Zeichenfolge im Feld „order_characterlists“ der Tabelle „Alternativer Vorschlag“ [sn_ord_qual_mgmt_alterate_proposal]. Datentyp: Array von Objekten `"serviceCharacteristic": [ { "valueType": "String", "name": "String", "value": "String" } ]`
serviceQualificationItem.alternateProposal.alternateService.serviceCharacteristic.name	Erforderlich. Name des Merkmals, das zum alternativen Servicevorschlag gehört. Datentyp: Zeichenfolge
serviceQualificationItem.alternatProposal.alternatService.serviceMerkmal.wert	Wert des Merkmals, das zum alternativen Servicevorschlag gehört. Datentyp: Zeichenfolge
serviceQualificationItem.alternatProposal.alternatService .serviceSpecification	Erforderlich. Servicespezifikation für den alternativen Vorschlag. Wird im Spezifikationsfeld des alternativen Vorschlagseintrags der Tabelle „Alternativer Vorschlag“ [sn_ord_qual_mgmt_alterate_proposal] gespeichert. Datentyp: Objekt `"serviceSpecification": { “@type”: ”String” "id": "String", "name": "String" }`
serviceQualificationItem.alternatProposal.alternatService .serviceSpecification.@type	Teil des TMF Open API-Standards. Anmerkung für die Servicespezifikation. Dieser Wert ist immer `ServiceSpecification`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
serviceQualificationItem.alternateProposal.alternateService.serviceSpecification.id	Erforderlich. Externe ID oder Anfangsversion der Servicespezifikation. Datentyp: Zeichenfolge
serviceQualifizierungselement.alternativesVorschlag.alternativerService.serviceSpezifikation.interneVersion	Interne Version der Servicespezifikation. Datentyp: Zeichenfolge
serviceQualificationItem.alternateProposal.alternateService.serviceSpecification.name	Name der Servicespezifikation. Datentyp: Zeichenfolge
serviceQualifizierungselement.alternativesVorschlag.alternativerService.serviceSpezifikation.version	Externe Version der Servicespezifikation. Datentyp: Zeichenfolge
serviceQualificationItem.alterativeProposal.alterativeServiceAvailabilityDate	Optional. Alternatives Serviceverfügbarkeitsdatum. Befindet sich im Feld „available_date“ der Tabelle „Alternatives Angebot“ [sn_ord_qual_mgmt_alternat_proposal], wobei die Domänenauftragsinformationen zu dem Domänenauftrag gehören, der durch das aktuelle Servicequalifizierungselement dargestellt wird. Format: JJJJ-MM-TTTHH:MM:SS.SSZZ Datentyp: Zeichenfolge
serviceQualificationItem.alternateProposal.id	Optional. Anwenderdefinierte ID für den alternativen Vorschlag. Diese Daten werden nicht beibehalten. Datentyp: Zeichenfolge
serviceQualificationItem.eligibilityUnavailabilityReason	Optional. Grund, warum die Servicequalifizierung nicht berechtigt ist. Die gesamte Liste der Gründe wird mit ihren Bezeichnungsfeldern als Zeichenfolge im Feld „unavailability_reason“ der Tabelle „Domänenauftrag“ [sn_ind_tmt_orm_domain_order] gespeichert. Datentyp: Objekt `"eligibilityUnavailabilityReason": [ { "code": "String", "label": "String" } ]`
serviceQualificationItem.eligibilityUnavailabilityReason.code	Optional. Code für den Grund der Nichtverfügbarkeit der Berechtigung. Diese Informationen werden nicht beibehalten. Datentyp: Zeichenfolge
serviceQualifikationselement.BerechtigungNichtverfügbarkeitGrund.Bezeichnung	Erforderlich. Bezeichnung für den Grund der Nichtverfügbarkeit der Berechtigung. Wenn mehrere Nichtberechtigungsgründe vorliegen, werden die Bezeichnungen durch „ “, “ getrennt und im Feld „unavailability_reason“ der Tabelle „Domänenauftrag“ [sn_ind_tmt_orm_domain_order] gespeichert. Datentyp: Zeichenfolge
serviceQualificationItem.id	Erforderlich. Sys_id des Domänenauftrags, der vom Qualifizierungselement dargestellt wird. Wird im Feld „Sys_id“ des Domänenauftrags [sn_ind_tmt_orm_service_order] gespeichert. Datentyp: Zeichenfolge
serviceQualifikationselement.qualifizierungsergebnis	Erforderlich. Qualifizierungsergebnis für jedes Servicequalifizierungselement, das im Ergebnisfeld der Tabelle „Domänenauftrag“ [sn_ind_tmt_orm_service_order] gespeichert wird. Datentyp: Zeichenfolge

Header

Tabelle : 23. Anforderungskopfzeilen
Kopfzeile	Beschreibung
Akzeptieren	Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json

Tabelle : 24. Antwortkopfzeilen
Kopfzeile	Beschreibung
Keine

Statuscodes

Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter HTTP-Antwortcodesder REST-API.

Tabelle : 25. Statuscodes
Statuscode	Beschreibung
201	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
400	Ungültige Anforderung. Kann einer der folgenden Gründe sein: Ungültige Nutzlast: Qualifizierungsergebnis muss eines der folgenden Elemente sein: [alternativ, ausstehend, qualifiziert, nicht qualifiziert]. Ungültige Nutzlast: Qualifizierungselement-ID ist nicht vorhanden. Alle Qualifizierungselemente müssen zu derselben obersten Auftragsposition gehören. Ungültige Nutzlast: „serviceQualificationItem QualificationResult“ fehlt. Ungültige Nutzlast: Verbraucher ist nicht vorhanden.

Parameter des Antworttexts (JSON oder XML)


Name	Beschreibung
id	Sys_id des Qualifizierungskundenauftrags. Befindet sich in der Tabelle „Kundenauftrag“ [sn_ind_tmt_orm_order]. Datentyp: Zeichenfolge
href	Relativer Link zum Qualifizierungsreihenfolge-Datensatz. Datentyp: Zeichenfolge
Beschreibung	Beschreibung der Qualifizierungsanforderung, die aus dem Feld „short_description“ des Kundenauftrags abgerufen wird. Befindet sich in der Tabelle „Kundenauftrag“ [sn_ind_tmt_orm_order]. Datentyp: Zeichenfolge
externalId	Externe ID aus dem Feld „external_id“ des Kundenauftrags Befindet sich in der Tabelle „Kundenauftrag“ [sn_ind_tmt_orm_order]. Datentyp: Zeichenfolge
Qualifizierungsergebnis	Qualifizierungsstatus des Ergebnisfelds des Kundenauftrags Mögliche Werte: Alternative Keine Ausstehend Qualifiziert nicht qualifiziert Datentyp: Zeichenfolge
Staat	Status des Kundenauftrags aus dem Statusfeld des Kundenauftrags. Datentyp: Zeichenfolge
@type	Teil des TMF Open API-Standards. Anmerkung für die Qualifizierung. Dieser Wert ist immer `CheckServiceQualification`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
checkServiceQualificationDate	Datum und Uhrzeit der Qualifizierungsanforderung, die aus dem Feld „order_date“ des Kundenauftrags erstellt wurde. Befindet sich in der Tabelle „Kundenauftrag“ [sn_ind_tmt_orm_order]. Format: JJJJ-MM-TTTHH:MM:SS.SSZZ Datentyp: Zeichenfolge
effektivQualifizierungsdatum	Gültigkeitsdatum der Qualifizierung, abgerufen aus dem Feld „order_date“ des Kundenauftrags. Befindet sich in der Tabelle „Kundenauftrag“ [sn_ind_tmt_orm_order]. Format: JJJJ-MM-TTTHH:MM:SS.SSZZ Datentyp: Zeichenfolge
erwartetes Qualifizierungsdatum	Speichert das erwartete Qualifizierungsdatum. Im Feld „expected_end_date“ des Kundenauftrags beibehalten Befindet sich in der Tabelle „Kundenauftrag“ [sn_ind_tmt_orm_order]. Format: JJJJ-MM-TTTHH:MM:SS.SSZZ Datentyp: Zeichenfolge
Zugehörige Partei	Liste der Kontakte für die Qualifizierungsanforderung. Jeder Kontakt ist ein Objekt im Array. Datentyp: Array von Objekten `"relatedParty": [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ]`
Zugehörigepartei.id	Sys_id oder external_id des Accounts, Kundenkontakts oder Verbrauchers, der dem Auftrag zugeordnet ist. Zu finden in der Tabelle „Account“ [customer_account], „Kontakt“ [customer_contact] oder „Verbraucher“ [csm_consumer]. Datentyp: Zeichenfolge
Zugehörigepartei.name	Name des Accounts, Kunden oder Verbrauchers. Datentyp: Zeichenfolge
zugehörigepartei.@typ	Teil des TMF Open API-Standards. Anmerkung für den Kontakt des Bestellpositionselements. Dieser Wert ist immer `RelatedParty`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
zugehörigepartei.@referenztyp	Typ der zugehörigen Partei. Mögliche Werte: Verbraucher Kunde Kundenkontakt Datentyp: Zeichenfolge
serviceQualificationItem	Liste der Servicequalifizierungselemente mit Informationen zu Standort, Serviceinformationen und Servicemerkmalen. Werden als Bestellpositionen für den Kundenauftrag gespeichert. Datentyp: Array von Objekten `"serviceQualificationItem": [ { "id": "String", "action": "String", "expectedServiceAvailabilityDate": "Number", "service": {Object}, "@type": "String" } ],`
serviceQualificationItem.id	ID des Qualifizierungselements. Wird im Feld „external_id“ der Kundenauftragsposition in der Tabelle „Auftragspositionselement“ [sn_ind_tmt_orm_order_line_item] gespeichert. Datentyp: Zeichenfolge
serviceQualifikationselement.qualifizierungsergebnis	Ergebnis des Qualifizierungselements. Wird im Feld „Ergebnis“ der Kundenauftragsposition gespeichert. Befindet sich in der Tabelle „Auftragspositionselement“ [sn_ind_tmt_orm_order_line_item]. Mögliche Werte: Alternative Keine Ausstehend Qualifiziert nicht qualifiziert Datentyp: Zeichenfolge
serviceQualifikationselement.status	Status des Qualifizierungselements, der aus dem Feld „Status“ der Kundenauftragsposition abgeleitet wird. Befindet sich in der Tabelle „Auftragspositionselement“ [sn_ind_tmt_orm_order_line_item]. Datentyp: Zeichenfolge
serviceQualificationItem.menge	Menge des Qualifizierungsartikels, abgeleitet aus dem Feld „Menge“ der Kundenauftragsposition. Befindet sich in der Tabelle „Auftragspositionselement“ [sn_ind_tmt_orm_order_line_item]. Datentyp: Zahl
serviceQualificationItem.@type	Teil des TMF Open API-Standards. Anmerkung für das Qualifizierungselement. Dieser Wert ist immer ServiceQualificationItem. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
serviceQualificationItem.service	Serviceinformationen, die Details zu Standort (Ort), Servicespezifikationen und Servicemerkmalen enthalten. Datentyp: Objekt `"service": { "@type": "String", "place": [Array], "serviceCharacteristic": [Array], "serviceSpecification": {Object} }`
serviceQualifikationselement.service.@type	Teil des API-Standards TMF Open. Anmerkung für den Service. Dieser Wert ist immer `Service`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
serviceQualifikationsElement.service.Ort	Standortinformationen für das Servicequalifizierungselement. Datentyp: Array von Objekten Hinweis: Dieses Array kann nur einen Ort enthalten. `"place": [ { "id": "String", "name": "String", "@referredType": "String" } ]`
serviceQualificationItem.service.place.id	Sys_id eines Standorts in der Standorttabelle [cmn_location]. Datentyp: Zeichenfolge
serviceQualificationItem.service.place.name	Name des Standorts. Nicht anhand eines Eintrags in der Standorttabelle [cmn_location] verifiziert. Datentyp: Zeichenfolge
serviceQualifikationsElement.service.Ort.@Typ	Teil des TMF Open API-Standards. Anmerkung für Service. Dieser Wert ist immer `GeographicSite`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
serviceQualifikationsElement.service.serviceSpezifikation	Servicespezifikationsdetails für das Qualifizierungselement. Datentyp: Array von Objekten `"serviceSpecification": { "id": "String", "internalVersion": "Number", "internalId": "String", "name": "String" "@type": "ServiceSpecification" "version": "String", }`
serviceQualificationItem.service.serviceSpecification.id	Externe ID oder Anfangsversion der Servicespezifikation. Datentyp: Zeichenfolge
serviceQualificationItem.service.serviceSpecification.name	Name der Servicespezifikation. Datentyp: Zeichenfolge
serviceQualifikationselement.service.servicespezifikation.version	Externe Version der Servicespezifikation. Datentyp: Zeichenfolge
serviceQualifikationselement.service.serviceSpezifikation.interneVersion	Interne Version der Servicespezifikation. Datentyp: Zahl
serviceQualifikationselement.service.serviceSpezifikation.interneID	Anfangsversion der Servicespezifikation. Datentyp: Zeichenfolge
serviceQualificationItem.service.serviceSpecification.@type	Teil des TMF Open API-Standards. Anmerkung für Servicespezifikation. Dieser Wert ist immer `ServiceSpecification`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
serviceQualificationItem.service.serviceMerkmal	Liste der Servicemerkmale. Datentyp: Array von Objekten `"serviceCharacteristic": [ { "name": "String", "value": "String" "valueType": "String", } ]`
serviceQualifikationsElement.service.serviceMerkmal.wertTyp	Werttyp des Merkmals. Datentyp: Zeichenfolge
serviceQualificationItem.service.serviceMerkmal.name	Name des Merkmals. Datentyp: Zeichenfolge
serviceQualificationItem.service.serviceMerkmal.wert	Wert des Merkmals. Datentyp: Zeichenfolge
Servicequalifizierungselement.alternativesServicevorschlag	Alternativer Servicevorschlag für den Qualifizierungsauftrag. Alternative Vorschläge werden in der Tabelle „Alternative Vorschläge“ [sn_ord_qual_mgmt_alterate_proposal] gespeichert. Datentyp: Zeichenfolge
ServiceQualificationItem.alternateServiceProposal.id	Sys_id des alternativen Vorschlagseintrags in der Tabelle „Alternative Vorschläge“ [sn_ord_qual_mgmt_alterate_proposal]. Datentyp: Zeichenfolge
ServiceQualifizierungselement.alternativesServicevorschlag.alternatServiceverfügbarkeitsdatum	Der Wert im Feld „available_date“ des alternativen Vorschlagseintrags in der Tabelle „Alternativer Vorschlag“ [sn_ord_qual_mgmt_alterate_proposal] Datentyp: Zeichenfolge
serviceQualifizierungselement.alternativesServiceangebot.alternativerService	Serviceinformationen, die durch den alternativen Vorschlag dargestellt werden. Datentyp: Objekt
serviceQualificationItem.alternatServiceVorschlag.alternatService.serviceSpezifikation	Die Servicespezifikation des alternativen Vorschlags wurde in der Spezifikation der Tabelle „Alternatives Angebot“ [sn_ord_qual_mgmt_alternat_proposal] beibehalten. Datentyp: Objekt
serviceQualificationItem alternativeServiceProposal.alterateService.serviceSpecification.id	Externe ID oder Anfangsversion der alternativen Servicespezifikation. Datentyp: Zeichenfolge
serviceQualificationItem alternativeServiceVorschlag.alternatService.serviceSpezifikation.name	Name der alternativen Servicespezifikation. Datentyp: Zeichenfolge
serviceQualificationItem alternativeServiceVorschlag.alternatService.serviceSpezifikation.version	Externe Version der alternativen Servicespezifikation. Datentyp: Zeichenfolge
serviceQualificationItem alternativeServiceVorschlag.alternatService.serviceSpezifikation.interneVersion	Interne Version der alternativen Servicespezifikation. Datentyp: Zahl
serviceQualificationItem alternativeServiceVorschlag.alternatService.serviceSpezifikation.interneID	Ursprüngliche Version der alternativen Servicespezifikation. Datentyp: Zeichenfolge
ServiceQualificationItem alternativeServiceProposal.alternatService.serviceSpecification.@type	Teil des TMF Open API-Standards. Anmerkung für Servicespezifikation. Dieser Wert ist immer `ServiceSpecification`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
serviceQualificationItem alternativeServiceProposal.alterateService.serviceCharacterificent	Array von Servicemerkmalen für den alternativen Servicevorschlag. Datentyp: Array von Objekten `"serviceCharacteristic": [ { "name": "String", "value": "String", "valueType": "String" } ]`
serviceQualificationItem alternativeServiceVorschlag.alternatService.serviceMerkmal.wertTyp	Werttyp des alternativen Servicemerkmals. Datentyp: Zeichenfolge
serviceQualificationItem alternativeServiceVorschlag.alternatService.serviceMerkmal.name	Name des alternativen Servicemerkmals. Datentyp: Zeichenfolge
serviceQualificationItem alternativeServiceVorschlag.alternatService.serviceMerkmal.wert	Wert des alternativen Servicemerkmals. Datentyp: Zeichenfolge
serviceQualificationItem.eligibilityUnavailabilityReason	Eine Liste der Gründe für die Nichtverfügbarkeit der Serviceberechtigung, um zu erklären, warum der Service nicht verfügbar ist. Dieser Wert wird im Feld „unavailability_reason“ der Tabelle „Domänenauftrag“ [sn_ind_tmt_orm_domain_order] gespeichert. Datentyp: Array
serviceQualificationItem.eligibilityUnavailabilityReason.code	Ursachencode für Nichtverfügbarkeit von Serviceberechtigung. Datentyp: Zeichenfolge
serviceQualifikationselement.BerechtigungNichtverfügbarkeitGrund.Bezeichnung	Bezeichnung des Grunds für Nichtverfügbarkeit von Serviceberechtigung. Datentyp: Zeichenfolge

Beispiel für eine cURL-Anforderung

Das folgende Beispiel zeigt, wie der -Endpunkt eine in der API-Anforderung gesendete Qualifizierungsreihenfolge verarbeitet.

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

Antworttext:

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