REST API - Créer un CI
Sommaire
POST /configuration-items
- Cette méthode permet de créer un nouvel élément de configuration (CI).
- La méthode supporte la création d’un seul CI par appel.
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.
- 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 le corps de la requête HTTP, vous devez utiliser le paramètre ci-dessous.
| Paramètre | Type | Description / Exemple |
|---|---|---|
| catalog_id | string | Identifiant du modèle auquel est rattaché le CI exemple "catalog_id": 4822 |
Paramètres optionnels
Aucun
Champs optionnels
- Dans le corps de la requête HTTP, vous pouvez utiliser tous les champs de la table AM_ASSET sauf ceux indiqués ci-dessous.
- location_code ; location_path
- department_code ; department_path
- Version minimum : Oxygène 2.1.2 - Build 2018.1.183.0 En plus des champs fournis par EasyVista, vous pouvez aussi affecter des valeurs aux champs que vous avez ajoutés dans la base de données Service Manager. Il s’agit des champs préfixés par e_.
exemple e_field_name_xyz
Codes de statut HTTP de la méthode
StatusHeader
Note : 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" } |
Status500
| 500 | Internal Server Error (Erreur interne du serveur) | Message d’erreur générique, donné quand une condition inattendue a été rencontrée et qu'aucun message plus spécifique n’est approprié.
exemple { "error": "An error occured. A text message is returned in the body." } |
Exemples
Exemple de corps de requête HTTP
{
"assets": [
{
"catalog_id": 3153,
"asset_tag": "ZGCSS_732",
"serial_number": "DGSF-2004-1019",
"status_id": 1,
"charge_back": "140",
"installation_date": "09/09/2018",
"IS_CI": 1,
"CI_STATUS_ID": 1,
"comment_asset": "ip_input.c in BSD-derived TCP/IP implementations allows remote attackers to cause a denial of service (crash or hang) via crafted packets."
}
]
}
"assets": [
{
"catalog_id": 3153,
"asset_tag": "ZGCSS_732",
"serial_number": "DGSF-2004-1019",
"status_id": 1,
"charge_back": "140",
"installation_date": "09/09/2018",
"IS_CI": 1,
"CI_STATUS_ID": 1,
"comment_asset": "ip_input.c in BSD-derived TCP/IP implementations allows remote attackers to cause a denial of service (crash or hang) via crafted packets."
}
]
}
Résultat avec un code de statut retourné 201
{
"HREF": "https://{your_server}/api/v1/{your_account}/configuration-items/9504"
}
"HREF": "https://{your_server}/api/v1/{your_account}/configuration-items/9504"
}
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)" } } |
||