この文章は Salesforce 機械翻訳システムを使用して翻訳されました。詳細はこちらをご参照ください。
英語に切り替える

Salesforce ナレッジ開発者ガイド

概要
SOAP API
REST API
メタデータ API
SOQL と SOSL
Apex
UI API
UI API の制限
PDF

UI API の制限

Lightning Knowledge を使用した UI API には、以下の制限があります。

リンクされたレコードの RecordTypeId は Null でないはずのときに Null と表示される

Get a Record (レコードの取得) UI API を使用して LinkedArticle.LinkedEntity レコードの recordTypeId を取得する場合は、Id を RecordTypeId に置き換えてください。この制限は、API バージョン 57.0 以降に適用されます。

1// This code doesn't retrieve the correct recordTypeId.
2GET /services/data/v57.0/ui-api/records/{LinkedArticleId}?fields=LinkedArticle.LinkedEntity.Id
3// This code retrieves the correct recordTypeId.
4GET /services/data/v57.0/ui-api/records/{LinkedArticleId}?fields=LinkedArticle.LinkedEntity.RecordTypeId
応答には、レコードタイプ ID が 2 か所に表示��れます。
  • LinkedEntity | value | fields | RecordTypeId | value — 正しいレコードタイプ ID を示しています。
  • LinkedEntity | value | recordTypeId — 関連するレコードタイプがある場合でも、NULL が表示されます。
1{
2    "apiName": "LinkedArticle",
3    "childRelationships": {},
4    "eTag": "0a4b81f3e165e7feefcc2f0e0f30e6da",
5    "fields": {
6        "LinkedEntity": {
7            "displayValue": "00000001",
8            "value": {
9                "apiName": "Name",
10                "childRelationships": {},
11                "eTag": "0917224c30df4322d4e5abbda36a9c25",
12                "fields": {
13                    "Id": {
14                        "displayValue": null,
15                        "value": "0WORM0000006nan4AA"
16                    },
17                    "RecordTypeId": {
18                        "displayValue": null,
19                        "value": "012RM0000005Yl2YAE"
20                    }
21                },
22                "id": "0WORM0000006nan4AA",
23                "lastModifiedById": null,
24                "lastModifiedDate": null,
25                "recordTypeId": null,
26                "recordTypeInfo": null,
27                "systemModstamp": null,
28                "weakEtag": 0
29            }
30        },
31        "LinkedEntityId": {
32            "displayValue": null,
33            "value": "0WORM0000006nan4AA"
34        }
35    },
36    "id": "1WKRM0000004MKA4A2",
37    "lastModifiedById": "005RM000002Z4dkYAC",
38    "lastModifiedDate": "2022-09-28T18:12:10.000Z",
39    "recordTypeId": "012000000000000AAA",
40    "recordTypeInfo": null,
41    "systemModstamp": "2022-09-28T18:12:10.000Z",
42    "weakEtag": 1664388730000
43}

object-info UI API がエラーを返す

[オブジェクトマネージャー] でナレッジオブジェクトの [オブジェクト名] を変更すると、LinkedArticle または CaseArticle に対して Get Object Metadata (オブジェクトメタデータの取得) UI API を実行したときにエラーが発生することがあります。ナレッジオブジェクトの名前は変更しないでください。この制限は、API バージョン 57.0 以降に適用されます。

変更してならないナレッジオブジェクト名が表示された [オブジェクトマネージャー] の [詳細] タブ。

たとえば、ナレッジオブジェクトの名前を変更して、次の UI API を実行するとします。

1GET /services/data/v57.0/ui-api/object-info/LinkedArticle
2GET /services/data/v57.0/ui-api/object-info/CaseArticle

INSUFFICIENT_ACCESS エラーが表示されます。

1{
2    "errorCode":"INSUFFICIENT_ACCESS",
3    "message":"You don't have access to this record. Ask your administrator for help or to request access."
4}

KnowledgeArticleVersion.RecordTypeId の取得に失敗する

Get a Record (レコードの取得) UI API を使用して LinkedArticle または CaseArticle レコードの KnowledgeArticleVersion.RecordTypeId を取得するには、fields 要求パラメーターではなく optionaFields を使用します。この制限は、API バージョン 57.0 以降に適用されます。

1GET /services/data/v57.0/ui-api/records/{LinkedArticleId}?optionalFields=LinkedArticle.KnowledgeArticleVersion.RecordTypeId
2GET /services/data/v57.0/ui-api/records/{CaseArticleId}?optionalFields=CaseArticle.KnowledgeArticleVersion.RecordTypeId

RecordTypeId を fields 要求パラメーターを使用して取得しようとすると、次のエラーが返されます。

1{
2    "errorCode": "INVALID_FIELD",
3    "message": "INVALID_FIELD: \nSELECT LastModifiedDate, KnowledgeArticleVersion.RecordTypeId\n                         ^\nERROR at Row:1:Column:26\nNo such column 'RecordTypeId' on entity 'KnowledgeArticleVersion'. If you are attempting to use a custom field, be sure to append the '__c' after the custom field name. Please reference your WSDL or the describe call for the appropriate names."
4}

関連リストのレコードデータとメタデータが表示されない

関連オブジェクトが親レコードのページレイアウトに追加されていない場合、UI API はレコードデータも、関連リストのメタデータも返しません。この制限は、API バージョン 57.0 以降に適用されます。

次のエンドポイントがこの影響を受けます。
ページレイアウトに関連オブジェクトがない場合、次のいずれかの問題が発生します。
  • NVALID_TYPE エラーコードの発生
  • UNKNOWN_EXCEPTION エラーコードの発生
  • UI API が間違ったレコードを返す (Article ではなく LinkedArticle のレコードを返すなど)

関連リストの UI API エンドポイントで正しいレコードデータやメタデータを取得するには、親オブジェクトのページレイアウトに関連オブジェクトを追加します。

1/ui-api/related-list-records/{parentRecordId}/{relatedListId}
2/ui-api/related-list-info/{parentObjectApiName}/{relatedListId}

関連リストオブジェクトを追加するには、[オブジェクトマネージャー] | {親オブジェクト} | [ページレイアウト] | [関連リスト] に移動します。

関連リストを設定する、[オブジェクトマネージャー] の [ページレイアウト] タブ

たとえば、これらの UI API コールで [記事] 関連リストを取得するには、[記事] 関連リストを WorkOrder、WorkOrderLineItem、および Case のページレイアウトに追加します。この方法を、[記事] が関係する他の親オブジェクト種別にも行います。

1GET /services/data/v57.0/ui-api/related-list-records/{WorkOrderId}/LinkedArticles
2GET /services/data/v57.0/ui-api/related-list-records/{WorkOrderLineItemId}/LinkedArticles
3
4GET /services/data/v57.0/ui-api/related-list-info/{WorkOrderId}/LinkedArticles
5GET /services/data/v57.0/ui-api/related-list-info/{WorkOrderLineItemId}/LinkedArticles
6GET /services/data/v57.0/ui-api/related-list-info/{CaseId}/CaseArticles

これらの UI API コールでナレッジ記事に関連する関連リストレコードを取得するには、[ナレッジ] ページレイアウトに WorkOrder、WorkOrderLineItem、SocialPosts の関連オブジェクトを追加します。

1GET /services/data/v57.0/ui-api/related-list-records/{KnowledgeArticleVersionId}/LinkedWorkOrders
2GET /services/data/v57.0/ui-api/related-list-records/{KnowledgeArticleVersionId}/LinkedWorkOrderLineItems
3GET /services/data/v57.0/ui-api/related-list-records/{KnowledgeArticleVersionId}/LinkedSocialPosts
4
5GET /services/data/v57.0/ui-api/related-list-info/{KnowledgeArticleVersionId}/LinkedWorkOrders
6GET /services/data/v57.0/ui-api/related-list-info/{KnowledgeArticleVersionId}/LinkedWorkOrderLineItems
7GET /services/data/v57.0/ui-api/related-list-info/{KnowledgeArticleVersionId}/LinkedSocialPosts

ナレッジ記事に関連するケースのレコードデータやメタデータを取得するには、[ナレッジ] ページレイアウトに [ケース] 関連リストを追加します。

1GET /services/data/v57.0/ui-api/related-list-info/{Knowledge__kavId}/CaseArticles