Overview
Etlworks creates a unique log file for each executed Flow. Use this API endpoint to download the log file.
Authentication
Before making a call to the built-in API, the user must receive a JWT token from the authentication API.
Step 1. Use any user with the Operator, Editor, or Administrator role in calling an Etlworks authentication endpoint and receiving an access token.
Step 2. Use the access token received in Step 1 to call Etlworks API endpoints. The access token must be submitted as a header parameter, as in: Authorization:Bearer access-token.
Note: Access tokens in Etlworks are short-lived and self-expiring. An access token gives you access to the APIs for approximately 10 minutes. It is recommended that you refresh the access token before each call to the API.
Important: The API endpoint parameters
- PATH: /rest/v1/executions/console/download?flowId={flowId}&auditId={auditId}&Authorization=Bearer%20{token}
EXAMPLE: https://app.etlworks.com/rest/v1/executions/console/download?flowId=123&auditId=45&Authorization=Bearer%20eyJ0eXAiOiJKV1QiLCJhbGci...
- LEGACY PATH (we keep it for backward compatibility): /plugins/dashboard/rest/v1/flows/console/download?flowId={flowId}&auditId={auditId}&Authorization=Bearer%20{token}
flowId=long: the Flow ID can be found in the Flows.
auditId=long: the audit ID can be found in the audit trail log or in the response when the Flow is executed by name.
-
- Authorization=string: authorization token can be received from the authentication API endpoint.
- METHOD: GET
- REQUEST BODY: none
Response
The response if a file: Content-Disposition: attachment
Response Codes
- 200 for success
- 401 and 403 for not authorized
- 500 for an internal error