SAsalesforce
generators

Get generator

Changed on

Retrieve the specified generator.

get/generators/{key}

Request

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

Path parameters

keystring required

The id or key of the generator to retrieve.

Query parameters

fieldsstring[]

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

Response

Success, returns the specified generator.

descriptionstring

A description of the generator.

helpEmailstring

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

helpUrlstring

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

createdBystring

Id of the User who created this Generator.

idstring

The collector id.

intervalSecsinteger

Interval (seconds) between each collection.

isActiveboolean

Default false. When set to true, the generator will be assigned to a running collector and regularly send in samples.

namestring

The generator's name.

subjectQuerystring

The query to append to GET subjects. Only "absolutePath", "name", "tags" are allowed in subjectQuery.

collectorGroupobject

Specifies set of collectors this Sample Generator should try to use.

aspectsstring[]

Names of the aspects.

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 (-).

connectionobject

Information about the connection.

contextobject

Variables accessible inside the transform function.

currentCollectorobject

Current collector assigned to the generator.

Changes