API de réservations multiples WSD

  • Rversion finale: Yokohama
  • Mis à jour 30 janv. 2025
  • 16 minutes de lecture

    • L’API Prestation de services de lieu de travail (WSD) Multi Reservation fournit des points de terminaison pour la gestion des réservations avec plusieurs emplacements de lieu de travail.

    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 Gestion des réservations du lieu de travail, voir Gestion des réservations du lieu de travail.

    Réservation multiple WSD : PATCH /api/sn_wsd_rsv/multi_reservation/cancel/{sys_id}

    Annule une réservation multiple spécifiée.

    Format d'URL

    URL versionnée : /api/sn_wsd_rsv/{api_version}/multi_reservation/cancel/{sys_id}

    URL par défaut : /api/sn_wsd_rsv/multi_reservation/cancel/{sys_id}

    Remarque :
    Les versions disponibles sont spécifiées dans l’explorateur d’API REST. Pour les API REST basées sur un script, des informations de version supplémentaires sont disponibles sur le formulaire Service REST scripté.

    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. Par exemple, v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison différente de la dernière.

    Type de données : chaîne
    sys_id Sys_id de la multi-réservation à annuler.

    Type de données : chaîne

    Table : Réservation du lieu de travail [sn_wsd_rsv_reservation]
    Tableau 2. Paramètres de requête
    Nom Description
    Néant
    Tableau 3. Paramètres du corps de la demande
    Nom Description
    cancel_notes Motif d’annulation de la réservation.

    Type de données : chaîne

    En-têtes

    Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir 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 demande. Types pris en charge : application/json, application/xml ou, text/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 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.
    401 Non autorisé. Les informations d'identification de l'utilisateur sont incorrectes ou n'ont pas été transmises.
    404 Introuvable. L’élément demandé est introuvable.
    500 Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur.

    Paramètres du corps de réponse

    Nom Description
    résultat Détails des résultats de la demande d’annulation.

    Type de données : objet

    "result": {
  "error": "String",
  "parent": "String",
  "success": Boolean,
  "successfulReservations": [Array],
  "unSuccessfulReservations": [Array]
}
    résultat.erreur Message décrivant l’erreur associée.

    Type de données : chaîne
    résultat.parent Sys_id de la réservation parente. Une ou plusieurs réservations enfants peuvent être associées à un parent.

    Type de données : chaîne
    Résultat.Réussite Marqueur indiquant si la réservation a été annulée.
    Valeurs possibles :
    • vrai : annulation réussie.
    • faux : la réservation n’a pas été annulée.

    Type de données : booléennes
    résultat.réservations réussies Détails sur l’annulation réussie de la réservation multiple.

    Type de données : tableau d’objets

    "successfulReservations": [
  {
    "msg": "String",
    "success": Boolean,
    "sys_id": "String"
  }
]
    result.successfulReservations.msg Message d’annulation.

    Type de données : chaîne
    résultat.réservationsréussies.réussite Marqueur indiquant si la réservation a été annulée.
    Valeurs possibles :
    • vrai : annulation réussie.
    • faux : échec de l’opération.

    Type de données : booléennes
    result.successfulReservations.sys_id Sys_id de la réservation qui a été annulée.

    Type de données : chaîne

    Table : Réservation du lieu de travail [sn_wsd_rsv_reservation]
    résultat.unSuccessfulReservations Détails sur l’échec de l’annulation de la réservation multiple.

    Type de données : tableau d’objets

    "unSuccessfulReservations": [
  {
    "msg": "String",
    "success": Boolean,
    "sys_id": "String"
  }
]
    result.unSuccessfulReservations.msg Message d’annulation.

    Type de données : chaîne
    résultat.unSuccessfulReservations.success Marqueur indiquant si la réservation a été annulée.
    Valeurs possibles :
    • vrai : annulation réussie.
    • faux : échec de l’opération.

    Type de données : booléennes
    result.unSuccessfulReservations.sys_id Sys_id de la réservation qui n’a pas été annulée.

    Type de données : chaîne

    Table : Réservation du lieu de travail [sn_wsd_rsv_reservation]

    Demande cURL

    L’exemple de code suivant montre comment annuler une réservation multiple.

    curl "https://instance.servicenow.com/api/sn_wsd_rsv/multi_reservation/cancel/1b1fdf5987ab01506342b846dabb35ec" \
--request PATCH \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{\"cancel_notes\":\"Meeting no longer needed.\"}" \ 
--user "username":"password’"

    Renvoyer les résultats :

    {
  "result": {
    "success": true,
    "successfulReservations": [
      {
        "success": true,
        "msg": "Cancelled successfully.",
        "sys_id": "5b1f9f1d87ab01506342b846dabb35a4"
      },
      {
        "success": true,
        "msg": "Cancelled successfully.",
        "sys_id": "931f9f1d87ab01506342b846dabb35a0"
      }
    ],
    "unSuccessfulReservations": [],
    "error": null,
    "parent": "1b1fdf5987ab01506342b846dabb35ec"
  }
}

    Réservation multiple WSD : PATCH /api/sn_wsd_rsv/multi_reservation/update/{sys_id}

    Met à jour les réservations associées à une réservation multiple où la même réservation (réunion) a plusieurs emplacements de lieu de travail.

    Ce point de terminaison peut gérer quatre scénarios de mise à jour différents :
    1. Mettez à jour le contenu de l’enregistrement de plusieurs réservations, tel que l’objet, la date ou l’heure.
    2. Convertissez la multi-réservation en une seule réservation basée sur le parent (réservation pour un seul emplacement de lieu de travail).
    3. Convertissez une réservation unique (réservation pour un seul emplacement de lieu de travail) en une réservation multiple.
    4. Ajoutez ou supprimez un emplacement de lieu de travail à une réservation multiple.

    Format d'URL

    URL versionnée : /api/sn_wsd_rsv/{api_version}/multi_reservation/update/{sys_id}

    URL par défaut : /api/sn_wsd_rsv/multi_reservation/update/{sys_id}

    Remarque :
    Les versions disponibles sont spécifiées dans l’explorateur d’API REST. Pour les API REST basées sur un script, des informations de version supplémentaires sont disponibles sur le formulaire Service REST scripté.

    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. Par exemple, v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison différente de la dernière.

    Type de données : chaîne
    sys_id Sys_id de la réservation à mettre à jour.
    • De la réservation simple à la réservation multiple : Sys_id de la réservation unique.

      Table : Réservation du lieu de travail [sn_wsd_rsv_reservation]

    • Mettre à jour le contenu de la réservation multiple : Sys_id de l’enregistrement de réservation parent.

      Table : Réservation du lieu de travail [sn_wsd_rsv_reservation]

    Pour obtenir les détails d’une réservation parente multiple à partir de l’enregistrement enfant, consultez les sys_id dans le champ source_reservation de l’enregistrement enfant.

    Type de données : chaîne
    Tableau 8. Paramètres de requête
    Nom Description
    Néant
    Tableau 9. Paramètres du corps de la demande
    Nom Description
    fin Requis si le shift paramètre n’est pas transmis. Heure de fin demandée de la réservation.

    Type de données : chaîne

    Format : UTC ou heure locale (aaaa-mm-jj hh :mm :ss)
    requested_for Sys_id ou adresse e-mail de l’utilisateur pour lequel la réservation est effectuée.

    Type de données : chaîne

    Table : Utilisateur [sys_user]
    réservables Liste de détails sur les réservables associés à la réservation.

    Type de données : tableau d’objets

    "reservables": [
  {
    "is_private": Boolean,
    "sys_id": "String"
  }
]
    reservables.is_private Marqueur indiquant si la réservation est privée. Si elle est privée, la réservation n’apparaît à personne d’autre qu’au propriétaire.

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

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

    Type de données : booléennes

    Par défaut : valeur définie pour la confidentialité dans les propriétés système.
    reservables.sys_id Sys_id de l’emplacement où effectuer les réservations.

    Type de données : chaîne

    Table : Emplacement du lieu de travail [sn_wsd_core_workplace_location]
    reservable_module Requis. Sys_id du module réservable à associer à la réservation. Un module réservable définit les éléments sur le lieu de travail nécessaires pour une réservation.

    Type de données : chaîne

    Table : module réservable [sn_wsd_rsv_reservable_module]
    Période de travail
    Sys_id de l’équipe à associer à la réservation. Si ce paramètre est transmis, il end n’est pas obligatoire.

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

    Type de données : chaîne

    Table : Équipe [sn_wsd_core_shift]
    début Requis. Heure de début demandée de la réservation.

    Type de données : chaîne

    Format : UTC ou heure locale (aaaa-mm-jj hh :mm :ss)
    objet
    Objet de la réunion associée à la réservation.

    Type de données : chaîne

    En-têtes

    Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir 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 demande. Types pris en charge : application/json, application/xml ou, text/xml.

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

    Codes d'état

    Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir 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.
    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 création ou de la mise à jour de plusieurs réservations.

    Type de données : objet

    "result": {
  "parent": "String",
  "success": Boolean,
  "successfulReservations": [Array],
  "unSuccessfulReservations": [Array]
}
    résultat.parent Sys_id de la réservation parente. Une ou plusieurs réservations enfants peuvent être associées à un parent.

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

    Type de données : booléennes
    résultat.réservations réussies Liste des réservations créées.

    Type de données : tableau d’objets

    "successfulReservations": [
  {
    "cancelled": Boolean,
    "error": "String",
    "reservable": "String"
    "success": Boolean,
    "sys_id": "String",
    "updated": Boolean
  }
]
    résultat.réservationsréussies.annulées Marqueur indiquant si la réservation a été annulée.
    Valeurs possibles :
    • vrai : annulation réussie.
    • faux : non annulé.

    Type de données : booléennes
    résultat.réservationsréussies.erreur Message d’erreur en cas de problème lors de la création de la réservation.

    Type de données : chaîne
    résultat. Reservations.insert réussies Marqueur indiquant si la réservation a été insérée avec succès. Par exemple, lorsqu’une réservation est ajoutée.
    Valeurs possibles :
    • vrai : inséré avec succès.
    • faux : échec de l’opération.

    Type de données : booléennes
    résultat.réservationsréussies.réservable Sys_id du lieu de travail pour lequel la réservation a été effectuée.

    Type de données : chaîne

    Table : Emplacement du lieu de travail [sn_wsd_core_workplace_location]
    résultat.réservationsréussies.réussite Marqueur indiquant si l’opération associée a réussi.
    Valeurs possibles :
    • vrai : l’opération a réussi.
    • faux : échec de l’opération.

    Type de données : booléennes
    result.successfulReservations.sys_id Sys_id de la réservation qui a été créée.

    Type de données : chaîne

    Table : Réservation du lieu de travail [sn_wsd_rsv_reservation]
    résultat.réservationsréussies.mise à jour Marqueur indiquant si la réservation a été mise à jour avec succès.
    Valeurs possibles :
    • vrai : mise à jour réussie.
    • false : non mis à jour.

    Type de données : booléennes
    résultat.unSuccessfulReservations Liste des réservations qui ont échoué.

    Type de données : tableau d’objets

    "unSuccessfulReservations": [
  {
    "cancelled": Boolean,
    "error": "String",
    "insert": Boolean
    "reservable": "String"
    "success": Boolean,
    "sys_id": "String",
    "updated": Boolean
  }
]
    résultat.unSuccessfulReservations.cancelled Marqueur indiquant si la réservation a été annulée.
    Valeurs possibles :
    • vrai : annulation réussie.
    • faux : non annulé.

    Type de données : booléennes
    résultat.unSuccessfulReservations.error Message d’erreur en cas de problème lors de la création de la réservation.

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

    Type de données : booléennes
    résultat.unSuccessfulReservations.reservable Sys_id du lieu de travail pour lequel la réservation a été effectuée.

    Type de données : chaîne

    Table : Emplacement du lieu de travail [sn_wsd_core_workplace_location]
    résultat.unSuccessfulReservations.success Marqueur indiquant si la réservation a été créée avec succès.
    Valeurs possibles :
    • vrai : créé avec succès.
    • faux : échec de l’opération.

    Type de données : booléennes
    result.unSuccessfulReservations.sys_id Sys_id de l’échec de la réservation.

    Toujours nul.

    Type de données : chaîne
    résultat.unSuccessfulReservations.update Marqueur indiquant si la réservation a été mise à jour avec succès.
    Valeurs possibles :
    • vrai : mise à jour réussie.
    • false : non mis à jour.

    Type de données : booléennes

    Demande cURL

    L’exemple de code suivant montre comment modifier le contenu d’une réservation multiple existante.

    curl "https://instance.servicenow.com/api/sn_wsd_rsv/multi_reservation/update/02000d4edb7650106c731dcd13961914" \
--request PATCH \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
    \"reservables\":[
        { 
            \"sys_id\":\"fe1f744edb7650106c731dcd139619ca\" 
        }, 
        {
            \"sys_id\":\"02000d4edb7650106c731dcd13961914\"
        }
    ],
    \"reservable_module\":\"c31241cedb7650106c731dcd13961917\",
    \"subject\":\"Test 1\",
    \"start\":\"2022-05-27 13:00:00\",
    \"end\":\"2022-05-27 14:00:00\",
    \"requested_for\": \"workplace_user@example.com\"
}" \
--user 'username':'password'

    Renvoyer les résultats :

    {
  "result": {
    "parent": "98ccb4348723cd106342b846dabb359a",
    "success": true,
    "successfulReservations": [
      {
        "success": true,
        "updated": true,
        "cancelled": false,
        "sys_id": "6cccb4348723cd106342b846dabb359d",
        "error": null,
        "reservable": "5eafb44edb7650106c731dcd13961943"
      },
      {
        "success": true,
        "updated": true,
        "cancelled": false,
        "sys_id": "74af283c87ef8d106342b846dabb3592",
        "error": null,
        "reservable": "fe1f744edb7650106c731dcd139619ca"
      }
    ],
    "unSuccessfulReservations": []
  }
}

    Demande cURL

    L’exemple de code suivant montre comment ajouter un emplacement de lieu de travail à une réservation multiple.

    curl "https://instance.servicenow.com/api/sn_wsd_rsv/multi_reservation/update/02000d4edb7650106c731dcd13961914" \
--request PATCH \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
   \"reservables\":[
       { 
           \"sys_id\":\"fe1f744edb7650106c731dcd139619ca\",
           \"is_private\": false 
       }, 
       {
           \"sys_id\":\"5eafb44edb7650106c731dcd13961943\",
           \"is_private\": false
       },
    {
           \"sys_id\":\"c4308d4edb7650106c731dcd1396194c\",
           \"is_private\": false
       }
   ],
   \"reservable_module\":\"c31241cedb7650106c731dcd13961917\",
   \"subject\":\"Test 1\",
   \"start\":\"2022-05-27 13:00:00\",
   \"end\":\"2022-05-27 14:00:00\",
   \"requested_for\": \"workplace_user@example.com\"
}" \
--user 'username':'password'

    Renvoyer les résultats :

    {
  "result": {
    "parent": "98ccb4348723cd106342b846dabb359a",
    "success": true,
    "successfulReservations": [
      {
        "success": true,
        "updated": true,
        "cancelled": false,
        "sys_id": "6cccb4348723cd106342b846dabb359d",
        "error": null,
        "reservable": "5eafb44edb7650106c731dcd13961943"
      },
      {
        "success": true,
        "updated": true,
        "cancelled": false,
        "sys_id": "74af283c87ef8d106342b846dabb3592",
        "error": null,
        "reservable": "fe1f744edb7650106c731dcd139619ca"
      },
      {
        "success": true,
        "inserted": true,
        "sys_id": "9e6d78748723cd106342b846dabb35a5",
        "error": null,
        "reservable": "c4308d4edb7650106c731dcd1396194c"
      }
    ],
    "unSuccessfulReservations": []
  }
}

    Demande cURL

    L’exemple de code suivant montre comment convertir une réservation unique en une réservation multiple.

    curl "https://instance.servicenow.com/api/sn_wsd_rsv/multi_reservation/update/02000d4edb7650106c731dcd13961914" \
--request PATCH \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
   \"reservables\":[
       { 
           \"sys_id\":\"fe1f744edb7650106c731dcd139619ca\",
           \"is_private\": false
       }, 
       {
           \"sys_id\":\"5eafb44edb7650106c731dcd13961943\",
           \"is_private\": false
       }
   ],
   \"reservable_module\":\"c31241cedb7650106c731dcd13961917\",
   \"subject\":\"Test 1\",
   \"start\":\"2022-05-27 13:00:00\",
   \"end\":\"2022-05-27 14:00:00\",
   \"requested_for\": \"workplace_user@example.com\"
}" \
--user 'username':'password'

    Renvoyer les résultats :

    {
  "result": {
    "success": true,
    "parent": "98ccb4348723cd106342b846dabb359a",
    "successfulReservations": [
      {
        "success": true,
        "inserted": true,
        "sys_id": "6cccb4348723cd106342b846dabb359d",
        "error": null,
        "reservable": "5eafb44edb7650106c731dcd13961943"
      },
      {
        "success": true,
        "insert": false,
        "update": true,
        "cancel": false,
        "sys_id": "74af283c87ef8d106342b846dabb3592",
        "reservable": "fe1f744edb7650106c731dcd139619ca"
      }
    ],
    "unSuccessfulReservations": [],
    "error": null
  }
}

    Demande cURL

    L’exemple de code suivant montre comment convertir une réservation multiple en une seule réservation.

    curl "https://instance.servicenow.com/api/sn_wsd_rsv/multi_reservation/update/02000d4edb7650106c731dcd13961914" \
--request PATCH \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
   \"reservables\":[
       { 
           \"sys_id\":\"fe1f744edb7650106c731dcd139619ca\",
           \"is_private\": false
       }
   ],
   \"reservable_module\":\"c31241cedb7650106c731dcd13961917\",
   \"subject\":\"Test 1\",
   \"start\":\"2022-05-27 13:00:00\",
   \"end\":\"2022-05-27 14:00:00\",
   \"requested_for\": \"workplace_user@example.com\"
}" \
--user 'username':'password'

    Renvoyer les résultats :

    {
  "result": {
    "sys_id": "74af283c87ef8d106342b846dabb3592",
    "success": true,
    "successfulReservations": [
      {
        "success": true,
        "insert": false,
        "update": true,
        "cancel": false,
        "sys_id": "74af283c87ef8d106342b846dabb3592",
        "reservable": "fe1f744edb7650106c731dcd139619ca",
        "error": ""
      },
      {
        "success": true,
        "insert": false,
        "update": true,
        "cancel": true,
        "sys_id": "3caf283c87ef8d106342b846dabb3596",
        "reservable": "5eafb44edb7650106c731dcd13961943"
      }
    ],
    "unSuccessfulReservations": [],
    "error": null
  }
}

    Réservation multiple WSD : POST /api/sn_wsd_rsv/multi_reservation/add

    Crée des réservations de lieu de travail pour la même heure à différents emplacements du lieu de travail.

    Format d'URL

    URL versionnée : /api/sn_wsd_rsv/{api_version}/multi_reservation/add

    URL par défaut : /api/sn_wsd_rsv/multi_reservation/add

    Remarque :
    Les versions disponibles sont spécifiées dans l’explorateur d’API REST. Pour les API REST basées sur un script, des informations de version supplémentaires sont disponibles sur le formulaire Service REST scripté.

    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. Par exemple, v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison différente de la dernière.

    Type de données : chaîne
    Tableau 14. Paramètres de requête
    Nom Description
    Néant
    Tableau 15. Paramètres du corps de la demande
    Nom Description
    fin Requis si le shift paramètre n’est pas transmis. Heure de fin demandée de la réservation.

    Type de données : chaîne

    Format : UTC ou heure locale (aaaa-mm-jj hh :mm :ss)
    requested_for Sys_id ou adresse e-mail de l’utilisateur pour lequel la réservation est effectuée.

    Type de données : chaîne

    Table : Utilisateur [sys_user]
    réservables Liste de détails sur les réservables associés à la réservation.

    Type de données : tableau d’objets

    "reservables": [
  {
    "is_private": Boolean,
    "sys_id": "String"
  }
]
    reservables.is_private Marqueur indiquant si la réservation est privée. Si elle est privée, la réservation n’apparaît à personne d’autre qu’au propriétaire.

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

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

    Type de données : booléennes

    Par défaut : valeur définie pour la confidentialité dans les propriétés système.
    reservables.sys_id Sys_id de l’emplacement où effectuer les réservations.

    Type de données : chaîne

    Table : Emplacement du lieu de travail [sn_wsd_core_workplace_location]
    reservable_module Requis. Sys_id du module réservable à associer à la réservation. Un module réservable définit les éléments sur le lieu de travail nécessaires pour une réservation.

    Type de données : chaîne

    Table : module réservable [sn_wsd_rsv_reservable_module]
    Période de travail
    Sys_id de l’équipe à associer à la réservation. Si ce paramètre est transmis, il end n’est pas obligatoire.

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

    Type de données : chaîne

    Table : Équipe [sn_wsd_core_shift]
    début Requis. Heure de début demandée de la réservation.

    Type de données : chaîne

    Format : UTC ou heure locale (aaaa-mm-jj hh :mm :ss)
    objet Requis.
    Objet de la réunion associée à la réservation.

    Type de données : chaîne

    En-têtes

    Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir 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 16. 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
    Content-Type Format de données du corps de la demande. Prend uniquement en charge application/json.
    Tableau 17. En-têtes de réponses
    En-tête Description
    Aucun

    Codes d'état

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

    Tableau 18. Codes d'état
    Code d'état Description
    200 Réussi. La demande a été correctement traitée.
    401 Non autorisé. Les informations d'identification de l'utilisateur sont incorrectes ou n'ont pas été transmises.
    404 Introuvable. L’élément demandé est introuvable.
    500 Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur.

    Paramètres du corps de réponse

    Nom Description
    résultat Renvoie les résultats de la création ou de la mise à jour de plusieurs réservations.

    Type de données : objet

    "result": {
  "parent": "String",
  "success": Boolean,
  "successfulReservations": [Array],
  "unSuccessfulReservations": [Array]
}
    résultat.parent Sys_id de la réservation parente. Une ou plusieurs réservations enfants peuvent être associées à un parent.

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

    Type de données : booléennes
    résultat.réservations réussies Liste des réservations créées.

    Type de données : tableau d’objets

    "successfulReservations": [
  {
    "error": "String",
    "inserted": Boolean,
    "reservable": "String"
    "success": Boolean,
    "sys_id": "String"
  }
]
    résultat.réservationsréussies.erreur Message d’erreur en cas de problème lors de la création de la réservation.

    Type de données : chaîne
    résultat.réservationsréussies.insérées Marqueur indiquant si la réservation a été insérée avec succès. Par exemple, lorsqu’une réservation est ajoutée.
    Valeurs possibles :
    • vrai : inséré avec succès.
    • faux : échec de l’opération.

    Type de données : booléennes
    résultat.réservationsréussies.réservable Sys_id du lieu de travail pour lequel la réservation a été effectuée.

    Type de données : chaîne

    Table : Emplacement du lieu de travail [sn_wsd_core_workplace_location]
    résultat.réservationsréussies.réussite Marqueur indiquant si la réservation a été créée avec succès.
    Valeurs possibles :
    • vrai : créé avec succès.
    • faux : échec de l’opération.

    Type de données : booléennes
    result.successfulReservations.sys_id Sys_id de la réservation qui a été créée.

    Type de données : chaîne

    Table : Réservation du lieu de travail [sn_wsd_rsv_reservation]
    résultat.unSuccessfulReservations Liste des réservations qui ont échoué.

    Type de données : tableau d’objets

    "unSuccessfulReservations": [
  {
    "error": "String",
    "inserted": Boolean,
    "reservable": "String"
    "success": Boolean,
    "sys_id": "String"
  }
]
    résultat.unSuccessfulReservations.error Message d’erreur en cas de problème lors de la création de la réservation.

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

    Type de données : booléennes
    résultat.unSuccessfulReservations.reservable Sys_id du lieu de travail pour lequel la réservation a été effectuée.

    Type de données : chaîne

    Table : Emplacement du lieu de travail [sn_wsd_core_workplace_location]
    résultat.unSuccessfulReservations.success Marqueur indiquant si la réservation a été créée avec succès.
    Valeurs possibles :
    • vrai : créé avec succès.
    • faux : échec de l’opération.

    Type de données : booléennes
    result.unSuccessfulReservations.sys_id Sys_id de l’échec de la réservation.

    Toujours nul.

    Type de données : chaîne

    Demande cURL

    Cet exemple de code montre comment réserver deux lieux de travail différents pour la même réservation.

    curl "https://instance.servicenow.com/api/sn_wsd_rsv/multi_reservation/add" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
    \"reservable_module\": \"c31241cedb7650106c731dcd13961917\",
    \"subject\": \"Test-123\",
    \"reservation_purpose\": \"meeting\",
    \"timezone\": \"US/Pacific\",
    \"requested_for\": \"6816f79cc0a8016401c5a33be04be441\",
    \"reservables\": [
        {
            \"sys_id\": \"fe1f744edb7650106c731dcd139619ca\",
            \"is_private\": false
        },
        {
            \"sys_id\": \"d1208d4edb7650106c731dcd1396194a\",
            \"is_private\": false
        }
    ],
    \"start\": \"2023-01-12T11:30:00Z\",
    \"end\": \"2023-01-12T12:30:00Z\",
    \"reservation_type\": \"space\"
}" \
--user "username":"password"

    Renvoyer les résultats :

    {
  "result": {
    "success": true,
    "parent": "08e8a18687586550cfaa99b73cbb354f",
    "successfulReservations": [
      {
        "success": true,
        "inserted": true,
        "sys_id": "44e8a18687586550cfaa99b73cbb3552",
        "error": null,
        "reservable": "fe1f744edb7650106c731dcd139619ca"
      },
      {
        "success": true,
        "inserted": true,
        "sys_id": "04e8a18687586550cfaa99b73cbb3555",
        "error": null,
        "reservable": "d1208d4edb7650106c731dcd1396194a"
      }
    ],
    "unSuccessfulReservations": []
  }
}