Schema Patches

Update, remove, or delete patch mapping

Changed on

Updates an existing mapping, removes a mapping from a patch (remove=true), or marks a mapping for deletion when the patch is applied (delete=true).

post/schema/patch/{table}/{id}/mapping/{mapping_id}

Request

  • Base URL
    https://api.lytics.io/v2
  • URL
    https://api.lytics.io/v2/schema/patch/{table}/{id}/mapping/{mapping_id}
  • Auth
    API key in header Authorization

Path parameters

tablestring required

Table name

idstring required

Patch ID

mapping_idstring required

Mapping ID

Query parameters

account_idstring

The account ID. Defaults to the user's default account.

removeboolean

Remove mapping from patch (undo changes)

deleteboolean

Mark mapping for deletion when patch is applied

Request body

createdstring date-time
edit_statusstring
exprstring

The LQL expression for the mapping

fieldstring required

The target field of the mapping

guard_exprstring

The LQL Guard expression for the mapping

idstring

The ID of the mapping

managed_bystring
modifiedstring date-time
streamstring

The stream associated with the mapping

Response

Updated patch with diff information

_metaobject

Response Metadata

request_idstring
statusinteger

HTTP Status Code

Changes