API de réservation récurrente WSD

  • Rversion finale: Washingtondc
  • Mis à jour 1 févr. 2024
  • 43 minutes de lecture

    • L’API Workplace Service Deliveryde réservation récurrente (WSD) fournit des points de terminaison pour la gestion des réservations qui se produisent en même temps, mais qui ont des dates différentes.

    Pour accéder à cette API, l’appelant doit disposer du 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 Workplace Reservation Management, consultez Workplace Reservation Management.

    Réservation récurrente WSD : GET /api/sn_wsd_rsv/recurring_reservation/list/{parent_id}

    Renvoie la réservation récurrente spécifiée.

    Si plus de six occurrences de réunion récurrentes sont disponibles pour la réservation, vous pouvez les paginer à l’aide des paramètres de requête. Vous pouvez également spécifier des enregistrements d’occurrence à ne pas renvoyer.

    Format d'URL

    URL versionnée : /api/sn_wsd_rsv/{api_version}/recurring_reservation/list/{parent_id}

    URL par défaut : /api/sn_wsd_rsv/recurring_reservation/list/{parent_id}

    Paramètres de demande pris en charge

    Tableau 1. Paramètres de chemin d'accès
    Nom Description
    api_version Facultatif. Version du point de terminaison auquel accéder. 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
    parent_id Sys_id de l’enregistrement de réservation parent récurrent. Situé dans la table Réservation du lieu de travail [sn_wsd_rsv_reservation].

    Lorsqu’une réservation récurrente est créée, un enregistrement parent récurrent et un ou plusieurs enregistrements de réservation enfant sont créés. Les enregistrements de réservation contiennent un champ appelé reservation_subtype, qui indique le type d’enregistrement de réservation. Pour les enregistrements parents récurrents, ce champ est défini sur « Parent récurrent ». Pour les enregistrements enfants, ce champ est défini sur « Occurrence ».

    Dans un enregistrement enfant, l’sys_id de l’enregistrement parent récurrent associé se trouve dans le champ source_reservation.

    Type de données : chaîne
    Tableau 2. Paramètres de requête
    Nom Description
    end_index Lors de la pagination dans un jeu d’enregistrements récurrent, le numéro d’enregistrement de base zéro auquel arrêter le retour des enregistrements d’occurrence.
    Remarque :
    Si le nombre d’occurrences récurrentes est inférieur à six, le point de terminaison renvoie toutes les occurrences, sinon il renvoie les six premières occurrences. Pour récupérer les occurrences au-delà de six, vous devez transmettre le paramètre end_index en conséquence.

    Type de données : nombre
    occurrence_sys_id Sys_id d’un enregistrement d’occurrence dans la série récurrente à ne pas revenir. Situé dans la table Réservation du lieu de travail [sn_wsd_rsv_reservation].
    start_index Lorsque vous paginez dans un jeu d’enregistrements récurrent, il s’agit du numéro d’enregistrement de base zéro à partir duquel commencer à renvoyer les enregistrements d’occurrences.

    Type de données : nombre

    Par défaut : 0
    Tableau 3. Paramètres de corps de demande
    Nom Description
    Néant

    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 une liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

    Tableau 4. En-têtes de demandes
    En-tête Description
    Accepter Format de données du corps de la demande. Types pris en charge : application/json, application/xml ou, text/xml.

    Valeur par défaut : application/json
    Tableau 5. En-têtes de réponses
    En-tête Description
    Aucun

    Codes d'état

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

    Tableau 6. Codes d'état
    Code d'état Description
    200 Réussi. La demande a été correctement traitée.
    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 Renvoyer les résultats pour la réservation récurrente demandée.

    Type de données : objet

    "result": {
 "occurencesTotalCount": "String",
 "reservation": {Object}
}
    result.occurencesTotalCount Nombre total d’occurrences de réunion dans la série récurrente.

    Type de données : chaîne
    résultat.réservation Détails sur la réservation récurrente demandée.

    Type de données : objet

    "reservation": {
  "active": Boolean,
  "attendees": [Array],
  "check_in_state": {Object},
  "edit_restriction": {Object},
  "end": "String",
  "external_ical": "String",
  "external_id": "String",
  "is_parent": Boolean,
  "last_updated_sub_source": {Object},
  "location": {Object},
  "notification_custom_message": "String",
  "notification_recipients": [Array],
  "number": "String",
  "number_of_attendees": Number,
  "opened_by": {Object},
  "recording_details": [Array],
  "recurring_pattern": {Object},
  "requested_for": {Object},
  "reservable_module": {Object},
  "sensitivity": {Object},
  "shift": {Object},
  "source": {Object},
  "source_icon": {Object},
  "source_reservation": {OObject},
  "source_reservation_requester": {Object},
  "start": "String",
  "state": {OObject},
  "sys_created_on": "String",
  "sys_id": "String",
  "sys_updated_on": "String",
  "subject": "String",
  "sub_source": {Object},
  "sync_state": {Object},
  "virtual_meeting": "String"
}
    result.reservation.active Marqueur indiquant si la réservation est active.
    Valeurs valides :
    • true : la réservation est active.
    • false : la réservation est inactive.

    Type de données : booléennes
    résultat.réservation.participants Liste des participants à la réservation.

    Type de données : tableau d’objets

    "attendees": [
  {
    "avatar": "String",
    "displayValue": "String",
    "display_value": "String",
    "email": "String",
    "initials": "String",
    "label": "String",
    "name": "String",
    "sys_id": "String",
    "table": "String",
    "user_name": "String",
    "value": "String"
  }
]
    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.initiaux 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 des participants.

    Type de données : chaîne
    résultat.réservation.participants.table Table dans laquelle se trouve l’enregistrement des participants.

    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

    "check_in_state": {
  "display_value": "String,"
  "value": "String"
}
    result.reservation.check_in_state.display_value Affichez la valeur 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.value 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 de l’utilisateur pour la réservation, telles que no_restrictions, service_only ou fully_restricted.

    Type de données : objet

    "edit_restriction": {
  "display_value": "String",
  "value": "String"
}
    result.reservation.edit_restriction.valeur_affichage 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, par exemple 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 :
    • true : réservation parente.
    • false : aucune réservation parente.

    Type de données : booléennes
    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

    "last_updated_sub_source": {
  "display_value": "String,"
  "value": "String"
}
    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

    "location": {
  "area": {Object},
  "building": {Object},
  "campus": {Object},
  "capacity": Number,
  "description": "String",
  "display_value": "String",
  "email": "String",
  "floor": {Object},
  "label_value": "String",
  "name": "String",
  "number": "String",
  "number_of_attendees": Boolean,
  "reservable_module": {Object},
  "region": {Object},
  "reservation": {Object},
  "site": {Object},
  "requested_for": {Object},
  "state": {Object},
  "sys_id": "String",
}
    résultat.réservation.emplacement.zone Détails sur la zone associée à l’emplacement.

    Type de données : objet

    "area": {
  "active": Boolean,
  "display_value": "String,"
  "sys_id": "String"
}
    result.reservation.location.area.active Marqueur indiquant si la zone est active.
    Valeurs valides :
    • true : la zone est active.
    • false : la zone est inactive.

    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

    "building": {
  "active": Boolean,
  "display_value": "String",
  "sys_id": "String",
  "timezone": {Object}
}
    result.reservation.location.building.active Marqueur indiquant si le bâtiment est actif.
    Valeurs valides :
    • true : le bâtiment est actif.
    • false : le bâtiment est inactif.

    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 du fuseau horaire du bâtiment.
    "timezone": {
  "displayValue": "String",
  "value": "String"
}
    result.reservation.location.building.timezone.display_value Valeur d’affichage du fuseau horaire dans lequel se trouve le bâtiment associé.

    Type de données : chaîne
    résultat.réservation.emplacement.bâtiment.fuseau.horaire.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

    "campus": {
  "active": Boolean,
  "display_value": "String,"
  "sys_id": "String"
}
    result.reservation.location.campus.active Marqueur indiquant si le campus est actif.
    Valeurs valides :
    • true : le campus est actif.
    • false : le campus est inactif.

    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
    description.réservation.emplacement 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

    "floor": {
  "active": Boolean,
  "display_value": "String,"
  "sys_id": "String"
}
    result.reservation.location.floor.active Marqueur indiquant si l’étage est actif.
    Valeurs valides :
    • true : l’étage est actif.
    • false : l’étage est inactif.

    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, par exemple 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.location.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
    result.reservation.location.reservable_module Détails sur le module réservable associé à la réservation.

    Type de données : objet

    
  "reservable_module": {
    "inline_title": "String",
    "name": "String",
    "sys_id": "String",
    "title": "String",
  },
    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
    résultat.réservation.emplacement.région Détails sur la région associée à l’emplacement.

    Type de données : objet

    "region": {
  "active": Boolean,
  "display_value": "String,"
  "sys_id": "String"
}
    result.reservation.location.region.active Marqueur indiquant si la région est active.
    Valeurs valides :
    • true : la région est active.
    • false : la région est inactive.

    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 l’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
    résultat.réservation.emplacement.réservation Détails sur la réservation associée à l’emplacement.

    Type de données : objet

    "reservation": {
  "active": Boolean,
  "number": "String",
  "number_of_attendees": Number,
  "requested_for": {Object},
  "state": {Object},
  "sys_id": "String"
}
    result.reservation.location.reservation.active Marqueur indiquant si la réservation est active.
    Valeurs valides :
    • true : la réservation est active.
    • false : la réservation est inactive.

    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

    "requested_for": {
  "name": "String",
  "sys_id": "String",
  "user_name": "String"
}
    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.nom_de_l’utilisateur 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.reservation.état Détails sur l’état de la réservation pour l’emplacement.

    Type de données : objet

    "state": {
  "display_value": "String,"
  "value": "String"
}
    result.reservation.location.reservation..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.réservation..état.valeur Valeur interne de l’état actuel de la réservation, par exemple 2.

    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

    "site": {
  "active": Boolean,
  "display_value": "String",
  "sys_id": "String",
}
    result.reservation.location.site.active Marqueur indiquant si le site est actif.
    Valeurs valides :
    • true : le site est actif.
    • false : le site est inactif.

    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
    result.reservation.location.standard_services
    résultat.réservation.location.état Détails sur l’état de la réservation pour l’emplacement.

    Type de données : objet

    "state": {
  "display_value": "String,"
  "value": "String"
}
    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.location.é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é de 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

    "notification_recipients":[
  {
    "name": "String",
    "sys_id": "String",
    "user_name": "String"
  }
]
    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
    résultat.réservation.number 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.number_of_attendees Nombre de participants dans cette réservation.

    Type de données : nombre
    result.reservation.opened_by Détails sur l’utilisateur qui a créé la réservation.

    Type de données : objet

    "opened_by": {
  "avatar": "String",
  "displayValue": "String",
  "display_value": "String",
  "email": "String",
  "initials": "String",
  "label": "String",
  "name": "String",
  "sys_id": "String",
  "table": "String",
  "user_name": "String",
  "value": "String"
}
    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 par.

    Type de données : chaîne
    result.reservation.opened_by.valeur_affichage Valeur d’affichage de l’utilisateur ouvert par.

    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.name Nom de l’utilisateur qui a ouvert la réservation.

    Type de données : chaîne
    result.reservation.opened_by.nom_de_l’utilisateur 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
    result.reservation.recording_details Détails sur les enregistrements associés à la réservation (réunion).

    Type de données : tableau

    "recording_details": [
  "recording_url": "String"
]
    result.reservation.recording_details.recording_url URL des enregistrements associés à la réservation.

    Type de données : chaîne
    result.reservation.recurring_pattern Détails sur le modèle récurrent de la réservation.

    Type de données : objet

    "recurring_pattern": {
  "amountOfDates": "String",
  "duration": Number,
  "label": "String",
  "options": {Object},
  "repeats": "String",
  "startDate":"String",
  "startDateGdt": Object,
}
    result.reservation.recurring_pattern.amountOfDates (en anglais seulement) Nombre de dates pour lesquelles les réservables sont réservés.

    Type de données : chaîne
    result.reservation.recurring_pattern.durée
    Durée de réservation de l’élément réservable.

    Type de données : nombre

    Unité : Secondes
    result.reservation.recurring_pattern.label Nom descriptif de la réservation récurrente.

    Type de données : chaîne
    result.reservation.recurring_pattern.options Détails sur les options associées à la réservation récurrente.

    Type de données : objet

    "options": {
  "count": Number,
  "daysOfWeek": "String",
  "every": Number,
  "endDate": "String"
  "endDateGdt": Object
}
    result.reservation.recurring_pattern.options.Compter

    Nombre de répétitions du modèle.

    Type de données : nombre
    result.reservation.recurring_pattern.options.daysOfWeek

    Jours de la semaine pendant lesquels l’élément réservable est nécessaire.

    Valeurs valides :
    • 1 = Lundi
    • 2 = Mardi
    • 3 = Mercredi
    • 4 = Jeudi
    • 5 = Vendredi
    • 6 = Samedi
    • 7 = Dimanche

    Par exemple, pour spécifier le mardi, le jeudi et le vendredi, transmettez 245 (aucun délimiteur). Si repeats est hebdomadaire, count est 5 et daysOfWeek est 245, alors dans les résultats de retour, le total est égal à count*daysOfWeek.length (5*3=15).

    Type de données : chaîne
    result.reservation.recurring_pattern.options.Chaque Intervalle de répétition du modèle. Par exemple, si cette valeur est égale à 2, répétez le modèle alternativement en fonction de la sélection dans le repeats paramètre, par exemple tous les deux jours ou toutes les deux semaines.

    Type de données : nombre
    result.reservation.recurring_pattern.options.endDate Date et heure de fin de la récurrence de la réunion, par exemple, « 2022-07-08T14 :00 :00Z ».

    Type de données : chaîne

    Format : UTC aaaa-mm-jj hh :mm :ss
    result.reservation.recurring_pattern.options.endDateGdt Date et heure de fin de la récurrence de la réunion, par exemple, « 2022-07-08T14 :00 :00Z ».

    Type de données : chaîne

    Format : UTC aaaa-mm-jj hh :mm :ss
    result.reservation.recurring_pattern.répétitions

    Modèle répétitif pour l’élément réservable.

    Valeurs valides : (sensible à la casse)
    • quotidien
    • mensuel
    • hebdomadaire
    • annuel

    Type de données : chaîne
    result.reservation.recurring_pattern.startDate
    Date et heure de début du modèle récurrent, par exemple « 2022-07-08T14 :00 :00Z ».

    Type de données : chaîne

    Format : UTC aaaa-mm-jj hh :mm :ss
    result.reservation.recurring_pattern.startDateGdt
    Date et heure de début du modèle récurrent, par exemple « 2022-07-08T14 :00 :00Z ».

    Type de données : chaîne

    Format : UTC aaaa-mm-jj hh :mm :ss
    result.reservation.requested_for Détails sur l’utilisateur au nom duquel la réservation a été effectuée.

    Type de données : objet

    "requested_for": {
  "avatar": "String",
  "displayValue": "String",
  "display_value": "String",
  "email": "String",
  "initials": "String",
  "label": "String",
  "name": "String",
  "sys_id": "String",
  "table": "String",
  "user_name": "String",
  "value": "String"
}
    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.valeur_affichage 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.initiales Initiales de l’utilisateur au nom duquel la réservation a été effectuée.

    Type de données : chaîne
    result.reservation.requested_for.label É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.nom_utilisateur 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.value 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

    {
  "reservable_module": {
    "allow_invitees": Boolean,
    "allow_whole_day": Boolean,
    "apply_to_shift": Boolean,
    "browse_by_area_enabled": Boolean,
    "browse_near_a_person_enabled": Boolean,
    "buildingSysIds": [Array],
    "checkin_before_minutes": Number,
    "display_number_of_attendees": Boolean,
    "display_on_behalf_of": Boolean,
    "display_sensitivity": Boolean,
    "display_value": "String",
    "enable_browse_by_area": Boolean,
    "enable_browse_near_a_person": Boolean,
    "enable_facet_filter": Boolean,
    "enable_group_reservations": Boolean,
    "enable_ical_generation": Boolean,
    "font_awesome_icon": "String",
    "inline_title": "String",      
    "layout_mapping": {JSON Object},
    "max_days_in_future": Number,
    "max_occurrences": Number,
    "name": "String",
    "override_approval_policy": "String",
    "require_cancel_notes": Boolean,
    "require_cc_dept_check": Boolean,
    "require_subject": Boolean,
    "reservable_columns": [Array],
    "reservable_container_field": "String",
    "reservable_filter": "String",
    "reservable_quantity_field": "String",
    "reservable_table": "String",
    "reservable_type": "String",
    "reservable_views": [Array],
    "reservation_paths": [Array],
    "search_limit": Number,
    "selection_type": "String",
    "short_description": "String",
    "show_map_view": Boolean,
    "sys_id": "String",
    "timeSlots": [Array],
    "title": "String",
    "virtual_meeting_provider": {Object}
  }
}
    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 :
    • true : autorisez les employés à ajouter des invités à la réservation.
    • false : n’autorisez pas les employés à ajouter des invités à la réservation.

    Type de données : booléennes
    result.reservation.reservable_module.allow_whole_day Marqueur indiquant si les utilisateurs peuvent réserver l’élément réservable pour la journée entière.
    Valeurs valides :
    • true : autorise les utilisateurs à réserver pour toute la journée.
    • false : n’autorisez pas les utilisateurs à réserver pour toute la journée.

    Type de données : booléennes
    result.reservation.reservable_module.apply_to_shift Marqueur indiquant si les réservations basées sur les équipes sont activées pour le module réservable.
    Valeurs valides :
    • true : autorise les réservations basées sur les équipes.
    • false : n’autorise pas les réservations basées sur les équipes.

    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 :
    • true : permet aux utilisateurs de parcourir les modules réservables par zone.
    • false : n’autorise pas les utilisateurs à parcourir les modules réservables par zone.

    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 localisés par une personne spécifiée.
    Valeurs valides :
    • true : permet aux utilisateurs de parcourir les modules réservables près d’une personne.
    • false : n’autorisez pas les utilisateurs à parcourir les modules réservables à proximité d’une personne.

    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 :
    • true : les utilisateurs peuvent spécifier le nombre de participants.
    • false : les utilisateurs ne peuvent pas spécifier le nombre de participants affichés.

    Type de données : booléennes
    result.reservation.reservable_module.display_on_behalf_of Marqueur indiquant si des réservations peuvent être effectuées au nom de quelqu’un d’autre.
    Valeurs valides :
    • true : au nom de pris en charge.
    • false : au nom de non pris en charge.

    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, par exemple normal ou privé.
    Valeurs valides :
    • true : peut définir la sensibilité.
    • false : impossible de définir la sensibilité. La valeur par défaut est Normal.

    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 :
    • true : permet aux utilisateurs de parcourir les modules réservables par zone.
    • false : n’autorise pas les utilisateurs à parcourir les modules réservables par zone.

    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 localisés par une personne spécifiée. Identique à browse_near_a_person_enabled.
    Valeurs valides :
    • true : permet aux utilisateurs de parcourir les modules réservables près d’une personne.
    • false : n’autorisez pas les utilisateurs à parcourir les modules réservables à proximité d’une personne.

    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 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 :
    • true : les filtres de facette sont activés.
    • false : les filtres de facette ne sont pas activés.

    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 :
    • true : possibilité d’effectuer des réservations de groupe.
    • false : impossible d’effectuer des réservations de groupe.

    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 :
    • true : génération iCalendar autorisée.
    • false : la génération iCalendar n’est pas autorisée.

    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

    "layout_mapping": {
  "body": [Array],
  "description": [Array],
  "image": "String",
  "subtitle": [Array],
  "subtitle_asc": [Array],
  "title": [Array]
}
    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

    "body": [
  {
    "field": "String",
    "field_to_display": "String",
    "icon": "String",
    "label": "String"
  }
]
    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.corps.champ_à_afficher 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 maximum 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 :
    • Aucun remplacement : la politique d’approbation est implémentée telle que définie dans le champ Exige l’approbation d’un espace ou d’une salle du lieu de travail.
    • Toujours exiger l’approbation : la politique d’approbation est requise, indépendamment de ce qui est défini dans le champ Exige l’approbation d’un espace ou d’une salle du lieu de travail.
    • Ne jamais exiger l’approbation : la politique d’approbation est supprimée, indépendamment de ce qui est défini dans le champ Exige l’approbationl d’un espace ou d’une salle du lieu de travail.

    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 :
    • true : note d’annulation requise.
    • false : note d’annulation non requise.

    Type de données : booléennes
    result.reservation.reservable_module.require_cc_dept_check Marqueur indiquant s’il faut vérifier s’il y a 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 :
    • true : vérifier s’il n’y a pas d’incohérence.
    • false : ne pas vérifier s’il y a une incohérence.

    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 :
    • true : objet requis.
    • false : l’objet n’est pas obligatoire.

    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, tel qu’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 voisins à une zone. Pour plus d’informations, voir Affecter des espaces voisins à 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 d’é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

    "reservable_views": {
  "iconClass": "String",
  "isDefault": Boolean,
  "label": "String",
  "order": Number,
  "type": "String"
}
    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 :
    • true : définir la valeur par défaut.
    • false : ne pas définir par défaut.

    Type de données : booléennes
    result.reservation.reservable_module.reservable_views.label 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 apparaît en premier dans l’interface utilisateur. Dans le cas d’un 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 du 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, Parcourir à proximité d’une personne.

    Type de données : tableau d’objets

    "reservation_paths": [
  {
    "displayValue": "String",
    "value": "String"
}
    result.reservation.reservable_module.reservation_paths.valeur_affichage Valeur d’affichage du chemin de réservation, telle que « Explorer à proximité d’une personne ».

    Type de données : chaîne
    result.reservation.reservable_module.reservation_paths.value 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 sur le 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 :
    • Unité spécifique : les résultats de la recherche affichent chaque élément du lieu de travail.
    • Conteneur : les résultats de la recherche affichent le parent ou le conteneur des éléments du lieu de travail.

    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 :
    • true : active la vue cartographique.
    • false : n’activez pas la vue cartographique.

    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.créneaux horaires Détails sur les créneaux horaires associés à un module réservable.

    Type de données : tableau d’objets

    [
  {
    "name": "String",
    "short_description": "String",
    "slot_end": "String",
    "slot_start": "String",
    "sys_id": "String"
  }
]
    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.title 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

    "virtual_meeting_provider": {
  "display_value": "String",
  "sys_id": "String"
}
    result.reservation.reservable_module.virtual_meeting_provider.valeur_affichage 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 utilisateur (ACL) définies sur la réservation associée.

    Type de données : objet

    "reservationAcl": {
  "read": Boolean,
  "write": {Object}
}
    result.reservation.reservationAcl.read Marqueur indiquant si l’utilisateur peut lire cette réservation.
    Valeurs valides :
    • true : vérifier si l’utilisateur peut lire la réservation.
    • false : ne pas vérifier si l’utilisateur peut lire la réservation.

    Type de données : booléennes
    résultat.réservation.reservationAcl.write Détails sur les options d’écriture de l’utilisateur pour la réservation associée.

    Type de données : objet

    "write": {
  "allFields": Boolean,
  "fields": {Object},
  "record": Boolean
}
    résultat.réservation.reservationAcl.write.allFields Marqueur indiquant si l’utilisateur peut écrire dans tous les champs spécifiés dans l’objet reservationACL.write.fields s’il faut vérifier s’il faut le vérifier. 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 :
    • true : vérifie si l’utilisateur peut écrire dans tous les champs spécifiés dans l’objet reservationACL.write.fields .
    • false : ne pas vérifier si l’utilisateur peut écrire dans tous les champs spécifiés dans l’objet reservationACL.write.fields

    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

    "fields": {
  "location": Boolean,
  "number_of_attendees": Boolean,
  "requested_for": Boolean,
  "sensitivity": Boolean,
  "subject": Boolean
}
    résultat.réservation.reservationAcl.write.champs.emplacement Marqueur indiquant si l’utilisateur peut écrire dans les champs d’emplacement de cette réservation.
    Valeurs valides :
    • true : vérifie si l’utilisateur peut écrire dans les champs d’emplacement.
    • false : ne pas vérifier si l’utilisateur peut écrire dans les champs d’emplacement.

    Type de données : booléennes
    result.reservation.reservationAcl.write.fields.number_of_attendees Marqueur indiquant si l’utilisateur peut écrire dans les champs Nombre de participants de cette réservation.
    Valeurs valides :
    • true : permet de vérifier si l’utilisateur peut écrire dans le champ Nombre de participants.
    • false : ne pas vérifier si l’utilisateur peut écrire dans le champ Nombre de participants.

    Type de données : booléennes
    result.reservation.reservationAcl.write.fields.requested_for Marqueur indiquant si l’utilisateur est en mesure d’écrire dans les champs demandés pour cette réservation.
    Valeurs valides :
    • true : cochez cette case si l’utilisateur peut écrire dans le champ demandé pour.
    • false : ne pas vérifier si l’utilisateur peut écrire dans le champ demandé pour.

    Type de données : booléennes
    résultat.reservation.reservationAcl.write.fields.sensitivity Marqueur indiquant si l’utilisateur peut écrire dans les champs de sensibilité de cette réservation.
    Valeurs valides :
    • true : vérifie si l’utilisateur peut écrire dans le champ de sensibilité.
    • false : ne pas vérifier si l’utilisateur peut écrire dans le champ de sensibilité.

    Type de données : booléennes
    résultat.reservation.reservationAcl.write.fields.subject Marqueur indiquant si l’utilisateur est en mesure d’écrire dans les champs d’objet de cette réservation.
    Valeurs valides :
    • true : vérifie si l’utilisateur peut écrire dans le champ d’objet.
    • false : ne pas vérifier si l’utilisateur peut écrire dans les champs d’objet.

    Type de données : booléennes
    résultat.reservation.reservationAcl.write.record Marqueur indiquant si l’utilisateur peut écrire à l’intégralité de l’enregistrement de réservation s’il faut le vérifier.
    Valeurs valides :
    • true : permet à l’utilisateur d’écrire dans l’enregistrement complet de la réservation.
    • false : ne pas vérifier si l’utilisateur peut écrire dans l’enregistrement complet de la réservation.

    Type de données : booléennes
    result.reservation.reservation_purpose Détails sur l’objet de la réservation.

    Type de données : objet

    "reservation_purpose": {
  "display_value": "String,"
  "value": "String"
}
    result.reservation.reservation_purpose.display_value Valeur d’affichage aux fins de la réservation, telle que Réunion de l’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

    "reservation_type": {
  "display_value": "String,"
  "value": "String"
}
    result.reservation.reservation_type.display_value Valeur d’affichage du type de réservation, par exemple Espace.

    Type de données : chaîne
    result.reservation.reservation_type.value Valeur interne du type de la réservation, par exemple 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, Multiparent, Multi-enfant, Parent récurrent ou occurrence.

    Type de données : objet

    "reservation_subtype": {
  "display_value": "String,"
  "value": "String"
}
    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.value 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 la sensibilité de la réservation.

    Type de données : objet

    "sensitivity": {
  "display_value": "String,"
  "value": "String"
}
    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

    "shift": {
  "display_value": "String",
  "name": "String",
  "shiftDetails": "String",
  "sys_id": "String"
}
    result.reservation.shift.display_value Affichez la valeur 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.shift.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

    "source": {
  "display_value": "String",
  "value": "String"
}
    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

    "source_icon": {
  "classNames": "String",
  "imgSrc": "String",
  "tooltip": "String"
}
    result.reservation.source_icon.Noms de classe 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, pour les réservations récurrentes, la réservation parente récurrente est la source de la série de réservations d’occurrence.

    Type de données : objet

    "source_reservation": {
  "display_value": "String",
  "name": "String",
  "sys_id": "String"
}
    result.reservation.source_reservation.display_value Affichez la valeur de la réservation source.

    Type de données : chaîne
    result.reservation.source_reservation.name Nom de la réservation source.

    Type de données : chaîne
    result.reservation.source_reservation.sys_id Sys_id de l’enregistrement de réservation source. Situé dans la table Réservation du lieu de travail [sn_wsd_rsv_reservation].

    Type de données : chaîne
    result.reservation.source_reservation_requester Utilisateur qui a demandé la réservation récurrente.

    Type de données : objet

    "source_reservation": {
  "name": "String",
  "sys_id": "String",
  "user_name": "String"
}
    result.reservation.source_reservation_​requester.name Nom du demandeur de réservation récurrente.

    Type de données : chaîne
    result.reservation.source_reservation_requester.sys_id Sys_id de l’utilisateur qui a demandé la réservation récurrente. Situé dans la table Utilisateur [sys_user].

    Type de données : chaîne
    result.reservation.source_reservation_requester.nom_de_l’utilisateur Nom d’utilisateur du demandeur de réservation récurrent.

    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
    état.réservation.résultat Détails sur l’état de la réservation.

    Type de données : objet

    "state": {
  "display_value": "String,"
  "value": "String"
}
    result.reservation.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.état.réservation Valeur interne de l’état actuel de la réservation, par exemple 2.

    Type de données : chaîne
    objet.réservation.résultat 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 l’origine de la réservation, comme Google Agenda ou Microsoft Exchange.

    Type de données : objet

    "sub_source": {
  "display_value": "String,"
  "value": "String"
}
    result.reservation.sub_source.valeur_affichage 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, tel que « sync_enqueued » ou « synchronisé ».

    Type de données : objet

    "sync_state": {
  "display_value": "String,"
  "value": "String"
}
    result.reservation.sync_state.valeur_affichage Affichez la valeur de l’état de synchronisation actuel de la réservation, tel que « synchronisé ».

    Type de données : chaîne
    result.reservation.sync_state.value Valeur interne de l’état de synchronisation actuel de la réservation, par exemple 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
    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

    Demande cURL

    L’exemple de code suivant montre comment récupérer une réservation récurrente spécifique.

    curl "https://instance.servicenow.com/api/sn_wsd_rsv/recurring_reservation/list/d98a381587b789506342b846dabb3563" \
--request GET \
--header "Accept:application/json" \
--user "username": "password"

    Résultats renvoyés :

    {
  "result": {
    "reservations": [
      {
        "sys_id": "198a381587b789506342b846dabb3565",
        "number": "WRES0001247",
        "location": {
          "sys_id": "fe1f744edb7650106c731dcd139619ca",
          "name": "Aspen",
          "description": "A room with large windows, dark leather seats and a large wooden table.",
          "display_value": "Aspen",
          "capacity": 16,
          "label_value": "Room name",
          "email": null,
          "reservable_module": {
            "sys_id": "c31241cedb7650106c731dcd13961917",
            "name": "Meeting rooms",
            "title": "Meeting rooms",
            "inline_title": "meeting room"
          },
          "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": "2f554296dbba10106c731dcd139619ed",
            "display_value": "Floor 2",
            "active": true
          },
          "area": {
            "sys_id": "",
            "display_value": "",
            "active": false
          },
          "reservation": {
            "sys_id": "198a381587b789506342b846dabb3565",
            "number_of_attendees": 1,
            "state": {
              "value": "confirmed",
              "display_value": "Confirmed"
            },
            "requested_for": {
              "sys_id": "2de07e1887cb89106342b846dabb35fe",
              "name": "Workplace User",
              "user_name": "workplace_user"
            },
            "number": "WRES0001247",
            "active": true
          },
          "number_of_attendees": 1,
          "state": {
            "value": "confirmed",
            "display_value": "Confirmed"
          },
          "number": "WRES0001247",
          "requested_for": {
            "sys_id": "2de07e1887cb89106342b846dabb35fe",
            "name": "Workplace User",
            "user_name": "workplace_user"
          }
        },
        "start": "2022-06-11T13:00:00Z",
        "end": "2022-06-11T14:00:00Z",
        "sys_created_on": "2022-05-30T07:06:37Z",
        "sys_updated_on": "2022-05-30T07:06:40Z",
        "source_reservation": {
          "sys_id": "d98a381587b789506342b846dabb3563",
          "display_value": "WRES0001246",
          "name": "WRES0001246"
        },
        "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": "occurrence",
          "display_value": "Occurrence"
        },
        "reservation_purpose": {
          "value": "meeting",
          "display_value": "Meeting"
        },
        "attendees": null,
        "number_of_attendees": 1,
        "is_parent": false,
        "subject": "Rec 1",
        "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": "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_recurring": "1",
          "allow_whole_day": "1",
          "require_whole_day": null,
          "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": "1",
          "enable_group_reservations": null,
          "enable_browse_near_a_person": "1",
          "enable_browse_by_area": "1",
          "enable_floor_search": "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": [],
          "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",
              "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": "2de07e1887cb89106342b846dabb35fe",
          "value": "2de07e1887cb89106342b846dabb35fe",
          "displayValue": "Workplace User",
          "display_value": "Workplace User",
          "name": "Workplace User",
          "user_name": "workplace_user",
          "table": "sys_user",
          "avatar": null,
          "initials": "WU",
          "email": "workplace_user@example.com",
          "label": ""
        },
        "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": null,
          "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_reservation_requester": {
          "sys_id": "2de07e1887cb89106342b846dabb35fe",
          "name": "Workplace User",
          "user_name": "workplace_user"
        },
        "source_icon": {
          "classNames": "fa fa-calendar-check-o",
          "tooltip": "Reservation is confirmed",
          "imgSrc": ""
        },
        "shift": null,
        "recurring_pattern": {
          "duration": "3600000",
          "repeats": "daily",
          "options": {
            "count": 3,
            "daysOfWeek": "",
            "every": 1,
            "endDate": "2022-06-13 14:00:00",
            "endDateGdt": {}
          },
          "label": "Repeats daily, 3 times",
          "startDate": "2022-06-11 13:00:00",
          "startDateGdt": "{}",
          "amountOfDates": "3"
        },
        "reservationAcl": {
          "write": {
            "record": true,
            "fields": {
              "subject": true,
              "sensitivity": true,
              "requested_for": true,
              "number_of_attendees": true,
              "location": true
            },
            "allFields": true
          },
          "read": true
        }
      }
    ],
    "occurencesTotalCount": "1"
  }
}

    Réservation récurrente WSD : PATCH /api/sn_wsd_rsv/recurring_reservation/cancel_series/{sys_id}

    Annule l’intégralité d’une réservation de série récurrente spécifiée ou d’une réunion spécifique au sein de la série.

    Remarque :
    Vous ne pouvez pas supprimer plusieurs occurrences de réunion en un seul appel.

    Format d'URL

    URL versionnée : /api/sn_wsd_rsv/{api_version}/recurring_reservation/cancel_series/{sys_id}

    URL par défaut : /api/sn_wsd_rsv/recurring_reservation/cancel_series/{sys_id}

    Paramètres de demande pris en charge

    Tableau 7. Paramètres de chemin d'accès
    Nom Description
    api_version Facultatif. Version du point de terminaison auquel accéder. 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 Pour annuler la série entière, transmettez le sys_id de l’enregistrement de réservation parent récurrent. Situé dans la table Réservation du lieu de travail [sn_wsd_rsv_reservation].

    Pour annuler une occurrence spécifique de la série, transmettez la sys_id de l’occurrence de la série.

    La colonne de l’enregistrement parent récurrent est reservation_subtype définie sur Parent récurrent. Le champ reservation_subtype des enregistrements d’occurrence individuels est défini sur Occurrence.

    Pour obtenir les détails de la réservation parente récurrente à partir de l’enregistrement d’événement, consultez le sys_id du champ source_reservation de l’enregistrement d’événement.

    Type de données : chaîne
    Tableau 8. Paramètres de requête
    Nom Description
    cancel_notes Motif de l’annulation de la réservation.

    Type de données : chaîne
    Tableau 9. Paramètres de corps de demande
    Nom Description
    Néant

    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 une liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

    Tableau 10. En-têtes de demandes
    En-tête Description
    Accepter Format de données du corps de la réponse. Types pris en charge : application/json ou application/xml.

    Valeur par défaut : application/json
    Content-Type Format de données du corps de la demande. Prend uniquement en charge application/json.
    Tableau 11. En-têtes de réponses
    En-tête Description
    Aucun

    Codes d'état

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

    Tableau 12. Codes d'état
    Code d'état Description
    200 Réussi. La demande a été correctement traitée.
    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 pour annuler une demande de réservation récurrente.

    Type de données : objet

    "result": {
  "failedToCancelOccurrenceReservations": [Array],
  "seriesId": "String",
  "success": Boolean,
  "successCanceledOccurrences": [Array],
  "user_msg": "String"
}
    result.failedToCancelOccurrenceReservations Liste des sys_ids d’enregistrements d’occurrences de réunion individuels qui n’ont pas pu être annulés.

    Type de données : tableau de chaînes
    result.seriesId Sys_id du parent récurrent lorsque toute la série est annulée ou la sys_id d’une occurrence spécifique si une seule occurrence est annulée.

    Type de données : chaîne
    résultat.succès Marqueur indiquant si la réservation a été annulée avec succès.
    Valeurs possibles :
    • true : annulé avec succès.
    • false : échec de l’opération.

    Type de données : booléennes
    result.failedToCancelOccurrenceReservations Liste des sys_ids des enregistrements d’occurrences de réunion individuels qui ont été annulés avec succès.

    Type de données : tableau de chaînes
    result.user_msg Message concernant la demande.

    Type de données : chaîne

    Demande cURL

    L’exemple de code suivant montre comment annuler l’intégralité d’une réservation récurrente.

    curl "https://instance.servicenow.com/api/sn_wsd_rsv/recurring_reservation/cancel_series/f64983a347274550003a4587746d43b8" \
--request PATCH \
--header "Accept:application/json" \ 
--header "Content-Type:application/json" \ 
--user "username":"password"

    Résultats renvoyés :

    {
  "result": {
    "failedToCancelOccurrenceReservations": [],
    "successCanceledOccurrences": [
      "cb4983a347274550003a4587746d43bd",
      "cf4983a347274550003a4587746d43ba"
    ],
    "user_msg": "Your Recurring reservation has been canceled successfully!",
    "seriesId": "f64983a347274550003a4587746d43b8",
    "success": true
  }
}

    Réservation récurrente WSD : POST/api/sn_wsd_rsv/recurring_reservation/create_series

    Crée des réservations de lieu de travail pour la même heure, mais à des dates différentes, par exemple hebdomadaire, mensuelle ou toutes les deux semaines.

    Format d'URL

    URL versionnée : /api/sn_wsd_rsv/{api_version}/recurring_reservation/create_series

    URL par défaut : /api/sn_wsd_rsv/recurring_reservation/create_series

    Paramètres de demande pris en charge

    Tableau 13. Paramètres de chemin d'accès
    Nom Description
    api_version Facultatif. Version du point de terminaison auquel accéder. Exemple : v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison différente de la dernière.

    Type de données : chaîne
    Tableau 14. Paramètres de requête
    Nom Description
    Néant
    Tableau 15. Paramètres de corps de demande
    Nom Description
    recurringPattern Détails sur le modèle récurrent de la réservation.

    Type de données : objet

    "recurringPattern": {
  "duration": Number,
  "label": "String",
  "options": {Object},
  "repeats": "String",
  "startDate": "String"
}
    recurringPattern.duration Obligatoire s’il ne s’agit pas d’une réservation basée sur une équipe.
    Durée de réservation de l’élément réservable.

    Type de données : nombre

    Unité : Secondes
    recurringPattern.label Nom descriptif de la réservation récurrente.

    Type de données : chaîne
    recurringPattern.options Requis.
    Détails sur les options définies pour le modèle récurrent.

    Type de données : objet

    
  "options": {
    "count": Number,
    "daysOfWeek": "String",
    "every": Number,
    "endDate": "String"
  }
    recurringPattern.options.count Obligatoire s’il ne s’agit pas d’une réservation basée sur l’équipe ; Ignoré pour les réservations basées sur les équipes.

    Nombre de répétitions du modèle.

    Type de données : nombre
    recurringPattern.options.daysOfWeek Requis si le repeats paramètre est défini sur Hebdomadaire.

    Jours de la semaine pendant lesquels l’élément réservable est nécessaire.

    Valeurs valides :
    • 1 = Lundi
    • 2 = Mardi
    • 3 = Mercredi
    • 4 = Jeudi
    • 5 = Vendredi
    • 6 = Samedi
    • 7 = Dimanche

    Par exemple, pour spécifier le mardi, le jeudi et le vendredi, transmettez 245 (aucun délimiteur). Si repeats est hebdomadaire, count est 5 et daysOfWeek est 245, alors dans les résultats de retour, le total est égal à count*daysOfWeek.length (5*3=15).

    Type de données : chaîne
    recurringPattern.options.every Intervalle de répétition du modèle. Par exemple, si cette valeur est égale à 2, répétez le modèle alternativement en fonction de la sélection dans le repeats paramètre, par exemple tous les deux jours ou toutes les deux semaines.

    Type de données : nombre
    recurringPattern.options.endDate Date et heure de fin de la récurrence de la réunion, par exemple, « 2022-07-08T14 :00 :00Z ».

    Type de données : chaîne

    Format : UTC aaaa-mm-jj hh :mm :ss
    recurringPattern.options.repeats Obligatoire s’il ne s’agit pas d’une réservation basée sur une équipe.

    Modèle répétitif pour l’élément réservable.

    Valeurs valides : (sensible à la casse)
    • quotidien
    • mensuel
    • hebdomadaire
    • annuel

    Type de données : chaîne
    recurringPattern.startDate Requis.
    Date et heure de début du modèle récurrent, par exemple « 2022-07-08T14 :00 :00Z ».

    Type de données : chaîne

    Format : UTC aaaa-mm-jj hh :mm :ss
    réservation Détails sur la réservation récurrente à créer.

    Type de données : objet

    "reservation": {
  "is_private": Boolean,
  "location": "String",
  "reservable_module": "String",
  "shift": "String",
  "subject": "String"
}
    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 Paramètres de confidentialité de la localisation et impact.

    Valeurs valides :
    • true : la réservation est privée.
    • false : la réservation n’est pas privée.

    Type de données : booléennes

    Par défaut : valeur définie pour la confidentialité dans les propriétés système.
    reservation.location 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
    reservation.reservable_module Requis. Sys_id du module réservable à associer à la réservation. Un module réservable définit les éléments du lieu 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
    reservation.shift
    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 requis.

    Pour plus d’informations sur la réservation basée sur les équipes, consultez Activer la réservation basée sur les équipes.

    Type de données : chaîne
    reservation.subject Requis.
    Objet de la réunion associé à 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 une liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

    Tableau 16. En-têtes de demandes
    En-tête Description
    Accepter Format de données du corps de la réponse. Types pris en charge : application/json ou application/xml.

    Valeur par défaut : application/json
    Content-Type Format de données du corps de la demande. Prend uniquement en charge application/json.
    Tableau 17. En-têtes de réponses
    En-tête Description
    Aucun

    Codes d'état

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

    Tableau 18. Codes d'état
    Code d'état Description
    200 Réussi. La demande a été correctement traitée.
    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 Renvoyer les résultats de la création ou de la mise à jour de plusieurs réservations.

    Type de données : objet

    "result": {
  "isValid": Boolean,
  "parent": "String",
  "successfulReservations": Array,
  "unSuccessfulReservations": Array
}
    result.isValid Marqueur qui indique si la réservation a été créée avec succès.
    Valeurs possibles :
    • true : créé avec succès.
    • false : échec de l’opération.

    Type de données : booléennes
    résultat.parent Sys_id de la réservation parente qui a été mise à jour.

    Type de données : chaîne
    résultat.successfulReservations Liste des réservations qui ont été mises à jour.

    Type de données : tableau d’objets

    "successfulReservations": [
  {
    "collision": Boolean,
    "end": "String",
    "error": "String",
    "inserted": Boolean,
    "start": "String"
    "sys_id": "String"
  }
]
    résultat.successfulReservations.collision Marqueur indiquant si une réservation existe déjà pour l’heure spécifiée et entre en conflit avec la réservation actuelle.
    Valeurs possibles :
    • true : collision.
    • false : aucune collision.

    Type de données : booléennes
    résultat.successfulReservations.end Date et heure de fin 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.successfulReservations.error Message d’erreur en cas de problème lors de la création de la réservation.

    Type de données : chaîne
    résultat.successfulReservations.inséré Marqueur qui indique si la réservation a bien été insérée. Par exemple, lorsqu’une réservation est ajoutée.
    Valeurs possibles :
    • true : insertion réussie.
    • false : échec de l’opération.

    Type de données : booléennes
    résultat.successfulReservations.start 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
    result.successfulReservations.sys_id Sys_id de la réservation qui a été créée. Situé dans la table Réservation du lieu de travail [sn_wsd_rsv_reservation].

    Type de données : chaîne
    result.unSuccessfulReservations Liste des réservations qui n’ont pas été mises à jour.

    Type de données : tableau d’objets

    "unSuccessfulReservations": [
  {
    "collision": Boolean,
    "end": "String",
    "error": "String",
    "inserted": Boolean,
    "start": "String"
    "sys_id": "String"
  }
]
    résultat.unSuccessfulReservations.collision Marqueur indiquant si une réservation existe déjà pour l’heure spécifiée et entre en conflit avec la réservation actuelle.
    Valeurs possibles :
    • true : collision.
    • false : aucune collision.

    Type de données : booléennes
    résultat.unSuccessfulReservations.end Date et heure de fin 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.unSuccessfulReservations.error Message d’erreur en cas de problème lors de la création de la réservation.

    Type de données : chaîne
    résultat.unSuccessfulReservations.inséré Marqueur qui indique si la réservation a bien été insérée. Par exemple, lorsqu’une réservation est ajoutée.
    Valeurs possibles :
    • true : insertion réussie.
    • false : échec de l’opération.

    Type de données : booléennes
    result.unSuccessfulReservations.start 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
    result.unSuccessfulReservations.sys_id
    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

    Demande cURL

    L’exemple de code suivant montre comment créer une réservation récurrente quotidienne pendant deux jours consécutifs.

    curl "https://instance.servicenow.com/api/sn_wsd_rsv/recurring_reservation/create_series" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
    \"reservation\": {
        \"reservable_module\": \"5db44502dbb650106c731dcd13961937\",
        \"subject\": \"Test-123\",
        \"reservation_purpose\": \"meeting\",
        \"timezone\": \"US/Pacific\",
        \"requested_for\": \"6816f79cc0a8016401c5a33be04be441\",
        \"location\": \"6a11a94adb7210106c731dcd1396194e\",
        \"attendees\": \"6816f79cc0a8016401c5a33be04be441\",
        \"is_private\": false
    },
    \"recurringPattern\": {
        \"duration\": 3600000,
        \"repeats\": \"daily\",
        \"options\": {
            \"count\": 2,
            \"daysOfWeek\": \"\",
            \"every\": 1
        },
        \"label\": \"Repeats daily, 2 times\",
        \"startDate\": \"2023-01-12T12:00:00Z\"
    }
}" \

    Résultats renvoyés :

    {
  "result": {
    "isValid": true,
    "parent": "1e5f65ca87586550cfaa99b73cbb3513",
    "successfulReservations": [
      {
        "inserted": true,
        "collision": false,
        "sys_id": "9e5f65ca87586550cfaa99b73cbb3517",
        "error": null,
        "start": "2023-01-13T12:00:00Z",
        "end": "2023-01-13T13:00:00Z"
      }
    ],
    "unSuccessfulReservations": [
      {
        "inserted": true,
        "collision": true,
        "sys_id": "5e5f65ca87586550cfaa99b73cbb3515",
        "error": null,
        "start": "2023-01-12T12:00:00Z",
        "end": "2023-01-12T13:00:00Z"
      }
    ]
  }
}