Operation result
A JSON representation of the operation execution log. Includes the outcome of the operation, information about triggered business rules, and any warnings or errors that might have occurred during execution.
Attributes
Examples
- Success
-
{ "resultType": 0, "innerMessages": [], "exception": null, "actualObjectDN": "CN=John Smith,OU=Users,DC=example,DC=com", "extraInfo": {} } - Succeeded with warnings
-
{ "resultType": 0, "exception": null, "innerMessages": [ { "source": null, "text": "The password wasn't set because of the following error: Unable to update the password. The value provided for the new password does not meet the length, complexity, or history requirements of the domain. (Server: example.com) The password policy requires that the password: - must be at least 3 characters.", "messageType": 1, "innerMessages": [] }, { "source": null, "text": "Property 'userAccountControl' wasn't set because of the following error: Unable to update the password. The value provided for the new password does not meet the length, complexity, or history requirements of the domain. (Server: example.com)", "messageType": 1, "innerMessages": [] } ], "actualObjectDN": "CN=John Smith,CN=Users,DC=example,DC=com", "extraInfo": {} } - Operation suspended
-
{ "resultType": 2, "exception": null, "innerMessages": [ { "source": "Business Rules", "text": "1 rule encountered while processing your request", "messageType": 2, "innerMessages": [ { "source": "'Business Rule <name>'", "text": "Send this operation for approval.", "messageType": 3, "innerMessages": [ { "source": ', "text": "Request submitted for approval.", "messageType": 4, "innerMessages": [] } ] } ] } ], "actualObjectDN": "CN=John Smith,CN=Users,DC=example,DC=com", "extraInfo": {} } - Error
-
{ "resultType": 1, "exception": { "message": "This user doesn't have a mailbox." }, "innerMessages": [], "actualObjectDN": "CN=John Smith,CN=Users,DC=example,DC=com", "extraInfo": {} }
resultType enum
The outcome of the operation.
Show possible enum values
Success = 0, // Operation succeeded
Error = 1, // Operation failed
Suspended = 2 // Operation suspended by Adaxes
exception exception
Equals null if the operation succeeded or was suspended. Contains the exception message if the operation failed.
innerMessages OperationResultMessage array
An array of messages from the execution log. Each message can contain more inner messages that follow the same data structure.
Show attributes
innerMessages.source string
Name of the object source that generated the message. For example, the name of the triggered business rule. This attribute will be empty if there is no defined object source.
innerMessages.text string
Message text.
innerMessages.messageType enum
The type of the returned message.
Show possible enum values
Error = 0, // Error message
Warning = 1, // Warning message
Information = 2, // Informational message
TriggeredOperation = 3, // Business rule was triggered by the operation
ApprovalRequired = 4 // Main operation or the operation executed by a triggered business rule is sent for approval
innerMessages.innerMessages OperationResultMessage array
An array of nested messages. Each message can contain more inner messages that follow the same data structure.
actualObjectDN string
The distinguished name (DN) of the object the operation was performed on.
extraInfo info
This attribute will have a value only when creating Exchange mailboxes. Contains additional information about the created mailbox.
Show attributes
extraInfo.mailNickname string
Exchange alias of the mailbox.
extraInfo.mail string
Primary SMTP address of the mailbox.
extraInfo.homeMDB string
The name of the Exchange database where the mailbox was created.