Rendez-vous ouvert : POST /sn_tmf_api/rendez-vous/rendez-vous
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
| Nom | Description |
|---|---|
| Aucun |
| Nom | Description |
|---|---|
| Aucun |
| 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 | 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 | 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.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 |
| valideFor.startDateTime | Date de début du créneau horaire. Format : JJ-MM-AAAA 00:00:00. Par exemple, Type de données : chaîne |
| valideFor.endDateTime | Date de fin du créneau horaire. Format : JJ-MM-AAAA 00:00:00. Par exemple, Type de données : chaîne |
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.
| En-tête | Description |
|---|---|
| Accepter | Format de données du corps de la réponse. Prend uniquement en charge application/json. |
| En-tête | Description |
|---|---|
| Content-Type | Format de 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.
| 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. |
Paramètres du corps de réponse
| 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 | 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 | 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.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 |
| 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 :
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"
}