REST API - View the list of paths of an entry of one of the ticket catalog


GET  /catalog-requests-paths/{catalog_id}

Notes

     Open url.png  see Product name - ev itsm.png REST API Conventions

  • If successful, an HTTP status code 200 is returned.
    • A URL link (HREF) to the resource is provided.
    • All fields are provided, including e_field_name and available_field_x, except for certain sensitive fields reserved for Logo - EasyVista.png.
       

List of parameters / objects

Mandatory parameters

You must use the JSON object below in the body of the HTTP request.
 

Objet Type Description / Example
catalog_id integer Entry catalog identifier

Optional parameters

You can use the parameters detailed below in the HTTP request string.

REST_OptionalParametersGetList_Oxygen1.7_Build131.0

Note: not like, not, formatDate parameters: Specific to Product name - ev itsm.png Oxygen version 1.7 - Build 2018.1.131.0 - and later.

Objet Type Description / Example
max_rows integer Maximum number of records to display.
  • Default value: 100
  • Example documentation icon EN.png /catalog-requests-paths/4579?max_rows=3
sort string Sort in ascending or descending order.
  • Syntax: field1[+asc|+desc],field2[+asc|+desc],fieldn[+asc|+desc]
  • Example documentation icon EN.png /catalog-requests-paths/4579?sort=catalog_requests_path.sd_catalog_path_en+asc
fields string Select fields to display.
  • Example documentation icon EN.png /catalog-requests-paths/4579?fields=sd_catalog_path_fr,sd_catalog_path_en
search string Search/filter the specified fields.   Open url.png See Description of the options.
  • Example documentation icon EN.png /catalog-requests-paths/4579?search=sd_catalog_path_en~"*Printer*"
~

(equivalent to like)

string Include the results which begin with or contain a given character string.
  • Syntax: ~ following by the string to include enclosed in quotation marks.
  • You should use the wildcard character *.
    • < string >* = include what begins with < string >.
    • *< string >* = include what contains < string >.
  • Example documentation icon EN.png
    • /catalog-requests-paths?search=sd_catalog_path_en~"Service *" ==> all paths of a catalog entry in which the sd_catalog_path_en field begins with Service
    • /catalog-requests-paths?search=sd_catalog_path_en~"*Service *" ==> all paths of a catalog entry in which the sd_catalog_path_en field contains Service
!~

(equivalent to not like)

string Exclude the results which begin with or contain a given character string.
  • Syntax: !~ following by the string to exclude enclosed in quotation marks.
  • You should use the wildcard character *.
    • < string >* = exclude what begins with < string >.
    • *< string >* = exclude what contains < string >.
  • Example documentation icon EN.png
    • /catalog-requests-paths?search=sd_catalog_path_en!~"Service *" ==> all paths of a catalog entry by excluding those in which the sd_catalog_path_en field begins with Service
    • /catalog-requests-paths?search=sd_catalog_path_en!~"*Service *" ==> all paths of a catalog entry by excluding those in which the sd_catalog_path_en field contains Service
!

(equivalent to not)

string Exclude all results equal to a given character string.
  • Syntax: ! following by the string to exclude enclosed in quotation marks.
  • Example documentation icon EN.png /catalog-requests-paths?search=sd_catalog_path_en!"Service Request/Equipment/New Printer/Inkjet Printer" ==> all paths of a catalog entry by excluding those in which the sd_catalog_path_en field is equal to Service Request/Equipment/New Printer/Inkjet Printer
formatDate string Specification of the date.   Open url.png See Description of the options
  • Example documentation icon EN.png
    • /catalog-requests-paths?formatDate=l/M/Y ==> Friday/Nov/2018
    • /catalog-requests-paths?formatDate=l jS \of F Y h:i:s A ==> Friday 16th of November 2018 12:00:00 AM

HTTP status codes for the method

StatusHeader
Code Error Description
Status200
200 OK (Success) Request processed successfully.
Status401
401 Unauthorized Authentication process for accessing the resource is incorrect: Login/Password incorrect, Invalid session, Incorrect Product name - ev itsm.png account.
Example documentation icon EN.png
{
 "error": "Invalid Login / Password"
}

Example

Result with a status code 200 returned

{
   "HREF": "https://{your_server}/api/v1/{your_account}/catalog-requests-paths/4579",
   "SD_CATALOG_ID": "4579",
   "SD_CATALOG_PATH_EN": "Service Request/Equipment/New Printer/Inkjet Printer",
   "SD_CATALOG_PATH_FR": "Demande de service/Matériels/Installer une imprimante/Imprimante jet d'encre",
   "SD_CATALOG_PATH_GE": "Service Request/Ausrüstungen/Neuer Drucker/Tintenstrahldrucker",
   "SD_CATALOG_PATH_IT": "Richiesta di servizio/Apparecchiature/Installare una stampante/Stampante Inkjet",
   "SD_CATALOG_PATH_L1": "///",
   "SD_CATALOG_PATH_L2": "///",
   "SD_CATALOG_PATH_L3": "///",
   "SD_CATALOG_PATH_L4": "///",
   "SD_CATALOG_PATH_L5": "///",
   "SD_CATALOG_PATH_L6": "///",
   "SD_CATALOG_PATH_PO": "Pedido de Serviço/Equipamentos/Nova impressora/Impressora de jacto de tinta",
   "SD_CATALOG_PATH_SP": "Petición de Servicio/Equipos/Nueva Impresora/Impresora de Tinta"
}


ConventionsAPI

REST API Conventions

Convention Meaning
Orange Parameters used in an HTTP request string (URL) which do not correspond to Product name - ev itsm.png database fields.
Example documentation icon EN.png   Method View a list of assets
https://{your_server}/api/v1/{your_account}/assets?max_rows=3&fields=asset_tag
Black and Bold Parameters used in the URL of an HTTP request which correspond to Product name - ev itsm.png database fields.
Example documentation icon EN.png   Method View an asset
https://{your_server}/api/v1/{your_account}/assets/{asset_id}
Green Parameters used in the body of an HTTP request which represent JSON object names corresponding to Product name - ev itsm.png database fields; they allow the value of a database field to be assigned or modified.
Example documentation icon EN.png   Method Close an incident/request

{  "closed": {  "end_date": "11/20/2016 12:12:12",  }  }
Parameters used in the body of an HTTP request which represent JSON object names not corresponding to Product name - ev itsm.png database fields.
Example documentation icon EN.png   Method Reopen an incident/request

{  "restarted": {  "comment": "string (required)"  }  }

Tags:
Last modified by Unknown User on 2019/03/19 15:34
Created by Administrator XWiki on 2018/07/13 17:11

Shortcuts

Recent Updates

Haven't been here in a while? Here's what changed recently:

-   Product name - ev itsm.png
-   Product name - ev sas.png

Interesting Content

How to Automate Integration
Add a Shortcut to an App
History
Quick Dashboard
Full text search - Stop Words

Powered by XWiki ©, EasyVista 2019