Person Object
Root Connection
All Person objects of an account are accessible by a query on the root connection people
.
Such a query will return a PersonConnection!
, which contains the Person objects in its
nodes
field.
PersonConnection!
)
Root connection for retrieving Person 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 |
PersonFilter
|
Filter to determine which Person records are returned. |
first |
Int
|
Returns the first n elements from the list. |
last |
Int
|
Returns the last n elements from the list. |
order |
[PersonOrder!]
|
Order of the Person records returned. |
view |
PersonView
|
View name. The default value is |
Fields
The fields in this section list which values can be retrieved when querying Person records.
Account
)
The account this record belongs to.
String
)
Uniquely identify the user for Single Sign-On
Boolean
)
Whether the person should be offered translations for texts that are written in languages other than the ones selected in the Language (language) and the Do not translate (do_not_translate_languages) fields. Such texts are translated automatically into the language selected in the Language (language) field.
MonetaryAmount
)
The person's estimated total cost per work hour for the service provider organization. The value in this field should include the costs of the person's salary (or rate in case of a long-term contractor), office space, service subscriptions, training, etc.
Currency
)
The currency of the cost per hour value of this skill pool.
ISO8601Timestamp
)
The date and time at which the record was created.
[CustomField!]
)
Values of custom fields.
Boolean
)
true
when the person may no longer be related to other records.
[String!]
)
The languages that should not be translated automatically for the person. Translations will not be offered to the person for texts in any of these languages. This field can contain a comma-separated list of language codes. Supported language codes are: en, nl, de, fr, es, pt, it, da, fi, sv, pl, cs, tr, ru, ar, id, fa, no, zh, ja, ko, he, hi, ms.
String
)
The unique identifier for a person typically based on order of hire or association with an organization.
Boolean
)
Whether team notifications should be excluded from all notifications.
Boolean
)
true
when the person registered as a guest in self service.
ID!
)
Unique identifier of the record.
String
)
Any additional information about the person that might prove useful.
String
)
The person's job title.
Language
)
The language preference of the person.
LifeCycleState
)
Current state of the record.
String
)
The name or number of the room, cubicle or area where the person has his/her primary work space.
Person
)
The manager or supervisor to whom the person reports.
String
)
The person's name.
Boolean
)
An enabled OAuth person is mentionable and visible in suggest fields, just like a real person.
Organization
)
The organization for which the person works as an employee or long-term contractor.
String
)
The hyperlink to the image file for the record.
String
)
The email address to which email notifications are to be sent. This email address acts as the unique identifier for the person within the R-Service account. This primary email address also acts as the person's login name if he/she is a user of the R-Service service.
PersonSendEmailNotifications
)
Indicates when to send email notifications to the person.
PersonShowNotificationPopup
)
Indicates when to show a notification popup to the person.
Site
)
Where the person is stationed.
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.
String
)
A number or code that a service desk analyst can ask the person for when the person contacts the service desk for support.
Boolean
)
Whether the person prefers to see times displayed within the R-Service service in the 24-hour format or not (in which case the 12-hour format is applied).
TimeZone
)
The time zone in which the person normally resides.
UiExtension
)
UI extension that is linked to the record.
ISO8601Timestamp
)
The date and time of the last update of the record. If the record has no updates it contains the createdAt
value.
Boolean
)
Whether the person is a very important person.
Calendar
)
Calendar that represents the work hours of the person.
Connections
The connection fields in this section allow (paged) access to objects related to a specific Person record.
The actual objects will be in the nodes
field of the connection.
AddressConnection
)
Addresses 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. |
ShopOrderLineConnection
)
The shop order lines related to this person with status in_cart.
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. |
ConfigurationItemConnection
)
Configuration items this person is related to as a user.
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. |
ContactConnection
)
Contact details for this entity.
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
)
Files and inline images linked to the Information 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. |
OutOfOfficePeriodConnection
)
Out of office periods for this person.
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. |
PermissionConnection
)
Permissions of this person.
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. |
SkillPoolConnection
)
Skill pools this person belongs to.
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. |
TeamConnection
)
Teams this person belongs to.
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
Person implements the following interfaces. This means that fragments defined on these interfaces may be used in queries returning a Person.