POST
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 | Yes | the id of the tenant | |
tempalteName | string | 200 | Yes | the name of data transfer template | |
| jsonData | string | maximum allowable limit of api call(1048500) | Yes | a JSON array containing objects of data to upload. Each object in the array is a record detailing field names and values. | |
| dttUploadName | string | 200 | No | The name that will appear for the upload in MyWorkPal. If omitted, 'Json DTT Upload' will be used | |
| fileName | string | 200 | No | The JSON array will be converted to an XLSX file on the MyWorkPal system. You can specify the name of the file here . If omitted, 'Json upload file' will be used | |
| uploadDescription | string | 1000 | No | description of the data transfer upload. | |
| sendEmailWhenComplete | bool | 1 | No | indicates whether email notifications are sent when the data transfer template upload completes |
See How to create API Clients to see how to obtain API Client IDs and secrets
Please note that the JSON schema will vary depending on the DTT configuration. A DTT is a collection of field mapping, where fields are mapped to entities on MyWorkPal. A DTT can be configured to have as many or as little field mappings as required. The JSON object posted to the endpoint must correlate to the DTT configuration. For example, if a DTT has been defined with the following fields:
Forename
Surname
DOB
The posted JSON object will need to confirm to the following schema:
[
{ "Forename" : "John", "Smith" : "Alpha", "DOB" : "01/01/1960" },
{ "Forename" : "Ted", "Jones" : "Bravo", "DOB" : "10/06/1965" }
]
Permissions
The API Client requires write 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 |
Response
| Return | |
Status code | Description |
| 403 | Incorrect access for the request |
| 400 | Invalid request or unexpected error (detail will be in the response) |
| 200 | The upload 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/upload");
var content = new StringContent({\"DataTransferUploadCreateJsonRequestDTO\": [{\r\n\"tenantId\": \"tenant_id\", \r\n\"templateName\": \"template_name\",\r\n\"jsonData\": \"json_data\",\r\n\"dttUploadName\":\"dttupload_name\",\r\n\"fileName\": \"file_name\",\r\n\"uploadDescription\": \"upload_description\",\r\n\"sendEmailWhenComplete\": \"send_email_when_complete\"}\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-'{"DataTransferUploadCreateJsonRequestDTO":[{"tenantId": "tenant_id", "templateName": "template_name","jsonData": "json_data","dttUploadName":"dttupload_name","fileName": "file_name","uploadDescription": "upload_description","sendEmailWhenComplete": "send_email_when_complete"} ]}'