Uploading CSV/XLS with Request Upload

Copy

• Copy for LLM

  Copy page as Markdown for LLMs
• View as Markdown

  Open this page as Markdown
• Open in ChatGPT

  Get insights from ChatGPT
• Open in Claude

  Get insights from Claude

Overview

This step-by-step instruction guides the user through the data upload process using Upload Request. Uploaded data can be used with Use Case Enablers.

Scenario

In this instruction, the user will learn how to:

1. Create a Data Storage,
2. Request a file upload,
3. Upload desired data,
4. Read uploaded data,
5. Delete unused data storage.

Step 1: Create a storage

To upload desired files, storage is needed! Before upload:

1. Use the Create Storage endpoint to send the below request.
2. Select the Create a storage example.
3. Replace the dataStorageExample and the dataSourceExample with new names.

{
  "name": "dataStorageExample",
  "dataSources": [
    {
      "dataSourceName": "dataSourceExample",
      "dataMapperDefinitionId": "61a5d4dc773d1012a3dfa5aa"
    }
  ],
  "featuresOn": ["LOOKUP", "DATA_MIRROR"]
}

Important information:

• Your storage is created if the status: CREATED_SUCCESSFULLY is displayed in the response body.
• The id refers to the unique identifier of a newly created storage (e.g., id:3a10645d8be23f53a20b30bfa936e63d).
• The storage is empty by default.

Step 2: Request the file upload

Get the upload link

To start the import job of a CSV or XLSX file:

1. Use the Request file upload endpoint to send the below request.
2. Change the name of the imported file if needed.

{
  "url": "file.xlsx"
}

In the response, you will find three important parameters:

• The uploadLink with the link to be used in the next step.
• The uploadMethod with the method to be used during the upload.
• The url with the link to your uploaded file.

{
  "uploadLink": "https://example.org/some.line",
  "uploadMethod": "PUT",
  "url": "customer-uploads/cdq/user-id/file.xlsx"
}

Upload the file

Uploading the file must be performed by an external client like Insomnia.

To upload the file:

1. Create a new request.
2. Set the uploadMethod and paste the uploadLink.

Defining the request parameters

3. Change the body of the request to Binary File.
4. Select the file.

Setting the request body	Selecting the file

5. Send the request.

Step 3: Upload data to the storage

Use received URL link

To start the import job of the uploaded file:

1. Use the Start Import Job endpoint to send the below request.
2. Paste the existing storage id.
3. Paste the url from step 2.

In the response, you will find three important parameters:

• The id with the value representing YOUR JOB ID - the unique number of every upload job.
• The progress: 0 representing the progress of the job.
• The status: SCHEDULED - the job is in the job queue.

Poll for the completion status

To check the import job status:

1. Use the Poll Import Job endpoint to send the below request.
2. Use the YOUR JOB ID from the previous step and replace the jobId.

If the job is still running, the status with the progress will be displayed:

{
  "id": "YOUR JOB ID",
  "progress": "71",
  "status": "RUNNING"
}

When the job is done, the FINISHED status will be displayed:

{
  "id": "YOUR JOB ID",
  "progress": "100",
  "status": "FINISHED"
}

Step 4: Read data

To read uploaded data:

1. Use the Read Business Partners endpoint to send the below request.
2. Use the existing storage id.

In the response, the Business Partners data will be displayed in the value object:

{
  "values": [
    {
      "businessPartnerData1"
    },
    {
      "businessPartnerData2"
    }
  ]
}

Step 5: Delete storage

1. Use the Delete Storage endpoint to send the below request.
2. Use the existing storage id no longer in use and replace the storageId in the request.

Your opinion matters!

Copy

• Copy for LLM

  Copy page as Markdown for LLMs
• View as Markdown

  Open this page as Markdown
• Open in ChatGPT

  Get insights from ChatGPT
• Open in Claude

  Get insights from Claude

We are constantly working on providing an outstanding user experience with our products. Please share your opinion about this tutorial!