- Bienvenue sur le wiki EasyVista
- Intégrations
- API REST Service Manager
- REST API - Suspendre un ticket
REST API - Suspendre un ticket
Sommaire
PUT /requests/{rfc_number}
- Cette méthode permet de suspendre un ticket déterminé (un ticket englobe un incident, demande de service / changement / investissement, problème et événement).
exemple /requests/S161123_000034
- Pour reprendre un ticket: PUT /requests/{rfc_number} -
voir la méthode
Remarques
voir Conventions de l'API REST Service Manager
- Vous devez fournir un tableau au format JSON dans le corps de la requête HTTP.
- Vous devez utiliser un objet suspended ayant pour valeur un ensemble d’objets JSON (couples nom/valeur).
- En cas de succès, un code de statut HTTP 201 est retourné et un lien URL (HREF) vers la ressource modifiée est fourni.
CommonNotes_JSONandFields
Format JSON / Format des champs :
- Les noms de champs sont ceux du modèle de données Service Manager.
exemple available_field_1
- Pour mettre à jour un champ, respectez le format JSON suivant : "field_name":"value".
- Les noms d’objets JSON, y compris ceux représentant les champs de la base Service Manager, ne sont pas sensibles à la casse.
exemple field_name, Field_Name et FIELD_NAME sont équivalents
Liste des paramètres / champs
Paramètres obligatoires
Dans l’URL, vous devez utiliser le paramètre ci-dessous.
| Paramètre | Type | Description / Exemple |
|---|---|---|
| rfc_number | integer | Identifiant du ticket |
Paramètres optionnels
Aucun
Champs optionnels
| Paramètre | Type | Description / Exemple |
|---|---|---|
| comment | string | Commentaire |
| done_by_id | integer | Effectué par : Identifiant |
Description des actions effectuées
1. Une action de suspension est créée pour le ticket.
2. Les compteurs de temps sont mis en pause.
Codes de statut HTTP de la méthode
StatusHeader
| Code | Erreur | Description |
|---|
Status201
| 201 | Created (Créé) | Requête traitée avec succès et création d’un élément. |
Status401
| 401 | Unauthorized (Non autorisé) | Processus d'authentification pour accéder à la ressource incorrect : Login/Mot de passe incorrect, Session non valide, Compte Service Manager incorrect.
exemple { "error": "Invalid Login / Password" } |
Status404
| 404 | Not found (Non trouvée) | Ressource non trouvée : URI incorrecte, Ressource inexistante, Communication avec le serveur incorrecte, rfc_number non trouvé.
exemple { "error": "Resource not found" } |
Status405
| 405 | Method not allowed (Méthode non autorisée) | Méthode de requête non autorisée : non supportée ou pas appropriée pour la ressource.
exemple { "error": "Invalid input parameter" } |
Exemples
Exemple de corps de requête HTTP
{
"suspended": {
"Comment": "Incident suspended via REST API",
"done_by_id": 18665
}
}
"suspended": {
"Comment": "Incident suspended via REST API",
"done_by_id": 18665
}
}
Résultat avec un code de statut retourné 201
{
"HREF": "https://{your_server}/api/v1/{your_account}/requests/I161019_000003"
}
"HREF": "https://{your_server}/api/v1/{your_account}/requests/I161019_000003"
}
ConventionsAPI
Conventions de l'API REST
| Convention | Signification | |
|---|---|---|
| Orange | Paramètres utilisés dans la chaîne d’une requête HTTP et qui ne correspondent pas à des champs de la base Service Manager.
exemple Méthode Voir une liste de biens https://{your_server}/api/v1/{your_account}/assets?max_rows=3&fields=asset_tag |
|
| Noir et Gras | Paramètres utilisés dans l’URL d’une requête HTTP et qui correspondent à des champs de la base Service Manager.
exemple Méthode Voir un bien https://{your_server}/api/v1/{your_account}/assets/{asset_id} |
|
| Vert | Paramètres utilisés dans le corps d’une requête HTTP et qui représentent des noms d’objets JSON correspondant à des champs de la base Service Manager ; ils permettent d’affecter ou de modifier une valeur de champ dans la base.
exemple Méthode Terminer un ticket { "closed": { "end_date": "11/20/2016 12:12:12", } } |
|
| Paramètres utilisés dans le corps d’une requête HTTP et qui représentent des noms d’objets JSON ne correspondant pas à des champs de la base Service Manager.
exemple Méthode Reprendre un ticket { "restarted": { "comment": "string (required)" } } |
||