Data Files

Data File endpoints helps to store the customer information and associated data. The request should be submitted on JSON format from the Deamon application side. There are four types of endpoints which helps to store the Data files into Fusion

Post Data File

Http Method              : Post

URL                                 : /api/FusionApi/DataFiles

Use this endpoint to post collection of data files in base64 encoded format string. Place the base64 encoded file string in the FileData attribute of the JSON payload. Any optional metadata associated with the file can be passed in the attributes of the JSON payload.AdditionalData attribute supports flexible data payload in JSON format. Pass any valid JSON in the additional data attribute section. Back-end system processing the data will have to be aware about the JSON schema to process it. JSON schema public URI maybe passed in the AdditionalDataSchemaId attribute so that backend process can use it for any specific processing.

Limitations:

1. Supports max payload size of 500 MB per request.

2. File hash validation is only done when FileHash and FileHashType values are provided.

3. Review the DataFileRequest schema for the required attributes marked with an asterisk.

Example JSON Payload

{

"orderId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"usageId": 0,

"solutionsId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"subjectHandle": "string",

"records": [

{

"recordHandle": "string",

"fullName": "string",

"firstName": "string",

"lastName": "string",

"emailAddress": "user@example.com",

"phone": "string",

"addressLine1": "string",

"addressLine2": "string",

"addressLine3": "string",

"addressLine4": "string",

"addressLine5": "string",

"city": "string",

"state": "string",

"postalCode": "string",

"country": "string",

"additionalData": {},

"additionalDataSchemaId": "string",

"fileName": "string",

"fileData": "string",

"fileHash": "string",

"fileHashType": "string"

}

]

}

Request Array Parameters

Responses

The below tabs show the list of expected response from post data file endpoint.

Post - MultiPartFileWithDataRecord

Http Method              : SinglePost

URL                                 : /api/FusionApi/DataFiles

Use this endpoint to post a file with data using multipart-form. Any optional metadata associated with the file can be passed in the attributes of the JSON payload. AdditionalData attribute supports flexible data payload in JSON format. Pass any valid JSON in the additional data attribute section. Back-end system processing the data will have to be aware about the JSON schema to process it. JSON schema public URI maybe passed in the AdditionalDataSchemaId attribute so that backend process can use it for any specific processing.

Limitations:

1. Supports file size up to 2 GB.

Request Body Parameters

Responses

The below tabs show the list of expected response from post a file with metadata using multipart form endpoint.

Post - MultiPartFileUpload

Http Method              : SingleFilePost

URL                                 : /api/FusionApi/DataFiles

Post a file using multipart from.

Limitations:

1. Use this endpoint to post a file using multipart-form. Supports file size up to 2GB.

Request Body Parameters

Responses

The below tabs show the list of expected response from post multipart file upload endpoint.

Post - Chunks

Http Method              : Chunks

URL                                 : /api/FusionApi/DataFiles

Create file chunk reference. Fusion supports posting large file using file chunk operation. Posting file chunks is a multiple step process. Create a file chunk reference using this endpoint. Returns a file GUID as a reference. Upload the file chunk with the chunk number and provide the file chunk reference in the request.

For example, if you have 3 file chunks, upload each file chunk with incrementing file chunk number and the file GUID reference. Commit the file chunks after all the chunks are posted. This will combine the file chunks together and store the file in the storage.

Please note that this endpoint is a synchronous operation.

Example JSON Payload

{

"orderId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"usageId": 0,

"solutionsId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"subjectHandle": "string",

"records": [

{

"recordHandle": "string",

"fullName": "string",

"firstName": "string",

"lastName": "string",

"emailAddress": "user@example.com",

"phone": "string",

"addressLine1": "string",

"addressLine2": "string",

"addressLine3": "string",

"addressLine4": "string",

"addressLine5": "string",

"city": "string",

"state": "string",

"postalCode": "string",

"country": "string",

"additionalData": {},

"additionalDataSchemaId": "string",

"fileName": "string",

"fileHash": "string",

"fileHashType": "string"

}

]

}

Request Array Parameters

Responses

The below tabs show the list of expected response from chunks endpoint.

Post - UploadChunk

Http Method              : UploadChunk

URL                                 : /api/FusionApi/DataFiles

Upload file chunk. Fusion supports posting large file using file chunk operation. Posting file chunks is a multiple step process. Create a file chunk reference using the chunk endpoint. Returns a file GUID as a reference. Upload the file chunk using this endpoint with the chunk number and provide the file chunk reference in the request.

For example, if you have 3 file chunks, upload each file chunk with incrementing file chunk number and the file GUID reference. Commit the file chunks after all the chunks are posted. This will combine the file chunks together and store the file in the storage.

Please note that this endpoint is a synchronous operation.

Limitations:

1. You can use parallel process with up to 5 threads to upload multiple chunks for a single file.

Request body parameter

Example JSON payload

{

"guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"chunkId": 0,

"currentChunkSize": 0,

"chunkData": "string"

}

Responses

The below tabs show the list of expected response from chunk-upload endpoint.

Post - CommitChunk

Http Method              : CommitChunk

URL                                 : /api/FusionApi/DataFiles

Fusion supports posting large file using file chunk operation. Posting file chunks is a multiple step process. Create a file chunk reference using the chunk endpoint. Returns a file GUID as a reference. Upload the file chunk with the chunk number and provide the file chunk reference in the request.

For example, if you have 3 file chunks, upload each file chunk with incrementing file chunk number and the file GUID reference. Commit the file chunks using this endpoint after all the chunks are posted. This will combine the file chunks together and store the file in the storage.

Please note that this endpoint is a synchronous operation.

Request body parameter

Example JSON payload

{

"guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"chunkIds": [

0

]

}

Responses

The below tabs show the list of expected response from chunk-commit endpoint.

Delete DataFile

Http Method              : Delete

URL                                 : /api/FusionApi/DataFiles

Use this endpoint to delete the data file.

Request body parameter

Responses

The below tabs show the list of expected response from delete endpoint.

Get DataFile by Id

Http Method              : Get

URL                                 : /api/FusionApi/DataFiles

This endpoint returns the data file metadata information only.

Request body parameter

Responses

The below tabs show the list of expected response from get data file by id endpoint.

Post - Assign to Order

Http Method              : Post

URL                                 : /api/FusionApi/DataFiles

This endpoint associates DataFiles to an order. Accepts either DataFile SubjectHandle or DataFileIds to associate them to an Order.

Example JSON payload

{

"orderId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"dataFileSubjectHandle": "string",

"dataFileIds": [

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

]

}

Responses

The below tabs show the list of expected response from datafile assign to order endpoint.