Skip to main content

 Services

Web services from /about to /webhooks

transform uri fragment

/members/{member}/groups/{group}/uris/{uri}/fragments/{+fragment}/transform [POST]

Description

Transform fragment's content using XSLT.

If preview=true or diffx=true, no edit is created and the result of the transformation is returned. Parameters labels, lastmodifed, note, note-title and note-labels are ignored then.

Parameters

NameDescriptionRequiredTypeDefault value
diffxIf 'true', edit is not created but result of transformation diff is in the outputnobooleanfalse
labelsComma-separated list of edit labelsnostring
lastmodifiedThe last modified date/time (ISO 8601) of the fragment (prevents edit clashes)nostring
notecontent for edit notes (if exists creates a note)nostring
note-labelsComma-separated list of labels for the note (if exists creates a note)nostring
note-titletitle for edit notenostringEdit note
previewIf 'true', edit is not created but result of transformation is in the outputnobooleanfalse
reloadIf 'true', the transformation script cache is clearednobooleanfalse
transformationName of the XSLT to use (without .xsl extension). Maps to /quickfix/[transformation].xsl in project template.yesstring
parameter.*Any parameter used by the XSLT, with the parameter name after the dot.nostring

Permission

This service requires contributor or higher.

Response

The output has the following format:

<fragment-transform [preview="true"] [diff="true"]>
  <!-- Transformed fragment (no transcluded content) -->
</fragment-transform>

Error Handling

0x120BError processing xrefs
0x120CError creating fragment
0x120DContent validation error
0x120Elastmodified date is invalid
0x120FSomeone has modified the fragment while you were editing
0x122DThe fragment is invalid (no match)
0x1225The fragment is invalid (wrong case)
Created on , last edited on