API de demande de service supplémentaire WSD

  • Rversion finale: Xanadu
  • Mis à jour 1 août 2024
  • 5 minutes de lecture

    • L’API Prestation de services sur le lieu de travailde demande de service supplémentaire (WSD) fournit des points de terminaison pour gérer les demandes de service supplémentaire pour les réservations.

    Pour accéder à cette API, l’appelant doit disposer du rôle sn_wsd_core.workplace_user.

    Cette API s’exécute dans l’espacede noms sn_wsd_rsv .

    Pour plus d’informations sur , reportez-vous à Gestion des réservations du lieu de travailla rubrique Gestion des réservations du lieu de travail.

    Service supplémentaire WSD : GET /sn_wsd_rsv/extra_service/list_loc_layouts

    Renvoie les détails sur les dispositions d’emplacement associées pour un emplacement de lieu de travail spécifié.

    Format d'URL

    URL versionnée : /api/sn_wsd_rsv/{api_version}/extra_service/list_loc_layouts

    URL par défaut : /api/sn_wsd_rsv/extra_service/list_loc_layouts

    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
    emplacement Requis. Sys_id de l’emplacement du lieu de travail pour lequel renvoyer les détails de la disposition de l’emplacement.

    Situé dans la table Emplacement du lieu de travail [sn_wsd_core_workplace_location].

    Type de données : chaîne
    Tableau 3. Paramètres du corps de la demande
    Nom Description
    Aucun Requis.

    En-têtes

    Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

    Tableau 4. 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 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 la 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.
    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.
    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 des mises en page associées à l’emplacement du lieu de travail spécifié.

    Type de données : tableau d’objets

    "result": [
  {
    "capacity": Number,
    "cleanup_duration": "String",
    "image": {Object},
    "is_default": Boolean,
    "max_capacity": Number,
    "name": "String",
    "preparation_duration": "String",
    "short_description": "String",
    "sys_id": "String"
  }
]
    résultat.capacité Nombre de personnes qui participeront à la réunion.

    Type de données : nombre
    result.cleanup_duration Durée nécessaire pour nettoyer le réservable pour cette mise en page.

    Type de données : nombre

    Unité : Millisecondes
    résultat.image Détails sur une image qui représente la mise en page du réservable associé.

    Situé dans la table Images [db_image].

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

    Type de données : chaîne
    result.is_default Marqueur indiquant si la mise en page associée est celle par défaut pour le réservable.
    Valeurs valides :
    • true : valeur par défaut.
    • false : non par défaut.

    Type de données : booléennes
    result.name Nom de l’aménagement de l’emplacement.

    Type de données : chaîne
    result.max_capacité Nombre maximum de personnes que la mise en page associée au réservable peut accueillir.

    Type de données : nombre
    result.preparation_duration Durée nécessaire à la préparation de la disposition de l’emplacement associée.

    Type de données : nombre

    Unité : Millisecondes
    result.short_description Brève description de la disposition de l’emplacement.

    Type de données : chaîne
    result.sys_id Sys_id de la disposition de l’emplacement.

    Situé dans la table Mise en page [sn_wsd_rsv_layout].

    Type de données : chaîne

    Demande cURL

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

    "http://instance.servicenow.com/api/sn_wsd_rsv/extra_service/list_loc_layouts&location=d2716d4adb7210106c731dcd13961994" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

    Résultats renvoyés :

    {
  "result": [
    {
      "sys_id": "f4fee556534301103cf7ddeeff7b12ed",
      "name": "Test",
      "short_description": "test",
      "is_default": false,
      "image": {
        "sys_id": "9648a7c5531301103cf7ddeeff7b1286",
        "link": "9648a7c5531301103cf7ddeeff7b1286.iix"
      },
      "capacity": null,
      "max_capacity": null,
      "preparation_duration": 172800000,
      "cleanup_duration": 86400000
    }
  ]
}

    Service supplémentaire WSD : GET /api/sn_wsd_rsv/extra_service/list_loc_standard_services

    Renvoie les détails sur les services standard associés pour un emplacement de lieu de travail spécifié.

    Format d'URL

    URL versionnée : /api/sn_wsd_rsv/{api_version}/extra_service/list_loc_standard_services

    URL par défaut : /api/sn_wsd_rsv/extra_service/list_loc_standard_services

    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
    emplacement Requis. Sys_id de l’emplacement du lieu de travail pour lequel renvoyer les services standard d’agencement d’emplacement.

    Situé dans la table Emplacement du lieu de travail [sn_wsd_core_workplace_location].

    Type de données : chaîne
    Tableau 9. Paramètres du corps de la demande
    Nom Description
    Aucun

    En-têtes

    Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

    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 la 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.
    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.
    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
    result.standard_services
    Services standard associés, tels que tableau de conférence, écran de projection, tableau blanc et marqueurs.

    Type de données : tableau d’objets

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

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

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

    Type de données : chaîne
    result.standard_services.sys_id Sys_id des états de service standard. Situé dans la table Service standard [sn_wsd_rsv_standard_service].

    Type de données : chaîne

    Demande cURL

    L’exemple de code suivant montre comment appeler ce point de terminaison pour obtenir les services standard.

    "http://instance.servicenow.com/api/sn_wsd_rsv/extra_service/list_loc_standard_services&location=d2716d4adb7210106c731dcd13961994" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

    Résultats renvoyés :

    {
  "result": [
    {
      "sys_id": "9b01458edb7650106c731dcd13961945",
      "name": "Flip chart",
      "short_description": "Flip chart with paper sheets",
      "font_awesome_icon": "fa-calendar-o"
    },
    {
      "sys_id": "abd0c18edb7650106c731dcd13961965",
      "name": "Projector screen",
      "short_description": "Connect laptop to screen (HDMI and DVI)",
      "font_awesome_icon": "fa-caret-square-o-right"
    },
    {
      "sys_id": "9841858edb7650106c731dcd1396193c",
      "name": "Whiteboard",
      "short_description": "Whiteboard and markers",
      "font_awesome_icon": "fa-pencil-square-o"
    }
  ]
}