API ouverte de qualification du service technique

Rversion finale: Yokohama

Mis à jour 30 janv. 2025

54 minutes de lecture

L’API ouverte de qualification du service technique fournit des points de terminaison permettant 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 à la section Service qualification requests.

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

Gestion du catalogue de produits Core [com.sn_prd_pm]
Catalogue de produits avancé [com.sn_prd_pm_adv]
Gestion des qualifications de commande [com.sn_ord_qual_mgmt]
Order Management pour les télécommunications, les médias et la technologie [com.sn_tmt_core]
Cœur des télécommunications [com.sn_tmt_core]

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

API ouverte de qualification du service technique : 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 par défaut : /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
id	Sys_id de la commande du client de qualification à récupérer. Type de données : chaîne Table : Commande de clients [sn_ind_tmt_orm_order]

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 la 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 la 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	Réussi. La demande a été correctement traitée.
400	Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté.
404	Introuvable. L’élément demandé est introuvable.

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


Nom	Description
id	Sys_id de la commande de client de qualification. Type de données : chaîne Table : Commande de clients [sn_ind_tmt_orm_order]
href	Lien relatif vers l’enregistrement de l’ordre de qualification. Type de données : chaîne
description	Description de la demande de qualification extraite du champ short_description de la commande de client. Type de données : chaîne Table : Commande de clients [sn_ind_tmt_orm_order]
externalId	ID externe de la commande de client. Type de données : chaîne Table : dans le champ external_id de la table Commande client [sn_ind_tmt_orm_order].
Résultat de qualification	Statut de qualification du champ de résultat de la commande de client. Valeurs possibles : alterner Aucun En attente qualifié inconditionnel Type de données : chaîne
État	État de la commande de client à partir du champ d’état de la commande de client. Type de données : chaîne
@type	Fait partie de la norme d’API ouverte TMF. Annotation pour la qualification. Cette valeur est toujours `CheckServiceQualification`. Ces informations ne sont pas stockées. Type de données : chaîne
checkServiceQualificationDate	Date et heure de création de la demande de qualification à partir du champ order_date de la commande de client. Type de données : chaîne Format : AAAA-MM-JJTHH :MM :SS. SSSZ Table : Commande de clients [sn_ind_tmt_orm_order]
effectiveQualificationDate	Date de qualification effective extraite du champ order_date de la commande de client. Type de données : chaîne Format : AAAA-MM-JJTHH :MM :SS. SSSZ Table : Commande de clients [sn_ind_tmt_orm_order]
expectedQualificationDate	Stocke la date de qualification attendue. A persisté dans expected_end_date champ de la commande client. Type de données : chaîne Format : AAAA-MM-JJTHH :MM :SS. SSSZ Table : Commande de clients [sn_ind_tmt_orm_order]
Fête connexe	Liste des contacts pour la demande de qualification. Chaque contact est un objet dans le tableau. Type de données : tableau d’objets `"relatedParty": [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ]`
relatedParty.id	Sys_id ou external_id du compte, du contact client ou du consommateur associé à la commande. Type de données : chaîne Table : table Compte [customer_account], table Contact [customer_contact] ou Consommateur [csm_consumer]
relatedParty.name	Nom du compte, du client ou du consommateur. Type de données : chaîne
relatedParty.@type	Fait partie de la norme d’API ouverte TMF. 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 liée. Valeurs possibles : Consommateur Client Contact client Type de données : chaîne
serviceQualificationItem	Liste des éléments de qualification de service contenant des informations sur l’emplacement, des informations de service et les caractéristiques de 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": {Object}, "@type": "String" } ]`
serviceQualificationItem.id	ID de l’élément de qualification. Type de données : chaîne Stocké dans : Le champ external_id de l’élément de ligne de commande client dans la table Élément de ligne de commande [sn_ind_tmt_orm_order_line_item].
serviceQualificationItem.qualificationResult	Résultat de l’élément de qualification. Stocké dans le champ « résultat » de l’élément de ligne de commande client. Valeurs possibles : alterner Aucun En attente qualifié inconditionnel Type de données : chaîne Table : élément de ligne de commande [sn_ind_tmt_orm_order_line_item]
serviceQualificationItem.state	État de l’élément de qualification dérivé du champ « statut » de l’élément de ligne de commande client. Type de données : chaîne Table : élément de ligne de commande [sn_ind_tmt_orm_order_line_item]
serviceQualificationItem.quantity	Quantité de l’élément de qualification dérivée du champ « quantité » de l’élément de ligne de commande client. Type de données : nombre Table :Élément de ligne de commande [sn_ind_tmt_orm_order_line_item]
serviceQualificationItem.@type	Fait partie de la norme d’API ouverte TMF. 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, notamment des détails sur l’emplacement (lieu), les spécifications et les caractéristiques du service. Type de données : objet `"service": { "@type": "String", "place": [Array], "serviceCharacteristic": [Array], "serviceSpecification": {Object} }`
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
serviceQualificationItem.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": "String", "name": "String", "@referredType": "String" } ]`
serviceQualificationItem.service.place.id	Sys_id de l’emplacement. Type de données : chaîne Table : Emplacement [cmn_location]
serviceQualificationItem.service.place.name	Nom de l'emplacement. Non vérifié par rapport à une entrée dans la table Emplacement [cmn_location]. Type de données : chaîne
serviceQualificationItem.service.place.@type	Fait partie de la norme d’API ouverte TMF. 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 de la spécification 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 d’API ouverte TMF. Annotation pour la spécification 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": "String", "value": "String", "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
ServiceQualificationItem.alternateServiceProposal	Proposition de service alternatif pour l’ordre de qualification. Type de données : chaîne Stockée dans : Proposition alternative [sn_ord_qual_mgmt_alternate_proposal]
ServiceQualificationItem.alternateServiceProposal.id	Sys_id de l’enregistrement de la proposition alternative. Type de données : chaîne Tableau : Proposition alternative [sn_ord_qual_mgmt_alternate_proposal]
ServiceQualificationItem.alternateServiceProposal.alternateServiceAvailabilityDate	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 du service de la proposition alternative a persisté dans la spécification. Type de données : objet Tableau : Proposition alternative [sn_ord_qual_mgmt_alternate_proposal]
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
Élément de qualification de service. alternateServiceProposal.alternateService.serviceSpecification.@type	Fait partie de la norme d’API ouverte TMF. Annotation pour la spécification de service. Cette valeur est toujours `ServiceSpecification`. Ces informations ne sont pas stockées. Type de données : chaîne
serviceQualificationItem. alternateServiceProposal.alternateService.serviceCharacteristics	Liste des caractéristiques de service pour la proposition de service de remplacement. Type de données : tableau d’objets `"serviceCharacteristic": [ { "name": "String", "value": "String", "valueType": "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. AlternativeServiceProposal.alternateService.serviceCharacteristic.value	Valeur de la caractéristique de service alternatif. Type de données : chaîne
serviceQualificationItem.eligibilityUnavailabilityReason	Liste des motifs d’indisponibilité d’éligibilité au service pour expliquer pourquoi le service n’est pas disponible. Type de données : tableau Stocké dans : Le champ unavailability_reason de la table Commande de domaine [sn_ind_tmt_orm_domain_order].
serviceQualificationItem.eligibilityUnavailabilityReason.code	Code du 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é au 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"
  }
]

API ouverte de qualification du service technique : 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 retourne 20 enregistrements par défaut, mais peut renvoyer un maximum de 100 enregistrements. Utilisez des filtres de requête pour affiner les résultats en fonction du statut, du ou des noms de champ, de la description et du résultat de qualification.

Format d'URL

URL par défaut : /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
Néant

Tableau 8. Paramètres de requêtes
Paramètre	Description
description	Filtre les commandes de qualifications en fonction du champ « short_description » de la commande client. Seules les commandes dont la description brève correspond àla valeur de ce paramètre sont renvoyées dans la réponse. Type de données : chaîne
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ée 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
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
É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

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 la 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 complète renvoyée en réponse (aucune pagination).
206	Ressource partielle retourné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 du corps de la réponse (JSON ou XML)


Nom	Description
id	Sys_id de la commande de client de qualification. Type de données : chaîne Table : Commande de clients [sn_ind_tmt_orm_order]
href	Lien relatif vers l’enregistrement de l’ordre de qualification. Type de données : chaîne
description	Description de la demande de qualification extraite du champ short_description de la commande de client. Type de données : chaîne Table : Commande de clients [sn_ind_tmt_orm_order]
externalId	ID externe de la commande de client. Type de données : chaîne Table : dans le champ external_id de la table Commande client [sn_ind_tmt_orm_order].
Résultat de qualification	Statut de qualification du champ de résultat de la commande de client. Valeurs possibles : alterner Aucun En attente qualifié inconditionnel Type de données : chaîne
État	État de la commande de client à partir du champ d’état de la commande de client. Type de données : chaîne
@type	Fait partie de la norme d’API ouverte TMF. Annotation pour la qualification. Cette valeur est toujours `CheckServiceQualification`. Ces informations ne sont pas stockées. Type de données : chaîne
checkServiceQualificationDate	Date et heure de création de la demande de qualification à partir du champ order_date de la commande de client. Type de données : chaîne Format : AAAA-MM-JJTHH :MM :SS. SSSZ Table : Commande de clients [sn_ind_tmt_orm_order]
effectiveQualificationDate	Date de qualification effective extraite du champ order_date de la commande de client. Type de données : chaîne Format : AAAA-MM-JJTHH :MM :SS. SSSZ Table : Commande de clients [sn_ind_tmt_orm_order]
expectedQualificationDate	Stocke la date de qualification attendue. A persisté dans expected_end_date champ de la commande client. Type de données : chaîne Format : AAAA-MM-JJTHH :MM :SS. SSSZ Table : Commande de clients [sn_ind_tmt_orm_order]
Fête connexe	Liste des contacts pour la demande de qualification. Chaque contact est un objet dans le tableau. Type de données : tableau d’objets `"relatedParty": [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ]`
relatedParty.id	Sys_id ou external_id du compte, du contact client ou du consommateur associé à la commande. Type de données : chaîne Table : table Compte [customer_account], table Contact [customer_contact] ou Consommateur [csm_consumer]
relatedParty.name	Nom du compte, du client ou du consommateur. Type de données : chaîne
relatedParty.@type	Fait partie de la norme d’API ouverte TMF. 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 liée. Valeurs possibles : Consommateur Client Contact client Type de données : chaîne
serviceQualificationItem	Liste des éléments de qualification de service contenant des informations sur l’emplacement, des informations de service et les caractéristiques de 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": {Object}, "@type": "String" } ]`
serviceQualificationItem.id	ID de l’élément de qualification. Type de données : chaîne Stocké dans : Le champ external_id de l’élément de ligne de commande client dans la table Élément de ligne de commande [sn_ind_tmt_orm_order_line_item].
serviceQualificationItem.qualificationResult	Résultat de l’élément de qualification. Stocké dans le champ « résultat » de l’élément de ligne de commande client. Valeurs possibles : alterner Aucun En attente qualifié inconditionnel Type de données : chaîne Table : élément de ligne de commande [sn_ind_tmt_orm_order_line_item]
serviceQualificationItem.state	État de l’élément de qualification dérivé du champ « statut » de l’élément de ligne de commande client. Type de données : chaîne Table : élément de ligne de commande [sn_ind_tmt_orm_order_line_item]
serviceQualificationItem.quantity	Quantité de l’élément de qualification dérivée du champ « quantité » de l’élément de ligne de commande client. Type de données : nombre Table :Élément de ligne de commande [sn_ind_tmt_orm_order_line_item]
serviceQualificationItem.@type	Fait partie de la norme d’API ouverte TMF. 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, notamment des détails sur l’emplacement (lieu), les spécifications et les caractéristiques du service. Type de données : objet `"service": { "@type": "String", "place": [Array], "serviceCharacteristic": [Array], "serviceSpecification": {Object} }`
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
serviceQualificationItem.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": "String", "name": "String", "@referredType": "String" } ]`
serviceQualificationItem.service.place.id	Sys_id de l’emplacement. Type de données : chaîne Table : Emplacement [cmn_location]
serviceQualificationItem.service.place.name	Nom de l'emplacement. Non vérifié par rapport à une entrée dans la table Emplacement [cmn_location]. Type de données : chaîne
serviceQualificationItem.service.place.@type	Fait partie de la norme d’API ouverte TMF. 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 de la spécification 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 d’API ouverte TMF. Annotation pour la spécification 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": "String", "value": "String", "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
ServiceQualificationItem.alternateServiceProposal	Proposition de service alternatif pour l’ordre de qualification. Type de données : chaîne Stockée dans : Proposition alternative [sn_ord_qual_mgmt_alternate_proposal]
ServiceQualificationItem.alternateServiceProposal.id	Sys_id de l’enregistrement de la proposition alternative. Type de données : chaîne Tableau : Proposition alternative [sn_ord_qual_mgmt_alternate_proposal]
ServiceQualificationItem.alternateServiceProposal.alternateServiceAvailabilityDate	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 du service de la proposition alternative a persisté dans la spécification. Type de données : objet Tableau : Proposition alternative [sn_ord_qual_mgmt_alternate_proposal]
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
Élément de qualification de service. alternateServiceProposal.alternateService.serviceSpecification.@type	Fait partie de la norme d’API ouverte TMF. Annotation pour la spécification de service. Cette valeur est toujours `ServiceSpecification`. Ces informations ne sont pas stockées. Type de données : chaîne
serviceQualificationItem. alternateServiceProposal.alternateService.serviceCharacteristics	Liste des caractéristiques de service pour la proposition de service de remplacement. Type de données : tableau d’objets `"serviceCharacteristic": [ { "name": "String", "value": "String", "valueType": "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. AlternativeServiceProposal.alternateService.serviceCharacteristic.value	Valeur de la caractéristique de service alternatif. Type de données : chaîne
serviceQualificationItem.eligibilityUnavailabilityReason	Liste des motifs d’indisponibilité d’éligibilité au service pour expliquer pourquoi le service n’est pas disponible. Type de données : tableau Stocké dans : Le champ unavailability_reason de la table Commande de domaine [sn_ind_tmt_orm_domain_order].
serviceQualificationItem.eligibilityUnavailabilityReason.code	Code du 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é au 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"
}
]

API ouverte de qualification du service technique : 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 client avec le type d’exécution qualifié. Chaque élément de qualification est conservé en tant qu’ordre 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 :

Demandez la qualification d’un service à une adresse spécifiée.
Demandez la qualification d’un nouveau service au même emplacement qu’un service d’accès existant et actif.
Demandez la mise à niveau ou le passage à une version antérieure 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. Les détails de 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 fournir 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 d’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 les détails de l’emplacement. Vous pouvez éventuellement définir des caractéristiques de service supplémentaires dans votre demande.
Pour mettre à niveau ou passer à une version antérieure d’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 toutes les caractéristiques de service que vous souhaitez modifier.
Par exemple, supposons que vous souhaitiez vérifier que vous pouvez mettre à niveau la vitesse de téléchargement d’un service actif existant de 100 Mb/s à 600 Mb/s. Dans ce cas, vous pouvez utiliser le serviceInventory paramètre pour définir la demande en changeant la caractéristique 'Vitesse' de 'Faible' à 'Élevée'. L’API obtient les caractéristiques restantes du service existant.

Pour comprendre comment former votre demande API selon votre cas d’utilisation particulier, reportez-vous aux exemples d’appels fournis dans la section Exemple de cette page.

Format d'URL

URL par défaut : /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
@type	Facultatif. Fait partie de la norme d’API ouverte TMF. Annotation pour la qualification. Cette valeur est toujours `CheckServiceQualification`. Ces informations ne sont pas stockées. Type de données : chaîne
checkServiceQualificationDate	Facultatif. Date et heure de création de la demande de qualification. Situé dans le champ order_date de la table Commande client [sn_ind_tmt_orm_order]. Si cette option n’est pas spécifiée, order_date est définie sur la date et l’heure actuelles. Type de données : chaîne Format : AAAA-MM-JJTHH :MM :SS. SSSZ
description	Facultatif. Description de la demande de qualification. Situé dans le champ « short_description » de la table Commande client [sn_ind_tmt_orm_order]. Type de données : chaîne Longueur maximale : 100
effectiveQualificationDate	Facultatif. Date à laquelle la qualification prend effet. A persisté dans le champ « actual_end_date » de la commande client de la table Commande client [sn_ind_tmt_orm_order]. Type de données : chaîne Format : AAAA-MM-JJTHH :MM :SS. SSSZ
expectedQualificationDate	Facultatif. Date de qualification attendue. A persisté dans le champ expected_end_date' de la commande client. Situé dans la table Commande de clients [sn_ind_tmt_orm_order]. Type de données : chaîne Format : AAAA-MM-JJTHH :MM :SS. SSSZ
externalId	Facultatif. ID externe affecté de la commande client. A été conservé dans le champ external_id de la commande client de la table Commande client [sn_ind_tmt_orm_order]. Type de données : chaîne
Fête connexe	Liste des contacts pour la demande de qualification. Chaque contact est un objet dans le tableau. Doit répertorier au moins un élément qui contient des informations de compte client, de contact client ou de compte de consommateur. Type de données : tableau d’objets `"relatedParty": [ { "@referredType": "String", "@type": "String", "id": "String", "name": "String" } ]`
relatedParty.@referredType	Type de partie liée. Valeurs possibles : consommateur customer contact client Type de données : chaîne
relatedParty.@type	Facultatif. Fait partie de la norme d’API ouverte TMF. 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.id	Le sys_id ou le external_id, le cas échéant, de l’apparenté. Situé 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
serviceQualificationItem	Liste des éléments de qualification de service avec emplacement, informations de service et 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": [{ "@type": "String", "id": "String", "qualificationResult": "String", "quantity": "Number", "service": {Object}, "state": "String" ]`
serviceQualificationItem.@type	Facultatif. Fait partie de la norme d’API ouverte TMF. 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.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": [ { "id": "String" "relationshipType": "String" } ]`
serviceQualificationItem.qualificationItemRelationship.id	Requis. ID de l’élément de qualification cible dans la relation. Type de données : chaîne
serviceQualificationItem.qualificationItemRelationship.relationshipType	Requis. Type de relation d’élément de ligne. Valeurs valides : HasChild : indique l’élément enfant. HasParent : indique l’élément parent. Type de données : chaîne
serviceQualificationItem.quantity	Facultatif. Quantité de l’élément de qualification. A persisté dans le champ « quantité » de l’élément de ligne de commande client. Type de données : nombre Par défaut si non spécifié : 1
serviceQualificationItem.service	Requis. Informations sur le service qui peuvent inclure des variables telles que le lieu, les spécifications du service et les caractéristiques du service. Type de données : objet `"service": { "@type": "String", "place": [Array], "serviceCharacteristic": [Array], "serviceSpecification": {Object} }`
serviceQualificationItem.service.@type	Facultatif. Fait partie de la norme d’API ouverte TMF. Annotation pour les informations de service pour l’é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	Facultatif. Les informations sur l’emplacement demandé pour l’élément de qualification de service. Situé dans la table Emplacement [cmn_location]. Remarque : Même si le tableau est pris en charge, il ne doit contenir qu’un seul emplacement. Type de données : tableau d’objets `"place": [ { "@type": "String" "id": "String", "name": "String" } ]`
serviceQualificationItem.service.place.@type	Facultatif. Fait partie de la norme d’API ouverte TMF. Annotation pour le service. Cette valeur est toujours `GeographicSite`. Ces informations ne sont pas stockées. Type de données : chaîne
serviceQualificationItem.service.place.id	Requis. Sys_id d’un emplacement dans la table Emplacement [cmn_location]. Cet ID d’emplacement doit être une entrée valide dans la table Emplacement [cmn_location]. Type de données : chaîne
serviceQualificationItem.service.place.name	Facultatif. Nom de l'emplacement. Cette valeur n’est pas vérifiée par rapport aux entrées de la table Emplacement [cmn_location]. Type de données : chaîne
serviceQualificationItem.service.referenceServiceInventory	Requis. Entité d’inventaire des services valide qui fait référence à un service actif pour l’emplacement requis. Les informations sur l’emplacement de l’ordre de qualification sont obtenues à partir de l’emplacement de cet inventaire des services. Important : Utilisez l’objet referenceServiceInventory pour qualifier un nouveau service au même emplacement d’un service d’accès existant et actif. Pour ce faire, vous devez également omettre le tableau et serviceInventory l’objet place de votre demande, sinon l’API renvoie une erreur. Type de données : objet `"referenceServiceInventory": { "id": "String" }`
serviceQualificationItem.service.referenceServiceInventory.id	Requis en cas d’utilisation serviceQualificationItem.service.referenceServiceInventory dans la demande. Le 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. Type de données : chaîne
serviceQualificationItem.service.serviceCharacteristics	Facultatif. Tableau des caractéristiques de service. Type de données : tableau d’objets `"serviceCharacteristic": [ { "name": "String", "value": "String", "valueType": "String", } ]`
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 d’API ouverte TMF. 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.serviceCharacteristic.valueType	Facultatif. Type de valeur de la caractéristique. Type de données : chaîne
serviceQualificationItem.service.serviceInventory	Facultatif. 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 pour les serviceInventory mises à niveau ou les versions antérieures de service. 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": "String" }`
serviceQualificationItem.service.serviceSpecification	Requis. Spécification de service pour l’élément de qualification. Stockée dans le champ service_specification de l’élément de ligne de commande client dans la table Élément de ligne de commande [sn_ind_tmt_orm_order_line_item]. Les spécifications de service d’un élément de qualification ne peuvent pas être orientées ressources. Type de données : objet `"serviceSpecification": { “@type”: ”String”, "id": "String", "name": "String" }`
serviceQualificationItem.service.serviceSpecification.@type	Facultatif. Fait partie de la norme d’API ouverte TMF. Annotation de la spécification de service. Cette valeur est toujours `ServiceSpecification`. Ces informations ne sont pas stockées. Type de données : chaîne
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.internalVersion	Facultatif. Version interne de la spécification de service. Type de données : nombre
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

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
Content-Type	Format de données du corps de la demande. 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 la 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 d’option des caractéristiques, le point de terminaison stocke les commentaires suivants dans les champs de notes de travail de l’enregistrement d’élément de ligne de commande client associé, comme pour les commandes de livraison existantes
400	Demande incorrecte. 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 un lieu, 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 du corps de la 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. Type de données : chaîne Table : Commande de clients [sn_ind_tmt_orm_order]
href	Lien relatif vers l’enregistrement de l’ordre de qualification. Type de données : chaîne
description	Description de la demande de qualification extraite du champ short_description de la commande de client. Type de données : chaîne Table : Commande de clients [sn_ind_tmt_orm_order]
externalId	ID externe de la commande de client. Type de données : chaîne Table : dans le champ external_id de la table Commande client [sn_ind_tmt_orm_order].
Résultat de qualification	Statut de qualification du champ de résultat de la commande de client. Valeurs possibles : alterner Aucun En attente qualifié inconditionnel Type de données : chaîne
État	État de la commande de client à partir du champ d’état de la commande de client. Type de données : chaîne
@type	Fait partie de la norme d’API ouverte TMF. Annotation pour la qualification. Cette valeur est toujours `CheckServiceQualification`. Ces informations ne sont pas stockées. Type de données : chaîne
checkServiceQualificationDate	Date et heure de création de la demande de qualification à partir du champ order_date de la commande de client. Type de données : chaîne Format : AAAA-MM-JJTHH :MM :SS. SSSZ Table : Commande de clients [sn_ind_tmt_orm_order]
effectiveQualificationDate	Date de qualification effective extraite du champ order_date de la commande de client. Type de données : chaîne Format : AAAA-MM-JJTHH :MM :SS. SSSZ Table : Commande de clients [sn_ind_tmt_orm_order]
expectedQualificationDate	Stocke la date de qualification attendue. A persisté dans expected_end_date champ de la commande client. Type de données : chaîne Format : AAAA-MM-JJTHH :MM :SS. SSSZ Table : Commande de clients [sn_ind_tmt_orm_order]
Fête connexe	Liste des contacts pour la demande de qualification. Chaque contact est un objet dans le tableau. Type de données : tableau d’objets `"relatedParty": [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ]`
relatedParty.id	Sys_id ou external_id du compte, du contact client ou du consommateur associé à la commande. Type de données : chaîne Table : table Compte [customer_account], table Contact [customer_contact] ou Consommateur [csm_consumer]
relatedParty.name	Nom du compte, du client ou du consommateur. Type de données : chaîne
relatedParty.@type	Fait partie de la norme d’API ouverte TMF. 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 liée. Valeurs possibles : Consommateur Client Contact client Type de données : chaîne
serviceQualificationItem	Liste des éléments de qualification de service contenant des informations sur l’emplacement, des informations de service et les caractéristiques de 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": {Object}, "@type": "String" } ]`
serviceQualificationItem.id	ID de l’élément de qualification. Type de données : chaîne Stocké dans : Le champ external_id de l’élément de ligne de commande client dans la table Élément de ligne de commande [sn_ind_tmt_orm_order_line_item].
serviceQualificationItem.qualificationResult	Résultat de l’élément de qualification. Stocké dans le champ « résultat » de l’élément de ligne de commande client. Valeurs possibles : alterner Aucun En attente qualifié inconditionnel Type de données : chaîne Table : élément de ligne de commande [sn_ind_tmt_orm_order_line_item]
serviceQualificationItem.state	État de l’élément de qualification dérivé du champ « statut » de l’élément de ligne de commande client. Type de données : chaîne Table : élément de ligne de commande [sn_ind_tmt_orm_order_line_item]
serviceQualificationItem.quantity	Quantité de l’élément de qualification dérivée du champ « quantité » de l’élément de ligne de commande client. Type de données : nombre Table :Élément de ligne de commande [sn_ind_tmt_orm_order_line_item]
serviceQualificationItem.@type	Fait partie de la norme d’API ouverte TMF. 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, notamment des détails sur l’emplacement (lieu), les spécifications et les caractéristiques du service. Type de données : objet `"service": { "@type": "String", "place": [Array], "serviceCharacteristic": [Array], "serviceSpecification": {Object} }`
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
serviceQualificationItem.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": "String", "name": "String", "@referredType": "String" } ]`
serviceQualificationItem.service.place.id	Sys_id de l’emplacement. Type de données : chaîne Table : Emplacement [cmn_location]
serviceQualificationItem.service.place.name	Nom de l'emplacement. Non vérifié par rapport à une entrée dans la table Emplacement [cmn_location]. Type de données : chaîne
serviceQualificationItem.service.place.@type	Fait partie de la norme d’API ouverte TMF. 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 de la spécification 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 d’API ouverte TMF. Annotation pour la spécification 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": "String", "value": "String", "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

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 pour obtenir l’emplacement du client avec un service existant.

Remarque :

Inventaire des services de référence avec ID = est un inventaire de produits avec 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 à partir de referenceServiceInventory laquelle place est renseigné 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 plus élevée. L’inventaire des services avec l’ID = est un inventaire des produits avec la spécification du service = « Service à large bande », Emplacement = 20220 Bow Willow, Houston, TX, Caractéristiques=[{Vitesse :Moyenne}].

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

API ouverte de qualification du service technique : POST sn_ord_qual_mgmt/qualification/checkServiceQualification/processResult

Traite un résultat de qualification de service technique envoyé à l’API ouverte de qualification de service technique .

Format d'URL

URL par défaut : /api/sn_ord_qual_mgmt/qualification/checkServiceQualification/processResult

Paramètres de demande pris en charge

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

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

Tableau 22. Paramètres de corps de demande (XML ou JSON)
Paramètre	Description
serviceQualificationItem	Requis. Liste des éléments de qualification de service, chacun représentant une commande de domaine dans la table Commande de service [sn_ind_tmt_orm_service_order] pour l’élément de ligne de commande principale demandé. Toutes les commandes de domaine représentées par chacun des éléments de qualification de service doivent appartenir à la même ligne de commande principale. Type de données : tableau d’objets `"serviceQualificationItem": [ { "@type": "String", "alternateServiceProposal": [Array], "id": "String", "qualificationResult": "String" } ]`
serviceQualificationItem.@type	Facultatif. Fait partie de la norme d’API ouverte TMF. 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.alternateProposal	Propositions alternatives fournies pour l’élément de qualification. Type de données : tableau d’objets `"alternateServiceProposal": [ { "@type": "String", "alternateService": {Object}, "alternateServiceAvailabilityDate": "Number", "id": "String", "serviceCharacteristic": [Array] } ]` Stockée dans : Proposition alternative [sn_ord_qual_mgmt_alternate_proposal]
serviceQualificationItem.alternateProposal.@type	Fait partie de la norme d’API ouverte TMF. Annotation pour les informations de service pour l’élément de qualification. Cette valeur est toujours `Service`. Ces informations ne sont pas stockées. Type de données : chaîne
serviceQualificationItem.alternateProposal.alternateService	Requis. Informations sur le service pour la proposition alternative contenant des spécifications et des caractéristiques de service. Type de données : objet `"alternateService": { "@type": "String", "serviceSpecification": {Object}, "serviceCharacteristic": [Array] }`
serviceQualificationItem.alternateProposal.alternateService.alternateService.serviceCharacteristic.valueType	Type de valeur de la caractéristique sous la proposition de service alternative. Type de données : chaîne
serviceQualificationItem.alternateProposal.alternateService.serviceCharacteristics	Caractéristiques de service pour la proposition de service alternative. Type de données : tableau d’objets `"serviceCharacteristic": [ { "name": "String", "value": "String", "valueType": "String" } ]` Stocké dans : Le champ order_characteristics de la table Proposition alternative [sn_ord_qual_mgmt_alternate_proposal].
serviceQualificationItem.alternateProposal.alternateService.serviceCharacteristic.name	Requis. Nom de la caractéristique appartenant à la proposition de service alternatif. Type de données : chaîne
serviceQualificationItem.alternateProposal.alternateService.serviceCharacteristic.value	Valeur de la caractéristique appartenant à la proposition de service alternatif. Type de données : chaîne
serviceQualificationItem.alternateProposal.alternateService.serviceCharacteristic.valueType	Type de caractéristique. Type de données : chaîne
serviceQualificationItem.alternateProposal.alternateService .serviceSpecification	Requis. Spécification de service pour la proposition alternative. Type de données : objet `"serviceSpecification": { “@type”: ”String” "id": "String", "name": "String" }` Stocké dans : Le champ de spécification de l’entrée de proposition alternative de la table Proposition alternative [sn_ord_qual_mgmt_alternate_proposal].
serviceQualificationItem.alternateProposal.alternateService .serviceSpecification.@type	Fait partie de la norme d’API ouverte TMF. Annotation de la spécification de service. Cette valeur est toujours `ServiceSpecification`. Ces informations ne sont pas stockées. Type de données : chaîne
serviceQualificationItem.alternateProposal.alternateService.serviceSpecification.id	Requis. ID externe ou version initiale de la spécification de service. Type de données : chaîne
serviceQualificationItem.alternateProposal.alternateService.serviceSpecification.internalVersion	Version interne de la spécification de service. Type de données : chaîne
serviceQualificationItem.alternateProposal.alternateService.serviceSpecification.name	Nom de la spécification de service. Type de données : chaîne
serviceQualificationItem.alternateProposal.alternateService.serviceSpecification.version	Version externe de la spécification de service. Type de données : chaîne
serviceQualificationItem.alternateProposal.alternateServiceAvailabilityDate	Autre date de disponibilité du service. Type de données : chaîne Format : AAAA-MM-JJTHH :MM :SS. SSSZ Tableau : dans le champ available_date de la table Proposition alternative [sn_ord_qual_mgmt_alternate_proposal], où les informations d’ordre de domaine appartiennent à l’ordre de domaine représenté par l’élément de qualification de service en cours.
serviceQualificationItem.alternateProposal.id	ID défini par l’utilisateur pour la proposition alternative. Ces données ne sont pas conservées. Type de données : chaîne
serviceQualificationItem.eligibilityUnavailabilityReason	Motif pour lequel la qualification de service n’est pas éligible. Type de données : objet `"eligibilityUnavailabilityReason": [ { "code": "String", "label": "String" } ]` Stocké dans : La liste complète des motifs est conservée avec leurs champs d’étiquette sous forme de chaîne dans le champ unavailability_reason de la table Ordre de domaine [sn_ind_tmt_orm_domain_order].
serviceQualificationItem.eligibilityUnavailabilityReason.code	Code pour le motif d’indisponibilité de l’éligibilité. Ces informations ne sont pas conservées. Type de données : chaîne
serviceQualificationItem.eligibilityUnavailabilityReason.label	Requis. Étiquette indiquant le motif d’indisponibilité et d’éligibilité. S’il existe plusieurs motifs d’inéligibilité, les étiquettes sont séparées par une virgule. Type de données : chaîne Stocké dans : Le champ unavailability_reason de la table Commande de domaine [sn_ind_tmt_orm_domain_order].
serviceQualificationItem.id	Requis. Sys_id de l’ordre de domaine représenté par l’élément de qualification. Type de données : chaîne Stockée dans : Sys_id champ de la table Commande de domaine [sn_ind_tmt_orm_service_order].
serviceQualificationItem.qualificationResult	Requis. Résultat de qualification pour chaque élément de qualification de service. Type de données : chaîne Stocké dans : Le champ de résultat de la table Commande de domaine [sn_ind_tmt_orm_service_order].

En-têtes

Tableau 23. 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 24. 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 la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

Tableau 25. Codes d'état
Code d'état	Description
201	Réussi. La demande a été correctement traitée.
400	Demande incorrecte. Peut être l’une des raisons suivantes : Charge utile non valide : le résultat de qualification doit être l’un des suivants : [alternatif, en attente, qualifié, non qualifié]. Charge utile non valide : l’ID d’élément de qualification n’existe pas. Tous les éléments de qualification doivent appartenir au même élément de ligne de commande principale. Charge utile non valide : serviceQualificationItem qualificationResult est manquant. Charge utile non valide : le consommateur n’existe pas.

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


Nom	Description
id	Sys_id de la commande de client de qualification. Type de données : chaîne Table : Commande de clients [sn_ind_tmt_orm_order]
href	Lien relatif vers l’enregistrement de l’ordre de qualification. Type de données : chaîne
description	Description de la demande de qualification extraite du champ short_description de la commande de client. Type de données : chaîne Table : Commande de clients [sn_ind_tmt_orm_order]
externalId	ID externe de la commande de client. Type de données : chaîne Table : dans le champ external_id de la table Commande client [sn_ind_tmt_orm_order].
Résultat de qualification	Statut de qualification du champ de résultat de la commande de client. Valeurs possibles : alterner Aucun En attente qualifié inconditionnel Type de données : chaîne
État	État de la commande de client à partir du champ d’état de la commande de client. Type de données : chaîne
@type	Fait partie de la norme d’API ouverte TMF. Annotation pour la qualification. Cette valeur est toujours `CheckServiceQualification`. Ces informations ne sont pas stockées. Type de données : chaîne
checkServiceQualificationDate	Date et heure de création de la demande de qualification à partir du champ order_date de la commande de client. Type de données : chaîne Format : AAAA-MM-JJTHH :MM :SS. SSSZ Table : Commande de clients [sn_ind_tmt_orm_order]
effectiveQualificationDate	Date de qualification effective extraite du champ order_date de la commande de client. Type de données : chaîne Format : AAAA-MM-JJTHH :MM :SS. SSSZ Table : Commande de clients [sn_ind_tmt_orm_order]
expectedQualificationDate	Stocke la date de qualification attendue. A persisté dans expected_end_date champ de la commande client. Type de données : chaîne Format : AAAA-MM-JJTHH :MM :SS. SSSZ Table : Commande de clients [sn_ind_tmt_orm_order]
Fête connexe	Liste des contacts pour la demande de qualification. Chaque contact est un objet dans le tableau. Type de données : tableau d’objets `"relatedParty": [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ]`
relatedParty.id	Sys_id ou external_id du compte, du contact client ou du consommateur associé à la commande. Type de données : chaîne Table : table Compte [customer_account], table Contact [customer_contact] ou Consommateur [csm_consumer]
relatedParty.name	Nom du compte, du client ou du consommateur. Type de données : chaîne
relatedParty.@type	Fait partie de la norme d’API ouverte TMF. 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 liée. Valeurs possibles : Consommateur Client Contact client Type de données : chaîne
serviceQualificationItem	Liste des éléments de qualification de service contenant des informations sur l’emplacement, des informations de service et les caractéristiques de 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": {Object}, "@type": "String" } ]`
serviceQualificationItem.id	ID de l’élément de qualification. Type de données : chaîne Stocké dans : Le champ external_id de l’élément de ligne de commande client dans la table Élément de ligne de commande [sn_ind_tmt_orm_order_line_item].
serviceQualificationItem.qualificationResult	Résultat de l’élément de qualification. Stocké dans le champ « résultat » de l’élément de ligne de commande client. Valeurs possibles : alterner Aucun En attente qualifié inconditionnel Type de données : chaîne Table : élément de ligne de commande [sn_ind_tmt_orm_order_line_item]
serviceQualificationItem.state	État de l’élément de qualification dérivé du champ « statut » de l’élément de ligne de commande client. Type de données : chaîne Table : élément de ligne de commande [sn_ind_tmt_orm_order_line_item]
serviceQualificationItem.quantity	Quantité de l’élément de qualification dérivée du champ « quantité » de l’élément de ligne de commande client. Type de données : nombre Table :Élément de ligne de commande [sn_ind_tmt_orm_order_line_item]
serviceQualificationItem.@type	Fait partie de la norme d’API ouverte TMF. 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, notamment des détails sur l’emplacement (lieu), les spécifications et les caractéristiques du service. Type de données : objet `"service": { "@type": "String", "place": [Array], "serviceCharacteristic": [Array], "serviceSpecification": {Object} }`
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
serviceQualificationItem.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": "String", "name": "String", "@referredType": "String" } ]`
serviceQualificationItem.service.place.id	Sys_id de l’emplacement. Type de données : chaîne Table : Emplacement [cmn_location]
serviceQualificationItem.service.place.name	Nom de l'emplacement. Non vérifié par rapport à une entrée dans la table Emplacement [cmn_location]. Type de données : chaîne
serviceQualificationItem.service.place.@type	Fait partie de la norme d’API ouverte TMF. 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 de la spécification 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 d’API ouverte TMF. Annotation pour la spécification 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": "String", "value": "String", "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
ServiceQualificationItem.alternateServiceProposal	Proposition de service alternatif pour l’ordre de qualification. Type de données : chaîne Stockée dans : Proposition alternative [sn_ord_qual_mgmt_alternate_proposal]
ServiceQualificationItem.alternateServiceProposal.id	Sys_id de l’enregistrement de la proposition alternative. Type de données : chaîne Tableau : Proposition alternative [sn_ord_qual_mgmt_alternate_proposal]
ServiceQualificationItem.alternateServiceProposal.alternateServiceAvailabilityDate	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 du service de la proposition alternative a persisté dans la spécification. Type de données : objet Tableau : Proposition alternative [sn_ord_qual_mgmt_alternate_proposal]
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
Élément de qualification de service. alternateServiceProposal.alternateService.serviceSpecification.@type	Fait partie de la norme d’API ouverte TMF. Annotation pour la spécification de service. Cette valeur est toujours `ServiceSpecification`. Ces informations ne sont pas stockées. Type de données : chaîne
serviceQualificationItem. alternateServiceProposal.alternateService.serviceCharacteristics	Liste des caractéristiques de service pour la proposition de service de remplacement. Type de données : tableau d’objets `"serviceCharacteristic": [ { "name": "String", "value": "String", "valueType": "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. AlternativeServiceProposal.alternateService.serviceCharacteristic.value	Valeur de la caractéristique de service alternatif. Type de données : chaîne
serviceQualificationItem.eligibilityUnavailabilityReason	Liste des motifs d’indisponibilité d’éligibilité au service pour expliquer pourquoi le service n’est pas disponible. Type de données : tableau Stocké dans : Le champ unavailability_reason de la table Commande de domaine [sn_ind_tmt_orm_domain_order].
serviceQualificationItem.eligibilityUnavailabilityReason.code	Code du 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é au service. Type de données : chaîne

Exemple de demande cURL

L’exemple suivant montre comment le point de terminaison traite une commande de qualification envoyée dans la demande d’API.

curl -X POST "https://instance.service-now.com/api/sn_ord_qual_mgmt/qualification/checkServiceQualification/processResult " \ 
-H "Accept: application/json" \ 
-H "Content-Type: application/json" \ 
-u "username":"password" \ 
-d {
  "serviceQualificationItem": [
    {
      "eligibilityUnavailabilityReason": [
        {
          "code": "26-001",
          "label": "not enough bandwith at this place"
        }
      ],
      "qualificationResult": "alternate",
      "alternateServiceProposal": [
        {
          "alternateServiceAvailabilityDate": "2022-12-15T19:20:39.239Z",
          "@type": "AlternateServiceProposal",
          "id": "1",
          "alternateService": {
            "@type": "Service",
            "serviceSpecification": {
              "@type": "ServiceSpecification",
              "name": "Mobile Service",
              "id": "23",
              "href": "string"
            },
            "serviceCharacteristic": [
              {
                "@type": "ServiceCharacteristic",
                "valueType": "string",
                "name": "BroadcastQuality",
                "id": "1",
                "value": "HD"
              }
            ]
          }
        }
      ],
      "@type": "ServiceQualificationItem",
      "id": "295580b938bf1110f877c8d44c4b8912"
    },
    {
      "qualificationResult": "alternate",
      "alternateServiceProposal": [
        {
          "alternateServiceAvailabilityDate": "2022-12-15T19:20:39.239Z",
          "@type": "AlternateServiceProposal",
          "id": "1",
          "alternateService": {
            "@type": "Service",
            "serviceSpecification": {
              "@type": "ServiceSpecification",
              "name": "Mobile Service",
              "id": "23",
              "href": "string"
            },
            "serviceCharacteristic": [
              {
                "@type": "ServiceCharacteristic",
                "valueType": "string",
                "name": "BroadcastQuality",
                "id": "1",
                "value": "HD"
              }
            ]
          }
        }
      ],
      "@type": "ServiceQualificationItem",
      "action": "add",
      "id": "295580b938bf1110f877c8d44c4b8915"
    },
    {
      "qualificationResult": "alternate",
      "alternateServiceProposal": [
        {
          "alternateServiceAvailabilityDate": "2022-12-15T19:20:39.239Z",
          "@type": "AlternateServiceProposal",
          "id": "1",
          "alternateService": {
            "@type": "Service",
            "serviceSpecification": {
              "@type": "ServiceSpecification",
              "name": "Mobile Service",
              "id": "23",
              "href": "string"
            },
            "serviceCharacteristic": [
              {
                "@type": "ServiceCharacteristic",
                "valueType": "string",
                "name": "BroadcastQuality",
                "id": "1",
                "value": "HD"
              }
            ]
          }
        }
      ],
      "@type": "ServiceQualificationItem",
      "id": "2d5580b938bf1110f877c8d44c4b8902"
    }
  ],
  "@type": "CheckServiceQualification",
  "description": "check service qualification illustration"
}

Corps de la réponse :

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