Qualifizierung technischer Services – offene API

Freigeben Version: Zurich

Aktualisiert 31. Juli 2025

41 Minuten Lesedauer

Die Qualifizierung Für Technischen Service Offen Die API stellt Endpunkte bereit, um die Verfügbarkeit von Ressourcen und Services zu überprüfen, bevor Aufträge zur Erfüllung übermittelt werden.

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

Die Qualifizierung Für Technischen Service Offen API wird in bereitgestellt sn_ord_qual_mgmt Namespace und erfordert die folgenden Plugins:

Produktkatalog-Management Core [com.sn_prd_pm]
Produktkatalog erweitert [com.sn_prd_pm_adv]
Auftragsqualifizierungsmanagement [com.sn_ord_qual_mgmt]
Auftragsmanagement für Telekommunikation, Medien und Technik [com.sn_tmt_Core]
Telekommunikations-Core [com.sn_tmt_Core]

Die Rolle sn_ind_tmt_orm.order_Integrator ist erforderlich, um diese API zu verwenden.

Qualifizierung technischer Services – API öffnen – sn_ord_qual_mgmt/Qualifizierung/checkServiceQualifizierung/{ID} ABRUFEN

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

Standard-URL: /api/sn_ord_qual_mgmt/Qualifizierung/checkServiceQualifizierung/{ID}

Unterstützte Anforderungsparameter

Tabelle : 1. Pfadparameter
Name	Beschreibung
id	SYS_ID des abzurufenden Qualifizierungskundenauftrags. Datentyp: Zeichenfolge Tabelle: Kundenauftrag [sn_ind_tmt_orm_order]

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 REST API-HTTP-Antwortcodes .

Tabelle : 6. Statuscodes

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

Antworttext-Parameter (JSON oder XML)


Name	Beschreibung
id	SYS_ID des Qualifizierungskundenauftrags. Datentyp: Zeichenfolge Tabelle: Kundenauftrag [sn_ind_tmt_orm_order]
href	Relativer Link zum Qualifizierungsauftragsdatensatz. Datentyp: Zeichenfolge
Beschreibung	Beschreibung der Qualifizierungsanforderung, die aus dem Feld „short_description“ des Kundenauftrags abgerufen wird. Datentyp: Zeichenfolge Tabelle: Kundenauftrag [sn_ind_tmt_orm_order]
externalId	Externe ID des Kundenauftrags. Datentyp: Zeichenfolge Tabelle: Im Feld external_ID der Tabelle „Kundenauftrag“ [sn_ind_tmt_orm_order].
QualifizierungWeitere	Qualifizierungsstatus des Ergebnisfelds des Kundenauftrags. Mögliche Werte: Alternative Keine Ausstehend 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 die Qualifizierung. Dieser Wert ist immer `Überprüfen Sie die ServiceQualifizierung` . Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
PrüfServiceQualifizierungDatum	Datum und Uhrzeit der Qualifizierungsanforderung, die aus dem Feld „order_date“ des Kundenauftrags erstellt wurde. Datentyp: Zeichenfolge FORMAT: JJJJ-MM-TTTHH:MM:SS.SSSZ Tabelle: Kundenauftrag [sn_ind_tmt_orm_order]
GültigkeitQualifizierungDatum	Effektives Qualifizierungsdatum, das aus dem Feld „order_date“ des Kundenauftrags abgerufen wird. Datentyp: Zeichenfolge FORMAT: JJJJ-MM-TTTHH:MM:SS.SSSZ Tabelle: Kundenauftrag [sn_ind_tmt_orm_order]
ExpectedQualificationDate	Speichert das erwartete Qualifizierungsdatum. Im Feld expected_end_date des Kundenauftrags beibehalten. Datentyp: Zeichenfolge FORMAT: JJJJ-MM-TTTHH:MM:SS.SSSZ Tabelle: Kundenauftrag [sn_ind_tmt_orm_order]
Zugehörige Partei	Liste der Kontakte für die Qualifizierungsanforderung. Jeder Kontakt ist ein Objekt im Array. Datentyp: Array von Objekten `"relatedParty": [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ]`
ZugehörigPartei.ID	SYS_ID oder external_ID des Accounts, Kundenkontakts oder Verbrauchers, der der Bestellung zugeordnet ist. Datentyp: Zeichenfolge Tabelle: Tabelle „Account“ [Customer_Account], Tabelle „Kontakt“ [Customer_contact] oder „Verbraucher“ [csm_Consumer]
relatedParty.name	Name des Accounts, Kunden oder Verbrauchers. Datentyp: Zeichenfolge
RelatedParty.@type	Teil des TMF Open API-Standards. Anmerkung für den Auftragspositionskontakt. Dieser Wert ist immer `Zugehörige Partei` . Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
RelatedParty.@referredType	Typ der zugehörigen Partei. Mögliche Werte: Verbraucher Kunde CustomerContact Datentyp: Zeichenfolge
ServiceQualificationItem	Liste der Serviceinformationselemente mit Informationen zum Standort, Serviceinformationen und Servicemerkmalen. Als Auftragspositionen für den Kundenauftrag gespeichert. Datentyp: Array von Objekten `"serviceQualificationItem": [ { "id": "String", "action": "String", "expectedServiceAvailabilityDate": "Number", "service": {Object}, "@type": "String" } ]`
ServiceQualifikationElement.ID	ID des Qualifizierungselements. Datentyp: Zeichenfolge Gespeichert in: Das Feld „external_ID“ der Kundenauftragsposition in der Tabelle „Auftragspositionen“ [sn_ind_tmt_orm_order_line_item].
ServiceQualifikationElement.QualifikationErgebnis	Ergebnis des Qualifizierungselements. Wird im Feld „Ergebnis“ der Kundenauftragsposition gespeichert. Mögliche Werte: Alternative Keine Ausstehend Qualifiziert Nicht qualifiziert Datentyp: Zeichenfolge Tabelle: Auftragsposition [sn_ind_tmt_orm_order_line_item]
ServiceQualifikationElement.Status	Status des Qualifizierungselements, der aus dem Feld „Status“ der Kundenauftragsposition abgeleitet ist. Datentyp: Zeichenfolge Tabelle: Auftragsposition [sn_ind_tmt_orm_order_line_item]
ServiceQualifizierungElement.Menge	Menge des Qualifizierungselements, das aus dem Feld „Menge“ der Kundenauftragsposition abgeleitet wird. Datentyp: Zahl Tabelle: Auftragsposition [sn_ind_tmt_orm_order_line_item]
ServiceQualificationItem.@type	Teil des TMF Open API-Standards. Anmerkung für das Qualifizierungselement. Dieser Wert ist immer ServiceQualifizierungElement . Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
serviceQualificationItem.service	Serviceinformationen, die Details zum Standort (Ort), zu Servicespezifikationen und Servicemerkmalen enthalten. Datentyp: Objekt `"service": { "@type": "String", "place": [Array], "serviceCharacteristic": [Array], "serviceSpecification": {Object} }`
serviceQualificationItem.service.@type	Teil des TMF-Vorgangs en-API-Standard. Anmerkung für den Service. Dieser Wert ist immer `Service` . Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
serviceQualificationItem.service.place	Standortinformationen für das Service-Qualifizierungselement. Datentyp: Array von Objekten Hinweis: Dieses Array kann nur einen Standort enthalten. `"place": [ { "id": "String", "name": "String", "@referredType": "String" } ]`
serviceQualificationItem.service.place.id	SYS_ID des Standorts. Datentyp: Zeichenfolge Tabelle: Standort [cmn_location]
serviceQualificationItem.service.place.name	Name des Standorts. Nicht anhand eines Eintrags in der Tabelle „Standort“ [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	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 `Servicespezifikation` . Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
serviceQualificationItem.service.serviceCharacteristic	Liste der Servicemerkmale. Datentyp: Array von Objekten `"serviceCharacteristic": [ { "name": "String", "value": "String", "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
ServiceQualifizierungElement.AlternativServiceProposal	Alternativer Servicevorschlag für den Qualifizierungsauftrag. Datentyp: Zeichenfolge Gespeichert in: Alternativer Vorschlag [sn_ord_qual_mgmt_Alternate_Proposal]
ServiceQualificationItem.alternateServiceProposal.id	SYS_ID des alternativen Vorschlagsdatensatzes. Datentyp: Zeichenfolge Tabelle: Alternativer Vorschlag [sn_ord_qual_mgmt_Alternate_Proposal]
ServiceQualifizierungElement.alternateServiceAngebot.alternateServiceVerfügbarkeitsdatum	Der Feldwert available_date des alternativen Vorschlagseintrags in der Tabelle „alternativer Vorschlag“ [sn_ord_qual_mgmt_Alternate_Proposal]. Datentyp: Zeichenfolge
ServiceQualifizierungElement.alternateServiceProposal.alternateService	Serviceinformationen, die durch den alternativen Vorschlag dargestellt werden. Datentyp: Objekt
serviceQualificationItem.alternateServiceProposal.alternateService.serviceSpecification	Die Servicespezifikation des alternativen Vorschlags wurde in der Spezifikation beibehalten. Datentyp: Objekt Tabelle: Alternativer Vorschlag [sn_ord_qual_mgmt_Alternate_Proposal]
ServiceQualificationItem. alternateServiceProposal.alternateService.serviceSpecification.id	Externe ID oder Anfangsversion der alternativen Servicespezifikation. Datentyp: Zeichenfolge
ServiceQualificationItem. alternateServiceProposal.alternateService.serviceSpecification.name	Name der alternativen Servicespezifikation. Datentyp: Zeichenfolge
ServiceQualificationItem. alternateServiceProposal.alternateService.serviceSpecification.version	Externe Version der alternativen Servicespezifikation. Datentyp: Zeichenfolge
ServiceQualificationItem. alternateServiceProposal.alternateService.serviceSpecification.internalVersion	Interne Version der alternativen Servicespezifikation. Datentyp: Zahl
ServiceQualificationItem. alternateServiceProposal.alternateService.serviceSpecification.internalId	Anfangsversion der alternativen Servicespezifikation. Datentyp: Zeichenfolge
ServiceQualifizierungElement. alternateServiceProposal.alternateService.serviceSpecification.@type	Teil des TMF Open API-Standards. Anmerkung für Servicespezifikation. Dieser Wert ist immer `Servicespezifikation` . Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
ServiceQualificationItem. alternateServiceProposal.alternateService.serviceCharacteristic	Liste der Servicemerkmale für den alternativen Servicevorschlag. Datentyp: Array von Objekten `"serviceCharacteristic": [ { "name": "String", "value": "String", "valueType": "String" } ]`
ServiceQualificationItem. alternateServiceProposal.alternateService.serviceCharacteristic.valueType	Werttyp des alternativen Servicekennzeichens. Datentyp: Zeichenfolge
ServiceQualificationItem. alternateServiceProposal.alternateService.serviceCharacteristic.name	Name des alternativen Servicekennzeichens. Datentyp: Zeichenfolge
ServiceQualificationItem. alternateServiceProposal.alternateService.serviceCharacteristic.value	Wert des alternativen Servicekennzeichens. Datentyp: Zeichenfolge
ServiceQualifizierungElement.BerechtigungNichtverfügbarkeitReason	Liste der Gründe für Nichtverfügbarkeit der Serviceberechtigung, um zu erklären, warum der Service nicht verfügbar ist. Datentyp: Array Gespeichert in: Dem Feld „Unavailability_reason“ der Tabelle „Domänenauftrag“ [sn_ind_tmt_orm_Domain_order].
ServiceQualifizierungElement.BerechtigungUnverfügbarkeitReason.Code	Ursachencode für Nichtverfügbarkeit der Serviceberechtigung. Datentyp: Zeichenfolge
ServiceQualifizierungElement.BerechtigungUnverfügbarkeitReason.label	Bezeichnung des Grunds für Nichtverfügbarkeit der Serviceberechtigung. Datentyp: Zeichenfolge

Beispiel für eine cURL-Anforderung

Das folgende Beispiel ruft einen gesamten spezifischen Qualifizierungsauftrag ab, der einer bestimmten SYS_ID eines Qualifizierungskundenauftrags 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 – API öffnen – sn_ord_qual_mgmt/Qualifizierung/checkServiceQualifizierung ABRUFEN

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, Feldnamen, Beschreibung und Qualifizierungsergebnis einzugrenzen.

URL-Format

Standard-URL: /api/sn_ord_qual_mgmt/Qualifizierung/checkServiceQualifizierung

Unterstützte Anforderungsparameter

Tabelle : 7. Pfadparameter
Name	Beschreibung
Keine

Tabelle : 8. Abfrage Parameter
Parameter	Beschreibung
Beschreibung	Filtert Qualifizierungsaufträge nach dem Feld „short_description“ des Kundenauftrags. Nur Aufträge mit einer Kurzbeschreibung stimmen überein G der Wert dieses Parameters wird in der Antwort zurückgegeben. Datentyp: Zeichenfolge
Felder	Liste der Feldnamen, die in Th zurückgegeben werden sollen E-Antwort. Ungültige Felder werden ignoriert. Wenn dieser Parameter nicht in der Anforderung angegeben ist, werden alle Felder zurückgegeben. Datentyp: Zeichenfolge, kommagetrennt
limit	Maximale Anzahl der zurückzugebenden Datensätze. Für Anforderungen, die diese Anzahl von Datensätzen überschreiten, verwenden Sie Offset-Parameter Zum paginieren des Datensatzabrufs. Standard: 20 Maximum: 100 Datentyp: Zahl
QualifizierungWeitere	Filtert Qualifizierungsreihenfolgen nach Ergebnis. Nur Aufträge mit einem Ergebnis, das dem Wert dieses Parameters entspricht, werden in der Antwort zurückgegeben. Datentyp: Zeichenfolge
Status	Filtert Qualifizierungsreihenfolgen nach Status. Nur Aufträge mit einem Status, der dem Wert entspricht Parameter werden in der Antwort zurückgegeben. Datentyp: Zeichenfolge

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

Kopfzeilen

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

Tabelle : 11. Antwortkopfzeilen
Kopfzeile	Beschreibung
Keine

Statuscodes

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

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

Antworttext-Parameter (JSON oder XML)


Name	Beschreibung
id	SYS_ID des Qualifizierungskundenauftrags. Datentyp: Zeichenfolge Tabelle: Kundenauftrag [sn_ind_tmt_orm_order]
href	Relativer Link zum Qualifizierungsauftragsdatensatz. Datentyp: Zeichenfolge
Beschreibung	Beschreibung der Qualifizierungsanforderung, die aus dem Feld „short_description“ des Kundenauftrags abgerufen wird. Datentyp: Zeichenfolge Tabelle: Kundenauftrag [sn_ind_tmt_orm_order]
externalId	Externe ID des Kundenauftrags. Datentyp: Zeichenfolge Tabelle: Im Feld external_ID der Tabelle „Kundenauftrag“ [sn_ind_tmt_orm_order].
QualifizierungWeitere	Qualifizierungsstatus des Ergebnisfelds des Kundenauftrags. Mögliche Werte: Alternative Keine Ausstehend 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 die Qualifizierung. Dieser Wert ist immer `Überprüfen Sie die ServiceQualifizierung` . Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
PrüfServiceQualifizierungDatum	Datum und Uhrzeit der Qualifizierungsanforderung, die aus dem Feld „order_date“ des Kundenauftrags erstellt wurde. Datentyp: Zeichenfolge FORMAT: JJJJ-MM-TTTHH:MM:SS.SSSZ Tabelle: Kundenauftrag [sn_ind_tmt_orm_order]
GültigkeitQualifizierungDatum	Effektives Qualifizierungsdatum, das aus dem Feld „order_date“ des Kundenauftrags abgerufen wird. Datentyp: Zeichenfolge FORMAT: JJJJ-MM-TTTHH:MM:SS.SSSZ Tabelle: Kundenauftrag [sn_ind_tmt_orm_order]
ExpectedQualificationDate	Speichert das erwartete Qualifizierungsdatum. Im Feld expected_end_date des Kundenauftrags beibehalten. Datentyp: Zeichenfolge FORMAT: JJJJ-MM-TTTHH:MM:SS.SSSZ Tabelle: Kundenauftrag [sn_ind_tmt_orm_order]
Zugehörige Partei	Liste der Kontakte für die Qualifizierungsanforderung. Jeder Kontakt ist ein Objekt im Array. Datentyp: Array von Objekten `"relatedParty": [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ]`
ZugehörigPartei.ID	SYS_ID oder external_ID des Accounts, Kundenkontakts oder Verbrauchers, der der Bestellung zugeordnet ist. Datentyp: Zeichenfolge Tabelle: Tabelle „Account“ [Customer_Account], Tabelle „Kontakt“ [Customer_contact] oder „Verbraucher“ [csm_Consumer]
relatedParty.name	Name des Accounts, Kunden oder Verbrauchers. Datentyp: Zeichenfolge
RelatedParty.@type	Teil des TMF Open API-Standards. Anmerkung für den Auftragspositionskontakt. Dieser Wert ist immer `Zugehörige Partei` . Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
RelatedParty.@referredType	Typ der zugehörigen Partei. Mögliche Werte: Verbraucher Kunde CustomerContact Datentyp: Zeichenfolge
ServiceQualificationItem	Liste der Serviceinformationselemente mit Informationen zum Standort, Serviceinformationen und Servicemerkmalen. Als Auftragspositionen für den Kundenauftrag gespeichert. Datentyp: Array von Objekten `"serviceQualificationItem": [ { "id": "String", "action": "String", "expectedServiceAvailabilityDate": "Number", "service": {Object}, "@type": "String" } ]`
ServiceQualifikationElement.ID	ID des Qualifizierungselements. Datentyp: Zeichenfolge Gespeichert in: Das Feld „external_ID“ der Kundenauftragsposition in der Tabelle „Auftragspositionen“ [sn_ind_tmt_orm_order_line_item].
ServiceQualifikationElement.QualifikationErgebnis	Ergebnis des Qualifizierungselements. Wird im Feld „Ergebnis“ der Kundenauftragsposition gespeichert. Mögliche Werte: Alternative Keine Ausstehend Qualifiziert Nicht qualifiziert Datentyp: Zeichenfolge Tabelle: Auftragsposition [sn_ind_tmt_orm_order_line_item]
ServiceQualifikationElement.Status	Status des Qualifizierungselements, der aus dem Feld „Status“ der Kundenauftragsposition abgeleitet ist. Datentyp: Zeichenfolge Tabelle: Auftragsposition [sn_ind_tmt_orm_order_line_item]
ServiceQualifizierungElement.Menge	Menge des Qualifizierungselements, das aus dem Feld „Menge“ der Kundenauftragsposition abgeleitet wird. Datentyp: Zahl Tabelle: Auftragsposition [sn_ind_tmt_orm_order_line_item]
ServiceQualificationItem.@type	Teil des TMF Open API-Standards. Anmerkung für das Qualifizierungselement. Dieser Wert ist immer ServiceQualifizierungElement . Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
serviceQualificationItem.service	Serviceinformationen, die Details zum Standort (Ort), zu Servicespezifikationen und Servicemerkmalen enthalten. Datentyp: Objekt `"service": { "@type": "String", "place": [Array], "serviceCharacteristic": [Array], "serviceSpecification": {Object} }`
serviceQualificationItem.service.@type	Teil des TMF-Vorgangs en-API-Standard. Anmerkung für den Service. Dieser Wert ist immer `Service` . Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
serviceQualificationItem.service.place	Standortinformationen für das Service-Qualifizierungselement. Datentyp: Array von Objekten Hinweis: Dieses Array kann nur einen Standort enthalten. `"place": [ { "id": "String", "name": "String", "@referredType": "String" } ]`
serviceQualificationItem.service.place.id	SYS_ID des Standorts. Datentyp: Zeichenfolge Tabelle: Standort [cmn_location]
serviceQualificationItem.service.place.name	Name des Standorts. Nicht anhand eines Eintrags in der Tabelle „Standort“ [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	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 `Servicespezifikation` . Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
serviceQualificationItem.service.serviceCharacteristic	Liste der Servicemerkmale. Datentyp: Array von Objekten `"serviceCharacteristic": [ { "name": "String", "value": "String", "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
ServiceQualifizierungElement.AlternativServiceProposal	Alternativer Servicevorschlag für den Qualifizierungsauftrag. Datentyp: Zeichenfolge Gespeichert in: Alternativer Vorschlag [sn_ord_qual_mgmt_Alternate_Proposal]
ServiceQualificationItem.alternateServiceProposal.id	SYS_ID des alternativen Vorschlagsdatensatzes. Datentyp: Zeichenfolge Tabelle: Alternativer Vorschlag [sn_ord_qual_mgmt_Alternate_Proposal]
ServiceQualifizierungElement.alternateServiceAngebot.alternateServiceVerfügbarkeitsdatum	Der Feldwert available_date des alternativen Vorschlagseintrags in der Tabelle „alternativer Vorschlag“ [sn_ord_qual_mgmt_Alternate_Proposal]. Datentyp: Zeichenfolge
ServiceQualifizierungElement.alternateServiceProposal.alternateService	Serviceinformationen, die durch den alternativen Vorschlag dargestellt werden. Datentyp: Objekt
serviceQualificationItem.alternateServiceProposal.alternateService.serviceSpecification	Die Servicespezifikation des alternativen Vorschlags wurde in der Spezifikation beibehalten. Datentyp: Objekt Tabelle: Alternativer Vorschlag [sn_ord_qual_mgmt_Alternate_Proposal]
ServiceQualificationItem. alternateServiceProposal.alternateService.serviceSpecification.id	Externe ID oder Anfangsversion der alternativen Servicespezifikation. Datentyp: Zeichenfolge
ServiceQualificationItem. alternateServiceProposal.alternateService.serviceSpecification.name	Name der alternativen Servicespezifikation. Datentyp: Zeichenfolge
ServiceQualificationItem. alternateServiceProposal.alternateService.serviceSpecification.version	Externe Version der alternativen Servicespezifikation. Datentyp: Zeichenfolge
ServiceQualificationItem. alternateServiceProposal.alternateService.serviceSpecification.internalVersion	Interne Version der alternativen Servicespezifikation. Datentyp: Zahl
ServiceQualificationItem. alternateServiceProposal.alternateService.serviceSpecification.internalId	Anfangsversion der alternativen Servicespezifikation. Datentyp: Zeichenfolge
ServiceQualifizierungElement. alternateServiceProposal.alternateService.serviceSpecification.@type	Teil des TMF Open API-Standards. Anmerkung für Servicespezifikation. Dieser Wert ist immer `Servicespezifikation` . Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
ServiceQualificationItem. alternateServiceProposal.alternateService.serviceCharacteristic	Liste der Servicemerkmale für den alternativen Servicevorschlag. Datentyp: Array von Objekten `"serviceCharacteristic": [ { "name": "String", "value": "String", "valueType": "String" } ]`
ServiceQualificationItem. alternateServiceProposal.alternateService.serviceCharacteristic.valueType	Werttyp des alternativen Servicekennzeichens. Datentyp: Zeichenfolge
ServiceQualificationItem. alternateServiceProposal.alternateService.serviceCharacteristic.name	Name des alternativen Servicekennzeichens. Datentyp: Zeichenfolge
ServiceQualificationItem. alternateServiceProposal.alternateService.serviceCharacteristic.value	Wert des alternativen Servicekennzeichens. Datentyp: Zeichenfolge
ServiceQualifizierungElement.BerechtigungNichtverfügbarkeitReason	Liste der Gründe für Nichtverfügbarkeit der Serviceberechtigung, um zu erklären, warum der Service nicht verfügbar ist. Datentyp: Array Gespeichert in: Dem Feld „Unavailability_reason“ der Tabelle „Domänenauftrag“ [sn_ind_tmt_orm_Domain_order].
ServiceQualifizierungElement.BerechtigungUnverfügbarkeitReason.Code	Ursachencode für Nichtverfügbarkeit der Serviceberechtigung. Datentyp: Zeichenfolge
ServiceQualifizierungElement.BerechtigungUnverfügbarkeitReason.label	Bezeichnung des Grunds für Nichtverfügbarkeit der Serviceberechtigung. Datentyp: Zeichenfolge

Beispiel für eine cURL-Anforderung

Der folgende GET-Aufruf ruft alle Qualifizierungsaufträge 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 – offene API – POST sn_ord_qual_mgmt/Qualifizierung/checkServiceQualifizierung

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

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

Mit diesem Endpunkt

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

Anforderung zur Qualifizierung eines Service an einer angegebenen Adresse.
Anforderung zur Qualifizierung eines neuen Service am selben Standort eines vorhandenen und aktiven Zugriffsservice.
Anforderung zum Upgrade oder Downgrade eines vorhandenen Service.

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

Um einen Service an einer angegebenen Adresse zu qualifizieren, verwenden Sie placeArray ( serviceQualificationItem.service.place)Um einen bestimmten Standort und die Servicespezifikation anzugeben. Sie können optional zusätzliche Servicemerkmale in Ihrer Anforderung definieren.
Um einen neuen Service am selben Standort eines vorhandenen und aktiven Service zu qualifizieren, verwenden Sie referenceServiceInventoryObjekt (serviceQualificationItem.service.referenceServiceInventory) anstelle von placeArray. Mit diesem Objekt können Sie eine Anforderung erstellen und Servicespezifikationen definieren, ohne Standortdetails angeben zu müssen. Sie können optional zusätzliche Servicemerkmale in Ihrer Anforderung definieren.
Verwenden Sie zum Upgrade oder Downgrade eines vorhandenen Service serviceInventoryObjekt (serviceQualificationItem.service.ServiceInventory) anstelle von placeArray oder referenceServiceInventoryObjekt. 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 Downloadgeschwindigkeit eines vorhandenen, aktiven Service von 100 MB/s auf 600 MB/s aktualisieren können In diesem Fall können Sie verwenden serviceInventoryParameter zum Definieren der Anforderung durch Ändern des Merkmals „Geschwindigkeit“ von „Niedrig“ in „hoch“. Die API ruft verbleibende Merkmale vom vorhandenen Service ab.

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

URL-Format

Standard-URL: /api/sn_ord_qual_mgmt/Qualifizierung/checkServiceQualifizierung

Unterstützte Anforderungsparameter

Tabelle : 13. Pfadparameter
Name	Beschreibung
Keine

Tabelle : 14. Abfrageparameter
Name	Beschreibung
Keine

Tabelle : 15. Anforderungstextparameter (XML oder JSON)
Parameter	Beschreibung
@TYPE	Optional. Teil des TMF Open API-Standards. Anmerkung für die Qualifizierung. Dieser Wert ist immer `Überprüfen Sie die ServiceQualifizierung` . Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
PrüfServiceQualifizierungDatum	Optional. Datum und Uhrzeit der Erstellung der Qualifizierungsanforderung. Befindet sich im Feld order_date der Tabelle „Kundenauftrag“ [sn_ind_tmt_orm_order]. Wenn nicht angegeben, wird order_date auf das aktuelle Datum und die aktuelle Uhrzeit festgelegt. Datentyp: Zeichenfolge FORMAT: JJJJ-MM-TTTHH:MM:SS.SSSZ
Beschreibung	Optional. Die Beschreibung der Qualifizierungsanforderung. Befindet sich im Feld „short_description“ der Tabelle „Kundenauftrag“ [sn_ind_tmt_orm_order]. Datentyp: Zeichenfolge Maximale Zeichenlänge: 100
GültigkeitQualifizierungDatum	Optional. Das Datum, an dem die Qualifizierung gültig ist. Wird im Feld „actual_end_date“ des Kundenauftrags der Tabelle „Kundenauftrag“ [sn_ind_tmt_orm_order] beibehalten. Datentyp: Zeichenfolge FORMAT: JJJJ-MM-TTTHH:MM:SS.SSSZ
ExpectedQualificationDate	Optional. Das erwartete Qualifizierungsdatum. Wird im Feld expected_end_date“ des Kundenauftrags beibehalten. Befindet sich in der Tabelle „Kundenauftrag“ [sn_ind_tmt_orm_order]. Datentyp: Zeichenfolge FORMAT: JJJJ-MM-TTTHH:MM:SS.SSSZ
externalId	Optional. Externe ID, die dem Kundenauftrag zugewiesen ist. Wird im Feld „external_ID“ des Kundenauftrags der Tabelle „Kundenauftrag“ [sn_ind_tmt_orm_order] beibehalten. Datentyp: Zeichenfolge
Zugehörige Partei	Liste der Kontakte für die Qualifizierungsanforderung. Jeder Kontakt ist ein Objekt im Array. Muss mindestens ein Element auflisten, das Informationen zum Kunden-Account, zum Kundenkontakt oder zum Verbraucherkonto enthält. Datentyp: Array von Objekten `"relatedParty": [ { "@referredType": "String", "@type": "String", "id": "String", "name": "String" } ]`
RelatedParty.@referredType	Typ der zugehörigen Partei. Mögliche Werte: Verbraucher Kunde CustomerContact Datentyp: Zeichenfolge
RelatedParty.@type	Optional. Teil des TMF Open API-Standards. Anmerkung für den Auftragspositionskontakt. Dieser Wert ist immer `Zugehörige Partei` . Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
relatedParty.id	Die sys_ID oder external_ID, falls zutreffend, der zugehörigen Partei. Befindet sich in der Tabelle „Account“ [Customer_Account], der Tabelle „Kontakt“ [Customer_contact] oder der Tabelle „Verbraucher“ [csm_Consumer]. Datentyp: Zeichenfolge
relatedParty.name	Name des Accounts, Kunden oder Verbrauchers. Datentyp: Zeichenfolge
ServiceQualificationItem	Liste der Serviceinformationselemente mit Standort, Serviceinformationen und Merkmalen. Als Auftragspositionen für den Kundenauftrag gespeichert. Muss mindestens ein Service-Qualifizierungselement in der Liste enthalten. Datentyp: Array von Objekten `"serviceQualificationItem": [{ "@type": "String", "id": "String", "qualificationResult": "String", "quantity": "Number", "service": {Object}, "state": "String" ]`
ServiceQualificationItem.@type	Optional. Teil des TMF Open API-Standards. Anmerkung für Qualifizierungselement. Dieser Wert ist immer `ServiceQualifizierungElement` . Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
ServiceQualifikationElement.QualifikationItemBeziehung	Optional. Liste der Beziehungen zu anderen Service-Qualifizierungselementen in derselben Anforderung. Diese Informationen helfen beim Erstellen von Auftragspositionen mit einer übergeordneten Auftragsposition. Datentyp: Array von Objekten `"qualificationItemRelationship": [ { "id": "String" "relationshipType": "String" } ]`
serviceQualificationItem.qualificationItemRelationship.id	Erforderlich. Die ID des Zielqualifizierungselements in der Beziehung. Datentyp: Zeichenfolge
ServiceQualifikationElement.QualifikationItemBeziehung.Beziehungstyp	Erforderlich. Der Typ der Einzelposten-Beziehung. Gültige Werte: HasChild: Gibt das untergeordnete Element an. HasParent: Gibt das übergeordnete Element an. Datentyp: Zeichenfolge
ServiceQualifizierungElement.Menge	Optional. Menge des Qualifizierungselements. Wird im Feld „Menge“ der Kundenauftragsposition beibehalten. Datentyp: Zahl Standard, wenn nicht angegeben: 1
serviceQualificationItem.service	Erforderlich. Serviceinformationen, die Variablen wie Ort, Servicespezifikation und Servicemerkmale enthalten können. Datentyp: Objekt `"service": { "@type": "String", "place": [Array], "serviceCharacteristic": [Array], "serviceSpecification": {Object} }`
serviceQualificationItem.service.@type	Optional. Teil des TMF Open API-Standards. Anmerkung für Serviceinformationen für Qualifizierungselement. Dieser Wert ist immer `Service` . Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
serviceQualificationItem.service.place	Optional. Die angeforderten Standortinformationen für das Service-Qualifizierungselement. Befindet sich in der Tabelle „Standort“ [cmn_location]. Hinweis: Obwohl Array unterstützt wird, darf es nur einen Standort enthalten. Datentyp: Array von Objekten `"place": [ { "@type": "String" "id": "String", "name": "String" } ]`
serviceQualificationItem.service.place.@type	Optional. Teil des TMF Open API-Standards. Anmerkung für Service. Dieser Wert ist immer `GeographicSite` . Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
serviceQualificationItem.service.place.id	Erforderlich. SYS_ID eines Standorts in der Tabelle „Standort“ [cmn_location]. Diese Standort-ID muss ein gültiger Eintrag in der Tabelle „Standort“ [cmn_location] sein. Datentyp: Zeichenfolge
serviceQualificationItem.service.place.name	Optional. Name des Standorts. Dieser Wert wird nicht anhand von Einträgen in der Tabelle „Standort“ [cmn_location] verifiziert. Datentyp: Zeichenfolge
serviceQualificationItem.service.referenceServiceInventory	Erforderlich. Gültige Servicebestandsentität, die sich auf einen aktiven Service für den erforderlichen Standort bezieht. Die Standortinformationen für den Qualifizierungsauftrag werden vom Standort dieses Servicebestands abgerufen. Wichtig: Verwenden Sie referenceServiceInventoryObjekt zum Qualifizieren eines neuen Service am selben Standort eines vorhandenen und aktiven Zugriffsservice. Dazu müssen Sie auch auslassen placeArray und serviceInventoryObjekt aus Ihrer Anforderung, andernfalls gibt die API einen Fehler zurück. Datentyp: Objekt `"referenceServiceInventory": { "id": "String" }`
serviceQualificationItem.service.referenceServiceInventory.id	Erforderlich, wenn verwendet wird serviceQualificationItem.service.referenceServiceInventoryIn der Anforderung. 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. Datentyp: Zeichenfolge
serviceQualificationItem.service.serviceCharacteristic	Optional. Array von Servicemerkmalen. Datentyp: Array von Objekten `"serviceCharacteristic": [ { "name": "String", "value": "String", "valueType": "String", } ]`
serviceQualificationItem.service.serviceCharacteristic.name	Erforderlich. Name des Merkmals. Datentyp: Zeichenfolge
serviceQualificationItem.service.serviceCharacteristic.value	Optional. Wert des Merkmals. Teil des TMF Open API-Standards. Anmerkung für Qualifizierungselement. Dieser Wert ist immer `ServiceQualifizierungElement` . Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
serviceQualificationItem.service.serviceCharacteristic.valueType	Optional. Werttyp des Merkmals. Datentyp: Zeichenfolge
serviceQualificationItem.service.serviceInventory	Optional. Gültige Servicebestandsentität, die sich auf einen aktiven Service bezieht, der ein Upgrade oder Downgrade erfordert. Wichtig: Verwenden Sie serviceInventoryObjekt für Service-Upgrades oder Downgrades. Dazu müssen Sie den Ort auslassen arrayUnd referenceServiceInventoryObjekt aus Ihrer Anforderung, andernfalls gibt die API einen Fehler zurück. Datentyp: Objekt `"serviceInventory": { "id": "String" }`
serviceQualificationItem.service.serviceSpecification	Erforderlich. Servicespezifikation für das Qualifizierungselement. Wird im Feld „Service_Specification“ der Kundenauftragsposition in der Tabelle „Auftragsposition“ [sn_ind_tmt_orm_order_line_item] gespeichert. Servicespezifikationen für ein Qualifizierungselement dürfen nicht ressourcenorientiert sein. Datentyp: Objekt `"serviceSpecification": { “@type”: ”String”, "id": "String", "name": "String" }`
serviceQualificationItem.service.serviceSpecification.@type	Optional. Teil des TMF Open API-Standards. Anmerkung für die Servicespezifikation. Dieser Wert ist immer `Servicespezifikation` . Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
serviceQualificationItem.service.serviceSpecification.id	Erforderlich. Externe ID oder Anfangsversion der Servicespezifikation. Datentyp: Zeichenfolge
serviceQualificationItem.service.serviceSpecification.internalVersion	Optional. Interne Version der Servicespezifikation. Datentyp: Zahl
serviceQualificationItem.service.serviceSpecification.name	Erforderlich. Name der Servicespezifikation. Datentyp: Zeichenfolge
serviceQualificationItem.service.serviceSpecification.version	Optional. Externe Version der Servicespezifikation. Datentyp: Zeichenfolge

Header

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

Tabelle : 17. Antwortkopfzeilen
Kopfzeile	Beschreibung
Keine

Statuscodes

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

Tabelle : 18. Statuscodes
Statuscode	Beschreibung
201	Anforderung erfolgreich verarbeitet. Hinweis: Wenn Probleme mit den Informationen zu Merkmalen oder Merkmalen auftreten, speichert der Endpunkt die folgenden Kommentare in den Arbeitsnotizenfeldern des zugehörigen Kundenauftrags-Positionselementdatensatzes ähnlich wie vorhandene Lieferaufträge
400	Ungültige Anforderung. Dies kann einer der folgenden Gründe sein: Leere Nutzlast. Ungültige Nutzlast: Pflichtfeld fehlt: <field name> Ungültige Nutzlast: Anforderungstext fehlt – Nutzlast wurde im Anforderungstext nicht übergeben. Ungültige Nutzlast: RelatedParty fehlt. Ungültige Nutzlast: ServiceQualificationItem fehlt. Ungültige Nutzlast: ServiceQualificationItem-ID fehlt. Ungültige Nutzlast: Service „serviceQualificationItem“ fehlt. Ungültige Nutzlast: Die Standortinformationen fehlen. Geben Sie Place, 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.

Antworttext-Parameter (JSON oder XML)

Tabelle : 19. Im Antwort-Haupttext zurückgegebene Elemente
Elemente	Beschreibung
id	SYS_ID des Qualifizierungskundenauftrags. Datentyp: Zeichenfolge Tabelle: Kundenauftrag [sn_ind_tmt_orm_order]
href	Relativer Link zum Qualifizierungsauftragsdatensatz. Datentyp: Zeichenfolge
Beschreibung	Beschreibung der Qualifizierungsanforderung, die aus dem Feld „short_description“ des Kundenauftrags abgerufen wird. Datentyp: Zeichenfolge Tabelle: Kundenauftrag [sn_ind_tmt_orm_order]
externalId	Externe ID des Kundenauftrags. Datentyp: Zeichenfolge Tabelle: Im Feld external_ID der Tabelle „Kundenauftrag“ [sn_ind_tmt_orm_order].
QualifizierungWeitere	Qualifizierungsstatus des Ergebnisfelds des Kundenauftrags. Mögliche Werte: Alternative Keine Ausstehend 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 die Qualifizierung. Dieser Wert ist immer `Überprüfen Sie die ServiceQualifizierung` . Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
PrüfServiceQualifizierungDatum	Datum und Uhrzeit der Qualifizierungsanforderung, die aus dem Feld „order_date“ des Kundenauftrags erstellt wurde. Datentyp: Zeichenfolge FORMAT: JJJJ-MM-TTTHH:MM:SS.SSSZ Tabelle: Kundenauftrag [sn_ind_tmt_orm_order]
GültigkeitQualifizierungDatum	Effektives Qualifizierungsdatum, das aus dem Feld „order_date“ des Kundenauftrags abgerufen wird. Datentyp: Zeichenfolge FORMAT: JJJJ-MM-TTTHH:MM:SS.SSSZ Tabelle: Kundenauftrag [sn_ind_tmt_orm_order]
ExpectedQualificationDate	Speichert das erwartete Qualifizierungsdatum. Im Feld expected_end_date des Kundenauftrags beibehalten. Datentyp: Zeichenfolge FORMAT: JJJJ-MM-TTTHH:MM:SS.SSSZ Tabelle: Kundenauftrag [sn_ind_tmt_orm_order]
Zugehörige Partei	Liste der Kontakte für die Qualifizierungsanforderung. Jeder Kontakt ist ein Objekt im Array. Datentyp: Array von Objekten `"relatedParty": [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ]`
ZugehörigPartei.ID	SYS_ID oder external_ID des Accounts, Kundenkontakts oder Verbrauchers, der der Bestellung zugeordnet ist. Datentyp: Zeichenfolge Tabelle: Tabelle „Account“ [Customer_Account], Tabelle „Kontakt“ [Customer_contact] oder „Verbraucher“ [csm_Consumer]
relatedParty.name	Name des Accounts, Kunden oder Verbrauchers. Datentyp: Zeichenfolge
RelatedParty.@type	Teil des TMF Open API-Standards. Anmerkung für den Auftragspositionskontakt. Dieser Wert ist immer `Zugehörige Partei` . Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
RelatedParty.@referredType	Typ der zugehörigen Partei. Mögliche Werte: Verbraucher Kunde CustomerContact Datentyp: Zeichenfolge
ServiceQualificationItem	Liste der Serviceinformationselemente mit Informationen zum Standort, Serviceinformationen und Servicemerkmalen. Als Auftragspositionen für den Kundenauftrag gespeichert. Datentyp: Array von Objekten `"serviceQualificationItem": [ { "id": "String", "action": "String", "expectedServiceAvailabilityDate": "Number", "service": {Object}, "@type": "String" } ]`
ServiceQualifikationElement.ID	ID des Qualifizierungselements. Datentyp: Zeichenfolge Gespeichert in: Das Feld „external_ID“ der Kundenauftragsposition in der Tabelle „Auftragspositionen“ [sn_ind_tmt_orm_order_line_item].
ServiceQualifikationElement.QualifikationErgebnis	Ergebnis des Qualifizierungselements. Wird im Feld „Ergebnis“ der Kundenauftragsposition gespeichert. Mögliche Werte: Alternative Keine Ausstehend Qualifiziert Nicht qualifiziert Datentyp: Zeichenfolge Tabelle: Auftragsposition [sn_ind_tmt_orm_order_line_item]
ServiceQualifikationElement.Status	Status des Qualifizierungselements, der aus dem Feld „Status“ der Kundenauftragsposition abgeleitet ist. Datentyp: Zeichenfolge Tabelle: Auftragsposition [sn_ind_tmt_orm_order_line_item]
ServiceQualifizierungElement.Menge	Menge des Qualifizierungselements, das aus dem Feld „Menge“ der Kundenauftragsposition abgeleitet wird. Datentyp: Zahl Tabelle: Auftragsposition [sn_ind_tmt_orm_order_line_item]
ServiceQualificationItem.@type	Teil des TMF Open API-Standards. Anmerkung für das Qualifizierungselement. Dieser Wert ist immer ServiceQualifizierungElement . Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
serviceQualificationItem.service	Serviceinformationen, die Details zum Standort (Ort), zu Servicespezifikationen und Servicemerkmalen enthalten. Datentyp: Objekt `"service": { "@type": "String", "place": [Array], "serviceCharacteristic": [Array], "serviceSpecification": {Object} }`
serviceQualificationItem.service.@type	Teil des TMF-Vorgangs en-API-Standard. Anmerkung für den Service. Dieser Wert ist immer `Service` . Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
serviceQualificationItem.service.place	Standortinformationen für das Service-Qualifizierungselement. Datentyp: Array von Objekten Hinweis: Dieses Array kann nur einen Standort enthalten. `"place": [ { "id": "String", "name": "String", "@referredType": "String" } ]`
serviceQualificationItem.service.place.id	SYS_ID des Standorts. Datentyp: Zeichenfolge Tabelle: Standort [cmn_location]
serviceQualificationItem.service.place.name	Name des Standorts. Nicht anhand eines Eintrags in der Tabelle „Standort“ [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	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 `Servicespezifikation` . Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
serviceQualificationItem.service.serviceCharacteristic	Liste der Servicemerkmale. Datentyp: Array von Objekten `"serviceCharacteristic": [ { "name": "String", "value": "String", "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

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 Sie mithilfe einer ID eine einfache Servicequalifizierung anfordern, um den Standort des Kunden mit einem vorhandenen Service zu erhalten.

Hinweis:

Referenz-Servicebestand mit ID = ist ein Produktbestand mit Standort = 20220 Bow Willow, Houston, 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, wo placeWird aus ausgefüllt referenceServiceInventoryIn der Anforderung.

{
    "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 Sie den Breitbandservice eines Anwenders auf eine höhere Geschwindigkeit aktualisieren. Servicebestand mit ID = ist ein Produktbestand mit Servicespezifikation = „Breitbandservice“, Standort = 20220 Bow Willow, Houston, TX, Merkmale=[{Speed:Medium}].

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

Antwort, wo placeUnd specificationWerden aus ausgefüllt serviceInventoryIn der Anforderung.

Hinweis:

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

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

Anwendungsfall 4

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

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

Antwort:

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

Offene API für technische Servicequalifizierung – POST sn_ord_qual_mgmt/Qualifizierung/checkServiceQualifizierung/processResult

Verarbeitet ein Qualifizierungsergebnis für technische Services, das an gesendet wird Qualifizierung Für Technischen Service Offen API.

URL-Format

Standard-URL: /api/sn_ord_qual_mgmt/Qualifizierung/checkServiceQualifizierung/processResult

Unterstützte Anforderungsparameter

Tabelle : 20. Pfadparameter
Name	Beschreibung
Keine

Tabelle : 21. Abfrageparameter
Name	Beschreibung
Keine

Tabelle : 22. Anforderungstextparameter (XML oder JSON)
Parameter	Beschreibung
ServiceQualificationItem	Erforderlich. Liste der Service-Qualifizierungselemente, 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 von jedem der Servicequalifizierungselemente dargestellt werden, müssen zu derselben obersten Auftragsposition gehören. Datentyp: Array von Objekten `"serviceQualificationItem": [ { "@type": "String", "alternateServiceProposal": [Array], "id": "String", "qualificationResult": "String" } ]`
ServiceQualificationItem.@type	Optional. Teil des TMF Open API-Standards. Anmerkung für Qualifizierungselement. Dieser Wert ist immer `ServiceQualifizierungElement` . Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
ServiceQualifizierungElement.AlternativVorschlag	Alternative Vorschläge für das Qualifizierungselement. Datentyp: Array von Objekten `"alternateServiceProposal": [ { "@type": "String", "alternateService": {Object}, "alternateServiceAvailabilityDate": "Number", "id": "String", "serviceCharacteristic": [Array] } ]` Gespeichert in: Alternativer Vorschlag [sn_ord_qual_mgmt_Alternate_Proposal]
ServiceQualifikationItem.alternateProposal.@type	Teil des TMF Open API-Standards. Anmerkung für Serviceinformationen für das Qualifizierungselement. Dieser Wert ist immer `Service` . Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
ServiceQualifizierungElement.alternateProposal.alternateService	Erforderlich. Serviceinformationen für den alternativen Vorschlag mit Servicespezifikationen und -Merkmalen. Datentyp: Objekt `"alternateService": { "@type": "String", "serviceSpecification": {Object}, "serviceCharacteristic": [Array] }`
serviceQualificationItem.alternateProposal.alternateService.alternateService.serviceCharacteristic.valueType	Werttyp des Merkmals unter dem alternativen Servicevorschlag. Datentyp: Zeichenfolge
serviceQualificationItem.alternateProposal.alternateService.serviceCharacteristic	Servicemerkmale für den alternativen Servicevorschlag. Datentyp: Array von Objekten `"serviceCharacteristic": [ { "name": "String", "value": "String", "valueType": "String" } ]` Gespeichert in: Feld order_characteristics der Tabelle „Alternativer Vorschlag“ [sn_ord_qual_mgmt_Alternate_Proposal].
serviceQualificationItem.alternateProposal.alternateService.serviceCharacteristic.name	Erforderlich. Name des Merkmals, das zum alternativen Servicevorschlag gehört. Datentyp: Zeichenfolge
serviceQualificationItem.alternateProposal.alternateService.serviceCharacteristic.value	Wert des Merkmals, das zum alternativen Servicevorschlag gehört. Datentyp: Zeichenfolge
serviceQualificationItem.alternateProposal.alternateService.serviceCharacteristic.valueType	Typ des Merkmals. Datentyp: Zeichenfolge
ServiceQualifizierungElement.alternateProposal.alternateService .serviceSpezifikation	Erforderlich. Servicespezifikation für den alternativen Vorschlag. Datentyp: Objekt `"serviceSpecification": { “@type”: ”String” "id": "String", "name": "String" }` Gespeichert in: Dem Spezifikationsfeld des alternativen Vorschlagseintrags der Tabelle „alternativer Vorschlag“ [sn_ord_qual_mgmt_Alternate_Proposal].
ServiceQualificationItem.alternateProposal.alternateService .serviceSpecification.@type	Teil des TMF Open API-Standards. Anmerkung für die Servicespezifikation. Dieser Wert ist immer `Servicespezifikation` . Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
serviceQualificationItem.alternateProposal.alternateService.serviceSpecification.id	Erforderlich. Externe ID oder Anfangsversion der Servicespezifikation. Datentyp: Zeichenfolge
serviceQualificationItem.alternateProposal.alternateService.serviceSpecification.internalVersion	Interne Version der Servicespezifikation. Datentyp: Zeichenfolge
serviceQualificationItem.alternateProposal.alternateService.serviceSpecification.name	Name der Servicespezifikation. Datentyp: Zeichenfolge
serviceQualificationItem.alternateProposal.alternateService.serviceSpecification.version	Externe Version der Servicespezifikation. Datentyp: Zeichenfolge
ServiceQualifizierungElement.AlternateProposal.AlternateServiceVerfügbarkeitsdatum	Alternatives Serviceverfügbarkeitsdatum. Datentyp: Zeichenfolge FORMAT: JJJJ-MM-TTTHH:MM:SS.SSSZ Tabelle: Im Feld available_date der Tabelle „alternativer Vorschlag“ [sn_ord_qual_mgmt_Alternate_Proposal], in der die Informationen zum Domänenauftrag zu dem Domänenauftrag gehören, der durch das aktuelle Service-Qualifizierungselement dargestellt wird.
serviceQualificationItem.alternateProposal.id	Anwenderdefinierte ID für den alternativen Vorschlag. Diese Daten werden nicht beibehalten. Datentyp: Zeichenfolge
ServiceQualifizierungElement.BerechtigungNichtverfügbarkeitReason	Grund, warum die Servicequalifizierung nicht berechtigt ist. Datentyp: Objekt `"eligibilityUnavailabilityReason": [ { "code": "String", "label": "String" } ]` Gespeichert in: Die gesamte Liste der Gründe wird mit ihren Bezeichnungsfeldern als Zeichenfolge im Feld „Unavailability_reason“ der Tabelle „Domänenauftrag“ [sn_ind_tmt_orm_Domain_order] beibehalten.
ServiceQualifizierungElement.BerechtigungUnverfügbarkeitReason.Code	Code für den Grund der Nichtverfügbarkeit der Berechtigung. Diese Informationen werden nicht beibehalten. Datentyp: Zeichenfolge
ServiceQualifizierungElement.BerechtigungUnverfügbarkeitReason.label	Erforderlich. Bezeichnung für den Grund der Nichtverfügbarkeit der Berechtigung. Wenn mehrere Unberechtigungsgründe vorliegen, werden die Bezeichnungen durch ein Komma getrennt. Datentyp: Zeichenfolge Gespeichert in: Dem Feld „Unavailability_reason“ der Tabelle „Domänenauftrag“ [sn_ind_tmt_orm_Domain_order].
serviceQualificationItem.id	Erforderlich. SYS_ID des Domänenauftrags, der durch das Qualifizierungselement dargestellt wird. Datentyp: Zeichenfolge Gespeichert im Feld „SYS_ID“ der Tabelle „Domänenauftrag“ [sn_ind_tmt_orm_Service_order].
ServiceQualifikationElement.QualifikationErgebnis	Erforderlich. Qualifizierungsergebnis für jedes Service-Qualifizierungselement. Datentyp: Zeichenfolge Gespeichert in: Das Ergebnisfeld der Domänenauftragstabelle [sn_ind_tmt_orm_Service_order].

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 REST API-HTTP-Antwortcodes .

Tabelle : 25. Statuscodes
Statuscode	Beschreibung
201	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
400	Ungültige Anforderung. Dies kann einer der folgenden Gründe sein: Ungültige Nutzlast: Qualifizierungsergebnis muss eines der folgenden Werte sein: [Alternative, Ausstehend, qualifiziert, nicht qualifiziert]. Ungültige Nutzlast: Qualifizierungselement-ID ist nicht vorhanden. Alle Qualifizierungselemente müssen zu derselben obersten Auftragsposition gehören. Ungültige Nutzlast: ServiceQualificationItem qualificationResult fehlt. Ungültige Nutzlast: Verbraucher ist nicht vorhanden.

Antworttext-Parameter (JSON oder XML)


Name	Beschreibung
id	SYS_ID des Qualifizierungskundenauftrags. Datentyp: Zeichenfolge Tabelle: Kundenauftrag [sn_ind_tmt_orm_order]
href	Relativer Link zum Qualifizierungsauftragsdatensatz. Datentyp: Zeichenfolge
Beschreibung	Beschreibung der Qualifizierungsanforderung, die aus dem Feld „short_description“ des Kundenauftrags abgerufen wird. Datentyp: Zeichenfolge Tabelle: Kundenauftrag [sn_ind_tmt_orm_order]
externalId	Externe ID des Kundenauftrags. Datentyp: Zeichenfolge Tabelle: Im Feld external_ID der Tabelle „Kundenauftrag“ [sn_ind_tmt_orm_order].
QualifizierungWeitere	Qualifizierungsstatus des Ergebnisfelds des Kundenauftrags. Mögliche Werte: Alternative Keine Ausstehend 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 die Qualifizierung. Dieser Wert ist immer `Überprüfen Sie die ServiceQualifizierung` . Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
PrüfServiceQualifizierungDatum	Datum und Uhrzeit der Qualifizierungsanforderung, die aus dem Feld „order_date“ des Kundenauftrags erstellt wurde. Datentyp: Zeichenfolge FORMAT: JJJJ-MM-TTTHH:MM:SS.SSSZ Tabelle: Kundenauftrag [sn_ind_tmt_orm_order]
GültigkeitQualifizierungDatum	Effektives Qualifizierungsdatum, das aus dem Feld „order_date“ des Kundenauftrags abgerufen wird. Datentyp: Zeichenfolge FORMAT: JJJJ-MM-TTTHH:MM:SS.SSSZ Tabelle: Kundenauftrag [sn_ind_tmt_orm_order]
ExpectedQualificationDate	Speichert das erwartete Qualifizierungsdatum. Im Feld expected_end_date des Kundenauftrags beibehalten. Datentyp: Zeichenfolge FORMAT: JJJJ-MM-TTTHH:MM:SS.SSSZ Tabelle: Kundenauftrag [sn_ind_tmt_orm_order]
Zugehörige Partei	Liste der Kontakte für die Qualifizierungsanforderung. Jeder Kontakt ist ein Objekt im Array. Datentyp: Array von Objekten `"relatedParty": [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ]`
ZugehörigPartei.ID	SYS_ID oder external_ID des Accounts, Kundenkontakts oder Verbrauchers, der der Bestellung zugeordnet ist. Datentyp: Zeichenfolge Tabelle: Tabelle „Account“ [Customer_Account], Tabelle „Kontakt“ [Customer_contact] oder „Verbraucher“ [csm_Consumer]
relatedParty.name	Name des Accounts, Kunden oder Verbrauchers. Datentyp: Zeichenfolge
RelatedParty.@type	Teil des TMF Open API-Standards. Anmerkung für den Auftragspositionskontakt. Dieser Wert ist immer `Zugehörige Partei` . Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
RelatedParty.@referredType	Typ der zugehörigen Partei. Mögliche Werte: Verbraucher Kunde CustomerContact Datentyp: Zeichenfolge
ServiceQualificationItem	Liste der Serviceinformationselemente mit Informationen zum Standort, Serviceinformationen und Servicemerkmalen. Als Auftragspositionen für den Kundenauftrag gespeichert. Datentyp: Array von Objekten `"serviceQualificationItem": [ { "id": "String", "action": "String", "expectedServiceAvailabilityDate": "Number", "service": {Object}, "@type": "String" } ]`
ServiceQualifikationElement.ID	ID des Qualifizierungselements. Datentyp: Zeichenfolge Gespeichert in: Das Feld „external_ID“ der Kundenauftragsposition in der Tabelle „Auftragspositionen“ [sn_ind_tmt_orm_order_line_item].
ServiceQualifikationElement.QualifikationErgebnis	Ergebnis des Qualifizierungselements. Wird im Feld „Ergebnis“ der Kundenauftragsposition gespeichert. Mögliche Werte: Alternative Keine Ausstehend Qualifiziert Nicht qualifiziert Datentyp: Zeichenfolge Tabelle: Auftragsposition [sn_ind_tmt_orm_order_line_item]
ServiceQualifikationElement.Status	Status des Qualifizierungselements, der aus dem Feld „Status“ der Kundenauftragsposition abgeleitet ist. Datentyp: Zeichenfolge Tabelle: Auftragsposition [sn_ind_tmt_orm_order_line_item]
ServiceQualifizierungElement.Menge	Menge des Qualifizierungselements, das aus dem Feld „Menge“ der Kundenauftragsposition abgeleitet wird. Datentyp: Zahl Tabelle: Auftragsposition [sn_ind_tmt_orm_order_line_item]
ServiceQualificationItem.@type	Teil des TMF Open API-Standards. Anmerkung für das Qualifizierungselement. Dieser Wert ist immer ServiceQualifizierungElement . Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
serviceQualificationItem.service	Serviceinformationen, die Details zum Standort (Ort), zu Servicespezifikationen und Servicemerkmalen enthalten. Datentyp: Objekt `"service": { "@type": "String", "place": [Array], "serviceCharacteristic": [Array], "serviceSpecification": {Object} }`
serviceQualificationItem.service.@type	Teil des TMF-Vorgangs en-API-Standard. Anmerkung für den Service. Dieser Wert ist immer `Service` . Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
serviceQualificationItem.service.place	Standortinformationen für das Service-Qualifizierungselement. Datentyp: Array von Objekten Hinweis: Dieses Array kann nur einen Standort enthalten. `"place": [ { "id": "String", "name": "String", "@referredType": "String" } ]`
serviceQualificationItem.service.place.id	SYS_ID des Standorts. Datentyp: Zeichenfolge Tabelle: Standort [cmn_location]
serviceQualificationItem.service.place.name	Name des Standorts. Nicht anhand eines Eintrags in der Tabelle „Standort“ [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	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 `Servicespezifikation` . Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
serviceQualificationItem.service.serviceCharacteristic	Liste der Servicemerkmale. Datentyp: Array von Objekten `"serviceCharacteristic": [ { "name": "String", "value": "String", "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
ServiceQualifizierungElement.AlternativServiceProposal	Alternativer Servicevorschlag für den Qualifizierungsauftrag. Datentyp: Zeichenfolge Gespeichert in: Alternativer Vorschlag [sn_ord_qual_mgmt_Alternate_Proposal]
ServiceQualificationItem.alternateServiceProposal.id	SYS_ID des alternativen Vorschlagsdatensatzes. Datentyp: Zeichenfolge Tabelle: Alternativer Vorschlag [sn_ord_qual_mgmt_Alternate_Proposal]
ServiceQualifizierungElement.alternateServiceAngebot.alternateServiceVerfügbarkeitsdatum	Der Feldwert available_date des alternativen Vorschlagseintrags in der Tabelle „alternativer Vorschlag“ [sn_ord_qual_mgmt_Alternate_Proposal]. Datentyp: Zeichenfolge
ServiceQualifizierungElement.alternateServiceProposal.alternateService	Serviceinformationen, die durch den alternativen Vorschlag dargestellt werden. Datentyp: Objekt
serviceQualificationItem.alternateServiceProposal.alternateService.serviceSpecification	Die Servicespezifikation des alternativen Vorschlags wurde in der Spezifikation beibehalten. Datentyp: Objekt Tabelle: Alternativer Vorschlag [sn_ord_qual_mgmt_Alternate_Proposal]
ServiceQualificationItem. alternateServiceProposal.alternateService.serviceSpecification.id	Externe ID oder Anfangsversion der alternativen Servicespezifikation. Datentyp: Zeichenfolge
ServiceQualificationItem. alternateServiceProposal.alternateService.serviceSpecification.name	Name der alternativen Servicespezifikation. Datentyp: Zeichenfolge
ServiceQualificationItem. alternateServiceProposal.alternateService.serviceSpecification.version	Externe Version der alternativen Servicespezifikation. Datentyp: Zeichenfolge
ServiceQualificationItem. alternateServiceProposal.alternateService.serviceSpecification.internalVersion	Interne Version der alternativen Servicespezifikation. Datentyp: Zahl
ServiceQualificationItem. alternateServiceProposal.alternateService.serviceSpecification.internalId	Anfangsversion der alternativen Servicespezifikation. Datentyp: Zeichenfolge
ServiceQualifizierungElement. alternateServiceProposal.alternateService.serviceSpecification.@type	Teil des TMF Open API-Standards. Anmerkung für Servicespezifikation. Dieser Wert ist immer `Servicespezifikation` . Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
ServiceQualificationItem. alternateServiceProposal.alternateService.serviceCharacteristic	Liste der Servicemerkmale für den alternativen Servicevorschlag. Datentyp: Array von Objekten `"serviceCharacteristic": [ { "name": "String", "value": "String", "valueType": "String" } ]`
ServiceQualificationItem. alternateServiceProposal.alternateService.serviceCharacteristic.valueType	Werttyp des alternativen Servicekennzeichens. Datentyp: Zeichenfolge
ServiceQualificationItem. alternateServiceProposal.alternateService.serviceCharacteristic.name	Name des alternativen Servicekennzeichens. Datentyp: Zeichenfolge
ServiceQualificationItem. alternateServiceProposal.alternateService.serviceCharacteristic.value	Wert des alternativen Servicekennzeichens. Datentyp: Zeichenfolge
ServiceQualifizierungElement.BerechtigungNichtverfügbarkeitReason	Liste der Gründe für Nichtverfügbarkeit der Serviceberechtigung, um zu erklären, warum der Service nicht verfügbar ist. Datentyp: Array Gespeichert in: Dem Feld „Unavailability_reason“ der Tabelle „Domänenauftrag“ [sn_ind_tmt_orm_Domain_order].
ServiceQualifizierungElement.BerechtigungUnverfügbarkeitReason.Code	Ursachencode für Nichtverfügbarkeit der Serviceberechtigung. Datentyp: Zeichenfolge
ServiceQualifizierungElement.BerechtigungUnverfügbarkeitReason.label	Bezeichnung des Grunds für Nichtverfügbarkeit der 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"
}