Offene API für Qualifizierung technischer Services

Freigeben Version: Washingtondc

Aktualisiert 1. Februar 2024

44 Minuten Lesedauer

Mit der offenen API für Qualifizierung technischer Services können Sie die Verfügbarkeit von Ressourcen und Services überprüfen, bevor Aufträge zur Erfüllung gesendet werden.

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

Die offene API für Qualifizierung technischer Services wird im Namespace sn_ord_qual_mgmt bereitgestellt und erfordert die folgenden Plugins:

Product Catalog Management Core [com.sn_prd_pm]
Product Catalog – Vertiefung [com.sn_prd_pm_adv]
Order Qualification Management [com.sn_ord_qual_mgmt]
Order Management für 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.

Qualifizierung technischer Services Open API – 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:

Kundenauftrag [sn_ind_tmt_orm_order]
Auftragspositionselement [sn_ind_tmt_orm_order_line_item]

URL-Format

Versionierte URL: /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. 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	Anforderung erfolgreich verarbeitet.
400	Ungültige Anforderung. Mögliche Gründe: Ungültiger Pfadparameter Ungültiger URI
404	Nicht gefunden. Das angeforderte Element wurde nicht gefunden.

Antworttextparameter (JSON oder XML)


Name	Beschreibung
id	Sys_id des Qualifizierungskundenauftrags. Datentyp: Zeichenfolge
href	Relativer Link zum Datensatz der Qualifizierungsreihenfolge. Datentyp: Zeichenfolge
Beschreibung	Beschreibung der Qualifizierungsanforderung, die aus dem Feld short_description des Kundenauftrags abgerufen wird. Datentyp: Zeichenfolge
externe ID	Externe ID aus dem Feld „external_id“ des Kundenauftrags. Datentyp: Zeichenfolge
Qualifizierungsergebnis	Qualifizierungsstatus des Ergebnisfelds des Kundenauftrags. Mögliche Werte: Alternative Ausstehend Keine Qualifiziert nicht qualifiziert Datentyp: Zeichenfolge
Status	Status des Kundenauftrags aus dem Statusfeld des Kundenauftrags. Datentyp: Zeichenfolge
@type	Teil des TMF Open API-Standards. Anmerkung für 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. Format: JJJJ-MM-TTTHH:MM:SS.SSSZ Datentyp: Zeichenfolge
effektiveQualifizierungDatum	Effektives Qualifizierungsdatum, das aus dem Feld order_date des Kundenauftrags abgerufen wurde. Format: JJJJ-MM-TTTHH:MM:SS.SSSZ Datentyp: Zeichenfolge
erwartetes Qualifizierungsdatum	Speichert das erwartete Qualifizierungsdatum. Wird im Feld „expected_end_date“ des Kundenauftrags beibehalten. Format: JJJJ-MM-TTTHH:MM:SS.SSSZ Datentyp: Zeichenfolge
relatedPartei	Liste der Kontakte für die Qualifizierungsanforderung. Jeder Kontakt ist ein Objekt im Array. Datentyp: Array von Objekten `"relatedParty": [ { "id": "String", "name": "String", "@type": "String", "@referredType": "String" } ]`
relatedPartei.id	Sys_id oder external_id des Accounts, Kundenkontakts oder Verbrauchers, der dem Auftrag zugeordnet ist. Befindet sich in der Tabelle „Account“ [customer_account], „Kontakt“ [customer_contact] oder „Verbraucher“ [csm_consumer]. Datentyp: Zeichenfolge
relatedPartei.name	Name des Accounts, Kunden oder Verbrauchers. Datentyp: Zeichenfolge
relatedPartei.@Typ	Teil des TMF Open API-Standards. Anmerkung für den Kontakt der Bestellposition. Dieser Wert ist immer RelatedPartei. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
relatedPartei.@referenziertTyp	Typ der zugehörigen Partei. Mögliche Werte: Kunde Kundenkontakt Verbraucher Datentyp: Zeichenfolge
serviceQualificationItem	Liste der Servicequalifizierungselemente, die Informationen zu Standort, Serviceinformationen und Servicemerkmalen enthalten. Als Auftragspositionen für den Kundenauftrag gespeichert. Datentyp: Array von Objekten `"serviceQualificationItem": [ { "id": "string", "action": "string", "expectedServiceAvailabilityDate": "number", "service": { "place": [ { "id": "string", "name": "string" } ], "serviceCharacteristic": [ { "valueType": "string", "name": "string", "value": "string" } ], "serviceSpecification": { "id": "string", "name": "string" } }, "@type": "ServiceQualificationItem" } ],`
serviceQualificationItem.id	ID des Qualifizierungselements. Wird im Feld „external_id“ der Kundenauftragsposition gespeichert. Datentyp: Zeichenfolge
serviceQualificationItem.qualificationResult	Ergebnis des Qualifizierungselements. Wird im Feld „Ergebnis“ der Kundenauftragsposition gespeichert. Mögliche Werte: Alternative Keine Ausstehend Qualifiziert nicht qualifiziert Datentyp: Zeichenfolge
serviceQualifizierungselement.status	Status des Qualifizierungselements, abgeleitet aus dem Feld „Status“ der Kundenauftragsposition. Datentyp: Zeichenfolge
serviceQualifizierungselement.Menge	Menge des Qualifizierungselements, die aus dem Feld „Menge“ der Kundenauftragsposition abgeleitet wird. 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
serviceQualifizierungselement.service	Serviceinformationen, die Details zu Standort (Ort), Servicespezifikationen und Servicemerkmalen enthalten. Datentyp: Objekt `"service": { "place": [ { "id": "String", "name": "String" } ], "serviceCharacteristic": [ { "valueType": "String", "name": "String", "value": "String" } ], "serviceSpecification": { "id": "String", "name": "String" } }`
serviceQualificationItem.service.@type	Teil des API-Standards TMF Open. Anmerkung für Service. Dieser Wert ist immer Service. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
serviceQualifikationselement.service.place	Standortinformationen für das Servicequalifizierungselement. Datentyp: Array von Objekten. Hinweis: Dieses Array kann nur einen Speicherort enthalten. `"place": [ { "id": "5671dd2ec3a53010188473ce3640dd81", "name": "Jean Pontus home", "@referredType": "GeographicSite" } ]`
serviceQualificationItem.service.place.id	Sys_id eines Standorts in der Tabelle „Standort“ [cmn_location]. Datentyp: Zeichenfolge
serviceQualificationItem.service.place.name	Name des Standorts. Nicht anhand eines Eintrags in der Tabelle „Standort“ [cmn_location] überprüft. Datentyp: Zeichenfolge
serviceQualificationItem.service.place.@type	Teil des TMF Open API-Standards. Anmerkung für Service. Dieser Wert ist immer GeographicSite. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
serviceQualificationItem.service.serviceSpecification	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
serviceQualificationItem.service.serviceSpecification.version	Externe Version der Servicespezifikation. Datentyp: Zeichenfolge
serviceQualificationItem.service.serviceSpecification.internalVersion	Interne Version der Servicespezifikation. Datentyp: Zahl
serviceQualificationItem.service.serviceSpecification.internalId	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.serviceCharacteristic	Liste der Servicemerkmale. Datentyp: Array von Objekten `"serviceCharacteristic": [ { "name": "Speed", "value": "High" "valueType": "string", } ]`
serviceQualificationItem.service.serviceCharacteristic.valueType	Werttyp des Merkmals. Datentyp: Zeichenfolge
serviceQualificationItem.service.serviceCharacteristic.name	Name des Merkmals. Datentyp: Zeichenfolge
serviceQualificationItem.service.serviceCharacteristic.value	Wert des Merkmals. Datentyp: Zeichenfolge
ServiceQualificationItem.alternateServiceProposal	Alternativer Servicevorschlag für den Qualifizierungsauftrag. Alternative Vorschläge werden in der Tabelle „Alternativer Vorschlag“ [sn_ord_qual_mgmt_alternate_proposal] gespeichert. Datentyp: Zeichenfolge
ServiceQualificationItem.alternateServiceProposal.id	Sys_id des alternativen Vorschlagseintrags in der Tabelle „Alternativer Vorschlag“ [sn_ord_qual_mgmt_alternate_proposal]. Datentyp: Zeichenfolge
ServiceQualificationItem.alternateServiceProposal.alternateServiceAvailabilityDate	Der Wert im Feld available_date des Eintrags für alternative Vorschläge in der Tabelle „Alternativer Vorschlag“ [sn_ord_qual_mgmt_alternate_proposal]. Datentyp: Zeichenfolge
serviceQualificationItem.alternateServiceProposal.alternateService	Serviceinformationen, die durch den alternativen Vorschlag dargestellt werden. Datentyp: Objekt
serviceQualificationItem.alternateServiceProposal.alternateService.serviceSpecification	Die Servicespezifikation des alternativen Vorschlags wurde in der Tabelle „Spezifikation des alternativen Vorschlags“ [sn_ord_qual_mgmt_alternate_proposal] beibehalten. Datentyp: Objekt
serviceQualificationItem „alternativeServiceProposal.alternateService.serviceSpecification.id“	Externe ID oder Anfangsversion der alternativen Servicespezifikation. Datentyp: Zeichenfolge
serviceQualificationItem alternativeServiceVorschlag.alternateService.serviceSpecification.name	Name der alternativen Servicespezifikation. Datentyp: Zeichenfolge
serviceQualificationItem alternativeServiceVorschlag.alternateService.serviceSpecification.version	Externe Version der alternativen Servicespezifikation. Datentyp: Zeichenfolge
serviceQualificationItem „alternativeServiceProposal.alternateService.serviceSpecification.internalVersion“	Interne Version der alternativen Servicespezifikation. Datentyp: Zahl
serviceQualificationItem „alternativeServiceProposal.alternateService.serviceSpecification.internalId“	Anfangsversion der Spezifikation des alternativen Service. Datentyp: Zeichenfolge
ServiceQualificationItem „alternativeServiceProposal.alternateService.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.alternateService.serviceCharacteristic“	Array von Servicemerkmalen für den alternativen Servicevorschlag. Datentyp: Array von Objekten `"serviceCharacteristic": [ { "valueType": "String", "name": "String", "value": "String" } ]`
serviceQualificationItem „alternativeServiceProposal.alternateService.serviceCharacteristic.valueType“	Werttyp des alternativen Servicemerkmals. Datentyp: Zeichenfolge
serviceQualificationItem alternativeServiceVorschlag.alternateService.serviceCharacteristic.name	Name des alternativen Servicemerkmals. Datentyp: Zeichenfolge
serviceQualificationItem „alternativeServiceProposal.alternateService.serviceCharacteristic.value“	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 in „unavailability_reason“ der Tabelle „Domänenauftrag“ [sn_ind_tmt_orm_domain_order] beibehalten. Datentyp: Array
serviceQualificationItem.eligibilityUnavailabilityReason.code	Ursachencode für Nichtverfügbarkeit von Serviceberechtigung. Datentyp: Zeichenfolge
serviceQualificationItem.eligibilityUnavailabilityReason.label	Bezeichnung des Nichtverfügbarkeitsgrunds für Serviceberechtigung. Datentyp: Zeichenfolge

Beispiel für eine cURL-Anforderung

Im folgenden Beispiel wird ein vollständiger spezifischer Qualifizierungsauftrag abgerufen, der einer bestimmten 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"
  }
]

Qualifizierung technischer Services Open API – GET sn_ord_qual_mgmt/qualification/checkServiceQualification

Ruft eine Liste aller technischen Qualifizierungsanforderungen ab.

Dieser Endpunkt ruft Bestellinformationen aus den folgenden Tabellen ab:

Kundenauftrag [sn_ind_tmt_orm_order]
Auftragspositionselement [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

Versionierte URL: /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
Felder	Liste der Feldnamen, die in der Antwort vonzurückgegeben werden sollen. Ungültige Felder werden ignoriert. Wenn dieser Parameter in der Anforderung nicht angegeben ist, 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 Offset-Parameter, um den Datensatzabruf zu paginieren. Standard: 20 Höchstwert: 100 Datentyp: Zahl
Status	Filtert Qualifizierungsaufträge nach Status. Nur Aufträge mit einem Status, der dem Wert dieses Parameters entspricht, werden in der Antwort zurückgegeben. Datentyp: Zeichenfolge
Beschreibung	Filtert Qualifizierungsaufträge nach dem Feld „short_description“ des Kundenauftrags. Nur Aufträge mit einer Kurzbeschreibung, die dem Wert dieses Parameters entspricht, werden in der Antwort zurückgegeben. Datentyp: Zeichenfolge
Qualifizierungsergebnis	Filtert Qualifizierungsreihenfolgen nach Ergebnis. Nur Aufträge mit einem Ergebnis, das dem Wert dieses Parameters entspricht, werden in der Antwort zurückgegeben. Datentyp: Zeichenfolge Format:

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	In Antwort zurückgegebene Teilressource (mit Paginierung).
400	Ungültige Anforderung. Mögliche Gründe: Ungültiger Pfadparameter Ungültiger URI
404	Kein Datensatz für die Filterkriterien gefunden.

Antworttextparameter (JSON oder XML)


Name	Beschreibung
id	Sys_id des Qualifizierungskundenauftrags. Datentyp: Zeichenfolge
href	Relativer Link zum Datensatz der Qualifizierungsreihenfolge. Datentyp: Zeichenfolge
Beschreibung	Beschreibung der Qualifizierungsanforderung, die aus dem Feld short_description des Kundenauftrags abgerufen wird. Datentyp: Zeichenfolge
externe ID	Externe ID aus dem Feld „external_id“ des Kundenauftrags. Datentyp: Zeichenfolge
Qualifizierungsergebnis	Qualifizierungsstatus des Ergebnisfelds des Kundenauftrags. Mögliche Werte: Alternative Ausstehend Keine Qualifiziert nicht qualifiziert Datentyp: Zeichenfolge
Status	Status des Kundenauftrags aus dem Statusfeld des Kundenauftrags. Datentyp: Zeichenfolge
@type	Teil des TMF Open API-Standards. Anmerkung für 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. Format: JJJJ-MM-TTTHH:MM:SS.SSSZ Datentyp: Zeichenfolge
effektiveQualifizierungDatum	Effektives Qualifizierungsdatum, das aus dem Feld order_date des Kundenauftrags abgerufen wurde. Format: JJJJ-MM-TTTHH:MM:SS.SSSZ Datentyp: Zeichenfolge
erwartetes Qualifizierungsdatum	Speichert das erwartete Qualifizierungsdatum. Wird im Feld „expected_end_date“ des Kundenauftrags beibehalten. Format: JJJJ-MM-TTTHH:MM:SS.SSSZ Datentyp: Zeichenfolge
relatedPartei	Liste der Kontakte für die Qualifizierungsanforderung. Jeder Kontakt ist ein Objekt im Array. Datentyp: Array von Objekten `"relatedParty": [ { "id": "String", "name": "String", "@type": "String", "@referredType": "String" } ]`
relatedPartei.id	Sys_id oder external_id des Accounts, Kundenkontakts oder Verbrauchers, der dem Auftrag zugeordnet ist. Befindet sich in der Tabelle „Account“ [customer_account], „Kontakt“ [customer_contact] oder „Verbraucher“ [csm_consumer]. Datentyp: Zeichenfolge
relatedPartei.name	Name des Accounts, Kunden oder Verbrauchers. Datentyp: Zeichenfolge
relatedPartei.@Typ	Teil des TMF Open API-Standards. Anmerkung für den Kontakt der Bestellposition. Dieser Wert ist immer RelatedPartei. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
relatedPartei.@referenziertTyp	Typ der zugehörigen Partei. Mögliche Werte: Kunde Kundenkontakt Verbraucher Datentyp: Zeichenfolge
serviceQualificationItem	Liste der Servicequalifizierungselemente, die Informationen zu Standort, Serviceinformationen und Servicemerkmalen enthalten. Als Auftragspositionen für den Kundenauftrag gespeichert. Datentyp: Array von Objekten `"serviceQualificationItem": [ { "id": "string", "action": "string", "expectedServiceAvailabilityDate": "number", "service": { "place": [ { "id": "string", "name": "string" } ], "serviceCharacteristic": [ { "valueType": "string", "name": "string", "value": "string" } ], "serviceSpecification": { "id": "string", "name": "string" } }, "@type": "ServiceQualificationItem" } ],`
serviceQualificationItem.id	ID des Qualifizierungselements. Wird im Feld „external_id“ der Kundenauftragsposition gespeichert. Datentyp: Zeichenfolge
serviceQualificationItem.qualificationResult	Ergebnis des Qualifizierungselements. Wird im Feld „Ergebnis“ der Kundenauftragsposition gespeichert. Mögliche Werte: Alternative Keine Ausstehend Qualifiziert nicht qualifiziert Datentyp: Zeichenfolge
serviceQualifizierungselement.status	Status des Qualifizierungselements, abgeleitet aus dem Feld „Status“ der Kundenauftragsposition. Datentyp: Zeichenfolge
serviceQualifizierungselement.Menge	Menge des Qualifizierungselements, die aus dem Feld „Menge“ der Kundenauftragsposition abgeleitet wird. 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
serviceQualifizierungselement.service	Serviceinformationen, die Details zu Standort (Ort), Servicespezifikationen und Servicemerkmalen enthalten. Datentyp: Objekt `"service": { "place": [ { "id": "String", "name": "String" } ], "serviceCharacteristic": [ { "valueType": "String", "name": "String", "value": "String" } ], "serviceSpecification": { "id": "String", "name": "String" } }`
serviceQualificationItem.service.@type	Teil des API-Standards TMF Open. Anmerkung für Service. Dieser Wert ist immer Service. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
serviceQualifikationselement.service.place	Standortinformationen für das Servicequalifizierungselement. Datentyp: Array von Objekten. Hinweis: Dieses Array kann nur einen Speicherort enthalten. `"place": [ { "id": "5671dd2ec3a53010188473ce3640dd81", "name": "Jean Pontus home", "@referredType": "GeographicSite" } ]`
serviceQualificationItem.service.place.id	Sys_id eines Standorts in der Tabelle „Standort“ [cmn_location]. Datentyp: Zeichenfolge
serviceQualificationItem.service.place.name	Name des Standorts. Nicht anhand eines Eintrags in der Tabelle „Standort“ [cmn_location] überprüft. Datentyp: Zeichenfolge
serviceQualificationItem.service.place.@type	Teil des TMF Open API-Standards. Anmerkung für Service. Dieser Wert ist immer GeographicSite. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
serviceQualificationItem.service.serviceSpecification	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
serviceQualificationItem.service.serviceSpecification.version	Externe Version der Servicespezifikation. Datentyp: Zeichenfolge
serviceQualificationItem.service.serviceSpecification.internalVersion	Interne Version der Servicespezifikation. Datentyp: Zahl
serviceQualificationItem.service.serviceSpecification.internalId	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.serviceCharacteristic	Liste der Servicemerkmale. Datentyp: Array von Objekten `"serviceCharacteristic": [ { "name": "Speed", "value": "High" "valueType": "string", } ]`
serviceQualificationItem.service.serviceCharacteristic.valueType	Werttyp des Merkmals. Datentyp: Zeichenfolge
serviceQualificationItem.service.serviceCharacteristic.name	Name des Merkmals. Datentyp: Zeichenfolge
serviceQualificationItem.service.serviceCharacteristic.value	Wert des Merkmals. Datentyp: Zeichenfolge
ServiceQualificationItem.alternateServiceProposal	Alternativer Servicevorschlag für den Qualifizierungsauftrag. Alternative Vorschläge werden in der Tabelle „Alternativer Vorschlag“ [sn_ord_qual_mgmt_alternate_proposal] gespeichert. Datentyp: Zeichenfolge
ServiceQualificationItem.alternateServiceProposal.id	Sys_id des alternativen Vorschlagseintrags in der Tabelle „Alternativer Vorschlag“ [sn_ord_qual_mgmt_alternate_proposal]. Datentyp: Zeichenfolge
ServiceQualificationItem.alternateServiceProposal.alternateServiceAvailabilityDate	Der Wert im Feld available_date des Eintrags für alternative Vorschläge in der Tabelle „Alternativer Vorschlag“ [sn_ord_qual_mgmt_alternate_proposal]. Datentyp: Zeichenfolge
serviceQualificationItem.alternateServiceProposal.alternateService	Serviceinformationen, die durch den alternativen Vorschlag dargestellt werden. Datentyp: Objekt
serviceQualificationItem.alternateServiceProposal.alternateService.serviceSpecification	Die Servicespezifikation des alternativen Vorschlags wurde in der Tabelle „Spezifikation des alternativen Vorschlags“ [sn_ord_qual_mgmt_alternate_proposal] beibehalten. Datentyp: Objekt
serviceQualificationItem „alternativeServiceProposal.alternateService.serviceSpecification.id“	Externe ID oder Anfangsversion der alternativen Servicespezifikation. Datentyp: Zeichenfolge
serviceQualificationItem alternativeServiceVorschlag.alternateService.serviceSpecification.name	Name der alternativen Servicespezifikation. Datentyp: Zeichenfolge
serviceQualificationItem alternativeServiceVorschlag.alternateService.serviceSpecification.version	Externe Version der alternativen Servicespezifikation. Datentyp: Zeichenfolge
serviceQualificationItem „alternativeServiceProposal.alternateService.serviceSpecification.internalVersion“	Interne Version der alternativen Servicespezifikation. Datentyp: Zahl
serviceQualificationItem „alternativeServiceProposal.alternateService.serviceSpecification.internalId“	Anfangsversion der Spezifikation des alternativen Service. Datentyp: Zeichenfolge
ServiceQualificationItem „alternativeServiceProposal.alternateService.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.alternateService.serviceCharacteristic“	Array von Servicemerkmalen für den alternativen Servicevorschlag. Datentyp: Array von Objekten `"serviceCharacteristic": [ { "valueType": "String", "name": "String", "value": "String" } ]`
serviceQualificationItem „alternativeServiceProposal.alternateService.serviceCharacteristic.valueType“	Werttyp des alternativen Servicemerkmals. Datentyp: Zeichenfolge
serviceQualificationItem alternativeServiceVorschlag.alternateService.serviceCharacteristic.name	Name des alternativen Servicemerkmals. Datentyp: Zeichenfolge
serviceQualificationItem „alternativeServiceProposal.alternateService.serviceCharacteristic.value“	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 in „unavailability_reason“ der Tabelle „Domänenauftrag“ [sn_ind_tmt_orm_domain_order] beibehalten. Datentyp: Array
serviceQualificationItem.eligibilityUnavailabilityReason.code	Ursachencode für Nichtverfügbarkeit von Serviceberechtigung. Datentyp: Zeichenfolge
serviceQualificationItem.eligibilityUnavailabilityReason.label	Bezeichnung des Nichtverfügbarkeitsgrunds für 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"
}
]

Qualifizierung technischer Services Open API – POST sn_ord_qual_mgmt/qualification/checkServiceQualification

Erstellt eine Entität für die Qualifizierungsanforderung für technische Services, 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 Auftragstabelle [sn_ind_tmt_orm_order_line_item] gespeichert.

Verwenden dieses Endpunkts

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

Fordern Sie die Qualifizierung eines Service an einer angegebenen Adresse an.
Fordern Sie die Qualifizierung eines neuen Service am selben Standort eines vorhandenen und aktiven Access-Service an.
Fordern Sie ein Upgrade oder Downgrade eines vorhandenen Service an.

Jeder Anwendungsfall erfordert dieselbe Anforderungsstruktur, verwendet jedoch unterschiedliche Anforderungsparameter. Details zu jedem Anwendungsfall und akzeptierten Parametern werden bereitgestellt:

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 Ort wie ein vorhandener und aktiver 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.
Um einen vorhandenen Service zu aktualisieren oder zu downgraden, verwenden Sie das Objekt serviceInventory (serviceQualificationItem.service.ServiceInventory) anstelle des Arrays place oder des Objekts referenceServiceInventory. In diesem Anwendungsfall werden Standortinformationen und Spezifikationsdetails aus 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 und 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 das verbleibende Merkmal aus dem vorhandenen Service ab.

Informationen zum Erstellen Ihrer API-Anforderung für Ihren speziellen Anwendungsfall finden Sie in den Beispielaufrufen im Abschnitt „Beispiel“ dieser Seite.

URL-Format

Versionierte URL: /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
Beschreibung	Optional. Die Beschreibung der Qualifizierungsanforderung, die im Feld „short_description“ des Kundenauftrags gespeichert und beibehalten wird. Datentyp: Zeichenfolge
checkServiceQualificationDate	Optional. Speichert das Datum und die Uhrzeit der Erstellung der Qualifizierungsanforderung . In Feld „order_date“ des Kundenauftrags beibehalten. Wenn nicht angegeben, wird „order_date“ auf das aktuelle Datum und die aktuelle Uhrzeit festgelegt. Datentyp: Zeichenfolge Format: JJJJ-MM-TTTHH:MM:SS.SSSZ
effektiveQualifizierungDatum	Optional. Speichert das erwartete Qualifizierungsdatum. Im Feld „actual_end_date“ des Kundenauftrags beibehalten. Datentyp: Zeichenfolge Format: JJJJ-MM-TTTHH:MM:SS.SSSZ
erwartetes Qualifizierungsdatum	Optional. Speichert das erwartete Qualifizierungsdatum. Wird im Feld „expected_end_date“ des Kundenauftrags beibehalten. Datentyp: Zeichenfolge Format: JJJJ-MM-TTTHH:MM:SS.SSSZ
externe ID	Optional. Externale ID des Kundenauftrags, beibehalten in „external_id“ des Kundenauftrags. Datentyp: Zeichenfolge
relatedPartei	Erforderlich. Liste der Kontakte, die der Qualifizierungsanforderung zugeordnet sind (z. B. Kunden-Accounts, Kontakte usw.). Als Array formatiert, muss relatedParty mindestens ein Objekt auflisten, das Kunden- oder Verbraucherkontoinformationen enthält. Datentyp: Array von Objekten `"relatedParty": [ { "id": "String", "name": "String", "@referredType": "String" "@type": "String", }, ]`
relatedPartei.id	Erforderlich. Sys_id oder external_id des Accounts, Kundenkontakts oder Verbrauchers, der dem Auftrag zugeordnet ist. Befindet sich in der Tabelle „Account“ [customer_account], „Kontakt“ [customer_contact] oder „Verbraucher“ [csm_consumer]. Datentyp: Zeichenfolge
relatedPartei.name	Optional. Name des Accounts, Kunden oder Verbrauchers. Datentyp: Zeichenfolge
relatedPartei.@Typ	Optional. Teil des TMF Open API-Standards. Anmerkung für den Kontakt der Bestellposition. Dieser Wert ist immer RelatedPartei. Fürwerden diese Informationen nicht gespeichert. Datentyp: Zeichenfolge
relatedPartei.@referenziertTyp	Erforderlich. Typ der zugehörigen Partei. Gültige Werte: Kunde Kundenkontakt Verbraucher Datentyp: Zeichenfolge
serviceQualificationItem	Erforderlich. Liste von Servicequalifizierungselementen, die Informationen zu Standort, Servicespezifikationen und Servicemerkmalen enthalten. Als Auftragspositionen für den Kundenauftrag gespeichert. Fügen Sie mindestens ein Servicequalifizierungselement in die Liste ein. Datentyp: Array von Objekten `"serviceQualificationItem": [ { "id": "100", "action": "add", "expectedServiceAvailabilityDate": "2022-12-11T19:20:39.239Z", "service": { "place": [ { "id": "5671dd2ec3a53010188473ce3640dd81", "name": "Jean Pontus home" } ], "serviceCharacteristic": [ { "valueType": "string", "name": "Speed", "value": "High" } ], "serviceSpecification": { "id": "91478553b7969910ff00f203ae11a97d", "name": "Broadband Service" } }, "@type": "ServiceQualificationItem" } ],`
serviceQualificationItem.id	Erforderlich. ID des Qualifizierungselements. Wird im Feld „external_id“ der Kundenauftragsposition gespeichert. Datentyp: Zeichenfolge
serviceQualifizierungselement.Menge	Optional. Menge des Qualifizierungselements. Wird im Feld „Menge“ der Kundenauftragsposition beibehalten. Datentyp: Zahl Standard: 1
serviceQualificationItem.qualificationItemRelationship	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": [ { "relationshipType": "HasChild", "id": "110" }, { "relationshipType": "HasChild", "id": "120" }, { "relationshipType": "HasChild", "id": "130" } ] "qualificationItemRelationship": [ { "relationshipType": "HasParent", "id": "100" } ]`
serviceQualificationItem QualificationItemRelationship.relationshipType	Erforderlich. Gibt an, ob es sich bei dem Beziehungstyp um eine untergeordnete oder übergeordnete Position handelt. Akzeptierte Werte: HasChild: Gibt das untergeordnete Element an. HatParent: Gibt den übergeordneten Einzelposten an. Datentyp: Zeichenfolge
serviceQualificationItem.QualificationItemRelationship.id	Erforderlich. Die ID des Qualifizierungselements „tar“ in der Beziehung. Datentyp: Zeichenfolge
serviceQualifizierungselement.service	Erforderlich. Serviceinformationen, die Details zu Ort, Servicespezifikation und Servicemerkmalen enthalten. Datentyp: Objekt `"service": { "place": [ { "id": "5671dd2ec3a53010188473ce3640dd81", "name": "Jean Pontus home" } ], "serviceCharacteristic": [ { "valueType": "string", "name": "Speed", "value": "High" } ], "serviceSpecification": { "id": "91478553b7969910ff00f203ae11a97d", "name": "Broadband Service" } }`
serviceQualificationItem.service.@type	Optional. Teil des TMF Open API-Standards. Anmerkung zu Serviceinformationen für ein Qualifizierungselement. Dieser Wert ist immer Service. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
serviceQualificationItem.service.place	Erforderlich. Speichert die angeforderten Standortinformationen für das Servicequalifizierungselement. Diese Standort-ID muss ein gültiger Eintrag in der Standorttabelle [cmn_location] sein. Wichtig: Verwenden Sie das Orts-Array, um einen Service an einer bestimmten Adresse zu qualifizieren. Dazu müssen Sie die Objekte referenceServiceInventory und serviceInventory in Ihrer Anforderung auslassen, andernfalls gibt die API einen Fehler zurück. Datentyp: Array von Objekten Hinweis: Obwohl Arrays unterstützt werden, darf das Array nur einen Speicherort enthalten. Beispiel-Array: `"place": [ { "id": "5671dd2ec3a53010188473ce3640dd81", "name": "Jean Pontus home" } ]`
serviceQualificationItem.service.place.id	Erforderlich , wenn Sie serviceQualificationItem.service.place in Ihrer Anforderung verwenden. Die sys_id eines Standorts in der Tabelle „Standort“ [cmn_location]. Datentyp: Zeichenfolge
serviceQualificationItem.service.place.name	Optional, wenn Sie serviceQualificationItem.service.place in Ihrer Anforderung verwenden. Name des Standorts. Der Namenswert wird nicht anhand von Standorteinträgen [cmn_location] überprüft. Datentyp: Zeichenfolge
serviceQualificationItem.service.place.@type	Optional, wenn Sie serviceQualificationItem.service.place in Ihrer Anforderung verwenden. Teil des TMF Open API-Standards. Anmerkung für Service. Dieser Wert ist immer GeographicSite. Diese Informationen werden nicht gespeichert. 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 aus dem 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 auslassen, andernfalls gibt die API einen Fehler zurück. Datentyp: Objekt `"referenceServiceInventory": { "id": "f1b2d99e777301108e191e599a5a99d2" },`
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 Auftragsarbeitsnotizen erwähnt, aber nicht gespeichert. Datentyp: Zeichenfolge
serviceQualificationItem.service.serviceInventory	Erforderlich. Gültige Servicebestandsentität, die auf einen aktiven Service verweist, für den ein Upgrade oder Downgrade erforderlich ist. Wichtig: Verwenden Sie das Objekt serviceInventory für Service-Upgrades oder -Downgrades. Dazu müssen Sie das Ortsobjekt array und das referenceServiceInventory -Objekt in Ihrer Anforderung auslassen, andernfalls gibt die API einen Fehler zurück. Datentyp: Objekt `"serviceInventory": { "id": "f1b2d99e777301108e191e599a5a99d2" },` Der Parameter serviceCharacteristics ist erforderlich, wenn serviceInventory zum Definieren von Serviceänderungen verwendet wird. Standort- und Servicespezifikationsinformationen für den Qualifizierungsauftrag werden aus dem Standort bzw. der Spezifikation dieses Servicebestands abgerufen.
serviceQualificationItem.service.serviceInventory.id	Erforderlich, wenn serviceQualificationItem.service.serviceInventory in der Anforderung verwendet wird. Die sys_id einer gültigen vorhandenen Servicebestandsentität, die ein Upgrade oder Downgrade erfordert. Diese Informationen werden nur in den Auftragsarbeitsnotizen erwähnt, aber nicht gespeichert. Datentyp: Zeichenfolge
serviceQualificationItem.service.serviceSpecification	Erforderlich. Service Spezifikation für das Qualifizierungselement. Wird im Feld „service_specification“ der Kundenauftragsposition gespeichert. Servicespezifikation für ein Qualifizierungselement darf nicht auf Ressourcen ausgerichtet sein. Datentyp: Objekt `"serviceSpecification": { "id": "91478553b7969910ff00f203ae11a97d", "name": "Broadband Service", “@type”: ”ServiceSpecification” }`
serviceQualificationItem.service.serviceSpecification.id	Erforderlich. Externe ID oder Anfangsversion der Servicespezifikation. Datentyp: Zeichenfolge
serviceQualificationItem.service.serviceSpecification.name	Erforderlich. Name der Servicespezifikation. Datentyp: Zeichenfolge
serviceQualificationItem.service.serviceSpecification.Version	Optional. Externe Version der Servicespezifikation. Datentyp: Zeichenfolge
serviceQualificationItem.service.serviceSpecification.interne Version	Optional. Interne Version der Servicespezifikation Datentyp: Zahl
ServiceQualificationItem.service.serviceSpecification.@type	Optional. Teil des TMF Open API-Standards. Anmerkung für Servicespezifikation. Dieser Wert ist immer ServiceSpecification. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
serviceQualificationItem.service.serviceCharacteristic	Optional. Array von Servicemerkmalen. Datentyp: Array von Objekten
serviceQualificationItem.service.serviceCharacteristicvalueType	Optional. Werttyp des Merkmals. Datentyp: Zeichenfolge
serviceQualificationItem.service.serviceCharacteristic.name	Erforderlich. Name des Merkmals. Datentyp: Zeichenfolge
serviceQualificationItem.service.serviceCharacteristic.value	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
serviceQualificationItem.@type	Optional. Teil des TMF Open API-Standards. Anmerkung für Qualifizierungselement. Dieser Wert ist immer ServiceQualificationItem. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
@type	Optional. Teil des TMF Open API-Standards. Anmerkung für Qualifizierung. Dieser Wert ist immer CheckServiceQualification. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge

Header

Tabelle : 16. Anforderungskopfzeilen
Kopfzeile	Beschreibung
Akzeptieren	Datenformat des Antworttexts. 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 es Probleme mit den Merkmalen oder Merkmalsoptionsinformationen gibt, speichert der Endpunkt die folgenden Kommentare in den Arbeitsnotizfeldern des zugeordneten Datensatzes für Kundenauftragspositionen, ähnlich wie bei vorhandenen Lieferaufträgen
400	Ungültige Anforderung. Dies kann einen der folgenden Gründe haben: Leere Nutzlast. Ungültige Nutzlast: Pflichtfeld fehlt:<field name> Ungültige Nutzlast: Anforderungstext fehlt – Nutzlast wurde im Anforderungstext nicht übergeben. Ungültige Nutzlast: relatedPartei 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 referenceServiceInventory an. Ungültige Nutzlast: Die Spezifikationsinformationen fehlen. Geben Sie „serviceSpecification“ oder „serviceInventory“ an. Ungültige Nutzlast: Servicespezifikation ist nicht vorhanden. Ungültige Nutzlast: Kundenaccount 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.

Antworttextparameter (JSON oder XML)

Tabelle : 19. Im Antwort-Haupttext zurückgegebene Elemente
Elemente	Beschreibung
id	Sys_id des Qualifizierungs-Kundenauftrags, der für diese Anforderung aktualisiert wurde. Datentyp: Zeichenfolge
href	Relativer Link zum Datensatz der Qualifizierungsreihenfolge. Datentyp: Zeichenfolge
Beschreibung	Beschreibung der Qualifizierungsanforderung, die aus dem Feld „short_description“ des Kundenauftrags verwendet wird. Datentyp: Zeichenfolge
externe ID	Externe ID aus „external_id“ des Kundenauftrags. Datentyp: Zeichenfolge
Qualifizierungsergebnis	Ergebnis des Kundenauftrags aus dem Feld „Ergebnis“. Mögliche Werte: Qualifiziert nicht qualifiziert Alternative Ausstehend Keine Datentyp: Zeichenfolge
Status	Status vonf Kundenauftrag aus Feld „Status“ des Kundenauftrags.
@type	Teil des TMF Open API-Standards. Anmerkung für Qualifizierung. Dieser Wert ist immer CheckServiceQualification. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
checkServiceQualificationDate	Datum und Uhrzeit, zu der die Qualifizierungsanforderung aus dem Feld „order_date“ des Kundenauftrags erstellt wurde. Datentyp: Zeichenfolge Format: JJJJ-MM-TTTHH:MM:SS.SSSZ
effektiveQualifizierungDatum	Effektives Qualifizierungsdatum aus dem Feld „order_date“ des Kundenauftrags. Datentyp: Zeichenfolge Format: JJJJ-MM-TTTHH:MM:SS.SSSZ
erwartetes Qualifizierungsdatum	Speichert das erwartete Qualifizierungsdatum. Wird im Feld „expected_end_date“ des Kundenauftrags beibehalten. Datentyp: Zeichenfolge Format: JJJJ-MM-TTTHH:MM:SS.SSSZ
relatedPartei	Erforderlich. Liste der Kontakte, die der Qualifizierungsanforderung zugeordnet sind (z. B. Kunden-Accounts, Kontakte usw.). Als Array formatiert, muss relatedParty mindestens ein Objekt auflisten, das Kunden- oder Verbraucherkontoinformationen enthält. Datentyp: Array von Objekten Beispiel-Array: `"relatedParty": [ { "id": "String", "name": "String", "@type": "String", "@referredType": "String" }, ]`
relatedPartei.id	Erforderlich. Sys_id oder external_id des Accounts, Kundenkontakts oder Verbrauchers, der dem Auftrag zugeordnet ist. Befindet sich in der Tabelle „Account“ [customer_account], „Kontakt“ [customer_contact] oder „Verbraucher“ [csm_consumer]. Datentyp: Zeichenfolge
relatedPartei.name	Optional. Name des Accounts, Kunden oder Verbrauchers. Datentyp: Zeichenfolge
relatedPartei.@Typ	Teil des TMF Open API-Standards. Anmerkung für Kontakt zu Auftragspositionselement. Dieser Wert ist immer RelatedPartei. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
relatedPartei.@referenziertTyp	Typ der zugehörigen Partei. Mögliche Werte: Kunde Kundenkontakt Verbraucher Datentyp: Zeichenfolge
serviceQualificationItem	Liste der Servicequalifizierungselemente mit Standort, Serviceinformationen und Merkmalen. Als Auftragspositionen für den Kundenauftrag gespeichert. Die Liste muss mindestens ein Servicequalifizierungselement enthalten. Datentyp: Array von Objekten `"serviceQualificationItem": [ { "id": "100", "action": "add", "expectedServiceAvailabilityDate": "2022-12-11T19:20:39.239Z", "service": { "place": [ { "id": "5671dd2ec3a53010188473ce3640dd81", "name": "Jean Pontus home" } ], "serviceCharacteristic": [ { "valueType": "string", "name": "Speed", "value": "High" } ], "serviceSpecification": { "id": "91478553b7969910ff00f203ae11a97d", "name": "Broadband Service" } }, "@type": "ServiceQualificationItem" } ],`
serviceQualificationItem.id	ID des Qualifizierungselements. Diese ID wird im Feld external_id von Kundenauftragsposition] gespeichert. Datentyp: Zeichenfolge
serviceQualificationItem.qualificationResult	Ergebnis des Qualifizierungselements. In „Ergebnis“ der Kundenauftragsposition gespeichert. Das Ergebnis kann entweder „Keine“, „Ausstehend“, „Qualifiziert“, „Nicht qualifiziert“ oder „Alternativ“ sein. Datentyp: Zeichenfolge
serviceQualifizierungselement.status	Status des Qualifizierungselements, abgeleitet aus dem Feld „Status“ von Kundenauftragsposition. Datentyp: Zeichenfolge
serviceQualifizierungselement.Menge	Menge des Qualifizierungselements, abgeleitet aus dem Feld „Menge“ der Kundenauftragsposition. Datentyp: Zahl
serviceQualificationItem.@type	Teil des TMF Open API-Standards. Anmerkung für Qualifizierungselement. Dieser Wert ist immer ServiceQualificationItem. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
serviceQualifizierungselement.service	Serviceinformationen umfassen Ort, Spezifikation und Merkmale. Datentyp: Objekt `"service": { "place": [ { "id": "5671dd2ec3a53010188473ce3640dd81", "name": "Jean Pontus home" } ], "serviceCharacteristic": [ { "valueType": "string", "name": "Speed", "value": "High" } ], "serviceSpecification": { "id": "91478553b7969910ff00f203ae11a97d", "name": "Broadband Service" } }`
serviceQualificationItem.service.@type	Teil des TMF Open API-Standards. Anmerkung für Service. Dieser Wert ist immer Service. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
serviceQualifikationselement.service.place	Standortinformationen für das Servicequalifizierungselement. Datentyp: Array von Objekten. Hinweis: Arrays werden zwar unterstützt, dürfen jedoch nur einen Speicherort enthalten. `"place": [ { "id": "5671dd2ec3a53010188473ce3640dd81", "name": "Jean Pontus home", "@referredType": "GeographicSite" } ]`
serviceQualificationItem.service.place.id	Sys_id eines Standorts in der Tabelle [ cmn_location. Datentyp: Zeichenfolge
serviceQualificationItem.service.place.name	Name des Standorts. Nicht für Eintrag in „cmn_location“ verifiziert. Datentyp: Zeichenfolge
serviceQualificationItem.service.place.@type	Teil des TMF Open API-Standards. Anmerkung für Service. Dieser Wert ist immer GeographicSite. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
serviceQualificationItem.service.serviceSpecification	Servicespezifikation für das Qualifizierungselement. Datentyp: Objekt `"serviceSpecification": { "id": "91478553b7969910ff00f203ae11a97d", "name": "Broadband Service", "version": "", "internalVersion": "1", "internalId": "91478553b7969910ff00f203ae11a97d", "@type": "ServiceSpecification" }`
serviceQualificationItem.service.serviceSpecification.id	Externe ID oder Anfangsversion der Servicespezifikation. Datentyp: Zeichenfolge
serviceQualificationItem.service.serviceSpecification.name	Name der Servicespezifikation. Datentyp: Zeichenfolge
serviceQualificationItem.service.serviceSpecification.version	Externe Version der Servicespezifikation Datentyp: Zeichenfolge
serviceQualificationItem.service.serviceSpecification.internalVersion	Interne Version der Servicespezifikation Datentyp: Zeichenfolge
serviceQualificationItem.service.serviceSpecification.internalId	Interne ID 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.serviceCharacteristic	Liste der Servicemerkmale. Datentyp: Array `"serviceCharacteristic": [ { "valueType": "string", "name": "Speed", "value": "High" } ]`
serviceQualificationItem.service.serviceCharacteristic.valueType	Werttyp des Merkmals. Datentyp: Zeichenfolge
serviceQualificationItem.service.serviceCharacteristic.name	Name des Merkmals. Datentyp: Zeichenfolge
serviceQualificationItem.service.serviceCharacteristic.value	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

Das folgende Beispiel zeigt, wie eine einfache Servicequalifizierung mithilfe einer ID angefordert wird, um den Standort des Kunden mit einem vorhandenen Service zu erhalten.

Hinweis:

Referenz-Servicebestand mit ID = ist ein Produktbestand mit Standort = 20220 Bogenweide, 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 Weide, 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 specificationserviceInventory ] in der Anforderung anhand von 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 übergeordneten und untergeordneten Einzelposten und deren 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"
}

Qualifizierung technischer Services Open API – POST sn_ord_qual_mgmt/qualification/checkServiceQualification/processResult

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

URL-Format

Versionierte URL: /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 Tabelle „Serviceauftrag“ [sn_ind_tmt_orm_service_order] für die angeforderte oberste Auftragsposition darstellen. Alle Domänenaufträge, die durch jedes der Servicequalifizierungselemente dargestellt werden, müssen zu derselben obersten Auftragsposition gehören. Datentyp: Array von Objekten Beispiel-Array: "serviceQualificationItem": [ { "qualificationResult": "alternate", "alternateServiceProposal": [ { "alternateServiceAvailabilityDate": "2022-12-15T19:20:39.239Z", "@type": "AlternateServiceProposal", "id": "1", "alternateService": { "@type": "Service", "serviceSpecification": { "@type": "ServiceSpecification", "name": "Mobile Service", "id": "23", "href": "string" }, "serviceCharacteristic": [ { "@type": "ServiceCharacteristic", "valueType": "string", "name": "BroadcastQuality", "id": "1", "value": "HD" } ] } } ], "@type": "ServiceQualificationItem", "id": "295580b938bf1110f877c8d44c4b8912" } ]
serviceQualificationItem.qualificationResult	Erforderlich. Qualifizierungsergebnis für jedes Servicequalifizierungselement, das im Ergebnisfeld der Tabelle „Domänenauftrag“ [sn_ind_tmt_orm_service_order] beibehalten wird. Datentyp: Zeichenfolge
serviceQualificationItem.id	Erforderlich. Sys_id des Domänenauftrags, der vom Qualifizierungselement dargestellt wird. Gespeichert im Sys_id-Feld des Domänenauftrags [sn_ind_tmt_orm_service_order]. Datentyp: Zeichenfolge
serviceQualificationItem.alternateProposal	Optional. Alternative Vorschläge für das Qualifizierungselement. Gespeichert in der Tabelle „Alternativer Vorschlag“ [sn_ord_qual_mgmt_alternate_proposal]. Datentyp: Array von Objekten `"alternateServiceProposal": [ { "alternateServiceAvailabilityDate": "2022-12-15T19:20:39.239Z", "@type": "AlternateServiceProposal", "id": "1", "alternateService": { "@type": "Service", "serviceSpecification": { "@type": "ServiceSpecification", "name": "Mobile Service", "id": "23", "href": "string" }, "serviceCharacteristic": [ { "@type": "ServiceCharacteristic", "valueType": "string", "name": "BroadcastQuality", "id": "1", "value": "HD" } ] } } ]`
serviceQualificationItem.alternateProposal.alternateServiceAvailabilityDate	Optional. Alternatives Serviceverfügbarkeitsdatum, das im Feld „available_date“ der Tabelle „Alternativer Vorschlag“ [sn_ord_qual_mgmt_alternate_proposal] gespeichert ist, wobei die Informationen zum Domänenauftrag zu dem Domänenauftrag gehören, der durch das aktuelle Servicequalifizierungselement dargestellt wird. Format: JJJJ-MM-TTTHH:MM:SS.SSSZ Datentyp: Zeichenfolge
serviceQualificationItem.alternateProposal.@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
serviceQualificationItem.alternateProposal.id	Optional. Benutzerdefinierte ID für den alternativen Vorschlag. Diese Daten werden nicht gespeichert. Datentyp: Zeichenfolge
serviceQualificationItem.alternateProposal.alternateService	Erforderlich. Serviceinformationen für den alternativen Vorschlag mit Servicespezifikationen und Merkmalen. Datentyp: Objekt `"alternateService": { "@type": "Service", "serviceSpecification": { "@type": "ServiceSpecification", "name": "Mobile Service", "id": "23", "href": "string" }, "serviceCharacteristic": [ { "@type": "ServiceCharacteristic", "valueType": "string", "name": "BroadcastQuality", "id": "1", "value": "HD" } ] }`
serviceQualificationItem.alternateProposal.alternateService .serviceSpecification	Erforderlich. Servicespezifikation für den alternativen Vorschlag. Wird im Feld „Spezifikation“ des alternativen Vorschlagseintrags gespeichert. Datentyp: Objekt `"serviceSpecification": { "id": "91478553b7969910ff00f203ae11a97d", "name": "Broadband Service", “@type”: ”ServiceSpecification” }`
serviceQualificationItem.alternateProposal.alternateService.serviceSpecification.id	Erforderlich. Externe ID oder Anfangsversion der Servicespezifikation. Datentyp: Zeichenfolge
serviceQualificationItem.alternateProposal.alternateService.serviceSpecification.name	Optional. Name der Servicespezifikation. Datentyp: Zeichenfolge
serviceQualificationItem.alternateProposal.alternateService.serviceSpecification.version	Optional. Externe Version der Servicespezifikation. Datentyp: Zeichenfolge
serviceQualificationItem.alternateProposal.alternateService.serviceSpecification.internalVersion	Optional. Interne Version der Servicespezifikation. Datentyp: Zeichenfolge
serviceQualificationItem.alternateProposal.alternateService .serviceSpecification.@type	Optional. Teil des TMF Open API-Standards. Anmerkung für Servicespezifikation. Dieser Wert ist immer ServiceSpecification. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
serviceQualificationItem.alternateProposal.alternateService .serviceCharacteristic	Array von Servicemerkmalen für den alternativen Servicevorschlag, gespeichert als Zeichenfolge im Feld „order_characteristics“ der Tabelle „Alternativer Vorschlag“ [sn_ord_qual_mgmt_alternate_proposal]. Datentyp: Objekt `"serviceCharacteristic": [ { "valueType": "string", "name": "Speed", "value": "High" } ]`
serviceQualificationItem.alternateProposal.alternateService.service.serviceCharacteristic.valueType	Optional. Werttyp des Merkmals unter dem alternativen Servicevorschlag. Datentyp: Zeichenfolge
serviceQualificationItem.alternateProposal.alternateService.serviceCharacteristic.name	Erforderlich. Name des Merkmals, das zum alternativen Servicevorschlag gehört. Datentyp: Zeichenfolge
serviceQualificationItem.alternateProposal.alternateService.serviceCharacteristic.value	Optional. Wert des Merkmals, das zum alternativen Servicevorschlag gehört. Datentyp: Zeichenfolge
serviceQualificationItem.eligibilityUnavailabilityReason	Optional. Berechtigung Nichtverfügbarkeit Grund für eine Servicequalifizierung. Die gesamte Liste der angegebenen „eligibilityUnavailabilityReasons“ wird mit ihren Bezeichnungsfeldern als Zeichenfolge im Feld „unavailability_reason“ der Tabelle „Domänenauftrag“ gespeichert. Datentyp: Objekt `"eligibilityUnavailabilityReason": [ { "code": "26-001", "label": "not enough bandwith at this place" } ]`
serviceQualificationItem.eligibilityUnavailabilityReason.code	Optional. Ursachencode für Nichtverfügbarkeit der Berechtigung. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
serviceQualificationItem.eligibilityUnavailabilityReason.label	Erforderlich. Bezeichnung des Berechtigungs-Nichtverfügbarkeitsgrunds. Wenn mehrere Gründe für die Nichtberechtigung vorhanden sind, werden die Bezeichnungen durch „“, „“ getrennt und im Feld „unavailability_reason“ der Tabelle „Domänenauftrag“ [sn_ind_tmt_orm_domain_order] gespeichert. Datentyp: Zeichenfolge
serviceQualificationItem.@type	Optional. Teil des TMF Open API-Standards. Anmerkung für Qualifizierungselement. Dieser Wert ist immer ServiceQualificationItem. Diese Informationen werden nicht gespeichert. 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	Anforderung erfolgreich verarbeitet.
400	Ungültige Anforderung. Dies kann einen der folgenden Gründe haben: Ungültige Nutzlast: Qualifizierungsergebnis muss eines der folgenden sein: [alternate, ausstehend, qualifiziert, nicht qualifiziert]. Ungültige Nutzlast: ID des Qualifizierungselements ist nicht vorhanden. Alle Qualifizierungselemente müssen zu derselben obersten Auftragsposition gehören. Ungültige Nutzlast: serviceQualificationItem capabilityResult fehlt. Ungültige Nutzlast: Verbraucher ist nicht vorhanden.

Antworttextparameter (JSON oder XML)


Name	Beschreibung
id	Sys_id des Qualifizierungskundenauftrags. Datentyp: Zeichenfolge
href	Relativer Link zum Datensatz der Qualifizierungsreihenfolge. Datentyp: Zeichenfolge
Beschreibung	Beschreibung der Qualifizierungsanforderung, die aus dem Feld short_description des Kundenauftrags abgerufen wird. Datentyp: Zeichenfolge
externe ID	Externe ID aus dem Feld „external_id“ des Kundenauftrags. Datentyp: Zeichenfolge
Qualifizierungsergebnis	Qualifizierungsstatus des Ergebnisfelds des Kundenauftrags. Mögliche Werte: Alternative Ausstehend Keine Qualifiziert nicht qualifiziert Datentyp: Zeichenfolge
Status	Status des Kundenauftrags aus dem Statusfeld des Kundenauftrags. Datentyp: Zeichenfolge
@type	Teil des TMF Open API-Standards. Anmerkung für 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. Format: JJJJ-MM-TTTHH:MM:SS.SSSZ Datentyp: Zeichenfolge
effektiveQualifizierungDatum	Effektives Qualifizierungsdatum, das aus dem Feld order_date des Kundenauftrags abgerufen wurde. Format: JJJJ-MM-TTTHH:MM:SS.SSSZ Datentyp: Zeichenfolge
erwartetes Qualifizierungsdatum	Speichert das erwartete Qualifizierungsdatum. Wird im Feld „expected_end_date“ des Kundenauftrags beibehalten. Format: JJJJ-MM-TTTHH:MM:SS.SSSZ Datentyp: Zeichenfolge
relatedPartei	Liste der Kontakte für die Qualifizierungsanforderung. Jeder Kontakt ist ein Objekt im Array. Datentyp: Array von Objekten `"relatedParty": [ { "id": "String", "name": "String", "@type": "String", "@referredType": "String" } ]`
relatedPartei.id	Sys_id oder external_id des Accounts, Kundenkontakts oder Verbrauchers, der dem Auftrag zugeordnet ist. Befindet sich in der Tabelle „Account“ [customer_account], „Kontakt“ [customer_contact] oder „Verbraucher“ [csm_consumer]. Datentyp: Zeichenfolge
relatedPartei.name	Name des Accounts, Kunden oder Verbrauchers. Datentyp: Zeichenfolge
relatedPartei.@Typ	Teil des TMF Open API-Standards. Anmerkung für den Kontakt der Bestellposition. Dieser Wert ist immer RelatedPartei. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
relatedPartei.@referenziertTyp	Typ der zugehörigen Partei. Mögliche Werte: Kunde Kundenkontakt Verbraucher Datentyp: Zeichenfolge
serviceQualificationItem	Liste der Servicequalifizierungselemente, die Informationen zu Standort, Serviceinformationen und Servicemerkmalen enthalten. Als Auftragspositionen für den Kundenauftrag gespeichert. Datentyp: Array von Objekten `"serviceQualificationItem": [ { "id": "string", "action": "string", "expectedServiceAvailabilityDate": "number", "service": { "place": [ { "id": "string", "name": "string" } ], "serviceCharacteristic": [ { "valueType": "string", "name": "string", "value": "string" } ], "serviceSpecification": { "id": "string", "name": "string" } }, "@type": "ServiceQualificationItem" } ],`
serviceQualificationItem.id	ID des Qualifizierungselements. Wird im Feld „external_id“ der Kundenauftragsposition gespeichert. Datentyp: Zeichenfolge
serviceQualificationItem.qualificationResult	Ergebnis des Qualifizierungselements. Wird im Feld „Ergebnis“ der Kundenauftragsposition gespeichert. Mögliche Werte: Alternative Keine Ausstehend Qualifiziert nicht qualifiziert Datentyp: Zeichenfolge
serviceQualifizierungselement.status	Status des Qualifizierungselements, abgeleitet aus dem Feld „Status“ der Kundenauftragsposition. Datentyp: Zeichenfolge
serviceQualifizierungselement.Menge	Menge des Qualifizierungselements, die aus dem Feld „Menge“ der Kundenauftragsposition abgeleitet wird. 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
serviceQualifizierungselement.service	Serviceinformationen, die Details zu Standort (Ort), Servicespezifikationen und Servicemerkmalen enthalten. Datentyp: Objekt `"service": { "place": [ { "id": "String", "name": "String" } ], "serviceCharacteristic": [ { "valueType": "String", "name": "String", "value": "String" } ], "serviceSpecification": { "id": "String", "name": "String" } }`
serviceQualificationItem.service.@type	Teil des API-Standards TMF Open. Anmerkung für Service. Dieser Wert ist immer Service. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
serviceQualifikationselement.service.place	Standortinformationen für das Servicequalifizierungselement. Datentyp: Array von Objekten. Hinweis: Dieses Array kann nur einen Speicherort enthalten. `"place": [ { "id": "5671dd2ec3a53010188473ce3640dd81", "name": "Jean Pontus home", "@referredType": "GeographicSite" } ]`
serviceQualificationItem.service.place.id	Sys_id eines Standorts in der Tabelle „Standort“ [cmn_location]. Datentyp: Zeichenfolge
serviceQualificationItem.service.place.name	Name des Standorts. Nicht anhand eines Eintrags in der Tabelle „Standort“ [cmn_location] überprüft. Datentyp: Zeichenfolge
serviceQualificationItem.service.place.@type	Teil des TMF Open API-Standards. Anmerkung für Service. Dieser Wert ist immer GeographicSite. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
serviceQualificationItem.service.serviceSpecification	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
serviceQualificationItem.service.serviceSpecification.version	Externe Version der Servicespezifikation. Datentyp: Zeichenfolge
serviceQualificationItem.service.serviceSpecification.internalVersion	Interne Version der Servicespezifikation. Datentyp: Zahl
serviceQualificationItem.service.serviceSpecification.internalId	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.serviceCharacteristic	Liste der Servicemerkmale. Datentyp: Array von Objekten `"serviceCharacteristic": [ { "name": "Speed", "value": "High" "valueType": "string", } ]`
serviceQualificationItem.service.serviceCharacteristic.valueType	Werttyp des Merkmals. Datentyp: Zeichenfolge
serviceQualificationItem.service.serviceCharacteristic.name	Name des Merkmals. Datentyp: Zeichenfolge
serviceQualificationItem.service.serviceCharacteristic.value	Wert des Merkmals. Datentyp: Zeichenfolge
ServiceQualificationItem.alternateServiceProposal	Alternativer Servicevorschlag für den Qualifizierungsauftrag. Alternative Vorschläge werden in der Tabelle „Alternativer Vorschlag“ [sn_ord_qual_mgmt_alternate_proposal] gespeichert. Datentyp: Zeichenfolge
ServiceQualificationItem.alternateServiceProposal.id	Sys_id des alternativen Vorschlagseintrags in der Tabelle „Alternativer Vorschlag“ [sn_ord_qual_mgmt_alternate_proposal]. Datentyp: Zeichenfolge
ServiceQualificationItem.alternateServiceProposal.alternateServiceAvailabilityDate	Der Wert im Feld available_date des Eintrags für alternative Vorschläge in der Tabelle „Alternativer Vorschlag“ [sn_ord_qual_mgmt_alternate_proposal]. Datentyp: Zeichenfolge
serviceQualificationItem.alternateServiceProposal.alternateService	Serviceinformationen, die durch den alternativen Vorschlag dargestellt werden. Datentyp: Objekt
serviceQualificationItem.alternateServiceProposal.alternateService.serviceSpecification	Die Servicespezifikation des alternativen Vorschlags wurde in der Tabelle „Spezifikation des alternativen Vorschlags“ [sn_ord_qual_mgmt_alternate_proposal] beibehalten. Datentyp: Objekt
serviceQualificationItem „alternativeServiceProposal.alternateService.serviceSpecification.id“	Externe ID oder Anfangsversion der alternativen Servicespezifikation. Datentyp: Zeichenfolge
serviceQualificationItem alternativeServiceVorschlag.alternateService.serviceSpecification.name	Name der alternativen Servicespezifikation. Datentyp: Zeichenfolge
serviceQualificationItem alternativeServiceVorschlag.alternateService.serviceSpecification.version	Externe Version der alternativen Servicespezifikation. Datentyp: Zeichenfolge
serviceQualificationItem „alternativeServiceProposal.alternateService.serviceSpecification.internalVersion“	Interne Version der alternativen Servicespezifikation. Datentyp: Zahl
serviceQualificationItem „alternativeServiceProposal.alternateService.serviceSpecification.internalId“	Anfangsversion der Spezifikation des alternativen Service. Datentyp: Zeichenfolge
ServiceQualificationItem „alternativeServiceProposal.alternateService.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.alternateService.serviceCharacteristic“	Array von Servicemerkmalen für den alternativen Servicevorschlag. Datentyp: Array von Objekten `"serviceCharacteristic": [ { "valueType": "String", "name": "String", "value": "String" } ]`
serviceQualificationItem „alternativeServiceProposal.alternateService.serviceCharacteristic.valueType“	Werttyp des alternativen Servicemerkmals. Datentyp: Zeichenfolge
serviceQualificationItem alternativeServiceVorschlag.alternateService.serviceCharacteristic.name	Name des alternativen Servicemerkmals. Datentyp: Zeichenfolge
serviceQualificationItem „alternativeServiceProposal.alternateService.serviceCharacteristic.value“	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 in „unavailability_reason“ der Tabelle „Domänenauftrag“ [sn_ind_tmt_orm_domain_order] beibehalten. Datentyp: Array
serviceQualificationItem.eligibilityUnavailabilityReason.code	Ursachencode für Nichtverfügbarkeit von Serviceberechtigung. Datentyp: Zeichenfolge
serviceQualificationItem.eligibilityUnavailabilityReason.label	Bezeichnung des Nichtverfügbarkeitsgrunds für Serviceberechtigung. Datentyp: Zeichenfolge

Beispiel für eine cURL-Anforderung

Das folgende Beispiel zeigt, wie der Endpunkt einen in der API-Anforderung gesendeten Qualifizierungsauftrag 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"
}