KnowledgeArticle Object
Root Connection
Section titled “Root Connection”All KnowledgeArticle objects of an account are accessible by a query on the root connection
knowledgeArticles
.
Such a query will return a
KnowledgeArticleConnection!
, which contains the KnowledgeArticle objects in its
nodes
field.
knowledgeArticles (
KnowledgeArticleConnection!
)
Root connection for retrieving KnowledgeArticle 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 | KnowledgeArticleFilter | Filter to determine which KnowledgeArticle records are returned. |
first | Int | Returns the first n elements from the list. |
last | Int | Returns the last n elements from the list. |
order | KnowledgeArticleOrder | Order of the KnowledgeArticle records returned. |
view | KnowledgeArticleView | View name. The default value is current_account . |
Fields
Section titled “Fields”The fields in this section list which values can be retrieved when querying KnowledgeArticle records.
account (
Account
)
The account this record belongs to.
archiveDate (
ISO8601Date
)
The date until which the knowledge article will be active. The knowledge article will be archived at the beginning of this day. When the knowledge article is archived, its status will automatically be set to “Archived”.
coveredSpecialists (
Boolean
)
Whether the knowledge article needs to be available to the people who are a member of the support team of one of the service instances that are selected in the Coverage section of an active SLA for the service that is linked to the article.
createdAt (
ISO8601Timestamp
)
The date and time at which the record was created.
createdBy (
Person
)
The person who created the knowledge article.
customFields (
CustomField
)
Values of custom fields.
description (
String
)
Describes the situation and/or environment in which the instructions of the knowledge article may be helpful.
endUsers (
Boolean
)
Whether the knowledge article needs to be available to anyone who is covered by an active SLA for the service that is linked to the article.
id (
ID!
)
Unique identifier of the record.
instructions (
String
)
Used to enter instructions for the service desk analysts, specialists and/or end users who are likely to look up the knowledge article to help them with their work or to resolve an issue.
internalSpecialists (
Boolean
)
Whether the knowledge article needs to be available to the people who have the Specialist role of the account in which the article is registered.
keyContacts (
Boolean
)
Whether the knowledge article needs to be available to the people who have the Key Contact role of the customer account of an active SLA for the service that is linked to the article.
keywords (
String
)
A comma-separated list of words that can be used to find the knowledge article using search.
public (
Boolean
)
Whether the knowledge article needs to be available to anyone, including people without access to R-Service.
service (
Service
)
Service for which the knowledge article is made available.
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 (
KnowledgeArticleStatus
)
The current status of the knowledge article.
subject (
String
)
A short description of the knowledge article.
template (
KnowledgeArticleTemplate
)
The knowledge article template that this knowledge article is based on.
updatedAt (
ISO8601Timestamp
)
The date and time of the last update of the record. If the record has no updates it contains the
createdAt
value.
updatedBy (
Person
)
The person who last updated the knowledge article.
Connections
Section titled “Connections”The connection fields in this section allow (paged) access to objects related to a specific KnowledgeArticle record.
The actual objects will be in the
nodes
field of the connection.
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. |
descriptionAttachments (
AttachmentConnection
)
Inline images linked to the Description 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. |
instructionsAttachments (
AttachmentConnection
)
Inline images linked to the Instructions 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. |
requests (
RequestConnection
)
Requests linked to this knowledge article.
| 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. |
serviceInstances (
ServiceInstanceConnection
)
Service instances linked to this knowledge article.
| 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
Section titled “Implements”KnowledgeArticle implements the following interfaces. This means that fragments defined on these interfaces may be used in queries returning a KnowledgeArticle.