BaseJob

Object

A background job. params is free-form JSON. For connector entity jobs it is:

{ "params": { "buildingId": "BLDG8R2nW3kq" } }

for importEntities/<connectorId>/<sourceType>, and

{
  "connectorId": "CON…",
  "sourceType": "room",
  "commitMessage": "Rename floor 2 rooms",
  "rules": { "typescript": "<base64>", "javascript": "<base64>" },
  "noEntityChanges": true,
  "redispatchedEntities": 12
}

for mergeEntities/<connectorId>/<sourceType>. noEntityChanges is present only on a save that changed no entity, such as a rule-only save. redispatchedEntities is present only when the merge picked up rows a failed merge left behind.

type BaseJob {
  completedAt: DateTime
  createdAt: DateTime
  createdBy: String
  description: String
  id: String
  name: String
  orgId: String
  params: GraphQLJSON
  parentResourceId: String
  percentageComplete: Int
  state: JobState
  status: String
  updatedAt: DateTime
}

Fields

Field	Type	Description
completedAt	DateTime
createdAt	DateTime
createdBy	String
description	String
id	String
name	String
orgId	String
params	GraphQLJSON	Free-form JSON the job was started with; see the examples in the type description.
parentResourceId	String
percentageComplete	Int
state	JobState
status	String
updatedAt	DateTime

Used by

• cancelJob (mutation)
• ConnectorEntityImportResponse.job (field)
• ConnectorEntityMergeResponse.job (field)
• jobs (query)
• migrateConnectorEntities (mutation)
• prepareConnectorEntitiesMigration (mutation)
• syncPlaceMappings (mutation)