REST API - Voir une liste de news


Version minimum : Service Manager Oxygène 2.1.3

GET  /news

  • Cette méthode permet d’obtenir une liste de news.
  • Pour obtenir les informations détaillées d'une news déterminée : GET /news/{document_id}  - Open url.png voir la méthode

Remarques

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

  • En cas de succès, un code de statut HTTP 200 est retourné.
    • Par défaut, si le paramètre optionnel fields n’est pas utilisé, seul un extrait des champs les plus utiles sélectionnés par EasyVista est affiché pour chaque enregistrement fourni.
    • Un lien URL (HREF) vers chaque ressource est fourni permettant d'obtenir la liste complète des champs pour un enregistrement.

Liste des paramètres / champs

Paramètres obligatoires

Aucun

Paramètres optionnels

Aucun

Champs optionnels

Aucun

Codes de statut HTTP de la méthode

StatusHeader
Code Erreur Description
Status200
200 OK (Succès) Requête traitée avec succès.
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"
}

Exemple

Résultat pour 3 news (code de statut 200)

{
   "HREF": "https://uap-fr-ac-01.easyvista-training.com/api/v1/50013/news?search=L_EN:1&max_rows=3",
   "record_count": "3",
   "total_record_count": "48",
   "records": [
        {
           "HREF": "https://uap-fr-ac-01.easyvista-training.com/api/v1/50013/news/18805",
           "CREATION_DATE": "",
           "DESCRIPTION": {
               "HREF": "https://uap-fr-ac-01.easyvista-training.com/api/v1/50013/news/18805/description"
            },
           "DOCUMENT_ID": "18805",
           "DOCUMENT_NAME": "No Internet Access Friday Evening",
           "END_DATE": "",
           "FRONT_OFFICE": "1",
           "L_EN": "1",
           "L_FR": "0",
           "L_GE": "0",
           "L_IT": "0",
           "L_PO": "0",
           "L_SP": "0",
           "REQUEST_ID": "",
           "SD_CATALOG_PATH": "Incidents/Hardware/Workstation",
           "SD_CATALOG_ID": "4702",
           "START_DATE": "2004-06-01",
           "REQUEST": {
               "MAX_RESOLUTION_DATE_UT": "",
               "REQUEST_ID": "",
               "RFC_NUMBER": "",
               "SUBMIT_DATE_UT": ""
            }
        },
        {
           "HREF": "https://uap-fr-ac-01.easyvista-training.com/api/v1/50013/news/18806",
           "CREATION_DATE": "",
           "DESCRIPTION": {
               "HREF": "https://uap-fr-ac-01.easyvista-training.com/api/v1/50013/news/18806/description"
            },
           "DOCUMENT_ID": "18806",
           "DOCUMENT_NAME": "Instant Messaging Usage Policy",
           "END_DATE": "",
           "FRONT_OFFICE": "1",
           "L_EN": "1",
           "L_FR": "0",
           "L_GE": "0",
           "L_IT": "0",
           "L_PO": "0",
           "L_SP": "0",
           "REQUEST_ID": "",
           "SD_CATALOG_PATH": "Incidents",
           "SD_CATALOG_ID": "4699",
           "START_DATE": "2004-06-01",
           "REQUEST": {
               "MAX_RESOLUTION_DATE_UT": "",
               "REQUEST_ID": "",
               "RFC_NUMBER": "",
               "SUBMIT_DATE_UT": ""
            }
        },
        {
           "HREF": "https://uap-fr-ac-01.easyvista-training.com/api/v1/50013/news/18838",
           "CREATION_DATE": "",
           "DESCRIPTION": {
               "HREF": "https://uap-fr-ac-01.easyvista-training.com/api/v1/50013/news/18838/description"
            },
           "DOCUMENT_ID": "18838",
           "DOCUMENT_NAME": "CRM application upgrade",
           "END_DATE": "",
           "FRONT_OFFICE": "0",
           "L_EN": "1",
           "L_FR": "0",
           "L_GE": "0",
           "L_IT": "0",
           "L_PO": "0",
           "L_SP": "0",
           "REQUEST_ID": "",
           "SD_CATALOG_PATH": "Incidents/Infrastructure",
           "SD_CATALOG_ID": "4747",
           "START_DATE": "",
           "REQUEST": {
               "MAX_RESOLUTION_DATE_UT": "",
               "REQUEST_ID": "",
               "RFC_NUMBER": "",
               "SUBMIT_DATE_UT": ""
            }
        }
    ]
}


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 2020/03/30 17:01
Créé par Administrator XWiki le 2020/03/30 11:34

Raccourcis

L'actualité mensuelle
•  Newsletter

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

Glossaire

Powered by XWiki ©, EasyVista 2020