Call this endpoint to start a download request for a DTT


POST    /api/admin/tenant/datatransfer/template/json/requestdownload


Request


The following form-urlencoded content needs to be sent in the request:


Body  

data requirements (mandatory data as per below)


jsonObject

 Max Length
Mandatory


tenantId
int
1 to 2147483647
Yesthe id if the tenant

tempalteName
string
200Yesthe name of datatransfer template




See How to create API Clients to see how to obtain API Client IDs and secrets


Permissions

The API Client requires permission to "Company Data Transfer Templates" and access to the user(s) to successfully to perform post requests (See Admin User Roles for more details).  Only tenants that the API client has access to will be returned.


Authorization

The following authorization header is required.  The authorisation header should be set to a 'Bearer Token' type


Token
see How to get a bearer token


Response


Return
Status
code
Description
403Incorrect access for the request
400Invalid request or unexpected error (detail will be in the response)
200The download request has been submitted successfully. An integer will be returned that signifies the job id (scheduledTaskId) to use in checking the request's status



C# Example:


var client = new HttpClient(); 
var request = new HttpRequestMessage(HttpMethod.Post, "https://{platform API url}/api/admin/tenant/datatransfer/template/json/requestdownload");
var content = new StringContent("{\"DataTransferDownloadCreateJsonRequestDTO\": [{\r\n\"tenantId\": \"tenant_id\", \r\n\"templateName\": \"template_name\n        }\r\n    ]\r\n}", null, "application/json");
request.Content = content; 
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/executereoprt' \--header
'Content-Type: application/json' \ --data- {"DataTransferDownloadCreateJsonRequestDTO": [{"tenantId": "tenant_id", "templateName": "template_name}]}'