Request Object
Root Connection
All Request objects of an account are accessible by a query on the root connection requests
.
Such a query will return a RequestConnection!
, which contains the Request objects in its
nodes
field.
RequestConnection!
)
Root connection for retrieving Request 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 |
RequestFilter
|
Filter to determine which Request records are returned. |
first |
Int
|
Returns the first n elements from the list. |
last |
Int
|
Returns the last n elements from the list. |
order |
[RequestOrder!]
|
Order of the Request records returned. |
view |
RequestView
|
View name. The default value is |
Fields
The fields in this section list which values can be retrieved when querying Request records.
Account
)
The account this record belongs to.
Boolean
)
When the Satisfaction field of the request is set to 'Dissatisfied', a person who has the Service Desk Manager role, can check the Addressed box to indicate that the requester has been conciliated.
AgileBoard
)
Board this item is placed on.
AgileBoardColumn
)
Column this item is placed in.
Int
)
The (one based) position of this item in its column.
Int
)
Automatically set to the number of times that the Team field of the request
has been set to a team that is registered in the accounts from which the
request data is retrieved. This field is account specific, which means that
its value can be different for the same request, depending on the account that
has been specified in the X-4me-Account
header of the API call.
RequestCategory
)
The category of the request.
[String!]
)
The names of the checked items from any of the checklists in the instructions.
ISO8601Timestamp
)
Automatically set to the date and time at which the request is saved with the
status "Completed". This field is account specific, which means that its value
can be different for the same request, depending on the account that has been
specified in the X-4me-Account
header of the API call.
RequestCompletionReason
)
The appropriate completion reason for the request when it has been completed.
This field is account specific, which means that its value can be different
for the same request, depending on the account that has been specified in the
X-4me-Account
header of the API call.
ISO8601Timestamp
)
The date and time at which the record was created.
Person
)
Automatically set to the person who submitted the request.
[CustomField!]
)
Values of custom fields.
ISO8601Timestamp
)
The date and time that has been agreed on for the completion of the request. The desired completion overwrites the automatically calculated resolution target of any affected SLA that is related to the request when the desired completion is later than the affected SLA's resolution target. By default, the person selected in the Requested by field receives a notification based on the 'Desired Completion Set for Request' email template whenever the value in the Desired completion field is set, updated or removed.
ISO8601Timestamp
)
The actual date and time at which the service became available again.
ISO8601Timestamp
)
The actual date and time at which the service outage started.
Feedback
)
The satisfiedUrl
and the dissatisfiedUrl
of the requestedFor
. In case
the requestedBy
is different form the requestedFor
, the satisfaction link
of the requestedBy
are also included. Feedback is null
in case no feedback
for the request can be provided at this time.
Request
)
The request group that is used to group the requests that have been submitted for the resolution of exactly the same incident, for the implementation of exactly the same change, for the provision of exactly the same information, etc.
RequestGrouping
)
Default: none
ID!
)
Unique identifier of the record.
RequestImpact
)
The extent to which the service instance is impacted.
KnowledgeArticle
)
Deprecated: Use knowledgeArticles
instead.
Automatically set to the latest knowledge article that was applied to the request.
LifeCycleState
)
Current state of the record.
RequestMajorIncidentStatus
)
Used to indicate the status in the major incident management process. This
field is account specific, which means that its value can be different for the
same request, depending on the account that has been specified in the
X-4me-Account
header of the API call.
Person
)
The person to whom the request is to be assigned. This field is account
specific, which means that its value can be different for the same request,
depending on the account that has been specified in the X-4me-Account
header
of the API call.
TargetTimestamp
)
Empty when the status of the request is completed
. The next target equals
the response target when a response target exists and the response target is
less than the desired completion. Otherwise, the next target equals the
desired completion when a desired completion exists. Otherwise, if the status
is waiting_for_customer
the next target is clock_stopped
when an affected
SLA is linked to the request which Accountability field is set to provider
or supplier
. Otherwise, if the status is waiting_for_customer
the next
target is best_effort
. Otherwise the next target is the resolution target
when a resolution target exists. In all other cases, the next target is
best_effort
. This field is account specific, which means that its value can
be different for the same request, depending on the account that has been
specified in the X-4me-Account
header of the API call.
Organization
)
Automatically set when the request is saved for the first time to the organization that the person, who is selected in the Requested for field, belongs.
Int
)
The number of minutes the member is expected to spend working on the request.
Problem
)
Used to link the request to a problem.
ProductBacklog
)
Product backlog this item is placed on.
Int
)
Estimate of the relative size of this item on the product backlog.
Int
)
The (one based) position of this item on the backlog.
Project
)
Used to link the request to a project.
Boolean
)
Whether the provider currently indicates not to be accountable.
Boolean
)
Whether the provider has at any point in time indicated not to be accountable.
Int
)
Automatically set to the number of times that the status of the request has
changed from completed
to a different value in the account from which the
request data is retrieved. This field is account specific, which means that
its value can be different for the same request, depending on the account that
has been specified in the X-4me-Account
header of the API call.
String
)
The record ID as displayed in the UI
Person
)
The person who submitted the request.
Person
)
The person for whom the request was submitted. The person selected in the Requested by field is automatically selected in this field, but another person can be selected if the request is submitted for another person.
ISO8601Timestamp
)
Automatically set to the most stringent resolution target of the request's
affected SLAs, which Accountability field is not set to sla_not_affected
and
which are linked to an SLA for which the person who is selected in the
Requested for field has coverage.
Int
)
The number of minutes it took to complete this request, which is calculated as
the difference between the createdAt
and completedAt
values.
TargetTimestamp
)
Automatically indicates when the current assignment team needs to have completed the request. The target displayed in this field is the most stringent resolution target of the affected SLAs that are related to the request and for which the current assignment team is responsible.
TargetTimestamp
)
Automatically indicates when the current assignment team needs to have responded to the request. The target displayed in this field is the most stringent response target of the affected SLAs that are related to the request and for which the current assignment team is responsible.
Boolean
)
A request can be marked as reviewed by the problem manager of the service of
the service instance that is linked to the request. Marking a request as
reviewed excludes it from the 'Requests for Problem Identification' view.
This field is automatically set to true
when the Service instance field is
empty, when the request is linked to a problem or workflow, or when the
Grouping field is set to grouped
. This field is also set to true
when the
completion_reason is solved
and the impact is different from top
.
FeedbackSatisfaction
)
The Satisfaction field is set when a requester uses the hyperlinks defined in the 'Request Set to Completed' email template to indicate whether or not he/she is satisfied with the manner in which a request has been handled.
ISO8601Timestamp
)
The date and time the requester indicated satisfaction.
ServiceInstance
)
The service instance in which the cause of the incident resides, for which the change is requested, or about which information is needed.
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.
RequestStatus
)
Used to select the current status of the request. This field is account
specific, which means that its value can be different for the same request,
depending on the account that has been specified in the X-4me-Account
header
of the API call.
String
)
A short description of the request.
Organization
)
The supplier organization that has been asked to assist with the request. The
supplier organization is automatically selected in this field after a service
instance has been selected that is provided by an external service provider
organization. This field is account specific, which means that its value can
be different for the same request, depending on the account that has been
specified in the X-4me-Account
header of the API call.
String
)
The identifier under which the request has been registered at the supplier
organization. If the supplier provided a link to the request, enter the entire
URL in this field. This field is account specific, which means that its value
can be different for the same request, depending on the account that has been
specified in the X-4me-Account
header of the API call.
Task
)
The task that caused the request to be automatically generated.
Team
)
The team to which the request is to be assigned. By default, the first line
team of the service instance that is related to the request will be selected.
If a first line team has not been specified for the service instance, the
support team of the service instance will be selected instead. This field is
account specific, which means that its value can be different for the same
request, depending on the account that has been specified in the
X-4me-Account
header of the API call.
RequestTemplate
)
The link to the request template that was last applied to the request.
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 request has been marked as urgent.
ISO8601Timestamp
)
Used to specify the date and time at which the status of the request is to be
updated from waiting_for
to assigned
. This field is available only when
the Status field is set to waiting_for
.
Workflow
)
Used to link the request to a workflow.
Connections
The connection fields in this section allow (paged) access to objects related to a specific Request record.
The actual objects will be in the nodes
field of the connection.
AffectedSlaConnection
)
Affected SLAs of the request.
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. |
AutomationRuleConnection
)
Automation rules associated with this 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. |
ConfigurationItemConnection
)
Configuration items of the request. This field is account specific, which
means that its value can be different for the same request, depending on the
account that has been specified in the X-4me-Account
header of the API call.
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. |
RequestConnection
)
Requests that are grouped into this request group.
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. |
KnowledgeArticleConnection
)
Knowledge articles of the current request account.
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. |
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. |
SprintBacklogItemConnection
)
Sprint backlog items 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. |
Tags applied to the current request account.
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. |
TimeEntryConnection
)
Time entries for this 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. |
WatchConnection
)
List of all people watching the request.
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
Request implements the following interfaces. This means that fragments defined on these interfaces may be used in queries returning a Request.