In case one or multiple errors are encountered, they are returned as a serialized list of simple .NET objects containing the line and column number (if applicable), error number and the corresponding error text.
Error Object Structure
In case of an error the Result object contains an array of error objects with the following structure:
|
Property Name |
Type |
Description |
|---|---|---|
|
ErrorCode |
int |
Number for the error code |
| ErrorTitle | string | Short title describing the error |
| ErrorDetail | string | Description that describe the error. |
General Errors
Errors which occur because of e.g. providing faulty parameters to the API,
Export
|
Error code |
Shortname |
Description |
|---|---|---|
|
1 |
Invalid options |
Invalid options or an invalid combination of options were provided to the function. The error message provides more details. |
|
4 |
Authentication Error |
The username was not found or the username and password are invalid. |
|
20 |
Main type not found |
The specified main type was not found |
|
21 |
Custom type not found |
The specified custom type was not found |
|
30 |
Wrongly formatted date |
In case your start or end-date is wrongly formatted |
|
31 |
Invalid format option |
In case you specify a format which Automic Release Automation"Automic Release Automation (ARA) ist eine End-to-end-Lösung für die Definition, Koordinierung, Planung von Freigabe-Prozessen und deren Automatisierung. Dies enthält auch die automatische Durchführung von Anwendungs-Deployments auf großen Serverumgebungen. [Früher ""Application Release Automation"", ""Release Manager"" und ""Deployment Manager"" genannt.]" does not know about. Only XML and CSV are allowed. |
|
32 |
Invalid count option |
Count must not be higher than 1000. |
| 37 | Property does not exist | In case you specify a property which does not exist in that type |
Import
|
Error code |
Shortname |
Description |
|---|---|---|
|
1 |
Invalid options |
Invalid options or an invalid combination of options were provided to the function. The error message provides more details. E.g. "When the format is CSV a main type must be specified". |
|
4 |
Authentication error |
The username was not found or the username and password are invalid. |
|
6 |
Schema Validation Error |
The given input file is not valid with the required schema. |
|
20 |
Main type not found |
The specified main type was not found |
|
31 |
Invalid format option |
In case you specify a format which Automic Release AutomationName der AWI-Perspektive zur Kontrolle der Automic Release Automation. does not know about. Only XML and CSV are allowed. |
Delete
|
Error code |
Shortname |
Description |
|---|---|---|
|
4 |
Authentication error |
The username was not found or the username and password are invalid. |
|
6 |
Schema Validation Error |
The given input file is not valid with the required schema. |
|
14 |
Maintype required |
In case you did not specify a maintype while importing a CSV |
|
20 |
Maintype not found |
Main type not found |
|
31 |
Invalid format option |
In case you specify a format which Automic Release Automation does not know about. Only XML and CSV are allowed. |
Body Errors
Errors which may occur because of the provided body
|
Error code |
Shortname |
Description |
|---|---|---|
|
21 |
Custom type not found |
The specified custom type was not found |
|
33 |
Property rules violated |
The operation executed by the API was not valid because a property constraint was not matched. E.g. the max number of characters of a type name was exceeded |
|
34 |
Datatype Mismatch |
In case a property value does not match the property type (e.g. a wrongly formatted date) |
|
35 |
Reference not found |
In case a supplied reference could not be located |
|
36 |
Entity does not exist |
In case you supply an identity property which does not exist |
|
37 |
Property does not exist |
In case you specify a property which does not exist in that type |
|
38 |
Object identity already exists |
You tried importing an or changing to an identity property already existing. (e.g. importing a new Release with a system_name already defined in Automic Release Automation) |
|
39 |
Need at least [n] unique properties |
In case you provided less than the necessary amount of uniquely identifiable properties. |
|
40 |
Mandatory properties missing |
You tried creating an entity without specifying all required properties (e.g. missing system_name) |
|
41 |
Invalid identity property |
In case you try to supply a property which is not unique as a Identity property (e.g. system_description) |
|
42 |
Property is read only |
In case you try to set a value for a read only property (e.g. system_id). |
|
43 |
Duplicated property |
In case you specified a property more than one time |
|
44 |
Need exactly one unique property |
In case you specified more than one property when deleting entities. |