Errors and Warnings

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:

  • ErrorCode

    • InvalidOptions = 1
    • InvalidInputFile = 2
    • AuthenticationError = 4
    • SchemaValidationError = 6
    • MaintypeIsRequired = 14
    • MaintypeNotFound = 20
    • CustomTypeNotFound = 21
    • WronglyFormattedDate = 30
    • InvalidFormatOption = 31
    • InvalidCountOption = 32
    • PropertyRuleViolated = 33
    • DatatypeMismatch = 34
    • ReferenceNotFound = 35
    • PropertyDoesnotExists = 37
    • ObjectIdentityAlreadyExists = 38
    • MandatoryPropertiesMissing = 40
    • InvalidIndentityProperty = 41
    • SystemPropertyIsReadOnly = 42
    • DuplicateProperty = 43
    • WrongFormatPropertyName = 44

    Type: string

  • ErrorTitle

    Short title describing the error

    Type: string

  • ErrorDetail

    Description of the error.

    Type: string

General Errors

Errors which occur because of for example, 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 or 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 Continuous Delivery Automation 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
TypeVersionNotFound Type version not found A type version used in request was not found.
OperatorDoesNotSupport Operator is not supported An operator used in conditions is not supported for the given type.
ConditionIsInvalid Condition is invalid An invalid condition has been provided
ConditionOperatorIsInvalid Condition Operator is invalid Valid operators: t can be: eq (equal), neq (not equal), gt (greater than), geq (greater than or equal), lt (lower than), leq (lower than or equal)
ConditionPropertyDoesnotSupport Condition property is not supported An unsupported property was used in a condition
FolderLogsIsNotWriteable Folder Logs is not writable The logs folder within the Automic Continuous Delivery Automation web application is not writable.
NoReadAccessOnObject No read access on object Export of an object on which the user has no read access was requested.

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. For example, "When the format is CSV a main type must be specified".

4

Authentication error

The username was not found or the username or 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 Continuous Delivery Automation does not know about. Only XML and CSV are allowed.
AuthorizationError Authorization Error An operation was requested for which the user is not authorized.
BusinessRuleViolation Business Rule Violation A creation or update operation which violates a business rule was requested.
InvalidDataFormat Invalid Data format An invalid data format was provided. Valid formats are XML and CSV
TypeVersionNotFound Type version not found A type version used in request was not found.
FolderLogsIsNotWriteable Folder Logs is not writable The logs folder within Automic Continuous Delivery Automation web application is not writable.
NoCreationRightOnCustomType No creation right on custom type The creation of an entity was requested for which the user has no creation rights.
NoWriteAccessOnObject No write access on object The creation or update of an entity was requested for which the user has no write access.

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 Continuous Delivery Automation does not know about. Only XML and CSV are allowed.
AuthorizationError Authorization Error An operation was requested for which the user is not authorized.
NoMaintypeExpected No Maintype expected A maintype was specified which is not expected
InvalidDataFormat Invalid Data format An invalid data format was provided. Valid formats are XML and CSV
NoPropertyForDeletion No property for deletion A property which is needed to identify entities to be deleted was not provided
PropertiesCannotBeUsedTogetherForDeletion Properties cannot be used together for deletion An invalid set of properties for the entity to be deleted has been provided. Only identity properties are allowed for deletion
FolderLogsIsNotWriteable Folder Logs is not writable The logs folder within Automic Continuous Delivery Automation web application is not writable.
NoWriteAccessOnObject No write access on object The creation or update of an entity was requested for which the user has no write access.

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. For example, the max number of characters of a type name was exceeded

34

Datatype Mismatch

A property value does not match the property type (for example, a wrongly formatted date)

35

Reference not found

A supplied reference could not be located

36

Entity does not exist

A non-existing identity property was provided.

37

Property does not exist

A non-existing property was provided.

38

Object identity already exists

You tried to import or change an already existing property.

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 to create an entity without specifying all required properties (for example, missing system_name)

41

Invalid identity property

You tried to supply a property which is not unique as an Identity property (for example, system_description)

42

Property is read only

You set a value for a read only property (for example, system_id).

43

Duplicated property

You specified a property more than once.

44

Need exactly one unique property

You specified more than one property when deleting entities.