v1

latestSwagger 2.0BSD 3-Clause2026-07-1720953437.1 KB

generatorTemplates

Update generatorTemplate (partial)

Update the specified generatorTemplate. Requires user to have write permission. If a field is not included in the query body, that field will not be updated.

patch/generatorTemplates/{key}

Path parameters

keystring required

The id or key of the generatorTemplate to update.

Request body

isPublishedboolean

Default false. When set to true, the generatorTemplate is available to all users.

ownerstring

The name of the user to assign as the owner. Defaults to the user that created it

Response

Success, returns the updated generatorTemplate.

descriptionstring

A description of the generatorTemplate.

helpEmailstring

The email address where a user can go to get more help about the generatorTemplate.

helpUrlstring

The url where a user can go to get more help about the generatorTemplate.

namestring

The generatorTemplate's name.

versionstring

The version, in semantic versioning format ( MAJOR.MINOR.PATCH )

tagsstring[]

Array of tag names. Tag name: Max 60 characters; case insensitive; allows alpha-numeric characters, underscore (_) and dash (-). Tag names cannot start with a dash (-).

authorobject

The author of this generatorTemplate.

repositoryobject

The repository where this generatorTemplate is located.

connectionobject

Information about the connection.

contextDefinitionobject

Variables available to connection.url, connection.toUrl, and the transform function.

transformobject

The body of a javascript function which transforms some data into an array of samples

isPublishedboolean

Default false. When set to true, the generatorTemplate is available to all users.

idstring

The generatorTemplate id.

createdBystring

Id of the User who created this generatorTemplate.