SAsalesforce
generators

Create generator

Create a new generator and makes the creator the writer of the generator.

post/generators

Request

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

Request body

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.

intervalSecsinteger

Interval (seconds) between each collection.

namestring required

A unique and descriptive name for your Generator.

subjectQuerystring

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

collectorGroupstring

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

aspectsstring[] required

List of one or more Aspects you want to collect Samples for.

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

Specify the values for any context variables as defined by the Sample Generator Template you are using.

ownerstring

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

Response

Created.

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

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