API Gestion des commandes de travaux

Rversion finale: Zurich

Mis à jour 31 juil. 2025

54 minutes de lecture

L’API Gestion des commandes de travaux fournit des points de terminaison pour créer, mettre à jour et récupérer des commandes de travaux.

Cette API est incluse dans l’application Telecommunication Open APIs, disponible à l’adresse .ServiceNow Store

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

L’utilisateur appelant doit avoir le rôle sn_tmf_api.work_order_integrator.

L’API Work Order Management est une ServiceNow implémentation de la spécification REST de l’API Work Order Management TM Forum. Cette implémentation est basée sur l’API TMF697 Work Order Management v5.0.

Gestion des commandes de travaux : obtenir /sn_tmf_api/work_order_management_api/workorder/{id}

Récupère une commande de travaux spécifiée à partir de la table Commande de travaux [wm_order].

Format d'URL

URL versionnée : /api/sn_tmf_api/{api_version}/work_order_management_api/workorder/{id}

URL par défaut : /api/sn_tmf_api/work_order_management_api/workorder/{id}

Paramètres de demande pris en charge

Tableau 1. Paramètres de chemin d'accès
Nom	Description
api_version	Facultatif. Version du point de terminaison auquel accéder. Par exemple, `v1` ou `v2`. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison différente de la dernière. Type de données : chaîne
id	Sys_id ou externalIdentifier de la commande de travaux. Table : commande de travaux [wm_order] Champ : Sys_id ou correlation_id Type de données : chaîne

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. Valeurs valides : @type catégorie Date d’achèvement description expectedCompletionDate href id initiatedFrom Priorité requestedCompletionDate requestedStartDate shortDescription startDate État numéro de commande de travail Par défaut : renvoie tous les champs. Type de données : chaîne

Tableau 3. Paramètres du corps de la demande (JSON)
Nom	Description
Aucun

En-têtes

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

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

Tableau 5. 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 6. Codes d'état
Code d'état	Description
200	Réussi. La demande a été correctement traitée.
400	Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté.
404	Introuvable. L’élément demandé est introuvable.

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


Nom	Description
@type	Cette valeur est toujours `WorkOrder`. Type de données : chaîne
catégorie	Catégorie de la commande de travaux qui peut être utilisée par un système de gestion des commandes, tel `qu’entreprise` ou `résidentiel`. Type de données : chaîne
Date d’achèvement	Date et heure auxquelles la commande de travaux a été terminée. Type de données : chaîne
description	Description de la commande de travaux. Type de données : chaîne
expectedCompletionDate	Date et heure d’achèvement prévues désignées par le fournisseur. Type de données : chaîne
identificateur externe	Liste de références externes telles que l’ID de fournisseur ou de corrélation. Type de données : tableau `"externalIdentifier": [ { "@type": "String", "id": "String" } ]`
externalIdentifier.@type	Cette valeur est toujours `ExternalIdentifierRef`. Type de données : chaîne
externalIdentifier.id	Référence externe telle que l’ID de fournisseur ou de corrélation. Type de données : chaîne
href	Lien relatif vers l’enregistrement de la commande de travaux. Type de données : chaîne
id	Sys_id de la commande de travaux. Table : commande de travaux [wm_order] Type de données : chaîne
initiatedFrom	ID de référence indiquant où la commande de travaux a été initiée. Par exemple, une tâche sys_id de la table Tâche de commande de travaux [wm_task]. Type de données : chaîne
remarque	Liste des notes relatives à la commande. Type de données : tableau `"note": [ { "@type": "String", "author": "String", "date": "String", "text": "String" } ]`
note.@type	Cette valeur est toujours `Remarque`. Type de données : chaîne
note.auteur	Auteur de la note. Type de données : chaîne
note.date	Date à laquelle la note a été ajoutée à la commande de travaux. Type de données : chaîne
note.text	Le texte de la note. Type de données : chaîne
lieu	Emplacement géographique associé à la commande de travaux. Type de données : objet `"place": { "@type": "String", "id": "String", "relatedParty": [Array] }`
place.@type	Cette valeur est toujours `GeographicSite`. Type de données : chaîne
place.id	Sys_id de l’emplacement. Table : Emplacement [cmn_location] Type de données : chaîne
lieu.relatedParty	Liste des groupes de support pour l’emplacement. Type de données : tableau `"relatedParty": [ { "@type": "String", "id": "String", "name": "String", "role": "String" } ]`
place.relatedParty.@type	Cette valeur est toujours `RelatedPartyRef`. Type de données : chaîne
place.relatedParty.id	Sys_id du groupe de support. Table : Groupe [sys_user_group] Type de données : chaîne
place.relatedParty.name	Nom du groupe de support. Type de données : chaîne
lieu.relatedParty.role	Rôle du groupe de support. Type de données : chaîne
Priorité	Classement des priorités pour la commande de travaux. Valeurs possibles : 1 – Critique 2 - Élevée 3 - Modéré 4 - Faible 5 – En préparation Type de données : chaîne
Fête connexe	Liste des contacts associés pour la commande de travaux. Type de données : tableau `"relatedParty": [ { "@type": "String", "id": "String", "name": "String", "role": "String" } ]`
relatedParty.@type	Cette valeur est toujours `RelatedPartyRef`. Type de données : chaîne
relatedParty.id	Sys_id de la partie liée. Table : compte [customer_account], société [core_company] ou utilisateur [sys_user] Type de données : chaîne
relatedParty.name	Nom de la partie liée. Type de données : chaîne
relatedParty.role	Rôle de la partie connexe. Valeurs possibles : Compte Société Consommateur Contact Type de données : chaîne
relatedProductOrder	Liste des commandes de produits pour la commande de travaux. Type de données : tableau `"relatedProductOrder": [ { "@type": "String", "id": "String" } ]`
relatedProductOrder.@type	Cette valeur est toujours `ProductOrderRef`. Type de données : chaîne
relatedProductOrder.id	Sys_id de la commande de produit. Table : Commande de produit [sn_ind_tmt_orm_product_order] Type de données : chaîne
requestedCompletionDate	Date et heure d’achèvement demandées. Type de données : chaîne
requestedStartDate	Date de début d’exécution de la commande désignée par le demandeur. Utilisé dans les cas où le demandeur ne peut pas autoriser le fournisseur à commencer le traitement avant une date spécifiée. Type de données : chaîne
shortDescription	Bref résumé de la commande de travaux. Type de données : chaîne
startDate	Date et heure de début de la commande. Type de données : chaîne
État	État de la commande de travaux. Valeurs possibles : Brouillon En attente de qualification Qualifié Affecté Travail en cours Terminé Type de données : chaîne
élément de commande de travail	Liste des tâches sous la commande de travaux. Type de données : tableau `"workOrderItem": [ { "@type": "String", "description": "String", "id": "String", "shortDescription": "String", "state": "String", "work": {Object} } ]`
workOrderItem.@type	Cette valeur est toujours `WorkOrderItem`. Type de données : chaîne
workOrderItem.description	Description de la tâche. Type de données : chaîne
workOrderItem.id	Sys_id de la tâche. Table : Tâche de commande de travaux [wm_task] Type de données : chaîne
workOrderItem.shortDescription	Brève description de la phase. Type de données : chaîne
workOrderItem.state	État de la tâche. Type de données : chaîne
workOrderItem.work	Description du travail requis pour la tâche. Type de données : objet `"work": { "@type": "String", "expectedCompletionDate": "String", "id": "String", "place": [Array], "relatedParty": [Array], "relatedWork": [Array], "scheduledStartDate": "String", "workforceEmployeeAssignment": [Array], "workPriority": "String", "workType": "String" }`
workOrderItem.work.@type	Cette valeur est toujours `WorkRefOrValue`. Type de données : chaîne
workOrderItem.work.expectedCompletionDate	Date d’achèvement attendue pour la tâche. Type de données : chaîne
workOrderItem.work.id	Sys_id du type de travail de la tâche. Table : Type de travail [wm_work_type] Type de données : chaîne
workOrderItem.work.place	Liste des emplacements géographiques associés à la tâche. `"place": [ { "@type": "String", "place": {Object}, "role": "String" } ]`
workOrderItem.work.place.@type	Cette valeur est toujours `RelatedPlaceRefOrValue`. Type de données : chaîne
workOrderItem.work.place.place	Détails sur l’emplacement. Type de données : objet `"place": { "@type": "String", "id": "String" }`
workOrderItem.work.place.place.@type	Cette valeur est toujours `GeographicSite`. Type de données : chaîne
workOrderItem.work.place.place.id	Sys_id de l’emplacement. Table : Emplacement [cmn_location] Type de données : chaîne
workOrderItem.work.place.role	Rôle de cet emplacement dans le contexte de la tâche. Type de données : chaîne
workOrderItem.work.relatedParty	Liste des groupes de support pour la tâche. Type de données : tableau `"relatedParty": [ { "@type": "String", "id": "String", "name": "String", "role": "String" } ]`
workOrderItem.work.relatedParty.@type	Cette valeur est toujours `RelatedPartyRef`. Type de données : chaîne
workOrderItem.work.relatedParty.id	Sys_id du groupe de support. Table : Groupe [sys_user_group] Type de données : chaîne
workOrderItem.work.relatedParty.name	Nom du groupe de support. Type de données : chaîne
workOrderItem.work.relatedParty.role	Rôle du groupe de support. Type de données : chaîne
workItemOrder.work.relatedWork	Liste des tâches de commande de travaux connexes. Type de données : tableau `"relatedWork": [ { "@type": "String", "id": "String" } ]`
workOrderItem.work.relatedWork.@type	Cette valeur est toujours `WorkRefOrValue`. Type de données : chaîne
workOrderItem.work.relatedWork.id	Sys_id de la tâche connexe. Table : Tâche de commande de travaux [wm_task] Type de données : chaîne
workOrderItem.work.scheduledStartDate	Date de début planifiée pour la tâche. Type de données : chaîne
workOrderItem.work.workforceEmployeeAssignment	Détails de l’affectation de la tâche. Type de données : tableau `"workforceEmployeeAssignment": [ { "@type":"String", "id": "String", "workforceEmployee": {Object} } ]`
workOrderItem.work.workforceEmployeeAssignment.@type	Cette valeur est toujours `WorkforceEmployeeAssignment`. Type de données : chaîne
workOrderItem.work.workforceEmployeeAssignment.id	Sys_id du groupe affecté à la tâche. Table : Groupe [sys_user_group] Type de données : chaîne
workOrderItem.work.workforceEmployeeAssignment.workforceEmployee	Détails sur l’employé affecté à la tâche. Type de données : objet `"workforceEmployee": { "@type": "String", "contactMedium": [Array], "id": "String", "name": "String" }`
workOrderItem.work.workforceEmployeeAssignment.workforceEmployee.@type	Cette valeur est toujours `Individuel`. Type de données : chaîne
workOrderItem.work.workforceEmployeeAssignment.workforceEmployee.contactMedium	Liste des numéros de téléphone de l’employé. Type de données : tableau `"contactMedium": [ { "@type": "String", "phoneNumber": "String" } ]`
workOrderItem.work.workforceEmployeeAssignment.workforceEmployee.contactMedium.@type	Cette valeur est toujours `PhoneContactMedium`. Type de données : chaîne
workOrderItem.work.workforceEmployeeAssignment.workforceEmployee.contactMedium.phoneNumber	Numéro de téléphone de l’employé. Type de données : chaîne
workOrderItem.work.workforceEmployeeAssignment.workforceEmployee.id	Sys_id de l’employé. Table : Utilisateur [sys_user] Type de données : chaîne
workOrderItem.work.workforceEmployeeAssignment.workforceEmployee.name	Nom de l’employé. Type de données : chaîne
workOrderItem.work.workPriority	Classement des priorités pour la tâche. Valeurs possibles : 1 – Critique 2 - Élevée 3 - Modéré 4 - Faible 5 – En préparation Type de données : chaîne
workOrderItem.work.workType	Type de travail pour la tâche. Table : Type de travail [wm_work_type] Champ : Nom Type de données : chaîne
numéro de commande de travail	Identificateur unique de la commande de travaux, tel que WO0008004. Table : commande de travaux [wm_order] Champ : Numéro Type de données : chaîne
relation de commande de travail	Liste des relations de tâches avec la commande de travaux. Type de données : tableau `"workOrderRelationship": [ { "@type": "String", "id": "String", "relationshipType": "String" } ]`
workOrderRelationship.@type	Cette valeur est toujours `OrderRelationship`. Type de données : chaîne
workOrderRelationship.id	Sys_id de la relation des tâches. Table : Relation de tâche [task_rel_task] Type de données : chaîne
workOrderRelationship.relationshipType	Type de relation de tâche. Type de données : chaîne

Demande cURL

Récupère l’ordre de travail spécifié.

curl "https://instance.servicenow.com/api/sn_tmf_api/work_order_management_api/workorder/27e756a1df113100dca6a5f59bf263da" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

Corps de la réponse.

{
   "@type": "WorkOrder",
   "href": "api/sn_tmf_api/workordermanagement/workorder/6d22c6f0ff0de650f8dfffffffffff98",
   "workOrderNumber": "WO0008004",
   "id": "6d22c6f0ff0de650f8dfffffffffff98",
   "category": "test",
   "shortDescription": "Test-Test",
   "description": "Test",
   "startDate": "",
   "requestedCompletionDate": "2025-04-19 07:17:04",
   "requestedStartDate": "",
   "state": "Awaiting Qualification",
   "priority": "4 - Low",
   "initiatedFrom": "",
   "completionDate": "",
   "expectedCompletionDate": "",
   "place": {
      "@type": "GeographicSite",
      "id": "920cf6ac73d423002728660c4cf6a799",
      "relatedParty": [
         {
            "@type": "RelatedPartyRef",
            "id": "320ee92637232000158bbfc8bcbe5d40",
            "name": "East Qualifiers",
            "role": "QualificationGroup"
         }
      ]
   },
   "relatedParty": [
      {
         "@type": "RelatedPartyRef",
         "id": "5408091a3b100300e81d47b334efc452",
         "name": "Ashley Parker",
         "role": "Contact"
      },
      {
         "@type": "RelatedPartyRef",
         "id": "",
         "name": "",
         "role": "Account"
      },
      {
         "@type": "RelatedPartyRef",
         "id": "",
         "name": "",
         "role": "Consumer"
      },
      {
         "@type": "RelatedPartyRef",
         "id": "820351a1c0a8018b67c73d51c074097c",
         "name": "Acer",
         "role": "Company"
      }
   ],
   "appointment": {},
   "relatedProductOrder": [
      {
         "@type": "ProductOrderRef",
         "id": "19f5456dff092a50f8dfffffffffff01"
      },
      {
         "@type": "ProductOrderRef",
         "id": "7116456dff092a50f8dfffffffffff6e"
      }
   ],
   "externalIdentifier": [
      {
         "@type": "ExternalIdentifierRef",
         "id": "r6879"
      }
   ],
   "workOrderItem": [
      {
         "@type": "WorkOrderItem",
         "id": "2fa566fdff456a50f8dfffffffffffc6",
         "shortDescription": "abc",
         "description": "",
         "state": "Draft",
         "work": {
            "@type": "WorkRefOrValue",
            "id": "2fa566fdff456a50f8dfffffffffffc6",
            "workType": "",
            "scheduledStartDate": "",
            "expectedCompletionDate": "",
            "workPriority": "4 - Low",
            "place": [
               {
                  "@type": "RelatedPlaceRefOrValue",
                  "role": "string",
                  "place": {
                     "@type": "GeographicSite",
                     "id": "25ab8dcd0a0a0bb300bd8a8899934d72"
                  }
               }
            ],
            "relatedWork": [
               {
                  "@type": "WorkRefOrValue",
                  "id": "bb420af0ff0de650f8dfffffffffff4a"
               },
               {
                  "@type": "WorkRefOrValue",
                  "id": "c301e379ff096a50f8dfffffffffff43"
               }
            ],
            "relatedParty": [],
            "workforceEmployeeAssignment": []
         }
      },
      {
         "@type": "WorkOrderItem",
         "id": "bb420af0ff0de650f8dfffffffffff4a",
         "shortDescription": "Test",
         "description": "",
         "state": "Draft",
         "work": {
            "@type": "WorkRefOrValue",
            "id": "bb420af0ff0de650f8dfffffffffff4a",
            "workType": "38f719ec3b8a10103f09080044efc4cd",
            "scheduledStartDate": "",
            "expectedCompletionDate": "",
            "workPriority": "4 - Low",
            "place": [
               {
                  "@type": "RelatedPlaceRefOrValue",
                  "role": "string",
                  "place": {
                     "@type": "GeographicSite",
                     "id": "920cf6ac73d423002728660c4cf6a799"
                  }
               }
            ],
            "relatedWork": [
               {
                  "@type": "WorkRefOrValue",
                  "id": "2fa566fdff456a50f8dfffffffffffc6"
               },
               {
                  "@type": "WorkRefOrValue",
                  "id": "c301e379ff096a50f8dfffffffffff43"
               }
            ],
            "relatedParty": [],
            "workforceEmployeeAssignment": []
         }
      },
      {
         "@type": "WorkOrderItem",
         "id": "c301e379ff096a50f8dfffffffffff43",
         "shortDescription": "hi",
         "description": "",
         "state": "Draft",
         "work": {
            "@type": "WorkRefOrValue",
            "id": "c301e379ff096a50f8dfffffffffff43",
            "workType": "",
            "scheduledStartDate": "",
            "expectedCompletionDate": "",
            "workPriority": "4 - Low",
            "place": [
               {
                  "@type": "RelatedPlaceRefOrValue",
                  "role": "string",
                  "place": {
                     "@type": "GeographicSite",
                     "id": "6808184aeb211100420124e05206fe12"
                  }
               }
            ],
            "relatedWork": [
               {
                  "@type": "WorkRefOrValue",
                  "id": "2fa566fdff456a50f8dfffffffffffc6"
               },
               {
                  "@type": "WorkRefOrValue",
                  "id": "bb420af0ff0de650f8dfffffffffff4a"
               }
            ],
            "relatedParty": [],
            "workforceEmployeeAssignment": []
         }
      }
   ],
   "workOrderRelationship": [
      {
         "@type": "OrderRelationship",
         "id": "02016b46ffcd6a50f8dfffffffffff31",
         "relationshipType": "Contains::Task of"
      },
      {
         "@type": "OrderRelationship",
         "id": "0e016b46ffcd6a50f8dfffffffffff30",
         "relationshipType": "Contains::Task of"
      },
      {
         "@type": "OrderRelationship",
         "id": "66da174eff8d6a50f8dfffffffffffda",
         "relationshipType": "Contains::Task of"
      },
      {
         "@type": "OrderRelationship",
         "id": "aada174eff8d6a50f8dfffffffffffd9",
         "relationshipType": "Contains::Task of"
      },
      {
         "@type": "OrderRelationship",
         "id": "bd20e706ffcd6a50f8dfffffffffffc6",
         "relationshipType": "Contains::Task of"
      },
      {
         "@type": "OrderRelationship",
         "id": "c2016b46ffcd6a50f8dfffffffffff31",
         "relationshipType": "Contains::Task of"
      }
   ],
   "note": [
      {
         "@type": "Note",
         "author": "System Administrator",
         "date": "2025-04-23",
         "text": "This is a note."
      }
   ]
}

Gestion des commandes de travaux : GET /sn_tmf_api/work_order_management_api/workordermanagement

Récupère une liste de toutes les commandes de travaux à partir de la table Commande de travaux [wm_order].

Format d'URL

URL versionnée : /api/sn_tmf_api/{api_version}/work_order_management_api/workordermanagement

URL par défaut : /api/sn_tmf_api/work_order_management_api/workordermanagement

Paramètres de demande pris en charge

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

Tableau 8. Paramètres de requête
Nom	Description
champs	Liste des champs à renvoyer dans la réponse. Les champs non valides sont ignorés. Valeurs valides : @type catégorie Date d’achèvement description expectedCompletionDate href id initiatedFrom Priorité requestedCompletionDate requestedStartDate shortDescription startDate État numéro de commande de travail Par défaut : renvoie tous les champs. Type de données : chaîne
id	Sys_ids à utiliser pour filtrer les commandes de travaux. Seules les commandes de travaux correspondant aux sys_ids spécifiés sont renvoyées dans la réponse. Table : commande de travaux [wm_order] Type de données : chaîne
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. Par défaut : 20 Type de données : nombre
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. Par défaut : 0 Type de données : nombre

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

En-têtes

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

Tableau 11. 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.
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 12. Codes d'état
Code d'état	Description
200	Réussi. La demande a été correctement traitée.
206	Contenu partiel. La demande a été traitée avec succès et a renvoyé une plage partielle de contenu spécifiée par un appel paginé.
400	Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté.
404	Introuvable. L’élément demandé est introuvable.

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


Nom	Description
@type	Cette valeur est toujours `WorkOrder`. Type de données : chaîne
catégorie	Catégorie de la commande de travaux qui peut être utilisée par un système de gestion des commandes, tel `qu’entreprise` ou `résidentiel`. Type de données : chaîne
Date d’achèvement	Date et heure auxquelles la commande de travaux a été terminée. Type de données : chaîne
description	Description de la commande de travaux. Type de données : chaîne
expectedCompletionDate	Date et heure d’achèvement prévues désignées par le fournisseur. Type de données : chaîne
identificateur externe	Liste de références externes telles que l’ID de fournisseur ou de corrélation. Type de données : tableau `"externalIdentifier": [ { "@type": "String", "id": "String" } ]`
externalIdentifier.@type	Cette valeur est toujours `ExternalIdentifierRef`. Type de données : chaîne
externalIdentifier.id	Référence externe telle que l’ID de fournisseur ou de corrélation. Type de données : chaîne
href	Lien relatif vers l’enregistrement de la commande de travaux. Type de données : chaîne
id	Sys_id de la commande de travaux. Table : commande de travaux [wm_order] Type de données : chaîne
initiatedFrom	ID de référence indiquant où la commande de travaux a été initiée. Par exemple, une tâche sys_id de la table Tâche de commande de travaux [wm_task]. Type de données : chaîne
remarque	Liste des notes relatives à la commande. Type de données : tableau `"note": [ { "@type": "String", "author": "String", "date": "String", "text": "String" } ]`
note.@type	Cette valeur est toujours `Remarque`. Type de données : chaîne
note.auteur	Auteur de la note. Type de données : chaîne
note.date	Date à laquelle la note a été ajoutée à la commande de travaux. Type de données : chaîne
note.text	Le texte de la note. Type de données : chaîne
lieu	Emplacement géographique associé à la commande de travaux. Type de données : objet `"place": { "@type": "String", "id": "String", "relatedParty": [Array] }`
place.@type	Cette valeur est toujours `GeographicSite`. Type de données : chaîne
place.id	Sys_id de l’emplacement. Table : Emplacement [cmn_location] Type de données : chaîne
lieu.relatedParty	Liste des groupes de support pour l’emplacement. Type de données : tableau `"relatedParty": [ { "@type": "String", "id": "String", "name": "String", "role": "String" } ]`
place.relatedParty.@type	Cette valeur est toujours `RelatedPartyRef`. Type de données : chaîne
place.relatedParty.id	Sys_id du groupe de support. Table : Groupe [sys_user_group] Type de données : chaîne
place.relatedParty.name	Nom du groupe de support. Type de données : chaîne
lieu.relatedParty.role	Rôle du groupe de support. Type de données : chaîne
Priorité	Classement des priorités pour la commande de travaux. Valeurs possibles : 1 – Critique 2 - Élevée 3 - Modéré 4 - Faible 5 – En préparation Type de données : chaîne
Fête connexe	Liste des contacts associés pour la commande de travaux. Type de données : tableau `"relatedParty": [ { "@type": "String", "id": "String", "name": "String", "role": "String" } ]`
relatedParty.@type	Cette valeur est toujours `RelatedPartyRef`. Type de données : chaîne
relatedParty.id	Sys_id de la partie liée. Table : compte [customer_account], société [core_company] ou utilisateur [sys_user] Type de données : chaîne
relatedParty.name	Nom de la partie liée. Type de données : chaîne
relatedParty.role	Rôle de la partie connexe. Valeurs possibles : Compte Société Consommateur Contact Type de données : chaîne
relatedProductOrder	Liste des commandes de produits pour la commande de travaux. Type de données : tableau `"relatedProductOrder": [ { "@type": "String", "id": "String" } ]`
relatedProductOrder.@type	Cette valeur est toujours `ProductOrderRef`. Type de données : chaîne
relatedProductOrder.id	Sys_id de la commande de produit. Table : Commande de produit [sn_ind_tmt_orm_product_order] Type de données : chaîne
requestedCompletionDate	Date et heure d’achèvement demandées. Type de données : chaîne
requestedStartDate	Date de début d’exécution de la commande désignée par le demandeur. Utilisé dans les cas où le demandeur ne peut pas autoriser le fournisseur à commencer le traitement avant une date spécifiée. Type de données : chaîne
shortDescription	Bref résumé de la commande de travaux. Type de données : chaîne
startDate	Date et heure de début de la commande. Type de données : chaîne
État	État de la commande de travaux. Valeurs possibles : Brouillon En attente de qualification Qualifié Affecté Travail en cours Terminé Type de données : chaîne
élément de commande de travail	Liste des tâches sous la commande de travaux. Type de données : tableau `"workOrderItem": [ { "@type": "String", "description": "String", "id": "String", "shortDescription": "String", "state": "String", "work": {Object} } ]`
workOrderItem.@type	Cette valeur est toujours `WorkOrderItem`. Type de données : chaîne
workOrderItem.description	Description de la tâche. Type de données : chaîne
workOrderItem.id	Sys_id de la tâche. Table : Tâche de commande de travaux [wm_task] Type de données : chaîne
workOrderItem.shortDescription	Brève description de la phase. Type de données : chaîne
workOrderItem.state	État de la tâche. Type de données : chaîne
workOrderItem.work	Description du travail requis pour la tâche. Type de données : objet `"work": { "@type": "String", "expectedCompletionDate": "String", "id": "String", "place": [Array], "relatedParty": [Array], "relatedWork": [Array], "scheduledStartDate": "String", "workforceEmployeeAssignment": [Array], "workPriority": "String", "workType": "String" }`
élément de commande de travail.work.@type	Cette valeur est toujours `WorkRefOrValue`. Type de données : chaîne
workOrderItem.work.expectedCompletionDate	Date d’achèvement attendue pour la tâche. Type de données : chaîne
workOrderItem.work.id	Sys_id du type de travail de la tâche. Table : Type de travail [wm_work_type] Type de données : chaîne
workOrderItem.work.place	Liste des emplacements géographiques associés à la tâche. `"place": [ { "@type": "String", "place": {Object}, "role": "String" } ]`
workOrderItem.work.place.@type	Cette valeur est toujours `RelatedPlaceRefOrValue`. Type de données : chaîne
workOrderItem.work.place.place	Détails sur l’emplacement. Type de données : objet `"place": { "@type": "String", "id": "String" }`
workOrderItem.work.place.place.@type	Cette valeur est toujours `GeographicSite`. Type de données : chaîne
workOrderItem.work.place.place.id	Sys_id de l’emplacement. Table : Emplacement [cmn_location] Type de données : chaîne
workOrderItem.work.place.role	Rôle de cet emplacement dans le contexte de la tâche. Type de données : chaîne
workOrderItem.work.relatedParty	Liste des groupes de support pour la tâche. Type de données : tableau `"relatedParty": [ { "@type": "String", "id": "String", "name": "String", "role": "String" } ]`
workOrderItem.work.relatedParty.@type	Cette valeur est toujours `RelatedPartyRef`. Type de données : chaîne
workOrderItem.work.relatedParty.id	Sys_id du groupe de support. Table : Groupe [sys_user_group] Type de données : chaîne
workOrderItem.work.relatedParty.name	Nom du groupe de support. Type de données : chaîne
workOrderItem.work.relatedParty.role	Rôle du groupe de support. Type de données : chaîne
workItemOrder.work.relatedWork	Liste des tâches de commande de travaux connexes. Type de données : tableau `"relatedWork": [ { "@type": "String", "id": "String" } ]`
workOrderItem.work.relatedWork.@type	Cette valeur est toujours `WorkRefOrValue`. Type de données : chaîne
workOrderItem.work.relatedWork.id	Sys_id de la tâche connexe. Table : Tâche de commande de travaux [wm_task] Type de données : chaîne
workOrderItem.work.scheduledStartDate	Date de début planifiée pour la tâche. Type de données : chaîne
workOrderItem.work.workforceEmployeeAssignment	Détails de l’affectation de la tâche. Type de données : tableau `"workforceEmployeeAssignment": [ { "@type":"String", "id": "String", "workforceEmployee": {Object} } ]`
workOrderItem.work.workforceEmployeeAssignment.@type	Cette valeur est toujours `WorkforceEmployeeAssignment`. Type de données : chaîne
workOrderItem.work.workforceEmployeeAssignment.id	Sys_id du groupe affecté à la tâche. Table : Groupe [sys_user_group] Type de données : chaîne
workOrderItem.work.workforceEmployeeAssignment.workforceEmployee	Détails sur l’employé affecté à la tâche. Type de données : objet `"workforceEmployee": { "@type": "String", "contactMedium": [Array], "id": "String", "name": "String" }`
workOrderItem.work.workforceEmployeeAssignment.workforceEmployee.@type	Cette valeur est toujours `Individuel`. Type de données : chaîne
workOrderItem.work.workforceEmployeeAssignment.workforceEmployee.contactMedium	Liste des numéros de téléphone de l’employé. Type de données : tableau `"contactMedium": [ { "@type": "String", "phoneNumber": "String" } ]`
workOrderItem.work.workforceEmployeeAssignment.workforceEmployee.contactMedium.@type	Cette valeur est toujours `PhoneContactMedium`. Type de données : chaîne
workOrderItem.work.workforceEmployeeAssignment.workforceEmployee.contactMedium.phoneNumber	Numéro de téléphone de l’employé. Type de données : chaîne
workOrderItem.work.workforceEmployeeAssignment.workforceEmployee.id	Sys_id de l’employé. Table : Utilisateur [sys_user] Type de données : chaîne
workOrderItem.work.workforceEmployeeAssignment.workforceEmployee.name	Nom de l’employé. Type de données : chaîne
workOrderItem.work.workPriority	Classement des priorités pour la tâche. Valeurs possibles : 1 – Critique 2 - Élevée 3 - Modéré 4 - Faible 5 – En préparation Type de données : chaîne
workOrderItem.work.workType	Type de travail pour la tâche. Table : Type de travail [wm_work_type] Champ : Nom Type de données : chaîne
numéro de commande de travail	Identificateur unique de la commande de travaux, tel que WO0008004. Table : commande de travaux [wm_order] Champ : Numéro Type de données : chaîne
relation de commande de travail	Liste des relations de tâches avec la commande de travaux. Type de données : tableau `"workOrderRelationship": [ { "@type": "String", "id": "String", "relationshipType": "String" } ]`
workOrderRelationship.@type	Cette valeur est toujours `OrderRelationship`. Type de données : chaîne
workOrderRelationship.id	Sys_id de la relation des tâches. Table : Relation de tâche [task_rel_task] Type de données : chaîne
workOrderRelationship.relationshipType	Type de relation de tâche. Type de données : chaîne

Demande cURL

Récupère la première page des commandes de travaux.

curl "https://instance.servicenow.com/api/sn_tmf_api/work_order_management_api/workordermanagement" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

Corps de la réponse.

[{
   "@type": "WorkOrder",
   "href": "api/sn_tmf_api/workordermanagement/workorder/6d22c6f0ff0de650f8dfffffffffff98",
   "workOrderNumber": "WO0008004",
   "id": "6d22c6f0ff0de650f8dfffffffffff98",
   "category": "test",
   "shortDescription": "Test-Test",
   "description": "Test",
   "startDate": "",
   "requestedCompletionDate": "2025-04-19 07:17:04",
   "requestedStartDate": "",
   "state": "Awaiting Qualification",
   "priority": "4 - Low",
   "initiatedFrom": "",
   "completionDate": "",
   "expectedCompletionDate": "",
   "place": {
      "@type": "GeographicSite",
      "id": "920cf6ac73d423002728660c4cf6a799",
      "relatedParty": [
         {
            "@type": "RelatedPartyRef",
            "id": "320ee92637232000158bbfc8bcbe5d40",
            "name": "East Qualifiers",
            "role": "QualificationGroup"
         }
      ]
   },
   "relatedParty": [
      {
         "@type": "RelatedPartyRef",
         "id": "5408091a3b100300e81d47b334efc452",
         "name": "Ashley Parker",
         "role": "Contact"
      },
      {
         "@type": "RelatedPartyRef",
         "id": "",
         "name": "",
         "role": "Account"
      },
      {
         "@type": "RelatedPartyRef",
         "id": "",
         "name": "",
         "role": "Consumer"
      },
      {
         "@type": "RelatedPartyRef",
         "id": "820351a1c0a8018b67c73d51c074097c",
         "name": "Acer",
         "role": "Company"
      }
   ],
   "appointment": {},
   "relatedProductOrder": [
      {
         "@type": "ProductOrderRef",
         "id": "19f5456dff092a50f8dfffffffffff01"
      },
      {
         "@type": "ProductOrderRef",
         "id": "7116456dff092a50f8dfffffffffff6e"
      }
   ],
   "externalIdentifier": [
      {
         "@type": "ExternalIdentifierRef",
         "id": "r6879"
      }
   ],
   "workOrderItem": [
      {
         "@type": "WorkOrderItem",
         "id": "2fa566fdff456a50f8dfffffffffffc6",
         "shortDescription": "abc",
         "description": "",
         "state": "Draft",
         "work": {
            "@type": "WorkRefOrValue",
            "id": "2fa566fdff456a50f8dfffffffffffc6",
            "workType": "",
            "scheduledStartDate": "",
            "expectedCompletionDate": "",
            "workPriority": "4 - Low",
            "place": [
               {
                  "@type": "RelatedPlaceRefOrValue",
                  "role": "string",
                  "place": {
                     "@type": "GeographicSite",
                     "id": "25ab8dcd0a0a0bb300bd8a8899934d72"
                  }
               }
            ],
            "relatedWork": [
               {
                  "@type": "WorkRefOrValue",
                  "id": "bb420af0ff0de650f8dfffffffffff4a"
               },
               {
                  "@type": "WorkRefOrValue",
                  "id": "c301e379ff096a50f8dfffffffffff43"
               }
            ],
            "relatedParty": [],
            "workforceEmployeeAssignment": []
         }
      },
      {
         "@type": "WorkOrderItem",
         "id": "bb420af0ff0de650f8dfffffffffff4a",
         "shortDescription": "Test",
         "description": "",
         "state": "Draft",
         "work": {
            "@type": "WorkRefOrValue",
            "id": "bb420af0ff0de650f8dfffffffffff4a",
            "workType": "38f719ec3b8a10103f09080044efc4cd",
            "scheduledStartDate": "",
            "expectedCompletionDate": "",
            "workPriority": "4 - Low",
            "place": [
               {
                  "@type": "RelatedPlaceRefOrValue",
                  "role": "string",
                  "place": {
                     "@type": "GeographicSite",
                     "id": "920cf6ac73d423002728660c4cf6a799"
                  }
               }
            ],
            "relatedWork": [
               {
                  "@type": "WorkRefOrValue",
                  "id": "2fa566fdff456a50f8dfffffffffffc6"
               },
               {
                  "@type": "WorkRefOrValue",
                  "id": "c301e379ff096a50f8dfffffffffff43"
               }
            ],
            "relatedParty": [],
            "workforceEmployeeAssignment": []
         }
      },
      {
         "@type": "WorkOrderItem",
         "id": "c301e379ff096a50f8dfffffffffff43",
         "shortDescription": "hi",
         "description": "",
         "state": "Draft",
         "work": {
            "@type": "WorkRefOrValue",
            "id": "c301e379ff096a50f8dfffffffffff43",
            "workType": "",
            "scheduledStartDate": "",
            "expectedCompletionDate": "",
            "workPriority": "4 - Low",
            "place": [
               {
                  "@type": "RelatedPlaceRefOrValue",
                  "role": "string",
                  "place": {
                     "@type": "GeographicSite",
                     "id": "6808184aeb211100420124e05206fe12"
                  }
               }
            ],
            "relatedWork": [
               {
                  "@type": "WorkRefOrValue",
                  "id": "2fa566fdff456a50f8dfffffffffffc6"
               },
               {
                  "@type": "WorkRefOrValue",
                  "id": "bb420af0ff0de650f8dfffffffffff4a"
               }
            ],
            "relatedParty": [],
            "workforceEmployeeAssignment": []
         }
      }
   ],
   "workOrderRelationship": [
      {
         "@type": "OrderRelationship",
         "id": "02016b46ffcd6a50f8dfffffffffff31",
         "relationshipType": "Contains::Task of"
      },
      {
         "@type": "OrderRelationship",
         "id": "0e016b46ffcd6a50f8dfffffffffff30",
         "relationshipType": "Contains::Task of"
      },
      {
         "@type": "OrderRelationship",
         "id": "66da174eff8d6a50f8dfffffffffffda",
         "relationshipType": "Contains::Task of"
      },
      {
         "@type": "OrderRelationship",
         "id": "aada174eff8d6a50f8dfffffffffffd9",
         "relationshipType": "Contains::Task of"
      },
      {
         "@type": "OrderRelationship",
         "id": "bd20e706ffcd6a50f8dfffffffffffc6",
         "relationshipType": "Contains::Task of"
      },
      {
         "@type": "OrderRelationship",
         "id": "c2016b46ffcd6a50f8dfffffffffff31",
         "relationshipType": "Contains::Task of"
      }
   ],
   "note": [
      {
         "@type": "Note",
         "author": "System Administrator",
         "date": "2025-04-23",
         "text": "This is a note."
      }
   ]
}]

Gestion des commandes de travaux : PATCH /sn_tmf_api/work_order_management_api/workOrder/{id}

Met à jour une commande de travaux et les tâches associées.

L’enregistrement de l’ordre de travail est mis à jour dans la table Ordre de travail [wm_order]. Les enregistrements de tâches sont mis à jour dans la table Tâche de commande de travaux [wm_task].

Format d'URL

URL versionnée : /api/sn_tmf_api/{api_version}/work_order_management_api/workOrder/{id}

URL par défaut : /api/sn_tmf_api/work_order_management_api/workOrder/{id}

Paramètres de demande pris en charge

Tableau 13. Paramètres de chemin d'accès
Nom	Description
api_version	Facultatif. Version du point de terminaison auquel accéder. Par exemple, `v1` ou `v2`. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison différente de la dernière. Type de données : chaîne
id	Sys_id de la commande de travaux. Table : commande de travaux [wm_order] Type de données : chaîne

Tableau 14. Paramètres de requête
Nom	Description
Aucun

Tableau 15. Paramètres du corps de la demande (JSON)
Nom	Description
@type	Cette valeur est toujours `WorkOrder`. Type de données : chaîne
Date d’achèvement	Date et heure auxquelles la commande de travaux a été terminée. Type de données : chaîne
description	Description de la commande de travaux. Type de données : chaîne
expectedCompletionDate	Date et heure d’achèvement prévues désignées par le fournisseur. Type de données : chaîne
identificateur externe	Liste de références externes telles que l’ID de fournisseur ou de corrélation. Type de données : tableau `"externalIdentifier": [ { "@type": "String", "id": "String" } ]`
externalIdentifier.@type	Cette valeur est toujours `ExternalIdentifierRef`. Type de données : chaîne
externalIdentifier.id	Référence externe telle que l’ID de fournisseur ou de corrélation. Type de données : chaîne
href	Lien relatif vers l’enregistrement de la commande de travaux. Type de données : chaîne
id	Sys_id de la commande de travaux. Table : commande de travaux [wm_order] Type de données : chaîne
initiatedFrom	ID de référence indiquant où la commande de travaux a été initiée. Par exemple, une tâche sys_id de la table Tâche de commande de travaux [wm_task]. Type de données : chaîne
remarque	Liste des notes relatives à la commande. Type de données : tableau `"note": [ { "@type": "String", "author": "String", "date": "String", "text": "String" } ]`
note.@type	Cette valeur est toujours `Remarque`. Type de données : chaîne
note.auteur	Auteur de la note. Type de données : chaîne
note.date	Date à laquelle la note a été ajoutée à la commande de travaux. Type de données : chaîne
note.text	Le texte de la note. Type de données : chaîne
lieu	Emplacement géographique associé à la commande de travaux. Type de données : objet `"place": { "@type": "String", "id": "String", "relatedParty": [Array] }`
place.@type	Cette valeur est toujours `GeographicSite`. Type de données : chaîne
place.id	Sys_id de l’emplacement. Table : Emplacement [cmn_location] Type de données : chaîne
lieu.relatedParty	Liste des groupes de support pour l’emplacement. Type de données : tableau `"relatedParty": [ { "@type": "String", "id": "String", "name": "String", "role": "String" } ]`
place.relatedParty.@type	Cette valeur est toujours `RelatedPartyRef`. Type de données : chaîne
place.relatedParty.id	Sys_id du groupe de support. Table : Groupe [sys_user_group] Type de données : chaîne
place.relatedParty.name	Nom du groupe de support. Type de données : chaîne
lieu.relatedParty.role	Rôle du groupe de support. Type de données : chaîne
Priorité	Classement des priorités pour la commande de travaux. Valeurs possibles : 1 – Critique 2 - Élevée 3 - Modéré 4 - Faible 5 – En préparation Type de données : chaîne
Fête connexe	Liste des contacts associés pour la commande de travaux. Type de données : tableau `"relatedParty": [ { "@type": "String", "id": "String", "name": "String", "role": "String" } ]`
relatedParty.@type	Cette valeur est toujours `RelatedPartyRef`. Type de données : chaîne
relatedParty.id	Sys_id de la partie liée. Table : compte [customer_account], société [core_company] ou utilisateur [sys_user] Type de données : chaîne
relatedParty.name	Nom de la partie liée. Type de données : chaîne
relatedParty.role	Rôle de la partie connexe. Valeurs possibles : Compte Société Consommateur Contact Type de données : chaîne
requestedCompletionDate	Date et heure d’achèvement demandées. Type de données : chaîne
requestedStartDate	Date de début d’exécution de la commande désignée par le demandeur. Utilisé dans les cas où le demandeur ne peut pas autoriser le fournisseur à commencer le traitement avant une date spécifiée. Type de données : chaîne
shortDescription	Bref résumé de la commande de travaux. Type de données : chaîne
startDate	Date et heure de début de la commande. Type de données : chaîne
État	État de la commande de travaux. Valeurs possibles : Brouillon En attente de qualification Qualifié Affecté Travail en cours Terminé Type de données : chaîne
ID de modèle	Sys_id du modèle à utiliser pour la commande de travaux. Table : Modèle de produit [cmdb_model] Type de données : chaîne
élément de commande de travail	Liste des tâches sous la commande de travaux. Type de données : tableau `"workOrderItem": [ { "@type": "String", "action": "String", "completionDate": "String", "description": "String", "id": "String", "note": {Object}, "shortDescription": "String", "state": "String", "work": {Object} } ]`
workOrderItem.@type	Cette valeur est toujours `WorkOrderItem`. Type de données : chaîne
workOrderItem.action	Action à effectuer sur le produit pour la tâche. Valeurs possibles : ajouter supprimer modify noChange Type de données : chaîne
workOrderItem.completionDate	Date et heure de fin de la tâche. Type de données : chaîne
workOrderItem.description	Description de la tâche. Type de données : chaîne
workOrderItem.id	Sys_id de la tâche. Table : Tâche de commande de travaux [wm_task] Type de données : chaîne
workOrderItem.note	Liste des notes relatives à la tâche. Type de données : tableau `"note": [ { "@type": "String", "author": "String", "date": "String", "text": "String" } ]`
workOrderItem.note.@type	Cette valeur est toujours `Remarque`. Type de données : chaîne
workOrderItem.note.author	Auteur de la note. Type de données : chaîne
workOrderItem.note.date	Date à laquelle la note a été ajoutée à la tâche. Type de données : chaîne
workOrderItem.note.text	Le texte de la note. Type de données : chaîne
workOrderItem.shortDescription	Brève description de la phase. Type de données : chaîne
workOrderItem.state	État de la tâche. Type de données : chaîne
workOrderItem.work	Description du travail requis pour la tâche. Type de données : objet `"work": { "@type": "String", "expectedCompletionDate": "String", "id": "String", "place": [Array], "relatedParty": [Array], "scheduledStartDate": "String", "workforceEmployeeAssignment": [Array], "workPriority": "String", "workType": "String" }`
workOrderItem.work.@type	Cette valeur est toujours `WorkRefOrValue`. Type de données : chaîne
workOrderItem.work.expectedCompletionDate	Date d’achèvement attendue pour la tâche. Type de données : chaîne
workOrderItem.work.id	Sys_id du type de travail de la tâche. Table : Type de travail [wm_work_type] Type de données : chaîne
workOrderItem.work.place	Liste des emplacements géographiques associés à la tâche. `"place": [ { "@type": "String", "place": {Object}, "role": "String" } ]`
workOrderItem.work.place.@type	Cette valeur est toujours `RelatedPlaceRefOrValue`. Type de données : chaîne
workOrderItem.work.place.place	Détails sur l’emplacement. Type de données : objet `"place": { "@type": "String", "id": "String" }`
workOrderItem.work.place.place.@type	Cette valeur est toujours `GeographicSite`. Type de données : chaîne
workOrderItem.work.place.place.id	Sys_id de l’emplacement. Table : Emplacement [cmn_location] Type de données : chaîne
workOrderItem.work.place.role	Rôle de cet emplacement dans le contexte de la tâche. Type de données : chaîne
workOrderItem.work.relatedParty	Liste des groupes de support pour la tâche. Type de données : tableau `"relatedParty": [ { "@type": "String", "id": "String", "name": "String", "role": "String" } ]`
workOrderItem.work.relatedParty.@type	Cette valeur est toujours `RelatedPartyRef`. Type de données : chaîne
workOrderItem.work.relatedParty.id	Sys_id du groupe de support. Table : Groupe [sys_user_group] Type de données : chaîne
workOrderItem.work.relatedParty.name	Nom du groupe de support. Type de données : chaîne
workOrderItem.work.relatedParty.role	Rôle du groupe de support. Type de données : chaîne
workOrderItem.work.scheduledStartDate	Date de début planifiée pour la tâche. Type de données : chaîne
workOrderItem.work.workforceEmployeeAssignment	Détails de l’affectation de la tâche. Type de données : tableau `"workforceEmployeeAssignment": [ { "@type":"String", "id": "String", "workforceEmployee": {Object} } ]`
workOrderItem.work.workforceEmployeeAssignment.@type	Cette valeur est toujours `WorkforceEmployeeAssignment`. Type de données : chaîne
workOrderItem.work.workforceEmployeeAssignment.id	Sys_id du groupe affecté à la tâche. Table : Groupe [sys_user_group] Type de données : chaîne
workOrderItem.work.workforceEmployeeAssignment.workforceEmployee	Détails sur l’employé affecté à la tâche. Type de données : objet `"workforceEmployee": { "@type": "String", "contactMedium": [Array], "id": "String", "name": "String" }`
workOrderItem.work.workforceEmployeeAssignment.workforceEmployee.@type	Cette valeur est toujours `Individuel`. Type de données : chaîne
workOrderItem.work.workforceEmployeeAssignment.workforceEmployee.contactMedium	Liste des numéros de téléphone de l’employé. Type de données : tableau `"contactMedium": [ { "@type": "String", "phoneNumber": "String" } ]`
workOrderItem.work.workforceEmployeeAssignment.workforceEmployee.contactMedium.@type	Cette valeur est toujours `PhoneContactMedium`. Type de données : chaîne
workOrderItem.work.workforceEmployeeAssignment.workforceEmployee.contactMedium.phoneNumber	Numéro de téléphone de l’employé. Type de données : chaîne
workOrderItem.work.workforceEmployeeAssignment.workforceEmployee.id	Sys_id de l’employé. Table : Utilisateur [sys_user] Type de données : chaîne
workOrderItem.work.workforceEmployeeAssignment.workforceEmployee.name	Nom de l’employé. Type de données : chaîne
workOrderItem.work.workPriority	Classement des priorités pour la tâche. Valeurs possibles : 1 – Critique 2 - Élevée 3 - Modéré 4 - Faible 5 – En préparation Type de données : chaîne
workOrderItem.work.workType	Type de travail pour la tâche. Table : Type de travail [wm_work_type] Champ : Nom Type de données : chaîne
numéro de commande de travail	Identificateur unique de la commande de travaux, tel que WO0008004. Table : commande de travaux [wm_order] Champ : Numéro 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.
400	Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté.
404	Introuvable. L’élément demandé est introuvable.

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


Nom	Description
@type	Cette valeur est toujours `WorkOrder`. Type de données : chaîne
Date d’achèvement	Date et heure auxquelles la commande de travaux a été terminée. Type de données : chaîne
description	Description de la commande de travaux. Type de données : chaîne
expectedCompletionDate	Date et heure d’achèvement prévues désignées par le fournisseur. Type de données : chaîne
identificateur externe	Liste de références externes telles que l’ID de fournisseur ou de corrélation. Type de données : tableau `"externalIdentifier": [ { "@type": "String", "id": "String" } ]`
externalIdentifier.@type	Cette valeur est toujours `ExternalIdentifierRef`. Type de données : chaîne
externalIdentifier.id	Référence externe telle que l’ID de fournisseur ou de corrélation. Type de données : chaîne
href	Lien relatif vers l’enregistrement de la commande de travaux. Type de données : chaîne
id	Sys_id de la commande de travaux. Table : commande de travaux [wm_order] Type de données : chaîne
initiatedFrom	ID de référence indiquant où la commande de travaux a été initiée. Par exemple, une tâche sys_id de la table Tâche de commande de travaux [wm_task]. Type de données : chaîne
remarque	Liste des notes relatives à la commande. Type de données : tableau `"note": [ { "@type": "String", "author": "String", "date": "String", "text": "String" } ]`
note.@type	Cette valeur est toujours `Remarque`. Type de données : chaîne
note.auteur	Auteur de la note. Type de données : chaîne
note.date	Date à laquelle la note a été ajoutée à la commande de travaux. Type de données : chaîne
note.text	Le texte de la note. Type de données : chaîne
lieu	Emplacement géographique associé à la commande de travaux. Type de données : objet `"place": { "@type": "String", "id": "String", "relatedParty": [Array] }`
place.@type	Cette valeur est toujours `GeographicSite`. Type de données : chaîne
place.id	Sys_id de l’emplacement. Table : Emplacement [cmn_location] Type de données : chaîne
lieu.relatedParty	Liste des groupes de support pour l’emplacement. Type de données : tableau `"relatedParty": [ { "@type": "String", "id": "String", "name": "String", "role": "String" } ]`
place.relatedParty.@type	Cette valeur est toujours `RelatedPartyRef`. Type de données : chaîne
place.relatedParty.id	Sys_id du groupe de support. Table : Groupe [sys_user_group] Type de données : chaîne
place.relatedParty.name	Nom du groupe de support. Type de données : chaîne
lieu.relatedParty.role	Rôle du groupe de support. Type de données : chaîne
Priorité	Classement des priorités pour la commande de travaux. Valeurs possibles : 1 – Critique 2 - Élevée 3 - Modéré 4 - Faible 5 – En préparation Type de données : chaîne
Fête connexe	Liste des contacts associés pour la commande de travaux. Type de données : tableau `"relatedParty": [ { "@type": "String", "id": "String", "name": "String", "role": "String" } ]`
relatedParty.@type	Cette valeur est toujours `RelatedPartyRef`. Type de données : chaîne
relatedParty.id	Sys_id de la partie liée. Table : compte [customer_account], société [core_company] ou utilisateur [sys_user] Type de données : chaîne
relatedParty.name	Nom de la partie liée. Type de données : chaîne
relatedParty.role	Rôle de la partie connexe. Valeurs possibles : Compte Société Consommateur Contact Type de données : chaîne
requestedCompletionDate	Date et heure d’achèvement demandées. Type de données : chaîne
requestedStartDate	Date de début d’exécution de la commande désignée par le demandeur. Utilisé dans les cas où le demandeur ne peut pas autoriser le fournisseur à commencer le traitement avant une date spécifiée. Type de données : chaîne
shortDescription	Bref résumé de la commande de travaux. Type de données : chaîne
startDate	Date et heure de début de la commande. Type de données : chaîne
État	État de la commande de travaux. Valeurs possibles : Brouillon En attente de qualification Qualifié Affecté Travail en cours Terminé Type de données : chaîne
ID de modèle	Sys_id du modèle à utiliser pour la commande de travaux. Table : Modèle de produit [cmdb_model] Type de données : chaîne
élément de commande de travail	Liste des tâches sous la commande de travaux. Type de données : tableau `"workOrderItem": [ { "@type": "String", "action": "String", "completionDate": "String", "description": "String", "id": "String", "note": {Object}, "shortDescription": "String", "state": "String", "work": {Object} } ]`
workOrderItem.@type	Cette valeur est toujours `WorkOrderItem`. Type de données : chaîne
workOrderItem.action	Action à effectuer sur le produit pour la tâche. Valeurs possibles : ajouter supprimer modify noChange Type de données : chaîne
workOrderItem.completionDate	Date et heure de fin de la tâche. Type de données : chaîne
workOrderItem.description	Description de la tâche. Type de données : chaîne
workOrderItem.id	Sys_id de la tâche. Table : Tâche de commande de travaux [wm_task] Type de données : chaîne
workOrderItem.note	Liste des notes relatives à la tâche. Type de données : tableau `"note": [ { "@type": "String", "author": "String", "date": "String", "text": "String" } ]`
workOrderItem.note.@type	Cette valeur est toujours `Remarque`. Type de données : chaîne
workOrderItem.note.author	Auteur de la note. Type de données : chaîne
workOrderItem.note.date	Date à laquelle la note a été ajoutée à la tâche. Type de données : chaîne
workOrderItem.note.text	Le texte de la note. Type de données : chaîne
workOrderItem.shortDescription	Brève description de la phase. Type de données : chaîne
workOrderItem.state	État de la tâche. Type de données : chaîne
workOrderItem.work	Description du travail requis pour la tâche. Type de données : objet `"work": { "@type": "String", "expectedCompletionDate": "String", "id": "String", "place": [Array], "relatedParty": [Array], "scheduledStartDate": "String", "workforceEmployeeAssignment": [Array], "workPriority": "String", "workType": "String" }`
workOrderItem.work.@type	Cette valeur est toujours `WorkRefOrValue`. Type de données : chaîne
workOrderItem.work.expectedCompletionDate	Date d’achèvement attendue pour la tâche. Type de données : chaîne
workOrderItem.work.id	Sys_id du type de travail de la tâche. Table : Type de travail [wm_work_type] Type de données : chaîne
workOrderItem.work.place	Liste des emplacements géographiques associés à la tâche. `"place": [ { "@type": "String", "place": {Object}, "role": "String" } ]`
workOrderItem.work.place.@type	Cette valeur est toujours `RelatedPlaceRefOrValue`. Type de données : chaîne
ÉlémentCommandeTravail.Lieu.Lieu	Détails sur l’emplacement. Type de données : objet `"place": { "@type": "String", "id": "String" }`
workOrderItem.work.place.place.@type	Cette valeur est toujours `GeographicSite`. Type de données : chaîne
workOrderItem.work.place.place.id	Sys_id de l’emplacement. Table : Emplacement [cmn_location] Type de données : chaîne
workOrderItem.work.place.role	Rôle de cet emplacement dans le contexte de la tâche. Type de données : chaîne
workOrderItem.work.relatedParty	Liste des groupes de support pour la tâche. Type de données : tableau `"relatedParty": [ { "@type": "String", "id": "String", "name": "String", "role": "String" } ]`
workOrderItem.work.relatedParty.@type	Cette valeur est toujours `RelatedPartyRef`. Type de données : chaîne
workOrderItem.work.relatedParty.id	Sys_id du groupe de support. Table : Groupe [sys_user_group] Type de données : chaîne
workOrderItem.work.relatedParty.name	Nom du groupe de support. Type de données : chaîne
workOrderItem.work.relatedParty.role	Rôle du groupe de support. Type de données : chaîne
workOrderItem.work.scheduledStartDate	Date de début planifiée pour la tâche. Type de données : chaîne
workOrderItem.work.workforceEmployeeAssignment	Détails de l’affectation de la tâche. Type de données : tableau `"workforceEmployeeAssignment": [ { "@type":"String", "id": "String", "workforceEmployee": {Object} } ]`
workOrderItem.work.workforceEmployeeAssignment.@type	Cette valeur est toujours `WorkforceEmployeeAssignment`. Type de données : chaîne
workOrderItem.work.workforceEmployeeAssignment.id	Sys_id du groupe affecté à la tâche. Table : Groupe [sys_user_group] Type de données : chaîne
workOrderItem.work.workforceEmployeeAssignment.workforceEmployee	Détails sur l’employé affecté à la tâche. Type de données : objet `"workforceEmployee": { "@type": "String", "contactMedium": [Array], "id": "String", "name": "String" }`
workOrderItem.work.workforceEmployeeAssignment.workforceEmployee.@type	Cette valeur est toujours `Individuel`. Type de données : chaîne
workOrderItem.work.workforceEmployeeAssignment.workforceEmployee.contactMedium	Liste des numéros de téléphone de l’employé. Type de données : tableau `"contactMedium": [ { "@type": "String", "phoneNumber": "String" } ]`
workOrderItem.work.workforceEmployeeAssignment.workforceEmployee.contactMedium.@type	Cette valeur est toujours `PhoneContactMedium`. Type de données : chaîne
workOrderItem.work.workforceEmployeeAssignment.workforceEmployee.contactMedium.phoneNumber	Numéro de téléphone de l’employé. Type de données : chaîne
workOrderItem.work.workforceEmployeeAssignment.workforceEmployee.id	Sys_id de l’employé. Table : Utilisateur [sys_user] Type de données : chaîne
workOrderItem.work.workforceEmployeeAssignment.workforceEmployee.name	Nom de l’employé. Type de données : chaîne
workOrderItem.work.workPriority	Classement des priorités pour la tâche. Valeurs possibles : 1 – Critique 2 - Élevée 3 - Modéré 4 - Faible 5 – En préparation Type de données : chaîne
workOrderItem.work.workType	Type de travail pour la tâche. Table : Type de travail [wm_work_type] Champ : Nom Type de données : chaîne
numéro de commande de travail	Identificateur unique de la commande de travaux, tel que WO0008004. Table : commande de travaux [wm_order] Champ : Numéro Type de données : chaîne

Demande cURL

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

curl "http://instance.servicenow.com/api/sn_tmf_api/work_order_management_api/workOrder/2d3f32f0df113100dca6a5f59bf263a9" \
--request PATCH \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
   "@type": "WorkOrder",
   "description": "Fixed Fibre Broadband Installation",
   "shortDescription": "Fixed Fibre",
   "priority": "1 - Critical",
   "place": {
      "@type": "GeographicSite",
      "id": "f48b22530a0a0ba70001913a1c181eeb",
      "relatedParty": [
         {
            "role": "QualificationGroup",
            "id": "781da52637232000158bbfc8bcbe5db8",
            "name": "Jane Smith",
            "@type": "PartyRef",
            "@referredType": "Individual"
         }
      ]
   },
   "relatedParty": [
      {
         "@type": "RelatedPartyRef",
         "id": "86a08090ffcd62105e0dffffffffff8b",
         "name": "Workforce Engineering Group",
         "role": "Consumer"
      }
   ],
   "workOrderItem": [
      {
         "@type": "WorkOrderItem",
         "id": "3df59e8cff5d26105e0dffffffffff0e",
         "action": "add",
         "description": "FTTH Installation",
         "shortDescription": "FTTH Installation",
         "completionDate": "2024-04-22T14:23:06.528Z",
         "state": "Accepted",
         "work": {
            "@type": "WorkRefOrValue",
            "scheduledStartDate": "2024-04-22T14:23:06.528Z",
            "workType": "38f719ec3b8a10103f09080044efc4cd",
            "description": "Cabinet Configuration",
            "name": "FTTH Installation",
            "workPriority": "high",
            "place": [
               {
                  "@type": "RelatedPlaceRefOrValue",
                  "place": {
                     "@type": "GeographicSite",
                     "id": "b04b813bffc126105e0dffffffffff0d"
                  }
               }
            ],
            "note": {
               "@type": "Note",
               "text": "Demand Point Type: SDU"
            }
         }
      }
   ],
   "note": {
      "@type": "Note",
      "text": "This is important"
   }
}" \
--user 'username':'password'

Corps de la réponse.

{
   "@type": "WorkOrder",
   "description": "Fixed Fibre Broadband Installation",
   "shortDescription": "Fixed Fibre",
   "priority": "1 - Critical",
   "place": {
      "@type": "GeographicSite",
      "id": "f48b22530a0a0ba70001913a1c181eeb",
      "relatedParty": [
         {
            "role": "QualificationGroup",
            "id": "781da52637232000158bbfc8bcbe5db8",
            "name": "Jane Smith",
            "@type": "PartyRef",
            "@referredType": "Individual"
         }
      ]
   },
   "relatedParty": [
      {
         "@type": "RelatedPartyRef",
         "id": "86a08090ffcd62105e0dffffffffff8b",
         "name": "Workforce Engineering Group",
         "role": "Consumer"
      }
   ],
   "workOrderItem": [
      {
         "@type": "WorkOrderItem",
         "id": "3df59e8cff5d26105e0dffffffffff0e",
         "action": "add",
         "description": "FTTH Installation",
         "shortDescription": "FTTH Installation",
         "completionDate": "2024-04-22T14:23:06.528Z",
         "state": "Accepted",
         "work": {
            "@type": "WorkRefOrValue",
            "scheduledStartDate": "2024-04-22T14:23:06.528Z",
            "workType": "38f719ec3b8a10103f09080044efc4cd",
            "description": "Cabinet Configuration",
            "name": "FTTH Installation",
            "workPriority": "high",
            "place": [
               {
                  "@type": "RelatedPlaceRefOrValue",
                  "place": {
                     "@type": "GeographicSite",
                     "id": "b04b813bffc126105e0dffffffffff0d"
                  }
               }
            ],
            "note": {
               "@type": "Note",
               "text": "Demand Point Type: SDU"
            }
         }
      }
   ],
   "note": {
      "@type": "Note",
      "text": "This is important"
   },
   "id": "2d3f32f0df113100dca6a5f59bf263a9",
   "href": "/api/sn_tmf_api/work_order_management_api/workOrder/2d3f32f0df113100dca6a5f59bf263a9"
}

Gestion des commandes de travaux : POST /sn_tmf_api/work_order_management_api/cancelWorkOrder

Annule une commande de travaux spécifiée et toutes les tâches associées.

Format d'URL

URL versionnée : /api/sn_tmf_api/{api_version}/work_order_management_api/cancelWorkOrder

URL par défaut : /api/sn_tmf_api/work_order_management_api/cancelWorkOrder

Paramètres de demande pris en charge

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

Tableau 20. Paramètres de requête
Nom	Description
Aucun

Tableau 21. Paramètres du corps de la demande (JSON)
Nom	Description
@type	Cette valeur est toujours `CancelWorkOrder`. Type de données : chaîne
motif d’annulation	Motif de l’annulation de la commande de travaux. Type de données : chaîne
workOrder	Détails sur la commande de travaux. Type de données : objet `"workOrder": { "@type": "String", "id": "String" }`
workOrder.@type	Cette valeur est toujours `WorkOrderRef`. Type de données : chaîne
workOrder.id	Requis. Sys_id de la commande de travaux à annuler. Table : commande de travaux [wm_order] Type de données : chaîne

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. Un type de demande incorrecte ou mal formé a été détecté.

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


Nom	Description
@type	Cette valeur est toujours `CancelWorkOrder`. Type de données : chaîne
motif d’annulation	Motif de l’annulation de la commande de travaux. Type de données : chaîne
État	État de la demande d’annulation. Si la commande de travaux a été annulée avec succès, cette valeur est `Annulé`. Type de données : chaîne
workOrder	Détails sur la commande de travaux. Type de données : objet `"workOrder": { "@type": "String", "id": "String" }`
workOrder.@type	Cette valeur est toujours `WorkOrderRef`. Type de données : chaîne
workOrder.id	Sys_id de la commande de travaux annulée. Table : commande de travaux [wm_order] Type de données : chaîne

Demande cURL

Annule la commande de travaux spécifiée.

curl "http://instance.servicenow.com/api/sn_tmf_api/work_order_management_api/cancelWorkOrder" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
   "@type": "CancelWorkOrder",
   "cancellationReason": "Workforce unavailability",
   "workOrder": {
      "@type": "WorkOrderRef",
      "id": "f8ec1c38-4e4d-4378-a693-f95680e51e25"
   }
}" \
--user 'username':'password'

Corps de la réponse.

{
  "@type": "CancelWorkOrder",
  "cancellationReason": "Workforce unavailability",
  "state": "Cancelled",
  "workOrder": {
    "@type": "WorkOrderRef",
    "id": "f8ec1c38-4e4d-4378-a693-f95680e51e25"
  }
}

Gestion des commandes de travaux : POST/sn_tmf_api/work_order_management_api/workOrder

Crée une commande de travaux et les tâches associées.

Un enregistrement de la commande de travaux est créé dans la table Commande de travaux [wm_order]. Un enregistrement est créé pour chaque tâche dans la table Tâche de commande de travaux [wm_task].

Format d'URL

URL versionnée : /api/sn_tmf_api/{api_version}/work_order_management_api/workOrder

URL par défaut : /api/sn_tmf_api/work_order_management_api/workOrder

Paramètres de demande pris en charge

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

Tableau 26. Paramètres de requête
Nom	Description
Aucun

Tableau 27. Paramètres du corps de la demande (JSON)
Nom	Description
@type	Cette valeur est toujours `WorkOrder`. Type de données : chaîne
catégorie	Catégorie de la commande de travaux qui peut être utilisée par un système de gestion des commandes, tel `qu’entreprise` ou `résidentiel`. Type de données : chaîne
Date d’achèvement	Date et heure auxquelles la commande de travaux a été terminée. Type de données : chaîne
description	Description de la commande de travaux. Type de données : chaîne
expectedCompletionDate	Date et heure d’achèvement prévues désignées par le fournisseur. Type de données : chaîne
identificateur externe	Liste de références externes telles que l’ID de fournisseur ou de corrélation. Type de données : tableau `"externalIdentifier": [ { "@type": "String", "id": "String" } ]`
externalIdentifier.@type	Cette valeur est toujours `ExternalIdentifierRef`. Type de données : chaîne
externalIdentifier.id	Référence externe telle que l’ID de fournisseur ou de corrélation. Type de données : chaîne
href	Lien relatif vers l’enregistrement de la commande de travaux. Type de données : chaîne
id	Sys_id de la commande de travaux. Table : commande de travaux [wm_order] Type de données : chaîne
initiatedFrom	ID de référence indiquant où la commande de travaux a été initiée. Par exemple, une tâche sys_id de la table Tâche de commande de travaux [wm_task]. Type de données : chaîne
remarque	Liste des notes relatives à la commande. Type de données : tableau `"note": [ { "@type": "String", "author": "String", "date": "String", "text": "String" } ]`
note.@type	Cette valeur est toujours `Remarque`. Type de données : chaîne
note.auteur	Auteur de la note. Type de données : chaîne
note.date	Date à laquelle la note a été ajoutée à la commande de travaux. Type de données : chaîne
note.text	Le texte de la note. Type de données : chaîne
lieu	Emplacement géographique associé à la commande de travaux. Type de données : objet `"place": { "@type": "String", "id": "String", "relatedParty": [Array] }`
place.@type	Cette valeur est toujours `GeographicSite`. Type de données : chaîne
place.id	Sys_id de l’emplacement. Table : Emplacement [cmn_location] Type de données : chaîne
lieu.relatedParty	Liste des groupes de support pour l’emplacement. Type de données : tableau `"relatedParty": [ { "@type": "String", "id": "String", "name": "String", "role": "String" } ]`
place.relatedParty.@type	Cette valeur est toujours `RelatedPartyRef`. Type de données : chaîne
place.relatedParty.id	Sys_id du groupe de support. Table : Groupe [sys_user_group] Type de données : chaîne
place.relatedParty.name	Nom du groupe de support. Type de données : chaîne
lieu.relatedParty.role	Rôle du groupe de support. Type de données : chaîne
Priorité	Classement des priorités pour la commande de travaux. Valeurs possibles : 1 – Critique 2 - Élevée 3 - Modéré 4 - Faible 5 – En préparation Type de données : chaîne
Fête connexe	Liste des contacts associés pour la commande de travaux. Type de données : tableau `"relatedParty": [ { "@type": "String", "id": "String", "name": "String", "role": "String" } ]`
relatedParty.@type	Cette valeur est toujours `RelatedPartyRef`. Type de données : chaîne
relatedParty.id	Sys_id de la partie liée. Table : compte [customer_account], société [core_company] ou utilisateur [sys_user] Type de données : chaîne
relatedParty.name	Nom de la partie liée. Type de données : chaîne
relatedParty.role	Rôle de la partie connexe. Valeurs possibles : Compte Société Consommateur Contact Type de données : chaîne
requestedCompletionDate	Date et heure d’achèvement demandées. Type de données : chaîne
requestedStartDate	Date de début d’exécution de la commande désignée par le demandeur. Utilisé dans les cas où le demandeur ne peut pas autoriser le fournisseur à commencer le traitement avant une date spécifiée. Type de données : chaîne
shortDescription	Bref résumé de la commande de travaux. Type de données : chaîne
startDate	Date et heure de début de la commande. Type de données : chaîne
État	État de la commande de travaux. Valeurs possibles : Brouillon En attente de qualification Qualifié Affecté Travail en cours Terminé Type de données : chaîne
ID de modèle	Sys_id du modèle à utiliser pour la commande de travaux. Table : Modèle de produit [cmdb_model] Type de données : chaîne
élément de commande de travail	Liste des tâches sous la commande de travaux. Type de données : tableau `"workOrderItem": [ { "@type": "String", "action": "String", "completionDate": "String", "description": "String", "id": "String", "note": {Object}, "shortDescription": "String", "state": "String", "work": {Object} } ]`
workOrderItem.@type	Cette valeur est toujours `WorkOrderItem`. Type de données : chaîne
workOrderItem.action	Action à effectuer sur le produit pour la tâche. Valeurs possibles : ajouter supprimer modify noChange Type de données : chaîne
workOrderItem.completionDate	Date et heure de fin de la tâche. Type de données : chaîne
workOrderItem.description	Description de la tâche. Type de données : chaîne
workOrderItem.id	Sys_id de la tâche. Table : Tâche de commande de travaux [wm_task] Type de données : chaîne
workOrderItem.note	Liste des notes relatives à la tâche. Type de données : tableau `"note": [ { "@type": "String", "author": "String", "date": "String", "text": "String" } ]`
workOrderItem.note.@type	Cette valeur est toujours `Remarque`. Type de données : chaîne
workOrderItem.note.author	Auteur de la note. Type de données : chaîne
workOrderItem.note.date	Date à laquelle la note a été ajoutée à la tâche. Type de données : chaîne
workOrderItem.note.text	Le texte de la note. Type de données : chaîne
workOrderItem.shortDescription	Brève description de la phase. Type de données : chaîne
workOrderItem.state	État de la tâche. Type de données : chaîne
workOrderItem.work	Description du travail requis pour la tâche. Type de données : objet `"work": { "@type": "String", "expectedCompletionDate": "String", "id": "String", "place": [Array], "relatedParty": [Array], "scheduledStartDate": "String", "workforceEmployeeAssignment": [Array], "workPriority": "String", "workType": "String" }`
workOrderItem.work.@type	Cette valeur est toujours `WorkRefOrValue`. Type de données : chaîne
workOrderItem.work.expectedCompletionDate	Date d’achèvement attendue pour la tâche. Type de données : chaîne
workOrderItem.work.id	Sys_id du type de travail de la tâche. Table : Type de travail [wm_work_type] Type de données : chaîne
workOrderItem.work.place	Liste des emplacements géographiques associés à la tâche. `"place": [ { "@type": "String", "place": {Object}, "role": "String" } ]`
workOrderItem.work.place.@type	Cette valeur est toujours `RelatedPlaceRefOrValue`. Type de données : chaîne
workOrderItem.work.place.place	Détails sur l’emplacement. Type de données : objet `"place": { "@type": "String", "id": "String" }`
workOrderItem.work.place.place.@type	Cette valeur est toujours `GeographicSite`. Type de données : chaîne
workOrderItem.work.place.place.id	Sys_id de l’emplacement. Table : Emplacement [cmn_location] Type de données : chaîne
workOrderItem.work.place.role	Rôle de cet emplacement dans le contexte de la tâche. Type de données : chaîne
workOrderItem.work.relatedParty	Liste des groupes de support pour la tâche. Type de données : tableau `"relatedParty": [ { "@type": "String", "id": "String", "name": "String", "role": "String" } ]`
workOrderItem.work.relatedParty.@type	Cette valeur est toujours `RelatedPartyRef`. Type de données : chaîne
workOrderItem.work.relatedParty.id	Sys_id du groupe de support. Table : Groupe [sys_user_group] Type de données : chaîne
workOrderItem.work.relatedParty.name	Nom du groupe de support. Type de données : chaîne
workOrderItem.work.relatedParty.role	Rôle du groupe de support. Type de données : chaîne
workOrderItem.work.scheduledStartDate	Date de début planifiée pour la tâche. Type de données : chaîne
workOrderItem.work.workforceEmployeeAssignment	Détails de l’affectation de la tâche. Type de données : tableau `"workforceEmployeeAssignment": [ { "@type":"String", "id": "String", "workforceEmployee": {Object} } ]`
workOrderItem.work.workforceEmployeeAssignment.@type	Cette valeur est toujours `WorkforceEmployeeAssignment`. Type de données : chaîne
workOrderItem.work.workforceEmployeeAssignment.id	Sys_id du groupe affecté à la tâche. Table : Groupe [sys_user_group] Type de données : chaîne
workOrderItem.work.workforceEmployeeAssignment.workforceEmployee	Détails sur l’employé affecté à la tâche. Type de données : objet `"workforceEmployee": { "@type": "String", "contactMedium": [Array], "id": "String", "name": "String" }`
workOrderItem.work.workforceEmployeeAssignment.workforceEmployee.@type	Cette valeur est toujours `Individuel`. Type de données : chaîne
workOrderItem.work.workforceEmployeeAssignment.workforceEmployee.contactMedium	Liste des numéros de téléphone de l’employé. Type de données : tableau `"contactMedium": [ { "@type": "String", "phoneNumber": "String" } ]`
workOrderItem.work.workforceEmployeeAssignment.workforceEmployee.contactMedium.@type	Cette valeur est toujours `PhoneContactMedium`. Type de données : chaîne
workOrderItem.work.workforceEmployeeAssignment.workforceEmployee.contactMedium.phoneNumber	Numéro de téléphone de l’employé. Type de données : chaîne
workOrderItem.work.workforceEmployeeAssignment.workforceEmployee.id	Sys_id de l’employé. Table : Utilisateur [sys_user] Type de données : chaîne
workOrderItem.work.workforceEmployeeAssignment.workforceEmployee.name	Nom de l’employé. Type de données : chaîne
workOrderItem.work.workPriority	Classement des priorités pour la tâche. Valeurs possibles : 1 – Critique 2 - Élevée 3 - Modéré 4 - Faible 5 – En préparation Type de données : chaîne
workOrderItem.work.workType	Type de travail pour la tâche. Table : Type de travail [wm_work_type] Champ : Nom Type de données : chaîne
numéro de commande de travail	Identificateur unique de la commande de travaux, tel que WO0008004. Table : commande de travaux [wm_order] Champ : Numéro 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.
Content-Type	Format de données du corps de la demande. 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
201	Créé. La commande de travaux a été créée avec succès.
400	Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté.

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


Nom	Description
@type	Cette valeur est toujours `WorkOrder`. Type de données : chaîne
catégorie	Catégorie de la commande de travaux qui peut être utilisée par un système de gestion des commandes, tel `qu’entreprise` ou `résidentiel`. Type de données : chaîne
Date d’achèvement	Date et heure auxquelles la commande de travaux a été terminée. Type de données : chaîne
description	Description de la commande de travaux. Type de données : chaîne
expectedCompletionDate	Date et heure d’achèvement prévues désignées par le fournisseur. Type de données : chaîne
identificateur externe	Liste de références externes telles que l’ID de fournisseur ou de corrélation. Type de données : tableau `"externalIdentifier": [ { "@type": "String", "id": "String" } ]`
externalIdentifier.@type	Cette valeur est toujours `ExternalIdentifierRef`. Type de données : chaîne
externalIdentifier.id	Référence externe telle que l’ID de fournisseur ou de corrélation. Type de données : chaîne
href	Lien relatif vers l’enregistrement de la commande de travaux. Type de données : chaîne
id	Sys_id de la commande de travaux. Table : commande de travaux [wm_order] Type de données : chaîne
initiatedFrom	ID de référence indiquant où la commande de travaux a été initiée. Par exemple, une tâche sys_id de la table Tâche de commande de travaux [wm_task]. Type de données : chaîne
remarque	Liste des notes relatives à la commande. Type de données : tableau `"note": [ { "@type": "String", "author": "String", "date": "String", "text": "String" } ]`
note.@type	Cette valeur est toujours `Remarque`. Type de données : chaîne
note.auteur	Auteur de la note. Type de données : chaîne
note.date	Date à laquelle la note a été ajoutée à la commande de travaux. Type de données : chaîne
note.text	Le texte de la note. Type de données : chaîne
lieu	Emplacement géographique associé à la commande de travaux. Type de données : objet `"place": { "@type": "String", "id": "String", "relatedParty": [Array] }`
place.@type	Cette valeur est toujours `GeographicSite`. Type de données : chaîne
place.id	Sys_id de l’emplacement. Table : Emplacement [cmn_location] Type de données : chaîne
lieu.relatedParty	Liste des groupes de support pour l’emplacement. Type de données : tableau `"relatedParty": [ { "@type": "String", "id": "String", "name": "String", "role": "String" } ]`
place.relatedParty.@type	Cette valeur est toujours `RelatedPartyRef`. Type de données : chaîne
place.relatedParty.id	Sys_id du groupe de support. Table : Groupe [sys_user_group] Type de données : chaîne
place.relatedParty.name	Nom du groupe de support. Type de données : chaîne
lieu.relatedParty.role	Rôle du groupe de support. Type de données : chaîne
Priorité	Classement des priorités pour la commande de travaux. Valeurs possibles : 1 – Critique 2 - Élevée 3 - Modéré 4 - Faible 5 – En préparation Type de données : chaîne
Fête connexe	Liste des contacts associés pour la commande de travaux. Type de données : tableau `"relatedParty": [ { "@type": "String", "id": "String", "name": "String", "role": "String" } ]`
relatedParty.@type	Cette valeur est toujours `RelatedPartyRef`. Type de données : chaîne
relatedParty.id	Sys_id de la partie liée. Table : compte [customer_account], société [core_company] ou utilisateur [sys_user] Type de données : chaîne
relatedParty.name	Nom de la partie liée. Type de données : chaîne
relatedParty.role	Rôle de la partie connexe. Valeurs possibles : Compte Société Consommateur Contact Type de données : chaîne
requestedCompletionDate	Date et heure d’achèvement demandées. Type de données : chaîne
requestedStartDate	Date de début d’exécution de la commande désignée par le demandeur. Utilisé dans les cas où le demandeur ne peut pas autoriser le fournisseur à commencer le traitement avant une date spécifiée. Type de données : chaîne
shortDescription	Bref résumé de la commande de travaux. Type de données : chaîne
startDate	Date et heure de début de la commande. Type de données : chaîne
État	État de la commande de travaux. Valeurs possibles : Brouillon En attente de qualification Qualifié Affecté Travail en cours Terminé Type de données : chaîne
ID de modèle	Sys_id du modèle à utiliser pour la commande de travaux. Table : Modèle de produit [cmdb_model] Type de données : chaîne
élément de commande de travail	Liste des tâches sous la commande de travaux. Type de données : tableau `"workOrderItem": [ { "@type": "String", "action": "String", "completionDate": "String", "description": "String", "id": "String", "note": {Object}, "shortDescription": "String", "state": "String", "work": {Object} } ]`
workOrderItem.@type	Cette valeur est toujours `WorkOrderItem`. Type de données : chaîne
workOrderItem.action	Action à effectuer sur le produit pour la tâche. Valeurs possibles : ajouter supprimer modify noChange Type de données : chaîne
workOrderItem.completionDate	Date et heure de fin de la tâche. Type de données : chaîne
workOrderItem.description	Description de la tâche. Type de données : chaîne
workOrderItem.id	Sys_id de la tâche. Table : Tâche de commande de travaux [wm_task] Type de données : chaîne
workOrderItem.note	Liste des notes relatives à la tâche. Type de données : tableau `"note": [ { "@type": "String", "author": "String", "date": "String", "text": "String" } ]`
workOrderItem.note.@type	Cette valeur est toujours `Remarque`. Type de données : chaîne
workOrderItem.note.author	Auteur de la note. Type de données : chaîne
workOrderItem.note.date	Date à laquelle la note a été ajoutée à la tâche. Type de données : chaîne
workOrderItem.note.text	Le texte de la note. Type de données : chaîne
workOrderItem.shortDescription	Brève description de la phase. Type de données : chaîne
workOrderItem.state	État de la tâche. Type de données : chaîne
workOrderItem.work	Description du travail requis pour la tâche. Type de données : objet `"work": { "@type": "String", "expectedCompletionDate": "String", "id": "String", "place": [Array], "relatedParty": [Array], "scheduledStartDate": "String", "workforceEmployeeAssignment": [Array], "workPriority": "String", "workType": "String" }`
workOrderItem.work.@type	Cette valeur est toujours `WorkRefOrValue`. Type de données : chaîne
workOrderItem.work.expectedCompletionDate	Date d’achèvement attendue pour la tâche. Type de données : chaîne
workOrderItem.work.id	Sys_id du type de travail de la tâche. Table : Type de travail [wm_work_type] Type de données : chaîne
workOrderItem.work.place	Liste des emplacements géographiques associés à la tâche. `"place": [ { "@type": "String", "place": {Object}, "role": "String" } ]`
workOrderItem.work.place.@type	Cette valeur est toujours `RelatedPlaceRefOrValue`. Type de données : chaîne
ÉlémentCommandeTravail.Lieu.Lieu	Détails sur l’emplacement. Type de données : objet `"place": { "@type": "String", "id": "String" }`
workOrderItem.work.place.place.@type	Cette valeur est toujours `GeographicSite`. Type de données : chaîne
workOrderItem.work.place.place.id	Sys_id de l’emplacement. Table : Emplacement [cmn_location] Type de données : chaîne
workOrderItem.work.place.role	Rôle de cet emplacement dans le contexte de la tâche. Type de données : chaîne
workOrderItem.work.relatedParty	Liste des groupes de support pour la tâche. Type de données : tableau `"relatedParty": [ { "@type": "String", "id": "String", "name": "String", "role": "String" } ]`
workOrderItem.work.relatedParty.@type	Cette valeur est toujours `RelatedPartyRef`. Type de données : chaîne
workOrderItem.work.relatedParty.id	Sys_id du groupe de support. Table : Groupe [sys_user_group] Type de données : chaîne
workOrderItem.work.relatedParty.name	Nom du groupe de support. Type de données : chaîne
workOrderItem.work.relatedParty.role	Rôle du groupe de support. Type de données : chaîne
workOrderItem.work.scheduledStartDate	Date de début planifiée pour la tâche. Type de données : chaîne
workOrderItem.work.workforceEmployeeAssignment	Détails de l’affectation de la tâche. Type de données : tableau `"workforceEmployeeAssignment": [ { "@type":"String", "id": "String", "workforceEmployee": {Object} } ]`
workOrderItem.work.workforceEmployeeAssignment.@type	Cette valeur est toujours `WorkforceEmployeeAssignment`. Type de données : chaîne
workOrderItem.work.workforceEmployeeAssignment.id	Sys_id du groupe affecté à la tâche. Table : Groupe [sys_user_group] Type de données : chaîne
workOrderItem.work.workforceEmployeeAssignment.workforceEmployee	Détails sur l’employé affecté à la tâche. Type de données : objet `"workforceEmployee": { "@type": "String", "contactMedium": [Array], "id": "String", "name": "String" }`
workOrderItem.work.workforceEmployeeAssignment.workforceEmployee.@type	Cette valeur est toujours `Individuel`. Type de données : chaîne
workOrderItem.work.workforceEmployeeAssignment.workforceEmployee.contactMedium	Liste des numéros de téléphone de l’employé. Type de données : tableau `"contactMedium": [ { "@type": "String", "phoneNumber": "String" } ]`
workOrderItem.work.workforceEmployeeAssignment.workforceEmployee.contactMedium.@type	Cette valeur est toujours `PhoneContactMedium`. Type de données : chaîne
workOrderItem.work.workforceEmployeeAssignment.workforceEmployee.contactMedium.phoneNumber	Numéro de téléphone de l’employé. Type de données : chaîne
workOrderItem.work.workforceEmployeeAssignment.workforceEmployee.id	Sys_id de l’employé. Table : Utilisateur [sys_user] Type de données : chaîne
workOrderItem.work.workforceEmployeeAssignment.workforceEmployee.name	Nom de l’employé. Type de données : chaîne
workOrderItem.work.workPriority	Classement des priorités pour la tâche. Valeurs possibles : 1 – Critique 2 - Élevée 3 - Modéré 4 - Faible 5 – En préparation Type de données : chaîne
workOrderItem.work.workType	Type de travail pour la tâche. Table : Type de travail [wm_work_type] Champ : Nom Type de données : chaîne
numéro de commande de travail	Identificateur unique de la commande de travaux, tel que WO0008004. Table : commande de travaux [wm_order] Champ : Numéro Type de données : chaîne

Demande cURL

Crée une commande de travaux et une tâche à l’aide d’un modèle.

curl "http://instance.servicenow.com/api/sn_tmf_api/work_order_management_api/workOrder" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
   "id": "323",
   "@type": "WorkOrder",
   "category": "service",
   "shortDescription": "Fixed Fibre Broadband Installation sb",
   "description": "Fixed Fibre description",
   "startDate": "2025-07-22T14:23:06.528Z",
   "requestedCompletionDate": "2024-06-22T14:23:06.528Z",
   "requestedStartDate": "2024-06-22T14:23:06.528Z",
   "priority": "2 - High",
   "expectedCompletionDate": "2025-07-28T14:23:06.528Z",
   "initiatedFrom": "d090df34df113100dca6a5f59bf26335",
   "templateId": "191ba0e0df113100dca6a5f59bf26336",
   "place": {
      "@type": "GeographicSite",
      "id": "423e85f037d0200044e0bfc8bcbe5d12",
      "relatedParty": [
         {
            "role": "QualificationGroup",
            "id": "539546b237232000158bfc8bcbe5d7",
            "@type": "PartyRef",
            "@referredType": "Individual"
         }
      ]
   },
   "relatedParty": [
      {
         "@type": "RelatedPartyRef",
         "id": "d79249762fc1a610b79db3bf42faf3d2",
         "name": "Workforce Engineering Group",
         "role": "Company"
      },
      {
         "@type": "RelatedPartyRef",
         "id": "b88d14843bc02300bfe04d72f3efc4cd",
         "name": "Workforce Engineering Group",
         "role": "Contact"
      }
   ],
   "externalIdentifier": [
      {
         "@type": "ExternalIdentifier",
         "id": "1223412"
      }
   ],
   "workOrderItem": [
      {
         "@type": "WorkOrderItem",
         "action": "add",
         "id": "12232332",
         "description": "FTTH Installation",
         "completionDate": "2024-04-22T14:23:06.528Z",
         "work": {
            "@type": "WorkRefOrValue",
            "workType": "999469283bca10103f09080044efc4cf",
            "orderDate": "2024-04-22 14:23:06.528",
            "scheduledStartDate": "2025-06-25 14:23:06.528",
            "expectedCompletionDate": "2025-08-22 14:23:06.528",
            "workPriority": "2 - High",
            "place": [
               {
                  "@type": "RelatedPlaceRefOrValue",
                  "role": "string",
                  "place": {
                     "@type": "GeographicSite",
                     "id": "16ff753837d0200044e0bfc8bcbe5d5f"
                  }
               }
            ],
            "relatedParty": [
               {
                  "@type": "RelatedPartyRef",
                  "id": "4c0482b237232000158bbfc8bcbe5d09",
                  "name": "Louisiana Dispatchers",
                  "role": "DispatchGroup"
               }
            ],
            "workforceEmployeeAssignment": [
               {
                  "@type": "WorkforceEmployeeAssignment",
                  "id": "7172ea0037332000158bbfc8bcbe5db6",
                  "workforceEmployee": {
                     "@type": "Individual",
                     "name": "Athelstan Amos",
                     "id": "46c1293aa9fe1981000dc753e75ebeee"
                  }
               }
            ]
         },
         "note": {
            "@type": "Note",
            "id": "afa9-3d90aaa8da0f",
            "text": "This is a work order task note."
         }
      }
   ],
   "note": {
      "@type": "Note",
      "id": "afa9-3d90aaa8da0f",
      "text": "This is a work order note."
   }
}" \
--user 'username':'password'

Corps de la réponse.

{
   "id": "ca6d72d1ffa96210b79dffffffffffa1",
   "@type": "WorkOrder",
   "category": "service",
   "shortDescription": "Fixed Fibre Broadband Installation sb",
   "description": "Fixed Fibre description",
   "startDate": "2025-07-22T14:23:06.528Z",
   "requestedCompletionDate": "2024-06-22T14:23:06.528Z",
   "requestedStartDate": "2024-06-22T14:23:06.528Z",
   "priority": "2 - High",
   "expectedCompletionDate": "2025-07-28T14:23:06.528Z",
   "initiatedFrom": "d090df34df113100dca6a5f59bf26335",
   "templateId": "191ba0e0df113100dca6a5f59bf26336",
   "place": {
      "@type": "GeographicSite",
      "id": "423e85f037d0200044e0bfc8bcbe5d12",
      "relatedParty": [
         {
            "role": "QualificationGroup",
            "id": "539546b237232000158bfc8bcbe5d7",
            "@type": "PartyRef",
            "@referredType": "Individual"
         }
      ]
   },
   "relatedParty": [
      {
         "@type": "RelatedPartyRef",
         "id": "d79249762fc1a610b79db3bf42faf3d2",
         "name": "Workforce Engineering Group",
         "role": "Company"
      },
      {
         "@type": "RelatedPartyRef",
         "id": "b88d14843bc02300bfe04d72f3efc4cd",
         "name": "Workforce Engineering Group",
         "role": "Contact"
      }
   ],
   "externalIdentifier": [
      {
         "@type": "ExternalIdentifier",
         "id": "1223412"
      }
   ],
   "workOrderItem": [
      {
         "@type": "WorkOrderItem",
         "action": "add",
         "id": "12232332",
         "description": "FTTH Installation",
         "completionDate": "2024-04-22T14:23:06.528Z",
         "work": {
            "@type": "WorkRefOrValue",
            "workType": "999469283bca10103f09080044efc4cf",
            "orderDate": "2024-04-22 14:23:06.528",
            "scheduledStartDate": "2025-06-25 14:23:06.528",
            "expectedCompletionDate": "2025-08-22 14:23:06.528",
            "workPriority": "2 - High",
            "place": [
               {
                  "@type": "RelatedPlaceRefOrValue",
                  "role": "string",
                  "place": {
                     "@type": "GeographicSite",
                     "id": "16ff753837d0200044e0bfc8bcbe5d5f"
                  }
               }
            ],
            "relatedParty": [
               {
                  "@type": "RelatedPartyRef",
                  "id": "4c0482b237232000158bbfc8bcbe5d09",
                  "name": "Louisiana Dispatchers",
                  "role": "DispatchGroup"
               }
            ],
            "workforceEmployeeAssignment": [
               {
                  "@type": "WorkforceEmployeeAssignment",
                  "id": "7172ea0037332000158bbfc8bcbe5db6",
                  "workforceEmployee": {
                     "@type": "Individual",
                     "name": "Athelstan Amos",
                     "id": "46c1293aa9fe1981000dc753e75ebeee"
                  }
               }
            ]
         },
         "note": {
            "@type": "Note",
            "id": "afa9-3d90aaa8da0f",
            "text": "This is a work order task note."
         }
      }
   ],
   "note": {
      "@type": "Note",
      "id": "afa9-3d90aaa8da0f",
      "text": "This is a work order note."
   },
   "href": "api/sn_tmf_api/work_order_management_api/workOrder/ca6d72d1ffa96210b79dffffffffffa1"
}

Demande cURL

Crée une commande de travaux et une tâche sans utiliser de modèle.

curl "http://instance.servicenow.com/api/sn_tmf_api/work_order_management_api/workOrder" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
   "id": "323",
   "@type": "WorkOrder",
   "category": "service",
   "shortDescription": "Fixed Fibre Broadband Installation sb",
   "description": "Fixed Fibre description",
   "startDate": "2025-07-22T14:23:06.528Z",
   "requestedCompletionDate": "2024-06-22T14:23:06.528Z",
   "requestedStartDate": "2024-06-22T14:23:06.528Z",
   "priority": "2 - High",
   "expectedCompletionDate": "2025-07-28T14:23:06.528Z",
   "initiatedFrom": "d090df34df113100dca6a5f59bf26335",
   "place": {
      "@type": "GeographicSite",
      "id": "423e85f037d0200044e0bfc8bcbe5d12",
      "relatedParty": [
         {
            "role": "QualificationGroup",
            "id": "539546b237232000158bfc8bcbe5d7",
            "@type": "PartyRef",
            "@referredType": "Individual"
         }
      ]
   },
   "relatedParty": [
      {
         "@type": "RelatedPartyRef",
         "id": "d79249762fc1a610b79db3bf42faf3d2",
         "name": "Workforce Engineering Group",
         "role": "Company"
      },
      {
         "@type": "RelatedPartyRef",
         "id": "b88d14843bc02300bfe04d72f3efc4cd",
         "name": "Workforce Engineering Group",
         "role": "Contact"
      }
   ],
   "externalIdentifier": [
      {
         "@type": "ExternalIdentifier",
         "id": "1223412"
      }
   ],
   "workOrderItem": [
      {
         "@type": "WorkOrderItem",
         "action": "add",
         "id": "12232332",
         "description": "FTTH Installation",
         "completionDate": "2024-04-22T14:23:06.528Z",
         "work": {
            "@type": "WorkRefOrValue",
            "workType": "999469283bca10103f09080044efc4cf",
            "orderDate": "2024-04-22 14:23:06.528",
            "scheduledStartDate": "2025-06-25 14:23:06.528",
            "expectedCompletionDate": "2025-08-22 14:23:06.528",
            "workPriority": "2 - High",
            "place": [
               {
                  "@type": "RelatedPlaceRefOrValue",
                  "role": "string",
                  "place": {
                     "@type": "GeographicSite",
                     "id": "16ff753837d0200044e0bfc8bcbe5d5f"
                  }
               }
            ],
            "relatedParty": [
               {
                  "@type": "RelatedPartyRef",
                  "id": "4c0482b237232000158bbfc8bcbe5d09",
                  "name": "Louisiana Dispatchers",
                  "role": "DispatchGroup"
               }
            ],
            "workforceEmployeeAssignment": [
               {
                  "@type": "WorkforceEmployeeAssignment",
                  "id": "7172ea0037332000158bbfc8bcbe5db6",
                  "workforceEmployee": {
                     "@type": "Individual",
                     "name": "Athelstan Amos",
                     "id": "46c1293aa9fe1981000dc753e75ebeee"
                  }
               }
            ]
         },
         "note": {
            "@type": "Note",
            "id": "afa9-3d90aaa8da0f",
            "text": "This is a work order task note."
         }
      }
   ],
   "note": {
      "@type": "Note",
      "id": "afa9-3d90aaa8da0f",
      "text": "This is a work order note."
   }
}" \
--user 'username':'password'

Corps de la réponse.

{
   "id": "24fc3259ffa96210b79dffffffffff56",
   "@type": "WorkOrder",
   "category": "service",
   "shortDescription": "Fixed Fibre Broadband Installation sb",
   "description": "Fixed Fibre description",
   "startDate": "2025-07-22T14:23:06.528Z",
   "requestedCompletionDate": "2024-06-22T14:23:06.528Z",
   "requestedStartDate": "2024-06-22T14:23:06.528Z",
   "priority": "2 - High",
   "expectedCompletionDate": "2025-07-28T14:23:06.528Z",
   "initiatedFrom": "d090df34df113100dca6a5f59bf26335",
   "place": {
      "@type": "GeographicSite",
      "id": "423e85f037d0200044e0bfc8bcbe5d12",
      "relatedParty": [
         {
            "role": "QualificationGroup",
            "id": "539546b237232000158bfc8bcbe5d7",
            "@type": "PartyRef",
            "@referredType": "Individual"
         }
      ]
   },
   "relatedParty": [
      {
         "@type": "RelatedPartyRef",
         "id": "d79249762fc1a610b79db3bf42faf3d2",
         "name": "Workforce Engineering Group",
         "role": "Company"
      },
      {
         "@type": "RelatedPartyRef",
         "id": "b88d14843bc02300bfe04d72f3efc4cd",
         "name": "Workforce Engineering Group",
         "role": "Contact"
      }
   ],
   "externalIdentifier": [
      {
         "@type": "ExternalIdentifier",
         "id": "1223412"
      }
   ],
   "workOrderItem": [
      {
         "@type": "WorkOrderItem",
         "action": "add",
         "id": "12232332",
         "description": "FTTH Installation",
         "completionDate": "2024-04-22T14:23:06.528Z",
         "work": {
            "@type": "WorkRefOrValue",
            "workType": "999469283bca10103f09080044efc4cf",
            "orderDate": "2024-04-22 14:23:06.528",
            "scheduledStartDate": "2025-06-25 14:23:06.528",
            "expectedCompletionDate": "2025-08-22 14:23:06.528",
            "workPriority": "2 - High",
            "place": [
               {
                  "@type": "RelatedPlaceRefOrValue",
                  "role": "string",
                  "place": {
                     "@type": "GeographicSite",
                     "id": "16ff753837d0200044e0bfc8bcbe5d5f"
                  }
               }
            ],
            "relatedParty": [
               {
                  "@type": "RelatedPartyRef",
                  "id": "4c0482b237232000158bbfc8bcbe5d09",
                  "name": "Louisiana Dispatchers",
                  "role": "DispatchGroup"
               }
            ],
            "workforceEmployeeAssignment": [
               {
                  "@type": "WorkforceEmployeeAssignment",
                  "id": "7172ea0037332000158bbfc8bcbe5db6",
                  "workforceEmployee": {
                     "@type": "Individual",
                     "name": "Athelstan Amos",
                     "id": "46c1293aa9fe1981000dc753e75ebeee"
                  }
               }
            ]
         },
         "note": {
            "@type": "Note",
            "id": "afa9-3d90aaa8da0f",
            "text": "This is a work order task note."
         }
      }
   ],
   "note": {
      "@type": "Note",
      "id": "afa9-3d90aaa8da0f",
      "text": "This is a work order note."
   },
   "href": "api/sn_tmf_api/work_order_management_api/workOrder/24fc3259ffa96210b79dffffffffff56"
}