Appendix A - Error Messages
This appendix describes the types of error messages returned from SAQ API requests.
Template Elements
|
Error Message |
Resolution |
|---|---|
|
Element |
|
|
url: Invalid URL format (<value>). |
URL format must be as follows: http://<baseUrl>/rest/1.0/?parameters |
|
Url: Element is required |
Element “Url” is required. |
|
uris.<field>: Invalid URL format (<value>). |
For the uri.<field> sub element, specify a URL like http://domain.name/base/url/?parameters |
|
uris.<field>: Length of the field must not be greater than 2048 characters. (<value>). |
For the uri.<field> sub element, the maximum field length is 2048 characters. |
|
Attribute.category: Element is required. |
The element Attribute.category is required. |
|
Attribute.category: Invalid value (<value>). |
Element Attribute.category must be set to one of these values: Business Function, Business Location, Business Description. |
|
Attribute.value: Element is required. |
Provide a value for the attribute in the Attribute.value element: function, location or description. |
|
The attribute length cannot be greater than 64 characters. |
The value for this attribute cannot exceed 64 characters. |
|
The attribute length cannot be greater than 2048 characters. |
The value for this attribute cannot exceed 2048 characters. |
|
<element>: Element must not be set. |
This element does not apply to this request. |
|
set: Element must contain at least one child. |
The set element requires at least one sub element. |
|
headers: Length of all headers cannot exceed 2048 characters. |
The values of all headers cannot exceed 2048 characters. |
|
At least one of the following elements must be set: set, add, remove. |
For an “update” request you must set at least one of these elements: set, add or remove. |
|
UrlEntry: Element is required. |
The element UrlEntry must be provided. |
|
UrlEntry: Invalid URL format (value). |
Specify a URL like http://domain.name/base/url/?parameters |
|
<parent>: Length of all [URLs, regular expressions] cannot exceed 2048 characters |
The list of entries for a given type shall not exceed 2048 characters. |
|
UrlEntry: Only regular expressions are accepted for this element. |
You must provide regular expressions for the element postDataBlackList. |
|
tags.<element>: Element must not be set. |
The tags element does not apply for this request |
|
tags.set: Element must contain at least one child. |
At least one sub element must be provided for the element tag.set. |
|
Tag.id: Element is required. |
Provide a value for the element Tag.id |
|
Tag.id: Invalid value (value). |
Value must be an integer set at least to 1. |
|
Tag: Tag specified by ID <id> does not exist or is not available. |
Provide a value for the element id that corresponds to a valid tag. |
|
Criteria |
|
|
Criteria: Field is required. |
Specify the name of the criteria to search against. |
|
Criteria: Invalid criteria (<field name>). |
Please search against one of the following criteria: %s. |
|
Criteria: Invalid operator for criteria '<field>' (<operator>). |
Allowed operations for this criteria are: %s. |
|
Criteria: Value is required for criteria '<field>'. |
Specify a value for a field name for search criteria. |
|
Criteria: Invalid value format for criteria '<field>': <value>. |
Boolean (true, false). Date and Time in UTC format Enumeration (allowed options separated by comma). Other: Specify criteria value(s) as <type>. |
|
Authorization |
|
|
You are not authorized to access the application through the API. |
You must be granted the API Access permission in your roles and scopes. |
|
No data shall be passed for this operation. |
The POST request does not specify a data element. |
|
User is not authorized to perform this operation on specified object(s). |
You must be granted access to these objects in your user scope. |
|
Operation %s does not support search filters. |
Do not provide search filters for this operation. |
|
Report Storage Limit |
|
|
Your [subscription|user] storage limit of <NB> Mb has been reached. |
Delete existing reports and try again. |