ServiceInstance Object

• Root Connection
• Fields
• Connections
• Implemented Interfaces

Root Connection

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

serviceInstances ( ServiceInstanceConnection! )

Root connection for retrieving ServiceInstance 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	ServiceInstanceFilter	Filter to determine which ServiceInstance records are returned.
first	Int	Returns the first n elements from the list.
last	Int	Returns the last n elements from the list.
order	ServiceInstanceOrder	Order of the ServiceInstance records returned.
view	ServiceInstanceView	View name. The default value is current_account .

Fields

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

account ( Account )

The account this record belongs to.

createdAt ( ISO8601Timestamp )

The date and time at which the record was created.

customFields ( CustomField )

Values of custom fields.

firstLineTeam ( Team )

Used to select the team that will automatically be selected in the Team field of requests to which the service instance is linked after they have been submitted using Self Service or when they are generated using the Requests API, Mail API or Events API.

id ( ID! )

Unique identifier of the record.

maintenanceWindow ( Calendar )

The maintenance window defines the periods in which workflow tasks with an impact related to this service instance may be implemented.

name ( String )

The name of the service instance.

pictureUri ( String )

The hyperlink to the image file for the record.

remarks ( String )

Any additional information about the service instance that might prove useful.

service ( Service )

The service which functionality the service instance provides.

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.

status ( ServiceInstanceStatus )

The current status of the service instance.

supportTeam ( Team )

The team that will, by default, be selected in the Team field of a request when the service instance is manually selected in the Service instance field of the request, or when the service instance is applied from the Service Hierarchy Browser.

timeZone ( TimeZone )

The time zone that applies to the selected maintenance window.

uiExtension ( UiExtension )

UI extension that is linked to the record.

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 ServiceInstance record. The actual objects will be in the nodes field of the connection.

childServiceInstances ( ServiceInstanceConnection! )

Children of the service instance.

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.

configurationItems ( ConfigurationItemConnection )

Configuration items of the service instance.

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.

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.

parentServiceInstances ( ServiceInstanceConnection! )

Parents of the service instance.

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.

remarksAttachments ( AttachmentConnection )

Files and inline images linked to the Remarks field.

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.

serviceLevelAgreements ( ServiceLevelAgreementConnection )

Service level agreements of the service instance.

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.

translations ( TranslationConnection )

Translations associated with this object.

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

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

• HasTranslations
• Node
• Record