Create Multitable Job
Create a new Job within the specified Pipeline.
Creates a new job using multitable data. This endpoint allows users to upload an Excel file, specify primary and foreign keys for multiple tables, and map the data accordingly. Lume will join the data before performing the mapping.
Parameters
- id (string, required): The unique identifier of the pipeline. It can be either a string or a UUID.
Request Body
The request body must be of type multipart/form-data
and include the following fields:
Fields
- file (binary, required): The Excel file to process. This file should contain the sheets you want to map and join.
- metadata (string, required): A JSON string mapping the Excel file sheet names to table metadata. Only the sheets included in this mapping will be processed.
- top_sheet_name (string, required): The name of the topmost sheet in the Excel file. The list of records will correspond 1:1 with the rows in this sheet.
Example Request Body
{
"file": "<binary data>",
"metadata": "{\"Sheet1\": {\"primary_key\": [\"id\"], \"foreign_keys\": {\"sheet2_id\": \"Sheet2\"}}, \"Sheet2\": {\"primary_key\": [\"id\"], \"foreign_keys\": {}}}",
"top_sheet_name": "Sheet1"
}
Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Path Parameters
The name or ID of the pipeline to retrieve.
Body
The Excel file to process.
Mapping from Excel file sheet name to table metadata. Only sheets with metadata will be processed.
The topmost Excel file sheet name. List of records will correspond 1:1 with rows this sheet.
Response
The id of the job
The user id of the job
The pipeline id of the job
The target schema id of the job
The source schema id of the job
The created at of the job