API réservable WSD
L’API Prestation de services sur le lieu de travailRÉSERVABLE (WSD) fournit des points de terminaison pour récupérer les détails d’un réservable, une entité qui peut être réservée, telle qu’un emplacement de lieu de travail, à partir d’une ServiceNow instance.
Pour accéder à cette API, l’appelant doit disposer du rôle sn_wsd_core.workplace_user.
Cette API s’exécute dans l’espace de noms sn_wsd_rsv . Pour accéder à cette API, le module d’extension Workplace Reservation Management (sn_wsd_rsv) doit être activé.
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éservable WSD : GET /sn_wsd_rsv/reservable/list_reservables/{sys_ids}
Renvoie les détails d’un ou de plusieurs réservables spécifiés.
Format d'URL
URL versionnée : /api/sn_wsd_rsv/{api_version}/reservable/list_reservables/{sys_ids}
URL par défaut : /api/sn_wsd_rsv/reservable/list_reservables/{sys_ids}
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_ids | Sys_ids des réservables dont les détails doivent être renvoyés. Si vous spécifiez plusieurs réservables, séparez les sys_ids par une virgule. Ces sys_ids se trouvent dans la table Emplacement du lieu de travail [sn_wsd_core_workplace_location]. Type de données : chaîne |
| Nom | Description |
|---|---|
| include_flexible_services | Marqueur indiquant s’il faut renvoyer les services flexibles associés au réservable dans la réponse. Un service flexible est une prestation supplémentaire disponible avec un élément d’espace de travail réservable lorsqu’une réservation est effectuée. Par exemple, Style salle de classe - Rangées de tables disposées avec tous les participants orientés vers l’avant de la salle. Pour plus d’informations sur les services flexibles, consultez Créer un service flexible. Valeurs valides :
Type de données : booléennes Valeur par défaut : false |
| include_layouts | Marqueur indiquant s’il faut renvoyer les informations de disposition de l’emplacement dans la réponse. Les informations d’aménagement de l’emplacement comprennent des éléments tels que la capacité, la capacité maximale, la préparation et la durée de nettoyage. Ces informations figurent dans la table Disposition de l’emplacement [sn_wsd_rsv_m2m_location_layout]. Valeurs valides :
Type de données : booléennes Valeur par défaut : false |
| 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 |
| reservable_module_sys_id | Requis. Sys_id du module réservable. Un module réservable regroupe des types similaires d’éléments du lieu de travail. Cette sys_id figure dans la table Module réservable [sn_wsd_rsv_reservable_module]. Pour plus d’informations sur les modules réservables, consultez Configurer un module réservable. Type de données : chaîne |
| reservation_start_time | Heure de début de la réservation pour valider le délai des services supplémentaires. Format : format UTC, aaaa-MM-jj HH :mm :ss 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 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. |
| 400 | Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté. |
| 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 | Détails sur chaque réservable correspondant. Type de données : tableau d’objets |
| result.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 |
| zone.résultat | Zone où se trouve le réservable. Ces informations se trouvent dans la table Aire [sn_wsd_core_area]. |
| result.area.display_value | Valeur d’affichage de la zone. Type de données : chaîne |
| result.area.sys_id | Sys_id de l’enregistrement de zone associé. Type de données : chaîne |
| résultat.bâtiment | Bâtiment où se trouve le réservable. Ces informations se trouvent dans la table Bâtiment [sn_wsd_core_building]. |
| result.building.display_value | Valeur d’affichage pour le bâtiment. Type de données : chaîne |
| result.building.sys_id | Sys_id de l’enregistrement de bâtiment associé. Type de données : chaîne |
| résultat.bâtiment.fuseau horaire | Détails du fuseau horaire du bâtiment. |
| result.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.bâtiment.fusehoraire.valeur | Valeur interne du fuseau horaire dans lequel se trouve le bâtiment associé. Type de données : chaîne |
| résultat.campus | Campus où se trouve le réservable. Ces informations sont disponibles dans la table Campus [sn_wsd_core_campus]. |
| result.campus.display_value | Valeur d’affichage pour le campus. Type de données : chaîne |
| result.campus.sys_id | Sys_id de l’enregistrement de campus associé. Type de données : chaîne |
| résultat.capacité | Nombre de personnes que le réservable peut accueillir. Type de données : nombre |
| description résultat. | Description du réservable. Type de données : chaîne |
| result.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.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.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.email | Adresse e-mail associée au réservable. Type de données : chaîne |
| result.employee_override_privacy | Marqueur indiquant si les utilisateurs peuvent remplacer le paramètre de confidentialité pour le réservable associé. Pour plus d’informations sur ces paramètres de confidentialité, consultez la section Paramètres de confidentialité de la localisation et impact. Valeurs valides :
|
| result.enable_group_reservations | Marqueur indiquant si les utilisateurs peuvent effectuer une réservation de groupe. Valeurs valides :
Type de données : booléennes |
| result.enable_reservation_privacy | Marqueur qui indique le paramètre par défaut pour la confidentialité des réservations. Pour en savoir plus sur ces paramètres de confidentialité, reportez-vous à la section Location privacy settings and impact. Valeurs possibles :
Type de données : booléennes |
| result.external_id | ID externe du réservable. Type de données : chaîne |
| result.flexible_services | Renseigné uniquement si le include_flexible_services paramètre est défini sur vrai et que le module d’extension Workplace Case Management est installé. Description des services flexibles associés aux réservables. Il peut y avoir un service flexible parent et plusieurs services flexibles enfants. Ces informations figurent dans la table [sn_wsd_case_workplace_service_item]. |
| result.flexible_services.texte_additionnel | Texte pour inviter l’utilisateur à sélectionner des services flexibles supplémentaires. Type de données : chaîne |
| result.flexible_services.allow_only_single_service_item_selection | Marqueur indiquant si les utilisateurs peuvent sélectionner un seul élément de service parmi le groupe de services flexibles au sein d’une réservation. Valeurs valides :
Type de données : booléennes |
| result.flexible_services.catégorie | Catégorie des services flexibles. Type de données : chaîne |
| result.flexible_services.currency_code | Code de devise utilisé pour calculer le montant de devise lors de la commande de services flexibles. Type de données : chaîne |
| result.flexible_services.flexible_service | Services flexibles correspondant à un service flexible parent. Ces informations figurent dans la table [sn_wsd_case_workplace_service_item]. Type de données : tableau d’objets |
| result.flexible_services.flexible_service.flexible_service | Les détails de chaque service flexible correspondant à un service flexible parent. Type de données : tableau d’objets |
| result.flexible_services.flexible_service.flexible_service.texte_additionnel | Texte utilisé pour inviter un utilisateur à sélectionner des services flexibles supplémentaires. Type de données : chaîne |
| result.flexible_services.flexible_service.flexible_service.capacity_enabled | Marqueur indiquant si la capacité de la salle doit apparaître dans la réservation. Si cette valeur est définie sur true, quantity_enabled elle sera toujours false. Valeurs valides :
Type de données : booléennes |
| result.flexible_services.flexible_service.flexible_service.catégorie | Catégorie du service flexible. Type de données : chaîne |
| result.flexible_services.flexible_service.flexible_service.catégorie_étiquette | Étiquette de catégorie de service flexible. Type de données : chaîne |
| result.flexible_services.flexible_service.flexible_service.cleanup_duration | Temps nécessaire pour nettoyer ou supprimer le service ajouté au réservable. Type de données : nombre Unité : Millisecondes |
| result.flexible_services.flexible_service.flexible_service.image | Lien vers l’image du service flexible. Type de données : chaîne |
| result.flexible_services.flexible_service.flexible_service.max_capacité | Nombre maximum d’occupants que le réservable peut accueillir. Type de données : nombre |
| result.flexible_services.flexible_service.flexible_service.name | Nom du service flexible. Type de données : chaîne |
| result.flexible_services.flexible_service.flexible_service.préparation_durée | Durée nécessaire pour ajouter le service au réservable. Type de données : chaîne Unité : Millisecondes |
| result.flexible_services.flexible_service.flexible_service.prix_par_unité | Détails du coût d’ajout du service flexible au réservable. Type de données : objet |
| result.flexible_services.flexible_service.flexible_service.prix_par_unité.code | Code de devise à utiliser pour calculer le coût, par exemple GBP ou USD. Type de données : chaîne |
| result.flexible_services.flexible_service.flexible_service.prix_par_unité.valeur | Coût pour chaque unité du service flexible dans la devise définie dans le paramètre de code. Type de données : chaîne |
| result.flexible_services.flexible_service.flexible_service.quantity_enabled | Marqueur indiquant si le champ de quantité doit apparaître dans la réservation. Si cette valeur est définie sur true, capacity_enabled elle sera toujours false. Valeurs valides :
Type de données : booléennes |
| result.flexible_services.flexible_service.flexible_service.quantity_required | Marqueur indiquant si la quantité est requise. Valeurs valides :
Type de données : booléennes |
result.flexible_services.flexible_service.flexible_service.short_description |
Brève description du service flexible. Type de données : chaîne |
| result.flexible_services.flexible_service.flexible_service.sous_catégorie | Nom de la sous-catégorie du service flexible, telle que chair_layout. Type de données : chaîne |
| result.flexible_services.flexible_service.flexible_service.sub_category_label | Étiquette de sous-catégorie du service flexible, telle que Disposition de la chaise. Type de données : chaîne |
| result.flexible_services.flexible_service.flexible_service.sous_titre | Nom de sous-titre du service flexible enfant. Type de données : chaîne |
| result.flexible_services.flexible_service.flexible_service.sys_id | Sys_id d’un service flexible. Type de données : chaîne |
| result.flexible_services.flexible_service.flexible_service.texte | Texte utilisé pour inviter un utilisateur à sélectionner des services flexibles. Type de données : chaîne |
| result.flexible_services.flexible_service.flexible_service.titre | Détails des titres à utiliser lors de l’ajout et de la modification du service flexible enfant dans l’interface utilisateur. Type de données : objet |
| result.flexible_services.flexible_service.flexible_service.titre.ajouter | Titre utilisé lors de l’ajout d’un service flexible enfant dans l’interface utilisateur. Type de données : chaîne |
| result.flexible_services.flexible_service.flexible_service.title.modifier | Titre utilisé lors de la modification d’un service flexible enfant dans l’interface utilisateur. Type de données : chaîne |
| result.flexible_services.flexible_service.label | Étiquette de service flexible. Type de données : chaîne |
| result.flexible_services.flexible_service.sub_category | Sous-catégorie des services flexibles parentaux, telle que chaise supplémentaire. Type de données : chaîne |
| result.flexible_services.flexible_service.sub_title | Nom du sous-titre du service flexible parent. Type de données : chaîne |
| result.flexible_services.soup_service.text | Texte utilisé pour inviter un utilisateur à sélectionner un service flexible parent. Type de données : chaîne |
| result.flexible_services.flexible_service.title | Détails des titres à utiliser lors de l’ajout et de la modification du service flexible parent dans l’interface utilisateur. Type de données : objet |
| result.flexible_services.flexible_service.title.ajouter | Titre utilisé lors de l’ajout d’un service flexible parent dans l’interface utilisateur. Type de données : chaîne |
| result.flexible_services.flexible_service.title.éditer | Titre utilisé lors de la modification d’un service flexible parent dans l’interface utilisateur. Type de données : chaîne |
| résultat.étage | Détails sur l’étage où se trouve le réservable. Situé dans la table Étage [sn_wsd_core_floor]. |
| result.floor.display_value | Numéro d’affichage de l’étage où réside le réservable, par exemple 12. Type de données : chaîne |
| result.floor.sys_id | Sys_id de l’enregistrement associé dans la table Étage. Type de données : chaîne |
| résultat.image | Détails sur une image qui représente le réservable associé. Situé dans la table Images [db_image]. |
| result.image.link | Lien vers une image qui représente le réservable. Type de données : chaîne |
| result.image.sys_id | Sys_id de l’enregistrement d’image associé. Type de données : chaîne |
| result.is_reservable | Marqueur indiquant si le service flexible peut être réservé. Valeurs valides :
Type de données : booléennes |
| résultats.mises en page | Renseigné uniquement si le include_layouts paramètre est défini sur vrai. Liste des mises en page associées au réservable. Type de données : tableau d’objets
|
| résultat.dispositions.capacité | Nombre de personnes qui participeront à la réunion. Type de données : nombre |
| result.layouts.cleanup_duration | Durée nécessaire pour nettoyer le réservable pour cette mise en page. Type de données : nombre Unité : Millisecondes |
| résultat.dispositions.image | Détails sur une image qui représente la mise en page du réservable associé. Situé dans la table Images [db_image]. |
| result.layouts.image.link | Lien vers une image qui représente la mise en page de cet élément réservable. Situé dans la table Images [db_image]. Type de données : chaîne |
| result.layouts.image.sys_id | Sys_id de l’enregistrement d’image associé. Type de données : chaîne |
| result.layouts.is_default | Marqueur indiquant si la mise en page associée est celle par défaut pour le réservable. Valeurs valides :
Type de données : booléennes |
| result.layouts.max_capacité | Nombre maximum de personnes que la mise en page associée au réservable peut accueillir. Type de données : nombre |
| result.layouts.name | Nom de l’aménagement de l’emplacement. Type de données : chaîne |
| result.layouts.preparation_duration | Durée nécessaire à la préparation de la disposition de l’emplacement associée. Type de données : nombre Unité : Millisecondes |
| result.layouts.short_description | Brève description de la disposition de l’emplacement. Type de données : chaîne |
| result.layouts.sys_id | Sys_id de la disposition de l’emplacement. Situé dans la table Mise en page [sn_wsd_rsv_layout]. Type de données : chaîne |
| result.location_type | Détails sur le type d’emplacement du réservable, tel que le lieu de travail/bureau, le café ou la salle de sport. Situé dans la table Type d’espace [sn_wsd_core_space_type]. |
| result.location_type.display_value | Valeur d’affichage du type d’emplacement. Type de données : chaîne |
| result.location_type.sys_id | Sys_id de l’enregistrement associé dans la table Type d’espace [sn_wsd_core_space_type]. Type de données : chaîne |
| result.meetingProviders | Détails sur les fournisseurs de réunion virtuelle associés au réservable. Ces informations se trouvent dans la table Fournisseur de réunion virtuelle [sn_wsd_rsv_virtual_meeting_provider]. |
| result.meetingProviders.display_value | Valeur d’affichage du nom du fournisseur virtuel. Type de données : chaîne |
| résultat.fournisseursderendez-vous.valeur | Valeur réelle du nom du fournisseur virtuel dans l’enregistrement. Type de données : chaîne |
| result.moduleType | Module réservable associé au réservable, tel que bureaux ou salle de réunion. Type de données : chaîne |
| result.name | Nom du réservable. Type de données : chaîne |
| numéro.résultat | Identificateur unique du réservable. Cette valeur est plus lisible par l’homme que le sys_id. Type de données : chaîne |
| résultat.ordre | Numéro de commande du réservable. Type de données : nombre |
| result.require_approval | Marqueur indiquant si la réservation du réservable nécessite une approbation. Valeurs possibles :
Type de données : booléennes |
| result.requires_check_in | Marqueur indiquant si l’application réservable nécessite que l’utilisateur s’enregistre. Valeurs valides :
Type de données : booléennes |
| result.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.reservable_quantity | Nombre maximal de fois que le réservable associé peut être réservé pour la même période. Cette valeur est utilisée lors de l’affectation d’espaces de quartier à une zone. Type de données : entier |
| result.site | Détails sur le site où réside le réservable. Situé dans la table Site [sn_wsd_core_site]. |
| result.site.display_value | Valeur d’affichage du site. Type de données : chaîne |
| 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 |
| result.site.sys_id | Sys_id de l’enregistrement du site associé dans la table Site [sn_wsd_core_site]. Type de données : chaîne |
| result.tableName | Nom de la table dans laquelle réside l’enregistrement réservable. Type de données : chaîne |
| résultat.titre | Titre du réservable. Type de données : chaîne |
| type.résultat | Type d’un réservable, tel que l’emplacement. Type de données : chaîne |
Demande cURL
L’exemple de code suivant montre comment appeler ce point de terminaison.
curl "http://instance.servicenow.com/api/sn_wsd_rsv/reservable/list_reservables/dad3df5977220110b3d7be377b5a99ce,3ed3139977220110b3d7be377b5a99d1?include_flexible_services=true&include_layouts=false&include_reservable_purposes=true&include_standard_services=true&reservable_module_sys_id=c31241cedb7650106c731dcd13961917" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"
Résultats renvoyés :
{
"result": [
{
"sys_id": "3e41e94adb7210106c731dcd1396198c",
"external_id": null,
"wsd_email": null,
"name": "A1-02-04",
"title": "A1-02-04",
"description": "General desk available for reservation.",
"image": null,
"number": "SPCE0009004",
"site": {
"sys_id": "628eec06db7650106c731dcd139619dd",
"display_value": "North America"
},
"campus": {
"sys_id": "82b2a0cedb3650106c731dcd139619e9",
"display_value": "California Campus"
},
"building": {
"sys_id": "94e264cedb3650106c731dcd13961919",
"display_value": "CAL-B1",
"timezone": {
"value": "US/Pacific",
"displayValue": "US/Pacific"
}
},
"floor": {
"sys_id": "fc7368cedb3650106c731dcd13961902",
"display_value": "Floor 1"
},
"area": null,
"capacity": "1",
"reservable_quantity": null,
"location_type": {
"sys_id": "5f017383eb512010b89bfdfc9c5228c8",
"display_value": "Workspace/Desk"
},
"order": null,
"requires_check_in": null,
"is_reservable": "1",
"type": "location",
"moduleType": "Desks",
"meetingProviders": [],
"require_subject": false,
"allow_invitees": true,
"display_number_of_attendees": false,
"display_on_behalf_of": true,
"display_sensitivity": false,
"enable_group_reservations": false,
"enable_reservation_privacy": true,
"employee_override_privacy": true,
"tableName": "sn_wsd_core_space",
"require_approval": false
},
{
"sys_id": "fd41a94adb7210106c731dcd1396195a",
"external_id": null,
"wsd_email": null,
"name": "A1-02-03",
"title": "A1-02-03",
"description": "General desk available for reservation.",
"image": null,
"number": "SPCE0009003",
"site": {
"sys_id": "628eec06db7650106c731dcd139619dd",
"display_value": "North America"
},
"campus": {
"sys_id": "82b2a0cedb3650106c731dcd139619e9",
"display_value": "California Campus"
},
"building": {
"sys_id": "94e264cedb3650106c731dcd13961919",
"display_value": "CAL-B1",
"timezone": {
"value": "US/Pacific",
"displayValue": "US/Pacific"
}
},
"floor": {
"sys_id": "fc7368cedb3650106c731dcd13961902",
"display_value": "Floor 1"
},
"area": null,
"capacity": "1",
"reservable_quantity": null,
"location_type": {
"sys_id": "5f017383eb512010b89bfdfc9c5228c8",
"display_value": "Workspace/Desk"
},
"order": null,
"requires_check_in": null,
"is_reservable": "1",
"type": "location",
"moduleType": "Desks",
"meetingProviders": [],
"require_subject": false,
"allow_invitees": true,
"display_number_of_attendees": false,
"display_on_behalf_of": true,
"display_sensitivity": false,
"enable_group_reservations": false,
"enable_reservation_privacy": true,
"employee_override_privacy": true,
"tableName": "sn_wsd_core_space",
"require_approval": false
}
]
}