Product Object

Root Connection

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

products (ProductConnection!)

Root connection for retrieving Product 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 ProductFilter

Filter to determine which Product records are returned.

first Int

Returns the first n elements from the list.

last Int

Returns the last n elements from the list.

order [ProductOrder!]

Order of the Product records returned.

view ProductView

View name.

The default value is current_account.

Fields

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

account (Account)

The account this record belongs to.

brand (String)

The brand name is typically the name of the product's manufacturer.

category (String)

The appropriate product category for the product.

createdAt (ISO8601Timestamp)

The date and time at which the record was created.

depreciationMethod (ProductDepreciationMethod)

Used to specify whether or not configuration items that are based on the product are typically depreciated and if so, which depreciation method is normally applied. Valid values are:

  • na_cost_is_zero: N/A - Cost is Zero/Included in Other CI or Service
  • na_not_capitalized: N/A - Not Capitalized
  • na_leased: N/A - Leased
  • double_declining_balance: Double Declining Balance
  • reducing_balance: Reducing Balance (or Diminishing Value)
  • straight_line: Straight Line (or Prime Cost)
  • sum_of_the_years_digits: Sum of the Year's Digits
disabled (Boolean)

Whether the product may no longer be used to register new configuration items.

financialOwner (Organization)

The internal organization which budget is normally used to obtain the product.

id (ID!)

Unique identifier of the object.

model (String)

The model of the product.

name (String)

The name of the product. Fill out the Brand, Model, Product ID (optional) and Category fields to automatically generate a name based on the values entered in these fields.

pictureUri (String)

The hyperlink to the image file for the record.

productID (String)

The unique identifier of the product that is used by the manufacturer.

rate (Int)

The yearly rate that should normally be applied to calculate the depreciation of configuration items that are based on the product using the reducing balance (or diminishing value) method.

remarks (String)

Any additional information about the product that might prove useful.

ruleSet (ProductCategoryRuleSet)

The rule set of the related product category.

service (Service)

The Service which Service Instances would typically include the product.

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

supplier (Organization)

The organization from which the product is typically obtained. If the product is developed internally, select the internal organization that develops it. Note that a lease company should be selected in this field if the product is normally leased.

supportTeam (Team)

The team responsible for maintaining the product's information in the configuration management database (CMDB).

uiExtension (UiExtension)

UI extension that is to be added to the configuration items that are based on the product.

updatedAt (ISO8601Timestamp)

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

usefulLife (Int)

The number of years within which configuration items that are based on the product are typically depreciated.

Connections

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

configurationItems (ConfigurationItemConnection)

Configuration items of the product.

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)

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.

Implements

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