Article Object

The article object is what is returned when retrieving an article or querying articles.

Name

Summary

id_prefix

The prefix of the id.

id

The article id with the prefix.

title

The title of the article.

summary

The summary of the article.

content

The contents of the article in HTML.

published

Whether the article is published to the community or just internally.

status_id

The article status id.

status

The display name of the state.

hot

Whether the article is a hot article and available within the case creation screen in Supportbench.

owner_id

The agent owner id.

owner

The full name of the agent owner.

queue_id

The queue id the case is in.

queue

The display name of the queue the case is in.

review_date

The date the article expires and fires the selected action.

review_action_id

The action id of the reviewed article.

review_action

The name of the review action.

tags

An array of tags associated to the article.

category_id

The related case category id of the article.

category

The display name of the related category.

priority_id

The related case priority id.

priority

The display name of the related case priority.

issue_id

The related case issue id.

issue

The display name of the related case issue.

outcome_id

The related case outcome id.

outcome

The display name of the related case outcome id.

case_id

The case id where this article was created from.

activity_id

The activity id where this article was created from.

containers

An array of containers that this article is related to. Please see the container object below.

fields

An object array of key value pairs for custom fields related to this case if they exist.
name = The field name.
value = The value of the field.

attachments

An array of attachments that this article contains. Please see the attachment object below.

modified

The last date the case was modified in UTC.

created

The date the case was created in UTC.