Import File

post http://{{url}}/v1/clients/{clientId}/file-import

Trigger a file import

Behaviour

This API is used to initiate a file import into the FDP. It creates a pending file import entry, which waits for the corresponding file to be uploaded to our cloud storage system.

The response will include metadata related to the file import, along with a URL enabling direct upload access to our cloud storage system. This URL is secured with a short-lived access token, valid for up to 5 minutes, and supports file uploads of up to 1000 MB.

Example Response

{
    "fileImport": {
        "id": "6732115e04a38be4f744fa21",
        "clientId": "CORTEX",
        "name": "Fan data updates 2024",
        "filename": "fan_data.csv",
        "importKey": "imports/SCV/CORTEX/c243a922-282c-4e0d-8a8e-bb222ab28092",
        "service": "SCV",
        "status": "ReadyToImport",
        "importType": "API_KEY",
        "mapping": {
            "fields": [
                {
                    "index": 1,
                    "targetFieldName": "firstName",
                    "mapped": true
                },
                {
                    "index": 2,
                    "targetFieldName": "lastName",
                    "mapped": true
                },
                {
                    "index": 3,
                    "targetFieldName": "email",
                    "mapped": true
                }
            ]
        }
    },
    "url": "https://file-management-system-stage.s3.eu-west-1.amazonaws.com/imports/SCV/CORTEX/c243a922-282c-4e0d-8a8e-bb222ab28092?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA52IDDUHLUCKVUUFG/20241111/eu-west-1/s3/aws4_request&X-Amz-Date=20241111T141454Z&X-Amz-Expires=300&X-Amz-SignedHeaders=host&x-id=PutObject&X-Amz-Signature=9b9f6415378025bd4a7d4432ac0608cebc604bba528ff781ecd27329b3e99d87"
}

Uploading a file

Using the URL provided in the import file response, a file can be uploaded directly to our cloud storage system. This upload will automatically trigger the file import process.

Example cURL

curl -X PUT -H 'Content-Type: text/csv' -T "/path/to/file" "presigned URL"

Authentication

Authentication is required for this API using an API Key. This API key will be provided by the Cortex support team.

Header	What’s it for	Example Value
X-API-KEY	Defines the key or password the caller is authenticating with.	super-secure-key-123

File Format

The file must be in CSV or ZIP format and must include an email_address field.

File Limits

Files are limited to a maximum size of 1000 MB. If your files exceed this size, please divide them into smaller files and import each one separately.

Mapping

Import file requests must include a mapping structure that defines how the source file data maps to FDP data. Any fields not specified in the mapping structure will be ignored during the file import process and will not be included in the FDP.

Example Mapping

[
    {
        "index": 1,
        "targetFieldName": "firstName"
    },
    {
        "index": 2,
        "targetFieldName": "lastName"
    },
    {
        "index": 3,
        "targetFieldName": "email"
    }
]

Example Imported File

id	first_name	last_name	email	gender	age
1	Jane	Doe	[email protected]	Female	55