---
sourceDocument: Référence de l’API Xanadu
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/fr-FR/xanadu/api-reference

 Release :

    - xanadu

ft:locale :

    - fr-FR

ft:publication_title :

    - Référence de l’API Xanadu

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# Rendez-vous ouvert : POST /sn_tmf_api/rendez-vous/rendez-vous

# Rendez-vous ouvert : POST /sn_tmf_api/rendez-vous/rendez-vous {#ariaid-title1}

* Rversion finale: Xanadu
* 
* Mis à jour 1 août 2024
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 5 minutes de lecture

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

{#apptOpen-POST-appointment__table_lr2_mwt_dcc__entry__2}

| Nom | Description |
|-|-|
| Aucun |   |
[Tableau 1. Paramètres de chemin d'accès]

{#apptOpen-POST-appointment__table_lr2_mwt_dcc} {#apptOpen-POST-appointment__entry__6}

| Nom | Description |
|-|-|
| Aucun |   |
[Tableau 2. Paramètres de requête]

{#apptOpen-POST-appointment__entry__10}{#apptOpen-POST-appointment__serviceTest-response-testMeasureDefinition.thresholdRule.consequence.validFor}{#apptOpen-POST-appointment__serviceTest-response-testMeasureDefinition.thresholdRule.consequence.validFor.startDateTime}{#apptOpen-POST-appointment__serviceTest-response-testMeasureDefinition.thresholdRule.consequence.validFor.endDateTime}

| Nom | Description |
|-|-|
| catégorie | Requis. Le sys_id du créateur d'enregistrement configuré pour la configuration du service de Prise de rendez-vous. Le créateur d'enregistrement est défini dans le champ Élément de catalogue de l'enregistrement de configuration de service de Prise de rendez-vous connexe : table Configuration de service de Prise de rendez-vous \[sn_apptmnt_booking_service_config\]. Type de données : chaîne |
| entité connexe | Liste des commandes de travaux concernées. Type de données : tableau "relatedEntity": [ { "id": "String", "@referredType": "String" } ] |
| relatedEntity.id | Requis. Le sys_id de l'enregistrement situé dans la table Commande de travaux \[wm_order\]. Type de données : chaîne |
| relatedEntity.@referredType | Le type d'élément ou de service. Par exemple, `WorkOrder`. Type de données : chaîne |
| relatedEntity.role | Description du rôle de l'entité. Par exemple, `commande de travaux`. Type de données : chaîne |
| relatedParty | Liste des contacts pour le rendez-vous. Chaque contact est un objet dans le tableau. La demande doit énumérer au moins un élément qui contient des informations sur le compte client. Type de données : tableau "relatedParty": [ { "id": "String", "name": "String", "@referredType": "String", "role": "String" } ] |
| relatedParty.id | Requis. Le sys_id ou l'external_id du contact client associé à la commande de travaux. Situé dans la table Contact \[customer_contact\]. Type de données : chaîne |
| relatedParty.name | Nom du client. Type de données : chaîne |
| relatedParty.@referredType | Type de client. Par exemple, `Individuel`. Type de données : chaîne |
| relatedParty.role | Requis. Rôle prédéfini du contact. Par exemple, `client`. Type de données : chaîne |
| relatedPlace | Liste des lieux associés au rendez-vous. "relatedPlace": [ { "id": "String", "name": "String", "@referredType": "String", "role": "String" } ] Type de données : tableau |
| relatedPlace.id | Requis. sys_id du lieu répertorié dans la table Emplacements \[cmn_location\]. Type de données : chaîne |
| relatedPlace.name | Nom du lieu répertorié dans la table Emplacements \[cmn_location\]. Par exemple, `251 Reddy St, Darwin, CA 93522`. Type de données : chaîne |
| relatedPlace.@referredType | Type d'emplacement. Par exemple, `Ville`. Type de données : chaîne |
| relatedPlace.role | Description du rôle d'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é. |
| valideFor | Requis. Plage de dates pour laquelle le rendez-vous est valide. Type de données : objet "validFor": { "startDateTime": "String", "endDateTime": "String" } |
| valideFor.startDateTime | Date de début du créneau horaire. Format : JJ-MM-AAAA 00:00:00. Par exemple, `2025-01-31 09:35:43`. Type de données : chaîne |
| valideFor.endDateTime | Date de fin du créneau horaire. Format : JJ-MM-AAAA 00:00:00. Par exemple, `2025-01-31 09:35:43`. Type de données : chaîne |
[Tableau 3. Paramètres du corps de la demande]

## 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](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres.").
{#apptOpen-POST-appointment__entry__50}{#apptOpen-POST-appointment__accept-JSON-only-entry-RESTAPI}

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

{#apptOpen-POST-appointment__entry__54}{#apptOpen-POST-appointment__content_type-JSON-only-entry-RESTAPI}

| En-tête | Description |
|-|-|
| Content-Type | Format de données du corps de la demande. Prend uniquement en charge application/json. |
[Tableau 5. En-têtes de réponses]

## 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](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres.").
{#apptOpen-POST-appointment__entry__58}{#apptOpen-POST-appointment__entry-200-status-code}{#apptOpen-POST-appointment__entry-500-status-code}

| Code d'état | Description |
|-|-|
| 200 | Réussi. La demande a été correctement traitée. |
| 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. |
[Tableau 6. Codes d'état]

## Paramètres du corps de réponse

{#apptOpen-POST-appointment__entry__64}

| Nom | Description |
|-|-|
| catégorie | Le sys_id du créateur d'enregistrement configuré pour la configuration du service de Prise de rendez-vous. Le créateur d'enregistrement est défini dans le champ Élément de catalogue de l'enregistrement de configuration de service de Prise de rendez-vous connexe : table Configuration de service de Prise de rendez-vous \[sn_apptmnt_booking_service_config\]. Type de données : chaîne |
| creationDate | Date et heure de création de l'enregistrement du rendez-vous. Type de données : chaîne |
| id | La sys_id du rendez-vous créé. Situé dans la table Configuration du service Prise de rendez-vous \[sn_apptmnt_booking_service_config\]. Type de données : chaîne |
| href | Lien relatif à l'enregistrement du rendez-vous. Type de données : chaîne |
| lastUpdate (en anglais seulement) | Date et heure de dernière mise à jour de l'enregistrement du rendez-vous. Type de données : chaîne |
| entité connexe | Liste des commandes de travaux concernées. Type de données : tableau "relatedEntity": [ { "id": "String", "@referredType": "String" } ] |
| relatedEntity.id | Le sys_id de l'enregistrement situé dans la table Commande de travaux \[wm_order\]. Type de données : chaîne |
| relatedEntity.@referredType | Le type d'élément ou de service. Type de données : chaîne |
| relatedEntity.role | Description du rôle de l'entité. Type de données : chaîne |
| relatedParty | Liste des contacts pour le rendez-vous. Chaque contact est un objet dans le tableau. La demande doit énumérer au moins un élément qui contient des informations sur le compte client. Type de données : tableau "relatedParty": [ { "id": "String", "name": "String", "@referredType": "String", "role": "String" } ] |
| relatedParty.id | Le sys_id ou l'external_id du contact client associé à la commande de travaux. Situé dans la table Contact \[customer_contact\]. Type de données : chaîne |
| relatedParty.name | Nom du client. Type de données : chaîne |
| relatedParty.@referredType | Type de client. Type de données : chaîne |
| relatedParty.role | Rôle prédéfini du contact. Type de données : chaîne |
| relatedPlace | Liste des lieux associés au rendez-vous. "relatedPlace": [ { "id": "String", "name": "String", "@referredType": "String", "role": "String" } ] Type de données : tableau |
| relatedPlace.id | sys_id du lieu répertorié dans la table Emplacements \[cmn_location\]. Type de données : chaîne |
| relatedPlace.name | Nom du lieu répertorié dans la table Emplacements \[cmn_location\]. Type de données : chaîne |
| relatedPlace.@referredType | Type d'emplacement. Type de données : chaîne |
| relatedPlace.role | Description du rôle d'emplacement. Type de données : chaîne |
| Fuseau horaire | Fuseau horaire à utiliser lors de la réservation du créneau de rendez-vous spécifié. |
| valideFor | Plage de dates pour laquelle le rendez-vous est valide. Type de données : objet "validFor": { "startDateTime": "String", "endDateTime": "String" } |
| valideFor.startDateTime | Date de début du créneau horaire. Type de données : chaîne |
| valideFor.endDateTime | Date de fin du créneau horaire. Type de données : chaîne |
| succès | Marqueur indiquant si la demande a abouti. Valeurs possibles : * true : la demande a réussi. * faux : échec de la demande. Type de données : booléennes |
[ ]

## Demande cURL

L'exemple suivant montre comment créer une nouvelle réservation 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"
    }