afv-library/skills/platform-data-and-tooling-api-context-get/assets/enterprise_api/Knowledge__Feed.json

{
  "sections": [
    "title",
    "description",
    "fields",
    "special_access_rules",
    "field_reference"
  ],
  "title": "Knowledge__Feed - Data API",
  "description": "Represents the feed for a knowledge article. This object is available in API version 39.0 and later.",
  "fields_columns": [
    "type",
    "properties",
    "description"
  ],
  "fields": {
    "BestCommentId": {
      "type": "reference",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The ID of the comment marked as best answer on a question post."
    },
    "Body": {
      "type": "textarea",
      "properties": "Nillable, Sort",
      "description": "The body of the feed item. Required when Type is TextPost or AdvancedTextPost. Optional when Type is ContentPost or LinkPost. Although a value for Body is not required for the ContentPost type, an attachment is required. If an attachment isn’t present, the type changes to TextPost or AdvancedTextPost, depending on the API version. TextPost and AdvancedTextPost do require a value for Body. Tip: See the IsRichText field for a list of HTML tags supported in the body of rich text posts."
    },
    "CommentCount": {
      "type": "int",
      "properties": "Filter, Group, Sort",
      "description": "The number of comments associated with this feed item."
    },
    "InsertedById": {
      "type": "reference",
      "properties": "Group, Nillable, Sort",
      "description": "ID of the user who added this item to the feed. For example, if an application migrates posts and comments from another application into a feed, the InsertedBy value is set to the ID of the context user."
    },
    "IsRichText": {
      "type": "boolean",
      "properties": "Defaulted on create, Filter, Group, Sort",
      "description": "Indicates whether the feed item Body contains rich text. If you post a rich text feed comment using SOAP API, set IsRichText to true and escape HTML entities from the body. Otherwise, the post is rendered as plain text. Rich text supports the following HTML tags: <p> Tip: Though the <br> tag isn’t supported, you can use <p>&nbsp;</p> to create lines. <a> <b> <code> <i> <u> <s> <ul> <ol> <li> <img>The <img> tag is accessible only through the API and must reference files in Salesforce similar to this example: <img src=\"sfdc://069B0000000omjh\"></img> Note: In API version 35.0 and later, the system replaces special characters in rich text with escaped HTML. In API version 34.0 and prior, all rich text appears as a plain-text representation."
    },
    "LikeCount": {
      "type": "int",
      "properties": "Filter, Group, Sort",
      "description": "The number of likes associated with this feed item."
    },
    "LinkUrl": {
      "type": "url",
      "properties": "Nillable, Sort",
      "description": "The URL of a LinkPost."
    },
    "ParentId": {
      "type": "reference",
      "properties": "Filter, Group, Sort",
      "description": "ID of the Knowledge article to which the feed item is related."
    },
    "RelatedRecordId": {
      "type": "reference",
      "properties": "Group, Nillable, Sort",
      "description": "ID of the ContentVersion record associated with a ContentPost. For WDC thanks posts, it’s the ID of the WorkThanks object associated with a RypplePost. This field is typically null for all posts except ContentPost and RypplePost.For example, set this field to an existing ContentVersion ID and post it to a feed with Type set to ContentPost."
    },
    "Title": {
      "type": "string",
      "properties": "Group, Nillable, Sort",
      "description": "The title of the feed item. When the Type is LinkPost, the LinkUrl is the URL and this field is the link name. The Title field can be updated on posts of Type QuestionPost."
    },
    "Type": {
      "type": "picklist",
      "properties": "Filter, Group, Nillable, Restricted picklist, Sort",
      "description": "The type of feed item. Except for ContentPost, LinkPost, and TextPost, don’t create feed items of other types directly from the API. ActivityEvent—indirectly generated event when a user or the API adds a Task associated with a feed-enabled parent record (excluding email tasks on cases). Also occurs when a user or the API adds or updates a Task or Event associated with a case record (excluding email and call logging). For a recurring Task with CaseFeed disabled, one event is generated for the series only. For a recurring Task with CaseFeed enabled, events are generated for the series and each occurrence. AdvancedTextPost—created when a user posts a group announcement and, in Lightning Experience as of API version 39.0 and later, when a user shares a post. AnnouncementPost—Not used. ApprovalPost—generated when a user submits an approval. BasicTemplateFeedItem—Not used. CanvasPost—a post made by a canvas app posted on a feed. CollaborationGroupCreated—generated when a user creates a public group. CollaborationGroupUnarchived—Not used. ContentPost—a post with an attached file. CreatedRecordEvent—generated when a user creates a record from the publisher. DashboardComponentAlert—generated when a dashboard metric or gauge exceeds a user-defined threshold. DashboardComponentSnapshot—created when a user posts a dashboard snapshot on a feed. LinkPost—a post with an attached URL. PollPost—a poll posted on a feed. ProfileSkillPost—generated when a skill is added to a user’s Chatter profile. QuestionPost—generated when a user posts a question. ReplyPost—generated when Chatter Answers posts a reply. RypplePost—generated when a user creates a Thanks badge in WDC. TextPost—a direct text entry on a feed. TrackedChange—a change or group of changes to a tracked field. UserStatus—automatically generated when a user adds a post. Deprecated. The following values appear in the Type picklist for all feed objects but apply only to CaseFeed: AttachArticleEvent—generated event when a user attaches an article to a case. CallLogPost—generated event when a user logs a call for a case through the user interface. CTI calls also generate this event. CaseCommentPost—generated event when a user adds a case comment for a case object. ChangeStatusPost—generated event when a user changes the status of a case. ChatTranscriptPost—generated event when Chat transcript is saved to a case. EmailMessageEvent—generated event when an email related to a case object is sent or received. FacebookPost—generated when a Facebook post is created from a case. Deprecated. MilestoneEvent—generated when a case milestone is completed or reaches violation status. SocialPost—generated when a social post is created from a case. Note: If you set Type to ContentPost, also specify ContentData and ContentFileName."
    }
  },
  "special_access_rules": "Lightning Knowledge must be enabled in your org.",
  "field_reference": {
    "BestCommentId": {
      "field_label": "Best Comment ID",
      "type": "reference",
      "length": "18"
    },
    "Body": {
      "field_label": "Body",
      "type": "textarea",
      "length": "10000"
    },
    "CommentCount": {
      "field_label": "Comment Count",
      "type": "int",
      "digits": "9"
    },
    "CreatedById": {
      "field_label": "Created By ID",
      "type": "reference",
      "length": "18"
    },
    "CreatedDate": {
      "field_label": "Created Date",
      "type": "datetime"
    },
    "Id": {
      "field_label": "Feed Item ID",
      "type": "id",
      "length": "18"
    },
    "InsertedById": {
      "field_label": "InsertedBy ID",
      "type": "reference",
      "length": "18"
    },
    "IsDeleted": {
      "field_label": "Deleted",
      "type": "boolean"
    },
    "IsRichText": {
      "field_label": "Is Rich Text",
      "type": "boolean"
    },
    "LastModifiedDate": {
      "field_label": "Last Modified Date",
      "type": "datetime"
    },
    "LikeCount": {
      "field_label": "Like Count",
      "type": "int",
      "digits": "9"
    },
    "LinkUrl": {
      "field_label": "Link Url",
      "type": "url",
      "length": "1000"
    },
    "NetworkScope": {
      "field_label": "Network Scope",
      "type": "picklist",
      "length": "40"
    },
    "ParentId": {
      "field_label": "Parent ID",
      "type": "reference",
      "length": "18"
    },
    "RelatedRecordId": {
      "field_label": "Related Record ID",
      "type": "reference",
      "length": "18"
    },
    "SystemModstamp": {
      "field_label": "System Modstamp",
      "type": "datetime"
    },
    "Title": {
      "field_label": "Title",
      "type": "string",
      "length": "255"
    },
    "Type": {
      "field_label": "Feed Item Type",
      "type": "picklist",
      "length": "40"
    },
    "Visibility": {
      "field_label": "Visibility",
      "type": "picklist",
      "length": "40"
    }
  },
  "field_reference_columns": [
    "field_label",
    "type",
    "length",
    "digits"
  ]
}