Call this endpoint to retrieve the status of a DTT upload or download


GET 

 /api/admin/tenant/datatransfer/template/status/{tenantId}/{scheduledTaskId}

Request


Url Params

tenantId
intLength --1 to 2147483647
the id of the tenant
scheduedTaskIdint 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
see How to get a bearer token



Response

Return
Status code
Description
400Incorrect access for the request
403Invalid request or unexpected error (detail will be in the response
200
ResponseDetail
NotExecutedThe upload request (job) has not yet been looked at
QueuedThe job has been picked up by the task runner and is ready to process
IsExecutingThe job is processing. This means it is either being validating or data is being processed
FailureThe job has failed
SuccessThe job has completed successfully



Permissions

The API Client requires at least readonly permissions to Tenant company datatransfer template 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/status/{{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/status/{{tenantId}}/{{scheduledTaskId}}' \--header 'Authorization: Bearer {{access_token}}'