GET  /knownerrors

• This method allows a list of known errors to be obtained.

• To obtain detailed information for a specified known error: GET /known errors/{known_problems_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 /knownerrors?max_rows=5
		sort	string		Sort in ascending or descending order. Syntax: field1[+asc|+desc],field2[+asc|+desc],fieldn[+asc|+desc] example /knownerrors?sort=known_problems_id+desc
		fields	string		Select fields to display. example /knownerrors?fields=known_problems_id
		search	string		Search/filter the specified fields.   -   See Description of the options. example /knownerrors?search=known_problems_id:"3"
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 /knownerrors?search=urgency_id:1,urgency_id:2 ==> all the known errors in which the urgency_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 /knownerrors?search=question_en~"640*" ==> all the known errors in which the question_en field begins with 640 /knownerrors?search=question_en~"*640*" ==> all the known errors in which the question_en field contains 640
Oxygen 1.7 - Build 2018.1.131.0		!~ (equivalent to not like)	string		Exclude all results equal to 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 /knownerrors?search=question_en!~"640*" ==> all the known errors by excluding those in which the question_en field begins with 640 /knownerrors?search=question_en!~"640*" ==> all the known errors by excluding those in which the question_en field contains 640
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 /knownerrors?search=question_en!" - " ==> all the known errors by excluding those in which the question_en field is equal to -
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 /knownerrors?search=kp_number:"is_null"&sort=sd_catalog_id+asc ==> all the known errors in which the kp_number 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 /knownerrors?search=kp_number:"is_not_null"&sort=sd_catalog_id+asc ==> all the known errors in which the kp_number field has a value, sorted in ascending identifier
Oxygen 1.7 - Build 2018.1.131.0		formatDate	string		Specification of the date.   -   See Description of the options. example /knownerrors?fields=end_date&formatDate=l/M/Y ==> "end_date_format": "Friday/Nov/2018" /knownerrors?fields=end_date&formatDate=l jS \of F Y h:i:s A ==> "end_date_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 SD_KNOWN_PROBLEMS table.

HTTP status codes for the method

StatusHeader

Status200

Status401

Examples

Result for 3 known errors (status code 200)

ConventionsAPI