API de recherche WSD

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

    • L’API Workplace Service Deliveryde recherche (WSD) fournit des points de terminaison pour la recherche d’emplacements et d’éléments du lieu de travail disponibles tels que des éléments réservables, des modules réservables et des équipes disponibles.

    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.

    Recherche WSD : GET /api/sn_wsd_rsv/search/availability

    Vérifie si les réservables spécifiés sont disponibles pour les heures spécifiées.

    Format d'URL

    URL versionnée : /api/sn_wsd_rsv/{api_version}/search/availability

    URL par défaut : /api/sn_wsd_rsv/search/availability

    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
    Tableau 2. Paramètres de requête
    Nom Description
    fin Requis. Heure de fin à utiliser pour rechercher des modules réservables disponibles. Cette valeur doit être ultérieure à la valeur spécifiée dans le start paramètre.

    Type de données : chaîne

    Format : UTC ou heure locale (aaaa-mm-jj hh :mm :ss)
    include_reservations_within_days Marqueur indiquant s’il faut renvoyer tous les créneaux libres des heures disponibles dans la réponse pour chaque réservable pour toute la journée.
    Valeurs valides :
    • true : Renvoie tous les emplacements libres.
    • false : Ne renvoie pas tous les emplacements libres.

    Type de données : booléennes

    Valeur par défaut : false
    reservable_ids Requis. Liste séparée par des virgules des sys_ids réservables pour évaluer la disponibilité. Situé dans la table Emplacement du lieu de travail [sn_wsd_core_workplace_location].

    Type de données : chaîne
    reservation_ids Liste séparée par des virgules des sys_ids de réservation existants. Transmettez ce paramètre si vous souhaitez modifier les réservations associées. Situé dans la table Réservation du lieu de travail [sn_wsd_rsv_reservation].

    Le temps bloqué pour ces sys_ids pour les réservables correspondants est traité comme disponible.

    Type de données : chaîne

    Par défaut : Aucun
    reservable_module Requis. Sys_id du module réservable à inclure dans la recherche. Un module réservable regroupe les types similaires d’éléments du lieu de travail. Situé dans la table Module réservable [sn_wsd_rsv_reservable_module].

    Type de données : chaîne
    schedule_view_obj Détails sur la vue de calendrier à renvoyer. Transmettez cet objet si vous avez besoin de données de disponibilité 24 heures sur 24 pour les réservations qui couvrent plus d’une journée. Les résultats de retour ne contiendront que les heures disponibles et les réservations pour la date spécifiée.

    Pour que cette fonctionnalité fonctionne correctement, les paramètres ignore_same_day_validation et include_reservations_within_days doivent être définis sur vrai.

    Type de données : objet

    "schedule_view_obj": {
  "schedule_view_date": "String",
  "timezone": "String"
}
    schedule_view_obj.date_vue_calendrier Date à partir de laquelle commencer à renvoyer la disponibilité de la réservation. Cette date doit être comprise dans le fuseau horaire spécifié dans le schedule_view_obj.timezone paramètre.

    Type de données : chaîne

    Format : AAAA-MM-JJ
    schedule_view_obj.fuseau horaire Fuseau horaire du bâtiment à utiliser pour déterminer les données de disponibilité de la réservation à renvoyer. Par exemple : États-Unis/Pacifique.

    Type de données : chaîne
    Période de travail Requis si les modules réservables spécifiés dépendent d’une équipe.
    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
    début Requis. Heure de début à utiliser pour rechercher des modules réservables disponibles. Cette valeur doit être antérieure à la valeur spécifiée dans le end paramètre.

    Type de données : chaîne

    Format : UTC ou heure locale (aaaa-mm-jj hh :mm :ss)
    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 Liste de tous les équipements disponibles pour les heures spécifiées.

    Type de données : tableau d’objets

    "result": [
  {
    "availableTimes": [Array],
    "building": {Object},
    "campus": {Object},
    "email": "String",
    "floor": {Object},
    "is_available": Boolean,
    "name": "String",
    "reservations": [Array],
    "sys_id": "String"
  }
]
    result.availableTimes Liste des dates/heures auxquelles l’élément réservable associé est disponible.

    Type de données : tableau
    résultat.bâtiment Détails sur le bâtiment associé à l’élément réservable.

    Type de données : objet

    "building": {
  "display_value": "String",
  "name": "String",
  "sys_id": "String"
}
    result.building.display_value Valeur d’affichage du bâtiment.

    Type de données : chaîne
    result.building.name Nom 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.campus Détails sur le campus associé à l’élément réservable.

    Type de données : objet

    "campus": {
  "display_value": "String",
  "name": "String",
  "sys_id": "String"
}
    result.campus.display_value Numéro d’affichage du campus sur lequel se trouve l’élément réservable, par exemple East Bay.

    Type de données : chaîne
    result.campus.name Nom du campus.

    Type de données : chaîne
    result.campus.sys_id Sys_id de l’enregistrement associé. Situé dans la table Campus [sn_wsd_core_campus].

    Type de données : chaîne
    result.email Adresse e-mail de l’élément réservable associé.

    Type de données : chaîne
    résultat.étage Détails sur l’étage associé au réservable.

    Type de données : objet

    "floor": {
  "display_value": "String",
  "name": "String",
  "sys_id": "String"
}
    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.name Nom de l’étage où se trouve l’élément réservable.

    Type de données : chaîne
    result.floor.sys_id Sys_id de l’enregistrement associé dans la table Étage [sn_wsd_core_floor].

    Type de données : chaîne
    result.is_available Marqueur indiquant si le réservable est disponible à la réservation.
    Valeurs valides :
    • true : disponible à la réservation.
    • false : non disponible à la réservation.

    Type de données : booléennes
    result.name Nom de l’élément réservable.

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

    Type de données : tableau d’objets

    "reservations": [
  {
    "configuration_item": "String",
    "end": "String",
    "is_collided": Boolean,
    "location": {Object},
    "number": "String",
    "requested_for": {Object},
    "reservation_purpose": {Object},
    "start": "String",
    "state": {Object},
    "subject": "String",
    "sys_id": "String"
  }
]
    result.reservations.configuration_item Éléments de configuration correspondant à la réservation. Situé dans la table cmdb_ci.

    Type de données : chaîne
    résultat.réservations.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.reservations.is_collided Marqueur qui indique si la réservation entre en conflit avec les heures de début et de fin de la recherche.

    Cela indique que l’emplacement réservable associé est déjà réservé pour la période de recherche spécifiée.

    Valeurs possibles :
    • true : collision.
    • false : aucune collision.

    Type de données : booléennes
    résultat.réservations.emplacement Détails sur l’emplacement de la réservation.

    Type de données : objet

    "location": {
  "location": "String",
  "timezone": {Object}
}
    résultat.réservations.emplacement.emplacement 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
    résultat.réservations.emplacement.fuseau horaire Détails sur le fuseau horaire associé à l’emplacement.

    Type de données : objet

    "timezone": {
  "displayValue": "String",
  "value": "String"
}
    résultat.réservations.location.fusehoraire.displayValue Valeur d’affichage du fuseau horaire auquel cet emplacement appartient.

    Type de données : chaîne
    résultat.réservations.location.fusehoraire.valeur Valeur interne du fuseau horaire auquel cet emplacement appartient.

    Type de données : chaîne
    résultat.réservations.nombre Numéro de réservation.

    Type de données : chaîne
    result.reservations.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"
}
    result.reservations.requested_for.name Nom de l’utilisateur pour lequel la réservation a été demandée.

    Type de données : chaîne
    result.reservations.requested_for.sys_id Sys_id de l’utilisateur pour lequel la réservation est demandée. Situé dans la table Utilisateur [sys_user].

    Type de données : chaîne
    result.reservations.reservation_purpose Détails sur l’objet de la réservation.

    Type de données : objet

    "reservation_purpose": {
  "display_value": "String,"
  "value": "String"
}
    result.reservations.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.reservations.reservation_purpose.value Valeur interne aux fins de la réservation, telle que company_meeting.

    Type de données : chaîne
    résultat.réservations.début Date et heure de début de la réservation.

    Type de données : chaîne

    Format : UTC - aaaa-mm-jjThh :mm :ssZ, par exemple 2021-02-05T18 :00 :00Z
    résultat.réservations.é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.reservations.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.reservations.état.valeur Valeur interne de l’état actuel de la réservation, par exemple 2.

    Type de données : chaîne
    résultat.réservations.sujet Objet de la réservation.

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

    Type de données : chaîne

    Demande cURL

    L’exemple de code suivant montre comment appeler ce point de terminaison. Remarque : Des sauts de ligne ont été ajoutés aux paramètres de requête pour faciliter la lecture.

    curl "https://instance.servicenow.com/api/sn_wsd_rsv/search/availability?
reservable_module=5db44502dbb650106c731dcd13961937&
start=2023-10-12T11:00:00Z&
end=2023-10-15T12:00:00Z&
reservable_ids=adb35f1977220110b3d7be377b5a99fc&
reservation_ids=undefined&
shift=undefined&
schedule_view_obj={"schedule_view_date":"2023-10-12","timezone":"Europe/Paris"}&
timezone=Europe/Paris&
include_reservations_within_days=true&
ignore_same_day_validation=true&
include_unavailable_items=true"  \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

    Résultats renvoyés :

    {
  "result": [
    {
      "sys_id": "fe1f744edb7650106c731dcd139619ca",
      "email": null,
      "name": "Aspen",
      "is_available": true,
      "availableTimes": [
        [
          "2022-04-23 07:00:00",
          "2022-04-23 08:30:00"
        ],
        [
          "2022-04-23 09:30:00",
          "2022-04-23 23:00:00"
        ],
        [
          "2022-04-24 00:00:00",
          "2022-04-24 06:59:59"
        ]
      ],
      "floor": {
        "sys_id": "2f554296dbba10106c731dcd139619ed",
        "display_value": "Floor 2",
        "name": "Floor 2"
      },
      "building": {
        "sys_id": "94e264cedb3650106c731dcd13961919",
        "display_value": "CAL-B1",
        "name": "CAL-B1"
      },
      "campus": {
        "sys_id": "82b2a0cedb3650106c731dcd139619e9",
        "display_value": "California Campus",
        "name": "California Campus"
      },
      "reservations": [
        {
          "sys_id": "5fe65830874bc9106342b846dabb352b",
          "number": "WRES0001001",
          "location": {
            "location": "fe1f744edb7650106c731dcd139619ca",
            "timezone": {
              "value": "US/Pacific",
              "displayValue": "US/Pacific"
            }
          },
          "configuration_item": null,
          "start": "2022-04-23T08:30:00Z",
          "end": "2022-04-23T09:30:00Z",
          "subject": null,
          "reservation_purpose": {
            "value": "meeting",
            "display_value": "Meeting"
          },
          "state": {
            "value": "confirmed",
            "display_value": "Confirmed"
          },
          "is_collided": false,
          "requested_for": {
            "sys_id": "2de07e1887cb89106342b846dabb35fe",
            "name": "Workplace User"
          }
        }
      ]
    }
  ]
}

    Recherche WSD : GET /api/sn_wsd_rsv/search/best_match

    Recherche la meilleure correspondance d’éléments réservables en fonction des critères de recherche fournis.

    Format d'URL

    URL versionnée : /api/sn_wsd_rsv/{api_version}/search/best_match

    URL par défaut : /api/sn_wsd_rsv/search/best_match

    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
    Tableau 8. Paramètres de requête
    Nom Description
    best_match_count Nombre d’éléments réservables les mieux adaptés à renvoyer.

    Type de données : nombre

    Valeur par défaut : 1
    fin Requis. Heure de fin à utiliser pour rechercher des modules réservables disponibles. Cette valeur doit être ultérieure à la valeur spécifiée dans le start paramètre.

    Type de données : chaîne

    Format : UTC ou heure locale (aaaa-mm-jj hh :mm :ss)
    include_reservable_purposes Marqueur indiquant si l’objectif de réservation de l’emplacement du lieu de travail pour chaque réservable doit être renvoyé dans les résultats renvoyés. Ces informations se trouvent dans la table Objectif réservable [sn_wsd_rsv_reservable_purpose].
    Valeurs valides :
    • true : renvoyer les objectifs réservables.
    • false : ne pas renvoyer les objectifs réservables.

    Type de données : booléennes

    Valeur par défaut : false
    include_reservations_within_days Marqueur indiquant s’il faut renvoyer tous les créneaux libres des heures disponibles dans la réponse pour chaque réservable pour toute la journée.
    Valeurs valides :
    • true : Renvoie tous les emplacements libres.
    • false : Ne renvoie pas tous les emplacements libres.

    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 :
    • true : renvoie les informations sur les services standards.
    • false : ne renvoie pas les informations sur les services standards.

    Type de données : booléennes

    Valeur par défaut : false
    q Requis. Requête codée à utiliser pour filtrer les résultats de retour de recherche. Dans cette requête, vous devez spécifier le sys_id de bâtiment et vous pouvez spécifier des paramètres tels que l’étage, la surface, la capacité, les services standard et reservable_purposes.

    Tous les paramètres transmis doivent être sys_ids, à l’exception de la capacité, qui est un nombre.

    Par exemple : q=bâtiment=94e264cedb3650106c731dcd13961919^floorINfc7368cedb3650106c731dcd13961902^capacité>=1^standard_services=55c0818edb7650106c731dcd13961904^reservable_purposes=d6e5c7cd1ba4e01051848489cc4bcb81

    Vous pouvez trouver ces informations dans les tables suivantes :
    • Bâtiment : sn_wsd_core_building
    • Étage : sn_wsd_core_floor
    • Quartier : sn_wsd_core_area
    • Services standards : sn_wsd_rsv_standard_service
    • Objectifs réservables : sn_wsd_rsv_reservable_purpose

    Type de données : chaîne
    reservable_module Requis. Sys_id du module réservable à inclure dans la recherche. Un module réservable regroupe les types similaires d’éléments du lieu de travail. Situé dans la table Module réservable [sn_wsd_rsv_reservable_module].

    Type de données : chaîne
    début Requis. Heure de début à utiliser pour rechercher des modules réservables disponibles. Cette valeur doit être antérieure à la valeur spécifiée dans le end paramètre.

    Type de données : chaîne

    Format : UTC ou heure locale (aaaa-mm-jj hh :mm :ss)
    time_slot Sys_id d’un enregistrement de créneau horaire pour lequel nous essayons de rechercher le réservable qui correspond le mieux. Situé dans la table Créneau horaire [sn_wsd_rsv_time_slot].

    Type de données : chaîne

    Par défaut : Aucun
    fuseau horaire Fuseau horaire préféré, tel que Europe/Amsterdam.

    Type de données : chaîne

    Par défaut : Aucun
    Tableau 9. Paramètres de corps de demande
    En-tête 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
    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 Renvoyer les résultats de la meilleure correspondance réservable.

    Type de données : objet

    "result": { 
  "floorsOfSelectedBuilding": [Array],
  "hasMore": Boolean,
  "nextItemIndex": Number,
  "reservableContainers": [Array],
  "reservableUnits": [Array]
}
    résultat.étagesDeBâtimentSélectionné(e) Détails sur les étages où se trouve le réservable.

    Type de données : tableau d’objets

    "floorsOfSelectedBuilding": [
  {
    "display_value": "String",
    "external_id": "String",
    "name": "String",
    "sys_id": "String"
  }
]
    result.floorsOfSelectedBuilding.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.floorsOfSelectedBuilding.external_id Identificateur externe pour l’étage.

    Type de données : chaîne
    result.floorsOfSelectedBuilding.name Nom de l’étage où se trouve l’élément réservable.

    Type de données : chaîne
    result.floorsOfSelectedBuilding.sys_id Sys_id de l’enregistrement associé dans la table Étage [sn_wsd_core_floor].

    Type de données : chaîne
    result.hasPlus Marqueur indiquant s’il y a plus d’éléments réservables dans les résultats renvoyés.
    Valeurs possibles :
    • true : plus d’éléments réservables disponibles.
    • false : plus aucun réservable disponible.

    Type de données : booléennes
    résultat.nextItemIndex Index du prochain enregistrement réservable à extraire. Utilisez cette valeur lors de la pagination d’enregistrements réservables.

    Type de données : nombre
    result.reservableContainers Uniquement renvoyé pour les modules réservables dont le champ selection_type est défini sur Conteneur. Un conteneur est un regroupement d’éléments similaires, tel qu’un groupe de bureaux.

    Type de données : tableau d’objets

    "reservableContainers": [
  {
    "building": {Object},
    "campus": {Object},
    "capacity": Number,
    "display_value": "String",
    "floor": {Object},
    "image": {Object}
    "sys_id": "String"
  } 
]
    résultat.conteneursréservables.bâtiment Détails sur le bâtiment associé au conteneur réservable.

    Type de données : objet

    "building": {
  "display_value": "String",
  "name": "String",
  "sys_id": "String"
}
    result.reservableContainers.building.display_value Valeur d’affichage du bâtiment.

    Type de données : chaîne
    result.reservableContainers.building.name Nom du bâtiment.

    Type de données : chaîne
    result.reservableContainers.building.sys_id Sys_id de l’enregistrement de bâtiment associé.

    Type de données : chaîne
    résultat.conteneursréservables.campus
    Détails sur le campus sur lequel se trouve l’élément réservable.

    Situé dans la table Campus [sn_wsd_core_campus].

    Type de données : objet

    "campus": {
  "display_value": "String",
  "name": "String",
  "sys_id": "String"
}
    result.reservableContainers.campus.display_value Numéro d’affichage du campus sur lequel se trouve l’élément réservable, par exemple East Bay.

    Type de données : chaîne
    result.reservableContainers.campus.name Nom du campus.

    Type de données : chaîne
    result.reservableContainers.campus.sys_id Sys_id de l’enregistrement associé. Situé dans la table Campus [sn_wsd_core_campus].

    Type de données : chaîne
    résultat.conteneursréservables.capacité Nombre maximal d’occupants pour le réservable.

    Type de données : nombre
    result.reservableContainers.display_value Valeur d’affichage du conteneur réservable.

    Type de données : chaîne
    résultat.conteneursréservables.floor Détails sur l’étage associé au conteneur réservable.

    Type de données : objet

    "floor": {
  "display_value": "String",
  "name": "String",
  "sys_id": "String"
}
    result.reservableContainers.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.reservableContainers.floor.name Nom de l’étage où se trouve l’élément réservable.

    Type de données : chaîne
    result.reservableContainers.floor.sys_id Sys_id de l’enregistrement associé dans la table Étage [sn_wsd_core_floor].

    Type de données : chaîne
    résultat.réservableConteneurs.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].

    "image": {
  "link": "String",
  "sys_id": "String"
}
    result.reservableContainers.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.reservableContainers.image.sys_id Sys_id de l’enregistrement d’image associé.

    Type de données : chaîne
    result.reservableContainers.sys_id Sys_id de l’enregistrement de conteneur associé. La table dans laquelle il réside peut être configurée pour n’importe quel type de conteneur. Par défaut, il se trouve dans la table Aire [sn_wsd_core_area].

    Type de données : chaîne
    result.reservableUnits Détails sur les unités réservables qui correspondent aux critères de recherche spécifiés. Une unité réservable est un élément unique réservable, tel qu’un bureau ou une chaise.

    Type de données : objet

    "reservableUnits": [
  {
    "area": "String",
    "availableTimes": [Array],
    "building": {Object},
    "campus": {Object},
    "capacity": "String",
    "defaultPrivacyValue": Boolean,
    "description": "String",
    "email": "String",
    "external_id": "String",
    "floor": {Object},
    "image": {Object},
    "includedInResult": Boolean,
    "is_available": Boolean,
    "is_favorite": Boolean,
    "is_reservable": "String",
    "is_reserved": Boolean,
    "is_selected": Boolean,
    "location_type": {Object},
    "name": "String",
    "number": "String",
    "order": "String",
    "require_approval": Boolean,
    "requires_check_in": Boolean,
    "reservable_quantity": "String",
    "showPrivacyOption": Boolean,
    "site": {Object},
    "standard_services": [Array],
    "tableName": "String",
    "title": "String",
    “reservable_purposes”: [Array],
    "reservations": [Array],
    "sys_id": "String"
  }
]
    résultat.unitésréservables.aire Détails sur la zone dans laquelle se trouve le module réservable. Situé dans la table Zone [sn_wsd_core_area].

    Type de données : objet

    "area": {
  "display_value": "String",
  "sys_id": "String"
}
    result.reservableUnits.area.display_value Affichez la valeur de la zone de module réservable.

    Type de données : chaîne
    result.reservableUnits.area.sys_id Sys_id de l’enregistrement de zone associé au réservable.

    Type de données : chaîne
    result.reservableUnits.availableTime Liste des dates/heures auxquelles l’élément réservable associé est disponible.

    Type de données : tableau
    résultat.unitésréservables.bâtiment Détails sur le bâtiment dans lequel se trouve l’élément réservable. Situé dans la table Bâtiment [sn_wsd_core_building].

    Type de données : objet

    "building": {
  "display_value": "String",
  "sys_id": "String"
}
    result.reservableUnits.building.display_value Valeur d’affichage du bâtiment.

    Type de données : chaîne
    result.reservableUnits.building.sys_id Sys_id de l’enregistrement de bâtiment associé.

    Type de données : chaîne
    résultat.unitésréservables.campus
    Détails sur le campus sur lequel se trouve l’élément réservable.

    Situé dans la table Campus [sn_wsd_core_campus].

    Type de données : objet

    "campus": {
  "display_value": "String",
  "sys_id": "String"
}
    result.reservableUnits.campus.display_value Numéro d’affichage du campus sur lequel se trouve l’élément réservable, par exemple East Bay.

    Type de données : chaîne
    result.reservableUnits.campus.sys_id Sys_id de l’enregistrement associé. Situé dans la table Campus [sn_wsd_core_campus].

    Type de données : chaîne
    résultat.unitésréservables.capacité Nombre maximal d’occupants pour le réservable.

    Type de données : nombre
    result.reservableUnits.defaultPrivacyValue Marqueur indiquant le paramètre de confidentialité par défaut pour l’élément réservable.

    Pour plus d’informations sur ces paramètres de confidentialité, consultez Paramètres de confidentialité de la localisation et impact.

    Valeurs possibles :
    • true : le paramètre de confidentialité de l’élément réservable peut être remplacé.
    • false : le paramètre de confidentialité de l’élément réservable ne peut pas être remplacé.

    Type de données : booléennes
    result.reservableUnits.description Brève description de l’élément réservable.

    Type de données : chaîne
    result.reservableUnits.email Adresse e-mail de l’élément réservable.

    Type de données : chaîne
    result.reservableUnits.external_id ID externe du réservable utilisé pour synchroniser un espace mappé dans CMS. Cette valeur n’est renseignée que si une carte est associée à cet emplacement.

    Type de données : chaîne
    résultat.unitésréservables.floor
    Détails sur l’étage où se trouve l’élément réservable.

    Situé dans la table Étage [sn_wsd_core_floor].

    Type de données : objet

    "floor": {
  "display_value": "String",
  "sys_id": "String"
}
    result.reservableUnits.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.reservableUnits.floor.sys_id Sys_id de l’enregistrement associé dans la table Étage [sn_wsd_core_floor].

    Type de données : chaîne
    résultat.unitésréservables.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].

    "image": {
  "link": "String",
  "sys_id": "String"
}
    result.reservableUnits.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.reservableUnits.image.sys_id Sys_id de l’enregistrement d’image associé.

    Type de données : chaîne
    résultat.unitésréservables.inclusInRésultat Marqueur indiquant si l’élément réservable actuel est inclus dans les résultats renvoyés.
    Valeurs valides :
    • true : inclus dans les résultats renvoyés.
    • false : non inclus dans les résultats renvoyés.

    Type de données : booléennes
    result.reservableUnits.is_available Marqueur indiquant si le réservable est disponible à la réservation.
    Valeurs valides :
    • true : disponible à la réservation.
    • false : non disponible à la réservation.

    Type de données : booléennes
    result.reservableUnits.is_favorite Marqueur indiquant si l’élément réservable est marqué comme l’un des favoris de l’utilisateur associé.
    Valeurs valides :
    • true : favori.
    • false : ce n’est pas un favori.

    Type de données : booléennes
    result.reservableUnits.is_reservable Marqueur indiquant s’il est possible de réserver ce réservable.
    Remarque :
    Si le paramètre de requête est défini sur vrai, les include_unavailable_items emplacements indisponibles sont également renvoyés. Dans ce cas, si un emplacement est déjà réservé, alors le is_available paramètre est faux, mais is_reservable il est vrai.
    Valeurs valides :
    • true : disponible à la réservation.
    • false : non disponible à la réservation.

    Type de données : booléennes
    result.reservableUnits.is_reserved Marqueur indiquant si l’élément réservable est déjà réservé.
    Valeurs valides :
    • true : disponible à la réservation.
    • false : déjà réservé.

    Type de données : booléennes
    result.reservableUnits.is_selected Marqueur indiquant si l’élément réservable est déjà réservé.
    Valeurs valides :
    • true : disponible à la réservation.
    • false : déjà réservé.

    Type de données : booléennes
    result.reservableUnits.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 Emplacement du lieu de travail [sn_wsd_core_workplace_location].

    "location_type": {
  "display_value": "String",
  "name": "String",
  "sys_id": "String"
}
    result.reservableUnits.location_type.display_value Valeur d’affichage du type d’emplacement.

    Type de données : chaîne
    result.reservableUnits.location_type.name Nom du type d’emplacement, tel que sous-sol ou stockage. Identique à la valeur d’affichage.

    Type de données : chaîne
    result.reservableUnits.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.reservableUnits.name Nom de l’élément réservable.

    Type de données : chaîne
    résultat.unités.réservables.number 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.unitésréservables.ordre Numéro de commande de l’élément réservable.

    Type de données : nombre
    result.reservableUnits.require_approval Marqueur indiquant si la réservation de l’élément réservable nécessite une approbation.
    Valeurs possibles :
    • true : approbation requise.
    • false : l’approbation n’est pas requise.

    Type de données : booléennes
    result.reservableUnits.requires_check_in Marqueur indiquant si l’élément réservable nécessite que l’utilisateur s’enregistre.
    Valeurs valides :
    • true : enregistrement obligatoire.
    • false : l’enregistrement n’est pas obligatoire.

    Type de données : booléennes
    result.reservableUnits.reservable_purposes Détails sur l’objectif de réservation de l’élément réservable associé.

    Type de données : tableau d’objets

    "reservable_purposes": [
  {
    "name": "String",
    "short_description": "String",
    "sys_id": "String"
  }
]
    result.reservableUnits.reservable_purposes.Nom Nom de l’élément réservable.

    Type de données : chaîne
    result.reservableUnits.reservable_purposes.short_description Brève description de l’élément réservable.

    Type de données : chaîne
    result.reservableUnits.reservable_purposes.sys_id Sys_id de l’enregistrement de l’objectif réservable. Situé dans la table Objectif réservable [sn_wsd_rsv_reservable_purpose].

    Type de données : chaîne
    résultat.unitésréservables.réservations Détails sur les réservations associées à l’élément réservable. Renseigné uniquement si le paramètre de include_reservations_within_days requête est vrai et que le reservation_ids paramètre contient des ID de réservation, ce qui signifie qu’il existe déjà des réservations pour ce réservable.

    Type de données : tableau d’objets

    "reservations": [
  {
    "configuration_item": "String",
    "end": "String",
    "is_collided": Boolean,
    "location": {Object},
    "number": "String",
    "requested_for": {Object},
    "reservation_purpose": {Object},
    "start": "String",
    "state": {Object},
    "subject": "String",
    "sys_id": "String"
  }
]
    result.reservableUnits.reservations.configuration_item Éléments de configuration correspondant à la réservation. Situé dans la table cmdb_ci.

    Type de données : chaîne
    résultat.unitésréservables.reservations.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
    result.reservableUnits.reservations.is_collided Marqueur qui indique si la réservation entre en conflit avec les heures de début et de fin de la recherche.

    Cela indique que l’emplacement réservable associé est déjà réservé pour la période de recherche spécifiée.

    Valeurs possibles :
    • true : collision.
    • false : aucune collision.

    Type de données : booléennes
    résultat.unitésréservables.reservations.location Détails sur l’emplacement de la réservation.

    Type de données : objet

    "location": {
  "location": "String",
  "timezone": {Object}
}
    résultat.unitésréservables.reservations.location.location 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
    résultat.unitésréservables.reservations.location.fuseau horaire Détails sur le fuseau horaire associé à l’emplacement.

    Type de données : objet

    "timezone": {
  "displayValue": "String",
  "value": "String"
}
    résultat.reservableUnits.reservations.location.timezone.displayValue Valeur d’affichage du fuseau horaire auquel cet emplacement appartient.

    Type de données : chaîne
    résultat.unitésréservables.reservations.location.fusehoraire.valeur Valeur interne du fuseau horaire auquel cet emplacement appartient.

    Type de données : chaîne
    résultat.unitésréservables.réservations.number 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
    result.reservableUnits.reservations.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"
}
    result.reservableUnits.reservations.requested_for.name Nom de l’utilisateur pour lequel la réservation a été demandée.

    Type de données : chaîne
    result.reservableUnits.reservations.requested_for.sys_id Sys_id de l’utilisateur pour lequel la réservation est demandée. Situé dans la table Utilisateur [sys_user].

    Type de données : chaîne
    result.reservableUnits.reservations.reservation_purpose Détails sur l’objet de la réservation.

    Type de données : objet

    "reservation_purpose": {
  "display_value": "String,"
  "value": "String"
}
    result.reservableUnits.reservations.reservation_purpose.valeur_affichage Valeur d’affichage aux fins de la réservation, telle que Réunion de l’entreprise.

    Type de données : chaîne
    result.reservableUnits.reservations.reservation_purpose.value Valeur interne aux fins de la réservation, telle que company_meeting.

    Type de données : chaîne
    résultat.unitésréservables.reservations.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
    résultat.unitésréservables.reservations.é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.reservableUnits.reservations.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.unitésréservables.reservations.état.valeur Valeur interne de l’état actuel de la réservation, par exemple 2.

    Type de données : chaîne
    résultat.unitésréservables.réservations.sujet Objet de la réservation.

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

    Type de données : chaîne
    result.reservableUnits.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
    résultat.unitésréservables.showOptionConfidentialité Marqueur indiquant si un employé peut remplacer les paramètres 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 :
    • true : les paramètres de confidentialité peuvent être remplacés.
    • false : le paramètre de confidentialité ne peut pas être remplacé.

    Type de données : booléennes
    result.reservableUnits.site Détails sur le site où se trouve l’élément réservable.

    Situé dans la table Site [sn_wsd_core_site].

    "site": {
  "display_value": "String",
  "sys_id": "String"
}
    result.reservableUnits.site.display_value Valeur d’affichage du site.

    Type de données : chaîne
    result.reservableUnits.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.reservableUnits.standard_services
    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

    "standard_services": [
  {
    "font_awesome_icon": "String",
    "name": "String",
    "short_description": "String",
    "sys_id": "String"
  }
]
    result.reservableUnits.standard_services.font_awesome_icon Nom de l’icône de miniature associée au service standard.

    Type de données : chaîne
    result.reservableUnits.standard_services.name Nom de l’icône de miniature associée au service standard.

    Type de données : chaîne
    result.reservableUnits.standard_services.short_description Brève description du service standard.

    Type de données : chaîne
    result.reservableUnits.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.reservableUnits.sys_id Sys_id de l’enregistrement réservable. Situé dans la table Emplacement du lieu de travail [sn_wsd_core_workplace_location].

    Type de données : chaîne
    result.reservableUnits.tableName Nom de la table dans laquelle se trouve l’enregistrement réservable.

    Type de données : chaîne
    résultat.unitésréservables.title Titre de l’élément réservable.

    Type de données : chaîne

    Demande cURL

    L’exemple de code suivant montre comment appeler ce point de terminaison.

    curl "https://instance.servicenow.com/api/sn_wsd_rsv/search/best_match?q=building%3D9e0364cedb3650106c731dcd1396192b&start=2023-01-04T07%3A00%3A00Z&time_slot=d5331cf2dbb5f01038e42b24ca961906&end=2023-01-04T17%3A00%3A00Z&best_match_count=1&reservable_module=2b636b7e1b4e60103523ff751a4bcbe2&timezone=Europe%2FAmsterdam" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

    Résultats renvoyés :

    {
  "result": {
    "hasMore": false,
    "reservableUnits": [
      {
        "sys_id": "fe1f744edb7650106c731dcd139619ca",
        "external_id": null,
        "email": null,
        "name": "Aspen",
        "title": "Aspen",
        "description": "A room with large windows, dark leather seats and a large wooden table.",
        "image": {
          "sys_id": "41c74902dbb650106c731dcd13961944",
          "link": "41c74902dbb650106c731dcd13961944.iix"
        },
        "number": "ROOM0000903",
        "site": {
          "sys_id": "628eec06db7650106c731dcd139619dd",
          "display_value": "North America"
        },
        "campus": {
          "sys_id": "82b2a0cedb3650106c731dcd139619e9",
          "display_value": "California Campus"
        },
        "building": {
          "sys_id": "94e264cedb3650106c731dcd13961919",
          "display_value": "CAL-B1"
        },
        "floor": {
          "sys_id": "2f554296dbba10106c731dcd139619ed",
          "display_value": "Floor 2"
        },
        "area": null,
        "capacity": "16",
        "reservable_quantity": null,
        "location_type": {
          "sys_id": "20713b83eb512010b89bfdfc9c522899",
          "display_value": "Room",
          "name": "Room"
        },
        "order": null,
        "requires_check_in": null,
        "is_reservable": "1",
        "tableName": "sn_wsd_core_room",
        "require_approval": false,
        "standard_services": [
          {
            "sys_id": "abd0c18edb7650106c731dcd13961965",
            "name": "Projector screen",
            "short_description": "Connect laptop to screen (HDMI and DVI)",
            "font_awesome_icon": "fa-caret-square-o-right"
          }
        ],
        "reservable_purposes": [
          {
            "sys_id": "18f4c3cd1ba4e01051848489cc4bcb82",
            "name": "Board room",
            "short_description": null
          }
        ],
        "is_available": true,
        "reservations": [
          {
            "sys_id": "5fe65830874bc9106342b846dabb352b",
            "number": "WRES0001001",
            "location": {
              "location": "fe1f744edb7650106c731dcd139619ca",
              "timezone": {
                "value": "US/Pacific",
                "displayValue": "US/Pacific"
              }
            },
            "configuration_item": null,
            "start": "2022-04-23T08:30:00Z",
            "end": "2022-04-23T09:30:00Z",
            "subject": null,
            "reservation_purpose": {
              "value": "meeting",
              "display_value": "Meeting"
            },
            "state": {
              "value": "confirmed",
              "display_value": "Confirmed"
            },
            "is_collided": false,
            "requested_for": {
              "sys_id": "2de07e1887cb89106342b846dabb35fe",
              "name": "Workplace User"
            }
          },
          {
            "sys_id": "af075c30874bc9106342b846dabb3572",
            "number": "WRES0001002",
            "location": {
              "location": "fe1f744edb7650106c731dcd139619ca",
              "timezone": {
                "value": "US/Pacific",
                "displayValue": "US/Pacific"
              }
            },
            "configuration_item": null,
            "start": "2022-04-23T23:00:00Z",
            "end": "2022-04-24T00:00:00Z",
            "subject": null,
            "reservation_purpose": {
              "value": "meeting",
              "display_value": "Meeting"
            },
            "state": {
              "value": "confirmed",
              "display_value": "Confirmed"
            },
            "is_collided": false,
            "requested_for": {
              "sys_id": "2de07e1887cb89106342b846dabb35fe",
              "name": "Workplace User"
            }
          }
        ],
        "availableTimes": [
          [
            "2022-04-23 07:00:00",
            "2022-04-23 08:30:00"
          ],
          [
            "2022-04-23 09:30:00",
            "2022-04-23 23:00:00"
          ],
          [
            "2022-04-24 00:00:00",
            "2022-04-24 06:59:59"
          ]
        ],
        "is_favorite": false
      }
    ],
    "reservableContainers": [],
    "nextItemIndex": -1,
    "floorsOfSelectedBuilding": [
      {
        "sys_id": "2f554296dbba10106c731dcd139619ed",
        "display_value": "Floor 2",
        "external_id": null,
        "name": "Floor 2"
      }
    ]
  }
}{
  "result": {
    "hasMore": false,
    "reservableUnits": [
      {
        "sys_id": "32f2a98adb7210106c731dcd13961972",
        "external_id": null,
        "wsd_email": null,
        "name": "B1-03-04",
        "title": "B1-03-04",
        "description": "Desk reserved for the Team-C. After 10am, free to reserve for everyone.",
        "image": {
          "sys_id": "57b42dcadb7210106c731dcd13961945",
          "link": "57b42dcadb7210106c731dcd13961945.iix"
        },
        "number": "SPCE0009018",
        "site": {
          "sys_id": "b17220cedb3650106c731dcd1396197a",
          "display_value": "Western Europe"
        },
        "campus": {
          "sys_id": "44d2e0cedb3650106c731dcd13961988",
          "display_value": "Amsterdam Campus"
        },
        "building": {
          "sys_id": "9e0364cedb3650106c731dcd1396192b",
          "display_value": "AMS-B1"
        },
        "floor": {
          "sys_id": "5373a8cedb3650106c731dcd1396198a",
          "display_value": "Floor 3"
        },
        "area": {
          "sys_id": "410ff04edb7650106c731dcd13961973",
          "display_value": "Desks C1"
        },
        "capacity": "1",
        "reservable_quantity": null,
        "location_type": {
          "sys_id": "5f017383eb512010b89bfdfc9c5228c8",
          "display_value": "Workspace/Desk",
          "name": "Workspace/Desk"
        },
        "order": null,
        "requires_check_in": null,
        "is_reservable": "1",
        "tableName": "sn_wsd_core_space",
        "require_approval": false,
        "is_available": true,
        "reservations": [],
        "availableTimes": [
          [
            "2023-01-04 07:00:00",
            "2023-01-04 17:00:00"
          ]
        ],
        "showPrivacyOption": false,
        "defaultPrivacyValue": false,
        "container": {
          "sys_id": "410ff04edb7650106c731dcd13961973",
          "display_value": "Desks C1",
          "floor": {
            "sys_id": "5373a8cedb3650106c731dcd1396198a",
            "display_value": "Floor 3",
            "name": "Floor 3"
          },
          "building": {
            "sys_id": "9e0364cedb3650106c731dcd1396192b",
            "display_value": "AMS-B1",
            "name": "AMS-B1"
          },
          "campus": {
            "sys_id": "44d2e0cedb3650106c731dcd13961988",
            "display_value": "Amsterdam Campus",
            "name": "Amsterdam Campus"
          },
          "capacity": 6,
          "image": {
            "sys_id": "d52c27b21b8e60103523ff751a4bcb49",
            "link": "d52c27b21b8e60103523ff751a4bcb49.iix"
          }
        },
        "includedInResult": true,
        "is_favorite": true
      }
    ],
    "reservableContainers": [
      {
        "sys_id": "410ff04edb7650106c731dcd13961973",
        "display_value": "Desks C1",
        "floor": {
          "sys_id": "5373a8cedb3650106c731dcd1396198a",
          "display_value": "Floor 3",
          "name": "Floor 3"
        },
        "building": {
          "sys_id": "9e0364cedb3650106c731dcd1396192b",
          "display_value": "AMS-B1",
          "name": "AMS-B1"
        },
        "campus": {
          "sys_id": "44d2e0cedb3650106c731dcd13961988",
          "display_value": "Amsterdam Campus",
          "name": "Amsterdam Campus"
        },
        "capacity": 6,
        "image": {
          "sys_id": "d52c27b21b8e60103523ff751a4bcb49",
          "link": "d52c27b21b8e60103523ff751a4bcb49.iix"
        }
      }
    ],
    "nextItemIndex": -1,
    "floorsOfSelectedBuilding": [
      {
        "sys_id": "5373a8cedb3650106c731dcd1396198a",
        "display_value": "Floor 3",
        "external_id": null,
        "name": "Floor 3"
      }
    ]
  }

    Recherche WSD : GET /api/sn_wsd_rsv/search/overlapping_reservation

    Détermine si une réservation avec chevauchement existe en fonction des paramètres transmis.

    Format d'URL

    URL versionnée : /api/sn_wsd_rsv/{api_version}/search/overlapping_reservation

    URL par défaut : /api/sn_wsd_rsv/search/overlapping_reservation

    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
    fin Requis. Heure de fin à utiliser pour vérifier les réservations qui se chevauchent.

    Type de données : chaîne

    Format : AAAA-MM-JJTHH :MM :SSZ
    recurring_pattern Détails sur le modèle récurrent de la réservation.

    Type de données : objet

    "recurring_pattern": {
  "duration": Number,
  "options": {Object},
  "repeats": "String",
  "startDate":"String"
}
    recurring_pattern.durée Durée de vérification.

    Type de données : nombre

    Unité : Secondes
    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
}
    recurring_pattern.options.count Nombre de répétitions du modèle.

    Type de données : nombre
    recurring_pattern.options.daysOfWeek Jours de la semaine pour vérifier les chevauchements.
    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).

    Type de données : chaîne
    recurring_pattern.options.every Intervalle de répétition du modèle à vérifier. Par exemple, si cette valeur est égale à 2, elle vérifie le modèle de répétition 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
    recurring_pattern.options.répétitions Modèle répétitif pour la vérification du chevauchement de réservation.
    Valeurs possibles : (sensible à la casse)
    • quotidien
    • mensuel
    • hebdomadaire
    • annuel

    Type de données : chaîne
    reservable_id Sys_id du module réservable pour vérifier les réservations qui se chevauchent. Situé dans la table Module réservable [sn_wsd_rsv_reservable_module].

    Type de données : chaîne
    reservation_id Sys_id de la réservation pour vérifier le chevauchement. Cette valeur est nécessaire dans le flux de modification des parents multi/groupes. Situé dans la table Réservation du lieu de travail [sn_wsd_rsv_reservation].

    Type de données : chaîne
    shift_info_object Détails de l’équipe pour vérifier les chevauchements.

    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 : objet

    "shift_info_object": {
  "applyToShift": Boolean,
  "shift": "String",
  "timezone": "String"
}
    shift_info_object.applyToShift 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
    shift_info_object.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.

    Type de données : chaîne
    shift_info_object.fuseau horaire Fuseau horaire de l’équipe pour vérifier l’absence de chevauchement.

    Type de données : chaîne
    début Requis. Heure de début à utiliser pour vérifier les réservations qui se chevauchent.

    Type de données : chaîne

    Format : AAAA-MM-JJTHH :MM :SSZ
    user_id Requis. Sys_id de l’utilisateur à vérifier pour les réservations qui se chevauchent. Situé dans la table Utilisateur [sys_user].

    Type de données : chaîne
    Tableau 15. Paramètres de corps de demande (XML ou JSON)
    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 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
    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.
    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 de corps de réponse (JSON ou XML)

    Nom Description
    résultats Détails des résultats de la vérification de chevauchement.

    Type de données : objet

    "results": {
  "isOverlapped": Boolean,
  "reservableId": "String"
}
    results.isOverlapped Marqueur indiquant s’il existe une réservation avec chevauchement.

    Valeurs valides :

    • true : il existe une réservation avec chevauchement.
    • false : la réservation avec chevauchement n’existe pas.

    Type de données : booléennes
    results.reservableId Dans le cas d’une réservation de groupe, le sys_id de l’élément réservable pour lequel le chevauchement se produit.

    Type de données : chaîne

    Demande cURL

    L’exemple de code suivant montre comment vérifier un chevauchement de réservation pour un utilisateur spécifique et pour une période de temps spécifique notée par les start paramètres et end .

    curl "http://instance.servicenow.com/api/sn_wsd_rsv/search/overlapping_reservation?user_id=2e617fecc3d365101e38b23bb00131ec&end=2023-06-19T8:00:00Z&start=2023-06-19T07:00:00Z" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

    Résultats renvoyés :

    {
"results": {
  "isOverlapped": True,
  "reservableId": ""
  }
}

    Recherche WSD : GET/api/sn_wsd_rsv/search/reservable

    Recherche des éléments réservables disponibles à l’aide d’une configuration de modèle réservable spécifiée.

    Format d'URL

    URL versionnée : /api/sn_wsd_rsv/{api_version}/search/reservable

    URL par défaut : /api/sn_wsd_rsv/search/reservable

    Paramètres de demande pris en charge

    Tableau 19. 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 20. Paramètres de requête
    Nom Description
    fin Requis. Heure de fin à utiliser pour rechercher des modules réservables disponibles. Cette valeur doit être ultérieure à la valeur spécifiée dans le start paramètre.

    Type de données : chaîne

    Format : UTC ou heure locale (aaaa-mm-jj hh :mm :ss)
    exclude_reservablesListe d’un ou plusieurs sys_ids de réservables à exclure des résultats de recherche. La table dans laquelle se trouvent ces sys_ids est spécifiée dans le champ reservable_table de la table Module réservable [sn_wsd_rsv_reservable_module]. Il peut s’agir de la table Espace [sn_wsd_core_space] ou Salle [sn_wsd_core_room].

    Type de données : chaîne ou tableau
    ignore_same_day_validation Marqueur indiquant si la recherche de réservation ignore le changement de la validation de la date entre les paramètres de début et de fin.
    Valeurs valides :
    • true : ignore la validation de la date de changement.
    • false : n’ignorez pas la validation de la date de changement.

    Type de données : booléennes

    Valeur par défaut : false
    include_reservable_purposes Marqueur indiquant si l’objectif de réservation de l’emplacement du lieu de travail pour chaque réservable doit être renvoyé dans les résultats renvoyés. Ces informations se trouvent dans la table Objectif réservable [sn_wsd_rsv_reservable_purpose].
    Valeurs valides :
    • true : renvoyer les objectifs réservables.
    • false : ne pas renvoyer les objectifs réservables.

    Type de données : booléennes

    Valeur par défaut : false
    include_reservations_within_days Marqueur indiquant s’il faut renvoyer tous les créneaux libres des heures disponibles dans la réponse pour chaque réservable pour toute la journée.
    Valeurs valides :
    • true : Renvoie tous les emplacements libres.
    • false : Ne renvoie pas tous les emplacements libres.

    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 :
    • true : renvoie les informations sur les services standards.
    • false : ne renvoie pas les informations sur les services standards.

    Type de données : booléennes

    Valeur par défaut : false
    near_by_location_id Requis si le rsv_path paramètre est défini sur browse_near_a_person. Sys_id de l’emplacement à utiliser dans la requête codée. Situé dans la table Emplacement du lieu de travail [sn_wsd_core_workplace_location].

    Type de données : chaîne
    quartier

    Requis si le paramètre rsv_path est défini sur browse_by_neighborhood.

    disponible uniquement si le module d’extension Gestion des espaces (sn_wsd_spc_mgmt_neighborhood) est activé.

    Sys_id de l’enregistrement de quartier à utiliser dans la requête codée. Situé dans la table Quartier [sn_wsd_spcmgmt_neighborhood].

    Pour plus d’informations sur les réservations d’espaces du quartier, consultez Create neighborhood reservations.

    Type de données : chaîne
    next_item_index Index de l’élément suivant à récupérer. Transmettez ce paramètre lors de la pagination des résultats renvoyés.

    Type de données : nombre

    Par défaut : 0
    page_size Nombre maximal d’enregistrements à renvoyer dans les résultats renvoyés.

    Type de données : nombre

    Par défaut : 6
    q Requis. Requête codée à utiliser pour filtrer les résultats de retour de recherche. Dans cette requête, vous devez spécifier le sys_id de bâtiment et vous pouvez spécifier des paramètres tels que l’étage, la surface, la capacité, les services standard et reservable_purposes.

    Tous les paramètres transmis doivent être sys_ids, à l’exception de la capacité, qui est un nombre.

    Par exemple : q=bâtiment=94e264cedb3650106c731dcd13961919^floorINfc7368cedb3650106c731dcd13961902^capacité>=1^standard_services=55c0818edb7650106c731dcd13961904^reservable_purposes=d6e5c7cd1ba4e01051848489cc4bcb81

    Vous pouvez trouver ces informations dans les tables suivantes :
    • Bâtiment : sn_wsd_core_building
    • Étage : sn_wsd_core_floor
    • Quartier : sn_wsd_core_area
    • Services standards : sn_wsd_rsv_standard_service
    • Objectifs réservables : sn_wsd_rsv_reservable_purpose

    Type de données : chaîne
    reservable_module Requis. Sys_id du module réservable à inclure dans la recherche. Un module réservable regroupe les types similaires d’éléments du lieu de travail. Situé dans la table Module réservable [sn_wsd_rsv_reservable_module].

    Type de données : chaîne
    reservation_ids Liste séparée par des virgules des sys_ids de réservation existants. Transmettez ce paramètre si vous souhaitez modifier les réservations associées. Situé dans la table Réservation du lieu de travail [sn_wsd_rsv_reservation].

    Le temps bloqué pour ces sys_ids pour les réservables correspondants est traité comme disponible.

    Type de données : chaîne

    Par défaut : Aucun
    rsv_path Chemin de réservation à appliquer à la recherche.
    Valeurs valides :
    • browse_all : rechercher tous les réservables.
    • browse_by_area : rechercher les réservables à proximité d’un emplacement spécifique. Un identificateur de zone doit être passé dans la requête codée (q paramètre).
    • browse_by_neighborhood : recherchez les réservables à proximité du quartier spécifié dans le neighborhood paramètre.
    • browse_near_a_person : Recherchez les réservables à proximité de l’emplacement du lieu de travail de la personne spécifiée dans le near_by_location_id paramètre.

    Type de données : chaîne

    Valeur par défaut : browse_all
    schedule_view_obj Détails sur la vue de calendrier à renvoyer. Transmettez cet objet si vous avez besoin de données de disponibilité 24 heures sur 24 pour les réservations qui couvrent plus d’une journée. Les résultats de retour ne contiendront que les heures disponibles et les réservations pour la date spécifiée.

    Pour que cette fonctionnalité fonctionne correctement, les paramètres ignore_same_day_validation et include_reservations_within_days doivent être définis sur vrai.

    Type de données : objet

    "schedule_view_obj": {
  "schedule_view_date": "String",
  "timezone": "String"
}
    schedule_view_obj.date_vue_calendrier Date à partir de laquelle commencer à renvoyer la disponibilité de la réservation. Cette date doit être comprise dans le fuseau horaire spécifié dans le schedule_view_obj.timezone paramètre.

    Type de données : chaîne

    Format : AAAA-MM-JJ
    schedule_view_obj.fuseau horaire Fuseau horaire du bâtiment à utiliser pour déterminer les données de disponibilité de la réservation à renvoyer. Par exemple : États-Unis/Pacifique.

    Type de données : chaîne
    début Requis. Heure de début à utiliser pour rechercher des modules réservables disponibles. Cette valeur doit être antérieure à la valeur spécifiée dans le end paramètre.

    Type de données : chaîne

    Format : UTC ou heure locale (aaaa-mm-jj hh :mm :ss)
    Période de travail
    Sys_id de l’équipe à associer à la réservation. Situé dans la table Équipe [sn_wsd_core_shift]. Si ce paramètre est transmis, il end n’est pas 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
    sort_by Ordre de tri souhaité des éléments réservables retournés.
    Valeurs valides :
    • a_z : ordre de tri croissant.
    • favorites_first : trié d’abord selon les réservables du lieu de travail préférés de l’utilisateur, puis croissant pour les autres.
    • z_a : ordre de tri décroissant.

    Type de données : chaîne

    Valeur par défaut : a_z
    fuseau horaire Fuseau horaire préféré, tel que Europe/Amsterdam.

    Type de données : chaîne

    Par défaut : Aucun
    Tableau 21. 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 22. 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 23. 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 24. 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 Renvoie les résultats de la recherche spécifiée.

    Type de données : objet

    "result": { 
  "filter": {Object},
  "hasMore": Boolean,
  "nextFavIndex": Number,
  "nextItemIndex": Number,
  "reservableContainers": [Array],
  "reservableUnits": [Array],
  "totalProcessed": Number
}
    résultat.filtre Détails sur les étages, les services standards et les objectifs réservables des réservables. Si les include_standard_services paramètres ou include_reservable_purposes sont définis sur faux standard_services et reservable_purposes sont des tableaux vides.

    Type de données : objet

    "filter": {
   "floors": [Array],
   "reservable_purposes": [Array],
   "standard_services": [Array]
}
    résultat.filtre.étages
    Détails sur l’étage où se trouve l’élément réservable.

    Situé dans la table Étage [sn_wsd_core_floor].

    Type de données : objet

    "floors": [
  {
    "display_value": "String",
    "sys_id": "String"
  }
]
    result.filter.floors.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.filter.floors.sys_id Sys_id de l’enregistrement associé dans la table Étage [sn_wsd_core_floor].

    Type de données : chaîne
    result.filter.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

    "standard_services": [
  {
    "font_awesome_icon": "String",
    "name": "String",
    "short_description": "String",
    "sys_id": "String"
  }
]
    result.filter.standard_services.font_awesome_icon Nom de l’icône de miniature associée au service standard.

    Type de données : chaîne
    result.filter.standard_services.name Nom du service standard.

    Type de données : chaîne
    result.filter.standard_services.short_description Brève description du service standard.

    Type de données : chaîne
    result.filter.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.filter.reservable_purposes Détails sur l’objectif de réservation de l’élément réservable associé.

    Type de données : tableau d’objets

    "reservable_purposes": [
  {
    "name": "String",
    "short_description": "String",
    "sys_id": "String"
  }
]
    result.filter.reservable_purposes.name Nom de l’élément réservable.

    Type de données : chaîne
    result.filter.reservable_purposes.short_description Brève description de l’élément réservable.

    Type de données : chaîne
    result.filter.reservable_purposes.sys_id Sys_id de l’enregistrement de l’objectif réservable. Situé dans la table Objectif réservable [sn_wsd_rsv_reservable_purpose].

    Type de données : chaîne
    result.hasPlus Marqueur indiquant s’il y a plus d’éléments réservables dans les résultats renvoyés.
    Valeurs possibles :
    • true : plus d’éléments réservables disponibles.
    • false : plus aucun réservable disponible.

    Type de données : booléennes
    result.nextFavIndex Index du favori suivant réservable pour l’utilisateur. Utilisez cette valeur lors de la pagination des réservables préférés de l’utilisateur.

    Type de données : nombre
    résultat.nextItemIndex Index du prochain enregistrement réservable à extraire. Utilisez cette valeur lors de la pagination d’enregistrements réservables.

    Type de données : nombre
    result.reservableContainers Uniquement renvoyé pour les modules réservables dont le champ selection_type est défini sur Conteneur. Un conteneur est un regroupement d’éléments similaires, tel qu’un groupe de bureaux.

    Type de données : tableau d’objets

    "reservableContainers": [
  {
    "building": {Object},
    "campus": {Object},
    "capacity": Number,
    "display_value": "String",
    "floor": {Object},
    "image": {Object}
    "sys_id": "String"
  } 
]
    résultat.conteneursréservables.bâtiment Détails sur le bâtiment associé au conteneur réservable.

    Type de données : objet

    "building": {
  "display_value": "String",
  "name": "String",
  "sys_id": "String"
}
    result.reservableContainers.building.display_value Valeur d’affichage du bâtiment.

    Type de données : chaîne
    result.reservableContainers.building.name Nom du bâtiment.

    Type de données : chaîne
    result.reservableContainers.building.sys_id Sys_id de l’enregistrement de bâtiment associé.

    Type de données : chaîne
    résultat.conteneursréservables.campus
    Détails sur le campus sur lequel se trouve l’élément réservable.

    Situé dans la table Campus [sn_wsd_core_campus].

    Type de données : objet

    "campus": {
  "display_value": "String",
  "name": "String",
  "sys_id": "String"
}
    result.reservableContainers.campus.display_value Numéro d’affichage du campus sur lequel se trouve l’élément réservable, par exemple East Bay.

    Type de données : chaîne
    result.reservableContainers.campus.name Nom du campus.

    Type de données : chaîne
    result.reservableContainers.campus.sys_id Sys_id de l’enregistrement associé. Situé dans la table Campus [sn_wsd_core_campus].

    Type de données : chaîne
    résultat.conteneursréservables.capacité Nombre maximal d’occupants pour le réservable.

    Type de données : nombre
    result.reservableContainers.display_value Valeur d’affichage du conteneur réservable.

    Type de données : chaîne
    résultat.conteneursréservables.floor Détails sur l’étage associé au conteneur réservable.

    Type de données : objet

    "floor": {
  "display_value": "String",
  "name": "String",
  "sys_id": "String"
}
    result.reservableContainers.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.reservableContainers.floor.name Nom de l’étage où se trouve l’élément réservable.

    Type de données : chaîne
    result.reservableContainers.floor.sys_id Sys_id de l’enregistrement associé dans la table Étage [sn_wsd_core_floor].

    Type de données : chaîne
    résultat.réservableConteneurs.image 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.reservableContainers.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.reservableContainers.image.sys_id Sys_id de l’enregistrement d’image associé.

    Type de données : chaîne
    result.reservableContainers.sys_id Sys_id de l’enregistrement de conteneur associé. La table dans laquelle il réside peut être configurée pour n’importe quel type de conteneur. Par défaut, il se trouve dans la table Aire [sn_wsd_core_area].

    Type de données : chaîne
    result.reservableUnits Détails sur les unités réservables qui correspondent aux critères de recherche spécifiés. Une unité réservable est un élément unique réservable, tel qu’un bureau ou une chaise.

    Type de données : objet

    "reservableUnits": [
  {
    "area": "String",
    "availableTimes": [Array],
    "building": {Object},
    "campus": {Object},
    "capacity": "String",
    "defaultPrivacyValue": Boolean,
    "description": "String",
    "email": "String",
    "external_id": "String",
    "floor": {Object},
    "image": {Object},
    "includedInResult": Boolean,
    "is_available": Boolean,
    "is_favorite": Boolean,
    "is_reservable": "String",
    "is_reserved": Boolean,
    "is_selected": Boolean,
    "location_type": {Object},
    "name": "String",
    "number": "String",
    "order": "String",
    "require_approval": Boolean,
    "requires_check_in": Boolean,
    "reservable_quantity": "String",
    "showPrivacyOption": Boolean,
    "site": {Object},
    "standard_services": [Array],
    "tableName": "String",
    "title": "String",
    “reservable_purposes”: [Array],
    "reservations": [Array],
    "sys_id": "String"
  }
]
    résultat.unitésréservables.aire Détails sur la zone dans laquelle se trouve le module réservable. Situé dans la table Zone [sn_wsd_core_area].

    Type de données : objet

    "area": {
  "display_value": "String",
  "sys_id": "String"
}
    result.reservableUnits.area.display_value Affichez la valeur de la zone de module réservable.

    Type de données : chaîne
    result.reservableUnits.area.sys_id Sys_id de l’enregistrement de zone associé au réservable.

    Type de données : chaîne
    result.reservableUnits.availableTime Liste des dates/heures auxquelles l’élément réservable associé est disponible.

    Type de données : tableau
    résultat.unitésréservables.bâtiment Détails sur le bâtiment dans lequel se trouve l’élément réservable. Situé dans la table Bâtiment [sn_wsd_core_building].

    Type de données : objet

    "building": {
  "display_value": "String",
  "sys_id": "String"
}
    result.reservableUnits.building.display_value Valeur d’affichage du bâtiment.

    Type de données : chaîne
    result.reservableUnits.building.sys_id Sys_id de l’enregistrement de bâtiment associé.

    Type de données : chaîne
    résultat.unitésréservables.campus
    Détails sur le campus sur lequel se trouve l’élément réservable.

    Situé dans la table Campus [sn_wsd_core_campus].

    Type de données : objet

    "campus": {
  "display_value": "String",
  "sys_id": "String"
}
    result.reservableUnits.campus.display_value Numéro d’affichage du campus sur lequel se trouve l’élément réservable, par exemple East Bay.

    Type de données : chaîne
    result.reservableUnits.campus.sys_id Sys_id de l’enregistrement associé. Situé dans la table Campus [sn_wsd_core_campus].

    Type de données : chaîne
    résultat.unitésréservables.capacité Nombre maximal d’occupants pour le réservable.

    Type de données : nombre
    result.reservableUnits.description Brève description de l’élément réservable.

    Type de données : chaîne
    result.reservableUnits.email Adresse e-mail de l’élément réservable.

    Type de données : chaîne
    result.reservableUnits.external_id ID externe du réservable utilisé pour synchroniser un espace mappé dans CMS. Cette valeur n’est renseignée que si une carte est associée à cet emplacement.

    Type de données : chaîne
    résultat.unitésréservables.floor
    Détails sur l’étage où se trouve l’élément réservable.

    Situé dans la table Étage [sn_wsd_core_floor].

    Type de données : objet

    "floor": {
  "display_value": "String",
  "sys_id": "String"
}
    result.reservableUnits.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.reservableUnits.floor.sys_id Sys_id de l’enregistrement associé dans la table Étage [sn_wsd_core_floor].

    Type de données : chaîne
    résultat.unitésréservables.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].

    "image": {
  "link": "String",
  "sys_id": "String"
}
    result.reservableUnits.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.reservableUnits.image.sys_id Sys_id de l’enregistrement d’image associé.

    Type de données : chaîne
    résultat.unitésréservables.inclusInRésultat Marqueur indiquant si l’élément réservable actuel est inclus dans les résultats renvoyés.
    Valeurs valides :
    • true : inclus dans les résultats renvoyés.
    • false : non inclus dans les résultats renvoyés.

    Type de données : booléennes
    result.reservableUnits.is_available Marqueur indiquant si le réservable est disponible à la réservation.
    Valeurs valides :
    • true : disponible à la réservation.
    • false : non disponible à la réservation.

    Type de données : booléennes
    result.reservableUnits.is_favorite Marqueur indiquant si l’élément réservable est marqué comme l’un des favoris de l’utilisateur associé.
    Valeurs valides :
    • true : favori.
    • false : ce n’est pas un favori.

    Type de données : booléennes
    result.reservableUnits.is_reservable Marqueur indiquant s’il est possible de réserver ce réservable.
    Remarque :
    Si le paramètre de requête est défini sur vrai, les include_unavailable_items emplacements indisponibles sont également renvoyés. Dans ce cas, si un emplacement est déjà réservé, alors le is_available paramètre est faux, mais is_reservable il est vrai.
    Valeurs valides :
    • true : disponible à la réservation.
    • false : non disponible à la réservation.

    Type de données : booléennes
    result.reservableUnits.is_reserved Marqueur indiquant si l’élément réservable est déjà réservé.
    Valeurs valides :
    • true : disponible à la réservation.
    • false : déjà réservé.

    Type de données : booléennes
    result.reservableUnits.is_selected Marqueur indiquant si l’élément réservable est déjà réservé.
    Valeurs valides :
    • true : disponible à la réservation.
    • false : déjà réservé.

    Type de données : booléennes
    result.reservableUnits.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 Emplacement du lieu de travail [sn_wsd_core_workplace_location].

    "location_type": {
  "display_value": "String",
  "name": "String",
  "sys_id": "String"
}
    result.reservableUnits.location_type.display_value Valeur d’affichage du type d’emplacement.

    Type de données : chaîne
    result.reservableUnits.location_type.name Nom du type d’emplacement, tel que sous-sol ou stockage. Identique à la valeur d’affichage.

    Type de données : chaîne
    result.reservableUnits.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.reservableUnits.name Nom de l’élément réservable.

    Type de données : chaîne
    résultat.unités.réservables.number 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.unitésréservables.ordre Numéro de commande de l’élément réservable.

    Type de données : nombre
    result.reservableUnits.require_approval Marqueur indiquant si la réservation de l’élément réservable nécessite une approbation.
    Valeurs possibles :
    • true : approbation requise.
    • false : l’approbation n’est pas requise.

    Type de données : booléennes
    result.reservableUnits.requires_check_in Marqueur indiquant si l’élément réservable nécessite que l’utilisateur s’enregistre.
    Valeurs valides :
    • true : enregistrement obligatoire.
    • false : l’enregistrement n’est pas obligatoire.

    Type de données : booléennes
    result.reservableUnits.reservable_purposes Détails sur l’objectif de réservation de l’élément réservable associé.

    Type de données : tableau d’objets

    "reservable_purposes": [
  {
    "name": "String",
    "short_description": "String",
    "sys_id": "String"
  }
]
    result.reservableUnits.reservable_purposes.Nom Nom de l’élément réservable.

    Type de données : chaîne
    result.reservableUnits.reservable_purposes.short_description Brève description de l’élément réservable.

    Type de données : chaîne
    result.reservableUnits.reservable_purposes.sys_id Sys_id de l’enregistrement de l’objectif réservable. Situé dans la table Objectif réservable [sn_wsd_rsv_reservable_purpose].

    Type de données : chaîne
    résultat.unitésréservables.réservations Détails sur les réservations associées à l’élément réservable. Renseigné uniquement si le paramètre de include_reservations_within_days requête est vrai et que le reservation_ids paramètre contient des ID de réservation, ce qui signifie qu’il existe déjà des réservations pour ce réservable.

    Type de données : tableau d’objets

    "reservations": [
  {
    "configuration_item": "String",
    "end": "String",
    "is_collided": Boolean,
    "location": {Object},
    "number": "String",
    "requested_for": {Object},
    "reservation_purpose": {Object},
    "start": "String",
    "state": {Object},
    "subject": "String",
    "sys_id": "String"
  }
]
    result.reservableUnits.reservations.configuration_item Éléments de configuration correspondant à la réservation. Situé dans la table cmdb_ci.

    Type de données : chaîne
    résultat.unitésréservables.reservations.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
    result.reservableUnits.reservations.is_collided Marqueur qui indique si la réservation entre en conflit avec les heures de début et de fin de la recherche.

    Cela indique que l’emplacement réservable associé est déjà réservé pour la période de recherche spécifiée.

    Valeurs possibles :
    • true : collision.
    • false : aucune collision.

    Type de données : booléennes
    résultat.unitésréservables.reservations.location Détails sur l’emplacement de la réservation.

    Type de données : objet

    "location": {
  "location": "String",
  "timezone": {Object}
}
    résultat.unitésréservables.reservations.location.location 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
    résultat.unitésréservables.reservations.location.fuseau horaire Détails sur le fuseau horaire associé à l’emplacement.

    Type de données : objet

    "timezone": {
  "displayValue": "String",
  "value": "String"
}
    résultat.reservableUnits.reservations.location.timezone.displayValue Valeur d’affichage du fuseau horaire auquel cet emplacement appartient.

    Type de données : chaîne
    résultat.unitésréservables.reservations.location.fusehoraire.valeur Valeur interne du fuseau horaire auquel cet emplacement appartient.

    Type de données : chaîne
    résultat.unitésréservables.réservations.number 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
    result.reservableUnits.reservations.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"
}
    result.reservableUnits.reservations.requested_for.name Nom de l’utilisateur pour lequel la réservation a été demandée.

    Type de données : chaîne
    result.reservableUnits.reservations.requested_for.sys_id Sys_id de l’utilisateur pour lequel la réservation est demandée. Situé dans la table Utilisateur [sys_user].

    Type de données : chaîne
    result.reservableUnits.reservations.reservation_purpose Détails sur l’objet de la réservation.

    Type de données : objet

    "reservation_purpose": {
  "display_value": "String,"
  "value": "String"
}
    result.reservableUnits.reservations.reservation_purpose.valeur_affichage Valeur d’affichage aux fins de la réservation, telle que Réunion de l’entreprise.

    Type de données : chaîne
    result.reservableUnits.reservations.reservation_purpose.value Valeur interne aux fins de la réservation, telle que company_meeting.

    Type de données : chaîne
    résultat.unitésréservables.reservations.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
    résultat.unitésréservables.reservations.é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.reservableUnits.reservations.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.unitésréservables.reservations.état.valeur Valeur interne de l’état actuel de la réservation, par exemple 2.

    Type de données : chaîne
    résultat.unitésréservables.réservations.sujet Objet de la réservation.

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

    Type de données : chaîne
    result.reservableUnits.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.reservableUnits.site Détails sur le site où se trouve l’élément réservable.

    Situé dans la table Site [sn_wsd_core_site].

    "site": {
  "display_value": "String",
  "sys_id": "String"
}
    result.reservableUnits.site.display_value Valeur d’affichage du site.

    Type de données : chaîne
    result.reservableUnits.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.reservableUnits.standard_services
    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

    "standard_services": [
  {
    "font_awesome_icon": "String",
    "name": "String",
    "short_description": "String",
    "sys_id": "String"
  }
]
    result.reservableUnits.standard_services.font_awesome_icon Nom de l’icône de miniature associée au service standard.

    Type de données : chaîne
    result.reservableUnits.standard_services.name Nom de l’icône de miniature associée au service standard.

    Type de données : chaîne
    result.reservableUnits.standard_services.short_description Brève description du service standard.

    Type de données : chaîne
    result.reservableUnits.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.reservableUnits.sys_id Sys_id de l’enregistrement réservable. Situé dans la table Emplacement du lieu de travail [sn_wsd_core_workplace_location].

    Type de données : chaîne
    result.reservableUnits.tableName Nom de la table dans laquelle se trouve l’enregistrement réservable.

    Type de données : chaîne
    résultat.unitésréservables.title Titre de l’élément réservable.

    Type de données : chaîne
    result.totalProcessed Nombre total d’enregistrements traités.

    Type de données : nombre

    Demande cURL

    Cet exemple montre comment rechercher des réservables à l’aide de ce point de terminaison. Remarque : Des sauts de ligne ont été ajoutés aux paramètres de requête pour faciliter la lecture.

    curl "https://instance.servicenow.com/api/sn_wsd_rsv/search/reservable?
reservable_module=d9864189c3653910977396cb05013100&
start=2023-10-12T10:30:00Z&
end=2023-10-13T11:30:00Z&
include_standard_services=true&
include_reservable_purposes=true&
include_reservations_within_days=true&
include_unavailable_items=true&
near_by_location_id=undefined&
timezone=Europe/Paris&
page_size=6&
sort_by=a_z&
view=schedule&
rsv_path=browse_all&
ignore_same_day_validation=true&
schedule_view_obj={"schedule_view_date":"2023-10-12","timezone":"Europe/Paris"}&
q=building=dea39b1977220110b3d7be377b5a9955\
--request GET \
--header "Accept:application/json" 
--user "username":"password"

    Résultats renvoyés :

    {
  "result": {
    "hasMore": true,
    "reservableUnits": [
      {
        "sys_id": "fe1f744edb7650106c731dcd139619ca",
        "external_id": null,
        "email": null,
        "name": "Aspen",
        "title": "Aspen",
        "description": "A room with large windows, dark leather seats and a large wooden table.",
        "image": {
          "sys_id": "41c74902dbb650106c731dcd13961944",
          "link": "41c74902dbb650106c731dcd13961944.iix"
        },
        "number": "ROOM0000903",
        "site": {
          "sys_id": "628eec06db7650106c731dcd139619dd",
          "display_value": "North America"
        },
        "campus": {
          "sys_id": "82b2a0cedb3650106c731dcd139619e9",
          "display_value": "California Campus"
        },
        "building": {
          "sys_id": "94e264cedb3650106c731dcd13961919",
          "display_value": "CAL-B1"
        },
        "floor": {
          "sys_id": "2f554296dbba10106c731dcd139619ed",
          "display_value": "Floor 2"
        },
        "area": null,
        "capacity": "16",
        "reservable_quantity": null,
        "location_type": {
          "sys_id": "20713b83eb512010b89bfdfc9c522899",
          "display_value": "Room",
          "name": "Room"
        },
        "order": null,
        "requires_check_in": null,
        "is_reservable": "1",
        "tableName": "sn_wsd_core_room",
        "require_approval": false,
        "standard_services": [
          {
            "sys_id": "9b01458edb7650106c731dcd13961945",
            "name": "Flip chart",
            "short_description": "Flip chart with paper sheets",
            "font_awesome_icon": "fa-calendar-o"
          }
        ],
        "reservable_purposes": [
          {
            "sys_id": "18f4c3cd1ba4e01051848489cc4bcb82",
            "name": "Board room",
            "short_description": null
          }
        ],
        "is_available": true,
        "reservations": [
          {
            "sys_id": "5fe65830874bc9106342b846dabb352b",
            "number": "WRES0001001",
            "location": {
              "location": "fe1f744edb7650106c731dcd139619ca",
              "timezone": {
                "value": "US/Pacific",
                "displayValue": "US/Pacific"
              }
            },
            "configuration_item": null,
            "start": "2022-04-23T08:30:00Z",
            "end": "2022-04-23T09:30:00Z",
            "subject": null,
            "reservation_purpose": {
              "value": "meeting",
              "display_value": "Meeting"
            },
            "state": {
              "value": "confirmed",
              "display_value": "Confirmed"
            },
            "is_collided": false,
            "requested_for": {
              "sys_id": "2de07e1887cb89106342b846dabb35fe",
              "name": "Workplace User"
            }
          }
        ],
        "availableTimes": [
          [
            "2022-04-23 07:00:00",
            "2022-04-23 08:30:00"
          ],
          [
            "2022-04-23 09:30:00",
            "2022-04-23 23:00:00"
          ]
        ],
       "is_reserved": true,
       "is_selected": true,
        "includedInResult": true,
        "is_favorite": false
      }
    ],
    "reservableContainers": [],
    "nextItemIndex": -1,
    "filter": {
      "floors": [],
      "standard_services": [
        {
          "sys_id": "9b01458edb7650106c731dcd13961945",
          "name": "Flip chart",
          "short_description": "Flip chart with paper sheets",
          "font_awesome_icon": "fa-calendar-o"
        }
      ],
      "reservable_purposes": [
        {
          "sys_id": "18f4c3cd1ba4e01051848489cc4bcb82",
          "name": "Board room",
          "short_description": null
        }
      ]
    },
    "totalProcessed": 2,
    "nextFavIndex": 0
  }
}

    Recherche WSD : GET /api/sn_wsd_rsv/search/shift/{building_id}/{module_id}

    Renvoie une requête codée que vous pouvez utiliser pour rechercher des équipes disponibles dans la table Équipe [sn_wsd_core_shift].

    Applicable uniquement si le champ appy_to_shift du module réservable spécifié est activé. Dans le cas contraire, la chaîne de requête codée renvoyée sera vide.

    Format d'URL

    URL versionnée : /api/sn_wsd_rsv/{api_version}/search/shift/{building_id}/{module_id}

    URL par défaut : /api/sn_wsd_rsv/search/shift/{building_id}/{module_id}

    Paramètres de demande pris en charge

    Tableau 25. 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
    building_id Sys_id du bâtiment à inclure dans la requête de recherche. Situé dans la table Bâtiment [sn_wsd_core_building].

    Type de données : chaîne
    module_id Sys_id du module réservable à inclure dans la requête de recherche. Situé dans la table Module réservable [sn_wsd_core_reservable_module]. Un module réservable regroupe des types similaires d’éléments du lieu de travail, tels que des chaises ou des bureaux.

    Type de données : chaîne
    Tableau 26. Paramètres de requête
    Nom Description
    Néant
    Tableau 27. Paramètres de corps de demande
    Nom Description
    end_date Date et heure de fin de l’équipe à inclure dans la requête codée.

    Type de données : chaîne

    Format : aaaa-mm-jj hh :mm :ss
    start_date Date et heure de début de l’équipe à inclure dans la requête codée.

    Type de données : chaîne

    Format : aaaa-mm-jj hh :mm :ss

    En-têtes

    Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir 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 28. 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 29. 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 30. 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 Requête codée à utiliser pour acquérir les équipes disponibles spécifiées.

    Type de données : objet

    "result": { 
  "moduleHasShift" : Boolean,
  "query": "String"
}
    moduleHasShift Marqueur indiquant si des équipes sont activées pour le module réservable spécifié.
    Valeurs valides :
    • true : des équipes sont activées dans le module réservable.
    • false : le module réservable n’a pas d’équipes activées. Aucune requête codée n’a été renvoyée.

    Type de données : booléennes
    query Requête codée à utiliser pour récupérer les informations sur l’équipe du module réservable spécifié.

    Type de données : chaîne

    Demande cURL

    L’exemple de code suivant montre comment utiliser ce point de terminaison pour obtenir une requête codée d’équipe.

    curl "https://instance.servicenow.com/api/sn_wsd_rsv/search/shift/94e264cedb3650106c731dcd13961919/fc71f64fdb42a01097acc900399619a8?start_date=2022-04-23 16:00:00&end_date=2022-04-28 16:00:00"  \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

    Résultats renvoyés :

    {
  "result": { 
    "moduleHasShift" : true,
    "query" : "active=true^state=2^building=94e264cedb3650106c731dcd13961919^building.is_reservable=true^building.active=true^floorISEMPTY^ORfloor.is_reservable=true^floorISEMPTY^ORfloor.active=true^start<=2022-04-26 16:00:00^ORstartISEMPTY^end>=2022-04-28 16:00:00^ORendISEMPTY^start<=2022-04-28 16:00:00^ORstartISEMPTY^end>=2022-04-28 16:00:00^ORendISEMPTY"
  }
}

    Recherche WSD - POST /api/sn_wsd_rsv/search/availability_score

    Renvoie un score de disponibilité pour les éléments réservables pour les créneaux horaires spécifiés.

    Format d'URL

    URL versionnée : /api/sn_wsd_rsv/{api_version}/search/availability_score

    URL par défaut : /api/sn_wsd_rsv/search/availability_score

    Paramètres de demande pris en charge

    Tableau 31. 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 32. Paramètres de requête
    Nom Description
    Néant
    Tableau 33. Paramètres de corps de demande
    Nom Description
    recurringPattern Requis si startEndDateTimes le paramètre n’est pas spécifié. Modèle récurrent à utiliser pour rechercher des réservables disponibles pour les événements récurrents spécifiés.

    Type de données : objet

    "recurringPattern": {
  "duration": Number,
  "label": "String",
  "options": {Object},
  "repeats": "String",
  "startDate": "String"
}
    recurringPattern.duration Requis. Durée pendant laquelle le réservable doit être disponible.

    Type de données : nombre

    Unité : millisecondes
    recurringPattern.label Description du modèle récurrent, comme Se répète quotidiennement, 5 fois.

    Type de données : chaîne
    recurringPattern.options Options de disponibilité pour la réservation récurrente à rechercher.

    Type de données : objet

    "options": {
  "count": Number,
  "daysOfWeek": "String",
  "endDate": "String",
  "every": Number
}
    recurringPattern.options.count Requis si endDate non réussi. Si les deux sont réussis, count est utilisé. Nombre de fois que le modèle de réunion doit être répété.

    Type de données : nombre
    recurringPattern.options.daysOfWeek Requis si le recurringPattern.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 repeat 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.endDate Requis si recurringPattern.options.count non réussi. Si les deux sont réussis, count est utilisé. 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.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.repeats Requis. Modèle répétitif pour l’élément réservable.
    Valeurs valides (sensibles à 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
    ID réservables Requis. Liste des sys_ids des réservables à inclure dans le score de disponibilité. Situé dans la table Emplacement du lieu de travail [sn_wsd_core_workplace_location].

    Type de données : tableau
    Type réservable Requis. Type d’élément réservable à inclure dans le score de disponibilité. Permet d’affiner la recherche.
    Valeurs valides (sensibles à la casse) :
    • emplacement
    • configuration_item

    Type de données : chaîne
    startEndDateTimes Liste des dates et heures de début et de fin dans le fuseau horaire de l’utilisateur sur lesquelles effectuer la recherche.

    Type de données : tableau d’objets

    "startEndDateTimes": [
  {
    "end": "String",
    "start": "String"
  }
]

    Par défaut : doit spécifier un recurringPattern paramètre.
    startEndDateTimes.end Date et heure de fin de l’élément réservable.

    Type de données : chaîne

    Format : aaaa-mm-jj hh :mm :ss
    startEndDateTimes.start Date et heure de début de l’élément réservable.

    Type de données : chaîne

    Format : aaaa-mm-jj hh :mm :ss

    En-têtes

    Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir 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 34. 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 35. 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 36. 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 Renvoie les résultats pour le score de disponibilité spécifié.

    Type de données : objet

    "result": {
  "reservable_sys_id": {
    "available": Number,
    "score": "String",
    "total": Number
  }
}
    résultat.disponible Nombre d’éléments réservables disponibles répondant aux critères de recherche spécifiés.

    Type de données : nombre
    score.résultat Score de disponibilité. Nombre d’éléments réservables disponibles sur le nombre total d’éléments réservables répondant aux critères de recherche spécifiés. Par exemple, si available est 2 et total est 4, la score valeur est 2/4.

    Type de données : chaîne
    résultat.total Nombre total d’éléments réservables répondant aux critères de recherche spécifiés.

    Type de données : nombre

    Demande cURL

    L’exemple de code suivant montre comment appeler ce point de terminaison.

    curl "https://instance.servicenow.com/api/sn_wsd_rsv/search/availability_score" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
  \"reservableType\": \"location\",
  \"reservableIds\": [
    \"fe1f744edb7650106c731dcd139619ca\",
    \"5eafb44edb7650106c731dcd13961943\"
  ],
  \"recurringPattern\": {
    \"duration\": 3600000,
    \"repeats\": \"daily\",
    \"options\": {
      \"count\": 150,
      \"daysOfWeek\": \"\",
      \"every\": 1
    },
    \"label\": \"Repeats daily, 5 times\",
    \"startDate\": \"2022-04-26T14:00:00Z\"
  },
  \"startEndDateTimes\": [
    {
      \"start\": \"2022-07-05 14:00:00\",
      \"end\": \"2022-07-05 15:00:00\"
    },
    {
      \"start\": \"2022-07-06 14:00:00\",
      \"end\": \"2022-07-06 15:00:00\"
    }
  ]
}" \
--user "username":"password"

    Résultats renvoyés :

    {
  "result": {
    "fe1f744edb7650106c731dcd139619ca": {
      "available": 2,
      "total": 2,
      "score": "2/2"
    },
    "5eafb44edb7650106c731dcd13961943": {
      "available": 2,
      "total": 2,
      "score": "2/2"
    }
  }