API de réservation WSD
L’API Prestation de services sur le lieu de travailde réservation (WSD) fournit des points de terminaison pour la gestion des réservations de lieu de travail.
Pour accéder à cette API, l’appelant doit avoir le rôle sn_wsd_core.workplace_user et les modules d’extension Workplace Safety Management (sn_wsd_core) et Workplace Reservation Management (sn_wsd_rsv) doivent être activés.
Cette API s’exécute dans l’espace de noms sn_wsd_rsv .
Pour plus d’informations sur , reportez-vous à Gestion des réservations du lieu de travailla rubrique Gestion des réservations du lieu de travail.
Réservation WSD : GET /api/sn_wsd_rsv/reservation/get
Récupère la réservation du lieu de travail spécifiée.
Format d'URL
URL versionnée : /api/sn_wsd_rsv/{api_version}/reservation/get
URL par défaut : /api/sn_wsd_rsv/reservation/get
Paramètres de demande pris en charge
| Nom | Description |
|---|---|
| api_version | Facultatif. Version du point de terminaison auquel accéder. 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 |
| Nom | Description |
|---|---|
| external_ical | Identification iCalendar externe unique de la réservation. Utilisez cette valeur pour identifier la réservation lorsqu’il s’agit d’une réservation liée à la synchronisation du calendrier. Obtenez cette valeur à partir de l’application iCalendar externe associée. Type de données : chaîne |
| external_id | Identification externe unique de la réservation. Utilisez cette valeur pour identifier la réservation lorsqu’il s’agit d’une réservation liée à la synchronisation du calendrier. Obtenez cette valeur à partir de l’application externe associée. Type de données : chaîne |
| include_multi_child_data | Si la valeur du champ reservation_subtype de l’enregistrement Réservation du lieu de travail [sn_wsd_rsv_reservation] associé est définie sur multi_child, ce marqueur indique s’il faut renvoyer les détails de la réservation. Valeurs valides :
Type de données : booléennes Valeur par défaut : faux |
| include_standard_services | Marqueur indiquant s’il faut renvoyer les informations sur les services standard dans la réponse. Un service standard décrit les dispositions de base disponibles avec un élément d’espace de travail réservable au moment de la réservation, telles que des tableaux blancs, des moniteurs supplémentaires et des services similaires. Pour plus d’informations sur les services standard, reportez-vous à la section Services standard. Ces informations figurent dans la table Service standard [sn_wsd_rsv_standard_service]. Valeurs valides :
Type de données : booléennes Valeur par défaut : false |
| sys_id | Requis. Sys_id de l’enregistrement de réservation. Situé dans la table Réservation du lieu de travail [sn_wsd_rsv_reservation]. Type de données : chaîne |
| 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.
| En-tête | Description |
|---|---|
| Accepter | Format de données du corps de la demande. Types pris en charge : application/json, application/xml ou, text/xml. Valeur par défaut : application/json |
| En-tête | Description |
|---|---|
| Aucun |
Codes d'état
Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.
| Code d'état | Description |
|---|---|
| 200 | Réussi. La demande a été correctement traitée. |
| 401 | Non autorisé. Les informations d'identification de l'utilisateur sont incorrectes ou n'ont pas été transmises. |
| 404 | Introuvable. L’élément demandé est introuvable. |
| 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 |
|---|---|
| résultat.réservation | Détails de la réservation. Type de données : objet |
| result.reservation.active | Marqueur indiquant si la réservation est active. Valeurs valides :
Type de données : booléennes |
| résultat.réservation.participants | Liste des participants à la réservation. Type de données : tableau d’objets |
| résultat.réservation.participants.avatar | Sys_id de l’avatar associé au participant. Situé dans la table Pièces jointes [sys_attachment]. Type de données : chaîne |
| résultat.réservation.participants.displayValue | Valeur d’affichage pour le participant. Type de données : chaîne |
| result.reservation.attendees.display_value | Valeur d’affichage du participant. Identique à displayValue. Type de données : chaîne |
| result.reservation.attendees.email | Adresse e-mail du participant. Type de données : chaîne |
| résultat.réservation.participants.initiales | Initiales du participant. Type de données : chaîne |
| result.reservation.attendees.name | Nom du participant. Type de données : chaîne |
| result.reservation.attendees.sys_id | Sys_id_of l’enregistrement du participant. Type de données : chaîne |
| résultat.réservation.participants.table | Table dans laquelle se trouve l’enregistrement du participant. Type de données : chaîne |
| result.reservation.attendees.user_name | Nom d’utilisateur du participant. Type de données : chaîne |
| résultat.réservation.participants.valeur | Valeur interne du participant. Type de données : chaîne |
| result.reservation.check_in_state | Détails sur l’état d’enregistrement de la réservation. Type de données : objet |
| result.reservation.check_in_state.display_value | Valeur d’affichage de l’état d’enregistrement actuel de la réservation, par exemple En cours ou Terminé. Type de données : chaîne |
| result.reservation.check_in_state.valeur | Valeur interne de l’état d’enregistrement actuel de la réservation, par exemple 2. Type de données : chaîne |
| result.reservation.edit_restriction | Description des restrictions de modification utilisateur pour la réservation, telles que no_restrictions, service_only ou fully_restricted. Type de données : objet |
| result.reservation.edit_restriction.display_value | Valeur d’affichage des restrictions de modification de la réservation, par exemple Aucune restriction. Type de données : chaîne |
| result.reservation.edit_restriction.valeur | Valeur interne des restrictions de modification de la réservation, telle que no_restriction. Type de données : chaîne |
| résultat.réservation.fin | Date et heure de fin de la réservation. Type de données : chaîne Format : UTC : aaaa-mm-jjThh :mm :ssZ, comme 2021-02-05T18:00:00Z |
| result.reservation.external_ical | Identification iCalendar externe unique de la réservation. Utilisez cette valeur pour identifier la réservation lorsqu’il s’agit d’une réservation liée à la synchronisation du calendrier. Type de données : chaîne |
| result.reservation.external_id | Identification externe unique de la réservation. Utilisez cette valeur pour identifier la réservation lorsqu’il s’agit d’une réservation liée à la synchronisation du calendrier. Type de données : chaîne |
| result.reservation.is_parent | Marqueur indiquant si cette réservation est une réservation parente. Valeurs possibles :
Type de données : booléennes |
| result.reservation.is_private | Marqueur indiquant si la réservation est privée. Si elle est privée, la réservation n’apparaît à personne d’autre qu’au propriétaire. Pour plus d’informations sur ces paramètres de confidentialité, consultez la section Paramètres de confidentialité de la localisation et impact. Valeurs valides :
Type de données : booléennes Par défaut : valeur définie pour la confidentialité dans les propriétés système. |
| result.reservation.last_updated_sub_source | Détails sur la dernière sous-source mise à jour pour la réservation. Les sous-sources sont utilisées lors de l’intégration des réservations à un calendrier externe. Cet objet contient des informations telles que « servicenow_workplace_service_delivery », « google_calendar » ou « microsoft_exchange ». Type de données : objet |
| result.reservation.last_updated_sub_source.display_value | Valeur d’affichage de la dernière sous-source mise à jour de la réservation, telle que ServiceNow Workplace Service Delivery ou Google Agenda. Utilisé lors de l’intégration de la réservation à un service externe tel que Google Agenda ou Microsoft Outlook. Type de données : chaîne |
| result.reservation.last_updated_sub_source.valeur | Valeur interne de la dernière sous-source mise à jour de la réservation, telle que servicenow_workplace_service_delivery ou google_calendar. Utilisé lors de l’intégration de la réservation à un service externe tel que Google Agenda ou Microsoft Outlook. Type de données : chaîne |
| résultat.réservation.emplacement | Détails sur l’emplacement associé à la réservation. Type de données : objet |
| résultat.réservation.emplacement.zone | Détails sur la zone associée à l’emplacement. Type de données : objet |
| result.reservation.location.area.active | Marqueur indiquant si la zone est active. Valeurs valides :
Type de données : booléennes |
| result.reservation.location.area.display_value | Valeur d’affichage de la zone à laquelle cet emplacement appartient, par exemple Bureau A2. Type de données : chaîne |
| result.reservation.location.area.sys_id | Sys_id de la zone à laquelle cet emplacement appartient. Situé dans la table Zone [sn_wsd_core_area]. Type de données : chaîne |
| résultat.réservation.emplacement.bâtiment | Détails sur le bâtiment associé à l’emplacement. Type de données : objet |
| result.reservation.location.building.active | Marqueur indiquant si le bâtiment est actif. Valeurs valides :
Type de données : booléennes |
| result.reservation.location.building.display_value | Valeur d’affichage du bâtiment auquel cet emplacement appartient, telle que AMS - Bld1. Type de données : chaîne |
| result.reservation.location.building.sys_id | Sys_id du bâtiment auquel cet emplacement appartient. Situé dans la table du bâtiment [sn_wsd_core_building]. Type de données : chaîne |
| résultat.réservation.emplacement.bâtiment.fuseau horaire | Détails sur le fuseau horaire associé à l’emplacement. Type de données : objet |
| result.reservation.location.building.timezone.display_value | Valeur d’affichage du fuseau horaire auquel cet emplacement appartient. Type de données : chaîne |
| résultat.réservation.emplacement.bâtiment.fusehoraire.valeur | Valeur interne du fuseau horaire auquel cet emplacement appartient. Type de données : chaîne |
| résultat.réservation.emplacement.campus | Détails sur le campus associé à l’emplacement. Type de données : objet |
| result.reservation.location.campus.active | Marqueur indiquant si le campus est actif. Valeurs valides :
Type de données : booléennes |
| result.reservation.location.campus.display_value | Valeur d’affichage du campus auquel cet emplacement appartient, par exemple Campus d’Amsterdam. Type de données : chaîne |
| result.reservation.location.campus.sys_id | Sys_id du campus auquel cet emplacement appartient. Situé dans la table Campus [sn_wsd_core_campus]. Type de données : chaîne |
| résultat.réservation.emplacement.capacité | Nombre maximal d’occupants pour l’emplacement. Type de données : nombre |
| résultat.réservation.emplacement.description | Brève description de l’emplacement. Type de données : chaîne |
| result.reservation.location.display_value | Valeur à afficher dans l’interface utilisateur pour cet emplacement. Type de données : chaîne |
| result.reservation.location.email | Adresse e-mail de l’emplacement. Type de données : chaîne |
| résultat.réservation.emplacement.étage | Détails sur l’étage associé à l’emplacement. Type de données : objet |
| result.reservation.location.floor.active | Marqueur indiquant si l’étage est actif. Valeurs valides :
Type de données : booléennes |
| result.reservation.location.floor.display_value | Valeur d’affichage de l’étage auquel cet emplacement appartient, par exemple Premier étage. Type de données : chaîne |
| result.reservation.location.floor.sys_id | Sys_id de l’étage auquel cet emplacement appartient. Situé dans la table Étage [sn_wsd_core_floor]. Type de données : chaîne |
| result.reservation.location.label_value | Type de valeur spécifiée dans le paramètre, telle que le nom de la name salle. Type de données : chaîne |
| result.reservation.location.name | Nom de l'emplacement. Type de données : chaîne |
| résultat.réservation.emplacement.number | Numéro de réservation. Type de données : chaîne |
| result.reservation.location.number_of_attendees | Nombre de participants pour la réservation. Type de données : nombre |
| résultat.réservation.emplacement.région | Détails sur la région associée à l’emplacement. Type de données : objet |
| result.reservation.location.region.active | Marqueur indiquant si la région est active. Valeurs valides :
Type de données : booléennes |
| result.reservation.location.region.display_value | Valeur d’affichage de la région à laquelle cet emplacement appartient, par exemple Europe. Type de données : chaîne |
| result.reservation.location.region.sys_id | Sys_id de la région à laquelle cet emplacement appartient. Situé dans la table Région [sn_wsd_core_region]. Type de données : chaîne |
| result.reservation.location.requested_for | Détails sur la personne pour laquelle la réservation a été demandée. Type de données : objet |
| result.reservation.location.requested_for.nom | Nom de l’utilisateur pour lequel la réservation a été demandée. Type de données : chaîne |
| result.reservation.location.requested_for.sys_id | Sys_id de l’utilisateur pour lequel la réservation est demandée. Situé dans la table Utilisateur [sys_user]. Type de données : chaîne |
| result.reservation.location.requested_for.user_name | Nom d’utilisateur de l’utilisateur pour lequel la réservation a été demandée. Type de données : chaîne |
| résultat.réservation.emplacement.réservation | Détails sur la réservation associée à l’emplacement. Type de données : objet |
| result.reservation.location.reservation.active | Marqueur indiquant si la réservation est active. Valeurs valides :
Type de données : booléennes |
| résultat.réservation.emplacement.numéro.réservation | Numéro de réservation. Type de données : chaîne |
| result.reservation.location.reservation.number_of_attendees | Nombre de participants de la réservation. Type de données : nombre |
| result.reservation.location.reservation.requested_for | Détails sur la personne pour laquelle la réservation a été demandée. Type de données : objet |
| result.reservation.location.reservation.requested_for.name | Nom de l’utilisateur pour lequel la réservation a été demandée. Type de données : chaîne |
| result.reservation.location.reservation.requested_for.sys_id | Sys_id de l’utilisateur demandé. Situé dans la table Utilisateur [sys_user]. Type de données : chaîne |
| result.reservation.location.reservation.requested_for.user_name | Nom d’utilisateur de l’utilisateur pour lequel la réservation a été demandée. Type de données : chaîne |
| result.reservation.location.reservable_module | Détails sur le module réservable associé à la réservation. Type de données : objet |
| result.reservation.location.reservable_module.inline_title | Titre en ligne du module réservable. Le titre s’affiche conformément au texte descriptif sur le portail de services Workplace. Type de données : chaîne |
| result.reservation.location.reservable_module.nom | Nom du module réservable. Type de données : chaîne |
| result.reservation.location.reservable_module.sys_id | Sys_id du module réservable. Type de données : chaîne |
| result.reservation.location.reservable_module.titre | Titre du module réservable. Type de données : chaîne |
| result.reservation.location.site | Site auquel l’emplacement appartient. Situé dans la table Site [sn_wsd_core_site]. Type de données : objet |
| result.reservation.location.site.active | Marqueur indiquant si le site est actif. Valeurs valides :
Type de données : booléennes |
| result.reservation.location.site.display_value | Valeur d’affichage du site auquel cet emplacement appartient, par exemple Europe de l’Ouest. Type de données : chaîne |
| result.reservation.location.site.sys_id | Sys_id du site auquel cet emplacement appartient. Situé dans la table Site [sn_wsd_core_site]. Type de données : chaîne |
| résultat.réservation.emplacement.état | Détails sur l’état de la réservation pour l’emplacement. Type de données : objet |
| result.reservation.location.state.display_value | Valeur d’affichage de l’état actuel de la réservation, tel que confirmé. Type de données : chaîne |
| résultat.réservation.emplacement.état.valeur | Valeur interne de l’état actuel de la réservation, par exemple « 2 ». Type de données : chaîne |
| result.reservation.location.sys_id | Sys_id de l’enregistrement d’emplacement associé. Situé dans la table Emplacement du lieu de travail [sn_wsd_core_workplace_location]. Type de données : chaîne |
| result.reservation.notification_custom_message | Message personnalisé pour la notification envoyée aux destinataires répertoriés dans reservation.notification_recipients. Type de données : chaîne |
| result.reservation.notification_recipients | Liste des destinataires qui reçoivent une notification concernant la réservation. Type de données : tableau d’objets |
| result.reservation.notification_recipients.name | Nom du destinataire. Type de données : chaîne |
| result.reservation.notification_recipients.sys_id | Sys_id du destinataire. Situé dans la table Utilisateur [sys_user]. Type de données : chaîne |
| result.reservation.notification_recipients.user_name | Nom d’utilisateur du destinataire. Type de données : chaîne |
| numéro.réservation.résultat | Numéro unique de l’enregistrement de réservation. Situé dans la table Réservation du lieu de travail [sn_wsd_rsv_reservation]. Vous pouvez utiliser cette valeur pour interroger la réservation. Type de données : chaîne |
| result.reservation.opened_by | Détails sur l’utilisateur qui a créé la réservation. Type de données : objet |
| result.reservation.opened_by.avatar | Avatar de l’utilisateur qui a ouvert la réservation. Type de données : chaîne |
| result.reservation.opened_by.displayValue | Valeur d’affichage de l’utilisateur ouvert. Type de données : chaîne |
| result.reservation.opened_by.display_value | Valeur d’affichage de l’utilisateur ouvert. Type de données : chaîne |
| result.reservation.opened_by.email | Adresse e-mail de l’utilisateur qui a ouvert la réservation. Type de données : chaîne |
| result.reservation.opened_by.initiales | Initiales de l’utilisateur qui a ouvert la réservation. Type de données : chaîne |
| result.reservation.opened_by.label | Étiquette de l’utilisateur qui a ouvert la réservation. Il s’agit d’une combinaison du titre et du département de l’utilisateur. Type de données : chaîne |
| result.reservation.opened_by.name | Nom de l’utilisateur qui a ouvert la réservation. Type de données : chaîne |
| result.rservation.opened_by.sys_id | Sys_id_of l’utilisateur qui a ouvert la réservation. Situé dans la table Utilisateur [sys_user]. Type de données : chaîne |
| result.rservation.opened_by.table | Table contenant l’enregistrement de l’utilisateur. Type de données : chaîne |
| result.reservation.opened_by.user_name | Nom d’utilisateur de l’utilisateur qui a ouvert la réservation. Type de données : chaîne |
| result.reservation.opened_by.valeur | Valeur interne de l’utilisateur qui a ouvert la réservation. Type de données : chaîne |
| numéro.réservation.résultat | Numéro de réservation. Type de données : chaîne |
| result.reservation.number_of_attendees | Nombre de participants dans cette réservation. Type de données : nombre |
| result.reservation.recording_details | Détails sur les enregistrements associés à la réservation (réunion). Type de données : tableau |
| result.reservation.recording_details.recording_url | URL des enregistrements associés à la réservation. Type de données : chaîne |
| result.reservation.requested_for | Détails sur l’utilisateur au nom duquel la réservation a été effectuée. Type de données : objet |
| result.reservation.requested_for.avatar | Avatar de l’utilisateur au nom duquel la réservation a été effectuée. Type de données : chaîne |
| result.reservation.requested_for.displayValue | Valeur d’affichage de l’utilisateur au nom duquel la réservation a été effectuée. Type de données : chaîne |
| result.reservation.requested_for.display_value | Valeur d’affichage de l’utilisateur au nom duquel la réservation a été effectuée. Identique à displayValue. Type de données : chaîne |
| result.reservation.requested_for.email | Adresse e-mail de l’utilisateur au nom duquel la réservation a été effectuée. Type de données : chaîne |
| result.reservation.requested_for.initials | Initiales de l’utilisateur au nom duquel la réservation a été effectuée. Type de données : chaîne |
| result.reservation.requested_for.étiquette | Étiquette de l’utilisateur au nom duquel la réservation a été effectuée. Type de données : chaîne |
| result.reservation.requested_for.name | Nom de l’utilisateur au nom duquel la réservation a été effectuée. Type de données : chaîne |
| result.rservation.requested_for.sys_id | Sys_id_of l’utilisateur au nom duquel la réservation a été effectuée. Situé dans la table Utilisateur [sys_user]. Type de données : chaîne |
| result.rservation.requested_for.table | Table contenant l’enregistrement de l’utilisateur. Type de données : chaîne |
| result.reservation.requested_for.user_name | Nom d’utilisateur de l’utilisateur au nom duquel la réservation a été effectuée. Type de données : chaîne |
| result.reservation.requested_for.valeur | Valeur interne de l’utilisateur au nom duquel la réservation a été effectuée. Type de données : chaîne |
| result.reservation.reservable_module | Détails du module réservable demandé. Type de données : objet |
| result.reservation.reservable_module.allow_invitees | Marqueur indiquant si les employés sont en mesure d’ajouter des invités à la réservation. Valeurs valides :
Type de données : booléennes |
| result.reservation.reservable_module.allow_whole_day | Marqueur indiquant si les utilisateurs peuvent réserver le réservable pour toute la journée. Valeurs valides :
Type de données : booléennes |
| result.reservation.reservable_module.apply_to_shift | Marqueur indiquant si les réservations basées sur l’équipe sont activées pour le module réservable. Valeurs valides :
Type de données : booléennes |
| result.reservation.reservable_module.browse_by_area_enabled | Marqueur indiquant si les utilisateurs sont en mesure de rechercher des modules réservables par zone. Valeurs valides :
Type de données : booléennes |
| result.reservation.reservable_module.browse_near_a_person_enabled | Marqueur indiquant si les utilisateurs sont en mesure de rechercher des modules réservables situés par une personne spécifiée. Valeurs valides :
Type de données : booléennes |
| result.reservation.reservable_module.buildingSysIds | Liste des sys_ids des bâtiments associés au module réservable. Type de données : tableau de chaînes |
| result.reservation.reservable_module.checkin_before_minutes | Délai avant le début d’une réservation pendant lequel un utilisateur peut enregistrer sa réservation. Unité : Minutes Type de données : nombre |
| result.reservation.reservable_module.display_number_of_attendees | Marqueur indiquant si les utilisateurs peuvent spécifier le nombre de participants dans la réservation. Valeurs valides :
Type de données : booléennes |
| result.reservation.reservable_module.display_on_behalf_of | Marqueur indiquant si les réservations peuvent être effectuées au nom de quelqu’un d’autre. Valeurs valides :
Type de données : booléennes |
| result.reservation.reservable_module.display_sensitivity | Marqueur indiquant si les utilisateurs peuvent définir la sensibilité de la réservation, comme normal ou privé. Valeurs valides :
Type de données : booléennes |
| result.reservation.reservable_module.display_value | Valeur d’affichage du module réservable. Type de données : chaîne |
| result.reservation.reservable_module.enable_browse_by_area | Marqueur indiquant si les utilisateurs sont en mesure de rechercher des modules réservables par zone. Identique à browse_by_area_enabled. Valeurs valides :
Type de données : booléennes |
| result.reservation.reservable_module.enable_browse_near_a_person | Marqueur indiquant si les utilisateurs sont en mesure de rechercher des modules réservables situés par une personne spécifiée. Identique à browse_near_a_person_enabled. Valeurs valides :
Type de données : booléennes |
| result.reservation.reservable_module.enable_facet_filter | Marqueur indiquant si le filtrage des facettes sur les éléments du lieu de travail est activé. Lorsque cette option est activée, les options de filtre qui s’affichent sont basées sur les résultats de la recherche. Seuls les éléments disponibles dans les résultats de recherche générés sont sélectionnables par les utilisateurs dans le filtre. Valeurs valides :
Type de données : booléennes |
| result.reservation.reservable_module.enable_group_reservations | Marqueur indiquant si les utilisateurs peuvent effectuer une réservation de groupe. Valeurs valides :
Type de données : booléennes |
| result.reservation.reservable_module.enable_ical_generation | Marqueur indiquant si les utilisateurs peuvent générer un iCalendar pour la réservation. Valeurs valides :
Type de données : booléennes |
| result.reservation.reservable_module.font_awesome_icon | Nom de l’icône de police jointe au module réservable. Type de données : chaîne |
| result.reservation.reservable_module.inline_title | Titre en ligne du module réservable. Le titre s’affiche conformément au texte descriptif sur le portail de services Workplace. Type de données : chaîne |
| result.reservation.reservable_module.layout_mapping | Détails sur la structure du mappage de mise en page des emplacements. Utilisez ces données pour mettre en page les informations dans l’interface utilisateur. Type de données : objet |
| result.reservation.reservable_module.layout_mapping.corps | Espace réservé pour le mappage des données de l’interface utilisateur frontale. Type de données : tableau d’objets |
| result.reservation.reservable_module.layout_mapping.corps.champ | Espace réservé pour le mappage des données de l’interface utilisateur frontale. Type de données : chaîne |
| result.reservation.reservable_module.layout_mapping.body.field_to_display | Espace réservé pour le mappage des données de l’interface utilisateur frontale. Type de données : chaîne |
| result.reservation.reservable_module.layout_mapping.corps.icône | Espace réservé pour le mappage des données de l’interface utilisateur frontale. Type de données : chaîne |
| result.reservation.reservable_module.layout_mapping.corps.étiquette | Espace réservé pour le mappage des données de l’interface utilisateur frontale. Type de données : chaîne |
| result.reservation.reservable_module.layout_mapping.description | Espace réservé pour le mappage des données de l’interface utilisateur frontale. Description du mappage de mise en page. Type de données : tableau |
| result.reservation.reservable_module.layout_mapping.image | Espace réservé pour le mappage des données de l’interface utilisateur frontale. Type de données : chaîne |
| result.reservation.reservable_module.layout_mapping.sous-titre | Espace réservé pour le mappage des données de l’interface utilisateur frontale. Type de données : tableau |
| result.reservation.reservable_module.layout_mapping.subtitle_asc | Espace réservé pour le mappage des données de l’interface utilisateur frontale. Type de données : tableau |
| result.reservation.reservable_module.layout_mapping.titre | Espace réservé pour le mappage des données de l’interface utilisateur frontale. Type de données : tableau |
| result.reservation.reservable_module.max_days_in_future | Nombre maximal de jours dans le futur pendant lesquels un utilisateur peut réserver le module réservable. Type de données : nombre |
| result.reservation.reservable_module.max_occurrences | Nombre maximal d’occurrences de réservation récurrentes si des réservations récurrentes sont disponibles pour le module réservable. Type de données : nombre |
| result.reservation.reservable_module.name | Nom du module réservable. Type de données : chaîne |
| result.reservation.reservable_module.override_approval_policy | Option permettant de spécifier la méthode d'implémentation de la politique d'approbation. Les choix sont les suivants :
Type de données : chaîne |
| result.reservation.reservable_module.require_cancel_notes | Marqueur indiquant si les utilisateurs doivent saisir une note d’annulation avant d’annuler un module réservable. Valeurs valides :
Type de données : booléennes |
| result.reservation.reservable_module.require_cc_dept_check | Marqueur indiquant s’il faut vérifier s’il existe une incompatibilité de centre de coûts ou de département entre l’élément de l’espace de travail et l’utilisateur connecté. Valeurs valides :
Type de données : booléennes |
| result.reservation.reservable_module.require_subject | Marqueur indiquant si l’utilisateur doit saisir un objet lors de la réservation. Valeurs valides :
Type de données : booléennes |
| result.reservation.reservable_module.reservable_columns | Liste des colonnes d’un réservable. Situé dans la table Emplacement du lieu de travail [sn_wsd_core_workplace_location]. Type de données : tableau |
| result.reservation.reservable_module.reservable_container_field | Niveau du conteneur, par exemple un groupe de bureaux dans une zone spécifique. Type de données : chaîne |
| result.reservation.reservable_module.reservable_filter | Conditions de filtre utilisées pour filtrer les éléments réservables dans la table réservable associée. La table réservable est un champ de la table Module réservable [sn_wsd_rsv_reservable_module]. Ces conditions de filtre ont été appliquées à la table contenue dans le champ Table réservable. Type de données : chaîne |
| result.reservation.reservable_module.reservable_quantity_field | Quantité réservable de tous les espaces. La quantité est utilisée lors de l’affectation d’espaces de quartier à une zone. Pour plus d’informations, reportez-vous à la rubrique Affecter des espaces de quartier à une zone. Type de données : chaîne |
| result.reservation.reservable_module.reservable_table | Table contenant les éléments du lieu de travail réservables. Type de données : chaîne |
| result.reservation.reservable_module.reservable_type | Type de l’élément réservable, tel que l’emplacement. Type de données : chaîne |
| result.reservation.reservable_module.reservable_views | Détails sur les différentes vues associées au module réservable, telles que la vue de carte ou la vue de calendrier. Situé dans la table Vue réservable [sn_wsd_rsv_reservable_view]. Type de données : objet |
| result.reservation.reservable_module.reservable_views.iconClass | Classe d’icône de la vue réservable. Type de données : chaîne |
| result.reservation.reservable_module.reservable_views.isDefault | Marqueur indiquant s’il faut faire de cette vue réservable la valeur par défaut pour les modules réservables. Valeurs valides :
Type de données : booléennes |
| result.reservation.reservable_module.reservable_views.étiquette | Nom de la vue réservable. Type de données : chaîne |
| result.reservation.reservable_module.reservable_views.commande | Ordre dans lequel les vues sont affichées pour le module réservable dans l’interface utilisateur. Le numéro d’ordre inférieur vient en premier dans l’interface utilisateur. Dans le cas du même numéro d’ordre, un ordre aléatoire lui est attribué. Type de données : nombre |
| result.reservation.reservable_module.reservable_views.type | Nom back-end de la vue réservable. Utilisé pour le traitement interne. Type de données : chaîne |
| result.reservation.reservable_module.reservation_paths | Chemins de réservation associés aux modules réservables tels que Tout parcourir, Explorer à proximité d’une personne. Type de données : tableau d’objets |
| result.reservation.reservable_module.reservation_paths.display_value | Valeur d’affichage du chemin de réservation, par exemple « Explorer à proximité d’une personne ». Type de données : chaîne |
| result.reservation.reservable_module.reservation_paths.valeur | Valeur interne du chemin de réservation, telle que « browse_near_a_person ». Type de données : chaîne |
| result.reservation.reservable_module.search_limit | Nombre maximal de résultats de recherche à renvoyer lorsqu’un utilisateur recherche un emplacement de lieu de travail. Type de données : nombre |
| result.reservation.reservable_module.selection_type | Type de sélection à afficher dans les résultats de la recherche. Peut être l’une des options suivantes :
Type de données : chaîne |
| result.reservation.reservable_module.short_description | Brève description du module réservable. Type de données : chaîne |
| result.reservation.reservable_module.show_map_view | Marqueur indiquant s’il faut activer la vue de carte pour les modules réservables. Valeurs valides :
Type de données : booléennes |
| result.reservation.reservable_module.sys_id | Sys_id du module réservable. Type de données : chaîne |
| result.reservation.reservable_module.timeSlots | Détails sur les créneaux horaires associés à un module réservable. Type de données : tableau d’objets |
| result.reservation.reservable_module.timeSlots.name | Nom du créneau horaire Type de données : chaîne |
| result.reservation.reservable_module.timeSlots.short_description | Brève description du créneau horaire. Type de données : chaîne |
| result.reservation.reservable_module.timeSlots.slot_end | Heure de fin du créneau horaire Type de données : chaîne |
| result.reservation.reservable_module.timeSlots.slot_start | Heure de début du créneau. Type de données : chaîne |
| result.reservation.reservable_module.timeSlots.sys_id | Sys_id de l’enregistrement de créneau horaire. Situé dans la table Créneau horaire [sn_wsd_rsv_time_slot]. Type de données : chaîne |
| result.reservation.reservable_module.titre | Titre du module réservable. Type de données : chaîne |
| result.reservation.reservable_module.virtual_meeting_provider | Détails sur le fournisseur virtuel associé au module réservable. Type de données : objet |
| result.reservation.reservable_module.virtual_meeting_provider.display_value | Valeur d’affichage du fournisseur de réunion virtuelle. Type de données : chaîne |
| result.reservation.reservable_module.virtual_meeting_provider.sys_id | Sys_id du fournisseur de réunion virtuelle. Type de données : chaîne |
| résultat.réservation.reservationAcl | Détails des vérifications des niveaux de contrôle d’accès (ACL) de l’utilisateur définies sur la réservation associée. Type de données : objet |
| result.reservation.reservationAcl.read | Marqueur indiquant s’il faut vérifier si l’utilisateur peut lire cette réservation. Valeurs valides :
Type de données : booléennes |
| résultat.reservation.reservationAcl.write | Détails sur les options d’écriture de l’utilisateur pour la réservation associée. Type de données : objet |
| résultat.réservation.reservationAcl.write.allFields | Marqueur indiquant s’il faut vérifier si l’utilisateur peut écrire dans tous les champs spécifiés dans l’objet reservationACL.write.fields . Si l’utilisateur n’a accès qu’à certains champs spécifiques, seuls ces champs sont vrais dans l’objet reservationACL.write.fields . Valeurs valides :
Type de données : booléennes |
| result.reservation.reservationAcl.write.fields | Détails des contrôles d’accès sur différents champs de la réservation. Type de données : objet |
| résultat.réservation.reservationAcl.écrire.champs.emplacement | Marqueur indiquant s’il faut vérifier si l’utilisateur peut écrire dans les champs d’emplacement de cette réservation. Valeurs valides :
Type de données : booléennes |
| result.reservation.reservationAcl.write.fields.number_of_attendees | Marqueur indiquant s’il faut vérifier si l’utilisateur peut écrire dans les champs Nombre de participants de cette réservation. Valeurs valides :
Type de données : booléennes |
| result.reservation.reservationAcl.write.fields.requested_for | Marqueur indiquant s’il faut vérifier si l’utilisateur peut écrire dans les champs demandés pour cette réservation. Valeurs valides :
Type de données : booléennes |
| résultat.réservation.reservationAcl.écrire.champs.sensibilité | Marqueur indiquant s’il faut vérifier si l’utilisateur peut écrire dans les champs de sensibilité de cette réservation. Valeurs valides :
Type de données : booléennes |
| résultat.reservation.reservationAcl.write.fields.subject | Marqueur indiquant s’il faut vérifier si l’utilisateur peut écrire dans les champs d’objet de cette réservation. Valeurs valides :
Type de données : booléennes |
| résultat.réservation.reservationAcl.write.record | Marqueur indiquant s’il faut vérifier si l’utilisateur peut écrire dans l’intégralité de l’enregistrement de réservation. Valeurs valides :
Type de données : booléennes |
| result.reservation.reservation_purpose | Détails sur l’objet de la réservation. Type de données : objet |
| result.reservation.reservation_purpose.display_value | Valeur d’affichage aux fins de la réservation, telle qu’une réunion d’entreprise. Type de données : chaîne |
| result.reservation.reservation_purpose.valeur | Valeur interne aux fins de la réservation, telle que company_meeting. Type de données : chaîne |
| result.reservation.reservation_type | Détails sur le type de réservation. Type de données : objet |
| result.reservation.reservation_type.display_value | Valeur d’affichage du type de réservation, telle que l’espace. Type de données : chaîne |
| result.reservation.reservation_type.valeur | Valeur interne du type de réservation, telle que l’espace. Type de données : chaîne |
| result.reservation.reservation_subtype | Détails sur le sous-type de la réservation. Les sous-types indiquent le type de réservation, par exemple unique, multiparentale, multi-enfant, parent récurrent ou occurrence. Type de données : objet |
| result.reservation.reservation_subtype.display_value | Valeur d’affichage du sous-type de la réservation, par exemple Unique. Type de données : chaîne |
| result.reservation.reservation_subtype.valeur | Valeur interne du sous-type de la réservation, par exemple unique. Type de données : chaîne |
| résultat.réservation.sensibilité | Détails sur le niveau de sensibilité de la réservation. Type de données : objet |
| result.reservation.sensitivity.display_value | Valeur d’affichage de la sensibilité de la réservation, par exemple élevée ou faible. Type de données : chaîne |
| résultat.réservation.sensibilité.valeur | Valeur interne de la sensibilité de la réservation, telle que 1 ou 3. Type de données : chaîne |
| résultat.réservation.shift | Détails sur l’équipe appliquée à la réservation. Type de données : objet |
| result.reservation.shift.display_value | Valeur d’affichage de l’équipe. Type de données : chaîne |
| result.reservation.shift.name | Nom de l'équipe. Identique à display_value. Type de données : chaîne |
| Résultat.réservation.équipe.shiftDetails | Détails de l’équipe. Type de données : chaîne |
| result.reservation.shift.sys_id | Sys_id de l’enregistrement d’équipe. Situé dans la table Équipe [sn_wsd_core_shift]. Type de données : chaîne |
| résultat.réservation.source | Détails sur la source de la réservation, tels que Workplace Services ou Google Mail. Type de données : objet |
| result.reservation.source.display_value | Valeur d’affichage de la source de réservation, telle que Services du lieu de travail. Type de données : chaîne |
| résultat.réservation.source.valeur | Valeur interne de la source de réservation, telle que ServiceNow. Type de données : chaîne |
| result.reservation.source_icon | Détails sur la source de l’icône utilisée dans la réservation. Cette icône est utilisée dans l’interface utilisateur. Type de données : objet |
| result.reservation.source_icon.classNames | Noms de classe séparés par des virgules pour l’icône source. Type de données : chaîne |
| result.reservation.source_icon.imgSrc | Nom de la source de l’image pour l’icône source. Cette icône est stockée dans la table Images [db_image]. Type de données : chaîne |
| result.reservation.source_icon.info-bulle | Info-bulle associée à l’icône source. Type de données : chaîne |
| result.reservation.source_reservation | Réservation source de la réservation actuelle. Par exemple, dans le cas de plusieurs réservations, la réservation parente est la source de la réservation enfant. Type de données : chaîne |
| Résultat.Réservation.Début | Date et heure de début de la réservation. Type de données : chaîne Format : UTC - aaaa-mm-jjThh :mm :ssZ, par exemple 2021-02-05T18:00:00Z |
| Résultat.Réservation.Objet | Objet de la réservation. Type de données : chaîne |
| result.reservation.sub_source | Détails sur la sous-source de la réservation. La sous-source spécifie le lieu d’origine de la réservation, par exemple Google Agenda ou Microsoft Exchange. Type de données : objet |
| result.reservation.sub_source.display_value | Valeur d’affichage de la sous-source de la réservation, telle que Google Agenda. Type de données : chaîne |
| result.reservation.sub_source.valeur | Valeur interne du champ sous-source de la réservation, telle que google_calendar. Type de données : chaîne |
| result.reservation.sync_state | Détails sur l’état de synchronisation d’une réservation à partir d’un autre service, tels que « sync_enqueued » ou « synchronisé ». Type de données : objet |
| result.reservation.sync_state.display_value | Valeur d’affichage de l’état de synchronisation actuel de la réservation, tel que synchronisé. Type de données : chaîne |
| result.reservation.sync_state.valeur | Valeur interne de l’état de synchronisation actuel de la réservation, tel que synchronisé. Type de données : chaîne |
| result.reservation.sys_created_on | Date et heure de création de la réservation. Type de données : chaîne |
| result.reservation.sys_id | Requis. Sys_id de l’enregistrement de réservation. Situé dans la table Réservation du lieu de travail [sn_wsd_rsv_reservation]. Type de données : chaîne |
| Result.reservation.sys_updated_on | Date et heure de la dernière mise à jour de la réservation. Type de données : chaîne |
| result.reservation.virtual_meeting | URL du lien de la réunion virtuelle. Type de données : chaîne |
| result.reservationAcl | Détails des vérifications des niveaux de contrôle d’accès (ACL) de l’utilisateur définies sur la réservation associée. Type de données : objet |
| result.reservationAcl.read | Marqueur indiquant s’il faut vérifier si l’utilisateur peut lire cette réservation. Valeurs valides :
Type de données : booléennes |
| résultat.reservationAcl.write | Détails sur les options d’écriture de l’utilisateur pour la réservation associée. Type de données : objet |
| result.reservationAcl.write.allFields | Marqueur indiquant s’il faut vérifier si l’utilisateur peut écrire dans tous les champs spécifiés dans l’objet reservationACL.write.fields . Si l’utilisateur n’a accès qu’à certains champs spécifiques, seuls ces champs sont vrais dans l’objet reservationACL.write.fields . Valeurs valides :
Type de données : booléennes |
| result.reservationAcl.write.fields | Détails des contrôles d’accès sur différents champs de la réservation. Type de données : objet |
| résultat.reservationAcl.écrire.champs.emplacement | Marqueur indiquant s’il faut vérifier si l’utilisateur peut écrire dans les champs d’emplacement de cette réservation. Valeurs valides :
Type de données : booléennes |
| result.reservationAcl.write.fields.number_of_attendees | Marqueur indiquant s’il faut vérifier si l’utilisateur peut écrire dans les champs Nombre de participants de cette réservation. Valeurs valides :
Type de données : booléennes |
| result.reservationAcl.write.fields.requested_for | Marqueur indiquant s’il faut vérifier si l’utilisateur peut écrire dans les champs demandés pour cette réservation. Valeurs valides :
Type de données : booléennes |
| résultat.reservationAcl.write.fields.sensitivity | Marqueur indiquant s’il faut vérifier si l’utilisateur peut écrire dans les champs de sensibilité de cette réservation. Valeurs valides :
Type de données : booléennes |
| résultat.reservationAcl.écrire.champs.objet | Marqueur indiquant s’il faut vérifier si l’utilisateur peut écrire dans les champs d’objet de cette réservation. Valeurs valides :
Type de données : booléennes |
| résultat.reservationAcl.record | Marqueur indiquant s’il faut vérifier si l’utilisateur peut écrire dans l’intégralité de l’enregistrement de réservation. Valeurs valides :
Type de données : booléennes |
| result.standard_services | Renseigné uniquement si le include_standard_services paramètre est défini sur vrai. Services standard associés, tels que tableau de conférence, écran de projection, tableau blanc et marqueurs. Type de données : tableau d’objets
|
| result.standard_services.font_awesome_icon | Nom de l’icône de miniature associée au service standard. Type de données : chaîne |
| result.standard_services.name | Nom du service standard. Type de données : chaîne |
| result.standard_services.short_description | Brève description du service standard. Type de données : chaîne |
| result.standard_services.sys_id | Sys_id des états de service standard. Situé dans la table Service standard [sn_wsd_rsv_standard_service]. Type de données : chaîne |
Demande cURL
L’exemple de code suivant montre comment appeler ce point de terminaison et inclure les informations sur les services standard.
curl "https://instance.servicenow.com/api/sn_wsd_rsv/reservation/get?sys_id=8e87c722870741106342b846dabb3573&include_standard_services=true" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"
Résultats renvoyés :
"result": {
"reservation": {
"sys_id": "bf3621de842c2110fa9b813be354f327",
"number": "WRES0001005",
"location": {
"sys_id": "9841e94adb7210106c731dcd13961914",
"name": "A1-02-02",
"description": "General desk available for reservation.",
"display_value": "A1-02-02",
"capacity": 1,
"label_value": "Workspace/Desk name",
"wsd_email": null,
"reservable_module": {
"sys_id": "5db44502dbb650106c731dcd13961937",
"name": "Desks",
"title": "Desks",
"inline_title": "desk",
"table": "sn_wsd_core_space"
},
"region": {
"sys_id": "3752ac8edb3650106c731dcd139619e0",
"display_value": "Americas",
"active": true
},
"site": {
"sys_id": "628eec06db7650106c731dcd139619dd",
"display_value": "North America",
"active": true
},
"campus": {
"sys_id": "82b2a0cedb3650106c731dcd139619e9",
"display_value": "California Campus",
"active": true
},
"building": {
"sys_id": "94e264cedb3650106c731dcd13961919",
"display_value": "CAL-B1",
"active": true,
"timezone": {
"value": "US/Pacific",
"displayValue": "US/Pacific"
}
},
"floor": {
"sys_id": "fc7368cedb3650106c731dcd13961902",
"display_value": "Floor 1",
"active": true
},
"area": {
"sys_id": "",
"display_value": "",
"active": false
},
"is_favorite": false,
"reservation": {
"sys_id": "bf3621de842c2110fa9b813be354f327",
"number_of_attendees": 1,
"state": {
"value": "confirmed",
"display_value": "Confirmed"
},
"auto_conflict_resolution_state": {
"value": null,
"display_value": null
},
"requested_for": {
"sys_id": "6816f79cc0a8016401c5a33be04be441",
"name": "System Administrator",
"user_name": "admin"
},
"number": "WRES0001005",
"active": true
},
"number_of_attendees": 1,
"state": {
"value": "confirmed",
"display_value": "Confirmed"
},
"number": "WRES0001005",
"requested_for": {
"sys_id": "6816f79cc0a8016401c5a33be04be441",
"name": "System Administrator",
"user_name": "admin"
},
"is_private": true
},
"start": "2023-01-24T16:00:00Z",
"end": "2023-01-24T17:00:00Z",
"sys_created_on": "2023-01-24T15:49:49Z",
"sys_updated_on": "2023-01-24T15:49:50Z",
"source_reservation": null,
"check_in_state": {
"value": "awaiting_check_in",
"display_value": "Awaiting check-in"
},
"external_id": null,
"external_ical": null,
"building": {
"active": true,
"sys_id": "94e264cedb3650106c731dcd13961919",
"display_value": "CAL-B1",
"campus": {
"display_value": "California Campus",
"value": "82b2a0cedb3650106c731dcd139619e9",
"active": true
},
"site": {
"display_value": "North America",
"value": "628eec06db7650106c731dcd139619dd",
"active": true
},
"timezone": {
"value": "US/Pacific",
"displayValue": "US/Pacific"
}
},
"active": true,
"state": {
"value": "confirmed",
"display_value": "Confirmed"
},
"sensitivity": {
"value": "normal",
"display_value": "Normal"
},
"reservation_type": {
"value": "space",
"display_value": "Space"
},
"reservation_subtype": {
"value": "single",
"display_value": "Single"
},
"reservation_purpose": {
"value": "meeting",
"display_value": "Meeting"
},
"attendees": [
{
"sys_id": "6816f79cc0a8016401c5a33be04be441",
"value": "6816f79cc0a8016401c5a33be04be441",
"displayValue": "System Administrator",
"display_value": "System Administrator",
"name": "System Administrator",
"user_name": "admin",
"table": "sys_user",
"avatar": "a5d3c898c3222010ae17dd981840dd8b.iix?t=small",
"initials": "SA",
"email": "admin@example.com",
"label": "System Administrator, Finance"
}
],
"number_of_attendees": 1,
"is_parent": false,
"is_private": true,
"subject": "Reservation for A1-02-02",
"virtual_meeting": null,
"recording_details": [],
"sync_state": {
"value": "not_required",
"display_value": "Synchronization not required"
},
"sub_source": {
"value": "servicenow_workplace_service_delivery",
"display_value": "ServiceNow Workplace Service Delivery"
},
"last_updated_sub_source": {
"value": "servicenow_workplace_service_delivery",
"display_value": "ServiceNow Workplace Service Delivery"
},
"reservable_module": {
"sys_id": "5db44502dbb650106c731dcd13961937",
"name": "Desks",
"title": "Desks",
"inline_title": "desk",
"font_awesome_icon": "fa-desktop",
"reservable_table": "sn_wsd_core_space",
"reservable_filter": "active=true^is_reservable=true^location_type=5f017383eb512010b89bfdfc9c5228c8^building.is_reservable=true^floor.is_reservable=true^EQ",
"short_description": "Reserve a single desks",
"reservable_type": "location",
"require_subject": null,
"require_cancel_notes": false,
"virtual_meeting_provider": null,
"enable_reservation_privacy": true,
"allow_invitees": "1",
"display_number_of_attendees": null,
"display_on_behalf_of": "1",
"display_sensitivity": null,
"max_days_in_future": "90",
"allow_recurring": "1",
"auto_resolve_conflict": null,
"allow_whole_day": "1",
"allow_multi_building": "1",
"require_whole_day": null,
"selection_type": "unit",
"reservable_container_field": null,
"reservable_quantity_field": null,
"apply_to_shift": null,
"max_occurrences": "90",
"enable_facet_filter": false,
"search_limit": 10000,
"enable_ical_generation": null,
"enable_group_reservations": null,
"enable_browse_near_a_person": "1",
"enable_browse_by_area": "1",
"enable_floor_search": null,
"enable_browse_by_neighborhood": null,
"require_cc_dept_check": false,
"display_value": "Desks",
"browse_near_a_person_enabled": true,
"browse_by_area_enabled": true,
"browse_by_neighborhood_enabled": false,
"reservable_columns": [
"sys_id",
"external_id",
"wsd_email",
"name",
"title",
"description",
"image",
"number",
"site",
"campus",
"building",
"floor",
"area",
"capacity",
"reservable_quantity",
"location_type",
"order",
"requires_check_in",
"is_reservable"
],
"layout_mapping": {
"title": [
"name"
],
"description": [
"description"
],
"subtitle": [
"campus",
"building",
"floor",
"area"
],
"subtitle_asc": [
"area",
"floor",
"building",
"campus"
],
"image": "image",
"body": [
{
"label": "Capacity",
"icon": "fa-users",
"field": "capacity",
"field_to_display": ""
},
{
"label": "Standard services",
"icon": "fa-check",
"field": "standard_services",
"field_to_display": "name"
},
{
"label": "Reservable purposes",
"icon": "fa-tags",
"field": "reservable_purposes",
"field_to_display": "name"
}
]
},
"timeSlots": [
{
"sys_id": "d5331cf2dbb5f01038e42b24ca961906",
"name": "All day",
"short_description": "8am - 6pm",
"slot_start": "08:00",
"slot_end": "18:00"
},
{
"sys_id": "de131cf2dbb5f01038e42b24ca961931",
"name": "Before noon",
"short_description": "8am - 12pm",
"slot_start": "08:00",
"slot_end": "12:00"
},
{
"sys_id": "6e99ab5ddbb930102e8e853e68961929",
"name": "After noon",
"short_description": "1pm - 6pm",
"slot_start": "13:00",
"slot_end": "18:00"
}
],
"buildingSysIds": [
"03c45bf7dba41010d7981dcd1396196d",
"07c45bf7dba41010d7981dcd1396196b",
"07c45bf7dba41010d7981dcd13961972",
"0bc45bf7dba41010d7981dcd13961970",
"0fc45bf7dba41010d7981dcd1396196e",
"1aa39b1977220110b3d7be377b5a9953",
"2130659ae7321010809a268b03f6a91e",
"22c41bf7dba41010d7981dcd139619fe",
"2ac45bf7dba41010d7981dcd13961901",
"2ec41bf7dba41010d7981dcd139619ff",
"32c45bf7dba41010d7981dcd13961905",
"32c45bf7dba41010d7981dcd1396190c",
"32c45bf7dba41010d7981dcd13961943",
"e2c41bf7dba41010d7981dcd139619fb"
],
"reservable_views": [
{
"type": "card",
"label": "Card view",
"iconClass": "fa-th-large",
"isDefault": true,
"order": "1"
},
{
"type": "schedule",
"label": "Schedule view",
"iconClass": "fa-calendar-o",
"isDefault": false,
"order": "2"
}
],
"checkin_before_minutes": 30,
"reservation_paths": [
{
"value": "browse_all",
"displayValue": "Browse all",
"availableFor": true
},
{
"value": "browse_favorites",
"displayValue": "Browse favorites",
"availableFor": false
},
{
"value": "browse_near_a_person",
"displayValue": "Browse near a person",
"availableFor": true
},
{
"value": "browse_by_area",
"displayValue": "Browse by area",
"availableFor": true
}
],
"override_approval_policy": "never_required"
},
"notification_recipients": null,
"notification_custom_message": null,
"opened_by": {
"sys_id": "6816f79cc0a8016401c5a33be04be441",
"value": "6816f79cc0a8016401c5a33be04be441",
"displayValue": "System Administrator",
"display_value": "System Administrator",
"name": "System Administrator",
"user_name": "admin",
"table": "sys_user",
"avatar": "a5d3c898c3222010ae17dd981840dd8b.iix?t=small",
"initials": "SA",
"email": "admin@example.com",
"label": "System Administrator, Finance"
},
"requested_for": {
"sys_id": "6816f79cc0a8016401c5a33be04be441",
"value": "6816f79cc0a8016401c5a33be04be441",
"displayValue": "System Administrator",
"display_value": "System Administrator",
"name": "System Administrator",
"user_name": "admin",
"table": "sys_user",
"avatar": "a5d3c898c3222010ae17dd981840dd8b.iix?t=small",
"initials": "SA",
"email": "admin@example.com",
"label": "System Administrator, Finance"
},
"auto_conflict_resolution_state": {
"value": null,
"display_value": null
},
"parent_reservation": {},
"edit_restriction": {
"value": "no_restriction",
"display_value": "No restriction"
},
"source": {
"value": "servicenow",
"display_value": "Workplace Services"
},
"source_icon": {
"classNames": "fa fa-calendar-check-o",
"tooltip": "Reservation is confirmed",
"imgSrc": ""
},
"shift": null,
"hasPrivateReservation": true,
"reservationAcl": {
"write": {
"record": true,
"fields": {
"subject": true,
"sensitivity": true,
"requested_for": true,
"number_of_attendees": true,
"location": true,
"is_private": true
},
"allFields": true
},
"read": true
}
},
"reservationAcl": {
"write": {
"record": true,
"fields": {
"subject": true,
"sensitivity": true,
"requested_for": true,
"number_of_attendees": true,
"location": true,
"is_private": true
},
"allFields": true
},
"read": true
}
}
}
Réservation WSD : GET /api/sn_wsd_rsv/reservation/get_user_reservations
Récupère la liste des réservations pour un utilisateur spécifié pour les sept prochains jours.
Format d'URL
URL versionnée : /api/sn_wsd_rsv/{api_version}/reservation/get_user_reservations
URL par défaut : /api/sn_wsd_rsv/reservation/get_user_reservations
Paramètres de demande pris en charge
| Nom | Description |
|---|---|
| api_version | Facultatif. Version du point de terminaison auquel accéder. 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 |
| Nom | Description |
|---|---|
| userId | Sys_id de l’utilisateur dont les réservations doivent être renvoyées. Situé dans la table Utilisateur [sys_user]. Type de données : chaîne |
| 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.
| En-tête | Description |
|---|---|
| Accepter | Format de données du corps de la demande. Types pris en charge : application/json, application/xml ou, text/xml. Valeur par défaut : application/json |
| En-tête | Description |
|---|---|
| Aucun |
Codes d'état
Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.
| Code d'état | Description |
|---|---|
| 200 | Réussi. La demande a été correctement traitée. |
| 401 | Non autorisé. Les informations d'identification de l'utilisateur sont incorrectes ou n'ont pas été transmises. |
| 404 | Introuvable. L’élément demandé est introuvable. |
| 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 |
|---|---|
| résultat | Résultats de retour de réservation. Type de données : objet |
| result.informEmployeePrivacy | Marqueur indiquant s’il faut afficher un message lorsque des réservations marquées comme privées sont renvoyées. Valeurs possibles :
Type de données : booléennes |
| résultat.réservationsParDate | Détails sur chaque date limite de réservation. Type de données : Objet - chaque date dans son propre tableau |
| résultat.réservationsParDate.bâtiment | Bâtiment où se trouve le réservable. Ces informations se trouvent dans la table Bâtiment [sn_wsd_core_building]. |
| result.reservationsByDate.building.display_value | Valeur d’affichage pour le bâtiment. Type de données : chaîne |
| result.reservationsByDate.building.sys_id | Sys_id de l’enregistrement de bâtiment associé. Type de données : chaîne |
| result.reservationsByDate.building.timezone | Détails du fuseau horaire du bâtiment. |
| result.reservationsByDate.building.timezone.display_value | Valeur d’affichage du fuseau horaire dans lequel se trouve le bâtiment associé. Type de données : chaîne |
| result.reservationsByDate.building.timezone.sys_id | Sys_id de l’enregistrement de fuseau horaire dans lequel se trouve le bâtiment associé. Type de données : chaîne |
| résultat.réservationsParDate.bâtiment.valeur | Valeur interne pour le bâtiment. Type de données : chaîne |
| résultat.réservationspardate.étage | Détails sur l’étage associé à la réservation. Type de données : objet |
| résultat.reservationsByDate.floor.displayValue | Numéro d’affichage de l’étage où réside le réservable, par exemple 12. Type de données : chaîne |
| résultat.réservationsParDate.étage.valeur | Valeur interne de l’étage où se trouve la réservation. Type de données : chaîne |
| résultat.réservationsParDate.emplacement | Détails sur l’emplacement de la réservation. Type de données : objet |
| result.reservationsByDate.location.displayValue | Valeur d’affichage de l’emplacement, telle que Parcs Sud. Type de données : chaîne |
| résultat.réservationsParDate.Emplacement.Type | Type d’emplacement, tel que lieu de travail/bureau, café ou salle de sport. Type de données : chaîne |
| résultat.réservationsParDate.emplacement.valeur | Valeur interne de l’emplacement, telle que south_parks. Type de données : chaîne |
| result.searchEndDate | Date de fin de la recherche de réservation. Sept jours à compter de la date de début. Format : jj-mm-aaaa Type de données : chaîne |
| result.searchStartDate | Date de début de la recherche de réservation. Date à laquelle le point de terminaison a été appelé. Format : jj-mm-aaaa Type de données : chaîne |
| result.sortedReservationDates | Dates auxquelles l’utilisateur spécifié a des réservations pour les sept prochains jours, triées par ordre de date. Type de données : tableau |
| result.workplaceProfile | Profil du lieu de travail de l’utilisateur. Décrit le lieu de travail de l’utilisateur spécifié. Type de données : objet |
| résultat.profilespacetravail.bâtiment | Bâtiment dans lequel travaille l’utilisateur. Ces informations se trouvent dans la table Bâtiment [sn_wsd_core_building]. |
| result.workplaceProfile.building.display_value | Valeur d’affichage pour le bâtiment. Type de données : chaîne |
| result.workplaceProfile.building.sys_id | Sys_id de l’enregistrement de bâtiment associé. Type de données : chaîne |
| result.workplaceProfile.building.timezone | Détails du fuseau horaire du bâtiment. |
| result.workplaceProfile.building.timezone.display_value | Valeur d’affichage du fuseau horaire dans lequel se trouve le bâtiment associé. Type de données : chaîne |
| result.workplaceProfile.building.timezone.sys_id | Sys_id de l’enregistrement de fuseau horaire dans lequel se trouve le bâtiment associé. Type de données : chaîne |
| résultat.profilespacetravail.bâtiment.valeur | Valeur interne pour le bâtiment. Type de données : chaîne |
| résultat.workplaceProfile.floor | Détails sur l’étage sur lequel l’utilisateur travaille. Type de données : objet |
| result.workplaceProfile.floor.displayValue | Numéro d’affichage de l’étage sur lequel l’utilisateur travaille, par exemple Étage 8. Type de données : chaîne |
| result.workplaceProfile.floor.value | Valeur interne de l’étage sur lequel l’utilisateur travaille. Type de données : chaîne |
| result.workplaceProfile.location | Détails sur l’emplacement de l’utilisateur. Type de données : objet |
| result.workplaceProfile.location.displayValue | Valeur d’affichage de l’emplacement, par exemple San Diego. Type de données : chaîne |
| result.workplaceProfile.location.type | Type d’emplacement, tel qu’un bureau ou un bureau. Type de données : chaîne |
| résultat.workplaceProfile.location.value | Valeur interne de l’emplacement, telle que san_diego. Type de données : chaîne |
Demande cURL
L’exemple de code suivant montre comment appeler ce point de terminaison.
curl "https://instance.servicenow.com/api/sn_wsd_rsv/reservation/get_user_reservations?userId=2de07e1887cb89106342b846dabb35fe" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"
Résultats renvoyés :
{
"result": {
"sortedReservationDates": [
"2023-01-24"
],
"workplaceProfile": {
"location": {
"displayValue": "DDC-A2.0016A",
"value": "96d3139977220110b3d7be377b5a9918",
"externalId": "0e7bddfb475a011064062782846d43c2",
"type": "Workspace/Desk"
},
"floor": {
"displayValue": "Floor 2",
"value": "68d31f5977220110b3d7be377b5a991b"
},
"building": {
"displayValue": "Building A",
"value": "dea39b1977220110b3d7be377b5a9955",
"timezone": {
"value": "Europe/Paris",
"displayValue": "Europe/Paris"
}
}
},
"reservationsByDate": {
"2023-01-24": [
{
"location": {
"displayValue": "A1-02-04",
"value": "3e41e94adb7210106c731dcd1396198c",
"externalId": "",
"type": "Workspace/Desk"
},
"floor": {
"displayValue": "Floor 1",
"value": "fc7368cedb3650106c731dcd13961902"
},
"building": {
"displayValue": "CAL-B1",
"value": "94e264cedb3650106c731dcd13961919",
"timezone": {
"value": "US/Pacific",
"displayValue": "US/Pacific"
}
}
},
{
"location": {
"displayValue": "A1-02-02",
"value": "9841e94adb7210106c731dcd13961914",
"externalId": "",
"type": "Workspace/Desk"
},
"floor": {
"displayValue": "Floor 1",
"value": "fc7368cedb3650106c731dcd13961902"
},
"building": {
"displayValue": "CAL-B1",
"value": "94e264cedb3650106c731dcd13961919",
"timezone": {
"value": "US/Pacific",
"displayValue": "US/Pacific"
}
}
},
{
"location": {
"displayValue": "A1-02-03",
"value": "fd41a94adb7210106c731dcd1396195a",
"externalId": "",
"type": "Workspace/Desk"
},
"floor": {
"displayValue": "Floor 1",
"value": "fc7368cedb3650106c731dcd13961902"
},
"building": {
"displayValue": "CAL-B1",
"value": "94e264cedb3650106c731dcd13961919",
"timezone": {
"value": "US/Pacific",
"displayValue": "US/Pacific"
}
}
}
]
},
"searchStartDate": "2023-01-24",
"searchEndDate": "2023-01-31",
"informEmployeePrivacy": true
}
}
Réservation WSD : GET /api/sn_wsd_rsv/reservation/icalendar/{sys_id}
Génère le corps d’un fichier iCalendar pour une réservation spécifiée.
Format d'URL
URL versionnée : /api/sn_wsd_rsv/{api_version}/reservation/icalendar/{sys_id}
URL par défaut : /api/sn_wsd_rsv/reservation/icalendar/{sys_id}
Paramètres de demande pris en charge
| Nom | Description |
|---|---|
| api_version | Facultatif. Version du point de terminaison auquel accéder. 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 |
| sys_id | Sys_id de la réservation pour laquelle générer un corps de fichier iCalendar. Situé dans la table Réservation du lieu de travail [sn_wsd_rsv_reservation]. Type de données : chaîne |
| Nom | Description |
|---|---|
| Aucun |
| 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.
| En-tête | Description |
|---|---|
| Accepter | Format de données du corps de la demande. Types pris en charge : application/json, application/xml ou, text/xml. Valeur par défaut : application/json |
| En-tête | Description |
|---|---|
| Aucun |
Codes d'état
Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.
| Code d'état | Description |
|---|---|
| 200 | Réussi. La demande a été correctement traitée. |
| 401 | Non autorisé. Les informations d'identification de l'utilisateur sont incorrectes ou n'ont pas été transmises. |
| 404 | Introuvable. L’élément demandé est introuvable. |
| 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 |
|---|---|
| résultat | Corps du fichier iCalendar pour la réservation spécifiée. Type de données : chaîne |
Demande cURL
L’exemple de code suivant montre comment appeler ce point de terminaison pour créer un corps iCalender.
curl "https://instance.servicenow.com/api/sn_wsd_rsv/reservation/icalendar/60d26a0f47578910003a4587746d4331" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"
Résultats renvoyés :
{
"result": "BEGIN:VCALENDAR\nPRODID:-//Service-now.com//Outlook 11.0 MIMEDIR//EN\nVERSION:2.0\nMETHOD:REQUEST\nBEGIN:VEVENT\nATTENDEE;ROLE=REQ-PARTICIPANT;RSVP=TRUE:MAILTO:workplace_user@example.com\nDTSTART:20220521T050000Z\nDTEND:20220521T060000Z\nUID:60d26a0f47578910003a4587746d4331\nDTSTAMP:20220511T044018Z\nSUMMARY:For user 1\nDESCRIPTION:Dear System Administrator,\\n\\nThank you for your reservation.\\n\\nYou can find more details on your reservation, or manage your reservation using the following link: https://damay2.service-now.com/ws?id=wsd_reservation_summary&reservation_id=60d26a0f47578910003a4587746d4331\\n\\nKind regards,\\nWorkplace Services Team\nLOCATION:Berlin\nCLASS:PUBLIC\nORGANIZER;CN=Workplace User:MAILTO:workplace_user@example.com\nATTENDEE;ROLE=REQ-PARTICIPANT;CN=Workplace User:RSVP=TRUE:MAILTO:workplace_user@example.com\nEND:VEVENT\nEND:VCALENDAR"
}
Réservation WSD : GET /api/sn_wsd_rsv/reservation/list
Récupère la liste des réservations appartenant à un utilisateur spécifié.
Ce point de terminaison renvoie uniquement les réservations qui ont été demandées ou ouvertes par l’utilisateur spécifié.
Format d'URL
URL versionnée : /api/sn_wsd_rsv/{api_version}/reservation/list
URL par défaut : /api/sn_wsd_rsv/reservation/list
Paramètres de demande pris en charge
| Nom | Description |
|---|---|
| api_version | Facultatif. Version du point de terminaison auquel accéder. 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 |
| Nom | Description |
|---|---|
| encodedQuery | Requête codée à utiliser pour filtrer les résultats d’enregistrement de réservation renvoyés. Tous les champs de la table Réservation du lieu de travail [sn_wsd_rsv_reservation] sont valides dans la requête. Par exemple, Type de données : chaîne |
| endIndex | Dernier enregistrement de réservation dans l’ensemble de résultats à retourner lors de la spécification des index pour la pagination. Si cette valeur est supérieure au nombre disponible d’enregistrements de résultats de renvoi, tous les enregistrements restants sont renvoyés. Type de données : nombre |
| orderByEndDesc | Marqueur indiquant s’il faut renvoyer les résultats renvoyés dans l’ordre décroissant de l’heure de début. Valeurs valides :
Valeur par défaut : false |
| critères de recherche | Texte qui doit correspondre à la réservation pour être inclus dans les résultats renvoyés. Le point de terminaison recherche cette valeur dans les champs suivants :
Type de données : chaîne |
| startIndex | Enregistrement de départ pour lequel renvoyer des enregistrements, base zéro. Utilisez ce paramètre pour paginer dans des jeux d’enregistrements volumineux. Type de données : chaîne Par défaut : 0 |
| userId | Sys_id d’un utilisateur à filtrer des informations de réservation renvoyées. Situé dans la table Utilisateur [sys_user]. Lorsque cette valeur est transmise, le point de terminaison filtre les réservations pour lesquelles le champ requested_for ou opened_by est égal à l’utilisateur actuellement connecté. À partir de cette liste de réservations, il filtre ensuite les réservations pour lesquelles la requested_for ou la opened_by est égale à la valeur réussie userId. Type de données : chaîne Par défaut : renvoie toutes les réservations où les champs requested_for ou opened_by sont égaux à l’utilisateur actuellement connecté. |
| En-tête | Description |
|---|---|
| Accepter | Format de données du corps de la demande. Types pris en charge : application/json, application/xml ou, text/xml. Valeur par défaut : application/json |
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. Types pris en charge : application/json ou application/xml. Valeur par défaut : application/json |
| En-tête | Description |
|---|---|
| Aucun |
Codes d'état
Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.
| Code d'état | Description |
|---|---|
| 200 | Réussi. La demande a été correctement traitée. |
| 401 | Non autorisé. Les informations d'identification de l'utilisateur sont incorrectes ou n'ont pas été transmises. |
| 404 | Introuvable. L’élément demandé est introuvable. |
| 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 |
|---|---|
| résultat.réservation | Détails de la réservation. Type de données : objet |
| result.reservation.active | Marqueur indiquant si la réservation est active. Valeurs valides :
Type de données : booléennes |
| résultat.réservation.participants | Liste des participants à la réservation. Type de données : tableau d’objets |
| résultat.réservation.participants.avatar | Sys_id de l’avatar associé au participant. Situé dans la table Pièces jointes [sys_attachment]. Type de données : chaîne |
| résultat.réservation.participants.displayValue | Valeur d’affichage pour le participant. Type de données : chaîne |
| result.reservation.attendees.display_value | Valeur d’affichage du participant. Identique à displayValue. Type de données : chaîne |
| result.reservation.attendees.email | Adresse e-mail du participant. Type de données : chaîne |
| résultat.réservation.participants.initiales | Initiales du participant. Type de données : chaîne |
| result.reservation.attendees.name | Nom du participant. Type de données : chaîne |
| result.reservation.attendees.sys_id | Sys_id_of l’enregistrement du participant. Type de données : chaîne |
| résultat.réservation.participants.table | Table dans laquelle se trouve l’enregistrement du participant. Type de données : chaîne |
| result.reservation.attendees.user_name | Nom d’utilisateur du participant. Type de données : chaîne |
| résultat.réservation.participants.valeur | Valeur interne du participant. Type de données : chaîne |
| result.reservation.check_in_state | Détails sur l’état d’enregistrement de la réservation. Type de données : objet |
| result.reservation.check_in_state.display_value | Valeur d’affichage de l’état d’enregistrement actuel de la réservation, par exemple En cours ou Terminé. Type de données : chaîne |
| result.reservation.check_in_state.valeur | Valeur interne de l’état d’enregistrement actuel de la réservation, par exemple 2. Type de données : chaîne |
| result.reservation.edit_restriction | Description des restrictions de modification utilisateur pour la réservation, telles que no_restrictions, service_only ou fully_restricted. Type de données : objet |
| result.reservation.edit_restriction.display_value | Valeur d’affichage des restrictions de modification de la réservation, par exemple Aucune restriction. Type de données : chaîne |
| result.reservation.edit_restriction.valeur | Valeur interne des restrictions de modification de la réservation, telle que no_restriction. Type de données : chaîne |
| résultat.réservation.fin | Date et heure de fin de la réservation. Type de données : chaîne Format : UTC : aaaa-mm-jjThh :mm :ssZ, comme 2021-02-05T18:00:00Z |
| result.reservation.external_ical | Identification iCalendar externe unique de la réservation. Utilisez cette valeur pour identifier la réservation lorsqu’il s’agit d’une réservation liée à la synchronisation du calendrier. Type de données : chaîne |
| result.reservation.external_id | Identification externe unique de la réservation. Utilisez cette valeur pour identifier la réservation lorsqu’il s’agit d’une réservation liée à la synchronisation du calendrier. Type de données : chaîne |
| result.reservation.is_parent | Marqueur indiquant si cette réservation est une réservation parente. Valeurs possibles :
Type de données : booléennes |
| result.reservation.is_private | Marqueur indiquant si la réservation est privée. Si elle est privée, la réservation n’apparaît à personne d’autre qu’au propriétaire. Pour plus d’informations sur ces paramètres de confidentialité, consultez la section Paramètres de confidentialité de la localisation et impact. Valeurs valides :
Type de données : booléennes Par défaut : valeur définie pour la confidentialité dans les propriétés système. |
| result.reservation.last_updated_sub_source | Détails sur la dernière sous-source mise à jour pour la réservation. Les sous-sources sont utilisées lors de l’intégration des réservations à un calendrier externe. Cet objet contient des informations telles que « servicenow_workplace_service_delivery », « google_calendar » ou « microsoft_exchange ». Type de données : objet |
| result.reservation.last_updated_sub_source.display_value | Valeur d’affichage de la dernière sous-source mise à jour de la réservation, telle que ServiceNow Workplace Service Delivery ou Google Agenda. Utilisé lors de l’intégration de la réservation à un service externe tel que Google Agenda ou Microsoft Outlook. Type de données : chaîne |
| result.reservation.last_updated_sub_source.valeur | Valeur interne de la dernière sous-source mise à jour de la réservation, telle que servicenow_workplace_service_delivery ou google_calendar. Utilisé lors de l’intégration de la réservation à un service externe tel que Google Agenda ou Microsoft Outlook. Type de données : chaîne |
| résultat.réservation.emplacement | Détails sur l’emplacement associé à la réservation. Type de données : objet |
| résultat.réservation.emplacement.zone | Détails sur la zone associée à l’emplacement. Type de données : objet |
| result.reservation.location.area.active | Marqueur indiquant si la zone est active. Valeurs valides :
Type de données : booléennes |
| result.reservation.location.area.display_value | Valeur d’affichage de la zone à laquelle cet emplacement appartient, par exemple Bureau A2. Type de données : chaîne |
| result.reservation.location.area.sys_id | Sys_id de la zone à laquelle cet emplacement appartient. Situé dans la table Zone [sn_wsd_core_area]. Type de données : chaîne |
| résultat.réservation.emplacement.bâtiment | Détails sur le bâtiment associé à l’emplacement. Type de données : objet |
| result.reservation.location.building.active | Marqueur indiquant si le bâtiment est actif. Valeurs valides :
Type de données : booléennes |
| result.reservation.location.building.display_value | Valeur d’affichage du bâtiment auquel cet emplacement appartient, telle que AMS - Bld1. Type de données : chaîne |
| result.reservation.location.building.sys_id | Sys_id du bâtiment auquel cet emplacement appartient. Situé dans la table du bâtiment [sn_wsd_core_building]. Type de données : chaîne |
| résultat.réservation.emplacement.bâtiment.fuseau horaire | Détails sur le fuseau horaire associé à l’emplacement. Type de données : objet |
| result.reservation.location.building.timezone.display_value | Valeur d’affichage du fuseau horaire auquel cet emplacement appartient. Type de données : chaîne |
| résultat.réservation.emplacement.bâtiment.fusehoraire.valeur | Valeur interne du fuseau horaire auquel cet emplacement appartient. Type de données : chaîne |
| résultat.réservation.emplacement.campus | Détails sur le campus associé à l’emplacement. Type de données : objet |
| result.reservation.location.campus.active | Marqueur indiquant si le campus est actif. Valeurs valides :
Type de données : booléennes |
| result.reservation.location.campus.display_value | Valeur d’affichage du campus auquel cet emplacement appartient, par exemple Campus d’Amsterdam. Type de données : chaîne |
| result.reservation.location.campus.sys_id | Sys_id du campus auquel cet emplacement appartient. Situé dans la table Campus [sn_wsd_core_campus]. Type de données : chaîne |
| résultat.réservation.emplacement.capacité | Nombre maximal d’occupants pour l’emplacement. Type de données : nombre |
| résultat.réservation.emplacement.description | Brève description de l’emplacement. Type de données : chaîne |
| result.reservation.location.display_value | Valeur à afficher dans l’interface utilisateur pour cet emplacement. Type de données : chaîne |
| result.reservation.location.email | Adresse e-mail de l’emplacement. Type de données : chaîne |
| résultat.réservation.emplacement.étage | Détails sur l’étage associé à l’emplacement. Type de données : objet |
| result.reservation.location.floor.active | Marqueur indiquant si l’étage est actif. Valeurs valides :
Type de données : booléennes |
| result.reservation.location.floor.display_value | Valeur d’affichage de l’étage auquel cet emplacement appartient, par exemple Premier étage. Type de données : chaîne |
| result.reservation.location.floor.sys_id | Sys_id de l’étage auquel cet emplacement appartient. Situé dans la table Étage [sn_wsd_core_floor]. Type de données : chaîne |
| result.reservation.location.label_value | Type de valeur spécifiée dans le paramètre, telle que le nom de la name salle. Type de données : chaîne |
| result.reservation.location.name | Nom de l'emplacement. Type de données : chaîne |
| résultat.réservation.emplacement.number | Numéro de réservation. Type de données : chaîne |
| result.reservation.location.number_of_attendees | Nombre de participants pour la réservation. Type de données : nombre |
| résultat.réservation.emplacement.région | Détails sur la région associée à l’emplacement. Type de données : objet |
| result.reservation.location.region.active | Marqueur indiquant si la région est active. Valeurs valides :
Type de données : booléennes |
| result.reservation.location.region.display_value | Valeur d’affichage de la région à laquelle cet emplacement appartient, par exemple Europe. Type de données : chaîne |
| result.reservation.location.region.sys_id | Sys_id de la région à laquelle cet emplacement appartient. Situé dans la table Région [sn_wsd_core_region]. Type de données : chaîne |
| result.reservation.location.requested_for | Détails sur la personne pour laquelle la réservation a été demandée. Type de données : objet |
| result.reservation.location.requested_for.nom | Nom de l’utilisateur pour lequel la réservation a été demandée. Type de données : chaîne |
| result.reservation.location.requested_for.sys_id | Sys_id de l’utilisateur pour lequel la réservation est demandée. Situé dans la table Utilisateur [sys_user]. Type de données : chaîne |
| result.reservation.location.requested_for.user_name | Nom d’utilisateur de l’utilisateur pour lequel la réservation a été demandée. Type de données : chaîne |
| résultat.réservation.emplacement.réservation | Détails sur la réservation associée à l’emplacement. Type de données : objet |
| result.reservation.location.reservation.active | Marqueur indiquant si la réservation est active. Valeurs valides :
Type de données : booléennes |
| résultat.réservation.emplacement.numéro.réservation | Numéro de réservation. Type de données : chaîne |
| result.reservation.location.reservation.number_of_attendees | Nombre de participants de la réservation. Type de données : nombre |
| result.reservation.location.reservation.requested_for | Détails sur la personne pour laquelle la réservation a été demandée. Type de données : objet |
| result.reservation.location.reservation.requested_for.name | Nom de l’utilisateur pour lequel la réservation a été demandée. Type de données : chaîne |
| result.reservation.location.reservation.requested_for.sys_id | Sys_id de l’utilisateur demandé. Situé dans la table Utilisateur [sys_user]. Type de données : chaîne |
| result.reservation.location.reservation.requested_for.user_name | Nom d’utilisateur de l’utilisateur pour lequel la réservation a été demandée. Type de données : chaîne |
| result.reservation.location.reservable_module | Détails sur le module réservable associé à la réservation. Type de données : objet |
| result.reservation.location.reservable_module.inline_title | Titre en ligne du module réservable. Le titre s’affiche conformément au texte descriptif sur le portail de services Workplace. Type de données : chaîne |
| result.reservation.location.reservable_module.nom | Nom du module réservable. Type de données : chaîne |
| result.reservation.location.reservable_module.sys_id | Sys_id du module réservable. Type de données : chaîne |
| result.reservation.location.reservable_module.titre | Titre du module réservable. Type de données : chaîne |
| result.reservation.location.site | Site auquel l’emplacement appartient. Situé dans la table Site [sn_wsd_core_site]. Type de données : objet |
| result.reservation.location.site.active | Marqueur indiquant si le site est actif. Valeurs valides :
Type de données : booléennes |
| result.reservation.location.site.display_value | Valeur d’affichage du site auquel cet emplacement appartient, par exemple Europe de l’Ouest. Type de données : chaîne |
| result.reservation.location.site.sys_id | Sys_id du site auquel cet emplacement appartient. Situé dans la table Site [sn_wsd_core_site]. Type de données : chaîne |
| résultat.réservation.emplacement.état | Détails sur l’état de la réservation pour l’emplacement. Type de données : objet |
| result.reservation.location.state.display_value | Valeur d’affichage de l’état actuel de la réservation, tel que confirmé. Type de données : chaîne |
| résultat.réservation.emplacement.état.valeur | Valeur interne de l’état actuel de la réservation, par exemple « 2 ». Type de données : chaîne |
| result.reservation.location.sys_id | Sys_id de l’enregistrement d’emplacement associé. Situé dans la table Emplacement du lieu de travail [sn_wsd_core_workplace_location]. Type de données : chaîne |
| result.reservation.notification_custom_message | Message personnalisé pour la notification envoyée aux destinataires répertoriés dans reservation.notification_recipients. Type de données : chaîne |
| result.reservation.notification_recipients | Liste des destinataires qui reçoivent une notification concernant la réservation. Type de données : tableau d’objets |
| result.reservation.notification_recipients.name | Nom du destinataire. Type de données : chaîne |
| result.reservation.notification_recipients.sys_id | Sys_id du destinataire. Situé dans la table Utilisateur [sys_user]. Type de données : chaîne |
| result.reservation.notification_recipients.user_name | Nom d’utilisateur du destinataire. Type de données : chaîne |
| numéro.réservation.résultat | Numéro unique de l’enregistrement de réservation. Situé dans la table Réservation du lieu de travail [sn_wsd_rsv_reservation]. Vous pouvez utiliser cette valeur pour interroger la réservation. Type de données : chaîne |
| result.reservation.opened_by | Détails sur l’utilisateur qui a créé la réservation. Type de données : objet |
| result.reservation.opened_by.avatar | Avatar de l’utilisateur qui a ouvert la réservation. Type de données : chaîne |
| result.reservation.opened_by.displayValue | Valeur d’affichage de l’utilisateur ouvert. Type de données : chaîne |
| result.reservation.opened_by.display_value | Valeur d’affichage de l’utilisateur ouvert. Type de données : chaîne |
| result.reservation.opened_by.email | Adresse e-mail de l’utilisateur qui a ouvert la réservation. Type de données : chaîne |
| result.reservation.opened_by.initiales | Initiales de l’utilisateur qui a ouvert la réservation. Type de données : chaîne |
| result.reservation.opened_by.label | Étiquette de l’utilisateur qui a ouvert la réservation. Il s’agit d’une combinaison du titre et du département de l’utilisateur. Type de données : chaîne |
| result.reservation.opened_by.name | Nom de l’utilisateur qui a ouvert la réservation. Type de données : chaîne |
| result.rservation.opened_by.sys_id | Sys_id_of l’utilisateur qui a ouvert la réservation. Situé dans la table Utilisateur [sys_user]. Type de données : chaîne |
| result.rservation.opened_by.table | Table contenant l’enregistrement de l’utilisateur. Type de données : chaîne |
| result.reservation.opened_by.user_name | Nom d’utilisateur de l’utilisateur qui a ouvert la réservation. Type de données : chaîne |
| result.reservation.opened_by.valeur | Valeur interne de l’utilisateur qui a ouvert la réservation. Type de données : chaîne |
| numéro.réservation.résultat | Numéro de réservation. Type de données : chaîne |
| result.reservation.number_of_attendees | Nombre de participants dans cette réservation. Type de données : nombre |
| result.reservation.recording_details | Détails sur les enregistrements associés à la réservation (réunion). Type de données : tableau |
| result.reservation.recording_details.recording_url | URL des enregistrements associés à la réservation. Type de données : chaîne |
| result.reservation.requested_for | Détails sur l’utilisateur au nom duquel la réservation a été effectuée. Type de données : objet |
| result.reservation.requested_for.avatar | Avatar de l’utilisateur au nom duquel la réservation a été effectuée. Type de données : chaîne |
| result.reservation.requested_for.displayValue | Valeur d’affichage de l’utilisateur au nom duquel la réservation a été effectuée. Type de données : chaîne |
| result.reservation.requested_for.display_value | Valeur d’affichage de l’utilisateur au nom duquel la réservation a été effectuée. Identique à displayValue. Type de données : chaîne |
| result.reservation.requested_for.email | Adresse e-mail de l’utilisateur au nom duquel la réservation a été effectuée. Type de données : chaîne |
| result.reservation.requested_for.initials | Initiales de l’utilisateur au nom duquel la réservation a été effectuée. Type de données : chaîne |
| result.reservation.requested_for.étiquette | Étiquette de l’utilisateur au nom duquel la réservation a été effectuée. Type de données : chaîne |
| result.reservation.requested_for.name | Nom de l’utilisateur au nom duquel la réservation a été effectuée. Type de données : chaîne |
| result.rservation.requested_for.sys_id | Sys_id_of l’utilisateur au nom duquel la réservation a été effectuée. Situé dans la table Utilisateur [sys_user]. Type de données : chaîne |
| result.rservation.requested_for.table | Table contenant l’enregistrement de l’utilisateur. Type de données : chaîne |
| result.reservation.requested_for.user_name | Nom d’utilisateur de l’utilisateur au nom duquel la réservation a été effectuée. Type de données : chaîne |
| result.reservation.requested_for.valeur | Valeur interne de l’utilisateur au nom duquel la réservation a été effectuée. Type de données : chaîne |
| result.reservation.reservable_module | Détails du module réservable demandé. Type de données : objet |
| result.reservation.reservable_module.allow_invitees | Marqueur indiquant si les employés sont en mesure d’ajouter des invités à la réservation. Valeurs valides :
Type de données : booléennes |
| result.reservation.reservable_module.allow_whole_day | Marqueur indiquant si les utilisateurs peuvent réserver le réservable pour toute la journée. Valeurs valides :
Type de données : booléennes |
| result.reservation.reservable_module.apply_to_shift | Marqueur indiquant si les réservations basées sur l’équipe sont activées pour le module réservable. Valeurs valides :
Type de données : booléennes |
| result.reservation.reservable_module.browse_by_area_enabled | Marqueur indiquant si les utilisateurs sont en mesure de rechercher des modules réservables par zone. Valeurs valides :
Type de données : booléennes |
| result.reservation.reservable_module.browse_near_a_person_enabled | Marqueur indiquant si les utilisateurs sont en mesure de rechercher des modules réservables situés par une personne spécifiée. Valeurs valides :
Type de données : booléennes |
| result.reservation.reservable_module.buildingSysIds | Liste des sys_ids des bâtiments associés au module réservable. Type de données : tableau de chaînes |
| result.reservation.reservable_module.checkin_before_minutes | Délai avant le début d’une réservation pendant lequel un utilisateur peut enregistrer sa réservation. Unité : Minutes Type de données : nombre |
| result.reservation.reservable_module.display_number_of_attendees | Marqueur indiquant si les utilisateurs peuvent spécifier le nombre de participants dans la réservation. Valeurs valides :
Type de données : booléennes |
| result.reservation.reservable_module.display_on_behalf_of | Marqueur indiquant si les réservations peuvent être effectuées au nom de quelqu’un d’autre. Valeurs valides :
Type de données : booléennes |
| result.reservation.reservable_module.display_sensitivity | Marqueur indiquant si les utilisateurs peuvent définir la sensibilité de la réservation, comme normal ou privé. Valeurs valides :
Type de données : booléennes |
| result.reservation.reservable_module.display_value | Valeur d’affichage du module réservable. Type de données : chaîne |
| result.reservation.reservable_module.enable_browse_by_area | Marqueur indiquant si les utilisateurs sont en mesure de rechercher des modules réservables par zone. Identique à browse_by_area_enabled. Valeurs valides :
Type de données : booléennes |
| result.reservation.reservable_module.enable_browse_near_a_person | Marqueur indiquant si les utilisateurs sont en mesure de rechercher des modules réservables situés par une personne spécifiée. Identique à browse_near_a_person_enabled. Valeurs valides :
Type de données : booléennes |
| result.reservation.reservable_module.enable_facet_filter | Marqueur indiquant si le filtrage des facettes sur les éléments du lieu de travail est activé. Lorsque cette option est activée, les options de filtre qui s’affichent sont basées sur les résultats de la recherche. Seuls les éléments disponibles dans les résultats de recherche générés sont sélectionnables par les utilisateurs dans le filtre. Valeurs valides :
Type de données : booléennes |
| result.reservation.reservable_module.enable_group_reservations | Marqueur indiquant si les utilisateurs peuvent effectuer une réservation de groupe. Valeurs valides :
Type de données : booléennes |
| result.reservation.reservable_module.enable_ical_generation | Marqueur indiquant si les utilisateurs peuvent générer un iCalendar pour la réservation. Valeurs valides :
Type de données : booléennes |
| result.reservation.reservable_module.font_awesome_icon | Nom de l’icône de police jointe au module réservable. Type de données : chaîne |
| result.reservation.reservable_module.inline_title | Titre en ligne du module réservable. Le titre s’affiche conformément au texte descriptif sur le portail de services Workplace. Type de données : chaîne |
| result.reservation.reservable_module.layout_mapping | Détails sur la structure du mappage de mise en page des emplacements. Utilisez ces données pour mettre en page les informations dans l’interface utilisateur. Type de données : objet |
| result.reservation.reservable_module.layout_mapping.corps | Espace réservé pour le mappage des données de l’interface utilisateur frontale. Type de données : tableau d’objets |
| result.reservation.reservable_module.layout_mapping.corps.champ | Espace réservé pour le mappage des données de l’interface utilisateur frontale. Type de données : chaîne |
| result.reservation.reservable_module.layout_mapping.body.field_to_display | Espace réservé pour le mappage des données de l’interface utilisateur frontale. Type de données : chaîne |
| result.reservation.reservable_module.layout_mapping.corps.icône | Espace réservé pour le mappage des données de l’interface utilisateur frontale. Type de données : chaîne |
| result.reservation.reservable_module.layout_mapping.corps.étiquette | Espace réservé pour le mappage des données de l’interface utilisateur frontale. Type de données : chaîne |
| result.reservation.reservable_module.layout_mapping.description | Espace réservé pour le mappage des données de l’interface utilisateur frontale. Description du mappage de mise en page. Type de données : tableau |
| result.reservation.reservable_module.layout_mapping.image | Espace réservé pour le mappage des données de l’interface utilisateur frontale. Type de données : chaîne |
| result.reservation.reservable_module.layout_mapping.sous-titre | Espace réservé pour le mappage des données de l’interface utilisateur frontale. Type de données : tableau |
| result.reservation.reservable_module.layout_mapping.subtitle_asc | Espace réservé pour le mappage des données de l’interface utilisateur frontale. Type de données : tableau |
| result.reservation.reservable_module.layout_mapping.titre | Espace réservé pour le mappage des données de l’interface utilisateur frontale. Type de données : tableau |
| result.reservation.reservable_module.max_days_in_future | Nombre maximal de jours dans le futur pendant lesquels un utilisateur peut réserver le module réservable. Type de données : nombre |
| result.reservation.reservable_module.max_occurrences | Nombre maximal d’occurrences de réservation récurrentes si des réservations récurrentes sont disponibles pour le module réservable. Type de données : nombre |
| result.reservation.reservable_module.name | Nom du module réservable. Type de données : chaîne |
| result.reservation.reservable_module.override_approval_policy | Option permettant de spécifier la méthode d'implémentation de la politique d'approbation. Les choix sont les suivants :
Type de données : chaîne |
| result.reservation.reservable_module.require_cancel_notes | Marqueur indiquant si les utilisateurs doivent saisir une note d’annulation avant d’annuler un module réservable. Valeurs valides :
Type de données : booléennes |
| result.reservation.reservable_module.require_cc_dept_check | Marqueur indiquant s’il faut vérifier s’il existe une incompatibilité de centre de coûts ou de département entre l’élément de l’espace de travail et l’utilisateur connecté. Valeurs valides :
Type de données : booléennes |
| result.reservation.reservable_module.require_subject | Marqueur indiquant si l’utilisateur doit saisir un objet lors de la réservation. Valeurs valides :
Type de données : booléennes |
| result.reservation.reservable_module.reservable_columns | Liste des colonnes d’un réservable. Situé dans la table Emplacement du lieu de travail [sn_wsd_core_workplace_location]. Type de données : tableau |
| result.reservation.reservable_module.reservable_container_field | Niveau du conteneur, par exemple un groupe de bureaux dans une zone spécifique. Type de données : chaîne |
| result.reservation.reservable_module.reservable_filter | Conditions de filtre utilisées pour filtrer les éléments réservables dans la table réservable associée. La table réservable est un champ de la table Module réservable [sn_wsd_rsv_reservable_module]. Ces conditions de filtre ont été appliquées à la table contenue dans le champ Table réservable. Type de données : chaîne |
| result.reservation.reservable_module.reservable_quantity_field | Quantité réservable de tous les espaces. La quantité est utilisée lors de l’affectation d’espaces de quartier à une zone. Pour plus d’informations, reportez-vous à la rubrique Affecter des espaces de quartier à une zone. Type de données : chaîne |
| result.reservation.reservable_module.reservable_table | Table contenant les éléments du lieu de travail réservables. Type de données : chaîne |
| result.reservation.reservable_module.reservable_type | Type de l’élément réservable, tel que l’emplacement. Type de données : chaîne |
| result.reservation.reservable_module.reservable_views | Détails sur les différentes vues associées au module réservable, telles que la vue de carte ou la vue de calendrier. Situé dans la table Vue réservable [sn_wsd_rsv_reservable_view]. Type de données : objet |
| result.reservation.reservable_module.reservable_views.iconClass | Classe d’icône de la vue réservable. Type de données : chaîne |
| result.reservation.reservable_module.reservable_views.isDefault | Marqueur indiquant s’il faut faire de cette vue réservable la valeur par défaut pour les modules réservables. Valeurs valides :
Type de données : booléennes |
| result.reservation.reservable_module.reservable_views.étiquette | Nom de la vue réservable. Type de données : chaîne |
| result.reservation.reservable_module.reservable_views.commande | Ordre dans lequel les vues sont affichées pour le module réservable dans l’interface utilisateur. Le numéro d’ordre inférieur vient en premier dans l’interface utilisateur. Dans le cas du même numéro d’ordre, un ordre aléatoire lui est attribué. Type de données : nombre |
| result.reservation.reservable_module.reservable_views.type | Nom back-end de la vue réservable. Utilisé pour le traitement interne. Type de données : chaîne |
| result.reservation.reservable_module.reservation_paths | Chemins de réservation associés aux modules réservables tels que Tout parcourir, Explorer à proximité d’une personne. Type de données : tableau d’objets |
| result.reservation.reservable_module.reservation_paths.display_value | Valeur d’affichage du chemin de réservation, par exemple « Explorer à proximité d’une personne ». Type de données : chaîne |
| result.reservation.reservable_module.reservation_paths.valeur | Valeur interne du chemin de réservation, telle que « browse_near_a_person ». Type de données : chaîne |
| result.reservation.reservable_module.search_limit | Nombre maximal de résultats de recherche à renvoyer lorsqu’un utilisateur recherche un emplacement de lieu de travail. Type de données : nombre |
| result.reservation.reservable_module.selection_type | Type de sélection à afficher dans les résultats de la recherche. Peut être l’une des options suivantes :
Type de données : chaîne |
| result.reservation.reservable_module.short_description | Brève description du module réservable. Type de données : chaîne |
| result.reservation.reservable_module.show_map_view | Marqueur indiquant s’il faut activer la vue de carte pour les modules réservables. Valeurs valides :
Type de données : booléennes |
| result.reservation.reservable_module.sys_id | Sys_id du module réservable. Type de données : chaîne |
| result.reservation.reservable_module.timeSlots | Détails sur les créneaux horaires associés à un module réservable. Type de données : tableau d’objets |
| result.reservation.reservable_module.timeSlots.name | Nom du créneau horaire Type de données : chaîne |
| result.reservation.reservable_module.timeSlots.short_description | Brève description du créneau horaire. Type de données : chaîne |
| result.reservation.reservable_module.timeSlots.slot_end | Heure de fin du créneau horaire Type de données : chaîne |
| result.reservation.reservable_module.timeSlots.slot_start | Heure de début du créneau. Type de données : chaîne |
| result.reservation.reservable_module.timeSlots.sys_id | Sys_id de l’enregistrement de créneau horaire. Situé dans la table Créneau horaire [sn_wsd_rsv_time_slot]. Type de données : chaîne |
| result.reservation.reservable_module.titre | Titre du module réservable. Type de données : chaîne |
| result.reservation.reservable_module.virtual_meeting_provider | Détails sur le fournisseur virtuel associé au module réservable. Type de données : objet |
| result.reservation.reservable_module.virtual_meeting_provider.display_value | Valeur d’affichage du fournisseur de réunion virtuelle. Type de données : chaîne |
| result.reservation.reservable_module.virtual_meeting_provider.sys_id | Sys_id du fournisseur de réunion virtuelle. Type de données : chaîne |
| résultat.réservation.reservationAcl | Détails des vérifications des niveaux de contrôle d’accès (ACL) de l’utilisateur définies sur la réservation associée. Type de données : objet |
| result.reservation.reservationAcl.read | Marqueur indiquant s’il faut vérifier si l’utilisateur peut lire cette réservation. Valeurs valides :
Type de données : booléennes |
| résultat.reservation.reservationAcl.write | Détails sur les options d’écriture de l’utilisateur pour la réservation associée. Type de données : objet |
| résultat.réservation.reservationAcl.write.allFields | Marqueur indiquant s’il faut vérifier si l’utilisateur peut écrire dans tous les champs spécifiés dans l’objet reservationACL.write.fields . Si l’utilisateur n’a accès qu’à certains champs spécifiques, seuls ces champs sont vrais dans l’objet reservationACL.write.fields . Valeurs valides :
Type de données : booléennes |
| result.reservation.reservationAcl.write.fields | Détails des contrôles d’accès sur différents champs de la réservation. Type de données : objet |
| résultat.réservation.reservationAcl.écrire.champs.emplacement | Marqueur indiquant s’il faut vérifier si l’utilisateur peut écrire dans les champs d’emplacement de cette réservation. Valeurs valides :
Type de données : booléennes |
| result.reservation.reservationAcl.write.fields.number_of_attendees | Marqueur indiquant s’il faut vérifier si l’utilisateur peut écrire dans les champs Nombre de participants de cette réservation. Valeurs valides :
Type de données : booléennes |
| result.reservation.reservationAcl.write.fields.requested_for | Marqueur indiquant s’il faut vérifier si l’utilisateur peut écrire dans les champs demandés pour cette réservation. Valeurs valides :
Type de données : booléennes |
| résultat.réservation.reservationAcl.écrire.champs.sensibilité | Marqueur indiquant s’il faut vérifier si l’utilisateur peut écrire dans les champs de sensibilité de cette réservation. Valeurs valides :
Type de données : booléennes |
| résultat.reservation.reservationAcl.write.fields.subject | Marqueur indiquant s’il faut vérifier si l’utilisateur peut écrire dans les champs d’objet de cette réservation. Valeurs valides :
Type de données : booléennes |
| résultat.réservation.reservationAcl.write.record | Marqueur indiquant s’il faut vérifier si l’utilisateur peut écrire dans l’intégralité de l’enregistrement de réservation. Valeurs valides :
Type de données : booléennes |
| result.reservation.reservation_purpose | Détails sur l’objet de la réservation. Type de données : objet |
| result.reservation.reservation_purpose.display_value | Valeur d’affichage aux fins de la réservation, telle qu’une réunion d’entreprise. Type de données : chaîne |
| result.reservation.reservation_purpose.valeur | Valeur interne aux fins de la réservation, telle que company_meeting. Type de données : chaîne |
| result.reservation.reservation_type | Détails sur le type de réservation. Type de données : objet |
| result.reservation.reservation_type.display_value | Valeur d’affichage du type de réservation, telle que l’espace. Type de données : chaîne |
| result.reservation.reservation_type.valeur | Valeur interne du type de réservation, telle que l’espace. Type de données : chaîne |
| result.reservation.reservation_subtype | Détails sur le sous-type de la réservation. Les sous-types indiquent le type de réservation, par exemple unique, multiparentale, multi-enfant, parent récurrent ou occurrence. Type de données : objet |
| result.reservation.reservation_subtype.display_value | Valeur d’affichage du sous-type de la réservation, par exemple Unique. Type de données : chaîne |
| result.reservation.reservation_subtype.valeur | Valeur interne du sous-type de la réservation, par exemple unique. Type de données : chaîne |
| résultat.réservation.sensibilité | Détails sur le niveau de sensibilité de la réservation. Type de données : objet |
| result.reservation.sensitivity.display_value | Valeur d’affichage de la sensibilité de la réservation, par exemple élevée ou faible. Type de données : chaîne |
| résultat.réservation.sensibilité.valeur | Valeur interne de la sensibilité de la réservation, telle que 1 ou 3. Type de données : chaîne |
| résultat.réservation.shift | Détails sur l’équipe appliquée à la réservation. Type de données : objet |
| result.reservation.shift.display_value | Valeur d’affichage de l’équipe. Type de données : chaîne |
| result.reservation.shift.name | Nom de l'équipe. Identique à display_value. Type de données : chaîne |
| Résultat.réservation.équipe.shiftDetails | Détails de l’équipe. Type de données : chaîne |
| result.reservation.shift.sys_id | Sys_id de l’enregistrement d’équipe. Situé dans la table Équipe [sn_wsd_core_shift]. Type de données : chaîne |
| résultat.réservation.source | Détails sur la source de la réservation, tels que Workplace Services ou Google Mail. Type de données : objet |
| result.reservation.source.display_value | Valeur d’affichage de la source de réservation, telle que Services du lieu de travail. Type de données : chaîne |
| résultat.réservation.source.valeur | Valeur interne de la source de réservation, telle que ServiceNow. Type de données : chaîne |
| result.reservation.source_icon | Détails sur la source de l’icône utilisée dans la réservation. Cette icône est utilisée dans l’interface utilisateur. Type de données : objet |
| result.reservation.source_icon.classNames | Noms de classe séparés par des virgules pour l’icône source. Type de données : chaîne |
| result.reservation.source_icon.imgSrc | Nom de la source de l’image pour l’icône source. Cette icône est stockée dans la table Images [db_image]. Type de données : chaîne |
| result.reservation.source_icon.info-bulle | Info-bulle associée à l’icône source. Type de données : chaîne |
| result.reservation.source_reservation | Réservation source de la réservation actuelle. Par exemple, dans le cas de plusieurs réservations, la réservation parente est la source de la réservation enfant. Type de données : chaîne |
| Résultat.Réservation.Début | Date et heure de début de la réservation. Type de données : chaîne Format : UTC - aaaa-mm-jjThh :mm :ssZ, par exemple 2021-02-05T18:00:00Z |
| Résultat.Réservation.Objet | Objet de la réservation. Type de données : chaîne |
| result.reservation.sub_source | Détails sur la sous-source de la réservation. La sous-source spécifie le lieu d’origine de la réservation, par exemple Google Agenda ou Microsoft Exchange. Type de données : objet |
| result.reservation.sub_source.display_value | Valeur d’affichage de la sous-source de la réservation, telle que Google Agenda. Type de données : chaîne |
| result.reservation.sub_source.valeur | Valeur interne du champ sous-source de la réservation, telle que google_calendar. Type de données : chaîne |
| result.reservation.sync_state | Détails sur l’état de synchronisation d’une réservation à partir d’un autre service, tels que « sync_enqueued » ou « synchronisé ». Type de données : objet |
| result.reservation.sync_state.display_value | Valeur d’affichage de l’état de synchronisation actuel de la réservation, tel que synchronisé. Type de données : chaîne |
| result.reservation.sync_state.valeur | Valeur interne de l’état de synchronisation actuel de la réservation, tel que synchronisé. Type de données : chaîne |
| result.reservation.sys_created_on | Date et heure de création de la réservation. Type de données : chaîne |
| result.reservation.sys_id | Requis. Sys_id de l’enregistrement de réservation. Situé dans la table Réservation du lieu de travail [sn_wsd_rsv_reservation]. Type de données : chaîne |
| Result.reservation.sys_updated_on | Date et heure de la dernière mise à jour de la réservation. Type de données : chaîne |
| result.reservation.virtual_meeting | URL du lien de la réunion virtuelle. Type de données : chaîne |
| result.reservationAcl | Détails des vérifications des niveaux de contrôle d’accès (ACL) de l’utilisateur définies sur la réservation associée. Type de données : objet |
| result.reservationAcl.read | Marqueur indiquant s’il faut vérifier si l’utilisateur peut lire cette réservation. Valeurs valides :
Type de données : booléennes |
| résultat.reservationAcl.write | Détails sur les options d’écriture de l’utilisateur pour la réservation associée. Type de données : objet |
| result.reservationAcl.write.allFields | Marqueur indiquant s’il faut vérifier si l’utilisateur peut écrire dans tous les champs spécifiés dans l’objet reservationACL.write.fields . Si l’utilisateur n’a accès qu’à certains champs spécifiques, seuls ces champs sont vrais dans l’objet reservationACL.write.fields . Valeurs valides :
Type de données : booléennes |
| result.reservationAcl.write.fields | Détails des contrôles d’accès sur différents champs de la réservation. Type de données : objet |
| résultat.reservationAcl.écrire.champs.emplacement | Marqueur indiquant s’il faut vérifier si l’utilisateur peut écrire dans les champs d’emplacement de cette réservation. Valeurs valides :
Type de données : booléennes |
| result.reservationAcl.write.fields.number_of_attendees | Marqueur indiquant s’il faut vérifier si l’utilisateur peut écrire dans les champs Nombre de participants de cette réservation. Valeurs valides :
Type de données : booléennes |
| result.reservationAcl.write.fields.requested_for | Marqueur indiquant s’il faut vérifier si l’utilisateur peut écrire dans les champs demandés pour cette réservation. Valeurs valides :
Type de données : booléennes |
| résultat.reservationAcl.write.fields.sensitivity | Marqueur indiquant s’il faut vérifier si l’utilisateur peut écrire dans les champs de sensibilité de cette réservation. Valeurs valides :
Type de données : booléennes |
| résultat.reservationAcl.écrire.champs.objet | Marqueur indiquant s’il faut vérifier si l’utilisateur peut écrire dans les champs d’objet de cette réservation. Valeurs valides :
Type de données : booléennes |
| résultat.reservationAcl.record | Marqueur indiquant s’il faut vérifier si l’utilisateur peut écrire dans l’intégralité de l’enregistrement de réservation. Valeurs valides :
Type de données : booléennes |
| result.standard_services | Renseigné uniquement si le include_standard_services paramètre est défini sur vrai. Services standard associés, tels que tableau de conférence, écran de projection, tableau blanc et marqueurs. Type de données : tableau d’objets
|
| result.standard_services.font_awesome_icon | Nom de l’icône de miniature associée au service standard. Type de données : chaîne |
| result.standard_services.name | Nom du service standard. Type de données : chaîne |
| result.standard_services.short_description | Brève description du service standard. Type de données : chaîne |
| result.standard_services.sys_id | Sys_id des états de service standard. Situé dans la table Service standard [sn_wsd_rsv_standard_service]. Type de données : chaîne |
Demande cURL
Cet exemple de code montre comment appeler ce point de terminaison pour récupérer une liste de réservations associées à l’utilisateur spécifié.
curl "https://instance.servicenow.com/api/sn_wsd_rsv/reservation/list" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"
Résultats renvoyés :
{
"result": {
"reservations": [
{
"sys_id": "12e2da5e87c701106342b846dabb354d",
"number": "WRES0001010",
"location": {
"sys_id": "02000d4edb7650106c731dcd13961914",
"name": "Eureka",
"description": "A comfortable meeting room with leather chairs and a wooden table. Client meeting room.",
"display_value": "Eureka",
"capacity": 12,
"label_value": "Room name",
"email": "eureka@example.com",
"reservable_module": {
"sys_id": "c31241cedb7650106c731dcd13961917",
"name": "Meeting rooms",
"title": "Meeting rooms",
"inline_title": "meeting room"
},
"region": {
"sys_id": "2d626c4edb3650106c731dcd1396194b",
"display_value": "Europe",
"active": true
},
"site": {
"sys_id": "b17220cedb3650106c731dcd1396197a",
"display_value": "Western Europe",
"active": true
},
"campus": {
"sys_id": "44d2e0cedb3650106c731dcd13961988",
"display_value": "Amsterdam Campus",
"active": true
},
"building": {
"sys_id": "9e0364cedb3650106c731dcd1396192b",
"display_value": "AMS-B1",
"active": true,
"timezone": {
"value": "Europe/Amsterdam",
"displayValue": "Europe/Amsterdam"
}
},
"floor": {
"sys_id": "5373a8cedb3650106c731dcd1396198a",
"display_value": "Floor 3",
"active": true
},
"area": {
"sys_id": "",
"display_value": "",
"active": false
},
"reservation": {
"sys_id": "12e2da5e87c701106342b846dabb354d",
"number_of_attendees": 1,
"state": {
"value": "confirmed",
"display_value": "Confirmed"
},
"requested_for": {
"sys_id": "2de07e1887cb89106342b846dabb35fe",
"name": "Workplace User",
"user_name": "workplace_user"
},
"number": "WRES0001010",
"active": true
},
"number_of_attendees": 1,
"state": {
"value": "confirmed",
"display_value": "Confirmed"
},
"number": "WRES0001010",
"requested_for": {
"sys_id": "2de07e1887cb89106342b846dabb35fe",
"name": "Workplace User",
"user_name": "workplace_user"
}
},
"start": "2022-05-15T16:00:00Z",
"end": "2022-05-15T17:00:00Z",
"sys_created_on": "2022-04-26T09:19:37Z",
"sys_updated_on": "2022-04-26T09:20:04Z",
"source_reservation": null,
"check_in_state": {
"value": "not_required",
"display_value": "Not required"
},
"external_id": null,
"external_ical": null,
"active": true,
"state": {
"value": "confirmed",
"display_value": "Confirmed"
},
"sensitivity": {
"value": "normal",
"display_value": "Normal"
},
"reservation_type": {
"value": "space",
"display_value": "Space"
},
"reservation_subtype": {
"value": "single",
"display_value": "Single"
},
"reservation_purpose": {
"value": "meeting",
"display_value": "Meeting"
},
"attendees": [
{
"sys_id": "2de07e1887cb89106342b846dabb35fe",
"value": "2de07e1887cb89106342b846dabb35fe",
"displayValue": "Workplace User",
"display_value": "Workplace User",
"name": "Workplace User",
"user_name": "workplace_user",
"table": "sys_user",
"avatar": "eb513744c3222010ae17dd981840dd97",
"initials": "WU",
"email": "workplace_user@example.com",
"label": ""
}
],
"number_of_attendees": 1,
"is_parent": false,
"subject": "Add rsv_1",
"virtual_meeting": "https://samplemeetingurl.com",
"recording_details": [
{
"recording_url": "https://samplerecordingurl.com"
}
],
"sync_state": {
"value": "not_required",
"display_value": "Synchronization not required"
},
"sub_source": {
"value": "servicenow_workplace_service_delivery",
"display_value": "ServiceNow Workplace Service Delivery"
},
"last_updated_sub_source": {
"value": "servicenow_workplace_service_delivery",
"display_value": "ServiceNow Workplace Service Delivery"
},
"reservable_module": {
"sys_id": "c31241cedb7650106c731dcd13961917",
"name": "Meeting rooms",
"title": "Meeting rooms",
"inline_title": "meeting room",
"font_awesome_icon": "fa-building",
"reservable_table": "sn_wsd_core_room",
"reservable_filter": "active=true^is_reservable=true^building!=6c0364cedb3650106c731dcd13961927^building.is_reservable=true^floor.is_reservable=true^EQ",
"short_description": "Reserve a meeting room",
"reservable_type": "location",
"require_subject": "1",
"require_cancel_notes": true,
"virtual_meeting_provider": {
"sys_id": "e33d9e6853c201103cf7ddeeff7b1205",
"display_value": "Template"
},
"allow_invitees": "1",
"display_number_of_attendees": "1",
"display_on_behalf_of": "1",
"display_sensitivity": "1",
"max_days_in_future": "180",
"allow_whole_day": "1",
"selection_type": "unit",
"reservable_container_field": null,
"reservable_quantity_field": null,
"apply_to_shift": null,
"max_occurrences": "180",
"enable_facet_filter": false,
"search_limit": 10000,
"enable_ical_generation": null,
"enable_group_reservations": null,
"enable_browse_near_a_person": "1",
"enable_browse_by_area": "1",
"display_value": "Meeting rooms",
"browse_near_a_person_enabled": true,
"browse_by_area_enabled": true,
"reservable_columns": [
"sys_id",
"external_id",
"email",
"name",
"title",
"description",
"image",
"number",
"site",
"campus",
"building",
"floor",
"area",
"capacity",
"reservable_quantity",
"location_type",
"order",
"requires_check_in",
"is_reservable"
],
"layout_mapping": {
"title": [
"name"
],
"description": [
"description"
],
"subtitle": [
"campus",
"building",
"floor",
"area"
],
"subtitle_asc": [
"area",
"floor",
"building",
"campus"
],
"image": "image",
"body": [
{
"label": "Capacity",
"icon": "fa-users",
"field": "capacity",
"field_to_display": ""
},
{
"label": "Standard services",
"icon": "fa-check",
"field": "standard_services",
"field_to_display": "name"
},
{
"label": "Reservable purposes",
"icon": "fa-tags",
"field": "reservable_purposes",
"field_to_display": "name"
}
]
},
"timeSlots": [
{
"sys_id": "d5331cf2dbb5f01038e42b24ca961906",
"name": "All day",
"short_description": "8am - 6pm",
"slot_start": "08:00",
"slot_end": "18:00"
}
],
"buildingSysIds": [
"4703a4cedb3650106c731dcd13961945",
"6c0364cedb3650106c731dcd13961927",
"94e264cedb3650106c731dcd13961919",
"9e0364cedb3650106c731dcd1396192b"
],
"reservable_views": [
{
"type": "card",
"label": "Card view",
"iconClass": "fa-th-large",
"isDefault": true,
"order": "1"
},
{
"type": "schedule",
"label": "Schedule view",
"iconClass": "fa-calendar-o",
"isDefault": false,
"order": "2"
}
],
"checkin_before_minutes": 30,
"reservation_paths": [
{
"value": "browse_all",
"displayValue": "Browse all"
},
{
"value": "browse_near_a_person",
"displayValue": "Browse near a person"
},
{
"value": "browse_by_area",
"displayValue": "Browse by area"
}
],
"override_approval_policy": "never_required"
},
"notification_recipients": [
{
"sys_id": "7016f79cc0a8016401c5a33be04be441",
"name": "workplace user",
"user_name": "workplace.user"
}
],
"notification_custom_message": "Demo notification message",
"opened_by": {
"sys_id": "6816f79cc0a8016401c5a33be04be441",
"value": "6816f79cc0a8016401c5a33be04be441",
"displayValue": "System Administrator",
"display_value": "System Administrator",
"name": "System Administrator",
"user_name": "admin",
"table": "sys_user",
"avatar": "eb513744c3222010ae17dd981840dd97",
"initials": "SA",
"email": "admin@example.com",
"label": "System Administrator"
},
"requested_for": {
"sys_id": "2de07e1887cb89106342b846dabb35fe",
"value": "2de07e1887cb89106342b846dabb35fe",
"displayValue": "Workplace User",
"display_value": "Workplace User",
"name": "Workplace User",
"user_name": "workplace_user",
"table": "sys_user",
"avatar": "d3513744c3222010ae17dd981840dd97",
"initials": "WU",
"email": "workplace_user@example.com",
"label": ""
},
"edit_restriction": {
"value": "no_restriction",
"display_value": "No restriction"
},
"source": {
"value": "servicenow",
"display_value": "Workplace Services"
},
"source_icon": {
"classNames": "fa fa-calendar-check-o",
"tooltip": "Reservation is confirmed",
"imgSrc": ""
},
"shift": {
"sys_id": "e5d23acfdb42a01097acc9003996193a",
"name": "Test shift AMS-B1",
"display_value": "Test shift AMS-B1",
"shiftDetails": "8-5 weekdays excluding holidays\n - Monday-Friday 8-5"
},
"reservationAcl": {
"write": {
"record": true,
"fields": {
"subject": true,
"sensitivity": true,
"requested_for": true,
"number_of_attendees": true,
"location": true
},
"allFields": true
},
"read": true
}
}
]
}
}
Réservation WSD : PATCH /api/sn_wsd_rsv/reservation/cancel/{sys_id}
Annule une réservation de lieu de travail spécifiée.
Format d'URL
URL versionnée : /api/sn_wsd_rsv/{api_version}/reservation/cancel/{sys_id}
URL par défaut : /api/sn_wsd_rsv/reservation/cancel/{sys_id}
Paramètres de demande pris en charge
| Nom | Description |
|---|---|
| api_version | Facultatif. Version du point de terminaison auquel accéder. 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 |
| sys_id | Sys_id de la réservation à annuler. Situé dans la table Réservation du lieu de travail [sn_wsd_rsv_reservation]. Type de données : chaîne |
| Nom | Description |
|---|---|
| Aucun |
| Nom | Description |
|---|---|
| cancel_notes | Motif de l’annulation de la réservation. 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 demande. Types pris en charge : application/json, application/xml ou, text/xml. Valeur par défaut : application/json |
| Content-Type | Format de données du corps de la demande. Prend uniquement en charge application/json. |
| En-tête | Description |
|---|---|
| Aucun |
Codes d'état
Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.
| Code d'état | Description |
|---|---|
| 200 | Réussi. La demande a été correctement traitée. |
| 401 | Non autorisé. Les informations d'identification de l'utilisateur sont incorrectes ou n'ont pas été transmises. |
| 404 | Introuvable. L’élément demandé est introuvable. |
| 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 |
|---|---|
| sys_id | Sys_id de l’enregistrement de réservation annulée. Situé dans la table Réservation du lieu de travail [sn_wsd_rsv_reservation]. Type de données : chaîne |
Demande cURL
L’exemple de code suivant montre comment annuler une réservation à l’aide de ce point de terminaison.
curl "https://instance.servicenow.com/api/sn_wsd_rsv/reservation/cancel/12e2da5e87c701106342b846dabb354d" \
--request PATCH \
--header "Accept:application/json" \
--user ‘username’:’password’
Résultats renvoyés :
"result": {
"sys_id": "73c316d2474b0150003a4587746d4337"
}
Réservation WSD : PATCH /api/sn_wsd_rsv/reservation/share_details/{sys_id}
Met à jour et partage les détails de la réservation avec une liste spécifiée de destinataires via une notification par e-mail. Si vous le souhaitez, vous pouvez envoyer un message spécifié avec la réservation.
Format d'URL
URL versionnée : /api/sn_wsd_rsv/{api_version}/reservation/share_details/{sys_id}
URL par défaut : /api/sn_wsd_rsv/reservation/share_details/{sys_id}
Paramètres de demande pris en charge
| Nom | Description |
|---|---|
| api_version | Type de données : chaîne |
| sys_id | Sys_id de la réservation à partager. Situé dans la table Réservation du lieu de travail [sn_wsd_rsv_reservation]. Type de données : chaîne |
| Nom | Description |
|---|---|
| Aucun |
| Nom | Description |
|---|---|
| notification_custom_message | Message à envoyer aux destinataires spécifiés. Type de données : chaîne |
| notification_recipients | Requis. Liste des sys_ids des utilisateurs auxquels envoyer la notification par e-mail. Situé dans la table Utilisateur [sys_user]. Type de données : tableau |
| notification_type | Type de notification à envoyer. Types valides :
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 demande. Types pris en charge : application/json, application/xml ou, text/xml. Valeur par défaut : application/json |
| Content-Type | Format de données du corps de la demande. Prend uniquement en charge application/json. |
| En-tête | Description |
|---|---|
| Aucun |
Codes d'état
Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.
| Code d'état | Description |
|---|---|
| 200 | Réussi. La demande a été correctement traitée. |
| 401 | Non autorisé. Les informations d'identification de l'utilisateur sont incorrectes ou n'ont pas été transmises. |
| 404 | Introuvable. L’élément demandé est introuvable. |
| 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 |
|---|---|
| sys_id | Sys_id de l’enregistrement de réservation qui a été partagé. Situé dans la table Réservation du lieu de travail [sn_wsd_rsv_reservation]. Type de données : chaîne |
Demande cURL
L’exemple de code suivant montre comment utiliser ce point de terminaison pour partager une réservation.
curl "https://instance.servicenow.com/api/sn_wsd_rsv/reservation/share_details/60d26a0f47578910003a4587746d4331" \
--request PATCH \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
\"notification_recipients\": [\"5dfb9fcf47d78910003a4587746d4367\"],
\"notification_type\":\"reservation_updated\",
\"notification_custom_message\": \"Please join our design brainstorming meeting!\"
}" \
--user "username":"password"
Résultats renvoyés :
"result": {
"sys_id": "60d26a0f47578910003a4587746d4331"
}
Réservation WSD : PATCH /api/sn_wsd_rsv/reservation/update/{sys_id}
Met à jour une réservation de lieu de travail spécifiée.
Format d'URL
URL versionnée : /api/sn_wsd_rsv/{api_version}/reservation/update/{sys_id}
URL par défaut : /api/sn_wsd_rsv/reservation/update/{sys_id}
Paramètres de demande pris en charge
| Nom | Description |
|---|---|
| api_version | Facultatif. Version du point de terminaison auquel accéder. 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 |
| sys_id | Sys_id de la réservation à modifier. Situé dans la table Réservation du lieu de travail [sn_wsd_rsv_reservation]. Type de données : chaîne |
| Nom | Description |
|---|---|
| ignore_same_day_validation | Marqueur indiquant si la recherche de réservation ignore le changement de la validation de la date entre les paramètres de début et de fin. Valeurs valides :
Type de données : booléennes Valeur par défaut : false |
| Nom | Description |
|---|---|
| fin | Requis si le shift paramètre n’est pas transmis. Heure de fin de la réservation demandée. Type de données : chaîne Format : UTC ou heure locale (aaaa-mm-jj hh :mm :ss) |
| is_private | Marqueur indiquant si la réservation est privée. Si elle est privée, la réservation n’apparaît à personne d’autre qu’au propriétaire. Pour plus d’informations sur ces paramètres de confidentialité, consultez la section Paramètres de confidentialité de la localisation et impact. Valeurs valides :
Type de données : booléennes Par défaut : valeur définie pour la confidentialité dans les propriétés système. |
| emplacement | Requis. Sys_id de l’emplacement à réserver. Situé dans la table Emplacement du lieu de travail [sn_wsd_core_workplace_location]. Type de données : chaîne |
| requested_for | Sys_id ou adresse e-mail de l’utilisateur pour lequel la réservation est effectuée. Situé dans la table Utilisateur [sys_user]. Type de données : chaîne |
| Période de travail | Sys_id de l’équipe à associer à la réservation. Situé dans la table Équipe [sn_wsd_core_shift]. Si ce paramètre est transmis, il end n’est pas obligatoire. Pour plus d’informations sur les réservations basées sur l’équipe, consultez Activer la réservation basée sur l’équipe. Type de données : chaîne |
| début | Requis. A demandé l’heure de début de la réservation. Type de données : chaîne Format : UTC ou heure locale (aaaa-mm-jj hh :mm :ss) |
| objet | Requis. Objet de la réunion associée à la réservation. 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 demande. Types pris en charge : application/json, application/xml ou, text/xml. Valeur par défaut : application/json |
| Content-Type | Format de données du corps de la demande. Prend uniquement en charge application/json. |
| En-tête | Description |
|---|---|
| Aucun |
Codes d'état
Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.
| Code d'état | Description |
|---|---|
| 200 | Réussi. La demande a été correctement traitée. |
| 401 | Non autorisé. Les informations d'identification de l'utilisateur sont incorrectes ou n'ont pas été transmises. |
| 404 | Introuvable. L’élément demandé est introuvable. |
| 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 ou XML)
| Nom | Description |
|---|---|
| résultat | Détails de la réservation mise à jour. Type de données : objet |
| result.location_id | Sys_id de l’enregistrement du lieu de réservation. Situé dans la table Emplacement du lieu de travail [sn_wsd_core_workplace_location]. Type de données : chaîne |
| result.sys_id | Sys_id de l’enregistrement de réservation modifié. Situé dans la table Réservation du lieu de travail [sn_wsd_rsv_reservation]. Type de données : chaîne |
| result.type_of_change | Type d’informations mises à jour dans la réservation. Type de données : chaîne |
Demande cURL
L’exemple de code suivant montre comment mettre à jour une réservation à l’aide de ce point de terminaison.
curl "https://instance.servicenow.com/api/sn_wsd_rsv/reservation/update/b537abc947db4510003a4587746d4351" \
--request PATCH \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
\"subject\": \"Rsv Update_1\",
\"start\": \"2022-07-21 14:00:00\",
\"end\": \"2022-07-21 15:00:00\",
\"requested_for\": \"workplace_user@example.com\",
\"workplace_location\": \"fe1f744edb7650106c731dcd139619ca\",
\"is_private\": \false\
}" \
--user "username":"password"
Résultats renvoyés :
{
"result": {
"sys_id": "b537abc947db4510003a4587746d4351",
"location_id": "fe1f744edb7650106c731dcd139619ca",
"type_of_change": "location"
}
}
Réservation WSD : POST /api/sn_wsd_rsv/reservation/add
Crée une nouvelle réservation de lieu de travail.
Format d'URL
URL versionnée : /api/sn_wsd_rsv/{api_version}/reservation/add
URL par défaut : /api/sn_wsd_rsv/reservation/add
Paramètres de demande pris en charge
| Nom | Description |
|---|---|
| api_version | Facultatif. Version du point de terminaison auquel accéder. 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 |
| Nom | Description |
|---|---|
| ignore_same_day_validation | Marqueur indiquant si la recherche de réservation ignore le changement de la validation de la date entre les paramètres de début et de fin. Valeurs valides :
Type de données : booléennes Valeur par défaut : false |
| fuseau horaire | Fuseau horaire privilégié pour effectuer les validations de demande. Par exemple : Europe/Amsterdam. Cette validation vérifie si l’heure de début et de fin tombe le même jour. Type de données : chaîne Par défaut : fuseau horaire de l’utilisateur |
| Nom | Description |
|---|---|
| fin | Requis si le shift paramètre n’est pas transmis. Heure de fin de la réservation demandée. Type de données : chaîne Format : UTC ou heure locale (aaaa-mm-jj hh :mm :ss) |
| is_private | Marqueur indiquant si la réservation est privée. Si elle est privée, la réservation n’apparaît à personne d’autre qu’au propriétaire. Pour plus d’informations sur ces paramètres de confidentialité, consultez la section Paramètres de confidentialité de la localisation et impact. Valeurs valides :
Type de données : booléennes Par défaut : valeur définie pour la confidentialité dans les propriétés système. |
| emplacement | Requis. Sys_id de l’emplacement à réserver. Situé dans la table Emplacement du lieu de travail [sn_wsd_core_workplace_location]. Type de données : chaîne |
| requested_for | Sys_id ou adresse e-mail de l’utilisateur pour lequel la réservation est effectuée. Situé dans la table Utilisateur [sys_user]. Type de données : chaîne |
| reservable_module | Requis. Sys_id du module réservable à associer à la réservation. Un module réservable définit les éléments d’espace de travail nécessaires pour une réservation. Situé dans la table Module réservable [sn_wsd_rsv_reservable_module]. Type de données : chaîne |
| Période de travail | Sys_id de l’équipe à associer à la réservation. Situé dans la table Équipe [sn_wsd_core_shift]. Si ce paramètre est transmis, il end n’est pas obligatoire. Pour plus d’informations sur les réservations basées sur l’équipe, consultez Activer la réservation basée sur l’équipe. Type de données : chaîne |
| début | Requis. A demandé l’heure de début de la réservation. Type de données : chaîne Format : UTC ou heure locale (aaaa-mm-jj hh :mm :ss) |
| objet | Requis. Objet de la réunion associée à la réservation. 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 demande. Types pris en charge : application/json, application/xml ou, text/xml. Valeur par défaut : application/json |
| Content-Type | Format de données du corps de la demande. Prend uniquement en charge application/json. |
| En-tête | Description |
|---|---|
| Aucun |
Codes d'état
Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.
| Code d'état | Description |
|---|---|
| 200 | Réussi. La demande a été correctement traitée. |
| 401 | Non autorisé. Les informations d'identification de l'utilisateur sont incorrectes ou n'ont pas été transmises. |
| 404 | Introuvable. L’élément demandé est introuvable. |
| 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 |
|---|---|
| sys_id | Sys_id de l’enregistrement de réservation créé. Situé dans la table Réservation du lieu de travail [sn_wsd_rsv_reservation]. Type de données : chaîne |
Demande cURL
L’exemple de code suivant montre comment utiliser ce point de terminaison pour créer une réservation.
curl "https://instance.servicenow.com/api/sn_wsd_rsv/reservation/add" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
\"reservable_module\": \"c31241cedb7650106c731dcd13961917\",
\"subject\": \"Test-123\",
\"reservation_purpose\": \"meeting\",
\"timezone\": \"US/Pacific\",
\"requested_for\": \"6816f79cc0a8016401c5a33be04be441\",
\"location\": \"5eafb44edb7650106c731dcd13961943\",
\"is_private\": false,
\"start\": \"2023-01-12T11:00:00Z\",
\"end\": \"2023-01-12T12:00:00Z\"
}" \
--user "username":"password"
Résultats renvoyés :
"result": {
"sys_id": "4b036a9e474b0150003a4587746d43b1"
}
Réservation WSD : POST /api/sn_wsd_rsv/reservation/quick_reserve
Crée une réservation de lieu de travail à l’aide de la réservation rapide.
Format d'URL
URL versionnée : /api/sn_wsd_rsv/{api_version}/reservation/quick_reserve
URL par défaut : /api/sn_wsd_rsv/reservation/quick_reserve
Paramètres de demande pris en charge
| Nom | Description |
|---|---|
| api_version | Facultatif. Version du point de terminaison auquel accéder. 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 |
| Nom | Description |
|---|---|
| Aucun |
| Nom | Description |
|---|---|
| fin | Requis si le shift paramètre n’est pas transmis. Heure de fin de la réservation demandée. Type de données : chaîne Format : UTC ou heure locale (aaaa-mm-jj hh :mm :ss) |
| ignore_same_day_validation | Requis. Marqueur indiquant si le point de terminaison ignore la validation du changement de date entre les start paramètres et end Valeurs valides :
Type de données : booléennes |
| reference_location_id | Requis. Sys_id de l’emplacement à proximité duquel l’utilisateur souhaite réserver un emplacement. Situé dans la table Emplacement du lieu de travail [sn_wsd_core_workplace_location]. Type de données : chaîne |
| reservable_module | Requis. Sys_id du module réservable à associer à la réservation. Un module réservable définit les éléments d’espace de travail nécessaires pour une réservation. Situé dans la table Module réservable [sn_wsd_rsv_reservable_module]. Type de données : chaîne |
| Période de travail | Sys_id de l’équipe à associer à la réservation. Situé dans la table Équipe [sn_wsd_core_shift]. Si ce paramètre est transmis, il end n’est pas obligatoire. Pour plus d’informations sur les réservations basées sur l’équipe, consultez Activer la réservation basée sur l’équipe. Type de données : chaîne |
| début | Requis. A demandé l’heure de début de la réservation. Type de données : chaîne Format : UTC ou heure locale (aaaa-mm-jj hh :mm :ss) |
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 demande. Types pris en charge : application/json, application/xml ou, text/xml. Valeur par défaut : application/json |
| Content-Type | Format de données du corps de la demande. Prend uniquement en charge application/json. |
| En-tête | Description |
|---|---|
| Aucun |
Codes d'état
Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.
| Code d'état | Description |
|---|---|
| 200 | Réussi. La demande a été correctement traitée. |
| 401 | Non autorisé. Les informations d'identification de l'utilisateur sont incorrectes ou n'ont pas été transmises. |
| 404 | Introuvable. L’élément demandé est introuvable. |
| 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 |
|---|---|
| sys_id | Sys_id de l’enregistrement de réservation créé. Situé dans la table Réservation du lieu de travail [sn_wsd_rsv_reservation]. Type de données : chaîne |
Demande cURL
L’exemple de code suivant montre comment utiliser le point de terminaison de réservation rapide pour créer une réservation.
curl "https://instance.servicenow.com/api/sn_wsd_rsv/reservation/quick_reserve" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
\"start\":\"2022-05-23 16:00:00\",
\"end\": \"2022-05-23 17:00:00\",
\"reservable_module\": \"5db44502dbb650106c731dcd13961937\",
\"reference_location_id\": \"05f5290edb7210106c731dcd13961951\",
\"ignore_same_day_validation\": \"true\"
}" \
--user "username":"password"
Résultats renvoyés :
"result": {
"sys_id": "4b036a9e474b0150003a4587746d43b1"
}