v1

latestSwagger 2.0BSD 3-Clause2026-07-1720953437.1 KB
generatorTemplates

Find generatorTemplates

Get a generatorTemplate or all generatorTemplates. You may query using field filters with asterisk (*) wildcards. You may also optionally specify sort, limit, offset, and a list of fields to include in the response. The global default limit will apply if no limit param is specified.

get/generatorTemplates

Query parameters

fieldsstring[]

Comma-delimited list of field names to include in the response.

sortstring[]

Specify the sort order using a field name, e.g. '...?sort=name'. Prepend the field name with a minus sign to specify descending order, e.g. '...?sort=-name'.

limitinteger

Maximum number of records to return in the response; also useful for pagination in the UI.

offsetinteger

Offset for paginating the response.

namestring

Filter by the generatorTemplate name; asterisk (*) wildcards ok.

versionstring

Filter by the generatorTemplate version; asterisk (*) wildcards ok.

tagsstring[]

Comma-separated list of tags to include/exclude. Tag names are case-insensitive. For example, ?tags=FOO,BAR will only return aspects with tags FOO and BAR. Prefix each of the tag name with a negative sign to indicate that a aspect with that tag should be excluded. For example, ?tags=-BAZ,FOO will return only the aspects with tag name not equal to BAZ or FOO. A mix of tag names with and without minus signs, for example ?tags=BAZ,-FOO are not allowed. GeneratorTemplates without tags are not included in the include result set.

isPublishedboolean

Filter by generatorTemplate isPublished (true|false)

createdAtstring

Filter by time period when GeneratorTemplates were created.

updatedAtstring

Filter by time period when GeneratorTemplates were updated.

Response

Success, returns a list of generatorTemplates

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.