UI API Limitations

UI API with Lightning Knowledge has these limitations.

To retrieve the recordTypeId of a LinkedArticle.LinkedEntity record using the Get a Record UI API, replace Id with RecordTypeId. This limitation applies to API version 57.0 and later.

The response shows the record type ID in two places.

  • LinkedEntity | value | fields | RecordTypeId | value—Shows the correct record type ID.
  • LinkedEntity | value | recordTypeId—Shows null even if there’s an associated record type.

Changing the Object Name of the Knowledge object in Object Manager results in an error when you run the Get Object Metadata UI API for LinkedArticle or CaseArticle. Don’t change the Knowledge object name. This limitation applies to API version 57.0 and later.

Object Manager Details tab that shows Knowledge object name that must not change.

For example, you change the Knowledge object name and run these UI APIs.

You get an INSUFFICIENT_ACCESS error.

To retrieve the KnowledgeArticleVersion.RecordTypeId of LinkedArticle or CaseArticle records using the Get a Record UI API, use the optionaFields not fields request parameter. This limitation applies to API version 57.0 and later.

Here’s the error that you get when you try to retrieve this RecordTypeId using the fields request parameter.

If the related object isn’t added to the page layout of the parent record, UI API doesn’t return the record data or metadata of related lists. This limitation applies to API version 57.0 and later.

The affected endpoints are:

If the related object is missing from the page layout, you encounter one of these problems.

  • NVALID_TYPE error code
  • UNKNOWN_EXCEPTION error code
  • UI API returns the wrong record, for example, the LinkedArticle record instead of Article

To retrieve the correct record data or metadata with the related list UI API endpoints, add the related object to the parent object’s page layout.

To add a related list object, go to Object Manager | {PARENT_OBJECT} | Page Layouts | Related Lists.

Page Layouts tab in the Object Manager where you configure the related lists

For example, to retrieve the Articles related list with these UI API calls, add the Articles related list to the WorkOrder, WorkOrderLineItem, andCase page layouts. Apply this solution to other parent object types that Articles relate to.

To retrieve related list records related to Knowledge articles with these UI API calls, add the WorkOrder, WorkOrderLineItem, andSocialPosts related objects to the Knowledge page layout.

To retrieve record data or metadata of cases related to Knowledge articles, add the Cases related list to the Knowledge page layout.