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


GET  /catalog-requests/{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.
 

Objet Type Description / Example
fields string Select fields to display.
  • Example documentation icon EN.png /catalog-requests/5086?fields=article_model,catalog_id

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"
}
Status404
404 Not Found Resource not found: Incorrect URI, Missing resource, Incorrect communication with the server, rfc_number not found.
Example documentation icon EN.png
{
 "error": "Resource not found"
}

Example

Result with a status code 200 returned

{
 "ALLOW_GROUP_CHANGE": "0",
 "AVAILABLE_FIELD_1": "",
 "AVAILABLE_FIELD_2": "",
 "AVAILABLE_FIELD_3": "",
 "AVAILABLE_FIELD_4": "",
 "AVAILABLE_FIELD_5": "",
 "AVAILABLE_FIELD_6": "",
 "CAN_BE_PURCHASED": "",
 "CANNOT_BE_ORDERED": "",
 "CATALOG_GUID": "{16B692A5-600D-4850-934C-4128AE00FA01}",
 "CI_MANDATORY": "",
 "CODE": "",
 "COMMENT_CATALOG": {
   "HREF": "http://{your_server}/api/v1/{your_account}/catalog-requests/5086/comment_catalog"
  },
 "DEFAULT_REQUEST_BO": "",
 "DEFAULT_REQUEST_FO": "",
 "DEFAULT_REQUEST_TA": "",
 "DEFAULT_URGENCY_ID": "2",
 "DESCRIPTION_EN": {
   "HREF": "http://{your_server}/api/v1/{your_account}/catalog-requests/5086/description_en"
  },
 "DESCRIPTION_FR": {
   "HREF": "http://{your_server}/api/v1/{your_account}/catalog-requests/5086/description_fr"
  },
 "DESCRIPTION_GE": {
   "HREF": "http://{your_server}/api/v1/{your_account}/catalog-requests/5086/description_ge"
  },
 "DESCRIPTION_IT": {
   "HREF": "http://{your_server}/api/v1/{your_account}/catalog-requests/5086/description_it"
  },
 "DESCRIPTION_L1": {
   "HREF": "http://{your_server}/api/v1/{your_account}/catalog-requests/5086/description_l1"
  },
 "DESCRIPTION_L2": {
   "HREF": "http://{your_server}/api/v1/{your_account}/catalog-requests/5086/description_l2"
  },
 "DESCRIPTION_L3": {
   "HREF": "http://{your_server}/api/v1/{your_account}/catalog-requests/5086/description_l3"
  },
 "DESCRIPTION_L4": {
   "HREF": "http://{your_server}/api/v1/{your_account}/catalog-requests/5086/description_l4"
  },
 "DESCRIPTION_L5": {
   "HREF": "http://{your_server}/api/v1/{your_account}/catalog-requests/5086/description_l5"
  },
 "DESCRIPTION_L6": {
   "HREF": "http://{your_server}/api/v1/{your_account}/catalog-requests/5086/description_l6"
  },
 "DESCRIPTION_PO": {
   "HREF": "http://{your_server}/api/v1/{your_account}/catalog-requests/5086/description_po"
  },
 "DESCRIPTION_SP": {
   "HREF": "http://{your_server}/api/v1/{your_account}/catalog-requests/5086/description_sp"
  },
 "END_DATE": "",
 "END_OF_NEWS": "",
 "GROUP_ID": "",
 "IMPACT_ID": "",
 "LAST_INTEGRATION": "",
 "LAST_UPDATE": "2016-11-04",
 "MAX_CALLS": "",
 "MAX_QTY": "",
 "MONTHLY_NET_RENTAL": "",
 "MONTHLY_NET_RENTAL_CUR_ID": "",
 "NET_PRICE": "",
 "NET_PRICE_CUR_ID": "",
 "PACKAGE_NAME": "",
 "CATALOG_REQUEST_PATH": "Service Request/Human Ressources/Conflicts of Interest Report Form",
 "SD_CATALOG_ID": "5086",
 "SLA_ID": "",
 "START_DATE": "2014-06-26",
 "TITLE_EN": "Conflicts of Interest Report Form",
 "TITLE_FR": "Déclaration de conflits d'intérêt",
 "TITLE_GE": "Conflicts of Interest Report Form",
 "TITLE_IT": "Conflicts of Interest Report Form",
 "TITLE_L1": "",
 "TITLE_L2": "",
 "TITLE_L3": "",
 "TITLE_L4": "",
 "TITLE_L5": "",
 "TITLE_L6": "",
 "TITLE_PO": "Conflicts of Interest Report Form",
 "TITLE_SP": "Conflicts of Interest Report Form",
 "TITLE_URL": "",
 "CATALOG_REQUESTS_PATH": {
   "HREF": "http://{your_server}/api/v1/{your_account}/catalog-requests-paths/5070",
   "SD_CATALOG_ID": "5086",
   "SD_CATALOG_PATH_EN": "Service Request/Human Ressources/Conflicts of Interest Report Form"
  },
 "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 2018/11/14 12:29
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 2018