API ouverte de rendez-vous

  • Rversion finale: Yokohama
  • Mis à jour 30 janv. 2025
  • 29 minutes de lecture
  • L’API ouverte de rendez-vous est une API de télécommunication qui vous permet d’interagir avec l’application de prise de rendez-vous. Utilisez cette API pour prendre des rendez-vous et rechercher des créneaux horaires disponibles.

    L’API Appointment Open est une ServiceNow® implémentation de la spécification de l’API REST Open API TMForum TMF646 Appointment et est certifiée par TM Forum. Cette implémentation est basée sur la spécification REST R16.0.1 de l’API de rendez-vous TMF646.

    Logo de conformité TMF
    Cette API nécessite les modules d’extension suivants disponibles sur le ServiceNow Store.
    • Prise de rendez-vous (com.snc.appointment_booking)
    • Gestion des services sur site (com.snc.work_management)
    • Gestion des services sur site pour les télécommunications (com.sn_fsmt)
    • API ouvertes de télécommunication (com.sn_tmf_api)

    Avant d’utiliser cette API, la configuration de Prise de rendez-vous et la configuration du service doivent être configurées. En outre, une tâche pour laquelle le rendez-vous est pris doit exister.

    Cette API est fournie dans l’espace de noms sn_tmf_api . L’utilisateur appelant doit avoir le rôle sn_tmf_api.appointment_integrator.

    Rendez-vous ouvert : SUPPRIMER /api/sn_tmf_api/appointment/appointment/{id}

    Supprime un enregistrement de rendez-vous avec un ID donné.

    Format d’URL

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

    Paramètres de demande pris en charge

    Tableau 1. Paramètres de chemin d’accès
    Nom Description
    id Sys_id de l’enregistrement de rendez-vous à supprimer.

    Type de données : chaîne

    Table : Prise de rendez-vous [sn_apptmnt_booking_appointment_booking]

    Tableau 2. Paramètres de requête
    Nom Description
    Aucune
    Tableau 3. Paramètres du corps de la demande (XML ou JSON)
    Nom Description
    Aucune

    En-têtes

    Les en-têtes de demande et de réponse suivants s’appliquent uniquement à cette action HTTP 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 des 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 des données du corps de la demande. 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é traitée avec succès.
    400 Demande incorrecte. Un type de demande incorrect ou une demande mal formée a été détecté.
    404 Introuvable. L’élément demandé est introuvable.

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

    Nom Description
    message Message de réponse accusant la suppression réussie.

    Réussite : « Le rendez-vous (<id>) est annulé avec succès. »

    Erreurs :
    • « Échec de l’annulation du rendez-vous. » : l’ID est introuvable dans le système et renvoie un code d’état 404.
    • « Échec de l’annulation du rendez-vous » : le rendez-vous est déjà à l’état Annulé ou Terminé, ou ne peut pas être supprimé, et renvoie un code d’état 404.
    • « Le rendez-vous (<id>) ne peut pas être annulé car il est au-delà de l’heure d’annulation. » : le rendez-vous est déjà au-delà de l’heure d’annulation, qui est configurée dans la configuration du service de réservation de rendez-vous. Renvoie un code d’état 400.

    Type de données : chaîne

    Demande cURL

    L’exemple suivant supprime un rendez-vous avec un ID spécifique.

    curl "http://instance.servicenow.com/api/sn_tmf_api/appointment/appointment/68cc0a5a9314521060320dd548373" \ 
    --request GET\ 
    --user 'username':'password' 

    Corps de réponse :

    "The appointment (68cc0a5a9314521060320dd548373cbd) is successfully cancelled."

    Rendez-vous ouvert : GET /api/sn_tmf_api/appointment/appointment

    Récupère une liste d’enregistrements de rendez-vous.

    Format d’URL

    URL par défaut : /api/sn_tmf_api/appointment/appointment

    Paramètres de demande pris en charge

    Tableau 7. Paramètres de chemin d’accès
    Nom Description
    Aucune
    Tableau 8. Paramètres de requête
    Nom Description
    catégorie Filtrez le rendez-vous par catégorie sys_id.

    Type de données : chaîne

    Table : emplacement [cmn_location]

    Par défaut : renvoie tous les rendez-vous si la sys_id de catégorie n’est pas fournie.

    Entité connexe Détails sur l’entité connexe associée à la commande de travaux.

    Type de données : objet

    "relatedEntity": {
      "id": "String"
    }
    relatedEntity.id Requis. Sys_id de l’entité connexe.

    Type de données : chaîne

    Table : workOrder [wm_order]

    Par défaut : renvoie tout si sys_id n’est pas fourni.

    Fête connexe Filtrez le rendez-vous en fonction de l’sys_id de la partie liée associée au rendez-vous.

    Type de données : objet

    "relatedParty": {
      "id": "String",
      "name": "String"
    }

    Par défaut : renvoie tous les rendez-vous s’ils relatedParty ne sont pas fournis.

    relatedParty.id Sys_id de la partie liée.

    Type de données : chaîne

    Table : utilisateur [sys_user]

    relatedParty.name Nom de la partie liée.

    Type de données : chaîne

    relatedPlace Filtrez le rendez-vous en fonction de l’endroit où l’intervention ou la réparation est prévue.

    Type de données : objet

    "relatedPlace": {
      "id": "String"
    }

    Par défaut : renvoie tous les rendez-vous s’ils relatedPlace ne sont pas fournis.

    relatedPlace.id Sys_id du lieu associé.

    Type de données : chaîne

    Table : emplacement [cmn_location]

    validFor Filtrez le rendez-vous selon une plage de dates pour laquelle le rendez-vous est valide.

    Type de données : objet

    "validFor":
    {
      "endDateTime": "String",
      "startDateTime": "String"
    }

    Par défaut : renvoie tous les rendez-vous s’ils validFor ne sont pas fournis.

    validFor.endDateTime Date et heure de fin du rendez-vous. Seuls les rendez-vous avec la date et l’heure de fin spécifiées sont renvoyés dans la réponse.

    Type de données : chaîne

    Format : AAAA-MM-JJ 00:00:00. Par exemple, 2025-01-31 09:35:43.

    Table : emplacement [cmn_location]

    validFor.startDateTime Date et heure de début du rendez-vous. Seuls les rendez-vous avec la date et l’heure de début spécifiées sont renvoyés dans la réponse.

    Type de données : chaîne

    Format : AAAA-MM-JJ 00:00:00. Par exemple, 2025-01-31 09:35:43.

    Table : emplacement [cmn_location]

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

    En-têtes

    Les en-têtes de demande et de réponse suivants s’appliquent uniquement à cette action HTTP 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 10. En-têtes de demandes
    En-tête Description
    Accepter Format des données du corps de la réponse. Types pris en charge : application/json ou application/xml.

    Par défaut : application/json

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

    Codes d'état

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

    Tableau 12. Codes d'état
    Code d'état Description
    200 Réussi. La demande a été traitée avec succès.
    400 Demande incorrecte. Un type de demande incorrect ou une demande mal formée a été détecté.
    404 Introuvable. L’élément demandé est introuvable.

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

    Nom Description
    catégorie Sys_id du créateur d’enregistrement configuré pour la configuration du service de prise de rendez-vous.

    Type de données : chaîne

    Stocké dans : champ Élément de catalogue de la table Configuration du service de Prise de rendez-vous [sn_apptmnt_booking_service_config].

    creationDate Date et heure de création du rendez-vous.

    Type de données : chaîne

    Format : AAAA-MM-JJ 00:00:00. Par exemple, 2025-01-31 09:35:43.

    href Lien hypertexte vers l’enregistrement de rendez-vous. Utilisez ce lien dans un autre rendez-vous Ouvrez une demande API pour replanifier ou supprimer le rendez-vous.

    Type de données : chaîne

    id Sys_id du rendez-vous.

    Type de données : chaîne

    Stocké dans : table Configuration du service de Prise de rendez-vous [sn_apptmnt_booking_service_config]

    lastUpdate Date et heure de la dernière mise à jour du rendez-vous.

    Type de données : chaîne

    Format : AAAA-MM-JJ 00:00:00. Par exemple, 2025-01-31 09:35:43.

    Entité connexe Détails sur l’entité connexe du rendez-vous.

    Type de données : tableau d’objets

    "relatedEntity": [
     {
      "@referredType": "String",
      "id": "String",
      "role": "String"
      }
    ]
    relatedEntity.@referredType Type d’élément ou de service.

    Type de données : chaîne

    Stocké dans : table workOrder [wm_order]

    relatedEntity.id Sys_id de l’entité connexe.

    Type de données : chaîne

    Stocké dans : table workOrder [wm_order]

    relatedEntity.role Description du rôle de l’entité connexe.

    Valeur possible : commande de travaux

    Type de données : chaîne

    Stocké dans : table workOrder [wm_order]

    Fête connexe Liste des contacts pour le rendez-vous. Chaque contact est un objet dans le tableau.

    Type de données : tableau d’objets

    "relatedParty": [
     {
      "@referredType": "String",
      "id": "String",
      "name": " String",
      "role": "String"
     }
    ]
    relatedParty.@referredType Type de client.

    Type de données : chaîne

    Stocké dans : Table des contacts [customer_contact]

    relatedParty.id Sys_id du contact client associé à la commande de travaux.

    Type de données : chaîne

    Stocké dans : Table des contacts [customer_contact]

    relatedParty.name Nom du contact client.

    Type de données : chaîne

    Stocké dans : Table des contacts [customer_contact]

    relatedParty.role Rôle du contact client.
    Valeurs possibles :
    • customer : le contact a un rôle client.
    • technicien : le contact a un rôle de technicien.

    Type de données : chaîne

    Stocké dans : Table des contacts [customer_contact]

    relatedPlace Détails du lieu du rendez-vous associé.

    Type de données : objet

    "relatedPlace": {
      "@referredType": "String",
      "id": "String",
      "name": "String",
      "role": "String"
    }
    relatedPlace.@referredType Adresse géographique du rendez-vous.

    Valeur possible : GeographicLocation.

    Type de données : chaîne

    Stocké dans : Table d’emplacement [cmn_location]

    relatedPlace.id Sys_id de l’emplacement.

    Type de données : chaîne

    Stocké dans : Table d’emplacement [cmn_location]

    relatedPlace.name Nom de l’emplacement associé au contact. Par exemple, 100 South Charles Street, Baltimore, MD.

    Type de données : chaîne

    Stocké dans : Table d’emplacement [cmn_location]

    relatedPlace.role Rôle du lieu de rendez-vous en tant qu’adresse d’intervention.

    Valeur possible : InterventionAddress

    Type de données : chaîne

    Stocké dans : Table d’emplacement [cmn_location]

    validFor Plage de dates pour laquelle le rendez-vous est valide.

    Type de données : objet

    "validFor": {
     "endDateTime": "String"
     "startDateTime": "String"
    }
    validFor.endDateTime Date et heure de fin du rendez-vous.

    Type de données : chaîne

    Format : AAAA-MM-JJ 00:00:00. Par exemple, 2025-01-31 09:35:43.

    validFor.startDateTime Date et heure de début du rendez-vous.

    Type de données : chaîne

    Format : AAAA-MM-JJ 00:00:00. Par exemple, 2025-01-31 09:35:43.

    Demande cURL

    L’exemple suivant montre comment renvoyer une liste de rendez-vous à l’aide de la méthode de rendez-vous GET.

    curl "http://instance.servicenow.com/api/sn_tmf_api/appointment/appointment" \ 
    --request GET\ 
    --user 'username':'password' 

    Le corps de la réponse contient les détails de deux rendez-vous différents configurés dans la configuration du service de prise de rendez-vous :

    [
      {
        "id": "201071ad4f80d210f8992fec52ce0ba9",
        "href": "api/sn_tmf_api/appointment/appointment/201071ad4f80d210f8992fec52ce0ba9",
        "validFor": {
          "startDateTime": "2024-08-16 17:00:00",
          "endDateTime": "2024-08-16 19:00:00"
        },
        "category": "4a34a64d4f4c1210f8992fec52ce0b63",
        "relatedParty": [
          {
            "id": "eaf68911c35420105252716b7d40ddde",
            "name": " null",
            "role": "customer",
            "@referredType": "Individual"
          }
        ],
        "relatedPlace": {
          "id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c",
          "name": "100 South Charles Street, Baltimore,MD",
          "role": "interventionAddress",
          "@referredType": "Individual"
        },
        "relatedEntity": [
          {
            "id": "b440a5694f40d210f8992fec52ce0ba3",
            "role": "work order",
            "@referredType": "WorkOrder"
          }
        ],
        "creationDate": "2024-08-16 00:39:22",
        "lastUpdate": "2024-08-16 00:39:22"
      },
      {
        "id": "25c012c07f5c5610f8994fa63c866523",
        "href": "api/sn_tmf_api/appointment/appointment/25c012c07f5c5610f8994fa63c866523",
        "validFor": {
          "startDateTime": "2024-08-26 17:00:00",
          "endDateTime": "2024-08-26 19:00:00"
        },
        "category": "4a34a64d4f4c1210f8992fec52ce0b63",
        "relatedParty": [
          {
            "id": "eaf68911c35420105252716b7d40ddde",
            "name": " null",
            "role": "customer",
            "@referredType": "Individual"
          }
        ],
        "relatedPlace": {
          "id": "f48b21850a0a0ba7004182b18099696d",
          "name": "11251 Rancho Carmel Drive, San Diego,CA",
          "role": "interventionAddress",
          "@referredType": "Individual"
        },
        "relatedEntity": [
          {
            "id": "c0b09a047f109610f8994fa63c8665b4",
            "role": "work order",
            "@referredType": "WorkOrder"
          }
        ],
        "creationDate": "2024-08-23 22:18:43",
        "lastUpdate": "2024-08-23 22:18:43"
      }
    ]

    Rendez-vous ouvert : GET /api/sn_tmf_api/appointment/appointment/{id}

    Récupère un enregistrement de rendez-vous associé à un ID spécifié.

    Format d’URL

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

    Paramètres de demande pris en charge

    Tableau 13. Paramètres de chemin d’accès
    Nom Description
    id Sys_id du rendez-vous à récupérer.

    Type de données : chaîne

    Table : Prise de rendez-vous [sn_apptmnt_booking_appointment_booking]

    Tableau 14. Paramètres de requête
    Nom Description
    catégorie Filtrez le rendez-vous par catégorie sys_id.

    Type de données : chaîne

    Table : emplacement [cmn_location]

    Par défaut : renvoie tous les rendez-vous si la sys_id de catégorie n’est pas fournie.

    Entité connexe Détails sur l’entité connexe associée à la commande de travaux.

    Type de données : objet

    "relatedEntity": {
      "id": "String"
    }
    relatedEntity.id Requis. Sys_id de l’entité connexe.

    Type de données : chaîne

    Table : workOrder [wm_order]

    Par défaut : renvoie tout si sys_id n’est pas fourni.

    Fête connexe Filtrez le rendez-vous en fonction de l’sys_id de la partie liée associée au rendez-vous.

    Type de données : objet

    "relatedParty": {
      "id": "String",
      "name": "String"
    }

    Par défaut : renvoie tous les rendez-vous s’ils relatedParty ne sont pas fournis.

    relatedParty.id Sys_id de la partie liée.

    Type de données : chaîne

    Table : utilisateur [sys_user]

    relatedParty.name Nom de la partie liée.

    Type de données : chaîne

    relatedPlace Filtrez le rendez-vous en fonction de l’endroit où l’intervention ou la réparation est prévue.

    Type de données : objet

    "relatedPlace": {
      "id": "String"
    }

    Par défaut : renvoie tous les rendez-vous s’ils relatedPlace ne sont pas fournis.

    relatedPlace.id Sys_id du lieu associé.

    Type de données : chaîne

    Table : emplacement [cmn_location]

    validFor Filtrez le rendez-vous selon une plage de dates pour laquelle le rendez-vous est valide.

    Type de données : objet

    "validFor":
    {
      "endDateTime": "String",
      "startDateTime": "String"
    }

    Par défaut : renvoie tous les rendez-vous s’ils validFor ne sont pas fournis.

    validFor.endDateTime Date et heure de fin du rendez-vous. Seuls les rendez-vous avec la date et l’heure de fin spécifiées sont renvoyés dans la réponse.

    Type de données : chaîne

    Format : AAAA-MM-JJ 00:00:00. Par exemple, 2025-01-31 09:35:43.

    Table : emplacement [cmn_location]

    validFor.startDateTime Date et heure de début du rendez-vous. Seuls les rendez-vous avec la date et l’heure de début spécifiées sont renvoyés dans la réponse.

    Type de données : chaîne

    Format : AAAA-MM-JJ 00:00:00. Par exemple, 2025-01-31 09:35:43.

    Table : emplacement [cmn_location]

    Tableau 15. Paramètres du corps de la demande (XML ou JSON)
    Nom Description
    Aucune

    En-têtes

    Les en-têtes de demande et de réponse suivants s’appliquent uniquement à cette action HTTP 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 16. En-têtes de demandes
    En-tête Description
    Accepter Format des données du corps de la réponse. Prend uniquement en charge application/json.
    Tableau 17. En-têtes de réponses
    En-tête Description
    Type de contenu Format des données du corps de la demande. 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é traitée avec succès.
    400 Demande incorrecte. Un type de demande incorrect ou une demande mal formée a été détecté.
    404 Introuvable. L’élément demandé est introuvable.

    Paramètres du corps de réponse

    Nom Description
    catégorie Sys_id du créateur d’enregistrement configuré pour la configuration du service de prise de rendez-vous.

    Type de données : chaîne

    Stocké dans : champ Élément de catalogue de la table Configuration du service de Prise de rendez-vous [sn_apptmnt_booking_service_config].

    creationDate Date et heure de création du rendez-vous.

    Type de données : chaîne

    Format : AAAA-MM-JJ 00:00:00. Par exemple, 2025-01-31 09:35:43.

    href Lien hypertexte vers l’enregistrement de rendez-vous. Utilisez ce lien dans un autre rendez-vous Ouvrez une demande API pour replanifier ou supprimer le rendez-vous.

    Type de données : chaîne

    id Sys_id du rendez-vous.

    Type de données : chaîne

    Stocké dans : table Configuration du service de Prise de rendez-vous [sn_apptmnt_booking_service_config]

    lastUpdate Date et heure de la dernière mise à jour du rendez-vous.

    Type de données : chaîne

    Format : AAAA-MM-JJ 00:00:00. Par exemple, 2025-01-31 09:35:43.

    Entité connexe Détails sur l’entité connexe du rendez-vous.

    Type de données : tableau d’objets

    "relatedEntity": [
     {
      "@referredType": "String",
      "id": "String",
      "role": "String"
      }
    ]
    relatedEntity.@referredType Type d’élément ou de service.

    Type de données : chaîne

    Stocké dans : table workOrder [wm_order]

    relatedEntity.id Sys_id de l’entité connexe.

    Type de données : chaîne

    Stocké dans : table workOrder [wm_order]

    relatedEntity.role Description du rôle de l’entité connexe.

    Valeur possible : commande de travaux

    Type de données : chaîne

    Stocké dans : table workOrder [wm_order]

    Fête connexe Liste des contacts pour le rendez-vous. Chaque contact est un objet dans le tableau.

    Type de données : tableau d’objets

    "relatedParty": [
     {
      "@referredType": "String",
      "id": "String",
      "name": " String",
      "role": "String"
     }
    ]
    relatedParty.@referredType Type de client.

    Type de données : chaîne

    Stocké dans : Table des contacts [customer_contact]

    relatedParty.id Sys_id du contact client associé à la commande de travaux.

    Type de données : chaîne

    Stocké dans : Table des contacts [customer_contact]

    relatedParty.name Nom du contact client.

    Type de données : chaîne

    Stocké dans : Table des contacts [customer_contact]

    relatedParty.role Rôle du contact client.
    Valeurs possibles :
    • customer : le contact a un rôle client.
    • technicien : le contact a un rôle de technicien.

    Type de données : chaîne

    Stocké dans : Table des contacts [customer_contact]

    relatedPlace Détails du lieu du rendez-vous associé.

    Type de données : objet

    "relatedPlace": {
      "@referredType": "String",
      "id": "String",
      "name": "String",
      "role": "String"
    }
    relatedPlace.@referredType Adresse géographique du rendez-vous.

    Valeur possible : GeographicLocation.

    Type de données : chaîne

    Stocké dans : Table d’emplacement [cmn_location]

    relatedPlace.id Sys_id de l’emplacement.

    Type de données : chaîne

    Stocké dans : Table d’emplacement [cmn_location]

    relatedPlace.name Nom de l’emplacement associé au contact. Par exemple, 100 South Charles Street, Baltimore, MD.

    Type de données : chaîne

    Stocké dans : Table d’emplacement [cmn_location]

    relatedPlace.role Rôle du lieu de rendez-vous en tant qu’adresse d’intervention.

    Valeur possible : InterventionAddress

    Type de données : chaîne

    Stocké dans : Table d’emplacement [cmn_location]

    validFor Plage de dates pour laquelle le rendez-vous est valide.

    Type de données : objet

    "validFor": {
     "endDateTime": "String"
     "startDateTime": "String"
    }
    validFor.endDateTime Date et heure de fin du rendez-vous.

    Type de données : chaîne

    Format : AAAA-MM-JJ 00:00:00. Par exemple, 2025-01-31 09:35:43.

    validFor.startDateTime Date et heure de début du rendez-vous.

    Type de données : chaîne

    Format : AAAA-MM-JJ 00:00:00. Par exemple, 2025-01-31 09:35:43.

    Demande cURL

    L’exemple suivant renvoie les détails du rendez-vous en fonction de l’ID d’enregistrement de rendez-vous donné.

    curl "http://instance.servicenow.com/api/sn_tmf_api/appointment/appointment/201071ad4f80d210f8992fec52ce0ba9" \ 
    --request GET\ 
    --user 'username':'password'

    Corps de réponse :

    [
      {
        "id": "201071ad4f80d210f8992fec52ce0ba9",
        "href": "api/sn_tmf_api/appointment/appointment/201071ad4f80d210f8992fec52ce0ba9",
        "validFor": {
          "startDateTime": "2024-08-16 17:00:00",
          "endDateTime": "2024-08-16 19:00:00"
        },
        "category": "4a34a64d4f4c1210f8992fec52ce0b63",
        "relatedParty": [
          {
            "id": "eaf68911c35420105252716b7d40ddde",
            "name": " null",
            "role": "customer",
            "@referredType": "Individual"
          }
        ],
        "relatedPlace": {
          "id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c",
          "name": "100 South Charles Street, Baltimore,MD",
          "role": "interventionAddress",
          "@referredType": "Individual"
        },
        "relatedEntity": [
          {
            "id": "b440a5694f40d210f8992fec52ce0ba3",
            "role": "work order",
            "@referredType": "WorkOrder"
          }
        ],
        "creationDate": "2024-08-16 00:39:22",
        "lastUpdate": "2024-08-16 00:39:22"
      }
    ]

    Rendez-vous ouvert : GET /api/sn_tmf_api/appointment/searchTimeSlot

    Renvoie les créneaux horaires qui ont été configurés dans la configuration du service de prise de rendez-vous ainsi que leur disponibilité.

    Format d’URL

    /api/sn_tmf_api/appointment/searchTimeSlot

    Paramètres de demande pris en charge

    Tableau 19. Paramètres de chemin d’accès
    Nom Description
    Aucune
    Tableau 20. Paramètres de requête
    Nom Description
    catalog_id Requis. Sys_id du créateur d’enregistrement configuré avec une configuration de service de réservation de rendez-vous.

    Type de données : chaîne

    Table : Créateur d’enregistrement [sc_cat_item_producer]

    end_date Requis. Date et heure de fin de la période pendant laquelle vous souhaitez rechercher le rendez-vous.

    Type de données : chaîne

    Format : AAAA-MM-JJ 00:00:00. Par exemple, 2025-01-31 12:00:00.

    Emplacement Sys_id du lieu du rendez-vous.

    Table : emplacement [cmn_location]

    Type de données : chaîne

    Par défaut : renvoie tous les emplacements s’ils ne sont pas spécifiés.

    opened_for Requis. Sys_id de l’utilisateur pour lequel le rendez-vous est réservé.

    Table : Contact [customer_contact]

    Type de données : chaîne

    start_date Requis. Date et heure de début de la période pendant laquelle vous souhaitez rechercher le rendez-vous.

    Type de données : chaîne

    Format : AAAA-MM-JJ 00:00:00. Par exemple, 2025-01-31 09:00:00.

    Tableau 21. Paramètres du corps de la demande
    Nom Description
    Aucune

    En-têtes

    Les en-têtes de demande et de réponse suivants s’appliquent uniquement à cette action HTTP 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 22. En-têtes de demandes
    En-tête Description
    Accepter Format des données du corps de la réponse. Prend uniquement en charge application/json.
    Tableau 23. En-têtes de réponses
    En-tête Description
    Aucune

    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é traitée avec succès.
    400 Demande incorrecte. Un type de demande incorrect ou une demande mal formée a été détecté.
    500 Erreur interne du serveur. Une erreur inattendue s’est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l’erreur.

    Paramètres du corps de réponse

    Nom Description
    availableTimeSlot Liste des créneaux de rendez-vous dans le bloc horaire spécifié demandé.

    Type de données : tableau d’objets

    'availableTimeSlot': [
     { 
      "available": Boolean,
      "end_date": "String",
      "end_date_display": "String",
      "end_dateUTC": "String",
      "start_date": "String",
      "start_date_display": "String",
      "start_dateUTC": "String"
     }
    ]
    availableTimeSlot.available Marqueur indiquant si le créneau horaire associé est disponible.
    Valeurs possibles :
    • vrai : un créneau horaire est disponible.
    • faux : le créneau horaire n’est pas disponible.

    Type de données : booléen

    availableTimeSlot.end_date Date et heure de fin du rendez-vous associé. Le fuseau horaire est basé sur la valeur du timeZone paramètre.

    Type de données : chaîne

    Format : AAAA-MM-JJ 00:00:00. Par exemple, 2025-01-31 09:35:43.

    availableTimeSlot.end_date_display Affichez la date et l’heure de fin du rendez-vous associé. Le fuseau horaire est basé sur la valeur du timeZone paramètre.

    Type de données : chaîne

    Format : AAAA-MM-JJ 00:00:00. Par exemple, 2025-01-31 09:35:43.

    availableTimeSlot.end_dateUTC Date et heure de fin du rendez-vous associé.

    Type de données : chaîne

    Format : UTC

    availableTimeSlot.start_date Date et heure de début du rendez-vous associé. Reflète la valeur du timeZone paramètre.

    Type de données : chaîne

    Format : AAAA-MM-JJ 00:00:00. Par exemple, 2025-01-31 09:35:43.

    availableTimeSlot.start_date_display Affichez la date et l’heure de début du rendez-vous associé. Reflète la valeur du timeZone paramètre.

    Type de données : chaîne

    Format : AAAA-MM-JJ 00:00:00. Par exemple, 2025-01-31 09:35:43.

    availableTimeSlot.start_dateUTC Date et heure de début du rendez-vous associé.

    Type de données : chaîne

    Format : UTC

    hasMore Marqueur indiquant s’il reste plus de créneaux de rendez-vous à extraire après avoir renvoyé la limite. La limite est spécifiée dans la propriété Prise de rendez-vous, sn_apptmnt_booking.max_appointments_returned (par défaut : 100). Consultez la rubrique Appointment booking components pour plus de détails sur cette propriété.
    Valeurs possibles :
    • vrai : plus de créneaux de rendez-vous peuvent être récupérés.
    • faux : plus aucun créneau de rendez-vous n’est disponible.

    Type de données : booléen

    noApptAvailable Marqueur indiquant s’il y a plus de créneaux de rendez-vous disponibles pour la date et l’heure spécifiées.
    Valeurs valides :
    • vrai : plus de créneaux de rendez-vous sont disponibles pour la date et l’heure spécifiées.
    • faux : plus aucun créneau de rendez-vous n’est disponible pour la date et l’heure spécifiées.

    Type de données : booléen

    searchResult (Résultat de recherche) Résultats pour la disponibilité des rendez-vous dans le créneau horaire de recherche désigné.
    Valeurs possibles :
    • réussite
    • échec

    Type de données : chaîne

    statut État d’achèvement de la recherche de créneaux horaires disponibles. Par exemple, terminé.

    Type de données : chaîne

    Fuseau horaire Fuseau horaire utilisé lors de la réservation ou de la mise à jour du créneau de rendez-vous spécifié.

    Type de date : chaîne

    Format : format pays/ville ou zone, tel que États-Unis/Est

    Demande cURL

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

    curl --location --request GET 'https://instance.service-now.com/api/sn_tmf_api/appointment/searchTimeSlot?
    start_date=2024-07-10 09:00:00&end_date=2024-07-20 23:00:00&catalog_id=ada50a93f0220210f8776517d8c8e776&
    opened_for=51670151c35420105252716b7d40ddfe&location=f48b21850a0a0ba7004182b18099696d ' \
    --user 'username':'password'

    Résultat :

    {
      "searchResult": "success",
      "status": "done",
      "availableTimeSlot": [
        {
          "start_date": "2024-07-10 09:00:00",
          "end_date": "2024-07-10 12:00:00",
          "start_date_display": "09:00",
          "end_date_display": "12:00",
          "start_dateUTC": "2024-07-10 16:00:00",
          "end_dateUTC": "2024-07-10 19:00:00",
          "available": false
        },
        {
          "start_date": "2024-07-11 13:00:00",
          "end_date": "2024-07-11 16:00:00",
          "start_date_display": "13:00",
          "end_date_display": "16:00",
          "start_dateUTC": "2024-07-11 20:00:00",
          "end_dateUTC": "2024-07-11 23:00:00",
          "available": true
        },
        {
          "start_date": "2024-07-12 09:00:00",
          "end_date": "2024-07-12 12:00:00",
          "start_date_display": "09:00",
          "end_date_display": "12:00",
          "start_dateUTC": "2024-07-12 16:00:00",
          "end_dateUTC": "2024-07-12 19:00:00",
          "available": true
        },
        {
          "start_date": "2024-07-12 13:00:00",
          "end_date": "2024-07-12 16:00:00",
          "start_date_display": "13:00",
          "end_date_display": "16:00",
          "start_dateUTC": "2024-07-12 20:00:00",
          "end_dateUTC": "2024-07-12 23:00:00",
          "available": true
        },
        {
          "start_date": "2024-07-19 13:00:00",
          "end_date": "2024-07-19 16:00:00",
          "start_date_display": "13:00",
          "end_date_display": "16:00",
          "start_dateUTC": "2024-07-19 20:00:00",
          "end_dateUTC": "2024-07-19 23:00:00",
          "available": true
        }
      ],
      "hasMore": false,
      "noApptAvailable": false,
      "timeZone": "US/Arizona"
    }

    Rendez-vous ouvert : PATCH /api/sn_tmf_api/appointment/appointment/{id}

    Replanifier des rendez-vous avec un ID donné pour une commande de travaux.

    Format d’URL

    URL par défaut : PATCH /api/sn_tmf_api/appointment/appointment/{id}

    Paramètres de demande pris en charge

    Tableau 25. Paramètres de chemin d’accès
    Nom Description
    id Sys_id du rendez-vous à replanifier.

    Type de données : chaîne

    Table : Prise de rendez-vous [sn_apptmnt_booking_appointment_booking]

    Tableau 26. Paramètres de requête
    Nom Description
    Aucune
    Tableau 27. Paramètres du corps de la demande (JSON)
    Nom Description
    remarque Si vous annulez le rendez-vous, vous pouvez ajouter des notes de travail ici. Met à jour les notes de travail de la commande de travaux et le message du rendez-vous.

    Type de données : tableau d’objets

    "note": [ 
     {
      "author": "String", 
      "date": "String", 
      "text": "String"
     }
    ]

    Stocké dans : Table Prise de rendez-vous [sn_apptmnt_booking_appointment_booking]

    note.auteur Nom de la personne qui écrit la note.

    Type de données : chaîne

    Note.Date Date et heure de publication de la note.

    Type de données : chaîne

    Format : AAAA-MM-JJ 00:00:00. Par exemple, 2018-02-04T11:00:18.071Z.

    note.texte Texte descriptif de la commande de travaux jointe au rendez-vous. Par exemple, des mises à jour sur l’avancement de la commande de travaux.

    Type de données : chaîne

    statut État du rendez-vous.

    Valeurs valides :

    • annulé : la replanification du rendez-vous est annulée.
    • terminé : le rendez-vous replanifié est terminé.
    • confirmé : la replanification du rendez-vous est acceptée et réservée.
    • nouveau : la demande de replanification de rendez-vous a été créée récemment.
    • en attente : la replanification du rendez-vous est en attente.
    • prêt : la replanification du rendez-vous est demandée.

    Type de données : chaîne

    validFor Filtrez le rendez-vous selon une plage de dates pour laquelle le rendez-vous est valide.

    Type de données : objet

    "validFor":
    {
      "endDateTime": "String",
      "startDateTime": "String"
    }

    Par défaut : renvoie tous les rendez-vous s’ils validFor ne sont pas fournis.

    validFor.endDateTime Date et heure de fin du rendez-vous. Seuls les rendez-vous avec la date et l’heure de fin spécifiées sont renvoyés dans la réponse.

    Type de données : chaîne

    Format : AAAA-MM-JJ 00:00:00. Par exemple, 2025-01-31 09:35:43.

    Table : emplacement [cmn_location]

    validFor.startDateTime Date et heure de début du rendez-vous. Seuls les rendez-vous avec la date et l’heure de début spécifiées sont renvoyés dans la réponse.

    Type de données : chaîne

    Format : AAAA-MM-JJ 00:00:00. Par exemple, 2025-01-31 09:35:43.

    Table : emplacement [cmn_location]

    En-têtes

    Les en-têtes de demande et de réponse suivants s’appliquent uniquement à cette action HTTP 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 28. En-têtes de demandes
    En-tête Description
    Accepter Format des données du corps de la réponse. Prend uniquement en charge application/json.
    Tableau 29. En-têtes de réponses
    En-tête Description
    Type de contenu Format des données du corps de la demande. Prend uniquement en charge application/json.

    Codes d'état

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

    Tableau 30. Codes d'état
    Code d'état Description
    200 Réussi. La demande a été traitée avec succès.
    500 Erreur interne du serveur. Une erreur inattendue s’est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l’erreur.

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

    Nom Description
    creationDate Date et heure de création du rendez-vous.

    Type de données : chaîne

    Format : AAAA-MM-JJ 00:00:00. Par exemple, 2025-01-31 09:35:43.

    href Lien de référence unique du rendez-vous. Vous pouvez utiliser ce lien dans une autre demande pour obtenir un rendez-vous.

    Type de données : chaîne

    id Sys_id du rendez-vous qui a été replanifié.

    Type de données : chaîne

    Stocké dans : table Prise de rendez-vous [sn_apptmnt_booking_appointment_booking]

    lastUpdate Date et heure de la dernière mise à jour du rendez-vous.

    Type de données : chaîne

    Format : AAAA-MM-JJ 00:00:00. Par exemple, 2025-01-31 09:35:43.

    motif Objet de la mise à jour du rendez-vous.

    Valeurs possibles :

    • « Rendez-vous replanifié. » : la méthode PATCH a été utilisée pour replanifier le rendez-vous.
    • « Le rendez-vous (ID) est annulé avec succès. » : la méthode PATCH a été utilisée pour annuler le rendez-vous.

    Type de données : chaîne

    Fête connexe Détails sur le client du rendez-vous associé.

    Type de données : tableau d’objets

    "relatedParty": [
      {
      "@referredType": "String",
      "id": "String",
      "name": "String",
      "role": "String"
      }
    ]
    relatedParty.id Sys_id du contact client.

    Type de données : chaîne

    Stocké dans : Table des contacts [customer_contact]

    relatedParty.name Nom du contact client.

    Type de données : chaîne

    relatedPlace.@referredType Type de client.

    Type de données : chaîne

    Seule valeur possible : Individuel

    relatedParty.role Rôle du contact.

    Type de données : chaîne

    Seule valeur possible : Contact

    réussite Marqueur indiquant si la demande a abouti.
    Valeurs possibles :
    • vrai : le rendez-vous a été replanifié avec succès.
    • faux : le rendez-vous n’a pas pu être replanifié.

    Type de données : booléen

    Demande cURL

    L’exemple suivant montre comment utiliser une méthode PATCH pour replanifier un rendez-vous avec un ID donné.

    curl -X POST 'https://instance.service-now.com/api/sn_tmf_api/appointment/appointment/68cc0a5a9314521060320dd548373cbd ' \ 
    -H "Accept: application/json" \ 
    -H "Content-Type: application/json" \ 
    -u "username":"password" \ 
    -data {
      "validFor": { 
          "startDateTime": "2024-07-30 00:0:00", 
          "endDateTime": "2024-08-30 00:00:00" 
                  }
      "note": {
          "date": "85388c25b71011104eed4643ae11a993",
          "author": "Sarah Johnson",
          "text": "customer"
        }
      "state": "active"
       }
      ]
    }

    Le corps de la réponse affiche un message de réussite indiquant que le rendez-vous a été replanifié.

    {
      "relatedParty": [
        {
          "id": "85388c25b71011104eed4643ae11a993",
          "name": "Sarah Johnson",
          "role": "customer",
          "@referredType": "Individual"
        }
      ],
      "success": true,
      "reason": "Appointment rescheduled!",
      "id": "68cc0a5a9314521060320dd548373cbd",
      "href": "api/sn_tmf_api/appointment/appointment/68cc0a5a9314521060320dd548373cbd",
      "creationDate": "2024-08-30 20:56:54",
      "lastUpdate": "2024-08-30 20:56:54"
    }

    Rendez-vous ouvert : POST /api/sn_tmf_api/appointment/appointment

    Vous permet de prendre rendez-vous pour une commande de travaux.

    Format d’URL

    /api/sn_tmf_api/rendez-vous/rendez-vous

    Paramètres de demande pris en charge

    Tableau 31. Paramètres de chemin d’accès
    Nom Description
    Aucune
    Tableau 32. Paramètres de requête
    Nom Description
    Aucune
    Tableau 33. Paramètres du corps de la demande
    Nom Description
    catégorie Requis. Sys_id du créateur d’enregistrement configuré pour la configuration du service de prise de rendez-vous.

    Type de données : chaîne

    Table : dans le champ Élément de catalogue de la table Configuration du service de Prise de rendez-vous [sn_apptmnt_booking_service_config].

    Entité connexe Requis. Liste des commandes de travaux impactées à associer au rendez-vous.

    Type de données : tableau d’objets

    "relatedEntity": [
      {
        "@referredType": "String"
        "id": "String",
      }
    ]
    relatedEntity.@referredType Requis. Type d’élément ou de service.

    Seule valeur valide : WorkOrder

    Type de données : chaîne

    Table : commande de travaux [wm_order]

    relatedEntity.id Requis. Sys_id de l’entité connexe.

    Type de données : chaîne

    Table : workOrder [wm_order]

    Par défaut : renvoie tout si sys_id n’est pas fourni.

    relatedEntity.role Requis. Description du rôle de l’entité connexe.

    Seule valeur valide : commande de travaux

    Type de données : chaîne

    Table : commande de travaux [wm_order]

    Fête connexe Requis. Liste des contacts pour le rendez-vous. Chaque contact est un objet dans le tableau. La demande doit répertorier au moins un élément qui contient des informations de compte client.

    Type de données : tableau d’objets

    "relatedParty": [ 
     {
      "@referredType": "String",
      "id": "String",
      "name": "String",
      "role": "String"
     }
    ]
    relatedParty.@referredType Type de client.

    Seule valeur valide : Individuel

    Type de données : chaîne

    relatedParty.id Requis. Sys_id ou external_id du contact associé à la commande de travaux.

    Type de données : chaîne

    Table : Contact [customer_contact]

    relatedParty.name Nom du contact.

    Type de données : chaîne

    Table : Contact [customer_contact]

    relatedParty.role Requis. Rôle du contact.
    Valeurs possibles :
    • customer : le contact a un rôle client.
    • technicien : le contact a un rôle de technicien.

    Type de données : chaîne

    Table : Contact [customer_contact]

    relatedPlace Requis. Liste des lieux associés au rendez-vous.

    Type de données : tableau d’objets

    "relatedPlace": [
     {
      "@referredType": "String",
      "id": "String",
      "name": "String",
      "role": "String"
     }
    ]
    relatedPlace.@referredType Requis. Type d’emplacement. Par exemple, Ville.

    Type de données : chaîne

    Table : emplacements [cmn_location]

    relatedPlace.id Requis. Sys_id de l’emplacement associé.

    Type de données : chaîne

    Table : emplacements [cmn_location]

    relatedPlace.name Nom de l’emplacement associé au contact. Par exemple, 251 Reddy St, Darwin, CA 93522.

    Type de données : chaîne

    Table : emplacements [cmn_location]

    relatedPlace.role Requis. Description du rôle de l’emplacement. Par exemple, commande de travaux.

    Type de données : chaîne

    Fuseau horaire Requis. Fuseau horaire à utiliser lors de la réservation du créneau de rendez-vous spécifié.

    Type de date : chaîne

    Format : format pays/ville ou zone, tel que États-Unis/Est

    validFor Requis. Plage de dates pour laquelle le rendez-vous est valide.

    Type de données : objet

    "validFor": {
      "endDateTime": "String",
      "startDateTime": "String"
    }
    validFor.endDateTime Requis. Date et heure de fin du créneau horaire.

    Type de données : chaîne

    Format : AAAA-MM-JJ 00:00:00. Par exemple, 2025-01-31 09:35:43.

    validFor.startDateTime Requis. Date et heure de début du créneau horaire.

    Type de données : chaîne

    Format : AAAA-MM-JJ 00:00:00. Par exemple, 2025-01-31 09:35:43.

    En-têtes

    Les en-têtes de demande et de réponse suivants s’appliquent uniquement à cette action HTTP 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 34. En-têtes de demandes
    En-tête Description
    Accepter Format des données du corps de la réponse. Prend uniquement en charge application/json.
    Tableau 35. En-têtes de réponses
    En-tête Description
    Type de contenu Format des données du corps de la demande. 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 36. Codes d'état
    Code d'état Description
    200 Réussi. La demande a été traitée avec succès.
    500 Erreur interne du serveur. Une erreur inattendue s’est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l’erreur.

    Paramètres du corps de réponse

    Nom Description
    catégorie Sys_id du créateur d’enregistrement configuré pour la configuration du service de prise de rendez-vous.

    Type de données : chaîne

    Stocké dans : champ Élément de catalogue de la table Configuration du service de Prise de rendez-vous [sn_apptmnt_booking_service_config].

    creationDate Date et heure de création du rendez-vous.

    Type de données : chaîne

    Format : AAAA-MM-JJ 00:00:00. Par exemple, 2025-01-31 09:35:43.

    href Lien hypertexte vers l’enregistrement de rendez-vous. Utilisez ce lien dans un autre rendez-vous Ouvrez une demande API pour replanifier ou supprimer le rendez-vous.

    Type de données : chaîne

    id Sys_id du rendez-vous.

    Type de données : chaîne

    Stocké dans : table Configuration du service de Prise de rendez-vous [sn_apptmnt_booking_service_config]

    lastUpdate Date et heure de la dernière mise à jour du rendez-vous.

    Type de données : chaîne

    Format : AAAA-MM-JJ 00:00:00. Par exemple, 2025-01-31 09:35:43.

    Entité connexe Détails sur l’entité connexe du rendez-vous.

    Type de données : tableau d’objets

    "relatedEntity": [
     {
      "@referredType": "String",
      "id": "String",
      "role": "String"
      }
    ]
    relatedEntity.@referredType Type d’élément ou de service.

    Type de données : chaîne

    Stocké dans : table workOrder [wm_order]

    relatedEntity.id Sys_id de l’entité connexe.

    Type de données : chaîne

    Stocké dans : table workOrder [wm_order]

    relatedEntity.role Description du rôle de l’entité connexe.

    Valeur possible : commande de travaux

    Type de données : chaîne

    Stocké dans : table workOrder [wm_order]

    Fête connexe Liste des contacts pour le rendez-vous. Chaque contact est un objet dans le tableau.

    Type de données : tableau d’objets

    "relatedParty": [
     {
      "@referredType": "String",
      "id": "String",
      "name": " String",
      "role": "String"
     }
    ]
    relatedParty.@referredType Type de client.

    Type de données : chaîne

    Stocké dans : Table des contacts [customer_contact]

    relatedParty.id Sys_id du contact client associé à la commande de travaux.

    Type de données : chaîne

    Stocké dans : Table des contacts [customer_contact]

    relatedParty.name Nom du contact client.

    Type de données : chaîne

    Stocké dans : Table des contacts [customer_contact]

    relatedParty.role Rôle du contact client.
    Valeurs possibles :
    • customer : le contact a un rôle client.
    • technicien : le contact a un rôle de technicien.

    Type de données : chaîne

    Stocké dans : Table des contacts [customer_contact]

    relatedPlace Détails du lieu du rendez-vous associé.

    Type de données : objet

    "relatedPlace": {
      "@referredType": "String",
      "id": "String",
      "name": "String",
      "role": "String"
    }
    relatedPlace.@referredType Adresse géographique du rendez-vous.

    Valeur possible : GeographicLocation.

    Type de données : chaîne

    Stocké dans : Table d’emplacement [cmn_location]

    relatedPlace.id Sys_id de l’emplacement.

    Type de données : chaîne

    Stocké dans : Table d’emplacement [cmn_location]

    relatedPlace.name Nom de l’emplacement associé au contact. Par exemple, 100 South Charles Street, Baltimore, MD.

    Type de données : chaîne

    Stocké dans : Table d’emplacement [cmn_location]

    relatedPlace.role Rôle du lieu de rendez-vous en tant qu’adresse d’intervention.

    Valeur possible : InterventionAddress

    Type de données : chaîne

    Stocké dans : Table d’emplacement [cmn_location]

    réussite Marqueur indiquant si la demande a abouti.
    Valeurs possibles :
    • vrai : la demande a réussi.
    • faux : échec de la demande.

    Type de données : booléen

    Fuseau horaire Fuseau horaire utilisé lors de la réservation ou de la mise à jour du créneau de rendez-vous spécifié.

    Type de date : chaîne

    Format : format pays/ville ou zone, tel que États-Unis/Est

    validFor Plage de dates pour laquelle le rendez-vous est valide.

    Type de données : objet

    "validFor": {
     "endDateTime": "String"
     "startDateTime": "String"
    }
    validFor.endDateTime Date et heure de fin du rendez-vous.

    Type de données : chaîne

    Format : AAAA-MM-JJ 00:00:00. Par exemple, 2025-01-31 09:35:43.

    validFor.startDateTime Date et heure de début du rendez-vous.

    Type de données : chaîne

    Format : AAAA-MM-JJ 00:00:00. Par exemple, 2025-01-31 09:35:43.

    Demande cURL

    L’exemple suivant montre comment créer une prise de rendez-vous.

    curl "https://instance.servicenow.com/api/sn_tmf_api/appointment/appointment" \
    --request POST \
    --header "Accept:application/json" \
    --header "Content-Type:application/json" \
    --data "{
      \"validFor\": {
        \"startDateTime\": \"2024-08-19 09:00:00\",
        \"endDateTime\": \"2024-08-19 11:00:00\"
      },
      \"category\": \"e4c1116b3b810300ce8a4d72f3efc40f\",
      \"relatedParty\": [
        {
          \"id\": \"eaf68911c35420105252716b7d40ddde\",
          \"name\": \"Sally Thomas\",
          \"role\": \"customer\",
          \"@referredType\": \"Individual\"
        }
      ],
      \"relatedPlace\": {
        \"id\": \"25ab9c4d0a0a0bb300f7dabdc0ca7c1c\",
        \"name\": \"100 South Charles Street, Baltimore,MD\",
        \"role\": \"interventionAddress\",
        \"@referredType\": \"GeographicAddress\"
      },
      \"relatedEntity\": [
        {
          \"id\": \"48dbfbf9201f0250f877303e8a020dcd\",
          \"role\": \"work order\",
          \"@referredType\": \"WorkOrder\"
        }
      ],
      \"timeZone\": \"US/Arizona\"
    }" \
    --user 'username':'password'

    Réponse :

    {
      "validFor": {
        "startDateTime": "2024-07-19 09:00:00",
        "endDateTime": "2024-07-19 11:00:00"
      },
      "category": "e4c1116b3b810300ce8a4d72f3efc40f",
      "relatedParty": [
        {
          "id": "eaf68911c35420105252716b7d40ddde",
          "name": "Sally Thomas",
          "role": "customer",
          "@referredType": "Individual"
        }
      ],
      "relatedPlace": {
        "id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c",
        "name": "100 South Charles Street, Baltimore,MD",
        "role": "interventionAddress",
        "@referredType": "GeographicAddress"
      },
      "relatedEntity": [
        {
          "id": "48dbfbf9201f0250f877303e8a020dcd",
          "role": "work order",
          "@referredType": "WorkOrder"
        }
      ],
      "timeZone": "US/Arizona",
      "success": true,
      "id": "feacb7f9201f0250f877303e8a020d38",
      "href": "api/sn_tmf_api/appointment/appointment/feacb7f9201f0250f877303e8a020d38",
      "creationDate": "2024-07-10 22:45:01",
      "lastUpdate": "2024-07-10 22:45:01"
    }