SAsalesforce
generatorTemplates

Get generatorTemplate

Retrieve the specified generatorTemplate.

get/generatorTemplates/{key}

Request

  • Base URL
    /v1 (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /v1/generatorTemplates/{key}
  • Auth
    API key in header Authorization

Path parameters

keystring required

The id or key of the generatorTemplate to retrieve.

Query parameters

fieldsstring[]

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

Response

Success, returns the specified 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.

Changes

No recorded changes to this operation across all 70 revisions of this API.