knowledgeArticleCreate Mutation

Creates a new knowledge article.

Input Argument

knowledgeArticleCreate accepts a single input argument, an input type, which contains the values it uses.

The fields inside input are:

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".

clientMutationId (String)

A unique identifier for the client performing the mutation.

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.

createdById (ID)

Identifier of the person who created the knowledge article.

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.

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.

serviceId (ID!)

Identifier of the service for which the knowledge article is made available.

serviceInstanceIds ([ID!])

Identifiers of services linked to this knowledge article.

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.

Return Fields

clientMutationId (String)

A unique identifier for the client performing the mutation.

errors ([ValidationError!])

Errors encountered during the mutation.

knowledgeArticle (KnowledgeArticle)

Record after mutation.