The ExecuteCommandInformation type is used hold information about a command that can be passed between the UX and APIs.
Below are the properties and their purpose.
- Guid SessionGUID
- Default Value: Empty Guid.
- Intended Value: The guid of the users current session.
- Guid UserGUID
- Default Value: Empty Guid.
- Intended Value: The guid of the current user.
- Guid CurrentInstanceGUID
- Default Value: Empty Guid.
- Intended Value: The guid of current instance the user is on.
- Guid TargetInstanceGUID
- Default Value: Empty Guid.
- Intended Value: The guid of the instance the command will be executed on.
- Guid CommandGUID
- Default Value: Empty Guid.
- Intended Value: The guid of the command.
- string CommandTarget
- Default Value: Empty string.
- Intended Value: The target/endpoint to be called for this command.
- string CommandName
- Default Value: Empty string.
- Intended Value: The name of the command to execute.
- string UserMessage
- Default Value: Empty string.
- Intended Value: Currently not being used.
- string ErrorMessage
- Default Value: Empty string.
- Intended Value: A message detailing what went wrong if something failed on the API so it can properly be handled on the UX.