REST API - Modifier une news
Sommaire
PUT /news/{document_id}
- Cette méthode permet de modifier une news déterminée.
exemple /news/19001
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 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.
- Dans le corps de la requête HTTP, vous devez utiliser au moins l'un des champs optionnels. Sinon une erreur est retournée.
| Paramètre | Type | Description / Exemple |
|---|---|---|
| document_id | number | Identifiant de la news |
Paramètres optionnels
Aucun
Champs optionnels
Aucun
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" } |
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 avec code HTML
{
"DESCRIPTION": "<![CDATA[<span style=\"color: red\">EV - Service Manager</span> : update the <u>news</u>!]]>",
"FRONT_OFFICE": true,
"SD_CATALOG_ID": 4702,
"DISPLAY_LAST_UPDATE": true,
"L_EN": true,
"L_FR": true,
"L_SP": true,
"L_GE": true,
"L_IT": true,
"L_PO": true
}
"DESCRIPTION": "<![CDATA[<span style=\"color: red\">EV - Service Manager</span> : update the <u>news</u>!]]>",
"FRONT_OFFICE": true,
"SD_CATALOG_ID": 4702,
"DISPLAY_LAST_UPDATE": true,
"L_EN": true,
"L_FR": true,
"L_SP": true,
"L_GE": true,
"L_IT": true,
"L_PO": true
}
Résultat avec un code de statut retourné 201
{
"HREF": "https://{your_server}/api/v1/{your_account}/news/19001"
}
"HREF": "https://{your_server}/api/v1/{your_account}/news/19001"
}
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)" } } |
||