Skip to main content

# AutomationJob

Type for one automation definition.

    type AutomationJob {
      id: ID!
      createdBy: User!
      customer: Customer!
      definition: String!
      description: String
      email: AutomationJobEmail
      executions(
        onlyActive: Boolean = true
      ): [AutomationExecution!]!
      modifiedBy: User!
      name: String!
      scheduleId: ID
      timestamp: DateTime
    }

### Fields​

#### `AutomationJob.id` ● `ID!` non-null scalar​

The job's ID

#### `AutomationJob.createdBy` ● `User!` non-null object​

The user that created this job

#### `AutomationJob.customer` ● `Customer!` non-null object​

The customer to which this job belongs to.

#### `AutomationJob.definition` ● `String!` non-null scalar​

The definition

#### `AutomationJob.description` ● `String` scalar​

The description

#### `AutomationJob.email` ● `AutomationJobEmail` object​

If an email is sent by this job this field contains the details otherwhise it is not set (null).

#### `AutomationJob.executions` ● `[AutomationExecution!]!` non-null object​

The job's executions if you want all the executions not only the active ones set the 'onlyActive' argument to true.

##### `AutomationJob.executions.onlyActive` ● `Boolean` scalar​

#### `AutomationJob.modifiedBy` ● `User!` non-null object​

The user that made the last change to this job.

#### `AutomationJob.name` ● `String!` non-null scalar​

This job's name.

#### `AutomationJob.scheduleId` ● `ID` scalar​

Schedule of this job

#### `AutomationJob.timestamp` ● `DateTime` scalar​

The timestamp of the last change to this job.

### Returned By​

`automationJob` query ● `automationJobs` query

### Member Of​

`AutomationExecution` object