GET  /catalog-requests

• This method allows a list of ticket catalog entries (subjects) to be obtained (a ticket includes incident, service request, change request, investment request, problem and event).

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

Notes

        See Service Manager 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 EasyVista 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.

List of parameters / fields

Mandatory parameters

None

Optional parameters

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

Minimum version		Parameter	Type		Description / Example
		max_rows	integer		Maximum number of records to display. Default value: 100 example /catalog-requests?max_rows=5
		sort	string		Sort in ascending or descending order. Syntax: field1[+asc|+desc],field2[+asc|+desc],fieldn[+asc|+desc] example /catalog-requests?sort=catalog_requests_path.sd_catalog_path_en+asc
		fields	string		Select fields to display. example /catalog-requests?fields=catalog_request_path,title_fr,title_en,sla
		search	string		Search/filter the specified fields.   See Description of the options. example /catalog-requests?search=title_en~"Work*" A search on a Date field is also possible. example /catalog-requests?search=start_date:this_year
Oxygen 2.1.2 - Build 2018.1.183.0		search (logical OR operator)	string		Search/filter to several values from a same field Syntax: search=field:value1,field:value2 example /catalog-requests?search=sla.sla_id:1,sla.sla_id:2 ==> all the entries of a catalog in which the sla.sla_id field is equal to 1 or 2
Oxygène 1.7 - Build 2018.1.131.0		~ (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 /catalog-requests?search=title_en~"MS Project*" ==> all the entries of a catalog in which the title_en field begins with MS Project /catalog-requests?search=title_en~"*MS Project*" ==> all the entries of a catalog in which the title_en field contains MS Project
Oxygen 1.7 - Build 2018.1.131.0		!~ (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 /catalog-requests?search=title_en!~"MS Project*" ==> all the entries of a catalog by excluding those in which the title_en field begins with MS Project /catalog-requests?search=title_en!~"*MS Project*" ==> all the entries of a catalog by excluding those in which the title_en field contains MS Project
Oxygen 1.7 - Build 2018.1.131.0		! (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 /catalog-requests?search=title_en!"MS Project Import" ==> all the entries of a catalog by excluding those in which the title_en field is equal to MS Project Import
Oxygen 2.1.2 - Build 2018.1.183.0		is_null	string		Retrieve all results in which the field has no value (field value = null) Syntax: Field name following by "is_null" example /catalog-requests?search=title_en:"is_null"&sort=sd_catalog_id+asc ==> all the entries of a catalog in which the title_en field has no value, sorted in ascending identifier
Oxygen 2.1.2 - Build 2018.1.183.0		is_not_null	string		Retrieve all results in which the field has a value (field value = not null) Syntax: Field name following by "is_not_null" example /catalog-requests?search=title_en:"is_not_null"&sort=sd_catalog_id+asc ==> all the entries of a catalog in which the title_en field has a value, sorted in ascending identifier
Oxygen 1.7 - Build 2018.1.131.0		formatDate	string		Format display of Date fields in the HTTP request result.   See Description of the options. example /catalog-requests?fields=last_update&formatDate=l/M/Y ==> "last_update_format": "Friday/Nov/2018" /catalog-requests?fields=last_update&formatDate=l jS \of F Y h:i:s A ==> "last_update_format": "Friday 16th of November 2018 12:00:00 AM"

Fields that could be used in optional parameters

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

NotAuthorized_OptionalParametersFields_Catalog

HTTP status codes for the method

StatusHeader

Status200

Status401

Example

Result for a catalog entry (status code 200)

ConventionsAPI