API réservable WSD
L’API Workplace Service Deliveryréservable (WSD) récupère les détails d’un réservable, une entité qui peut être réservée, telle qu’un emplacement du 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 Workplace Reservation Management, consultez Workplace Reservation Management.
WSD réservable - 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 des virgules. Ces sys_ids sont situés 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 si les services flexibles associés au réservable doivent être renvoyés dans la réponse. Un service flexible est une provision supplémentaire disponible avec un élément du lieu de travail réservable lorsqu’une réservation est faite. 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 si les informations de mise en page de l’emplacement doivent être renvoyées dans la réponse. Les informations relatives à la disposition de l’emplacement comprennent notamment la capacité, la capacité maximale, la préparation et la durée de nettoyage. Ces informations se trouvent dans la table Mise en page 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 si les informations sur les services standard doivent être renvoyées dans la réponse. Un service standard décrit les dispositions de base disponibles pour un élément du lieu de travail réservable lorsque la réservation est faite, telles que des tableaux blancs, des moniteurs supplémentaires et des services similaires. Pour plus d’informations sur les services standards, reportez-vous à la rubrique Services standards. Ces informations se trouvent 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 les 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 |
| 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.
| 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 une 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 dans laquelle se trouve le réservable. Ces informations se trouvent dans la table Aire [sn_wsd_core_area]. |
| result.area.display_value | Affiche la valeur 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 du 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.fuseau.horaire.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 l’élément réservable. Ces informations se trouvent 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 |
| capacité.résultat | Nombre de personnes que le réservable peut accueillir. Type de données : nombre |
| description.résultat | Description de l’élément 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 des 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, par exemple normal ou privé. Valeurs valides :
Type de données : booléennes |
| result.email | Adresse e-mail associée à l’élément 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 l’élément réservable associé. Pour plus d’informations sur ces paramètres de confidentialité, consultez 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 plus d’informations sur ces paramètres de confidentialité, reportez-vous à Location privacy settings and impact. Valeurs possibles :
Type de données : booléennes |
| result.external_id | ID externe de l’élément réservable. Type de données : chaîne |
| result.flexible_services | Rempli 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 se trouvent dans la table [sn_wsd_case_workplace_service_item]. |
| result.flexible_services.texte_additionnel | Texte invitant 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 ne peuvent sélectionner qu’un seul élément de service parmi le groupe de services flexibles 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 la 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 se trouvent dans la table [sn_wsd_case_workplace_service_item]. Type de données : tableau d’objets |
| result.flexible_services.flexible_service.flexible_service | 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 la valeur 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.étiquette_catégorie | É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 au nettoyage ou à la suppression du service ajouté à l’élément 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 maximal 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 à l’élément réservable. Type de données : chaîne Unité : millisecondes |
| result.flexible_services.flexible_service.flexible_service.prix_unitaire | 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, tel que 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 la valeur 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.sous_catégorie_étiquette | Étiquette de sous-catégorie du service flexible, telle que Mise en page de la chaise. Type de données : chaîne |
| result.flexible_services.flexible_service.flexible_service.sous_titre | Nom du 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.title | 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.title.add | 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.edit | 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 parent, comme chaise supplémentaire. Type de données : chaîne |
| result.flexible_services.flexible_service.sub_title | Nom de 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.Modifier | 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 l’élément réservable. Situé dans la table Étage [sn_wsd_core_floor]. |
| result.floor.display_value | Numéro d’affichage de l’étage où se trouve l’élément 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 d’une image qui représente l’élément réservable associé. Situé dans la table Images [db_image]. |
| result.image.link | Lien vers une image qui représente l’élément 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 à l’élément réservable. Type de données : tableau d’objets
|
| résultat.mises en page.capacité | Nombre de personnes qui participeront à la réunion. Type de données : nombre |
| result.layouts.cleanup_duration | Temps nécessaire au nettoyage de l’élément réservable pour cette mise en page. Type de données : nombre Unité : millisecondes |
| résultat.mises en page.image | Détails d’une image qui représente la mise en page de l’élément 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 l’élément 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 à l’élément réservable peut prendre en charge. Type de données : nombre |
| result.layouts.name | Nom de la disposition de l’emplacement. Type de données : chaîne |
| result.layouts.preparation_duration | Temps nécessaire à la préparation de la mise en page 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 de l’élément 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.valeur_affichage | 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 à l’élément 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.fournisseursde réunion.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 les bureaux ou la salle de réunion. Type de données : chaîne |
| result.name | Nom de l’élément réservable. Type de données : chaîne |
| nombre.résultat | Identificateur unique de l’élément réservable. Cette valeur est plus lisible par l’homme que la sys_id. Type de données : chaîne |
| résultat.ordre | Numéro de commande de l’élément réservable. Type de données : nombre |
| result.require_approval | Marqueur indiquant si la réservation de l’élément réservable nécessite une approbation. Valeurs possibles :
Type de données : booléennes |
| result.requires_check_in | Marqueur indiquant si l’élément 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 maximum de fois où l’élément réservable associé peut être réservé pour la même période. Cette valeur est utilisée lors de l’affectation d’espaces voisins à une zone. Type de données : nombre entier |
| result.site | Détails sur le site où se trouve l’élément 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 standards associés, tels qu’un tableau de conférence, un écran de projection, un tableau blanc et des 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 de l’enregistrement 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 se trouve l’enregistrement réservable. Type de données : chaîne |
| résultat.titre | Titre de l’élément réservable. Type de données : chaîne |
| type.résultat | Type d’élément 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
}
]
}