Log Execution Message APIs
The Log Execution Message APIs enable management and interaction with execution log messages generated during RPA job runs. These messages are created by the Log Execution Message activity in RPA Studio and are securely stored within the RPA platform.
The Log Execution Message APIs support these operations:
- Saving new log messages
- Retrieving messages for a specific job instance
- Accessing individual log messages by ID
- Updating existing log messages
These Log Execution Message APIs are available:
| Method | Endpoint | Description |
|---|---|---|
| POST | /api/v1/rpa/logexecution/message/save | Saves a new log execution message for RPA job tracking. The message content is encrypted before storage. |
| GET | /api/v1/rpa/logexecution/messages/{jobInstanceId} | Retrieves all log execution messages for a specific job instance. Returned messages are decrypted. |
| GET | /api/v1/rpa/logexecution/message/{messageId} | Retrieves a single log execution message by its unique integer ID. Returns 404 if the message does not exist. |
| PUT | /api/v1/rpa/logexecution/message/{messageId} | Updates the message content of an existing log execution message identified by its ID. Only the message field is updated; all other fields remain unchanged. The updated content is encrypted before storage. Returns 404 if the message does not exist.. |
The GET and PUT endpoints that use messageId are useful for retrieving or modifying a specific log entry without retrieving the entire job log history. All API endpoints follow standard RPA authentication and multi-tenancy patterns and require the appropriate authorization headers.