Target Schemas
Update Target Schema
Target Schemas
Update Target Schema
Updates a target schema by ID.
PATCH
/
v2
/
target_schemas
/
{id}
Authorizations
lume-api-key
string
headerrequiredPath Parameters
id
string
requiredThe ID of the target schema to retrieve.
Query Parameters
include
enum<string>[]
Available options:
target_schema Body
application/json
A pipeline is an object containing source and target schemas, and associated with a mapper that jobs can be executed on.
name
string | null
The name of the target schema. Must be unique within the organization.
filename
string | null
The name of the file containing the target schema
schema
object | null
The target schema
Response
200 - application/json
id
string
requiredThe UUID of the target schema.
user_id
string
requiredThe UUID of the user who created the target schema.
name
string | null
The user-provided name of the target schema. Must be unique within the organization.
filename
string | null
The name of the uploaded file containing the target schema.
schema
object | null
The target JSON schema to which data will be mapped.