ErrorCode Enumeration

This enumeration contains error codes that are detected by the API

Namespace: Articy.Api
Assembly: PublicApiTypes (in PublicApiTypes.dll) Version: 1.0.0

Syntax

public enum ErrorCode

Members

Member name	Value	Description
NotInitialized	0	the API was not initialized before trying to create a session
AlreadyInitialized	1	tried to initialize more than one time
DotNetFrameworkNotFound	2	the required .NET framework was not found
Internal	3	thrown when an internal error occured in the a:d logic
GenericException	4	an unexpected exception from a lower level system was catched and wrapped
ProjectNotFound	5	the project given to load is unknown (either missing rights, deleted or never existing)
SourceControlError	6	an exception was catched that originates from source control (-> see inner exception)
UnknownServerError	7	an articy:server exception was catched but there is no RpcStatusCode available for a more detailed error
UnknownExport	8	the exports technical name is not known
InvalidExportDescriptior	9	failed to parse the export descriptor or missing export type in root element
NotConnected	10	an command was issued that requires to be logged on
ColumnNotFound	11	a column was not found on a given object
WriteDenied	12	writing to a row was denied because the row is read-only
ObjectNotAvailable	13	an object that was encapsulated by an proxy does not exist any more
InvalidState	14	a call is impossible in the current object/project state
UnknownPartition	15	the given partition guid is unknown
PartitionNotClaimed	16	tried to unclaim a partition that the API user does not own
CantForcefullyUnclaimOwnPartition	17	tried to forcefully unclaim an own partition
ProjectNotOpen	18	is thrown when a method expects an open project but there is no open project
ProjectOpen	19	is thrown when a method expects that no open project exist but there is a open project
CantSetCalculatedProperty	20	tried to write a calculated property
PropertyNotFound	21	the given property does not exist for the given object
UnexpectedObjectClass	22	the given class was not expected to be API exposed
ObjectNotCustomizeable	23	tried to set a feature value on a non customizable object
NoTemplateSet	24	tried to set a feature value on a object without a set template
FeatureNotPresent	25	tried to set a feature value where the object does not contain that feature
CantSetStrip	26	a strip can't be set directly
UnsetObjectStrip	27	thrown when trying to access an unset object collection
UnknownDataType	28	a value getter or setter encountered an unknown data type
UnknownDataSubType	29	a value getter or setter encountered an unknown data sub type
InvalidValue	30	the given value is not allowed for setting it to a property
ObjectCreationForbidden	31	it is forbidden to create an object of this type at this target
CantOpenProject	32	thrown when a project can't be opened
NeedExclusiveModeToOpen	33	thrown when a project needs an exclusive mode to open but the flag was not set
NotAllowedInExclusiveMode	34	thrown when partition actions are used in exclusive mode
UnknownTemplate	35	the referenced template does not exist (either name or ID)
TemplateNotAllowedForObject	36	the template exists but is not allowed for the object
CantSetReadOnlyProperty	37	tried to set a property that is read-only
CantSetObjectAggregates	38	thrown when properties of data subtype "Model" are tried to be written by the API
ObjectIsNotConnectable	39	thrown when a connectable object is needed (adding pins for example)
ForbiddenPinCount	40	thrown when a the operation would result in a forbidden pin count
FatalErrorDetected	41	thrown when a fatal error in the business logic was detected
UnsupportedObject	42	thrown when trying to access an object that is not allowed for API use
IndexOutOfRange	43	list access with index out of range
ParentDoesNotAllowFolders	44	thrown by create folder if the parent does not allow it
ObjectNull	45	thrown then a non-null object proxy was expected but null was found
InvalidParentForCreate	46	thrown when a object creation fails due to a wrong parents. E.g. Trying to import an Asset into an EntityUserFolder
NeedMoreVertices	47	thrown when creating a path or polygon with violated minimum vertex count
WrongReferencedObjectType	48	thrown when wrong object type is assigned to an object reference (Link or Jump for example)
InvalidTechnicalName	49	thrown when an internal error occurred in the a:d logic
DisplayNameMustNotBeEmpty	50	thrown when a display name is null, empty or only contains whitespace chars
ParseException	51	thrown if parsing a query reported an error
AssetsNotReady	52	asset system is not clean and not ready for unclaim
PartitionClaimed	53	You tried to update a partition that you already have claimed
InvalidDataFound	54	This error code denotes that a folder given as project folder contains a non matching project or no project at all
MissingProjectFolder	55	This error code is thrown when an open project does not know where to place the project data. E.g. the project was never opened and no Project-Folder was given in the open args.
ExportFailed	56	This error code is thrown when an export could not completed successfully. The reason may either be an unexpected exception from the lower layer or most likely an error condition that was also reported to the logging callback (if set)
AssetObjectExpected	57	This error code is thrown when an asset object is expected but was not given.
AssetFileNotFound	58	This error code is thrown when an asset
DeleteNotAllowed	59	This error code is thrown when a delete is not allowed. This can be the case if an inner object is a partition root object.
CantDeletePartitionRoot	60	This error is thrown when you try to delete an object that is the root of a partition
CantDeleteSystemFolder	61	This error is thrown when you try to delete a system folder object (e.g. Assets)
WrongContextForDocument	62	operations on documents require a context object, that must be a document or a child of a document. If this is not the case this exception is thrown.
WrongContextObjctTypeForDocument	63	Only Documents & TextObjects are allowed to have children in a document.
InvalidHierarchyAdjustment	64	This error is thrown if the hierarchical placement of a new document element is not allowed. e.g. Trying to add an TextObject as sibling of an Document object.
DocumentObjectExpected	65	This error is thrown when an document object was expected as parameter but another was given.
ComponentLicenseMissing	66	This error is thrown when a functionality is used which needs a specific license, but this license is not present.
InvalidQuery	67	This error is thrown when a calculated reference strip is accessed, but executing the query fails for some reason.
InvalidVariableName	68	This error is thrown when the given full qualified variable name is malformed.
NameNotUnique	69	This error is thrown when a variable or variable set name is already used.
ExpressionError	70	This error is thrown when an expression contains an error.
NonScriptableProperty	71	This error is thrown when trying to validate an expression on a property that does not support scripting.
ObjectNotPartitionable	72	This error is thrown when trying to partition an object that cannot be a partition.
RepartitioningFailed	73	This error is thrown when a repartitioning action failed.
WrongObjectType	74	This object passed to a function is of the wrong or an unsupported object type
ParentNotClaimed	75	This error code is throw when using accessing the position/sizing members of an flow-item and the parent-container object is not claimed.
CantAddPin	76	This error code is throw when trying to add a pin to an object that either has no pins (e.g Entity), does not allow to add pins (e.g. Condition) or has reached the limit of allowed pins (currently 10)
CantRemovePin	77	This error code is throw when trying to remove a pin from an object that has no pins (e.g. Entity) or does not allow to remove pins ( e.g. Condition)
StandaloneMultiUserExpected	78	This error code is throw when trying execute session commands that are only available for stand-alone multi-user programs (e.g. OpenProject)
MultiUserExpected	79	This error code is throw when trying execute session commands that are only available for multi-user API programs (e.g. GetUsers)
ServerExceptionCatched	65636	An exception was catched, no detailed error reason available
MandatoryParameterMissing	65637	The call could not be process because mandatory parameters were missing
NotANumber	65638	The parsing of a number failed
AccessDenied	65639	The requesting user did not have the required rights to access/modify the requested information
InvalidServerState	65640	The call could not be completed in the current server session state. (e.g. trying to login when a authenticated session already exists)
DataInconsistent	65641	Some consistency checks on the given parameter have failed
DatabaseException	65642	An error from the database query layer has been catched
NoSession	65643	A method that expected an existing session was called, but the session is not available
RequestTimeout	65644	The processing of a method did not return in time
RemoteRequestTimeout	65645	The processing of an upsteam call (e.g. License-Server) did not return in time
NoActiveConnection	65646	There was not active connection at the time a call was issued.
ServerDbUnavailable	65647	This error code is thrown if you try to login to an server which did not have its database ready
ServerFail	65648	generic error if the server reaches a code point where other checks already should have stopped the processing
RemoteServerException	65649	The processing of an upsteam call (e.g. License-Server) has thrown an exception.
UserNotFound	65736	the requested user was not found on the server or was deactivated
InvalidPassword	65737	the password (hash) does not match
LoginNotAllowed	65738	The login was denied because the same user has an active session from a different machine
CantCreateUser	65739	The new user row can't be created because either the user already exists or no license is available
CantUpdateUser	65740	The user row can't be updated because the login name conflicts with an already existing user
ProjectNotFoundOnServer	65836	The requested project was not found (or deactivated)
CantOpenExclusive	65837	The requested project can't be opened exclusive (already exclusively open elsewhere or locks are present)
ProjectAlreadyOpen	65838	The server known that you have the project already open (it is not allowed to open the same project twice at the same time)
ClaimsPresent	65839	When you try to claim an partition and that partition is already claimed, this error is thrown
ProjectAlreadyOpenedExclusive	65840	The project can't be opened because it already is open exclusive by another user
ProjectDeactivated	65841	You tried to open a deactivated project
ProjectUnavailable	65842	You tried to open an project that is temporarily unavailable (e.g. a ForcefullyUnclaimPartitions command is pending)
UsersWorking	65843	Tried to initiate a "forcefully unclaim all partitions" command while users are working in the project and you did not specify to kick those users
NeedExclusiveModeToCleanup	65844	Project needs an exclusive mode to cleanup
RepartitioningActive	65845	Current operation can't be executed because the publishing/commiting of an repartitioning is pending. Try again later.
NoClaimPresent	65936	You tried to forcedully unclaim a partition that is not currently claimed
NeedsFullUpdate	65937	The project was repartitioned, before new claims can be taken, a full project update needs to be done.
NoLicense	66036	You tried to log into a server that has no license. (SystemAdmin user can still log-in to fix this)
ServerLicenseExpired	66037	The articy:server main product license has expired
ServerLicenseAlreadyActivated	66038	The articy:server was requested to activate a license, but is already licensed
LicenseKeyMismatch	66039	The license update for the server returned a license key that was not requested (should never happen)
NoApiLicense	66040	A user tried to login using the articy:draft API but the server was not licensed for API usage
NoCAL	66136	A user logged in that did not have a client access license assigned (either multi-user or viewer)
DowngradeRequired	66138	The server admin tries to change the license of a user to a more restrictive license (e.g. from "multi-user" to "viewer"), but the user is member of a project and has access that is not covered by the requested license. The downgrade is automatically done when the matching checkbox in the editing dialog is checked
InsufficientCAL	66139	This error is returned when you try to give a user higher access than it current license allows (e.g. TeamMember level for a user with viewer license)
NoCALAvailable	66140	This error is returned when you try to upgrade a user to a new CAL, but all free licenses are already used
Underlicensed	66141	This error is returned when a user tries to log on an the CAL type the user owns has more licenses used than allowed. This error only can arise with CALs that have an expiry date.
CantEnterPartitioningMode	66236	This error is returned when a user tries to enter the repartitioning mode, but another user already uses it.
CantConnectArticyServer	69632	This error is thrown when the given server can't be connected
ArticyServerToOld	69633	This error is thrown when the connected articy:server has a version that is to low to operate with
ArticyServerToNew	69634	This error is thrown when the connected articy:server has a version that is to new to operate with
NoArticyServerInfoAvailable	69635	This error is thrown when articy:draft was no possible to retrieve the server capability/version information

Reference

Articy.Api Namespace