Error Messages Returned by Integration Monitoring API for Strategic Sourcing

When there is an issue with the Integration monitoring API, a JSON response containing one of the following HTTP response codes is returned to explain what the issue was.

Error Code

Message

Description

400

The API key passed in the request is not valid.

The API key passed in the query headers does not match the API key in the OAuth token.

400

Bad request/Malformed request.

All URL and request parameter parsing errors will result in this code being returned. For example, if the event name could not be found.

401

Unauthorized.

Authentication failure.

403

Forbidden

The integration event monitoring API feature is not enabled for the site.

405

Method not allowed.

Incorrect method used for this request. For example, if a POST is called on this API.

500

Internal Server Error.

Reports server errors that occurred during request processing. For example, exceptions encountered during JSON generation..

429

Rate limit error

You have exceeded the maximum permitted query rate. Refer to the developer portal discovery page for this API for the applicable query rates.

504

Gateway Time-out

The server timeout time has been exceeded, possibly due to network traffic or reliability issues. Retry your query.

Other error messages might be displayed as a result of JSON serialization errors or certificate parsing and validations. These can appear as error code 500 (for request processing errors) or error code 401 (for authentication failure).

Error Examples:

{
	"error": {
	"code":400,
	"message": "The API requires either the ITK display name or the Internal Event Name."
	}
}	
		
{
	"error": {
	"code":400,
	"message": "The ITK event display name provided is invalid."
	}
}	
		
{
	"error": {
	"code":400,
	"message": "The integration event name provided is invalid."
	}
}	
		
{
	"error": {
	"code":400,
	"message": "The realm name provided is invalid."
	}
}	
		
{
	"error": {
	"code":401,
	"message": "Shared Secret and Client Certificate are both null"
	}
}	
		
{
	"error": {
	"code":401,
	"message": "Authentication failure: Invalid Integration Password or Authentication mode is of type Certificate."
	}
}	
		
{
	"error": {
	"code":401,
	"message": "Authentication failure: Invalid Digital Certificate or Authentication mode is of type Shared Secret"
	}
}	
		
{
	"error": {
	"code":403,
	"message": "This API is not enabled for your site."
	}
}	
		
{
	"error": {
	"code":405,
	"message": "POST not allowed."
	}
}	
		
{
	"error": {
	"code":500,
	"message": "OAuth server is down. Please try again later."
	}
}