REST API - Créer une tâche pour un ticket


POST  /requests/{rfc_number}/tasks

  • La méthode supporte la création d’une seule tâche par appel.

Remarques

      Open url.png  voir Conventions de l'API REST Service Manager

  • Vous devez fournir un tableau au format JSON dans le corps de la requête HTTP.
  • Pour définir le type d’action de la tâche à créer, vous pouvez utiliser les noms d’objets action_type_id (de préférence) ou action_type_name. Dans ce dernier cas, vous devez saisir la valeur de l’objet dans la langue de l’utilisateur qui se connecte à l’API REST.
  • Pour définir le groupe assigné à la tâche, vous pouvez utiliser les noms d’objets group_id, group_name ou group_mail.
  • En cas de succès, un code de statut HTTP 201 est retourné et un lien URL (HREF) vers la ressource créé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 string Identifiant du ticket
  • Dans le corps de la requête HTTP, vous devez utiliser les objets JSON ci-dessous.
Paramètre Type Description / Exemple
action_type_id / action_type_name integer / string Identifiant / Nom du type d'action à créer
group_id / group_mail / group_name integer / string Identifiant / Adresse e-mail / nom du groupe qui doit intervenir sur la tâche

Paramètres optionnels

Aucun

Description des actions effectuées

Une tâche rattachée au ticket est créée.

  • statut Terminé
  • date de création (creation_date_ut) = now si non renseignée
  • calcul de la durée de la tâche si non renseignée (elapsed_time) = date de fin réelle - date de prise en charge, avec application du calendrier et jours fériés du SLA

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"
}
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

{
 "action_type_id": "19",
 "group_mail": "hotline@itassetservices.fr",
 "Elapsed_Time": "12",
 "time_cost": "99",
 "contractual_cost": "129",
 "description": "Task comment",
 "creation_date_ut": "",
 "start_date_ut": "",
 "end_date_ut": "",
 "available_field_1": "aaa",
 "available_field_6": "fff"
}

Résultat avec un code de statut retourné 201

{
 "HREF": "https://{your_server}/api/v1/{your_account}/requests/I161107_000004"
}


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)"  }  }

Tags:
Modifié par Utilisateur inconnu le 2021/08/31 17:07
Créé par Administrator XWiki le 2017/04/07 12:04

Raccourcis

L'actualité mensuelle
•  Newsletter

Tous les changements
•  Service Manager
•  Service Apps
•  Self Help
•  Service Bots

Powered by XWiki ©, EasyVista 2021