v2

latestOpenAPI 3.0.4Apache 2.0raw.githubusercontent.com2026-07-1754198241.7 KB

Transformations

Update a transformation

Updates transformation metadata, descriptor references, steps, or expression text. Route implementations should version or snapshot transformations when repeatable historical execution is required.

patch/transformations/{transformationId}

Path parameters

transformationIdstring uuid required

Stable identifier for a transformation definition.

Example:0e60abcc-41b5-4cc5-bec2-f0047f129341

Stable identifier of a reusable transformation between resource descriptors.

Request body

displayNamestring

Updated transformation name.

descriptionstring

Updated transformation description.

language'ATTRIBUTE_MAPPER' | 'JSONATA' | 'JQ' | 'CEL' | 'SQL' | 'TEMPLATE' | 'CUSTOM'

Transformation representation used by a transformation definition.

sourceDescriptorIdstring uuid

Stable identifier for a described external or internal resource shape.

targetDescriptorIdstring uuid

Stable identifier for a described external or internal resource shape.

expressionstring

Updated expression for expression-based transformations.

metadataStringMap

Small string-only metadata map for labels, ownership, routing hints, and implementation-specific annotations. Use first-class fields for contractually significant data.

Example request

{
  "description": "Maps employee profile rows into the current license invitation payload.",
  "steps": [
    {
      "stepType": "MAP",
      "sourcePath": "email",
      "targetPath": "recipient.email"
    },
    {
      "stepType": "DEFAULT",
      "targetPath": "invitation.locale",
      "value": "en-US"
    }
  ]
}

Response

Transformation updated.

displayNamestring required

Human-readable transformation name.

descriptionstring

Transformation purpose and scope.

language'ATTRIBUTE_MAPPER' | 'JSONATA' | 'JQ' | 'CEL' | 'SQL' | 'TEMPLATE' | 'CUSTOM' required

Transformation representation used by a transformation definition.

sourceDescriptorIdstring uuid

Stable identifier for a described external or internal resource shape.

targetDescriptorIdstring uuid

Stable identifier for a described external or internal resource shape.

expressionstring

Transformation expression for expression-based languages.

metadataStringMap

Small string-only metadata map for labels, ownership, routing hints, and implementation-specific annotations. Use first-class fields for contractually significant data.

transformationIdstring uuid required

Stable identifier for a transformation definition.

createdAtstring date-time required

Creation timestamp.

updatedAtstring date-time required

Last update timestamp.

Example response

{
  "transformationId": "0e60abcc-41b5-4cc5-bec2-f0047f129341",
  "displayName": "Employee profile to license invitation",
  "description": "Maps HR employee attributes into the invitation payload used by the license issuance flow.",
  "language": "ATTRIBUTE_MAPPER",
  "sourceDescriptorId": "41436f49-040c-4f5f-9c7f-657f43762e2b",
  "targetDescriptorId": "7a44f0de-e4d9-44ef-9211-372433933a88",
  "steps": [
    {
      "stepType": "MAP",
      "sourcePath": "email",
      "targetPath": "recipient.email"
    },
    {
      "stepType": "MAP",
      "sourcePath": "license_type",
      "targetPath": "credential.licenseType"
    }
  ],
  "createdAt": "2026-06-18T09:35:00Z",
  "updatedAt": "2026-06-18T09:40:00Z"
}