REST API - Créer une action

Modifié le 01/06/2023 16:14
Sommaire

POST  /requests/{rfc_number}/actions

  • La méthode supporte la création d’une seule action 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 l'action à 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é à l'action, 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 l'action

Paramètres optionnels

Aucun

Champs optionnels

Dans le corps de la requête HTTP, vous pouvez utiliser tous les champs de la table AM_ACTION, sauf ceux que vous avez ajoutés dans la base Service Manager (champs préfixés par e_).
 

Version minimum Paramètre Type Description / Exemple
creation_date_ut string Date de création de l'action, exprimée en Temps universel
  • Par défaut, date courante (now).
Autumn 2020 - Build 2020.2.122.2 comment string Commentaire de l'objet
contact_id, contact_identification, contact_mail, contact_name integer / string Clé / Numéro de matricule / Adresse e-mail / Nom de l'interlocuteur qui doit intervenir sur l'action
  • Les objets sont traités dans cet ordre de priorité par l'algorithme de recherche.
description string Description de l'objet
doneby_id, doneby_identification, doneby_mail, doneby_name integer / string Clé / Numéro de matricule / Adresse e-mail / Nom de l'intervenant qui doit intervenir sur l'action
  • Les objets sont traités dans cet ordre de priorité par l'algorithme de recherche.
expected_start_date_ut / expected_end_date_ut string Date de début / date de fin prévues de l'action, exprimées en Temps universel
group_id, group_mail, group_name integer / string Clé / Adresse e-mail / Nom du groupe qui doit intervenir sur l'action
  • Les objets sont traités dans cet ordre de priorité par l'algorithme de recherche.
max_intervention_date_ut string Date maximale à laquelle l'action doit être effectuée, exprimée en Temps universel
  • Si la date n'est pas renseignée, elle est calculée à partir de la date de création de l'action et l'OLA du groupe.
parent_action_id integer Clé de l'action parente

Description des actions effectuées

Une action est créée pour le ticket.

  • Statut  : En cours
  • Les calculs de l'assistant de création sont effectués.

Vous pouvez spécifier le champ parent_action_id dans le body en json.

  • Si parent_action_id est renseigné : la nouvelle action est rattachée au parent_action_id
  • Si parent_action_id n’est pas renseigné :
    • L’action créée est rattachée à la dernière action ouverte associée au rfc_number et affectée à l’utilisateur / groupe passé en paramètre
    • Si plusieurs actions parentes sont trouvées, le traitement est abondonné (ambiguïté sur parent_action_id)

Codes de statut HTTP de la méthode

StatusHeader

   Un code erreur Timeout est renvoyé et la méthode échoue si le serveur ne répond pas à la requête du web service REST au bout d'un certain temps (par défaut, 60 secondes).

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": {
   "action_type_id": "10",
   "group_name": "US network expert"
    }
}

Résultat avec un code de statut retourné 201

{
  "HREF":  "https://{your_server}/api/v1/{your_account}/actions/I191213_000001"
}
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 :
Powered by XWiki © EasyVista 2022