Call this endpoint to retrieve the data output of a DTT. You will need to have initiated the download request (see here) to obtain a scheduled task id
GET
Request
Url Params
tenantId | int | Length --1 to 2147483647 | |
| scheduedTaskId | int | Length --1 to 2147483647 | the id of scheduled task for upload |
Authorization
The following authorisation header is required. The authorisation header should be set to a 'Bearer Token' type
Token |
Response
| Return | |
Status code | Description |
| 403 | Incorrect access for the request |
| 400 | Invalid request or data not found error (detail will be in the response) |
| 200 | The response message will contain the JSON data |
Permissions
The API Client requires read and write permissions to tenant company datatransfer templates to successfully retrieve results (See Admin User Roles for more details). Only tenants that the API client has access to will be returned.
Examples
C# Example
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://{platform API url}/api/admin/tenant/datatransfer/template/json/download/{{tenantId}}/{{scheduledTaskId}}");
request.Headers.Add("Authorization", "Bearer {{access_token}}");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
cURL Example
curl --location 'https://{platform API url}/api/admin/tenant/datatransfer/template/json/download/{{tenantId}}/{{scheduledTaskId}}' \--header 'Authorization: Bearer {{access_token}}'