The RESTAPICommandInformation type is used hold information about a REST API command that is used to read the result of calling a custom API.
Below are the properties and their purpose.
- string CommandName
- Default Value: Empty string.
- Intended Value: The name of the command.
- Guid SessionGUID
- Default Value: Empty Guid.
- Intended Value: The guid of the current users active 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 the current instance.
- Guid TargetInstanceGUID
- Default Value: Empty Guid.
- Intended Value: The guid of the instance the command was executed on.
- string UserMessage
- Default Value: Empty string.
- Intended Value: Contains a string that determines if a conditional filter should be added to the form.
- string ErrorMessage
- Default Value: Empty string.
- Intended Value: Contains an error message if something during processing fails.
