This documentation supports the 22.1 version of BMC Helix ITSM.To view an earlier version, select the version from the Product version menu.

Troubleshooting the simplified REST API


To understand errors from the BMC Helix ITSM simplified REST API, examine the status code of the response along with the response body if present. If that does not help, and you have access to the logs, look at the log file for the simplified REST API (setting the log level to DEBUG temporarily can be useful).

Supported HTTP status codes

When responding to requests, the REST API uses some of the standard HTTP status codes. The following table provides a summary of the status codes that are returned. 

Code

Name

Usage

200

OK

The operation is successful.

400

Bad request

The request is invalid.

404

Not found

This code is used when a resource does not exist.

401

Unauthorized access

The authentication has failed for the user.

403

Forbidden

The user is not allowed to perform the operation.

500

Application server error

An error has occurred on the server.

4000

Invalid field

There is an invalid field in the request.

4001

Invalid criteria

The criteria in the request is invalid.

4002

No tickets found

No tickets were found for the query.

4004

Data not found

Record does not exist or user does not have permission.

4040

Attachment not found

No attachment available for specified details.

51310

Incorrect Status reason

An incorrect combination of Status and Status reason were specified. 

Accessing the log files

You can access the BMC Helix ITSM simplified REST API logs the same way as any other BMC Helix Innovation Suite bundle. For more information, see Handling exceptions and Enabling and downloading logs from BMC Helix Innovation Studio on the BMC Helix Innovation Suite documentation.

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*