Transfer Data REST API

{
"DataLoadRuleConfig": {
"dataLoadRuleId": 600058,
"dataLoadRuleName": "REST_FL_Test_2_XLSX",
"rowDelimiter": "|",
"columnDelimiter": ",",
"callbackOptions": {
"httpMethod": "POST",
"url": "https://fpa-infra.planfuldev.com//financemodel/data/CallbackToLog"
}
},
"payload": "03,310|04,410"
}

HTTP/1.1 200 OK

{   
"DataLoadRuleId": 600058,    
"ExcecutionId": "09c8ca47-2ff8-418c-81ce-ede50ae44a91",    "ChunksRecieved": 2,    
"RecordsRecieved": 4,    
"RunAsynchronously": false,    
"Attempts": 1
}

Last Request

The request for the last batch of data must have the following parameters;

Method

PUT

Endpoint Url Syntax

<Provide Application Url>/financemodel/data/transfer

Headers

Sample Body

{
"DataLoadRuleConfig": {
"dataLoadRuleId": 600058,
"dataLoadRuleName": "REST_FL_Test_2_XLSX",
"rowDelimiter": "|",
"columnDelimiter": ",",
"callbackOptions": {
"httpMethod": "POST",
"url": "https://fpa-infra.planfuldev.com//financemodel/data/CallbackToLog"
}
},
"payload": "05,11|06,12"
}

You can also send the last request without the IsLoadComplated header and add a Null value for the payload. Following is the sample request 

{
"DataLoadRuleConfig": {
"dataLoadRuleId": 600058,
"dataLoadRuleName": "REST_FL_Test_2_XLSX",
"columnDelimiter": ",",
"callbackOptions": {
"httpMethod": "POST",
"url": "https://fpa-infra.planfuldev.com//financemodel/data/CallbackToLog"
}
},
"payload": null
}

Sample Response

HTTP/1.1 200 OK 
{    
"DataLoadRuleId": 600058,    
"ExcecutionId": "09c8ca47-2ff8-418c-81ce-ede50ae44a91",    "ChunksRecieved": 3,    
"RecordsRecieved": 6,    
"RunAsynchronously": false,    
"Attempts": 1,    
"TransferResponse": {        
"Success": true,        
"Message": "Data Transferred Successfully."    
}
}

Platform: Reset Data Load with Transfer API

From this release, if needed you can now reset any ongoing data load, and start a fresh one. Add the following Header to the Transfer Data API call along with the fresh payload.

ResetDataLoad

Passing the value of DataLoadExecutionId is optional at the moment and it’s recommended to keep the ResetDataLoad parameter value empty. You can reset the ongoing data load only if you have started it.

You can even send the IsLoadCompleted header as True if this is the only chunk you want to load while resetting the previous execution.

Platform: Retry a Failed Data Load with Transfer API

From this release, you can now retry a failed data load. If any data load fails for any reason, and you wish to retry the failed data load after fixing the issue, run the API again and the API will retry the data transfer.

This is more useful when you are loading the data in chunks. You can send the execution ID (this is optional) of the failed DLR, and payload as NULL to retry the transfer. This avoids starting the process from the beginning if any DLR fails. However, there are some conditions the DLR has to meet if you want to retry the data load:

• The DLR should not have any other execution since a failed data load.
• You can retry executing the DLR within 8 hours of a failed data load.

GetDataLoadStatus API

When you initiate a DLR execution through REST API, the API will return an Execution ID in the response. You can now use that Execution ID to know the status of a DLR execution. Following is the GetDataLoadStatus API endpoint:

GET /<application URL>/financemodel/data/GetDataLoadStatus?ExecutionId=<Exec Guid>

Sample Response Body :

{    
"ExecutionId": "bdc0a259-7348-44a3-89b8-f380bdae2dc7",
"ChunksRecieved": 1,    
"RecordsRecieved": 11,    
"LastBatchRecievedDateTimeUtc": "2022-07-15T12:37:05.84",
"LoadCompletedDateTimeUtc": "2022-07-15T12:37:05.867",
"TransferStartedDateTimeUtc": "2022-07-15T12:37:05.9", 
"TransferCompletedDateTimeUtc": "2022-07-15T12:37:14.917",
"Attempts": 1,    
"ExecutionStatus": "Processed"
}

This API now fetches information about both Sync and Async API execution types and is available in the API response. The API can return any of the following execution statuses:

• Uploading
• Uploaded
• Processing
• Processed
• Failed
• Abandoned

Get Running Data Load Status API

You can use the GetRuningDataLoadStatus API to know if there is any execution going on for any DLR. This API just required the DLR name as the query string parameter and it retrieves detailed information about the execution. If there is no active DLR execution, then the API will return a “404 Not Found” message.

Rest API Endpoint - GET /<application URL>/financemodel/data/GetRuningDataLoadStatus?dlrName=<>

Sample Response if there is no ongoing DLR execution:

HTTP/1.1 404 Not Found

Requested data not found. No data load in progress for this DLR 'S - Rest WS GL'

Sample Response if there is any ongoing DLR execution:

{    
"ExecutionId": "ce8ba642-8f6f-4041-a706-fa602eced7c7",
"ChunksRecieved": 1,
"RecordsRecieved": 11,
"LastBatchRecievedDateTimeUtc": "2022-07-21T21:54:15.157",
"LoadCompletedDateTimeUtc": "2022-07-21T21:54:15.21",
"TransferStartedDateTimeUtc": "2022-07-21T21:54:15.26",
"Attempts": 1,
"ExecutionStatus": "Processing"
}