REST API - View a list of entries of one of the ticket catalog


GET  /catalog-requests

  • To obtain detailed information about a specified catalog entry: GET /catalog-requests/{catalog_id}. Open url.png See the method.

Notes

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

  • If successful, an HTTP status code 200 is returned.
    • By default, if the optional parameter fields is not used, only an extract of the most useful fields selected by Logo - EasyVista.png is displayed for each record provided.
    • A URL link (HREF) to each resource is provided so that the complete list of fields for a record can be obtained if required.

List of parameters / objects

Mandatory parameters

None

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?max_rows=5
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?sort=catalog_requests_path.sd_catalog_path_en+asc
fields string Select fields to display.
  • Example documentation icon EN.png /catalog-requests?fields=catalog_request_path,title_fr,title_en,sla
search string Search/filter the specified fields.   Open url.png See Description of the options.
  • Example documentation icon EN.png /catalog-requests?search=title_en~"Work*"

A search on a Date field is also possible.

  • Example documentation icon EN.png /catalog-requests?search=start_date:this_year
~

(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?search=title_en~"MS Project*" ==> all entries of one of the catalogs in which the title_en field begins with MS Project
    • /catalog-requests?search=title_en~"*MS Project*" ==> all entries of one of the catalogs in which the title_en field contains MS Project
!~

(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?search=title_en!~"MS Project*" ==> all entries of one of the catalogs by excluding those in which the title_en field begins with MS Project
    • /catalog-requests?search=title_en!~"*MS Project*" ==> all entries of one of the catalogs by excluding those in which the title_en field contains MS Project
!

(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?search=title_en!"MS Project Import" ==> all entries of one of the catalogs by excluding those in which the title_en field is equal to MS Project Import
formatDate string Specification of the date.   Open url.png See Description of the options
  • Example documentation icon EN.png
    • /catalog-requests?formatDate=l/M/Y ==> Friday/Nov/2018
    • /catalog-requests?formatDate=l jS \of F Y h:i:s A ==> Friday 16th of November 2018 12:00:00 AM

Fields that could be used in optional parameters

You can use all the JSON objects from the AM_CATALOG table except those mentioned below.

NotAuthorized_OptionalParametersFields_Catalog
  • lft ; rgt 
  • level 
  • big_picture_path 
  • default_root_cause_id 
  • forms_id 
  • workflow_id ; closing_workflow_id ; immediate_workflow_id 
  • manager_id 
  • request_asset_tag 
  • move_service 
  • path_to_compute 
  • sd_catalog_id_for_caddy 
  • category_id
  • click_2_get_software_package_id 
  • click_2_get_button_label_*

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 for an entry of one of the ticket catalog (status code 200)

{
"HREF": "http://{your_server}/api/v1/{your_account}/catalog-requests?(% class="RedColor" %)max_rows(%%)=400&search=catalog_requests_path.sd_catalog_path_en~%22*MS%20Project*%22",
"record_count": "1",
"total_record_count": "1",
"records": [
{
"HREF": "http://{your_server}/api/v1/{your_account}/catalog-requests/5070",
"CODE": "",
"CATALOG_REQUEST_PATH": "Projects/MS Project Import",
"SD_CATALOG_ID": "5070",
"TITLE_EN": "MS Project Import",
"CATALOG_REQUESTS_PATH": {
 "HREF": "http://{your_server}/api/v1/{your_account}/catalog-requests-paths/5070",
 "SD_CATALOG_ID": "5070",
 "SD_CATALOG_PATH_EN": "Projects/MS Project Import"
  },
"MANAGER": {
 "HREF": "",
 "BEGIN_OF_CONTRACT": "",
 "CELLULAR_NUMBER": "",
 "DEPARTMENT_PATH": "",
 "E_MAIL": "",
 "EMPLOYEE_ID": "",
 "LAST_NAME": "",
 "LOCATION_PATH": "",
 "PHONE_NUMBER": ""
  },
"SLA": {
 "HREF": "http://{your_server}/api/v1/{your_account}/slas/",
 "DELAY": "",
 "NAME_EN": "",
 "SLA_ID": ""
  }
}
]}


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 2017/12/21 08:50

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