Errors
If a call cannot be successfully completed, the HTTP response message contains three header values indicating the nature of the failure. The Status Code header details the general category of response. The X-IntegrationServer-Error-Code header pvodies an error code providing further information about the type of error that occurred. The X-IntegrationServer-Error-Message header provides the error message about the error that occurred.
The following table provides a description of each X-IntegrationServer-Error-Code.
| Name | Description |
|---|---|
| ACCESS_CONTROL_MARKING_NOT_FOUND_ERROR | An access control marking with the specified ID could not be found. |
| ADD_TO_FOLDER_ERROR | An error occurred while attempting to add an item to a folder. |
| ANNOTATION_TEMPLATE_NOT_FOUND_ERROR | The annotation template with the specified ID could not be found. |
| APPLICATION_PLAN_CONTEXT_FAIL_ERROR | Gathering context of an application plan failed |
| APPLICATION_PLAN_NOT_FOUND_ERROR | An application plan with the specified ID value could not be found. |
| APPLICATION_PLAN_TYPE_INVALID_ERROR | The specified application plan type is invalid for the current operation |
| BAD_REQUEST_ERROR | Returned when an a request is incomplete or invalid |
| BANNER_NOT_FOUND_ERROR | Returned when a banner is requested but no banner is found. |
| CANNOT_ADD_FOLDER_TO_ITSELF_ERROR | An operation occurred which attempted to add a folder to itself. |
| CAPTURE_PROFILE_NOT_FOUND_ERROR | A capture profile with the specified ID value could not be found. |
| CAPTURE_SOURCE_PROFILE_NOT_FOUND_ERROR | A capture source profile with the specified ID does not exist. |
| CLIENT_ENUM_TRANSFORM_ERROR | A generic error. The user provided an invalid enumeration constant to Integration Server. |
| COMPLETE_TASK_PASSWORD_ERROR | When completing a task, the password provided by the user was incorrect. |
| CONFLICTING_ITEM_ERROR | Returned when a conflicting item already exists |
| CONFLICT_ERROR | Returned when the request conflicts with an existing object or rule |
| DATABASE_ERROR | A generic error returned by the server when an error occurs in the database. |
| DEPARTMENT_NAME_INVALID_ERROR | The name provided for this department is invalid |
| DEPARTMENT_NOT_FOUND_ERROR | A department with the specified ID could not be found. |
| DEPARTMENT_PREFIX_INVALID_ERROR | The prefix provided for this department is invalid |
| DIGITAL_SIGNATURE_FAILED_TO_SIGN_VERSION | Returned when a user attempts to sign an invalid document version. |
| DIGITAL_SIGNATURE_FAILED_TO_VOID_DIGITAL_SIGNATURE | Returned when user does not have privileges to void a signature. |
| DIGITAL_SIGNATURE_INVALID_PASSWORD | Returned when a digital signature password was incorrect. |
| DIGITAL_SIGNATURE_NOT_FOUND_ERROR | Returned when a digital signature was not be found. |
| DIGITAL_SIGNATURE_PASSWORD_DECRYPT_FAILED | Returned when the password for a digital signature could not be decrypted. |
| DIGITAL_SIGNATURE_USER_KEY_NOT_FOUND | Returned when the user's key-pair id was not found. |
| DIGITAL_SIGNATURE_VERSION_HASH_FAILED | Returned when a hash could not be generated while signing a document. |
| DOCUMENT_ALREADY_CHECKED_OUT_ERROR | Returned when a user tries to complete a task that is associated with a document that they have checked out. |
| DOCUMENT_CHECKED_OUT_BY_OTHER_USER_ERROR | Returned when a user tries to complete a task that is associated with a document that is checked out by another user. |
| DOCUMENT_CONVERSION_FAILURE | Returned when the entire document failed to convert. |
| DOCUMENT_CONVERSION_PARTIAL_FAILURE | Returned when a portion of a document failed to convert. |
| DOCUMENT_COPY_TO_SELF_ERROR | Attempt to copy a document to the same name and location as itself. |
| DOCUMENT_EXPORT_ARCHIVE_FORMAT_INVALID | The specified export archive format is not valid. |
| DOCUMENT_EXPORT_CONVERSION_ERROR | Returned when an export fails due to a conversion error. |
| DOCUMENT_EXPORT_CONVERSION_FORMAT_INVALID | The specified export conversion format is not valid. |
| DOCUMENT_EXPORT_VERSION_NUMBER_NOT_SUPPORTED | Returned when a version number is specified for more than one document. |
| DOCUMENT_HAS_BEEN_DELETED_ERROR | The specified document has been deleted. |
| DOCUMENT_NOT_CHECKED_OUT_ERROR | The requested document operation requires the user to first check out the document. |
| DOCUMENT_NOT_FOUND_ERROR | The specified document could not be found. |
| DOCUMENT_NOT_IN_VERSION_CONTROL | Returned when document is not in version control |
| DOCUMENT_TYPE_LIST_NOT_FOUND_ERROR | The specified document type list ID is invalid. |
| DOCUMENT_TYPE_NOT_FOUND_ERROR | The specified document type ID is invalid. |
| DOCUMENT_VERSION_ALREADY_IN_VERSION_CONTROL | Returned when the document is already in version control. |
| DOCUMENT_VERSION_CHECKED_OUT | Returned when a document is already checked out. |
| DOCUMENT_VERSION_NUMBER_INVALID | Returned when an invalid version number is provided. |
| DOCUMENT_VERSION_REMOVE_HISTORY_FOR_SIGNED_DOCUMENT | Returned when removing document history when there is a signed version. |
| DRAWER_NOT_FOUND_ERROR | A drawer with the specified unique ID could not be found. |
| EMPTY_GROUP_ID_ERROR | A group id was not provided as a part of the URL |
| EMPTY_ID_ERROR | This error is returned when attempting to complete a task when the provided task ID is empty. |
| FILE_PLAN_NOT_FOUND_ERROR | A file plan with the specified ID could not be found. |
| FOLDER_INVALID_TYPE_ERROR | The type provided for this folder is invalid. |
| FOLDER_MARKED_FOR_DELETION_ERROR | This error code is returned when the user tries to retrieve a folder already marked for deletion. |
| FOLDER_NOT_FOUND_ERROR | A folder with the specified ID value could not be found. |
| FOLDER_TYPE_NOT_FOUND_ERROR | Returned with the folder type could not be found |
| FORBIDDEN_ERROR | Returned when the user is forbidden to perform an action |
| GLOBAL_MANAGER_MODIFICATION_NOT_ALLOWED | Cannot modify a global manager. |
| GROUP_ACCESS_SECURITY_GROUP_PRIVS | Returned when attempting to access group privileges for a security group (such as agents) |
| GROUP_ADD_AND_REMOVE_USER_ERROR | Returned when a user appears in both the add and remove lists |
| GROUP_ADD_CURRENT_USER_ERROR | Returned when attempting to add the current user to a user group |
| GROUP_ADD_DELETED_USER_ERROR | Returned when attempting to add a deleted user to a user group |
| GROUP_ADD_ERROR | Returned when the user group could not be added |
| GROUP_ADD_OWNER_USER_ERROR | Returned when attempting to add the owner user to a user group |
| GROUP_ADD_SYSTEM_USER_ERROR | Returned when attempting to add a system user to a user group |
| GROUP_DEPT_ID_EMPTY_ERROR | Returned when the department ID is empty |
| GROUP_NAME_EMPTY_ERROR | Returned when the group name is empty |
| GROUP_NAME_INVALID_ERROR | Returned when the group name is invalid |
| GROUP_NOT_FOUND_ERROR | Returned when the user group could not be found |
| GROUP_NOT_REFERENCEABLE_BY_PRIV_TARGET | A privilege cannot be set because the group is not referenceable by the resource. |
| GROUP_REMOVE_CURRENT_USER_ERROR | Returned when attempting to remove the current user from a user group |
| GROUP_UPDATE_ERROR | Returned when a user group could not be updated |
| INSTANCE_NAME_CONFLICT | Returned when there is a conflicting instance name. |
| INSUFFICIENT_PRIVILEGES_ERROR | A generic error. The user does not have privileges to perform the requested action. |
| INTERNAL_ERROR | Returned when an unexpected condition prevented the fulfillment of the request |
| INVALID_CAPTURE_PROFILE_ERROR | Returned when category of capture profile id is invalid for capture group |
| INVALID_CAPTURE_SOURCE_TYPE_ERROR | The specified capture source type does not exist. |
| INVALID_DOCUMENT_VERSION_NUMBER_ERROR | Returned from calls that accept a document version number from the user. This code is returned when the version number given by the user cannot be parsed. (error.document.invalid.version.number=Invalid version number: {0}) |
| INVALID_EMAIL_METADATA_ID_ERROR | The capture group page email metadata ID was invalid. |
| INVALID_FOLDER_SEARCH_CRITERIA_ERROR | Missing or invalid folder search criteria for the search for folders by name call. |
| INVALID_GROUP_ERROR | A missing or invalid group was referenced. |
| INVALID_HOLD_REASON_ERROR | The specified hold reason item is invalid. |
| INVALID_MOVE_DESTINATION_ERROR | An invalid destination was specified when moving items. |
| INVALID_NAME_ERROR | The name is invalid when renaming a document or folder. |
| INVALID_PRIVILEGE_NAME_ERROR | A null or invalid privilege name was given in a privilege set. |
| INVALID_PRIVILEGE_SET_ERROR | The data in a given privilege set is invalid. |
| INVALID_PRIVILEGE_SET_TYPE_ERROR | The privilege set type is invalid |
| INVALID_PRIVILEGE_VALUE_ERROR | A null or invalid privilege value was given. |
| INVALID_TASK_STATE_ERROR | The task could not be completed or returned because it is currently in a state that does not permit these operations. |
| INVALID_VERSION_ERROR | Returned when the user is using an incompatible version of a call. |
| INVALID_VIEW_CATEGORY_ERROR | The specified view classifier or category is invalid for the view call. |
| INVALID_WORKFLOW_QUEUE_ITEM_STATE_ERROR | When setting a workflow item state, the specified state was either missing or could not be parsed. |
| ITEM_NOT_AVAILABLE_IN_WORKFLOW_QUEUE_ERROR | Returned from calls to set a workflow item state when the workflow item could not be found in the specified workflow queue. |
| LICENSE_ERROR | An error validating the license has occurred. |
| LIST_ITEM_NOT_FOUND_ERROR | Returned when a list item does not exist. |
| LOGIN_FAILED_ERROR | An error has occurred while attempting to logon. |
| LOGIN_PROFILE_NOT_FOUND_ERROR | The specified login profile is invalid. |
| MESSAGE_CALL_FAILED_ERROR | A generic error message indicating that some failure occurred. The error message should further indicate the nature of the error. |
| MISSING_HOLD_REASON_LIST_ERROR | The user tried to set an item on hold with a reason ID, but the workflow queue hold reason list has not been specified. |
| MISSING_OR_INVALID_DRAWER_CONTENT_ITEMS_ERROR | The drawer content items collection was missing or invalid when attempting to move instances to a drawer. |
| MISSING_OR_INVALID_FOLDER_CONTENT_ITEMS_ERROR | When moving items from one folder to another, items collection was missing or invalid. Not sure how this is different from MISSING_OR_INVALID_INSTANCE_TYPE_ERROR |
| MISSING_OR_INVALID_INSTANCE_TYPE_ERROR | An instance type required by the call was missing or invalid. This can be returned by the calls to move instances if the specified instance types are missing or are invalid. |
| NOT_FOUND_ERROR | Returned when a the information or object requested could not be found |
| NOT_LATEST_VERSION_NUMBER_ERROR | The call failed because the version number is not the latest version number in your ImageNow system. In completing a task, this assures ImageNow Server that tasks are not completed with respect to dated documents. |
| OUT_OF_OFFICE_ALREADY_EXISTS | Returned when you already have an out of office instance. |
| OUT_OF_OFFICE_CIRCULAR_DELEGATION | Returned when you specify a delegate that has you as their delegate. |
| OUT_OF_OFFICE_DELEGATE_NOT_FOUND | Returned when the specifed delegate user is not found. |
| OUT_OF_OFFICE_INSTANCE_NOT_FOUND_ERROR | Returned when the specified out of office instance does not exist. |
| OUT_OF_OFFICE_INVALID_DATE | The date specified was invalid. |
| OUT_OF_OFFICE_INVALID_USER | Returned when the specified out of office instance does not belong to the current user. |
| OUT_OF_OFFICE_REASON_CATEGORY_INVALID | Returned when the specified reason is not an out of office reason. |
| OUT_OF_OFFICE_REASON_NOT_FOUND | Returned when the out of office reason is not found. |
| OUT_OF_OFFICE_REASON_NOT_SET | Returned when the reason ID is not set. |
| OUT_OF_OFFICE_SELF_DELEGATION | Returned when you attepmt to specify yourself as your out of office delegate. |
| PAGE_NOT_FOUND_ERROR | Returned when a failure occurs trying to retrieve a document page. (error.page.logob.not.found=Logical object not found. Logob ID: {0}) |
| PAGE_RENDER_FAILED | Page rendering failed. |
| PATCH_OPERATION_NOT_SUPPORTED | Returned when invalid patch operation is supplied to a patch call. |
| PATCH_PATH_NOT_SUPPORTED | Returned when path argument is invalid for the object specified. |
| POOLED_USER_MODIFY_NOT_ALLOWED | Cannot modify a pooled user. |
| POSITION_NOT_PROVIDED_ERROR | Position not provided for connection |
| PROPERTY_NOT_FOUND_ERROR | A custom property with the specified unique ID could not be found. |
| RECORD_CATEGORY_NOT_FOUND_ERROR | A record category with the specified ID could not be found. |
| RECORD_CONNECTION_TYPE_NOT_FOUND | A connection type with the specified ID could not be found. |
| RECORD_FOLDER_NOT_FOUND_ERROR | A record folder with the specified ID could not be found. |
| RECORD_HAS_BEEN_DELETED_ERROR | The specified record has already been deleted. |
| RECORD_NOT_FOUND_ERROR | A record with the specified ID could not be found. |
| RECORD_TYPE_NOT_FOUND_ERROR | A record type with the specified ID could not be found. |
| REQUIRED_DATA_INVALID_ERROR | A generic error. One or more pieces of required data were invalid. |
| REQUIRED_DATA_LENGTH_ERROR | Returned when the length of a field is too long |
| REQUIRED_DATA_NOT_SET_ERROR | Generic error. One or more piece of required data for the call was missing. |
| RESOURCE_NOT_FOUND_ERROR | Not sure if this is misnamed, but it is returned when an invalid reason ID is provided when completing a task. |
| RETENTION_ITEM_HOLD_ERROR | The specified item is in a retention hold. |
| RETENTION_ITEM_PROCESSING_ERROR | The specified item is being processed by a retention policy. |
| RETENTION_ITEM_PROCESSING_SET_ERROR | The specified item is being processed in a set. |
| RETENTION_ITEM_PROTECTED_ERROR | The specified item is in a retention protected state. |
| SERVER_ENUM_TRANSFORM_ERROR | A generic error. An invalid enumeration constant was returned by the ImageNow server to Integration server. This is an internal error. |
| SET_WORKFLOW_ITEM_STATE_ERROR | A generic error setting the state of a workflow item. |
| SUBOBJECT_ADD_WRONG_VERSION_ERROR | There is a mismatch between sub object and document versions |
| SYSTEM_DRAWER_ACCESS_NOT_ALLOWED | Cannot access a system drawer. |
| SYSTEM_USER_ACCESS_NOT_ALLOWED | Cannot access a system user. |
| SYSTEM_USER_MODIFY_NOT_ALLOWED | Cannot modify a system user. |
| TASK_LOCKED_ERROR | The user attempted to change the state of a task that is locked (perhaps because it is being worked on by another user). |
| TASK_NOT_FOUND_ERROR | A task with the passed ID could not be found. (error.task.task.not.found=Task not found. Task ID: {0}) |
| UNAUTHORIZED_ERROR | Returned when a user is unauthorized |
| UNKNOWN_ERROR | An unknown error has occurred. |
| UNSUPPORTED_FILE_TYPE | Rendering is not supported for the page's file type. |
| USER_ACCESS_SELF_ERROR | Cannot get or modify yourself |
| USER_ACCESS_SYSTEM_USER_PRIVS | Returned when attempting to access user privileges for a system user (such as agents) |
| USER_ADD_AND_REMOVE_GROUP_ERROR | Returned when the group appears in the to add and to remove lists |
| USER_ADD_ERROR | Returned when the user could not be added |
| USER_ADD_GROUP_ERROR | Returned when the group could not be added |
| USER_DELETED_ERROR | Returned when the user is deleted |
| USER_DELETE_SELF_ERROR | Returned when attempting to delete yourself |
| USER_ID_NOT_FOUND_ERROR | Returned when a user with the given ID could not be found |
| USER_MODIFY_SELF_ERROR | Returned when a user attempts to modify itself |
| USER_NAME_FIELD_REQUIRED_ERROR | Returned when a username field is missing |
| USER_NAME_INVALID_ERROR | Returned when the user name is invalid |
| USER_NAME_PARAMETER_REQUIRED_ERROR | Returned when an invalid parameter is used trying to retrieve a user's groups |
| USER_NOT_ASSIGNED_TO_TASK_ERROR | The user attempting to complete a task is not the user to whom the task is assigned. |
| USER_NOT_FOUND_ERROR | Returned when a failure occurs trying to retrieve a user |
| USER_POOLED_GROUP_ERROR | Returned when attempting to add or remove a user to or from a pooled group |
| USER_PROMOTION_ERROR | The specified user cannot be promoted |
| USER_REMOVE_GROUP_ERROR | Returned when the group could not be removed |
| USER_SECURITY_GROUP_ERROR | Returned when attempting to add or remove a user to or from a security group |
| USER_SYSTEM_GROUP_ERROR | Returned when attempting to add or remove a user to or from a system group |
| USER_UPDATE_ERROR | Returned when the user could not be updated |
| VERSION_IS_PRIVATE_ERROR | The specified version of the document is private. |
| VERSION_NOT_FOUND_ERROR | The specified version of the document was not found. |
| VIEW_NOT_FOUND_ERROR | Returned with the view could not be found |
| WORKFLOW_ITEM_NOT_FOUND_ERROR | Returned with the workflow item could not be found |
| WORKFLOW_ITEM_STATE_ALREADY_WORKING_ERROR | This error code is returned when the user tries to set a workflow item state to 'Working' when the state of the item is already 'Working'. |
| WORKFLOW_QUEUE_NOT_FOUND_ERROR | Returned with the workflow queue could not be found |