importJobDefinition

QUERY

importJobDefinition(serviceIntegrationKey: String!, isEnabled: Boolean): ImportJobDefinition

Arguments

serviceIntegrationKey

String!

required

isEnabled

Boolean

Returns

ImportJobDefinition

ID!

mode

String!

The sync mode for this definition (e.g. SYNC for continuous synchronization).

entityTypes

[String!]!

The entity types this definition syncs (e.g. TENANTS, CUSTOMERS, TENANT_FIELD_SCHEMAS).

metadata

ImportJobDefinitionMetadata

Optional metadata about the import configuration, such as the tenant list being synced.

enabledAt

DateTime

When this import job definition was enabled. Null if it has never been enabled.

createdAt

createdBy

updatedAt

updatedBy

Query

query ImportJobDefinition($serviceIntegrationKey: String!) {
  importJobDefinition(serviceIntegrationKey: $serviceIntegrationKey) {
    id
    mode
    entityTypes
    metadata {
      lists {
        id
        name
      }
    }
    enabledAt {
      unixTimestamp
      iso8601
    }
    createdAt {
      unixTimestamp
      iso8601
    }
  }
}

Variables

{
  "serviceIntegrationKey": "string"
}

Response

{
  "data": {
    "importJobDefinition": {
      "id": "id",
      "mode": "string",
      "entityTypes": [
        "string"
      ],
      "metadata": {
        "lists": [
          {
            "id": "id",
            "name": "string"
          }
        ]
      },
      "enabledAt": {
        "unixTimestamp": "string",
        "iso8601": "string"
      },
      "createdAt": {
        "unixTimestamp": "string",
        "iso8601": "string"
      }
    }
  }
}

⌘I

Query

query ImportJobDefinition($serviceIntegrationKey: String!) {
  importJobDefinition(serviceIntegrationKey: $serviceIntegrationKey) {
    id
    mode
    entityTypes
    metadata {
      lists {
        id
        name
      }
    }
    enabledAt {
      unixTimestamp
      iso8601
    }
    createdAt {
      unixTimestamp
      iso8601
    }
  }
}

Variables

{
  "serviceIntegrationKey": "string"
}

Response

{
  "data": {
    "importJobDefinition": {
      "id": "id",
      "mode": "string",
      "entityTypes": [
        "string"
      ],
      "metadata": {
        "lists": [
          {
            "id": "id",
            "name": "string"
          }
        ]
      },
      "enabledAt": {
        "unixTimestamp": "string",
        "iso8601": "string"
      },
      "createdAt": {
        "unixTimestamp": "string",
        "iso8601": "string"
      }
    }
  }
}

Queries

Mutations

Types

Arguments

Returns