API ouverte de qualification du service technique

Rversion finale: Washingtondc

Mis à jour 1 févr. 2024

56 minutes de lecture

L’API ouverte de qualification de service technique vous permet de vérifier la disponibilité des ressources et des services avant de soumettre des commandes pour exécution.

Cette API est une ServiceNow implémentation de la spécification REST de l’API de qualification de service TMF645. Pour plus d’informations sur les demandes de qualification de service, reportez-vous à Service qualification requests.

L’API ouverte de qualification du service technique est fournie dans l’espace de noms sn_ord_qual_mgmt et nécessite les modules d’extension suivants :

Gestion de Product Catalog Core [com.sn_prd_pm]
Catalogue de produits avancé [com.sn_prd_pm_adv]
Gestion des qualifications de commandes [com.sn_ord_qual_mgmt]
Gestion des commandes pour les télécommunications, les médias et la technologie [com.sn_tmt_core]
Cœur de télécommunication [com.sn_tmt_core]

Le rôle sn_ind_tmt_orm.order_integrator est requis pour utiliser cette API.

Qualification du service technique API ouverte : GET sn_ord_qual_mgmt/qualification/checkServiceQualification/{id}

Récupère une demande de qualification technique associée à un ID de commande client donné.

Ce point de terminaison récupère les informations de commande à partir des tables suivantes :

Commande de clients [sn_ind_tmt_orm_order]
Élément de ligne de commande [sn_ind_tmt_orm_order_line_item]

Format d'URL

URL versionnée : /api/sn_ord_qual_mgmt/qualification/checkServiceQualification/{id}

Paramètres de demande pris en charge

Tableau 1. Paramètres de chemin d'accès
Nom	Description
api_version	Facultatif. Version du point de terminaison auquel accéder. Exemple : `v1` ou `v2`. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison différente de la dernière. Type de données : chaîne
ID	Sys_id de la commande du client de qualification à récupérer. Type de données : chaîne

Tableau 2. Paramètres de requête
Nom	Description
Néant

Tableau 3. Paramètres de corps de demande (XML ou JSON)
Nom	Description
Néant

En-têtes

Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir une liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

Tableau 4. En-têtes de demandes
En-tête	Description
Accepter	Format de données du corps de la réponse. Types pris en charge : application/json ou application/xml. Valeur par défaut : application/json

Tableau 5. En-têtes de réponses
En-tête	Description
Aucun

Codes d'état

Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir une liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

Tableau 6. Codes d'état

200	Demande traitée avec succès.
400	Demande incorrecte. Raisons possibles : Paramètre de chemin d’accès non valide URI non valide
404	Introuvable. L'élément demandé est introuvable.

Paramètres de corps de réponse (JSON ou XML)


Nom	Description
ID	Sys_id de la commande de client de qualification. Type de données : chaîne
href	Lien relatif à l’enregistrement de l’ordre de qualification. Type de données : chaîne
description	Description de la demande de qualification qui est extraite du champ short_description de la commande client. Type de données : chaîne
ID externe	ID externe du champ external_id de la commande client. Type de données : chaîne
Résultat de qualification	État de qualification du champ de résultat de la commande client. Valeurs possibles : Alternative en attente aucun qualifié Inconditionnel Type de données : chaîne
État	État de la commande de client depuis le champ d’état de la commande de client. Type de données : chaîne
@type	Fait partie de la norme TMF Open API. Annotation pour qualification. Cette valeur est toujours CheckServiceQualification. Ces informations ne sont pas stockées. Type de données : chaîne
checkServiceQualificationDate	Date et heure auxquelles la demande de qualification a été créée à partir du champ order_date de la commande client. Format : AAAA-MM-JJTHH :MM :SS. SSSZ (en anglais seulement) Type de données : chaîne
effectiveQualificationDate	Date de qualification effective extraite du champ order_date de la commande client. Format : AAAA-MM-JJTHH :MM :SS. SSSZ (en anglais seulement) Type de données : chaîne
expectedQualificationDate (attendue)	Stocke la date de qualification attendue. Persistance dans expected_end_date champ de la commande client. Format : AAAA-MM-JJTHH :MM :SS. SSSZ (en anglais seulement) Type de données : chaîne
relatedParty	Liste des contacts de la demande de qualification. Chaque contact est un objet du tableau. Type de données : tableau d’objets `"relatedParty": [ { "id": "String", "name": "String", "@type": "String", "@referredType": "String" } ]`
relatedParty.id	Sys_id ou external_id du compte, du contact client ou du consommateur associé à la commande. Disponible dans la table Compte [customer_account], la table Contact [customer_contact] ou la table Consommateur [csm_consumer]. Type de données : chaîne
relatedParty.name	Nom du compte, du client ou du consommateur. Type de données : chaîne
relatedParty.@type	Fait partie de la norme TMF Open API. Annotation pour le contact de l’élément de ligne de commande. Cette valeur est toujours RelatedParty. Ces informations ne sont pas stockées. Type de données : chaîne
relatedParty.@referredType	Type de partie associée. Valeurs possibles : Client Contact du client Consommateur Type de données : chaîne
Élément de qualification de service	Liste des éléments de qualification de service contenant des informations sur l’emplacement, les informations de service et les caractéristiques du service. Stockés en tant qu’éléments de ligne de commande pour la commande client. Type de données : tableau d’objets `"serviceQualificationItem": [ { "id": "string", "action": "string", "expectedServiceAvailabilityDate": "number", "service": { "place": [ { "id": "string", "name": "string" } ], "serviceCharacteristic": [ { "valueType": "string", "name": "string", "value": "string" } ], "serviceSpecification": { "id": "string", "name": "string" } }, "@type": "ServiceQualificationItem" } ],`
serviceQualificationItem.id	ID de l’élément de qualification. Stockée dans le champ « external_id » de l’élément de ligne de commande client. Type de données : chaîne
serviceQualificationItem.qualificationResult	Résultat de l’élément de qualification. Stockée dans le champ « résultat » de l’élément de ligne de commande client. Valeurs possibles : Alternative aucun en attente qualifié Inconditionnel Type de données : chaîne
serviceQualificationItem.state	État de l’élément de qualification dérivé du champ « État » de l’élément de ligne de commande client. Type de données : chaîne
serviceQualificationItem.quantity	Quantité d’éléments de qualification dérivée du champ « quantité » de l’élément de ligne de commande client. Type de données : nombre
serviceQualificationItem.@type	Fait partie de la norme TMF Open API. Annotation pour l’élément de qualification. Cette valeur est toujours ServiceQualificationItem. Ces informations ne sont pas stockées. Type de données : chaîne
serviceQualificationItem.service	Informations sur le service qui incluent des détails sur l’emplacement (lieu), les spécifications du service et les caractéristiques du service. Type de données : objet `"service": { "place": [ { "id": "String", "name": "String" } ], "serviceCharacteristic": [ { "valueType": "String", "name": "String", "value": "String" } ], "serviceSpecification": { "id": "String", "name": "String" } }`
serviceQualificationItem.service.@type	Fait partie de la norme TMF Open API. Annotation pour le service. Cette valeur est toujours Service. Ces informations ne sont pas stockées. Type de données : chaîne
ÉlémentQualificationService.Service.Place	Informations sur l’emplacement de l’élément de qualification de service. Type de données : tableau d’objets. Remarque : Ce tableau ne peut contenir qu’un seul emplacement. `"place": [ { "id": "5671dd2ec3a53010188473ce3640dd81", "name": "Jean Pontus home", "@referredType": "GeographicSite" } ]`
serviceQualificationItem.service.place.id	Sys_id d’un emplacement dans la table Emplacement [cmn_location]. Type de données : chaîne
serviceQualificationItem.service.place.name	Nom de l'emplacement. Non vérifié par rapport à une entrée de la table Emplacement [cmn_location]. Type de données : chaîne
serviceQualificationItem.service.place.@type	Fait partie de la norme TMF Open API. Annotation pour le service. Cette valeur est toujours GeographicSite . Ces informations ne sont pas stockées. Type de données : chaîne
serviceQualificationItem.service.serviceSpecification	Détails des spécifications de service pour l’élément de qualification. Type de données : tableau d’objets. `"serviceSpecification": { "id": "String", "internalVersion": "Number", "internalId": "String", "name": "String" "@type": "ServiceSpecification" "version": "String", }`
serviceQualificationItem.service.serviceSpecification.id	ID externe ou version initiale de la spécification de service. Type de données : chaîne
serviceQualificationItem.service.serviceSpecification.name	Nom de la spécification de service. Type de données : chaîne
serviceQualificationItem.service.serviceSpecification.version	Version externe de la spécification de service. Type de données : chaîne
serviceQualificationItem.service.serviceSpecification.internalVersion	Version interne de la spécification de service. Type de données : nombre
serviceQualificationItem.service.serviceSpecification.internalId	Version initiale de la spécification de service. Type de données : chaîne
serviceQualificationItem.service.serviceSpecification.@type	Fait partie de la norme TMF Open API. Annotation pour les spécifications de service. Cette valeur est toujours ServiceSpecification. Ces informations ne sont pas stockées. Type de données : chaîne
serviceQualificationItem.service.serviceCharacteristics	Liste des caractéristiques du service. Type de données : tableau d’objets `"serviceCharacteristic": [ { "name": "Speed", "value": "High" "valueType": "string", } ]`
serviceQualificationItem.service.serviceCharacteristic.valueType	Type de valeur de la caractéristique. Type de données : chaîne
serviceQualificationItem.service.serviceCharacteristic.name	Nom de la caractéristique. Type de données : chaîne
serviceQualificationItem.service.serviceCharacteristic.value	Valeur de la caractéristique. Type de données : chaîne
ÉlémentQualificationService.Proposition de service alternatif	Proposition de service alternative pour l’ordre de qualification. Les propositions alternatives sont stockées dans la table Proposition alternative [sn_ord_qual_mgmt_alternate_proposal]. Type de données : chaîne
ServiceQualificationItem.alternateServiceProposal.id	Sys_id de l’entrée de proposition alternative dans le tableau Proposition alternative [sn_ord_qual_mgmt_alternate_proposal]. Type de données : chaîne
ServiceQualificationItem.alternateServiceProposal.alternateServiceAvailabilityDate	La valeur de champ available_date de l’entrée de proposition alternative dans la table Proposition alternative [sn_ord_qual_mgmt_alternate_proposal]. Type de données : chaîne
serviceQualificationItem.alternateServiceProposal.alternateService	Informations sur le service représentées par la proposition alternative. Type de données : objet
serviceQualificationItem.alternateServiceProposal.alternateService.serviceSpecification	La spécification de service de la proposition alternative est demeurée dans la spécification du tableau de la proposition alternative [sn_ord_qual_mgmt_alternate_proposal]. Type de données : objet
serviceQualificationItem. alternateServiceProposal.alternateService.serviceSpecification.id	ID externe ou version initiale de l’autre spécification de service. Type de données : chaîne
serviceQualificationItem. alternateServiceProposal.alternateService.serviceSpecification.name	Nom de l’autre spécification de service. Type de données : chaîne
serviceQualificationItem. alternateServiceProposal.alternateService.serviceSpecification.version	Version externe de l’autre spécification de service. Type de données : chaîne
serviceQualificationItem. alternateServiceProposal.alternateService.serviceSpecification.internalVersion	Version interne de l’autre spécification de service. Type de données : nombre
serviceQualificationItem. alternateServiceProposal.alternateService.serviceSpecification.internalId	Version initiale de l’autre spécification de service. Type de données : chaîne
ServiceQualificationItem. alternateServiceProposal.alternateService.serviceSpecification.@type	Fait partie de la norme TMF Open API. Annotation pour les spécifications de service. Cette valeur est toujours ServiceSpecification. Ces informations ne sont pas stockées. Type de données : chaîne
serviceQualificationItem. alternateServiceProposal.alternateService.serviceCharacteristics	Tableau des caractéristiques de service pour l’autre proposition de service. Type de données : tableau d’objets `"serviceCharacteristic": [ { "valueType": "String", "name": "String", "value": "String" } ]`
serviceQualificationItem. alternateServiceProposal.alternateService.serviceCharacteristic.valueType	Type de valeur de l’autre caractéristique de service. Type de données : chaîne
serviceQualificationItem. alternateServiceProposal.alternateService.serviceCharacteristic.name	Nom de l’autre caractéristique de service. Type de données : chaîne
serviceQualificationItem. alternateServiceProposal.alternateService.serviceCharacteristic.value	Valeur de la caractéristique de service de remplacement. Type de données : chaîne
serviceQualificationItem.eligibilityUnavailabilityReason	Une liste des motifs d’indisponibilité d’éligibilité au service pour expliquer pourquoi le service n’est pas disponible. Cette valeur est conservée dans la « unavailability_reason » de la table Ordre de domaine [sn_ind_tmt_orm_domain_order]. Type de données : tableau
serviceQualificationItem.eligibilityUnavailabilityReason.code	Code de motif d’indisponibilité de l’éligibilité du service. Type de données : chaîne
serviceQualificationItem.eligibilityUnavailabilityReason.label	Étiquette du motif d’indisponibilité de l’éligibilité du service. Type de données : chaîne

Exemple de demande cURL

L’exemple suivant récupère l’intégralité d’une commande de qualification spécifique associée à un Sys_id donné d’une commande de client de qualification.

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

Réponse :

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

Qualification du service technique API ouverte : GET sn_ord_qual_mgmt/qualification/checkServiceQualification

Récupère une liste de toutes les demandes de qualification technique.

Ce point de terminaison récupère les informations de commande à partir des tables suivantes :

Commande de clients [sn_ind_tmt_orm_order]
Élément de ligne de commande [sn_ind_tmt_orm_order_line_item]

Ce point de terminaison renvoie 20 enregistrements par défaut, mais peut renvoyer un maximum de 100 enregistrements. Utilisez les filtres de requête pour affiner les résultats en fonction de l’état, du ou des noms de champ, de la description et du résultat de qualification.

Format d'URL

URL versionnée : /api/sn_ord_qual_mgmt/qualification/checkServiceQualification

Paramètres de demande pris en charge

Tableau 7. Paramètres de chemin d'accès
Nom	Description
api_version	Facultatif. Version du point de terminaison auquel accéder. Exemple : `v1` ou `v2`. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison différente de la dernière. Type de données : chaîne

Tableau 8. Paramètres de requêtes
Paramètre	Description
champs	Liste des noms de champs à renvoyer dans laréponse. Les champs non valides sont ignorés. Si ce paramètre n’est pas fourni dans la demande, tous les champs sont renvoyés. Type de données : chaîne, séparées par des virgules
limite	Nombre maximal d'enregistrements à renvoyer. Pour les demandes qui dépassent ce nombre d’enregistrements, utilisez le paramètre de décalage pour paginer la récupération de l’enregistrement. Par défaut : 20 Maximum : 100 Type de données : nombre
État	Filtre les ordres de qualification par état. Seules les commandes dont l’état correspond à la valeur de ce paramètre sont renvoyées dans la réponse. Type de données : chaîne
description	Filtre les commandes de qualification par le champ « short_description » de la commande client. Seules les commandes dont la description courte correspond àla valeur de ce paramètre sont renvoyées dans la réponse. Type de données : chaîne
Résultat de qualification	Filtre les ordres de qualification par résultat. Seules les commandes dont le résultat correspond à la valeur de ce paramètre sont renvoyées dans la réponse. Type de données : chaîne Format:

Tableau 9. Paramètres de corps de demande (XML ou JSON)
Nom	Description
Néant

En-têtes

Tableau 10. En-têtes de demandes
En-tête	Description
Accepter	Format de données du corps de la réponse. Types pris en charge : application/json ou application/xml. Valeur par défaut : application/json

Tableau 11. En-têtes de réponses
En-tête	Description
Aucun

Codes d'état

Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir une liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

Tableau 12. Codes d'état
Code d'état	Description
200	Demande traitée avec succès. Ressource entière renvoyée en réponse (aucune pagination).
206	Ressource partielle renvoyée en réponse (avec pagination).
400	Demande incorrecte. Raisons possibles : Paramètre de chemin d’accès non valide URI non valide
404	Aucun enregistrement trouvé pour les critères de filtre.

Paramètres de corps de réponse (JSON ou XML)


Nom	Description
ID	Sys_id de la commande de client de qualification. Type de données : chaîne
href	Lien relatif à l’enregistrement de l’ordre de qualification. Type de données : chaîne
description	Description de la demande de qualification qui est extraite du champ short_description de la commande client. Type de données : chaîne
ID externe	ID externe du champ external_id de la commande client. Type de données : chaîne
Résultat de qualification	État de qualification du champ de résultat de la commande client. Valeurs possibles : Alternative en attente aucun qualifié Inconditionnel Type de données : chaîne
État	État de la commande de client depuis le champ d’état de la commande de client. Type de données : chaîne
@type	Fait partie de la norme TMF Open API. Annotation pour qualification. Cette valeur est toujours CheckServiceQualification. Ces informations ne sont pas stockées. Type de données : chaîne
checkServiceQualificationDate	Date et heure auxquelles la demande de qualification a été créée à partir du champ order_date de la commande client. Format : AAAA-MM-JJTHH :MM :SS. SSSZ (en anglais seulement) Type de données : chaîne
effectiveQualificationDate	Date de qualification effective extraite du champ order_date de la commande client. Format : AAAA-MM-JJTHH :MM :SS. SSSZ (en anglais seulement) Type de données : chaîne
expectedQualificationDate (attendue)	Stocke la date de qualification attendue. Persistance dans expected_end_date champ de la commande client. Format : AAAA-MM-JJTHH :MM :SS. SSSZ (en anglais seulement) Type de données : chaîne
relatedParty	Liste des contacts de la demande de qualification. Chaque contact est un objet du tableau. Type de données : tableau d’objets `"relatedParty": [ { "id": "String", "name": "String", "@type": "String", "@referredType": "String" } ]`
relatedParty.id	Sys_id ou external_id du compte, du contact client ou du consommateur associé à la commande. Disponible dans la table Compte [customer_account], la table Contact [customer_contact] ou la table Consommateur [csm_consumer]. Type de données : chaîne
relatedParty.name	Nom du compte, du client ou du consommateur. Type de données : chaîne
relatedParty.@type	Fait partie de la norme TMF Open API. Annotation pour le contact de l’élément de ligne de commande. Cette valeur est toujours RelatedParty. Ces informations ne sont pas stockées. Type de données : chaîne
relatedParty.@referredType	Type de partie associée. Valeurs possibles : Client Contact du client Consommateur Type de données : chaîne
Élément de qualification de service	Liste des éléments de qualification de service contenant des informations sur l’emplacement, les informations de service et les caractéristiques du service. Stockés en tant qu’éléments de ligne de commande pour la commande client. Type de données : tableau d’objets `"serviceQualificationItem": [ { "id": "string", "action": "string", "expectedServiceAvailabilityDate": "number", "service": { "place": [ { "id": "string", "name": "string" } ], "serviceCharacteristic": [ { "valueType": "string", "name": "string", "value": "string" } ], "serviceSpecification": { "id": "string", "name": "string" } }, "@type": "ServiceQualificationItem" } ],`
serviceQualificationItem.id	ID de l’élément de qualification. Stockée dans le champ « external_id » de l’élément de ligne de commande client. Type de données : chaîne
serviceQualificationItem.qualificationResult	Résultat de l’élément de qualification. Stockée dans le champ « résultat » de l’élément de ligne de commande client. Valeurs possibles : Alternative aucun en attente qualifié Inconditionnel Type de données : chaîne
serviceQualificationItem.state	État de l’élément de qualification dérivé du champ « État » de l’élément de ligne de commande client. Type de données : chaîne
serviceQualificationItem.quantity	Quantité d’éléments de qualification dérivée du champ « quantité » de l’élément de ligne de commande client. Type de données : nombre
serviceQualificationItem.@type	Fait partie de la norme TMF Open API. Annotation pour l’élément de qualification. Cette valeur est toujours ServiceQualificationItem. Ces informations ne sont pas stockées. Type de données : chaîne
serviceQualificationItem.service	Informations sur le service qui incluent des détails sur l’emplacement (lieu), les spécifications du service et les caractéristiques du service. Type de données : objet `"service": { "place": [ { "id": "String", "name": "String" } ], "serviceCharacteristic": [ { "valueType": "String", "name": "String", "value": "String" } ], "serviceSpecification": { "id": "String", "name": "String" } }`
serviceQualificationItem.service.@type	Fait partie de la norme TMF Open API. Annotation pour le service. Cette valeur est toujours Service. Ces informations ne sont pas stockées. Type de données : chaîne
ÉlémentQualificationService.Service.Place	Informations sur l’emplacement de l’élément de qualification de service. Type de données : tableau d’objets. Remarque : Ce tableau ne peut contenir qu’un seul emplacement. `"place": [ { "id": "5671dd2ec3a53010188473ce3640dd81", "name": "Jean Pontus home", "@referredType": "GeographicSite" } ]`
serviceQualificationItem.service.place.id	Sys_id d’un emplacement dans la table Emplacement [cmn_location]. Type de données : chaîne
serviceQualificationItem.service.place.name	Nom de l'emplacement. Non vérifié par rapport à une entrée de la table Emplacement [cmn_location]. Type de données : chaîne
serviceQualificationItem.service.place.@type	Fait partie de la norme TMF Open API. Annotation pour le service. Cette valeur est toujours GeographicSite . Ces informations ne sont pas stockées. Type de données : chaîne
serviceQualificationItem.service.serviceSpecification	Détails des spécifications de service pour l’élément de qualification. Type de données : tableau d’objets. `"serviceSpecification": { "id": "String", "internalVersion": "Number", "internalId": "String", "name": "String" "@type": "ServiceSpecification" "version": "String", }`
serviceQualificationItem.service.serviceSpecification.id	ID externe ou version initiale de la spécification de service. Type de données : chaîne
serviceQualificationItem.service.serviceSpecification.name	Nom de la spécification de service. Type de données : chaîne
serviceQualificationItem.service.serviceSpecification.version	Version externe de la spécification de service. Type de données : chaîne
serviceQualificationItem.service.serviceSpecification.internalVersion	Version interne de la spécification de service. Type de données : nombre
serviceQualificationItem.service.serviceSpecification.internalId	Version initiale de la spécification de service. Type de données : chaîne
serviceQualificationItem.service.serviceSpecification.@type	Fait partie de la norme TMF Open API. Annotation pour les spécifications de service. Cette valeur est toujours ServiceSpecification. Ces informations ne sont pas stockées. Type de données : chaîne
serviceQualificationItem.service.serviceCharacteristics	Liste des caractéristiques du service. Type de données : tableau d’objets `"serviceCharacteristic": [ { "name": "Speed", "value": "High" "valueType": "string", } ]`
serviceQualificationItem.service.serviceCharacteristic.valueType	Type de valeur de la caractéristique. Type de données : chaîne
serviceQualificationItem.service.serviceCharacteristic.name	Nom de la caractéristique. Type de données : chaîne
serviceQualificationItem.service.serviceCharacteristic.value	Valeur de la caractéristique. Type de données : chaîne
ÉlémentQualificationService.Proposition de service alternatif	Proposition de service alternative pour l’ordre de qualification. Les propositions alternatives sont stockées dans la table Proposition alternative [sn_ord_qual_mgmt_alternate_proposal]. Type de données : chaîne
ServiceQualificationItem.alternateServiceProposal.id	Sys_id de l’entrée de proposition alternative dans le tableau Proposition alternative [sn_ord_qual_mgmt_alternate_proposal]. Type de données : chaîne
ServiceQualificationItem.alternateServiceProposal.alternateServiceAvailabilityDate	La valeur de champ available_date de l’entrée de proposition alternative dans la table Proposition alternative [sn_ord_qual_mgmt_alternate_proposal]. Type de données : chaîne
serviceQualificationItem.alternateServiceProposal.alternateService	Informations sur le service représentées par la proposition alternative. Type de données : objet
serviceQualificationItem.alternateServiceProposal.alternateService.serviceSpecification	La spécification de service de la proposition alternative est demeurée dans la spécification du tableau de la proposition alternative [sn_ord_qual_mgmt_alternate_proposal]. Type de données : objet
serviceQualificationItem. alternateServiceProposal.alternateService.serviceSpecification.id	ID externe ou version initiale de l’autre spécification de service. Type de données : chaîne
serviceQualificationItem. alternateServiceProposal.alternateService.serviceSpecification.name	Nom de l’autre spécification de service. Type de données : chaîne
serviceQualificationItem. alternateServiceProposal.alternateService.serviceSpecification.version	Version externe de l’autre spécification de service. Type de données : chaîne
serviceQualificationItem. alternateServiceProposal.alternateService.serviceSpecification.internalVersion	Version interne de l’autre spécification de service. Type de données : nombre
serviceQualificationItem. alternateServiceProposal.alternateService.serviceSpecification.internalId	Version initiale de l’autre spécification de service. Type de données : chaîne
ServiceQualificationItem. alternateServiceProposal.alternateService.serviceSpecification.@type	Fait partie de la norme TMF Open API. Annotation pour les spécifications de service. Cette valeur est toujours ServiceSpecification. Ces informations ne sont pas stockées. Type de données : chaîne
serviceQualificationItem. alternateServiceProposal.alternateService.serviceCharacteristics	Tableau des caractéristiques de service pour l’autre proposition de service. Type de données : tableau d’objets `"serviceCharacteristic": [ { "valueType": "String", "name": "String", "value": "String" } ]`
serviceQualificationItem. alternateServiceProposal.alternateService.serviceCharacteristic.valueType	Type de valeur de l’autre caractéristique de service. Type de données : chaîne
serviceQualificationItem. alternateServiceProposal.alternateService.serviceCharacteristic.name	Nom de l’autre caractéristique de service. Type de données : chaîne
serviceQualificationItem. alternateServiceProposal.alternateService.serviceCharacteristic.value	Valeur de la caractéristique de service de remplacement. Type de données : chaîne
serviceQualificationItem.eligibilityUnavailabilityReason	Une liste des motifs d’indisponibilité d’éligibilité au service pour expliquer pourquoi le service n’est pas disponible. Cette valeur est conservée dans la « unavailability_reason » de la table Ordre de domaine [sn_ind_tmt_orm_domain_order]. Type de données : tableau
serviceQualificationItem.eligibilityUnavailabilityReason.code	Code de motif d’indisponibilité de l’éligibilité du service. Type de données : chaîne
serviceQualificationItem.eligibilityUnavailabilityReason.label	Étiquette du motif d’indisponibilité de l’éligibilité du service. Type de données : chaîne

Exemple de demande cURL

L’appel GET suivant récupère toutes les commandes de qualification pour une instance.

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

Réponse :

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

Qualification du service technique API ouverte : POST sn_ord_qual_mgmt/qualification/checkServiceQualification

Crée une entité de demande de qualification de service technique contenant une liste d’éléments de qualification.

La demande de qualification de service est conservée en tant que commande de client avec le type d’exécution « Qualifier ». Chaque élément de qualification est conservé en tant que commande de ligne client dans la table Commande [sn_ind_tmt_orm_order_line_item].

Utilisation de ce point de terminaison

Vous pouvez utiliser cette méthode API pour trois cas d’utilisation spécifiques :

Demande de qualification d’un service à une adresse spécifiée.
Demandez à qualifier un nouveau service au même emplacement qu’un service Access existant et actif.
Demande de mise à niveau ou de rétrogradation d’un service existant.

Chaque cas d’utilisation nécessite la même structure de demande, mais utilise des paramètres de demande différents. Des détails sur chaque cas d’utilisation et les paramètres acceptés sont fournis :

Pour qualifier un service à une adresse spécifiée, utilisez le place tableau (serviceQualificationItem.service.place) pour indiquer un emplacement spécifique et la spécification du service. Vous pouvez éventuellement définir des caractéristiques de service supplémentaires dans votre demande.
Pour qualifier un nouveau service au même emplacement qu’un service existant et actif, utilisez l’objet referenceServiceInventory (serviceQualificationItem.service.referenceServiceInventory) au lieu du place tableau. Cet objet vous permet de créer une demande et de définir des spécifications de service sans avoir à fournir de détails d’emplacement. Vous pouvez éventuellement définir des caractéristiques de service supplémentaires dans votre demande.
Pour mettre à niveau ou rétrograder un service existant, utilisez l’objet serviceInventory (serviceQualificationItem.service.ServiceInventory) au lieu du tableau ou de l’objet placereferenceServiceInventory . Dans ce cas d’utilisation, les informations d’emplacement et les détails des spécifications sont récupérés à partir d’un service existant. Dans votre demande, définissez les caractéristiques de service que vous souhaitez modifier.
Par exemple, imaginons que vous souhaitez vérifier que vous pouvez mettre à niveau la vitesse de téléchargement d’un service existant et actif de 100 Mbits/s à 600 Mbits/s. Dans ce cas, vous pouvez utiliser le serviceInventory paramètre pour définir la requête en changeant la caractéristique 'Vitesse' de 'Faible' à 'Haute'. L’API obtient les caractéristiques restantes du service existant.

Pour comprendre comment former votre demande d’API par cas d’utilisation particulier, consultez les exemples d’appels fournis dans la section Exemple de cette page.

Format d'URL

URL versionnée : /api/sn_ord_qual_mgmt/qualification/checkServiceQualification

Paramètres de demande pris en charge

Tableau 13. Paramètres de chemin d'accès
Nom	Description
Aucun

Tableau 14. Paramètres de requête
Nom	Description
Néant

Tableau 15. Paramètres de corps de demande (XML ou JSON)
Paramètre	Description
description	Facultatif. Description de la demande de qualification qui est stockée et conservée dans le champ « short_description » de la commande client. Type de données : chaîne
checkServiceQualificationDate	Facultatif. Stocke la date et l’heure de création de la demande de qualification. Persistance dans le champ « order_date » de la commande client. S’il n’est pas spécifié, « order_date » est défini sur la date et l’heure actuelles. Type de données : chaîne Format : AAAA-MM-JJTHH :MM :SS. SSSZ (en anglais seulement)
effectiveQualificationDate	Facultatif. Stocke la date de qualification attendue. Persistance dans le champ « actual_end_date » de la commande client. Type de données : chaîne Format : AAAA-MM-JJTHH :MM :SS. SSSZ (en anglais seulement)
expectedQualificationDate (attendue)	Facultatif. Stocke la date de qualification attendue. Persistance dans le champ expected_end_date' de la commande client. Type de données : chaîne Format : AAAA-MM-JJTHH :MM :SS. SSSZ (en anglais seulement)
ID externe	Facultatif. L’ID externe de la commande client, conservé dans « external_id » de la commande client. Type de données : chaîne
relatedParty	Requis. Liste des contacts associés à la demande de qualification (tels que les comptes clients, les contacts, etc.). Présenté sous forme de tableau, relatedParty il doit répertorier au moins un objet contenant des informations sur le compte de client ou de consommateur. Type de données : tableau d’objets `"relatedParty": [ { "id": "String", "name": "String", "@referredType": "String" "@type": "String", }, ]`
relatedParty.id	Requis. Sys_id ou external_id du compte, du contact client ou du consommateur associé à la commande. Disponible dans la table Compte [customer_account], la table Contact [customer_contact] ou la table Consommateur [csm_consumer]. Type de données : chaîne
relatedParty.name	Facultatif. Nom du compte, du client ou du consommateur. Type de données : chaîne
relatedParty.@type	Facultatif. Fait partie de la norme TMF Open API. Annotation pour le contact de l’élément de ligne de commande. Cette valeur est toujours RelatedParty. Cesinformations ne sont pas stockées. Type de données : chaîne
relatedParty.@referredType	Requis. Type de partie associée. Valeurs valides : Client Contact du client Consommateur Type de données : chaîne
Élément de qualification de service	Requis. Liste des éléments de qualification de service contenant des informations sur l’emplacement, les spécifications du service et les caractéristiques du service. Stockés en tant qu’éléments de ligne de commande pour la commande client. Inclure au moins un élément de qualification de service dans la liste. Type de données : tableau d’objets `"serviceQualificationItem": [ { "id": "100", "action": "add", "expectedServiceAvailabilityDate": "2022-12-11T19:20:39.239Z", "service": { "place": [ { "id": "5671dd2ec3a53010188473ce3640dd81", "name": "Jean Pontus home" } ], "serviceCharacteristic": [ { "valueType": "string", "name": "Speed", "value": "High" } ], "serviceSpecification": { "id": "91478553b7969910ff00f203ae11a97d", "name": "Broadband Service" } }, "@type": "ServiceQualificationItem" } ],`
serviceQualificationItem.id	Requis. ID de l’élément de qualification. Stocké dans le champ « external_id » de l’élément de ligne de commande client. Type de données : chaîne
serviceQualificationItem.quantity	Facultatif. Quantité de l’élément de qualification. Persistance dans le champ « quantité » de l’élément de ligne de commande client. Type de données : nombre Valeur par défaut : 1
serviceQualificationItem.qualificationItemRelationship	Facultatif. Liste des relations avec d’autres éléments de qualification de service dans la même demande. Ces informations permettent de créer des éléments de ligne de commande avec un élément de ligne de commande parent. Type de données : tableau d’objets `"qualificationItemRelationship": [ { "relationshipType": "HasChild", "id": "110" }, { "relationshipType": "HasChild", "id": "120" }, { "relationshipType": "HasChild", "id": "130" } ] "qualificationItemRelationship": [ { "relationshipType": "HasParent", "id": "100" } ]`
serviceQualificationItem. RelationÉlémentQualification.Type de relation	Requis. Indique si le type de relation est un élément de ligne enfant ou parent. Valeurs acceptées : HasChild : indique l’élément enfant. HasParent : indique l’élément de ligne parent. Type de données : chaîne
serviceQualificationItem.QualificationItemRelationship.id	Requis. L’ID de l’élément de qualification cibledans la relation. Type de données : chaîne
serviceQualificationItem.service	Requis. Informations sur le service qui fournissent des détails sur le lieu, les spécifications du service et les caractéristiques du service. Type de données : objet `"service": { "place": [ { "id": "5671dd2ec3a53010188473ce3640dd81", "name": "Jean Pontus home" } ], "serviceCharacteristic": [ { "valueType": "string", "name": "Speed", "value": "High" } ], "serviceSpecification": { "id": "91478553b7969910ff00f203ae11a97d", "name": "Broadband Service" } }`
serviceQualificationItem.service.@type	Facultatif. Fait partie de la norme TMF Open API. Annotation pour les informations de service d’un élément de qualification. Cette valeur est toujours Service. Ces informations ne sont pas stockées. Type de données : chaîne
serviceQualificationItem.service.place	Requis. Stocke les informations d’emplacement demandées pour l’élément de qualification de service. Cet ID d’emplacement doit être une entrée valide dans la table Emplacement [cmn_location]. Important : Utilisez le tableau d’emplacement pour qualifier un service à une adresse spécifique. Pour ce faire, vous devez omettre les referenceServiceInventory objets and serviceInventory de votre demande, sinon l’API renvoie une erreur. Type de données : tableau d’objets Remarque : Même si le tableau est pris en charge, le tableau ne doit contenir qu’un seul emplacement. Exemple de tableau : `"place": [ { "id": "5671dd2ec3a53010188473ce3640dd81", "name": "Jean Pontus home" } ]`
serviceQualificationItem.service.place.id	Nécessaire si vous l’utilisez serviceQualificationItem.service.place dans votre demande. sys_id d’un emplacement dans la table Emplacement [cmn_location]. Type de données : chaîne
serviceQualificationItem.service.place.name	Facultatif si vous l’utilisez serviceQualificationItem.service.place dans votre demande. Nom de l’emplacement. La valeur du nom n’est pas vérifiée par rapport aux entrées d’emplacement [cmn_location]. Type de données : chaîne
serviceQualificationItem.service.place.@type	Facultatif si vous l’utilisez serviceQualificationItem.service.place dans votre demande. Fait partie de la norme TMF Open API. Annotation pour le service. Cette valeur est toujours GeographicSite . Ces informations ne sont pas stockées. Type de données : chaîne
ÉlémentQualificationService.service.referenceServiceInventory	Requis. Entité d’inventaire des services valide qui fait référence à un service actif pour l’emplacement requis. Les informations d’emplacement de l’ordre de qualification sont obtenues à partir de l’emplacement de cet inventaire de services. Important : Utilisez l’objet referenceServiceInventory pour qualifier un nouveau service au même emplacement qu’un service Access existant et actif. Pour ce faire, vous devez également omettre le tableau et serviceInventory l’objet place de votre requête, sinon l’API renvoie une erreur. Type de données : objet `"referenceServiceInventory": { "id": "f1b2d99e777301108e191e599a5a99d2" },`
serviceQualificationItem.service.referenceServiceInventory.id	Nécessaire en cas d’utilisation serviceQualificationItem.service.referenceServiceInventory dans la demande. sys_id d’une entité d’inventaire des services valide qui fait référence à un service actif pour l’emplacement requis. Cette information n’est mentionnée que dans les notes de travail de la commande, mais n’est pas conservée. Type de données : chaîne
ÉlémentQualificationService.Service.ServiceInventory	Requis. Entité d’inventaire des services valide qui fait référence à un service actif nécessitant une mise à niveau ou une version antérieure. Important : Utilisez l’objet serviceInventory pour les mises à niveau de service ou les versions antérieures. Pour ce faire, vous devez omettre le lieu array et referenceServiceInventory l’objet de votre demande, sinon l’API renvoie une erreur. Type de données : objet `"serviceInventory": { "id": "f1b2d99e777301108e191e599a5a99d2" },` Le serviceCharacteristics paramètre est requis lors de l’utilisation serviceInventory pour définir des changements de service. Les informations sur l’emplacement et les spécifications du service pour l’ordre de qualification sont obtenues à partir de l’emplacement et des spécifications de cet inventaire de services respectivement.
serviceQualificationItem.service.serviceInventory.id	Nécessaire en cas d’utilisation serviceQualificationItem.service.serviceInventory dans la demande. La sys_id d’une entité d’inventaire des services existante valide qui nécessite une mise à niveau ou une version antérieure. Cette information n’est mentionnée que dans les notes de travail de la commande, mais n’est pas conservée. Type de données : chaîne
serviceQualificationItem.service.serviceSpecification	Requis. Spécifications de service pour l’élément de qualification. Stockée dans le champ « service_specification » de l’élément de ligne de commande client. La spécification de service pour un élément de qualification ne doit pas être orientée vers les ressources. Type de données : objet `"serviceSpecification": { "id": "91478553b7969910ff00f203ae11a97d", "name": "Broadband Service", “@type”: ”ServiceSpecification” }`
serviceQualificationItem.service.serviceSpecification.id	Requis. ID externe ou version initiale de la spécification de service. Type de données : chaîne
serviceQualificationItem.service.serviceSpecification.name	Requis. Nom de la spécification de service. Type de données : chaîne
serviceQualificationItem.service.serviceSpecification.Version	Facultatif. Version externe de la spécification de service. Type de données : chaîne
serviceQualificationItem.service.serviceSpecification.Version interne	Facultatif. Version interne de la spécification de service Type de données : nombre
ServiceQualificationItem.service.serviceSpecification.@type	Facultatif. Fait partie de la norme TMF Open API. Annotation pour les spécifications de service. Cette valeur est toujours ServiceSpecification. Ces informations ne sont pas stockées. Type de données : chaîne
serviceQualificationItem.service.serviceCharacteristics	Facultatif. Tableau des caractéristiques de service. Type de données : tableau d’objets
serviceQualificationItem.service.serviceCharacteristic.Valuetype	Facultatif. Type de valeur de la caractéristique. Type de données : chaîne
serviceQualificationItem.service.serviceCharacteristic.name	Requis. Nom de la caractéristique. Type de données : chaîne
serviceQualificationItem.service.serviceCharacteristic.value	Facultatif. Valeur de la caractéristique. Fait partie de la norme TMF Open API. Annotation pour l’élément de qualification. Cette valeur est toujours ServiceQualificationItem. Ces informations ne sont pas stockées. Type de données : chaîne
serviceQualificationItem.@type	Facultatif. Fait partie de la norme TMF Open API. Annotation pour l’élément de qualification. Cette valeur est toujours ServiceQualificationItem. Ces informations ne sont pas stockées. Type de données : chaîne
@type	Facultatif. Fait partie de la norme TMF Open API. Annotation pour qualification. Cette valeur est toujours CheckServiceQualification. Ces informations ne sont pas stockées. Type de données : chaîne

En-têtes

Tableau 16. En-têtes de demandes
En-tête	Description
Accepter	Format de données du corps de la réponse. Types pris en charge : application/json ou application/xml. Valeur par défaut : application/json

Tableau 17. En-têtes de réponses
En-tête	Description
Aucun

Codes d'état

Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir une liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

Tableau 18. Codes d'état
Code d'état	Description
201	Demande traitée avec succès. Remarque : En cas de problème avec les caractéristiques ou les informations sur les options de caractéristiques, le point de terminaison stocke les commentaires suivants dans les champs des notes de travail de l’enregistrement d’élément de ligne de commande client associé, similaire aux ordres de livraison existants
400	Demande incorrecte. Cela peut être l’une des raisons suivantes : Charge utile vide. Charge utile non valide : Champ obligatoire manquant : <nom de champ> Charge utile non valide : corps de la demande manquant : la charge utile n’a pas été transmise dans le corps de la demande. Charge utile non valide : relatedParty est manquant. Charge utile non valide : serviceQualificationItem est manquant. Charge utile non valide : l’ID serviceQualificationItem est manquant. Charge utile non valide : serviceQualificationItem service est manquant. Charge utile non valide : les informations d’emplacement sont manquantes. Veuillez fournir place, serviceInventory ou referenceServiceInventory. Charge utile non valide : les informations de spécification sont manquantes, veuillez fournir serviceSpecification ou serviceInventory. Charge utile non valide : la spécification de service n’existe pas. Charge utile non valide : le compte client n’existe pas. Charge utile non valide : le consommateur n’existe pas.
500	Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur.

Paramètres de corps de réponse (JSON ou XML)

Tableau 19. Éléments renvoyés dans le corps de réponse
Élément	Description
ID	Sys_id de la commande de client de qualification mise à jour pour cette demande. Type de données : chaîne
href	Lien relatif à l’enregistrement de l’ordre de qualification. Type de données : chaîne
description	Description de la demande de qualification qui est utilisée à partir du champ « short_description » de la commande client. Type de données : chaîne
ID externe	ID externe du « external_id » de la commande client. Type de données : chaîne
Résultat de qualification	Résultat de la commande du client à partir du champ « résultat ». Valeurs possibles : qualifié Inconditionnel Alternative en attente aucun Type de données : chaîne
État	État de la commande declient du champ « Statut » de la commande de client.
@type	Fait partie de la norme TMF Open API. Annotation pour qualification. Cette valeur est toujours CheckServiceQualification. Ces informations ne sont pas stockées. Type de données : chaîne
checkServiceQualificationDate	Date et heure auxquelles la demande de qualification a été créée à partir du champ « order_date » de la commande client. Type de données : chaîne Format : AAAA-MM-JJTHH :MM :SS. SSSZ (en anglais seulement)
effectiveQualificationDate	Date de qualification effective du champ « order_date » de la commande client. Type de données : chaîne Format : AAAA-MM-JJTHH :MM :SS. SSSZ (en anglais seulement)
expectedQualificationDate (attendue)	Stocke la date de qualification attendue. Persistance dans le champ expected_end_date' de la commande client. Type de données : chaîne Format : AAAA-MM-JJTHH :MM :SS. SSSZ (en anglais seulement)
relatedParty	Requis. Liste des contacts associés à la demande de qualification (tels que les comptes clients, les contacts, etc.). Présenté sous forme de tableau, relatedParty il doit répertorier au moins un objet contenant des informations sur le compte de client ou de consommateur. Type de données : tableau d’objets Exemple de tableau : `"relatedParty": [ { "id": "String", "name": "String", "@type": "String", "@referredType": "String" }, ]`
relatedParty.id	Requis. Sys_id ou external_id du compte, du contact client ou du consommateur associé à la commande. Disponible dans la table Compte [customer_account], la table Contact [customer_contact] ou la table Consommateur [csm_consumer]. Type de données : chaîne
relatedParty.name	Facultatif. Nom du compte, du client ou du consommateur. Type de données : chaîne
relatedParty.@type	Fait partie de la norme TMF Open API. Annotation pour le contact de l’élément de ligne de commande. Cette valeur est toujours RelatedParty. Ces informations ne sont pas stockées. Type de données : chaîne
relatedParty.@referredType	Type de partie associée. Valeurs possibles : Client Contact du client Consommateur Type de données : chaîne
Élément de qualification de service	Liste des éléments de qualification de service avec l’emplacement, les informations sur le service et les caractéristiques. Stockés en tant qu’éléments de ligne de commande pour la commande client. Doit inclure au moins un élément de qualification de service dans la liste. Type de données : tableau d’objets `"serviceQualificationItem": [ { "id": "100", "action": "add", "expectedServiceAvailabilityDate": "2022-12-11T19:20:39.239Z", "service": { "place": [ { "id": "5671dd2ec3a53010188473ce3640dd81", "name": "Jean Pontus home" } ], "serviceCharacteristic": [ { "valueType": "string", "name": "Speed", "value": "High" } ], "serviceSpecification": { "id": "91478553b7969910ff00f203ae11a97d", "name": "Broadband Service" } }, "@type": "ServiceQualificationItem" } ],`
serviceQualificationItem.id	ID de l’élément de qualification. Cet ID est stocké dans external_id champ de l’élément de ligne de commande client. Type de données : chaîne
serviceQualificationItem.qualificationResult	Résultat de l’élément de qualification. Stocké dans « résultat » de l’élément de ligne de commande client. Le résultat peut être aucun, en attente, qualifié, non qualifié ou alternatif. Type de données : chaîne
serviceQualificationItem.state	État de l’élément de qualification dérivé du champ « État » de l’élément de ligne de commande client. Type de données : chaîne
serviceQualificationItem.quantity	Quantité d’éléments de qualification dérivée du champ « quantité » de l’élément de ligne de commande client. Type de données : nombre
serviceQualificationItem.@type	Fait partie de la norme TMF Open API. Annotation pour l’élément de qualification. Cette valeur est toujours ServiceQualificationItem. Ces informations ne sont pas stockées. Type de données : chaîne
serviceQualificationItem.service	Les informations sur le service comprennent le lieu, les spécifications et les caractéristiques. Type de données : objet `"service": { "place": [ { "id": "5671dd2ec3a53010188473ce3640dd81", "name": "Jean Pontus home" } ], "serviceCharacteristic": [ { "valueType": "string", "name": "Speed", "value": "High" } ], "serviceSpecification": { "id": "91478553b7969910ff00f203ae11a97d", "name": "Broadband Service" } }`
serviceQualificationItem.service.@type	Fait partie de la norme TMF Open API. Annotation pour le service. Cette valeur est toujours Service. Ces informations ne sont pas stockées. Type de données : chaîne
ÉlémentQualificationService.Service.Place	Informations sur l’emplacement de l’élément de qualification de service. Type de données : tableau d’objets. Remarque : Même si le tableau est pris en charge, il peut ne contenir qu’un seul emplacement. `"place": [ { "id": "5671dd2ec3a53010188473ce3640dd81", "name": "Jean Pontus home", "@referredType": "GeographicSite" } ]`
serviceQualificationItem.service.place.id	Sys_id d’un emplacement dans cmn_location table. Type de données : chaîne
serviceQualificationItem.service.place.name	Nom de l'emplacement. Non vérifié par rapport à l’entrée dans cmn_location. Type de données : chaîne
serviceQualificationItem.service.place.@type	Fait partie de la norme TMF Open API. Annotation pour le service. Cette valeur est toujours GeographicSite . Ces informations ne sont pas stockées. Type de données : chaîne
serviceQualificationItem.service.serviceSpecification	Spécifications de service pour l’élément de qualification. Type de données : objet `"serviceSpecification": { "id": "91478553b7969910ff00f203ae11a97d", "name": "Broadband Service", "version": "", "internalVersion": "1", "internalId": "91478553b7969910ff00f203ae11a97d", "@type": "ServiceSpecification" }`
serviceQualificationItem.service.serviceSpecification.id	ID externe ou version initiale de la spécification de service. Type de données : chaîne
serviceQualificationItem.service.serviceSpecification.name	Nom de la spécification de service. Type de données : chaîne
serviceQualificationItem.service.serviceSpecification.version	Version externe de la spécification de service Type de données : chaîne
serviceQualificationItem.service.serviceSpecification.internalVersion	Version interne de la spécification de service Type de données : chaîne
serviceQualificationItem.service.serviceSpecification.internalId	ID interne de la spécification de service Type de données : chaîne
serviceQualificationItem.service.serviceSpecification.@type	Fait partie de la norme TMF Open API. Annotation pour les spécifications de service. Cette valeur est toujours ServiceSpecification. Ces informations ne sont pas stockées. Type de données : chaîne
serviceQualificationItem.service.serviceCharacteristics	Liste des caractéristiques du service. Type de données : tableau `"serviceCharacteristic": [ { "valueType": "string", "name": "Speed", "value": "High" } ]`
serviceQualificationItem.service.serviceCharacteristic.valueType	Type de valeur de la caractéristique. Type de données : chaîne
serviceQualificationItem.service.serviceCharacteristic.name	Nom de la caractéristique. Type de données : chaîne
serviceQualificationItem.service.serviceCharacteristic.value	Valeur de la caractéristique. Type de données : chaîne

Cas d’utilisation 1

L’exemple suivant montre une demande simple contenant un seul élément de qualification.

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

Réponse :

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

Cas d’utilisation 2

L’exemple suivant montre comment demander une qualification de service simple à l’aide d’un ID afin d’obtenir l’emplacement du client avec un service existant.

Remarque :

L’inventaire des services de référence avec id = est un inventaire de produits avec l’emplacement = 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"
}

Réponse, où place elle est renseignée referenceServiceInventory dans la demande.

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

Cas d’utilisation 3

L’exemple suivant montre comment mettre à niveau le service haut débit d’un utilisateur vers une vitesse supérieure. L’inventaire des services avec id = est un inventaire de produits avec Spécification de service = 'Service haut débit', Emplacement = 20220 Bow Willow, Houston, TX, Characteristics =[{Speed :Medium}].

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

Réponse, où place et specification sont renseignés serviceInventory dans la demande.

Remarque :

Les caractéristiques sont d’abord extraites de la charge utile de la demande, puis les caractéristiques restantes (le cas échéant) sont obtenues à partir de 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"
}

Cas d’utilisation 4

Décrit la hiérarchie des éléments de ligne parents et enfants et leurs types de relations. Il montre comment plusieurs éléments de ligne peuvent être créés via l’attribut quantité.

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

Réponse :

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