API ouverte de commande de service

Rversion finale: Yokohama

Mis à jour 30 janv. 2025

72 minutes de lecture

L’API ouverte de commande de service fournit un point de terminaison qui active un mécanisme standardisé pour passer des commandes de service.

Cette API est une ServiceNow® implémentation de la spécification API Open API TMForum TMF641 Service Ordering Management.

Logo de conformité TMF

Pour accéder à cette API, le (sn_ind_tmt_orm) module d’extension Order Management for Telecommunications doit être activé. Pour plus d'informations, consultez Install Order Management . Pour plus d’informations sur les tables, les Gestion des commandes entités et les relations, reportez-vous à la section Order Management data model.

Cette API est fournie dans l’espace de noms sn_tmf_api .

L’utilisateur appelant doit avoir le rôle sn_ind_tmt_orm.order_integrator.

Cette API peut être étendue pour effectuer des personnalisations autour des paramètres requis, de la validation du corps de la demande, des opérations REST supplémentaires et des mappages de champs. Pour plus d'informations, voir le Service Order Open API Developer Guide du développeur

API ouverte de commande de service – GET /sn_tmf_api/order/serviceOrder

Récupère toutes les commandes de services.

Cette API récupère les informations sur les commandes de services à partir des tables connexes suivantes :

Ordre [sn_ind_tmt_orm_order]
Valeur caractéristique de commande [sn_ind_tmt_orm_order_characteristic_value]
Élément de ligne de commande [sn_ind_tmt_orm_order_line_item]
Contact d’élément de ligne de commande [sn_ind_tmt_orm_order_line_item_contact]
Éléments liés à la ligne de commande [sn_ind_tmt_orm_order_line_related_items]

Format d'URL

/api/sn_tmf_api/order/serviceOrder

Paramètres de demande pris en charge

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

Tableau 2. Paramètres de requête
Nom	Description
champs	Liste des champs à renvoyer dans la réponse. Les champs non valides sont ignorés. Type de données : chaîne Par défaut : tous les champs renvoyés.
limite	Nombre maximal d'enregistrements à renvoyer. Pour les demandes qui dépassent ce nombre d’enregistrements, utilisez le paramètre pour paginer la offset récupération de l’enregistrement. Type de données : nombre Par défaut : 20 Maximum : 100
décalage	Index de début auquel commencer à récupérer les enregistrements. Utilisez cette valeur pour paginer la récupération des enregistrements. Cette fonctionnalité permet de récupérer tous les enregistrements, quel que soit le nombre d'enregistrements, par petits blocs gérables. Type de données : nombre Par défaut : 0
État	Filtrer les commandes 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 Par défaut : tous les états renvoyés.

Tableau 3. Paramètres du corps de la demande (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
Aucun

Tableau 5. En-têtes de réponses
En-tête	Description
Plage de contenu	Plage de contenu renvoyé lors d’un appel paginé. Par exemple, si `offset=2` and `limit=3`, la valeur de l’en-tête Content-Range est `les éléments 3 à 5`.
Type de contenu	Format de données du corps de la réponse. Prend uniquement en charge application/json.
un lien	Contient les liens suivants pour parcourir les résultats de la requête. premier dernier suivant previous
X-Total-Count	Pour les requêtes paginées, cet en-tête spécifie le nombre total d’enregistrements disponibles sur le serveur.

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
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	Enregistrement introuvable. Aucun enregistrement correspondant aux paramètres de requête n’a été trouvé dans la table.

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


Nom	Description
committedDueDate	Date et heure auxquelles l’action doit être effectuée sur la commande. Cette valeur doit être identique ou postérieure aux valeurs de chaque committedDueDate élément de ligne de bon de commande. Type de données : chaîne
expectedCompletionDate	Date à laquelle la commande doit être terminée. Type de données : chaîne
href	Lien relatif vers l’enregistrement de ressource. Type de données : chaîne Valeur par défaut : chaîne vide
id	Sys_id de la commande de service demandée. Type de données : chaîne
note	Liste des notes supplémentaires prises par le client lors de la commande. Type de données : tableau `"note": [ { "author": "String", "date": "String", "text": "String" } ]`
note.auteur	Nom d’utilisateur de la personne qui a rédigé la note associée. Type de données : chaîne
note.date	Date de création de la note. Type de données : chaîne
note.text	Notes/commentaires supplémentaires effectués par le client lors de la commande. Type de données : chaîne
orderDate	Date et horodatage de la commande. Format : JJ-MM-AAAA HH :MM :SS Type de données : chaîne Valeur par défaut : chaîne vide
PONR	Marqueur indiquant si le point de non-retour de la commande a été atteint. Valeurs valides : vrai : le point de non-retour de la commande a été atteint. La commande ne peut pas être modifiée ou annulée pendant que l’exécution est en cours. faux : le point de non-retour de la commande n’a pas été atteint. La commande peut être modifiée ou annulée. Type de données : booléennes
Fête connexe	Liste des contacts de la commande. 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. Situé dans la table Compte [customer_account], Contact [customer_contact] ou Consommateur [csm_consumer]. Type de données : chaîne
relatedParty.name	Nom du compte, du client ou du consommateur. Type de données : chaîne
relatedParty.@referredType	Type de client. Valeurs possibles : Consommateur Client Contact client 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
requestedCompletionDate	Date de livraison demandée par le client. Type de données : chaîne
requestedStartDate	Date de début de commande demandée par le client. Type de données : chaîne
élémentcommandeservice	Liste des éléments de ligne dans la commande de service et leur action associée. `"serviceOrderItem:" [ { "action": "String", "actionReason": "String", "committedDueDate": "String", "externalProductInventory": [Array], "id": "String", "orderRelationship": [Array], "quantity": "Number", "place": {Object}, "ponr": Boolean, "relatedParty": {Object}, "service": {Object}, "state": "String", "@type": "String", "version": "String" } ]` Type de données : tableau
serviceOrderItem.action	Action à effectuer sur l’élément de commande de service. Les actions possibles sont définies dans l’onglet Liste de choix dans le champ Entrée du dictionnaire d’action de la table sn_ind_tmt_orm_order_line_item. Pour plus de détails, voir Action types for customer and service orders. Type de données : chaîne
serviceItemOrder.actionReason	Motif de l’ajout de l’élément de ligne de bon de commande. Type de données : chaîne Stocké dans : Le champ action_reason de la table sn_ind_tmt_orm_order_line_item.
serviceOrderItem.committedDueDate	Date et heure auxquelles l’action doit être effectuée sur l’élément de ligne de bon de commande. Type de données : chaîne
serviceItemOrder.externalProductInventory	Liste des ID externes mappés aux inventaires de produits créés pour la commande. Type de données : tableau d’objets `"externalProductInventory": [ { "externalProductInventoryId": "String" } ]`
serviceOrderItem.externalProductInventory.externalProductInventoryId	ID externe mappé à l’inventaire de produits. Type de données : chaîne
serviceOrderItem.id	Identificateur unique de l’élément de ligne. Situé dans le champ sn_ind_tmt_orm_external_id de la table Élément de ligne de commande [sn_ind_tmt_orm_order_line_item]. Type de données : chaîne
serviceItemOrder.orderRelationship	Liste des relations entre les éléments de ligne de commande. Type de données : tableau `"orderRelationship:" [ { "id": "String", "relationshipType": "String" } ]`
serviceOrderItem.orderRelationship.id	Identificateur unique de l’élément de ligne connexe. Situé dans le champ sn_ind_tmt_orm_external_id de la table Élément de ligne de commande [sn_ind_tmt_orm_order_line_item]. Type de données : chaîne
serviceItemOrder.orderRelationship.relationshipType	Type de relation entre les deux éléments de ligne. Ces informations sont utilisées pour identifier la hiérarchie des relations. Valeurs possibles : HasChild HasParent Exige `HasChild` et `HasParent` sont utilisés pour les relations parent/enfant. `Exige` est utilisé pour les relations horizontales (un élément de ligne nécessite un autre élément de ligne). Type de données : chaîne
serviceItemOrder.quantity	Nombre d’éléments de ligne commandés. Type de données : nombre
serviceOrderItem.place	Carte des emplacements où installer le service. Type de données : objet `"place:" { "id": "String", "@type": "String" }`
serviceOrderItem.place.id	Sys_id de l’enregistrement de l’emplacement associé dans la table Emplacement [cmn_location]. Type de données : chaîne
serviceOrderItem.place.@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 `Lieu`. Ces informations ne sont pas stockées. Type de données : chaîne
serviceOrderItem.ponr	Marqueur indiquant si le point de non retour de l’élément de ligne de bon de commande a été atteint. Valeurs valides : vrai : le point de non retour pour l’élément de ligne de commande a été atteint. L’élément de ligne de commande ne peut pas être modifié ou annulé pendant que l’exécution est en cours. faux : le point de non retour pour l’élément de ligne de commande n’a pas été atteint. L’élément de ligne de commande peut être modifié ou annulé. Type de données : booléennes
serviceItemCommande.Partieconnexe	Liste de contacts pour les éléments de ligne. Type de données : tableau `"relatedParty:" [ { "email": "String", "firstName": "String" "id": "String", "lastName": "String", "phone": "String", "@referredType": "String", "@type": "String" } ]`
serviceOrderItem.relatedParty.email	Adresse e-mail du contact. Type de données : chaîne
serviceItemCommande.PartieConnexe.firstName	Prénom du contact. Type de données : chaîne
serviceOrderItem.relatedParty.id	Sys_id du contact de l’élément de ligne associé à l’élément de ligne de commande. Situé dans la table Contact de l’élément de ligne de commande [sn_ind_tmt_orm_order_line_item_contact]. Type de données : chaîne
serviceOrderItem.relatedParty.lastName	Nom de famille du contact. Type de données : chaîne
serviceOrderItem.relatedParty.phone	Numéro de téléphone professionnel du contact. Type de données : chaîne
serviceOrderItem.relatedParty.@referredType	Requis. Type de client. Valeur possible : OrderLineItemContact Type de données : chaîne
serviceOrderItem.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
serviceItemCommande.service	Description des détails d’instance du service acheté par le client. Type de données : objet `"service:" { "serviceCharacteristic": [Array], "serviceRelationship": [Array], "serviceSpecification": {Object}, "serviceType": "String", "state": "String", "@type": "String" }`
serviceItemCommande.service.serviceCaractéristique	Liste décrivant les caractéristiques du service associé. Seules les caractéristiques de service avec un courant value différent de celui previousValue sont renvoyées. Type de données : tableau d’objets `"serviceCharacteristic:" [ { "name": "String", "previousValue": "String", "value": "String", "valueType": "String" } ]`
serviceItemOrder.service.serviceCharacteristic.value	Valeurs des options de caractéristiques associées au service. Pour plus d’informations sur les valeurs des options de caractéristique, reportez-vous à la section Create product characteristics and characteristic options. Type de données : chaîne
serviceOrderItem.service.serviceCharacteristic.valueType	Type de valeur caractéristique. Type de données : chaîne
serviceOrderItem.service.serviceRelationship	Liste des inventaires de produits associés au service. Type de données : tableau d’objets `"serviceRelationship": [ { "id": "String", "relationshipType": "String" } ]`
serviceOrderItem.service.serviceRelationship.id	Sys_id ou sn_prd_invt_external_id de l’inventaire des produits. Type de données : chaîne Table : dans le champ sys_id ou sn_prd_invt_external_id de la table Inventaire des produits [sn_prd_invt_product_inventory].
serviceOrderItem.service.serviceRelationship.relationshipType	Type de relation entre le service et l’inventaire des produits. Valeur possible : nécessite Type de données : chaîne
serviceOrderItem.service.serviceSpecification	Description de la spécification de service associée au service. Type de données : objet `"serviceSpecification:" { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String", "@type": "String" }`
serviceOrderItem.service.serviceSpecification.id	Initial_version ou external_id de la spécification de service. Le initial_version est le sys_id de la première version de la spécification. Situé dans le champ sys_id ou external_id de la table des spécifications de service [sn_prd_pm_service_specification]. Type de données : chaîne
serviceOrderItem.service.serviceSpecification.internalId	Version initiale de la spécification de service. Type de données : chaîne Table : dans le champ sys_id de la table Spécification de service [sn_prd_pm_service_specification].
serviceItemCommande.service.serviceSpecification.internalVersion	Version de la spécification de service. Type de données : chaîne Table : Spécification de service [sn_prd_pm_service_specification]
serviceOrderItem.service.serviceSpecification.name	Nom de la spécification de service. Situé dans la table Spécification de service [sn_prd_pm_service_specification]. Type de données : chaîne
serviceCommandeÉlément.service.serviceSpécification.version	External_version de la spécification de service. Type de données : chaîne Table : Spécification de service [sn_prd_pm_service_specification]
serviceOrderItem.service.serviceSpecification.@type	Fait partie de la norme TMF Open API. Cette valeur est toujours `ServiceSpecificationRef`. Ces informations ne sont pas stockées. Type de données : chaîne
serviceItemOrder.service.serviceType	Type de service. Type de données : chaîne
serviceItemOrder.service.state	État du produit vendu. Par exemple, nouveau. Type de données : chaîne
serviceOrderItem.state	État de l’élément de la commande de service. Par exemple, nouveau. Type de données : chaîne
serviceOrderItem.version	Version de l’élément de ligne de la commande de service. Type de données : chaîne
serviceOrderItem.@type	Fait partie de la norme TMF Open API. Cette valeur est toujours `ServiceOrderItem`. Ces informations ne sont pas stockées. Type de données : chaîne
État	État de la commande de service. Pour plus d'informations, consultezService order states. Type de données : chaîne
@type	Fait partie de la norme TMF Open API. Cette valeur est toujours `ServiceOrder`. Ces informations ne sont pas stockées. Type de données : chaîne

Demande cURL

Cet exemple récupère toutes les commandes de services.

curl --location --request GET 'http://instance.service-now.com/api/sn_tmf_api/order/serviceOrder' \
--user 'username':'password'

Corps de la réponse.

[
    {
        "id": "bd30366ec3a83010abc8b5183c40dd92",
        "ponr": "true",
        "href": "/api/sn_tmf_api/order/serviceOrder/bd30366ec3a83010abc8b5183c40dd92",
        "completionDate": "2021-06-07T21:52:12.000Z",
        "expectedCompletionDate": "2018-01-14T20:07:40.000Z",
        "orderDate": "2021-06-08T05:34:59.000Z",
        "requestedCompletionDate": "2018-01-14T20:07:40.000Z",
        "requestedStartDate": "2018-01-14T20:07:40.000Z",
        "serviceOrderItem": [
            {
                "id": "100",
                "ponr": "true",
                "quantity": 1,
                "action": "add",
                "service": {
                    "@type": "Service",
                    "id": "4b5072aec3a83010abc8b5183c40dd42",
                    "state": "active",
                    "serviceType": "cfs",
                    "serviceCharacteristic": [
                        {
                            "name": "Firewall coverage",
                            "valueType": "choice",
                            "value": "Premium(Up to 50 sites)\n\t\t",
                            "previousValue": ""
                        },
                        {
                            "name": "Firewall Security",
                            "valueType": "choice",
                            "value": "Premium",
                            "previousValue": ""
                        },
                        {
                            "name": "CPE Type",
                            "valueType": "choice",
                            "value": "Physical",
                            "previousValue": ""
                        },
                        {
                            "name": "Administration Support",
                            "valueType": "choice",
                            "value": "Basic( Customer Managed)\n\t\t",
                            "previousValue": ""
                        }
                    ],
                    "serviceSpecification": {
                        "id": "f99546ff07266010a7955b7e0ad300a8",
                        "name": "Managed Firewall Service",
                        "version": "",
                        "internalVersion": "1",
                        "internalId": "f99546ff07266010a7955b7e0ad300a8",
                        "@type": "ServiceSpecificationRef"
                    }
                },
                "place": {
                    "id": "920cf6ac73d423002728660c4cf6a799",
                    "@type": "Place"
                },
                "state": "completed",
                "version": "2",
                "@type": "ServiceOrderItem"
            }
        ],
        "relatedParty": [
            {
                "id": "ffc68911c35420105252716b7d40dd55",
                "name": "Funco Intl",
                "@type": "RelatedParty",
                "@referredType": "Customer"
            },
            {
                "id": "eaf68911c35420105252716b7d40ddde",
                "name": "Sally Thomas",
                "@type": "RelatedParty",
                "@referredType": "CustomerContact"
            }
        ],
        "state": "completed",
        "version": "2",
        "@type": "ServiceOrder"
    }
]

API ouverte de commande de service – GET /sn_tmf_api/order/serviceOrder/{id}

Récupère une commande de service spécifiée.

Cette API récupère les informations sur les commandes de services à partir des tables connexes suivantes :

Ordre [sn_ind_tmt_orm_order]
Élément de ligne de commande [sn_ind_tmt_orm_order_line_item]
Valeur caractéristique de commande [sn_ind_tmt_orm_order_characteristic_value]
Contact d’élément de ligne de commande [sn_ind_tmt_orm_order_line_item_contact]
Éléments liés à la ligne de commande [sn_ind_tmt_orm_order_line_related_items]

Format d'URL

/api/sn_tmf_api/order/serviceOrder/{id}

Paramètres de demande pris en charge

Tableau 7. Paramètres de chemin d'accès
Nom	Description
id	Sys_id de la commande de service à récupérer. Type de données : chaîne Table : Ordre [sn_ind_tmt_orm_order]

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

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

En-têtes

Tableau 10. En-têtes de demandes
En-tête	Description
Néant

Tableau 11. En-têtes de réponses
En-tête	Description
Type de contenu	Format de données du corps de la réponse. Prend uniquement en charge application/json.

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). La réponse est retournée avec un message d’erreur si la commande sélectionnée présente des problèmes de traitement. Une réponse OK 200 se produit si la commande se trouve dans la table File d’attente entrante [sn_tmt_core_inbound_queue] en attente que le planificateur sélectionne l’enregistrement à traiter. Le champ de message d’erreur inclut les détails de l’enregistrement. Par exemple : `{ "code": 102, "reason": "Request in queue", "message": "Request in queue", "details": [ { "message": "This Order is still in the inbound queue table waiting to be processed.", "datapath": "" } ] }` Une réponse OK 200 se produit si la création d’une commande échoue et que l’enregistrement de la table File d’attente entrante [sn_tmt_core_inbound_queue] est dans un état d’erreur. Le champ de message d’erreur inclut les détails de l’enregistrement de table de file d’attente entrante. Par exemple : `{ "code": 23, "reason": "Missing body field", "message": "Missing body field", "details": [ { "message": "Invalid payload: orderCurrency is missing", "datapath": "/" } ] }`
400	Demande incorrecte. Raisons possibles : Paramètre de requête manquant URI non valide
404	Introuvable. L’élément demandé est introuvable.

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


Nom	Description
committedDueDate	Date et heure auxquelles l’action doit être effectuée sur la commande. Cette valeur doit être identique ou postérieure aux valeurs de chaque committedDueDate élément de ligne de bon de commande. Type de données : chaîne
expectedCompletionDate	Date à laquelle la commande doit être terminée. Type de données : chaîne
id	Sys_id de la commande de service demandée. Type de données : chaîne
href	Lien relatif vers l’enregistrement de ressource. Type de données : chaîne Valeur par défaut : chaîne vide
note	Liste des notes supplémentaires prises par le client lors de la commande. Type de données : tableau `"note": [ { "author": "String", "date": "String", "text": "String" } ]`
note.auteur	Nom d’utilisateur de la personne qui a rédigé la note associée. Type de données : chaîne
note.date	Date de création de la note. Type de données : chaîne
note.text	Notes/commentaires supplémentaires effectués par le client lors de la commande. Type de données : chaîne
orderDate	Date et horodatage de la commande. Format : JJ-MM-AAAA HH :MM :SS Type de données : chaîne Valeur par défaut : chaîne vide
PONR	Marqueur indiquant si le point de non-retour de la commande a été atteint. Valeurs valides : vrai : le point de non-retour de la commande a été atteint. La commande ne peut pas être modifiée ou annulée pendant que l’exécution est en cours. faux : le point de non-retour de la commande n’a pas été atteint. La commande peut être modifiée ou annulée. Type de données : booléennes
Fête connexe	Liste des contacts de la commande. 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. Situé dans la table Compte [customer_account], Contact [customer_contact] ou Consommateur [csm_consumer]. Type de données : chaîne
relatedParty.name	Nom du compte, du client ou du consommateur. Type de données : chaîne
relatedParty.@referredType	Type de client. Valeurs possibles : Consommateur Client Contact client 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
requestedCompletionDate	Date de livraison demandée par le client. Type de données : chaîne
requestedStartDate	Date de début de commande demandée par le client. Type de données : chaîne
élémentcommandeservice	Liste des éléments de ligne dans la commande de service et leur action associée. Type de données : tableau `"serviceOrderItem:" [ { "action": "String", "actionReason": "String", "committedDueDate": "String", "externalProductInventory": [Array], "id": "String", "orderRelationship": [Array], "quantity": "Number", "place": {Object}, "ponr": Boolean, "relatedParty": {Object}, "service": {Object}, "state": "String", "@type": "String", "version": "String" } ]`
serviceOrderItem.action	Action à effectuer sur l’élément de commande de service. Les actions possibles sont définies dans l’onglet Liste de choix dans le champ Entrée du dictionnaire d’action de la table sn_ind_tmt_orm_order_line_item. Pour plus de détails, voir Action types for customer and service orders Type de données : chaîne
serviceItemOrder.actionReason	Motif de l’ajout de l’élément de ligne de bon de commande. Type de données : chaîne Stocké dans : Le champ action_reason de la table sn_ind_tmt_orm_order_line_item.
serviceOrderItem.committedDueDate	Date et heure auxquelles l’action doit être effectuée sur l’élément de ligne de bon de commande. Type de données : chaîne
serviceItemOrder.externalProductInventory	Liste des ID externes mappés aux inventaires de produits créés pour la commande. Type de données : tableau d’objets `"externalProductInventory": [ { "externalProductInventoryId": "String" } ]`
serviceOrderItem.externalProductInventory.externalProductInventoryId	ID externe mappé à l’inventaire de produits. Type de données : chaîne
serviceOrderItem.id	Identificateur unique de l’élément de ligne. Situé dans le champ sn_ind_tmt_orm_external_id de la table Élément de ligne de commande [sn_ind_tmt_orm_order_line_item]. Type de données : chaîne
serviceItemOrder.orderRelationship	Liste des relations entre les éléments de ligne de commande. Type de données : tableau d’objets `"orderRelationship:" [ { "id": "String", "relationshipType": "String" } ]`
serviceOrderItem.orderRelationship.id	Identificateur unique de l’élément de ligne connexe. Situé dans le champ sn_ind_tmt_orm_external_id de la table Élément de ligne de commande [sn_ind_tmt_orm_order_line_item]. Type de données : chaîne
serviceItemOrder.orderRelationship.relationshipType	Type de relation entre les deux éléments de ligne. Ces informations sont utilisées pour identifier la hiérarchie des relations. Valeurs possibles : HasChild HasParent Exige `HasChild` et `HasParent` sont utilisés pour les relations parent/enfant. `Exige` est utilisé pour les relations horizontales (un élément de ligne nécessite un autre élément de ligne). Type de données : chaîne
serviceItemOrder.quantity	Nombre d’éléments de ligne commandés. Type de données : nombre
serviceOrderItem.place	Carte des emplacements où installer le service. Type de données : objet `"place:" { "id": "String", "@type": "String" }`
serviceOrderItem.place.id	Sys_id de l’enregistrement de l’emplacement associé dans la table Emplacement [cmn_location]. Type de données : chaîne
serviceOrderItem.place.@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 `Lieu`. Ces informations ne sont pas stockées. Type de données : chaîne
serviceOrderItem.ponr	Marqueur indiquant si le point de non retour de l’élément de ligne de bon de commande a été atteint. Valeurs valides : vrai : le point de non retour pour l’élément de ligne de commande a été atteint. L’élément de ligne de commande ne peut pas être modifié ou annulé pendant que l’exécution est en cours. faux : le point de non retour pour l’élément de ligne de commande n’a pas été atteint. L’élément de ligne de commande peut être modifié ou annulé. Type de données : booléennes
serviceItemCommande.Partieconnexe	Liste de contacts pour les éléments de ligne. Type de données : tableau `"relatedParty:" { "email": "String", "firstName": "String" "id": "String", "lastName": "String", "phone": "String", "@referredType": "String", "@type": "String" }`
serviceOrderItem.relatedParty.email	Adresse e-mail du contact. Type de données : chaîne
serviceItemCommande.PartieConnexe.firstName	Prénom du contact. Type de données : chaîne
serviceOrderItem.relatedParty.id	Sys_id du contact de l’élément de ligne associé à l’élément de ligne de commande. Situé dans la table Contact de l’élément de ligne de commande [sn_ind_tmt_orm_order_line_item_contact]. Type de données : chaîne
serviceOrderItem.relatedParty.lastName	Nom de famille du contact. Type de données : chaîne
serviceOrderItem.relatedParty.phone	Numéro de téléphone professionnel du contact. Type de données : chaîne
serviceOrderItem.relatedParty.@referredType	Requis. Type de client. Valeur possible : OrderLineItemContact Type de données : chaîne
serviceOrderItem.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
serviceItemCommande.service	Description des détails d’instance du service acheté par le client. Type de données : objet `"service:" { "serviceCharacteristic": [Array], "serviceRelationship": [Array], "serviceSpecification": {Object}, "serviceType": "String", "state": "String", "@type": "String" }`
serviceItemCommande.service.serviceCaractéristique	Liste décrivant les caractéristiques du service associé. Seules les caractéristiques de service avec un courant value différent de celui previousValue sont renvoyées. Type de données : tableau `"serviceCharacteristic:" [ { "name": "String", "previousValue": "String", "value": "String", "valueType": "String" } ]`
serviceItemOrder.service.serviceCharacteristic.value	Valeurs des options de caractéristiques associées au service. Pour plus d’informations sur les valeurs des options de caractéristique, reportez-vous à la section Create product characteristics and characteristic options. Type de données : chaîne
serviceOrderItem.service.serviceCharacteristic.valueType	Type de valeur caractéristique. Type de données : chaîne
serviceOrderItem.service.serviceRelationship	Liste des inventaires de produits associés au service. Type de données : tableau d’objets `"serviceRelationship": [ { "id": "String", "relationshipType": "String" } ]`
serviceOrderItem.service.serviceRelationship.id	Sys_id ou sn_prd_invt_external_id de l’inventaire des produits. Type de données : chaîne Table : dans le champ sys_id ou sn_prd_invt_external_id de la table Inventaire des produits [sn_prd_invt_product_inventory].
serviceOrderItem.service.serviceRelationship.relationshipType	Type de relation entre le service et l’inventaire des produits. Valeur possible : nécessite Type de données : chaîne
serviceOrderItem.service.serviceSpecification	Description de la spécification de service associée au service. Type de données : objet `"serviceSpecification:" { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String", "@type": "String" }`
serviceOrderItem.service.serviceSpecification.id	Initial_version ou external_id de la spécification de service. Le initial_version est le sys_id de la première version de la spécification. Situé dans le champ sys_id ou external_id de la table des spécifications de service [sn_prd_pm_service_specification]. Type de données : chaîne
serviceOrderItem.service.serviceSpecification.internalId	Version initiale de la spécification de service. Type de données : chaîne Table : dans le champ sys_id de la table Spécification de service [sn_prd_pm_service_specification].
serviceItemCommande.service.serviceSpecification.internalVersion	Version de la spécification de service. Type de données : chaîne Table : Spécification de service [sn_prd_pm_service_specification]
serviceOrderItem.service.serviceSpecification.name	Nom de la spécification de service. Situé dans la table Spécification de service [sn_prd_pm_service_specification]. Type de données : chaîne
serviceCommandeÉlément.service.serviceSpécification.version	External_version de la spécification de service. Type de données : chaîne Table : Spécification de service [sn_prd_pm_service_specification]
serviceOrderItem.service.serviceSpecification.@type	Fait partie de la norme TMF Open API. Cette valeur est toujours `ServiceSpecificationRef`. Ces informations ne sont pas stockées. Type de données : chaîne
serviceItemOrder.service.serviceType	Type de service. Type de données : chaîne
serviceItemOrder.service.state	État du produit vendu. Par exemple, nouveau. Type de données : chaîne
serviceOrderItem.state	État de l’élément de la commande de service. Par exemple, nouveau. Type de données : chaîne
serviceOrderItem.version	Version de l’élément de ligne de la commande de service. Type de données : chaîne
serviceOrderItem.@type	Fait partie de la norme TMF Open API. Cette valeur est toujours `ServiceOrderItem`. Ces informations ne sont pas stockées. Type de données : chaîne
État	État de la commande de service. Pour plus d'informations, consultezService order states. Type de données : chaîne
@type	Fait partie de la norme TMF Open API. Cette valeur est toujours `ServiceOrder`. Ces informations ne sont pas stockées. Type de données : chaîne

Demande cURL

L’exemple suivant récupère une commande de service spécifiée.

curl "https://instance.service-now.com/api/sn_tmf_api/order/serviceOrder/4f2af65ac3a030106e2473ce3640ddcf" \
--request GET \
--user 'username':'password'

Corps de la réponse.

{
   "id": "4f2af65ac3a030106e2473ce3640ddcf",
   "ponr": "false",
   "expectedCompletionDate": "2018-01-15T09:37:40.000Z",
   "requestedCompletionDate": "2018-01-15T09:37:40.000Z",
   "requestedStartDate": "2018-01-15T09:37:40.000Z",
   "note": [
      {
         "author": "System Administrator",
         "date": "2021-06-07T14:53:04.000Z",
         "text": "This is a TMF service order illustration no 2"
      },
      {
         "author": "System Administrator",
         "date": "2021-06-07T14:53:03.000Z",
         "text": "This is a TMF service order illustration"
      }
   ],
   "serviceOrderItem": [
      {
         "id": "100",
         "ponr": "false",
         "action": "add",
         "actionReason": "adding service package OLI",
         "quantity": 1,
         "service": {
            "@type": "Service",
            "state": "",
            "serviceType": "cfs",
            "serviceCharacteristic": [
               {
                  "name": "Firewall coverage",
                  "valueType": "choice",
                  "value": "Premium (Up to 50 sites)",
                  "previousValue": ""
               },
               {
                  "name": "Firewall Security",
                  "valueType": "choice",
                  "value": "Standard",
                  "previousValue": ""
               },
               {
                  "name": "Administration Support",
                  "valueType": "choice",
                  "value": "Basic (Customer Managed)",
                  "previousValue": ""
               }
            ],
            "serviceRelationship": [
               {
                  "id": "326d13f45b5620102dff5e92dc81c785",
                  "relationshipType": "Requires"
               }
            ],
            "serviceSpecification": {
               "id": "f99546ff07266010a7955b7e0ad300a8",
               "name": "Managed Firewall Service",
               "version": "v2",
               "internalVersion": "2",
               "internalId": "f99546ff07266010a7955b7e0ad300a8",
               "@type": "ServiceSpecificationRef"
            }
         },
         "place": {
            "id": "920cf6ac73d423002728660c4cf6a799",
            "@type": "Place"
         },
         "relatedParty": [
            {
               "id": "972af65ac3a030106e2473ce3640ddda",
               "firstName": "Mike",
               "lastName": "Hudson",
               "email": "mike@example.com",
               "phone": "1234567890",
               "@type": "RelatedParty",
               "@referredType": "OrderLineItemContact"
            }
         ],
         "state": "new",
         "version": "1",
         "@type": "ServiceOrderItem"
      }
   ],
   "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"
        }
    ],
   "state": "new",
   "version": "1",
   "@type": "ServiceOrder"
   "href": "/api/sn_tmf_api/order/serviceOrder/4f2af65ac3a030106e2473ce3640ddcfç",
   "orderDate": "2021-06-08T05:34:59.000Z",
}

API ouverte de commande de service : PATCH /sn_tmf_api/order/serviceOrder/{id}

Met à jour la commande de service spécifiée.

Format d'URL

URL par défaut : /api/sn_tmf_api/order/serviceOrder/{id}

Paramètres de demande pris en charge

Tableau 13. Paramètres de chemin d'accès
Nom	Description
id	Sys_id de la commande de client à mettre à jour. Type de données : chaîne Table : Commande de clients [sn_ind_tmt_orm_order]

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

Tableau 15. Paramètres du corps de la demande (JSON)
Nom	Description
committedDueDate	Date et heure auxquelles l’action doit être effectuée sur la commande. Cette valeur doit être identique ou postérieure aux valeurs de chaque committedDueDate élément de ligne de bon de commande. Si l’action pour les éléments de ligne de commande est `suspendre` ou `reprendre`, ce paramètre ne peut pas être mis à jour. Type de données : chaîne Stocké dans : Le champ committed_due_date de la table sn_ind_tmt_orm_order.
externalId	Numéro de commande unique de la commande de service externe. Type de données : chaîne Table/champ mis à jour : sn_ind_tmt_orm_order
note	Liste des notes supplémentaires prises par le client lors de la commande. Type de données : tableau d’objets `"note": [ { "text": "String" } ]` Stocké dans : sn_ind_tmt_orm_order
note.text	Notes/commentaires supplémentaires effectués par le client lors de la commande. Type de données : chaîne Stocké dans : Le champ de commentaires de la table sn_ind_tmt_orm_order. Valeur par défaut : chaîne vide
Fête connexe	Liste des contacts de la commande. Chaque contact est un objet dans le tableau. La demande doit répertorier au moins un élément contenant des informations sur un compte client ou un compte de consommateur. Type de données : tableau `"relatedParty": [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ]`
relatedParty.id	Requis. Sys_id ou external_id du compte, du contact client ou du consommateur associé à la commande. Type de données : chaîne Table : table Compte [customer_account], table Contact [customer_contact] ou Consommateur [csm_consumer] Table mise à jour : sn_ind_tmt_orm_order
relatedParty.name	Nom du compte, du client ou du consommateur. Type de données : chaîne
relatedParty.@referredType	Type de client. Valeurs possibles : Consommateur Client Contact client 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
requestedCompletionDate	Date de livraison demandée par le client. Type de données : chaîne Stocké dans : Le champ expected_end_date de la table sn_ind_tmt_orm_order. Valeur par défaut : chaîne vide
requestedStartDate	Date de début de commande demandée par le client. Type de données : chaîne Stocké dans : Le champ expected_start_date de la table sn_ind_tmt_orm_order. Valeur par défaut : chaîne vide
élémentcommandeservice	Requis. Liste des éléments de ligne dans la commande de service et leur action associée. Type de données : tableau d’objets `"serviceOrderItem:" [ { "action": "String", "actionReason": "String", "committedDueDate": "String", "externalProductInventory": [Array], "id": "String", "orderRelationship": [Array], "place": {Object}, "quantity": "Number", "relatedParty": {Object}, "service": {Object}, "@type": "String", "version": "String" } ]` Table/champ mis à jour : sn_ind_tmt_orm_order_line_item
serviceOrderItem.action	Requis. Action à effectuer sur l’élément de commande de service. Les actions possibles sont définies dans l’onglet Liste de choix dans le champ Entrée du dictionnaire d’action de la table sn_ind_tmt_orm_order_line_item. Valeurs possibles : ajouter changement supprimer Aucun changement reprendre suspendre Pour plus de détails, voir Action types for customer and service orders. Type de données : chaîne Table/champ mis à jour : sn_ind_tmt_orm_order_line_item/action
serviceItemOrder.actionReason	Facultatif. Description de la raison de l’élément de ligne. Type de données : chaîne Table/champ mis à jour : Élément de ligne de commande [sn_ind_tmt_orm_order_line_item] table/action_reason.
serviceOrderItem.committedDueDate	Date et heure auxquelles l’action doit être effectuée sur l’élément de ligne de bon de commande. Si l’action de l’élément est `suspendre` ou `reprendre`, ce paramètre ne peut pas être mis à jour. Type de données : chaîne Stocké dans : Le champ committed_due_date de la table sn_ind_tmt_orm_order_line_item.
serviceItemOrder.externalProductInventory	Liste des ID externes à mapper aux inventaires de produits créés pour la commande. Type de données : tableau d’objets `"externalProductInventory": [ { "externalProductInventoryId": "String" } ]` Remarque : Auparavant, lors de la création d’une commande PATCH avec un ID d’inventaire de produits externe qui existait déjà, l’opération était abandonnée et renvoyait une erreur. Avec la Xanadu version, ce paramètre est simplement ignoré lorsqu’un ID d’inventaire de produits externe existant est fourni et qu’aucune erreur n’est générée.
serviceOrderItem.externalProductInventory.externalProductInventoryId	ID externe à mapper à l’inventaire des produits. Type de données : chaîne Stocké dans : Champ external_inventory_id de la table Élément de ligne de commande [sn_ind_tmt_orm_order_line_item] et champ sn_prd_invt_external_id de la table sn_prd_invt_product_inventory.
serviceOrderItem.id	Requis. Identificateur unique de l’élément de ligne. Situé dans le champ sn_ind_tmt_orm_external_id de la table Élément de ligne de commande [sn_ind_tmt_orm_order_line_item]. Type de données : chaîne Table/champ mis à jour : sn_ind_tmt_orm_order_line_item/external_id
serviceItemOrder.orderRelationship	Requis. Liste des relations entre les éléments de ligne de commande. Type de données : tableau d’objets `"orderRelationship:" [ { "id": "String", "relationshipType": "String" } ]` Table/champ mis à jour : sn_ind_tmt_orm_order_line_item
serviceOrderItem.orderRelationship.id	Requis. Identificateur unique de l’élément de ligne connexe. Situé dans le champ sn_ind_tmt_orm_external_id de la table Élément de ligne de commande [sn_ind_tmt_orm_order_line_item]. Type de données : chaîne Table/champ mis à jour : sn_ind_tmt_orm_order_line_item/parent_line_item ou sn_ind_tmt_orm_order_line_related_items/related_order_line_item
serviceItemOrder.orderRelationship.relationshipType	Requis. Type de relation entre les deux éléments de ligne. Ces informations sont utilisées pour identifier la hiérarchie des relations. Valeurs possibles : HasChild HasParent Exige `HasChild` et `HasParent` sont utilisés pour les relations parent/enfant. `Exige` est utilisé pour les relations horizontales (un élément de ligne nécessite un autre élément de ligne). Type de données : chaîne
serviceOrderItem.place	Carte des emplacements où installer le service. Type de données : objet `"place:" { "id": "String", "@type": "String" }`
serviceOrderItem.place.id	Requis. Sys_id de l’enregistrement de l’emplacement associé dans la table Emplacement [cmn_location]. Type de données : chaîne Table/champ mis à jour : sn_ind_tmt_orm_order_line_item/emplacement
serviceOrderItem.place.@type	Fait partie de la norme d’API ouverte TMF. Annotation pour le placement de l’élément de ligne de commande. Type de données : chaîne
serviceItemOrder.quantity	Définit le nombre d’éléments de ligne à commander. Cette propriété est uniquement applicable lors de l’ajout d’une commande de service ; c’est-à-dire que la valeur de la action propriété est `ajoutée`. Type de données : nombre Valeur par défaut : chaîne vide Table/champ mis à jour : sn_ind_tmt_orm_order/quantité
serviceItemCommande.Partieconnexe	Liste de contacts pour les éléments de ligne. Type de données : tableau `"relatedParty:" { "email": "String", "firstName": "String", "lastName": "String", "phone": "String", "@referredType": "String", "@type": "String" }`
serviceOrderItem.relatedParty.email	Adresse e-mail du contact. Type de données : chaîne
serviceItemCommande.PartieConnexe.firstName	Prénom du contact. Type de données : chaîne
serviceOrderItem.relatedParty.lastName	Nom de famille du contact. Type de données : chaîne
serviceOrderItem.relatedParty.phone	Numéro de téléphone professionnel du contact. Type de données : chaîne
serviceOrderItem.relatedParty.@referredType	Requis. Type de client. Valeur possible : OrderLineItemContact Type de données : chaîne
serviceOrderItem.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
serviceItemCommande.service	Requis. Description des détails d’instance du service acheté par le client. Type de données : objet `"service:" { "id": "String", "serviceCharacteristic": [Array], "serviceRelationship": [Array], "serviceSpecification": {Object}, "@type": "String" }` Table/champ mis à jour : sn_ind_tmt_orm_order_line_item
serviceOrderItem.service.id	Identificateur unique du service vendu. Cette valeur peut être l’ID sys_id ou externe dans la table Inventaire des produits [sn_ind_tmt_orm_product_inventory]. Cette valeur n’est utilisée que pour les commandes de modification/déconnexion. Type de données : chaîne
serviceItemCommande.service.serviceCaractéristique	Liste décrivant les caractéristiques du service associé. Seules les caractéristiques de service avec un courant value différent de celui previousValue sont renvoyées. Type de données : tableau `"serviceCharacteristic:" [ { "name": "String", "previousValue": "String", "value": "String", } ]`
serviceOrderItem.service.serviceCharacteristic.name	Nom de l’enregistrement de caractéristique à associer au service. Situé dans la table Caractéristiques [sn_prd_pm_characteristic]. Type de données : chaîne
serviceOrderItem.service.serviceCharacteristic.previousValue	Valeurs des options des caractéristiques précédentes si la mise à jour concerne une commande de changement. La demande est une commande de changement si le paramètre est autre que `Ajouter`serviceOrderItem.action. Pour plus d’informations sur les valeurs d’option de caractéristique, reportez-vous à la sectionCreate product characteristics and characteristic options . Type de données : chaîne
serviceItemOrder.service.serviceCharacteristic.value	Valeurs des options de caractéristiques associées au service. Pour plus d’informations sur les valeurs des options de caractéristique, reportez-vous à la section Create product characteristics and characteristic options. Type de données : chaîne
serviceOrderItem.service.serviceSpecification	Requis. Description de la spécification de service associée au service. Remarque : Les ordres de changement (serviceOrderItem.action est `un changement`) sont traités différemment en fonction de la valeur de la sn_ind_tmt_orm.allowSpecVersionUpdateInChangeOrder propriété système. Lorsque la propriété est définie sur vrai (valeur par défaut), si le service est d’une version différente de celle indiquée dans la commande, le service est automatiquement mis à niveau vers la version de la commande en changeant la spécification de service référencée. Cela permet à la commande d’être traitée avec succès. Lorsque la propriété est définie sur faux, si le service est une version différente de celle indiquée dans la commande, la commande échoue en raison d’une incompatibilité de version. Type de données : objet `"serviceSpecification:" { "id": "String", "name": "String", "@type": "String" }` Stocké dans : Le champ service_specification de la table Élément de ligne de commande [sn_ind_tmt_orm_order_line_item].
serviceOrderItem.service.serviceSpecification.id	Requis. Initial_version ou external_id de la spécification de service. Le initial_version est le sys_id de la première version de la spécification. Situé dans le champ sys_id ou external_id de la table des spécifications de service [sn_prd_pm_service_specification]. Type de données : chaîne
serviceOrderItem.service.serviceSpecification.name	Requis. Nom de la spécification de service. Situé dans la table Spécification de service [sn_prd_pm_service_specification]. Type de données : chaîne
serviceOrderItem.service.serviceSpecification.@type	Fait partie de la norme TMF Open API. Cette valeur est toujours `ServiceSpecificationRef`. Ces informations ne sont pas stockées. Type de données : chaîne
serviceOrderItem.@type	Fait partie de la norme TMF Open API. Cette valeur est toujours `ServiceOrderItem`. Ces informations ne sont pas stockées. Type de données : chaîne
@type	Fait partie de la norme TMF Open API. Cette valeur est toujours `ServiceOrder`. Ces informations ne sont pas stockées. Type de données : chaîne

En-têtes

Tableau 16. En-têtes de demandes
En-tête	Description
Accepter	Format de données du corps de la réponse. Prend uniquement en charge application/json.
Content-Type	Format de données du corps de la demande. Prend uniquement en charge application/json.

Tableau 17. En-têtes de réponses
En-tête	Description
Type de contenu	Format de données du corps de la réponse. Prend uniquement en charge application/json.

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
200	Réussi. La demande a été correctement traitée.
201	Réussi. 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é : `Les caractéristiques suivantes de l’élément de commande n’existent pas : examinez les <specification.name de spécification> et corrigez la caractéristique et l’option de caractéristique dans l’élément de ligne de commande avant d’approuver la commande.` `Caractéristique de l’élément de commande : <characteristic.name> avec une valeur caractéristique : <characteristic.value>n’est pas valide. Corrigez les valeurs caractéristiques avant d’approuver la commande.`
400	Demande incorrecte. Peut être l’une des raisons suivantes : `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 : serviceOrderItem est manquant :` l’objet d’élément de ligne de commande de service ou JSON est manquant. `Charge utile non valide : l’ID serviceOrderItem est manquant` : le id paramètre est manquant dans l’élément de ligne de commande de service de la charge utile. `Charge utile non valide : l’action serviceOrderItem est manquante` : le action paramètre est manquant dans l’élément de ligne de commande de service de la charge utile. `Charge utile non valide : serviceOrderItem serviceOffering est manquant` : l’objet d’offre de service ou le JSON est manquant dans l’élément de ligne de commande de service dans la charge utile. `Charge utile non valide : l’ID serviceOffering est manquant :` le id paramètre est manquant dans l’élément de ligne de commande de service de l’objet d’offre de service dans la charge utile. `Charge utile non valide : L’offre de service n’existe pas :` l’offre de service dans l’élément de ligne de commande de service n’est pas valide. `Charge utile non valide : serviceOrderItem service est manquant` : l’objet de service ou le JSON dans l’élément de ligne de commande de service est manquant dans la charge utile. `Charge utile non valide : serviceSpecification est manquant` : l’objet de spécification de service ou le JSON dans l’élément de ligne de commande de service est manquant dans la charge utile. `Charge utile non valide : l’ID serviceSpecification est manquant :` le id paramètre de l’élément de ligne de commande de service de l’objet de spécification de service est manquant dans la charge utile. `Charge utile non valide : la spécification de service n’existe pas :` la spécification de service dans l’élément de ligne de commande de service n’est pas valide. `Charge utile non valide : L’inventaire des services n’existe pas` - Dans un ordre de changement (action = changement), la quantité d’un élément est supérieure à la quantité en stock. `Charge utile non valide : l’ID d’inventaire de service est manquant :` dans un ordre de changement, il manque le service.id dans la charge utile. `Charge utile non valide : le service vendu est inactif :` dans un ordre de modification, un service indiqué dans la charge utile est inactif. `Charge utile non valide : relatedParty est manquant :` l’objet de partie connexe est manquant dans la charge utile. `Charge utile non valide : le compte client ou le consommateur est manquant` : le client ou l’objet consommateur tiers connexe est manquant dans la charge utile. `Charge utile non valide : Le compte client n’existe pas` : le client tiers associé spécifié n’existe pas dans l’instance. `Charge utile non valide : le consommateur n’existe pas :` le consommateur tiers associé spécifié n’existe pas dans l’instance. `Charge utile non valide : Échec` de la création de la commande - Impossible de créer la commande demandée. `Révision en cours de la devise de commande non prise en charge` : le orderCurrency paramètre ne peut pas être mis à jour une fois la commande créée. `Cette commande doit encore être créée dans la table de commande client. Veuillez vérifier la file d’attente entrante pour plus d’informations.` – L’ID de commande fourni n’est pas dans la table de commande client. `La demande de correctif ne peut pas être effectuée car le type d’exécution de la commande n’est pas « livrer ».` – La demande de correctif a été effectuée sur une commande dont le type d’exécution n’est pas livré.
404	Introuvable. L'élément demandé est introuvable.

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


Nom	Description
committedDueDate	Date et heure auxquelles l’action doit être effectuée sur la commande. Cette valeur doit être identique ou postérieure aux valeurs de chaque committedDueDate élément de ligne de bon de commande. Type de données : chaîne
externalId	Numéro de commande unique de la commande de service externe. Type de données : chaîne
href	Lien relatif vers l’enregistrement de ressource. Type de données : chaîne Valeur par défaut : chaîne vide
id	Sys_id de la commande de service. Type de données : chaîne
note	Liste des notes supplémentaires prises par le client lors de la commande. Type de données : tableau `"note": [ { "text": "String" } ]`
note.text	Notes/commentaires supplémentaires effectués par le client lors de la commande. Type de données : chaîne
orderDate	Date et horodatage de la commande. Format : JJ-MM-AAAA HH :MM :SS Type de données : chaîne Valeur par défaut : chaîne vide
Fête connexe	Liste des contacts de la commande. 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 client ou du contact du consommateur associé à la commande. Situé dans la table Compte [customer_account], Contact [customer_contact] ou Consommateur [csm_consumer]. Type de données : chaîne
relatedParty.name	Nom du compte, du client ou du consommateur. Type de données : chaîne
relatedParty.@referredType	Type de client. Valeurs possibles : Client Contact client 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
requestedCompletionDate	Date de livraison demandée par le client. Type de données : chaîne
requestedStartDate	Date de début de commande demandée par le client. Type de données : chaîne
élémentcommandeservice	Liste des éléments de ligne dans la commande de service et leur action associée. Type de données : tableau `"serviceOrderItem:" [ { "action": "String", "actionReason": "String", "committedDueDate": "String", "externalProductInventory": [Array], "id": "String", "orderRelationship": [Array], "place": {Object}, "quantity": "Number", "relatedParty": {Object}, "service": {Object}, "@type": "String", "version": "String" } ]`
serviceOrderItem.action	Action à effectuer sur l’élément de commande de service. Les actions possibles sont définies dans l’onglet Liste de choix dans le champ Entrée du dictionnaire d’action de la table sn_ind_tmt_orm_order_line_item. Valeurs possibles : ajouter changement supprimer Pour plus de détails, voir Action types for customer and service orders. Type de données : chaîne
serviceItemOrder.actionReason	Motif de l’ajout de l’élément de ligne de bon de commande. Type de données : chaîne Stocké dans : Le champ action_reason de la table sn_ind_tmt_orm_order_line_item.
serviceOrderItem.committedDueDate	Date et heure auxquelles l’action doit être effectuée sur l’élément de ligne de bon de commande. Type de données : chaîne
serviceItemOrder.externalProductInventory	Liste des ID externes à mapper aux inventaires de produits créés pour la commande. Type de données : tableau d’objets `"externalProductInventory": [ { "externalProductInventoryId": "String" } ]` Remarque : Auparavant, lors de la création d’une commande PATCH avec un ID d’inventaire de produits externe qui existait déjà, l’opération était abandonnée et renvoyait une erreur. Avec la Xanadu version, ce paramètre est simplement ignoré lorsqu’un ID d’inventaire de produits externe existant est fourni et qu’aucune erreur n’est générée.
serviceOrderItem.externalProductInventory.externalProductInventoryId	ID externe mappé à l’inventaire de produits. Type de données : chaîne
serviceOrderItem.id	Identificateur unique de l’élément de ligne. Situé dans le champ sn_ind_tmt_orm_external_id de la table Élément de ligne de commande [sn_ind_tmt_orm_order_line_item]. Type de données : chaîne
serviceItemOrder.orderRelationship	Liste des relations entre les éléments de ligne de commande. Type de données : tableau `"orderRelationship:" [ { "id": "String", "relationshipType": "String" } ]`
serviceOrderItem.orderRelationship.id	Identificateur unique de l’élément de ligne connexe. Situé dans le champ sn_ind_tmt_orm_external_id de la table Élément de ligne de commande [sn_ind_tmt_orm_order_line_item]. Type de données : chaîne
serviceItemOrder.orderRelationship.relationshipType	Type de relation entre les deux éléments de ligne. Ces informations sont utilisées pour identifier la hiérarchie des relations. Valeurs possibles : HasChild HasParent Exige `HasChild` et `HasParent` sont utilisés pour les relations parent/enfant. `Exige` est utilisé pour les relations horizontales (un élément de ligne nécessite un autre élément de ligne). Type de données : chaîne
serviceOrderItem.place	Carte des emplacements où installer le service. Type de données : objet `"place:" { "id": "String", "@type": "String" }`
serviceOrderItem.place.id	Sys_id de l’enregistrement de l’emplacement associé dans la table Emplacement [cmn_location]. Type de données : chaîne
serviceOrderItem.place.@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 `Lieu`. Ces informations ne sont pas stockées. Type de données : chaîne
serviceItemOrder.quantity	Nombre d’éléments de ligne commandés. Type de données : nombre
serviceItemCommande.Partieconnexe	Liste de contacts pour les éléments de ligne. Type de données : tableau `"relatedParty:" { "email": "String", "firstName": "String", "lastName": "String", "phone": "String", "@referredType": "String", "@type": "String" }`
serviceOrderItem.relatedParty.email	Adresse e-mail du contact. Type de données : chaîne
serviceItemCommande.PartieConnexe.firstName	Prénom du contact. Type de données : chaîne
serviceOrderItem.relatedParty.lastName	Nom de famille du contact. Type de données : chaîne
serviceItemCommande.PartieConnexe.téléphone	Numéro de téléphone professionnel du contact. Type de données : chaîne
serviceOrderItem.relatedParty.@referredType	Type de client. Valeur possible : OrderLineItemContact Type de données : chaîne
serviceOrderItem.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
serviceItemCommande.service	Description des détails d’instance du service acheté par le client. Type de données : objet `"service:" { "id": "String", "serviceCharacteristic": [Array], "serviceRelationship": [Array], "serviceSpecification": {Object}, "@type": "String" }`
serviceOrderItem.service.id	Identificateur unique du service vendu. Cette valeur peut être l’ID sys_id ou externe dans la table Inventaire des produits [sn_ind_tmt_orm_product_inventory]. Cette valeur n’est renvoyée que pour les commandes de modification/déconnexion. Type de données : chaîne
serviceItemCommande.service.serviceCaractéristique	Liste décrivant les caractéristiques du service associé. Seules les caractéristiques de service avec un courant value différent de celui previousValue sont renvoyées. Type de données : tableau `"serviceCharacteristic:" [ { "name": "String", "previousValue": "String", "value": "String", } ]`
serviceOrderItem.service.serviceCharacteristic.name	Nom de l’enregistrement de caractéristique à associer au service. Situé dans la table Caractéristiques [sn_prd_pm_characteristic]. Type de données : chaîne
serviceOrderItem.service.serviceCharacteristic.previousValue	Valeurs des options des caractéristiques précédentes si la mise à jour concerne une commande de changement. La demande est une commande de changement si le paramètre est autre que `Ajouter`serviceOrderItem.action. Pour plus d’informations sur les valeurs d’option de caractéristique, reportez-vous à la sectionCreate product characteristics and characteristic options . Type de données : chaîne
serviceItemOrder.service.serviceCharacteristic.value	Valeurs des options de caractéristiques associées au service. Pour plus d’informations sur les valeurs des options de caractéristique, reportez-vous à la section Create product characteristics and characteristic options. Type de données : chaîne
serviceOrderItem.service.serviceSpecification	Description de la spécification de service associée au service. Type de données : objet `"serviceSpecification:" { "id": "String", "name": "String", "@type": "String" }`
serviceOrderItem.service.serviceSpecification.id	Initial_version ou external_id de la spécification de service. Le initial_version est le sys_id de la première version de la spécification. Situé dans le champ sys_id ou external_id de la table des spécifications de service [sn_prd_pm_service_specification]. Type de données : chaîne
serviceOrderItem.service.serviceSpecification.name	Nom de la spécification de service. Situé dans la table Spécification de service [sn_prd_pm_service_specification]. Type de données : chaîne
serviceOrderItem.service.serviceSpecification.@type	Fait partie de la norme TMF Open API. Cette valeur est toujours `ServiceSpecificationRef`. Ces informations ne sont pas stockées. Type de données : chaîne
serviceOrderItem.@type	Fait partie de la norme TMF Open API. Cette valeur est toujours `ServiceOrderItem`. Ces informations ne sont pas stockées. Type de données : chaîne
État	État de la commande de service. Pour plus d'informations, consultezService order states. Type de données : chaîne

Demande cURL

Cet exemple montre comment mettre à jour une commande de service.

curl -X PATCH 'https://instance.service-now.com/api/sn_tmf_api/order/serviceOrder/a831e56e77602110c8b3a4d54b5a9954' \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-u "username":"password" \
-d '{
  "externalId": "BSS748",
  "priority": "1",
  "description": "Managed Security",
  "category": "TMF resource illustration",
  "requestedStartDate": "2018-01-15T09:37:40.508Z",
  "requestedCompletionDate": "2018-01-15T09:37:40.508Z",
  "@type": "ServiceOrder",
  "note": [
    {
      "id": "1",
      "author": "Jean Pontus",
      "date": "2019-04-30T08:13:59.509Z",
      "text": "This is a TMF product order illustration"
    },
    {
      "id": "2",
      "author": "Jean Pontus1",
      "date": "2019-04-30T08:13:59.509Z",
      "text": "This is a TMF product order illustration no 2"
    }
  ],
  "serviceOrderItem": [
    {
      "id": "100",
      "action": "add",
      "actionReason":"adding service package OLI",
      "quantity": 1,
      "@type": "ServiceOrderItem",
      "service": {
        "serviceState": "active",
        "@type": "CFS",
        "serviceCharacteristic": [
          {
            "name": "CPE Type",
            "valueType": "string",
            "value": "Virtual"
          },
          {
            "name": "Administration Support",
            "valueType": "string",
            "value": "Basic( Customer Managed)"
          },
          {
            "name": "Firewall coverage",
            "valueType": "string",
            "value": "Standard(Up to 20 sites)"
          },
          {
            "name": "Firewall Security",
            "valueType": "string",
            "value": "Basic"
          }
        ],
        "serviceSpecification": {
          "id": "f99546ff07266010a7955b7e0ad300a8",
          "name": "Managed Firewall Service",
          "internalVersion": "1",
          "@type": "Managed Firewall Service"
        },
        "serviceRelationship": [
          {
            "id": "326d13f45b5620102dff5e92dc81c785",
            "relationshipType": "Requires"
          }
        ]
      },
      "place": {
        "id": "5671dd2ec3a53010188473ce3640dd81",
        "@type": "Place"
      }
    }
  ],
  "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"
        }
    ]
}'

Corps de la réponse.

{
  "externalId": "BSS748",
  "priority": "1",
  "description": "Managed Security",
  "category": "TMF resource illustration",
  "requestedStartDate": "2018-01-15T09:37:40.508Z",
  "requestedCompletionDate": "2018-01-15T09:37:40.508Z",
  "@type": "ServiceOrder",
  "note": [
    {
      "id": "1",
      "author": "Jean Pontus",
      "date": "2019-04-30T08:13:59.509Z",
      "text": "This is a TMF product order illustration"
    },
    {
      "id": "2",
      "author": "Jean Pontus1",
      "date": "2019-04-30T08:13:59.509Z",
      "text": "This is a TMF product order illustration no 2"
    }
  ],
  "serviceOrderItem": [
    {
      "id": "100",
      "action": "add",
      v"actionReason": "adding service package OLI",
      "quantity": 1,
      "@type": "ServiceOrderItem",
      "service": {
        "serviceState": "active",
        "@type": "CFS",
        "serviceCharacteristic": [
          {
            "name": "CPE Type",
            "valueType": "string",
            "value": "Virtual"
          },
          {
            "name": "Administration Support",
            "valueType": "string",
            "value": "Basic(Customer Managed)"
          },
          {
            "name": "Firewall coverage",
            "valueType": "string",
            "value": "Standard(Up to 20 sites)"
          },
          {
            "name": "Firewall Security",
            "valueType": "string",
            "value": "Basic"
          }
        ],
        "serviceSpecification": {
          "id": "f99546ff07266010a7955b7e0ad300a8",
          "name": "Managed Firewall Service",
          "internalVersion": "1",
          "@type": "Managed Firewall Service",
          "sys_id": "f99546ff07266010a7955b7e0ad300a8",
          "version": "",
          "status": "published",
          "internalId": "f99546ff07266010a7955b7e0ad300a8"
        },
        "serviceRelationship": [
          {
            "id": "326d13f45b5620102dff5e92dc81c785",
            "relationshipType": "Requires"
          }
        ]
      },
      "place": {
        "id": "5671dd2ec3a53010188473ce3640dd81",
        "@type": "Place"
      }
    }
  ],
  "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"
        }
    ],
  "orderType": "add",
  "state": "revision_received",
  "href": "/api/sn_tmf_api/order/serviceOrder/a831e56e77602110c8b3a4d54b5a9954"
}

API ouverte de commande de service : POST /sn_tmf_api/order/serviceOrder/cancelserviceorder

Annule la commande de service spécifiée.

Remarque :

Ce point de terminaison ne peut pas être utilisé sur les commandes pour lesquelles le point de non-retour a été atteint. Un élément de ligne de commande ne peut pas être annulé pendant que l’exécution est en cours.

Format d'URL

URL par défaut : /api/sn_tmf_api/order/serviceOrder/cancelserviceorder

Paramètres de demande pris en charge

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

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

Tableau 21. Paramètres du corps de la demande (JSON)
Nom	Description
motif d’annulation	Motif de l’annulation. Type de données : chaîne Valeur par défaut : chaîne vide
Commande de service	Données relatives à la commande de service. Type de données : objet `"serviceOrder": { "id": "String", "href": "String", "@referredType": "String" }`
serviceOrder.id	Requis. Sys_id de la commande du client à annuler. Type de données : chaîne Table : Commande de clients [sn_ind_tmt_orm_order]
serviceOrder.href	URL de la commande client à annuler. Type de données : chaîne Valeur par défaut : chaîne vide
serviceOrder.@referredType	La valeur de ce paramètre doit être `ServiceOrder`. Type de données : chaîne Valeur par défaut : chaîne vide
requestedCancellationDate	Date d’annulation de la commande. Type de données : chaîne Valeur par défaut : chaîne vide
@type	La valeur de ce paramètre doit être `CancelServiceOrder`. Type de données : chaîne Valeur par défaut : chaîne vide

En-têtes

Tableau 22. En-têtes de demandes
En-tête	Description
Accepter	Format de données du corps de la réponse. Prend uniquement en charge application/json.
Content-Type	Format de données du corps de la demande. Prend uniquement en charge application/json.

Tableau 23. En-têtes de réponses
En-tête	Description
Type de contenu	Format de données du corps de la réponse. Prend uniquement en charge application/json.

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 24. Codes d'état
Code d'état	Description
200	Réussi. La demande a été correctement traitée.
400	Demande incorrecte. Peut être l’une des raisons suivantes : Charge utile vide. Charge utile non valide. Champ obligatoire manquant : <nom de champ>. ID de commande non valide. ID de commande non valide : `cette commande doit encore être créée dans la table de commande client`. La demande d’annulation a été faite pour une commande qui n’a pas encore été créée. L’ordre se trouve dans la table File d’attente entrante [sn_tmt_core_inbound_queue] en attente que le planificateur récupère l’enregistrement.

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


Nom	Description
motif d’annulation	Motif de l’annulation. Type de données : chaîne
id	Sys_id de la commande annulée. Type de données : chaîne
Commande de service	Données relatives à la commande de service. Type de données : objet `"serviceOrder": { "id": "String", "@referredType": "String" }`
serviceOrder.id	Sys_id de la commande annulée. Type de données : chaîne
serviceOrder.@referredType	La valeur de ce paramètre est `ServiceOrder`. Type de données : chaîne
requestedCancellationDate	Date d’annulation de la commande. Type de données : chaîne
État	État de l’annulation. Si la demande d’annulation a été traitée avec succès (code d’état 201), la valeur de ce paramètre est `terminée`. Type de données : chaîne
@type	La valeur de ce paramètre est `CancelServiceOrder`. Type de données : chaîne

Demande cURL

L’exemple de code suivant annule une commande client.

curl -X POST "https://instance.servicenow.com/api/sn_tmf_api/cancelserviceorder" \
-H "Content-Type: application/json" \
-u "username":"password" \
-d {
  "cancellationReason": "Duplicate order",
  "requestedCancellationDate": "2023-01-24T11:56:21.931Z",
  "serviceOrder": {
    "id": "5f4f5e5377a311101fa5a4d54b5a99fd",
    "@referredType": "ServiceOrder"
  },
  "@type": "CancelServiceOrder"
}

{
  "id": "5f4f5e5377a311101fa5a4d54b5a99fd",
  "cancellationReason": "Duplicate order",
  "requestedCancellationDate": "2023-01-24T11:56:21.931Z",
  "@type": "CancelServiceOrder",
  "serviceOrder": {
    "id": "5f4f5e5377a311101fa5a4d54b5a99fd",
    "@referredType": "ServiceOrder"
  },
  "state": "done"
}

API ouverte de commande de service : POST /sn_tmf_api/order/serviceOrder

Crée, met à jour ou supprime une commande de service ou un élément de ligne.

Lorsqu’une action d’ajout est reçue et acceptée, un nouvel enregistrement est créé dans les tables suivantes :

Ordre [sn_ind_tmt_orm_order]
Valeur caractéristique de commande [sn_ind_tmt_orm_order_characteristic_value]
Élément de ligne de commande [sn_ind_tmt_orm_order_line_item]
Contact d’élément de ligne de commande [sn_ind_tmt_orm_order_line_item_contact]
Éléments liés à la ligne de commande [sn_ind_tmt_orm_order_line_related_items]

Format d'URL

/api/sn_tmf_api/order/serviceOrder

Paramètres de demande pris en charge

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

Tableau 26. Paramètres de requête
Nom	Description
Mode	Permet un traitement asynchrone des commandes. En d’autres termes, la commande est ajoutée à la table File d’attente entrante [sn_tmt_core_inbound_queue] pour être créée. Si elle n’est pas incluse, la commande est traitée de manière synchrone. Valeur valide : asynchrone Type de données : chaîne

Tableau 27. Paramètres du corps de la demande (JSON)
Nom	Description
committedDueDate	Date et heure auxquelles l’action doit être effectuée sur la commande. Cette valeur doit être identique ou postérieure aux valeurs de chaque committedDueDate élément de ligne de bon de commande. Type de données : chaîne Stocké dans : Le champ committed_due_date de la table sn_ind_tmt_orm_order.
externalId	Numéro de commande unique de la commande de service externe. Type de données : chaîne Table/champ mis à jour : sn_ind_tmt_orm_order
href	Lien relatif vers l’enregistrement de ressource. Type de données : chaîne Valeur par défaut : chaîne vide
note	Liste des notes supplémentaires prises par le client lors de la commande. Type de données : tableau d’objets `"note": [ { "text": "String" } ]` Stocké dans : sn_ind_tmt_orm_order
note.text	Notes/commentaires supplémentaires effectués par le client lors de la commande. Type de données : chaîne Stocké dans : Le champ de commentaires de la table sn_ind_tmt_orm_order. Valeur par défaut : chaîne vide
orderDate	Date et horodatage de la commande. Format : JJ-MM-AAAA HH :MM :SS Type de données : chaîne Valeur par défaut : chaîne vide
Fête connexe	Liste des contacts de la commande. Chaque contact est un objet dans le tableau. La demande doit répertorier au moins un élément contenant des informations sur un compte client ou un compte de consommateur. Type de données : tableau `"relatedParty": [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ]`
relatedParty.id	Requis. Sys_id ou external_id du compte, du contact client ou du consommateur associé à la commande. Type de données : chaîne Table : table Compte [customer_account], table Contact [customer_contact] ou Consommateur [csm_consumer] Table mise à jour : sn_ind_tmt_orm_order
relatedParty.name	Nom du compte, du client ou du consommateur. Type de données : chaîne
relatedParty.@referredType	Type de client. Valeurs possibles : Client Contact client 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
requestedCompletionDate	Date de livraison demandée par le client. Type de données : chaîne Stocké dans : Le champ expected_end_date de la table sn_ind_tmt_orm_order. Valeur par défaut : chaîne vide
requestedStartDate	Date de début de commande demandée par le client. Type de données : chaîne Stocké dans : Le champ expected_start_date de la table sn_ind_tmt_orm_order. Valeur par défaut : chaîne vide
élémentcommandeservice	Requis. Liste des éléments de ligne dans la commande de service et leur action associée. Type de données : tableau d’objets `"serviceOrderItem:" [ { "action": "String", "actionReason": "String", "committedDueDate": "String", "externalProductInventory": [Array], "id": "String", "orderRelationship": [Array], "place": {Object}, "quantity": "Number", "relatedParty": {Object}, "service": {Object}, "@type": "String", "version": "String" } ]` Table/champ mis à jour : sn_ind_tmt_orm_order_line_item
serviceOrderItem.action	Requis. Action à effectuer sur l’élément de commande de service. Les actions possibles sont définies dans l’onglet Liste de choix dans le champ Entrée du dictionnaire d’action de la table sn_ind_tmt_orm_order_line_item. Valeurs possibles : ajouter changement supprimer Aucun changement reprendre suspendre Pour plus de détails, voir Action types for customer and service orders. Type de données : chaîne Table/champ mis à jour : sn_ind_tmt_orm_order_line_item/action Par défaut : ajouter
ServiceOrderItem.actionReason	Facultatif. Description de la raison de l’élément de ligne. Type de données : chaîne Table/champ mis à jour : Élément de ligne de commande [sn_ind_tmt_orm_order_line_item] table/action_reason.
serviceOrderItem.committedDueDate	Date et heure auxquelles l’action doit être effectuée sur l’élément de ligne de bon de commande. Type de données : chaîne Stocké dans : Le champ committed_due_date de la table Élément de ligne de commande [sn_ind_tmt_orm_order_line_item].
serviceItemOrder.externalProductInventory	ID externes à mapper aux inventaires de produits créés pour la commande. Type de données : tableau d’objets `"externalProductInventory": [ { "externalProductInventoryId": "String" } ]`
serviceOrderItem.externalProductInventory.externalProductInventoryId	ID externe à mapper à l’inventaire des produits. Type de données : chaîne Stocké dans : le champ external_inventory_id de la table sn_ind_tmt_orm_order_line_item et le champ sn_prd_invt_external_id de la table sn_prd_invt_product_inventory.
serviceOrderItem.id	Requis. Identificateur unique de l’élément de ligne. Situé dans le champ sn_ind_tmt_orm_external_id de la table Élément de ligne de commande [sn_ind_tmt_orm_order_line_item]. Type de données : chaîne Table/champ mis à jour : sn_ind_tmt_orm_order_line_item/external_id
serviceItemOrder.orderRelationship	Requis. Liste des relations entre les éléments de ligne de commande. Type de données : tableau d’objets `"orderRelationship:" [ { "id": "String", "relationshipType": "String" } ]` Table/champ mis à jour : sn_ind_tmt_orm_order_line_item
serviceOrderItem.orderRelationship.id	Requis. Identificateur unique de l’élément de ligne connexe. Situé dans le champ sn_ind_tmt_orm_external_id de la table Élément de ligne de commande [sn_ind_tmt_orm_order_line_item]. Type de données : chaîne Table/champ mis à jour : sn_ind_tmt_orm_order_line_item/parent_line_item ou sn_ind_tmt_orm_order_line_related_items/related_order_line_item
serviceItemOrder.orderRelationship.relationshipType	Requis. Type de relation entre les deux éléments de ligne. Ces informations sont utilisées pour identifier la hiérarchie des relations. Valeurs possibles : HasChild HasParent Exige `HasChild` et `HasParent` sont utilisés pour les relations parent/enfant. `Exige` est utilisé pour les relations horizontales (un élément de ligne nécessite un autre élément de ligne). Type de données : chaîne
serviceOrderItem.place	Carte des emplacements où installer le service. Type de données : objet `"place:" { "id": "String", "@type": "String" }`
serviceOrderItem.place.id	Requis. Sys_id de l’enregistrement de l’emplacement associé dans la table Emplacement [cmn_location]. Type de données : chaîne Table/champ mis à jour : sn_ind_tmt_orm_order_line_item/emplacement Valeur par défaut : chaîne vide
serviceOrderItem.place.@type	Fait partie de la norme d’API ouverte TMF. Annotation pour le placement de l’élément de ligne de commande. Type de données : chaîne
serviceItemOrder.quantity	Définit le nombre d’éléments de ligne à commander. Cette propriété est uniquement applicable lors de l’ajout d’une commande de service ; c’est-à-dire que la valeur de la action propriété est `ajoutée`. Type de données : nombre Valeur par défaut : chaîne vide Table/champ mis à jour : sn_ind_tmt_orm_order/quantité
serviceItemCommande.Partieconnexe	Liste de contacts pour les éléments de ligne. Type de données : tableau `"relatedParty:" { "email": "String", "firstName": "String", "lastName": "String", "phone": "String", "@referredType": "String", "@type": "String" }`
serviceOrderItem.relatedParty.email	Adresse e-mail du contact. Type de données : chaîne
serviceItemCommande.PartieConnexe.firstName	Prénom du contact. Type de données : chaîne
serviceOrderItem.relatedParty.lastName	Nom de famille du contact. Type de données : chaîne
serviceOrderItem.relatedParty.phone	Numéro de téléphone professionnel du contact. Type de données : chaîne
serviceOrderItem.relatedParty.@referredType	Requis. Type de client. Valeur possible : OrderLineItemContact Type de données : chaîne
serviceOrderItem.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
serviceItemCommande.service	Requis. Description des détails d’instance du service acheté par le client. Type de données : objet `"service:" { "id": "String", "serviceCharacteristic": [Array], "serviceRelationship": [Array], "serviceSpecification": {Object}, "@type": "String" }` Table/champ mis à jour : sn_ind_tmt_orm_order_line_item
serviceOrderItem.service.id	Identificateur unique du service vendu. Cette valeur peut être l’ID sys_id ou externe dans la table Inventaire des produits [sn_ind_tmt_orm_product_inventory]. Cette valeur n’est utilisée que pour les commandes de modification/déconnexion. Type de données : chaîne
serviceItemCommande.service.serviceCaractéristique	Liste décrivant les caractéristiques du service associé. Seules les caractéristiques de service avec un courant value différent de celui previousValue sont renvoyées. Type de données : tableau `"serviceCharacteristic:" [ { "name": "String", "previousValue": "String", "value": "String", } ]`
serviceOrderItem.service.serviceCharacteristic.name	Nom de l’enregistrement de caractéristique à associer au service. Situé dans la table Caractéristiques [sn_prd_pm_characteristic]. Type de données : chaîne
serviceOrderItem.service.serviceCharacteristic.previousValue	Valeurs des options des caractéristiques précédentes si la mise à jour concerne une commande de changement. La demande est une commande de changement si le paramètre est autre que `Ajouter`serviceOrderItem.action. Pour plus d’informations sur les valeurs d’option de caractéristique, reportez-vous à la sectionCreate product characteristics and characteristic options . Type de données : chaîne
serviceItemOrder.service.serviceCharacteristic.value	Valeurs des options de caractéristiques associées au service. Pour plus d’informations sur les valeurs des options de caractéristique, reportez-vous à la section Create product characteristics and characteristic options. Type de données : chaîne
serviceOrderItem.service.serviceRelationship	Liste des inventaires de produits associés au service. Type de données : tableau d’objets `"serviceRelationship": [ { "id": "String", "relationshipType": "String" } ]`
serviceOrderItem.service.serviceRelationship.id	Sys_id ou sn_prd_invt_external_id de l’inventaire des produits. Type de données : chaîne Table : dans le champ sys_id ou sn_prd_invt_external_id de la table Inventaire des produits [sn_prd_invt_product_inventory].
serviceOrderItem.service.serviceRelationship.relationshipType	Type de relation entre le service et l’inventaire des produits. Valeur possible : nécessite Type de données : chaîne
serviceOrderItem.service.serviceSpecification	Requis. Description de la spécification de service associée au service. Remarque : Les ordres de changement (serviceOrderItem.action est `un changement`) sont traités différemment en fonction de la valeur de la sn_ind_tmt_orm.allowSpecVersionUpdateInChangeOrder propriété système. Lorsque la propriété est définie sur vrai (valeur par défaut), si le service est d’une version différente de celle indiquée dans la commande, le service est automatiquement mis à niveau vers la version de la commande en changeant la spécification de service référencée. Cela permet à la commande d’être traitée avec succès. Lorsque la propriété est définie sur faux, si le service est une version différente de celle indiquée dans la commande, la commande échoue en raison d’une incompatibilité de version. Type de données : objet `"serviceSpecification:" { "id": "String", "internalVersion": "String", "name": "String", "version": "String", "@type": "String" }` Stocké dans : Le champ service_specification de la table Élément de ligne de commande [sn_ind_tmt_orm_order_line_item].
serviceOrderItem.service.serviceSpecification.id	Requis. Initial_version ou external_id de la spécification de service. Le initial_version est le sys_id de la première version de la spécification. Situé dans le champ sys_id ou external_id de la table des spécifications de service [sn_prd_pm_service_specification]. Type de données : chaîne
serviceItemCommande.service.serviceSpecification.internalVersion	Version de la spécification de service. Type de données : chaîne Table : Spécification de service [sn_prd_pm_service_specification]
serviceOrderItem.service.serviceSpecification.name	Requis. Nom de la spécification de service. Situé dans la table Spécification de service [sn_prd_pm_service_specification]. Type de données : chaîne
serviceCommandeÉlément.service.serviceSpécification.version	External_version de la spécification de service. Type de données : chaîne Table : Spécification de service [sn_prd_pm_service_specification]
serviceOrderItem.service.serviceSpecification.@type	Fait partie de la norme TMF Open API. Cette valeur est toujours `ServiceSpecificationRef`. Ces informations ne sont pas stockées. Type de données : chaîne
serviceOrderItem.@type	Fait partie de la norme TMF Open API. Cette valeur est toujours `ServiceOrderItem`. Ces informations ne sont pas stockées. Type de données : chaîne
@type	Fait partie de la norme TMF Open API. Cette valeur est toujours `ServiceOrder`. Ces informations ne sont pas stockées. Type de données : chaîne

En-têtes

Tableau 28. En-têtes de demandes
En-tête	Description
Accepter	Format de données du corps de la réponse. Prend uniquement en charge application/json.

Tableau 29. En-têtes de réponses
En-tête	Description
Type de contenu	Format de données du corps de la réponse. Prend uniquement en charge application/json.

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 30. Codes d'état
Code d'état	Description
200	Réussi. La demande a été correctement traitée.
201	Réussi. 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é : Les caractéristiques d’élément de commande suivantes n’existent pas : examinez les <specification.name de spécifications> et corrigez la caractéristique et l’option de caractéristique dans l’élément de ligne de commande avant d’approuver la commande. Caractéristique de l’élément de commande : <characteristic.name> avec une valeur caractéristique : <characteristic.value> n’est pas valide. Corrigez les valeurs caractéristiques avant d’approuver la commande.
202	Accepté. Demande réussie pour une commande en mode asynchrone. En d’autres termes, la demande a été effectuée avec le mode paramètre réglé sur `asynchrone` et le traitement de l’enregistrement est planifié dans la table File d’attente entrante [sn_tmt_core_inbound_queue].
400	Demande incorrecte. Peut être l’une des raisons suivantes : 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 : serviceOrderItem manquant. - L’objet d’élément de ligne de commande de service ou JSON est manquant. Charge utile non valide : l’ID serviceOrderItem est manquant. – L’ID est manquant sur l’élément de ligne de commande de service. Charge utile non valide : l’action serviceOrderItem est manquante. : l’objet de service ou le JSON est manquant dans la charge utile. Charge utile non valide : serviceOrderItem service est manquant. : la propriété de service est manquante dans l’élément de ligne de commande de service. Charge utile non valide : serviceSpecification est manquant. - L’objet de spécification de service ou le JSON dans l’élément de ligne de commande de service est manquant dans la charge utile. Charge utile non valide : l’ID serviceSpecification est manquant. - Le id paramètre de l’élément de ligne de commande de service de l’objet de spécification de service est manquant dans la charge utile. Charge utile non valide : la spécification de service n’existe pas. - La spécification de service dans l’élément de ligne de commande de service n’est pas valide. Charge utile non valide : l’inventaire de produits n’existe pas. - Dans un ordre de modification ou de suppression (c’est-à-dire action = modification ou suppression), le service vendu envoyé n’est pas présent dans le système. Charge utile non valide : ID d’inventaire de produits manquant. – Dans une commande de modification ou de suppression, l’ID du produit vendu est manquant dans la charge utile. Charge utile non valide : le compte client ou le consommateur est manquant : le client ou l’objet consommateur tiers connexe est manquant dans la charge utile. Charge utile non valide : le produit vendu est inactif. – Dans un ordre de modification ou de suppression, le Produit vendu envoyé dans la charge utile n’est pas en état actif. Charge utile non valide : le consommateur n’existe pas : le consommateur tiers associé spécifié n’existe pas dans l’instance. Charge utile non valide : le compte client n’existe pas. – Le client apparenté fourni dans la charge utile n’est pas présent dans le système. Charge utile non valide : Échec de la création de la commande. - Impossible de créer la commande demandée.
404	Introuvable. L’élément demandé est introuvable.

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


Nom	Description
committedDueDate	Date et heure auxquelles l’action doit être effectuée sur la commande. Cette valeur doit être identique ou postérieure aux valeurs de chaque committedDueDate élément de ligne de bon de commande. Type de données : chaîne
externalId	Numéro de commande unique de la commande de service externe. Type de données : chaîne
href	Lien relatif vers l’enregistrement de ressource. Type de données : chaîne Valeur par défaut : chaîne vide
id	Sys_id de la commande de service. Type de données : chaîne
note	Liste des notes supplémentaires prises par le client lors de la commande. Type de données : tableau `"note": [ { "text": "String" } ]`
note.text	Notes/commentaires supplémentaires effectués par le client lors de la commande. Type de données : chaîne
orderDate	Date et horodatage de la commande. Format : JJ-MM-AAAA HH :MM :SS Type de données : chaîne Valeur par défaut : chaîne vide
orderId	Sys_id de la commande à créer. En cas de réussite de la demande, la commande est ajoutée à la table File d’attente entrante [sn_tmt_core_inbound_queue] sur un calendrier pour être traitée. Remarque : Cette valeur est le seul résultat si la commande est créée de manière asynchrone à l’aide du mode paramètre query. `{ "orderId": "b0fc877ac3ab5110856d73ce3640dde0" }` Type de données : chaîne
Fête connexe	Liste des contacts de la commande. 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 client ou du contact du consommateur associé à la commande. Situé dans la table Compte [customer_account], Contact [customer_contact] ou Consommateur [csm_consumer]. Type de données : chaîne
relatedParty.name	Nom du compte, du client ou du consommateur. Type de données : chaîne
relatedParty.@referredType	Type de client. Valeurs possibles : Client Contact client 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
requestedCompletionDate	Date de livraison demandée par le client. Type de données : chaîne
requestedStartDate	Date de début de commande demandée par le client. Type de données : chaîne
élémentcommandeservice	Liste des éléments de ligne dans la commande de service et leur action associée. Type de données : tableau `"serviceOrderItem:" [ { "action": "String", "actionReason": "String", "committedDueDate": "String", "externalProductInventory": [Array], "id": "String", "orderRelationship": [Array], "place": {Object}, "quantity": "Number", "relatedParty": {Object}, "service": {Object}, "@type": "String", "version": "String" } ]`
serviceOrderItem.action	Action à effectuer sur l’élément de commande de service. Les actions possibles sont définies dans l’onglet Liste de choix dans le champ Entrée du dictionnaire d’action de la table sn_ind_tmt_orm_order_line_item. Valeurs possibles : ajouter changement supprimer Aucun changement reprendre suspendre Pour plus de détails, voir Action types for customer and service orders. Type de données : chaîne
ServiceOrderItem.actionReason	Description du motif de l’ajout de l’élément de ligne. Type de données : chaîne Table : élément de ligne de commande [sn_ind_tmt_orm_order_line_item]
serviceOrderItem.committedDueDate	Date et heure auxquelles l’action doit être effectuée sur l’élément de ligne de bon de commande. Type de données : chaîne
serviceItemOrder.externalProductInventory	Liste des ID externes mappés aux inventaires de produits créés pour la commande. Type de données : tableau d’objets `"externalProductInventory": [ { "externalProductInventoryId": "String" } ]`
serviceOrderItem.externalProductInventory.externalProductInventoryId	ID externe mappé à l’inventaire de produits. Type de données : chaîne
serviceOrderItem.id	Identificateur unique de l’élément de ligne. Situé dans le champ sn_ind_tmt_orm_external_id de la table Élément de ligne de commande [sn_ind_tmt_orm_order_line_item]. Type de données : chaîne
serviceItemOrder.orderRelationship	Liste des relations entre les éléments de ligne de commande. Type de données : tableau `"orderRelationship:" [ { "id": "String", "relationshipType": "String" } ]`
serviceOrderItem.orderRelationship.id	Identificateur unique de l’élément de ligne connexe. Situé dans le champ sn_ind_tmt_orm_external_id de la table Élément de ligne de commande [sn_ind_tmt_orm_order_line_item]. Type de données : chaîne
serviceItemOrder.orderRelationship.relationshipType	Type de relation entre les deux éléments de ligne. Ces informations sont utilisées pour identifier la hiérarchie des relations. Valeurs possibles : HasChild HasParent Exige `HasChild` et `HasParent` sont utilisés pour les relations parent/enfant. `Exige` est utilisé pour les relations horizontales (un élément de ligne nécessite un autre élément de ligne). Type de données : chaîne
serviceOrderItem.place	Carte des emplacements où installer le service. Type de données : objet `"place:" { "id": "String", "@type": "String" }`
serviceOrderItem.place.id	Sys_id de l’enregistrement de l’emplacement associé dans la table Emplacement [cmn_location]. Type de données : chaîne
serviceOrderItem.place.@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 `Lieu`. Ces informations ne sont pas stockées. Type de données : chaîne
serviceItemOrder.quantity	Nombre d’éléments de ligne commandés. Type de données : nombre
serviceItemCommande.Partieconnexe	Liste de contacts pour les éléments de ligne. Type de données : tableau `"relatedParty:" { "email": "String", "firstName": "String", "lastName": "String", "phone": "String", "@referredType": "String", "@type": "String" }`
serviceOrderItem.relatedParty.email	Adresse e-mail du contact. Type de données : chaîne
serviceItemCommande.PartieConnexe.firstName	Prénom du contact. Type de données : chaîne
serviceOrderItem.relatedParty.lastName	Nom de famille du contact. Type de données : chaîne
serviceItemCommande.PartieConnexe.téléphone	Numéro de téléphone professionnel du contact. Type de données : chaîne
serviceOrderItem.relatedParty.@referredType	Requis. Type de client. Valeur possible : OrderLineItemContact Type de données : chaîne
serviceOrderItem.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
serviceItemCommande.service	Description des détails d’instance du service acheté par le client. Type de données : objet `"service:" { "id": "String", "serviceCharacteristic": [Array], "serviceRelationship": [Array], "serviceSpecification": {Object}, "@type": "String" }`
serviceOrderItem.service.id	Identificateur unique du service vendu. Cette valeur peut être l’ID sys_id ou externe dans la table Inventaire des produits [sn_ind_tmt_orm_product_inventory]. Cette valeur n’est renvoyée que pour les commandes de modification/déconnexion. Type de données : chaîne
serviceItemCommande.service.serviceCaractéristique	Liste décrivant les caractéristiques du service associé. Seules les caractéristiques de service avec un courant value différent de celui previousValue sont renvoyées. Type de données : tableau `"serviceCharacteristic:" [ { "name": "String", "previousValue": "String", "value": "String", } ]`
serviceOrderItem.service.serviceCharacteristic.name	Nom de l’enregistrement de caractéristique à associer au service. Situé dans la table Caractéristiques [sn_prd_pm_characteristic]. Type de données : chaîne
serviceOrderItem.service.serviceCharacteristic.previousValue	Valeurs des options des caractéristiques précédentes si la mise à jour concerne une commande de changement. La demande est une commande de changement si le paramètre est autre que `Ajouter`serviceOrderItem.action. Pour plus d’informations sur les valeurs d’option de caractéristique, reportez-vous à la sectionCreate product characteristics and characteristic options . Type de données : chaîne
serviceItemOrder.service.serviceCharacteristic.value	Valeurs des options de caractéristiques associées au service. Pour plus d’informations sur les valeurs des options de caractéristique, reportez-vous à la section Create product characteristics and characteristic options. Type de données : chaîne
serviceOrderItem.service.serviceRelationship	Liste des inventaires de produits associés au service. Type de données : tableau d’objets `"serviceRelationship": [ { "id": "String", "relationshipType": "String" } ]`
serviceOrderItem.service.serviceRelationship.id	Sys_id ou sn_prd_invt_external_id de l’inventaire des produits. Type de données : chaîne Table : dans le champ sys_id ou sn_prd_invt_external_id de la table Inventaire des produits [sn_prd_invt_product_inventory].
serviceOrderItem.service.serviceRelationship.relationshipType	Type de relation entre le service et l’inventaire des produits. Valeur possible : nécessite Type de données : chaîne
serviceOrderItem.service.serviceSpecification	Description de la spécification de service associée au service. Type de données : objet `"serviceSpecification:" { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String", "@type": "String" }`
serviceOrderItem.service.serviceSpecification.id	Initial_version ou external_id de la spécification de service. Le initial_version est le sys_id de la première version de la spécification. Situé dans le champ sys_id ou external_id de la table des spécifications de service [sn_prd_pm_service_specification]. Type de données : chaîne
serviceOrderItem.service.serviceSpecification.internalId	Version initiale de la spécification de service. Type de données : chaîne Table : dans le champ sys_id de la table Spécification de service [sn_prd_pm_service_specification].
serviceItemCommande.service.serviceSpecification.internalVersion	Version de la spécification de service. Type de données : chaîne Table : Spécification de service [sn_prd_pm_service_specification]
serviceOrderItem.service.serviceSpecification.name	Nom de la spécification de service. Situé dans la table Spécification de service [sn_prd_pm_service_specification]. Type de données : chaîne
serviceCommandeÉlément.service.serviceSpécification.version	External_version de la spécification de service. Type de données : chaîne Table : Spécification de service [sn_prd_pm_service_specification]
serviceOrderItem.service.serviceSpecification.@type	Fait partie de la norme TMF Open API. Cette valeur est toujours `ServiceSpecificationRef`. Ces informations ne sont pas stockées. Type de données : chaîne
serviceOrderItem.state	État de l’élément de la commande de service. Par exemple, nouveau. Type de données : chaîne
serviceOrderItem.@type	Fait partie de la norme TMF Open API. Cette valeur est toujours `ServiceOrderItem`. Ces informations ne sont pas stockées. Type de données : chaîne
État	État de la commande de service. Pour plus d'informations, consultezService order states. Type de données : chaîne
@type	Fait partie de la norme TMF Open API. Cette valeur est toujours `ServiceOrder`. Ces informations ne sont pas stockées. Type de données : chaîne

Traitement asynchrone

Cet exemple montre comment utiliser le mode paramètre de requête pour créer une commande de manière asynchrone. La commande est ajoutée à la table File d’attente entrante [sn_tmt_core_inbound_queue] sur un calendrier à créer.

curl -X POST 'https://instance.service-now.com/api/sn_tmf_api/serviceorder?mode=async' \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-u "username":"password" \
-d '{
  "externalId": "BSS748",
  "priority": "1",
  "description": "Managed Security",
  "category": "TMF resource illustration",
  "requestedStartDate": "2018-01-15T09:37:40.508Z",
  "requestedCompletionDate": "2018-01-15T09:37:40.508Z",
  "@type": "ServiceOrder",
  "note": [
    {
      "id": "1",
      "author": "Jean Pontus",
      "date": "2019-04-30T08:13:59.509Z",
      "text": "This is a TMF product order illustration"
    },
    {
      "id": "2",
      "author": "Jean Pontus1",
      "date": "2019-04-30T08:13:59.509Z",
      "text": "This is a TMF product order illustration no 2"
    }
  ],
  "serviceOrderItem": [
    {
      "id": "100",
      "action": "add",
      "actionReason":"adding service package OLI",
      "quantity": 1,
      "@type": "ServiceOrderItem",
      "service": {
        "serviceState": "active",
        "@type": "CFS",
        "serviceCharacteristic": [
          {
            "name": "CPE Type",
            "valueType": "string",
            "value": "Virtual"
          },
          {
            "name": "Administration Support",
            "valueType": "string",
            "value": "Basic( Customer Managed)"
          },
          {
            "name": "Firewall coverage",
            "valueType": "string",
            "value": "Standard(Up to 20 sites)"
          },
          {
            "name": "Firewall Security",
            "valueType": "string",
            "value": "Basic"
          }
        ],
        "serviceSpecification": {
          "id": "f99546ff07266010a7955b7e0ad300a8",
          "name": "Managed Firewall Service",
          "internalVersion": "1",
          "@type": "Managed Firewall Service"
        },
        "serviceRelationship": [
          {
            "id": "326d13f45b5620102dff5e92dc81c785",
            "relationshipType": "Requires"
          }
        ]
      },
      "place": {
        "id": "5671dd2ec3a53010188473ce3640dd81",
        "@type": "Place"
      }
    }
  ],
  "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"
        }
    ]
}'

Corps de la réponse.

{
  "orderId": "304e877ac3ab5110856d73ce3640dde5"
}

Traitement synchrone (par défaut)

L’exemple suivant montre comment créer une commande de service en définissant la serviceOrderItem.action propriété sur ajouter.

curl "https://instance.service-now.com/api/sn_tmf_api/serviceorder" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
   "externalId": "BSS748",
   "requestedStartDate": "2018-01-15T09:37:40.508Z",
   "requestedCompletionDate": "2018-01-15T09:37:40.508Z",
   "@type": "ServiceOrder",
   "note": [
      {
         "text": "This is a TMF service order illustration"
      },
      {
         "text": "This is a TMF service order illustration no 2"
      }
   ],
   "serviceOrderItem": [
      {
         "id": "100",
         "action": "add",
         "actionReason":"adding service package OLI",
         "quantity": 1,
         "@type": "ServiceOrderItem",
         "service": {
            "@type": "CFS",
            "serviceCharacteristic": [
               {
                  "name": "Firewall Security",
                  "value": "Standard"
               },
               {
                  "name": "Firewall coverage",
                  "value": "Premium (Up to 50 sites)"
               },
               {
                  "name": "Administration Support",
                  "value": "Basic (Customer Managed)"
               }
            ],
            "serviceRelationship": [
               {
                  "id": "326d13f45b5620102dff5e92dc81c785",
                  "relationshipType": "Requires"
               }
            ],
            "serviceSpecification": {
               "id": "f99546ff07266010a7955b7e0ad300a8",
               "name": "Managed Firewall Service",
               "@type": "Managed Firewall Service"
            }
         },
         "relatedParty": [
            {
               "firstName": "Mike",
               "lastName": "Hudson",
               "email": "mike@example.com",
               "phone": "1234567890",
               "@type": "RelatedParty",
               "@referredType": "OrderLineItemContact"
            }
         ],
         "place": {
            "id": "920cf6ac73d423002728660c4cf6a799",
            "@type": "Place"
         }
      }
   ],
   "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"
        }
    ]
}" \
--user 'username':'password'

Corps de la réponse :

{
   "externalId": "BSS748",
   "requestedStartDate": "2018-01-15T09:37:40.508Z",
   "requestedCompletionDate": "2018-01-15T09:37:40.508Z",
   "@type": "ServiceOrder",
   "note": [
      {
         "text": "This is a TMF service order illustration"
      },
      {
         "text": "This is a TMF service order illustration no 2"
      }
   ],
   "serviceOrderItem": [
      {
         "id": "100",
         "action": "add",
         "actionReason":"adding service package OLI",
         "quantity": 1,
         "@type": "ServiceOrderItem",
         "service": {
            "@type": "CFS",
            "serviceCharacteristic": [
               {
                  "name": "Firewall Security",
                  "value": "Standard"
               },
               {
                  "name": "Firewall coverage",
                  "value": "Premium (Up to 50 sites)"
               },
               {
                  "name": "Administration Support",
                  "value": "Basic (Customer Managed)"
               }
            ],
            "serviceRelationship": [
               {
                  "id": "326d13f45b5620102dff5e92dc81c785",
                  "relationshipType": "Requires"
               }
            ],
            "serviceSpecification": {
               "id": "f99546ff07266010a7955b7e0ad300a8",
               "name": "Managed Firewall Service",
               "@type": "Managed Firewall Service",
               "internalVersion": "2",
               "version": "v2",
               "internalId": "f99546ff07266010a7955b7e0ad300a8"
            }
         },
         "relatedParty": [
            {
               "firstName": "Mike",
               "lastName": "Hudson",
               "email": "mike@example.com",
               "phone": "1234567890",
               "@type": "RelatedParty",
               "@referredType": "OrderLineItemContact"
            }
         ],
         "place": {
            "id": "920cf6ac73d423002728660c4cf6a799",
            "@type": "Place"
         },
         "state": "new"
      }
   ],
   "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": "4f2af65ac3a030106e2473ce3640ddcf",
   "href": "/api/sn_tmf_api/order/serviceOrder/4f2af65ac3a030106e2473ce3640ddcf",
   "orderDate": "2024-06-20T10:38:55.000Z",
   "state": "new"
}

Demande cURL

L’exemple suivant met à jour une commande de service en configurant la serviceOrderItem.action propriété sur change.

curl "https://instance.service-now.com/api/sn_tmf_api/serviceorder" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
   "externalId": "BSS748",
   "requestedStartDate": "2018-01-15T09:37:40.508Z",
   "requestedCompletionDate": "2018-01-15T09:37:40.508Z",
   "@type": "ServiceOrder",
   "note": [
      {
         "text": "This is a TMF service order illustration"
      },
      {
         "text": "This is a TMF service order illustration no 2"
      }
   ],
   "serviceOrderItem": [
      {
         "id": "100",
         "action": "change",
         "actionReason":"change service package OLI",
         "@type": "ServiceOrderItem",
         "service": {
            "@type": "CFS",
            "serviceCharacteristic": [
               {
                  "name": "Firewall Security",
                  "value": "Premium",
                  "previousValue": "Standard"
               }
            ],
            "id": "4b5072aec3a83010abc8b5183c40dd42"
         },
         "relatedParty": [
            {
               "firstName": "Mike",
               "lastName": "Hudson",
               "email": "mike@example.com",
               "phone": "1234567890",
               "@type": "RelatedParty",
               "@referredType": "OrderLineItemContact"
            }
         ],
         "place": {
            "id": "920cf6ac73d423002728660c4cf6a799",
            "@type": "Place"
         }
      }
   ],
   "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"
        }
    ]
}" \
--user 'username':'password'

Corps de la réponse.

{
   "externalId": "BSS748",
   "requestedStartDate": "2018-01-15T09:37:40.508Z",
   "requestedCompletionDate": "2018-01-15T09:37:40.508Z",
   "@type": "ServiceOrder",
   "note": [
      {
         "text": "This is a TMF service order illustration"
      },
      {
         "text": "This is a TMF service order illustration no 2"
      }
   ],
   "serviceOrderItem": [
      {
         "id": "100",
         "action": "change",
         "actionReason":"change service package OLI",
         "@type": "ServiceOrderItem",
         "service": {
            "@type": "CFS",
            "serviceCharacteristic": [
               {
                  "name": "Firewall Security",
                  "value": "Premium",
                  "previousValue": "Standard"
               }
            ],
            "id": "4b5072aec3a83010abc8b5183c40dd42"
         },
         "relatedParty": [
            {
               "firstName": "Mike",
               "lastName": "Hudson",
               "email": "mike@example.com",
               "phone": "1234567890",
               "@type": "RelatedParty",
               "@referredType": "OrderLineItemContact"
            }
         ],
         "place": {
            "id": "920cf6ac73d423002728660c4cf6a799",
            "@type": "Place"
         },
         "state": "new"
      }
   ],
   "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": "4f2af65ac3a030106e2473ce3640ddcf",
   "href": "/api/sn_tmf_api/order/serviceOrder/4f2af65ac3a030106e2473ce3640ddcf",
   "orderDate": "2024-06-20T10:38:55.000Z",
   "state": "new"
}

Demande cURL

L’exemple suivant supprime un élément de ligne de commande de service en définissant la serviceOrderItem.action propriété sur supprimer.

curl "https://instance.service-now.com/api/sn_tmf_api/serviceorder" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
   "externalId": "BSS748",
   "requestedStartDate": "2018-01-15T09:37:40.508Z",
   "requestedCompletionDate": "2018-01-15T09:37:40.508Z",
   "@type": "ServiceOrder",
   "note": [
      {
         "text": "This is a TMF service order illustration"
      },
      {
         "text": "This is a TMF service order illustration no 2"
      }
   ],
   "serviceOrderItem": [
      {
         "id": "100",
         "action": "delete",
         "actionReason":"delete service package OLI",
         "@type": "ServiceOrderItem",
         "service": {
            "@type": "CFS",
            "serviceCharacteristic": [
               {
                  "name": "Firewall Security",
                  "value": "Premium",
                  "previousValue": "Standard"
               }
            ],
            "id": "4b5072aec3a83010abc8b5183c40dd42"
         },
         "relatedParty": [
            {
               "firstName": "Mike",
               "lastName": "Hudson",
               "email": "mike@example.com",
               "phone": "1234567890",
               "@type": "RelatedParty",
               "@referredType": "OrderLineItemContact"
            }
         ],
         "place": {
            "id": "920cf6ac73d423002728660c4cf6a799",
            "@type": "Place"
         }
      }
   ],
   "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"
        }
    ]
}" \
--user 'username':'password'

Corps de la réponse.

{
   "externalId": "BSS748",
   "requestedStartDate": "2018-01-15T09:37:40.508Z",
   "requestedCompletionDate": "2018-01-15T09:37:40.508Z",
   "@type": "ServiceOrder",
   "note": [
      {
         "text": "This is a TMF service order illustration"
      },
      {
         "text": "This is a TMF service order illustration no 2"
      }
   ],
   "serviceOrderItem": [
      {
         "id": "100",
         "action": "delete",
         "actionReason":"delete service package OLI",
         "@type": "ServiceOrderItem",
         "service": {
            "@type": "CFS",
            "serviceCharacteristic": [
               {
                  "name": "Firewall Security",
                  "value": "Premium",
                  "previousValue": "Standard"
               }
            ],
            "id": "4b5072aec3a83010abc8b5183c40dd42"
         },
         "relatedParty": [
            {
               "firstName": "Mike",
               "lastName": "Hudson",
               "email": "mike@example.com",
               "phone": "1234567890",
               "@type": "RelatedParty",
               "@referredType": "OrderLineItemContact"
            }
         ],
         "place": {
            "id": "920cf6ac73d423002728660c4cf6a799",
            "@type": "Place"
         },
         "state": "new"
      }
   ],
   "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": "4f2af65ac3a030106e2473ce3640ddcf",
   "href": "/api/sn_tmf_api/order/serviceOrder/4f2af65ac3a030106e2473ce3640ddcf",
   "orderDate": "2024-06-20T10:38:55.000Z",
   "state": "new"
}

API ouverte de commande de service : POST /sn_tmf_api/order/serviceOrder/outboundresponse

Met à jour l’état d’exécution pour les enregistrements de commande de domaine spécifiés dans la table des demandes sortantes [sn_tmt_core_outbound_request].

Pour utiliser cette méthode, la table Demande sortante doit contenir l’enregistrement de commande de domaine spécifié. En outre, la validation de méthode génère une erreur si les enregistrements ou les états spécifiés dans le corps de la demande ne se trouvent pas dans l’enregistrement sortant existant.

Remarque :

Vous ne pouvez pas créer de nouveaux enregistrements dans cette table à l’aide de ce point de terminaison.

Pour plus d’informations sur les commandes de domaines, reportez-vous à la section Order Management data model.

Format d'URL

/api/sn_tmf_api/order/serviceOrder/outboundresponse

Paramètres de demande pris en charge

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

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

Tableau 33. Paramètres du corps de la demande (JSON)
Nom	Description
externalId	Requis. Identificateur de demande sortante de l’enregistrement des commandes de domaine envoyé pour exécution. Type de données : chaîne Table : dans le champ request_id de la table Demande sortante [sn_tmt_core_outbound_request].
ÉlémentCommandeService	Requis. Liste des commandes de domaine dont l’état d’exécution externe doit être mis à jour. Type de données : tableau d’objets `"ServiceOrderItem": [ { "id": "String", "state": "String" } ]`
ServiceOrderItem.id	Requis. Sys_id d’un enregistrement de commande de domaine dont l’état d’exécution externe doit être mis à jour. Type de données : chaîne Table : Commande de domaine [sn_ind_tmt_orm_domain_order]
ServiceOrderItem.state	Requis. État d’exécution externe de la commande de domaine. Valeurs valides : erreur Remplies En attente Type de données : chaîne

En-têtes

Tableau 34. En-têtes de demandes
En-tête	Description
Accepter	Format de données du corps de la réponse. Prend uniquement en charge application/json.
Content-Type	Format de données du corps de la demande. Prend uniquement en charge application/json.

Tableau 35. 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 36. 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 : externalId est manquant` : Indique que l’ID externe (externalId) n’a pas été transmis. `Charge utile non valide : l’état serviceOrderItem est manquant :` Indique que l’état d’exécution externe (ServiceOrderItem.state) n’a pas été transmis dans une ou plusieurs commandes de domaine. `ID externe non valide. Veuillez transmettre l’ID` externe correct : Indique que l’ID externe transmis (externalId) n’est pas présent dans le système. `ID de commande de domaine non valide. Veuillez transmettre l’ID` de commande de domaine correct : Indique que l’ID de commande de domaine transmis (ServiceOrderItem.id) ne figure pas dans le système. `L’ID de commande de domaine transmis n’est pas associé à un ID externe` : indique que l’ID externe (externalId) n’est associé à aucune commande de domaine. Le système ne met à jour que les commandes de domaine associées à un ID externe transmis dans la charge utile. `État d’exécution non valide : veuillez fournir un état d’exécution correct` : indique que l’état d’exécution réussi (ServiceOrderItem.state) pour une ou plusieurs commandes de domaine n’est pas valide.
500	Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur.

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


Nom	Description
externalId	Identificateur de demande sortante de l’enregistrement des commandes de domaine envoyé pour exécution. Type de données : chaîne Table : dans le champ request_id de la table Demande sortante [sn_tmt_core_outbound_request].
href	Lien relatif vers l’enregistrement de ressource. Type de données : chaîne Valeur par défaut : chaîne vide
orderDate	Date et horodatage de la commande. Format : JJ-MM-AAAA HH :MM :SS Type de données : chaîne Valeur par défaut : chaîne vide
ÉlémentCommandeService	Liste des commandes de domaine dont l’état d’exécution externe doit être mis à jour. Type de données : tableau d’objets `"ServiceOrderItem": [ { "id": "String", "state": "String" } ]`
ServiceOrderItem.id	Sys_id d’un enregistrement de commande de domaine dont l’état d’exécution externe doit être mis à jour. Type de données : chaîne Table : Commande de domaine [sn_ind_tmt_orm_domain_order]
ServiceOrderItem.state	État d’exécution externe de la commande de domaine. Valeurs possibles : erreur Remplies En attente Type de données : chaîne

Demande cURL

L’exemple de code suivant montre comment appeler ce point de terminaison.

curl "http://instance.servicenow.com/api/sn_tmf_api/serviceorder/outboundresponse" \ 
--request POST \
--header "Accept:application/json" \
--data "{ 
  "externalId": "607017d243322110461f99612bb8f25c",
  "serviceOrderItem": [
    {
      "id": "19913c3577b301108e191e599a5a9988",
      "state": "error"
    }
  ]
}"
--user 'username':'password'

Réponse :

{
  "externalId": "607017d243322110461f99612bb8f25c",
  "serviceOrderItem": [
    {
      "id": "19913c3577b301108e191e599a5a9988",
      "state": "error"
    }
  ]
}