Uploading a File for File-based Search
Learn about uploading a file with a list of values, using this API.
Use this API to upload a file with a list of values. Those values are uploaded to the internal cloud storage. Use them in the search filters.
Request
POST https://{env}.reltio.com/reltio/api/{tenantID}/valueList| Parameters | Name | Required | Details | Type |
|---|---|---|---|---|
| Headers | Authorization | Yes | The Headers provides information about authentication
access token in the format of "Bearer accessToken".
For more information, see topic Authentication API. | String |
Content-Type | Yes | You must add the Content-Type as Content-Type:
multipart/form-data. | ||
| Form | file | Yes | You must specify a Local/publicly available TXT or CSV file as a Form parameter.
Note: Limitation for supported file size is 10 MB or 5000 rows.
Before selecting a file, make sure that the number of rows in
the file does not exceed 5000. You can upload multiple files, but ensure the combined file size of all the files does not exceed 10 MB, and the total number of rows in all files does not exceed 5000.
| File |
Response
Check the listed fields and description:
| Field Name | Type | Description |
|---|---|---|
| path | String | Represents the internal file path used in the search filter. |
| downloadLink | String | Represents the presigned URL for direct file access, valid for a limited time interval till the expiry date. |
| expirationDate | Date and time | Represents the expiry date for the presigned URL. |
Example Request
cURL POST request URL example: https:/Your_environment.com/Your_environment/api/auto20240807jcWKL/valueList
curl --request POST --url 'https://Your_environment.com/Your_environment/api/auto20240807jcWKL/valueList' \
--header 'Content-Type: multipart/form-data' \
--header 'Authorization: Bearer NNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNN' \
--form 'file=@"C:\!Your_environment\file.txt"'
Example Response
{
"path": "s3://bucketName/envName/valueListFiles/01-Jan-2021/TenantID/data053231.txt",
"downloadLink": "https://bucketName.s3.amazonaws.com/envName/valueListFiles/01-Jan-2021/TenantID/data053231.txt?presignedURLInfo",
"expirationDate": "2021-01-01T12:32:33.608+0000"
}