API d’équipe WSD

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

    • L’API Prestation de services sur le lieu de travaild’équipe (WSD) fournit un point de terminaison qui renvoie les intervalles de temps d’équipe pour une date et une heure spécifiées.

    Pour accéder à cette API, l’appelant doit avoir le 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 , reportez-vous à Gestion des réservations du lieu de travailla rubrique Gestion des réservations du lieu de travail.

    Décalage WSD : GET /api/sn_wsd_rsv/wsd_shift/{shift_id}/timespan

    Renvoie l’intervalle de temps de l’équipe pour une date/heure et une équipe spécifiées.

    Format d'URL

    URL versionnée : /api/sn_wsd_rsv/{api_version}/wsd_shift/{shift_id}/timespan

    URL par défaut : /api/sn_wsd_rsv/wsd_shift/{shift_id}/timespan

    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
    shift_id Sys_id de l’équipe pour récupérer l’intervalle de temps. Situé dans la table Équipe [sn_wsd_core_shift].

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

    Type de données : chaîne
    Tableau 2. Paramètres de requête
    Nom Description
    attempt_earlier_start

    Marqueur indiquant s’il faut définir une heure de début anticipée si la valeur de début spécifiée est comprise dans l’intervalle de temps de l’équipe.

    Valeurs valides :
    • vrai : si l’équipe spécifiée inclut la date/l’heure spécifiée dans le start paramètre, renvoyez la date/l’heure de début spécifiée comme début de l’intervalle de temps.
    • false : renvoie l’intervalle de temps de l’équipe comme défini dans l’enregistrement associé.

    Type de données : booléennes

    Valeur par défaut : false
    début Requis. Date et heure de début de l’équipe Intervalles de temps pour revenir.

    Format : UTC - aaaa-mm-jjThh :mm :ssZ, comme 2022-05-23T08:00:00Z
    fuseau horaire Fuseau horaire à utiliser lors de la qualification des intervalles de temps de l’équipe, par exemple ECT ou PST. Renvoie également les intervalles de temps de l’équipe dans ce fuseau horaire.

    Format : UTC

    Type de données : chaîne

    Par défaut : fuseau horaire de l’utilisateur
    Tableau 3. 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 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 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 sur l’intervalle de temps de l’équipe qui correspondait aux critères de recherche.

    Type de données : objet

    "result":{
  "end": "String",
  "start": "String"
}
    résultat.fin Date et heure de fin de l’intervalle de temps de l’équipe dans le fuseau horaire spécifié.

    Format : UTC : aaaa-mm-jjThh :mm :ssZ, comme 2022-05-23T08:00:00Z

    Type de données : chaîne
    résultat.début Date et heure de début de l’équipe dans le fuseau horaire spécifié.

    Format : UTC : aaaa-mm-jjThh :mm :ssZ, comme 2022-05-23T08:00:00Z

    Type de données : chaîne

    Demande cURL

    L’exemple de code suivant montre comment récupérer l’intervalle de temps d’une équipe.

    curl "https://instance.servicenow.com/api/sn_wsd_rsv/wsd_shift/e5d23acfdb42a01097acc9003996193a/timespan?attempt_earlier_start=true&start=2022-05-23T08:00:00Z&timezone=ECT" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

    Résultats renvoyés :

    {
  "result": {
    "start": "2022-05-23T08:00:00Z",
    "end": "2022-05-23T15:00:00Z"
  }
}