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

162 lines
5.2 KiB
JSON

{
"sections": [
"title",
"description",
"fields",
"special_access_rules",
"field_reference"
],
"title": "Knowledge__ka - Data API",
"description": "Provides access to the concrete object that represents a Knowledge article, the parent object for article versions. This object is available in API version 39.0 and later.",
"fields_columns": [
"type",
"properties",
"description"
],
"fields": {
"ArchivedById": {
"type": "reference",
"properties": "Filter, Group, Nillable, Sort",
"description": "The ID of the user who archived the article."
},
"ArchivedDate": {
"type": "dateTime",
"properties": "Filter, Nillable, Sort",
"description": "The date when the article was archived."
},
"ArticleNumber": {
"type": "string",
"properties": "Autonumber, Defaulted on create, Filter, idLookup, Sort",
"description": "The unique number automatically assigned to the article when it's created. You can't change the format or value for this field."
},
"CaseAssociationCount": {
"type": "int",
"properties": "Filter, Group, Sort",
"description": "The number of cases attached to the article."
},
"FirstPublishedDate": {
"type": "dateTime",
"properties": "Filter, Nillable, Sort",
"description": "The date when the article was first published."
},
"LastPublishedDate": {
"type": "dateTime",
"properties": "Filter, Nillable, Sort",
"description": "The date when the article was last published."
},
"LastReferencedDate": {
"type": "dateTime",
"properties": "Filter, Nillable, Sort",
"description": "The timestamp when the current user last accessed this record, a record related to this record, or a list view."
},
"LastViewedDate": {
"type": "dateTime",
"properties": "Filter, Nillable, Sort",
"description": "The timestamp when the current user last viewed this record or list view. If this value is null, the user might have only accessed this record or list view (LastReferencedDate) but not viewed it."
},
"MasterLanguage": {
"type": "picklist",
"properties": "Filter, Group, Restricted picklist, Sort",
"description": "The article's original language. Only accessible if your knowledge base supports multiple languages."
},
"MigratedToFromArticle": {
"type": "string",
"properties": "Filter, Group, Nillable, Sort",
"description": "The ID for the corresponding pre- or post-migration article. Contains values only in orgs that migrate from Knowledge in Salesforce Classic to Lightning Knowledge. This field is available in API version 45.0 and later."
},
"TotalViewCount": {
"type": "int",
"properties": "Filter, Group, Nillable, Sort",
"description": "Total number of views for this article. This field is available in API version 39.0 and later."
}
},
"special_access_rules": "Lightning Knowledge must be enabled in your org. A user must have the View Articles permission enabled. Salesforce Knowledge users, unlike customer and partner users, must also be granted the Knowledge User feature license.",
"field_reference": {
"ArchivedById": {
"field_label": "User ID",
"type": "reference",
"length": "18"
},
"ArchivedDate": {
"field_label": "Archived Date",
"type": "datetime"
},
"ArticleNumber": {
"field_label": "Article Number",
"type": "string",
"length": "30"
},
"CaseAssociationCount": {
"field_label": "Case Association Count",
"type": "int",
"digits": "9"
},
"CreatedById": {
"field_label": "Created By ID",
"type": "reference",
"length": "18"
},
"CreatedDate": {
"field_label": "Created Date",
"type": "datetime"
},
"FirstPublishedDate": {
"field_label": "First Published Date",
"type": "datetime"
},
"Id": {
"field_label": "Knowledge Article ID",
"type": "id",
"length": "18"
},
"IsDeleted": {
"field_label": "Is Deleted",
"type": "boolean"
},
"IsGeneratedByLlm": {
"field_label": "Generated by Large Language Model",
"type": "boolean"
},
"LastModifiedById": {
"field_label": "Last Modified By ID",
"type": "reference",
"length": "18"
},
"LastModifiedDate": {
"field_label": "Last Modified Date",
"type": "datetime"
},
"LastPublishedDate": {
"field_label": "Last Published Date",
"type": "datetime"
},
"LastReferencedDate": {
"field_label": "Last Referenced Date",
"type": "datetime"
},
"LastViewedDate": {
"field_label": "Last Viewed Date",
"type": "datetime"
},
"MigratedToFromArticle": {
"field_label": "Mapping info between old Article and migrated Article",
"type": "string",
"length": "15"
},
"SystemModstamp": {
"field_label": "System Modstamp",
"type": "datetime"
},
"TotalViewCount": {
"field_label": "Total View Count",
"type": "int",
"digits": "9"
}
},
"field_reference_columns": [
"field_label",
"type",
"length",
"digits"
]
}