Change Object

Root Connection

All Change objects of an account are accessible by a query on the root connection changes. Such a query will return a ChangeConnection!, which contains the Change objects in its nodes field.

changes (ChangeConnection!)

Root connection for retrieving Change records.

Argument Type Description
after String

Returns the elements in the list that come after the specified cursor.

before String

Returns the elements in the list that come before the specified cursor.

filter ChangeFilter

Filter to determine which Change records are returned.

first Int

Returns the first n elements from the list.

last Int

Returns the last n elements from the list.

order [ChangeOrder!]

Order of the Change records returned.

view ChangeView

View name.

The default value is current_account.

Fields

The fields in this section list which values can be retrieved when querying Change records.

account (Account)

The account this record belongs to.

actualEffort (Int)

The total time that has already been spent on the change. This is the sum of the time spent on each of the change's tasks.

category (ChangeCategory)

The category of the change. A change is either planned or unplanned. Select the category "Emergency" for changes that were not planned. Changes that were planned by applying a standard change template are automatically set to the category "Standard". When a change template is used that is not approved as a standard change, then the option "Non-Standard" is automatically selected in this field.

changeId (String)

The record ID as displayed in the UI

changeType (String)

Used to indicate whether the change needs to be implemented following the procedure steps for application changes or for infrastructure changes.

completedAt (ISO8601Timestamp)

The date and time at which the change is saved with the status "Completed".

completionReason (ChangeCompletionReason)

Used to select the appropriate completion reason for the change when it has been completed. It is automatically set to "Complete" when all tasks related to the change have reached the status "Completed", "Approved" or "Canceled".

completionTargetAt (ISO8601Timestamp)

Shows the target date and time of the last task of the change.

createdAt (ISO8601Timestamp)

The date and time at which the record was created.

customFields ([CustomField!])

Values of custom fields.

effortIndication (Int)

The difference between the planned effort and the sum of the actual effort plus the remaining effort as a percentage of the planned effort.

id (ID!)

Unique identifier of the object.

impact (TaskImpact)

The maximum impact level that is selected in the tasks that are a part of the change. This indicates the maximum extent to which the service is impacted when the implementation tasks that are related to the change are executed.

justification (ChangeJustification)

The reason why the change was requested.

lifeCycleState (LifeCycleState)

Current state of the record.

manager (Person)

Who is responsible for coordinating the implementation of the change. If a manager is not specified for a new change, the API user is selected in the Manager field by default.

plannedEffort (Int)

The total planned effort of the change. This is the sum of the planned effort (or planned duration if the planned effort is empty) of the change's tasks.

project (Project)

Linked project

release (Release)

The release that the change is a part of.

remainingEffort (Int)

The total amount of effort that is still planned to be spent on the change. This is determined by calculating for each of the change's tasks the remaining effort. The remaining effort for a task is calculated by subtracting the total time spent on the task from its planned effort (or planned duration if the planned effort is empty). The result of this calculation cannot be lower than zero. The tasks that have already reached their final status are excluded.

service (Service)

The service that will directly be affected by the change implementation, or in case of an emergency change, the service that was directly affected by the change implementation.

source (String)

An identifier for the client application submitting the resource or the name of an external system

sourceID (String)

The unique identifier of the resource in an external system

startAt (ISO8601Timestamp)

The date and time at which the Status field of the first tasks of the change will automatically be set to "Assigned".

status (ChangeStatus)

Automatically set based on the status of the change's tasks.

subject (String)

A short description of the objective of the change.

template (ChangeTemplate)

The change template that was used to register the change.

updatedAt (ISO8601Timestamp)

The date and time of the last update of the record. If the record has no updates it contains the createdAt value.

Connections

The connection fields in this section allow (paged) access to objects related to a specific Change record. The actual objects will be in the nodes field of the connection.

customFieldsAttachments (AttachmentConnection)

Inline images linked to one of the custom fields.

Argument Type Description
after String

Returns the elements in the list that come after the specified cursor.

before String

Returns the elements in the list that come before the specified cursor.

first Int

Returns the first n elements from the list.

last Int

Returns the last n elements from the list.

notes (NoteConnection)

Notes of the record.

Argument Type Description
after String

Returns the elements in the list that come after the specified cursor.

before String

Returns the elements in the list that come before the specified cursor.

first Int

Returns the first n elements from the list.

last Int

Returns the last n elements from the list.

problems (ProblemConnection)

All problems of this change.

Argument Type Description
after String

Returns the elements in the list that come after the specified cursor.

before String

Returns the elements in the list that come before the specified cursor.

first Int

Returns the first n elements from the list.

last Int

Returns the last n elements from the list.

requests (RequestConnection)

All requests of this change.

Argument Type Description
after String

Returns the elements in the list that come after the specified cursor.

before String

Returns the elements in the list that come before the specified cursor.

first Int

Returns the first n elements from the list.

last Int

Returns the last n elements from the list.

tasks (TaskConnection)

All tasks of this change.

Argument Type Description
after String

Returns the elements in the list that come after the specified cursor.

before String

Returns the elements in the list that come before the specified cursor.

first Int

Returns the first n elements from the list.

last Int

Returns the last n elements from the list.

Implements

Change implements the following interfaces. This means that fragments defined on these interfaces may be used in queries returning a Change.