POST
/
workshops
/
{WorkShop_id}
/
sample
/
run
const headers = {'Content-Type': 'application/json', 'API-Key': '<lume_api_key>'};
const workshop_id = '<workshop_id>';

const body = {
    sample: {
        index: '0',
        source_record: { first_name: "John", last_name: "Doe" },
        mapped_record: { first_name: "Doe", last_name: "John" }
    }
};

fetch(`https://api.lume.ai/workshops/${workshop_id}/sample/run`, {
    method: 'POST',
    headers: headers,
    body: JSON.stringify(body),
})
.then(response => response.json())
.catch(err => console.error(err));
{
  "id": "196a1af0-420f-4a33-aa6c-8deb053c3f69",
  "created_at": "2024-02-29T02:30:23.459676Z",
  "job_id": "5b9e1989-2847-4364-88e5-9ff6a1ffa8bf",
  "pipeline_id": "243876bd-5beb-4c71-8b43-a5a8a91b6ec9",
  "status": "created",
  "updated_at": null
}

Runs an edit in the workshop by providing correctly mapped output data, e.g. a sample.

See step 2 in the Edit Mapper Guide to learn more.

const headers = {'Content-Type': 'application/json', 'API-Key': '<lume_api_key>'};
const workshop_id = '<workshop_id>';

const body = {
    sample: {
        index: '0',
        source_record: { first_name: "John", last_name: "Doe" },
        mapped_record: { first_name: "Doe", last_name: "John" }
    }
};

fetch(`https://api.lume.ai/workshops/${workshop_id}/sample/run`, {
    method: 'POST',
    headers: headers,
    body: JSON.stringify(body),
})
.then(response => response.json())
.catch(err => console.error(err));
{
  "id": "196a1af0-420f-4a33-aa6c-8deb053c3f69",
  "created_at": "2024-02-29T02:30:23.459676Z",
  "job_id": "5b9e1989-2847-4364-88e5-9ff6a1ffa8bf",
  "pipeline_id": "243876bd-5beb-4c71-8b43-a5a8a91b6ec9",
  "status": "created",
  "updated_at": null
}

Authorizations

lume-api-key
string
headerrequired

Path Parameters

WorkShop_id
string
required

Body

application/json
sample
object
required

An object that displays the mapped record of the data from the job

auto_deploy
boolean | null
immediate_return
boolean | null

Response

200 - application/json
id
string
required

The unique identifier of this object

created_at
string
required

The date and time this object was created

job_id
string | null
required

The id of the job the result is associated with

workshop_id
string | null
required

The id of the workshop the result is associated with

pipeline_id
string
required

The id of the pipeline the result is associated with

status
enum<string>
required

The status of the mapping task

Available options:
created,
running,
finished,
failed,
needs review
spec
object | null

The spec of the data to be transformed

updated_at
string | null
required

The date and time this object was last updated