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.
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 |
Fields
The fields in this section list which values can be retrieved when querying Product records.
Account
)
The account this record belongs to.
String
)
The brand name is typically the name of the product's manufacturer.
String
)
Deprecated: Please use productCategory { reference }
.
The reference of the appropriate product category for the product.
ISO8601Timestamp
)
The date and time at which the record was created.
[CustomField!]
)
Values of custom fields.
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:
-
not_depreciated
: Not Depreciated -
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
Boolean
)
Whether the product may no longer be used to register new configuration items.
Organization
)
The internal organization which budget is normally used to obtain the product.
ID!
)
Unique identifier of the record.
String
)
The model of the product.
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.
String
)
The hyperlink to the image file for the record.
ProductCategory
)
The appropriate product category for the product.
String
)
The unique identifier of the product that is used by the manufacturer. The
concatenation of brand
and productID
must be unique within a 4me account.
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.
RecurrenceTemplate
)
Recurrence for maintenance of configuration items created from the product.
String
)
Any additional information about the product that might prove useful.
ProductCategoryRuleSet
)
The rule set of the related product category.
MonetaryAmount
)
The value of this product at the end of its useful life (i.e. at the end of its depreciation period). When a value is not specified for this field, it is set to zero.
Currency
)
The currency of the salvage value of this product.
Service
)
The Service which Service Instances would typically include the product.
String
)
An identifier for the client application submitting the resource or the name of an external system.
String
)
The unique identifier of the resource in an external system.
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.
Team
)
The team responsible for maintaining the product's information in the configuration management database (CMDB).
UiExtension
)
UI extension that is to be added to the configuration items that are based on the product.
ISO8601Timestamp
)
The date and time of the last update of the record. If the record has no updates it contains the createdAt
value.
Int
)
The number of years within which configuration items that are based on the product are typically depreciated.
Person
)
The person who will be responsible for coordinating the workflows that will be generated automatically in accordance with the recurrence schedule.
WorkflowTemplate
)
The workflow template that is used to periodically maintain configuration items created from the product.
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.
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. |
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. |
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.