コマンド：
java -classpath .:* -DsiteId=1234 KnowledgeBaseArticles_GET_FromSite
コード：
public static void main(String[] args) throws Exception {
KnowledgeBaseArticleResource.Builder builder =
KnowledgeBaseArticleResource.builder();
KnowledgeBaseArticleResource knowledgeBaseArticleResource =
builder.authentication(
"test@liferay.com", "learn"
).build();
Page<KnowledgeBaseArticle> page =
knowledgeBaseArticleResource.getSiteKnowledgeBaseArticlesPage(
Long.valueOf(System.getProperty("siteId")), null, null, null,
null, Pagination.of(1, 2), null);
System.out.println(page);
}
インスタンスのKnowledgeBaseArticlesオブジェクトがJSONで表示されます。
以下のcURLまたはJavaコマンドを使用し、特定のナレッジベースの記事をIDで取得します。
ヒント
KnowledgeBaseArticles_GET_FromSite.[java|sh] を使用して、インスタンス Knowledge Base Article ID を取得します。
コマンド：
./KnowledgeBaseArticles_GET_ById.sh 1234
コード：
curl \
"http://localhost:8080/o/headless-delivery/v1.0/knowledge-base-articles/${1}" \
--user "test@liferay.com:learn"
コマンド：
java -classpath .:* -DknowledgeBaseArticleId=1234 KnowledgeBaseArticles_GET_ById
コード：
public static void main(String[] args) throws Exception {
KnowledgeBaseArticleResource.Builder builder =
KnowledgeBaseArticleResource.builder();
KnowledgeBaseArticleResource knowledgeBaseArticleResource =
builder.authentication(
"test@liferay.com", "learn"
).build();
System.out.println(
knowledgeBaseArticleResource.getKnowledgeBaseArticle(
Long.valueOf(System.getProperty("knowledgeBaseArticleId"))));
}
KnowledgeBaseArticleフィールドは、JSONで表示されます。
次のcURLおよびJavaコマンドを使用して、既存のナレッジベースの記事を部分的に編集します。 1234をナレッジベース記事のIDに置き換えてください。 修正したいフィールドとその新規値を指定します。
コマンド：
./KnowledgeBaseArticles_PATCH_ById.sh 1234
コード：
curl \
"http://localhost:8080/o/headless-delivery/v1.0/knowledge-base-articles/${1}" \
--data-raw '
{
"articleBody": "Bar"
}' \
--header "Content-Type: application/json" \
--request "PATCH" \
--user "test@liferay.com:learn"
コマンド：
java -classpath .:* -DknowledgeBaseArticleId=1234 KnowledgeBaseArticles_PATCH_ById
コード：
public static void main(String[] args) throws Exception {
KnowledgeBaseArticleResource.Builder builder =
KnowledgeBaseArticleResource.builder();
KnowledgeBaseArticleResource knowledgeBaseArticleResource =
builder.authentication(
"test@liferay.com", "learn"
).build();
KnowledgeBaseArticle knowledgeBaseArticle =
knowledgeBaseArticleResource.patchKnowledgeBaseArticle(
Long.valueOf(System.getProperty("knowledgeBaseArticleId")),
new KnowledgeBaseArticle() {
{
articleBody = "Bar";
}
});
System.out.println(knowledgeBaseArticle);
}
次のcURLおよびJavaコマンドを使用して、既存のナレッジベースの記事を完全に上書きします。 1234をナレッジベース記事のIDに置き換えてください。
コマンド：
./KnowledgeBaseArticles_PUT_ById.sh 1234
コード：
curl \
"http://localhost:8080/o/headless-delivery/v1.0/knowledge-base-articles/${1}" \
--data-raw '
{
"articleBody": "Goo",
"title": "Baker"
}' \
--header "Content-Type: application/json" \
--request "PUT" \
--user "test@liferay.com:learn"
コマンド：
java -classpath .:* -DknowledgeBaseArticleId=1234 KnowledgeBaseArticles_PUT_ById
コード：
public static void main(String[] args) throws Exception {
KnowledgeBaseArticleResource.Builder builder =
KnowledgeBaseArticleResource.builder();
KnowledgeBaseArticleResource knowledgeBaseArticleResource =
builder.authentication(
"test@liferay.com", "learn"
).build();
KnowledgeBaseArticle knowledgeBaseArticle =
knowledgeBaseArticleResource.putKnowledgeBaseArticle(
Long.valueOf(System.getProperty("knowledgeBaseArticleId")),
new KnowledgeBaseArticle() {
{
articleBody = "Goo";
title = "Dog";
}
});
System.out.println(knowledgeBaseArticle);
}
次のcURLおよびJavaコマンドを使用して、既存のナレッジベースの記事を削除します。 1234をナレッジベース記事のIDに置き換えてください。
コマンド：
./KnowledgeBaseArticles_DELETE_ById.sh 1234
コード:
curl \
"http://localhost:8080/o/headless-delivery/v1.0/knowledge-base-articles/${1}" \
--request "DELETE" \
--user "test@liferay.com:learn"
コマンド
java -classpath .:* -DknowledgeBaseArticleId=1234 KnowledgeBaseArticles_DELETE_ById
コード：
public static void main(String[] args) throws Exception {
KnowledgeBaseArticleResource.Builder builder =
KnowledgeBaseArticleResource.builder();
KnowledgeBaseArticleResource knowledgeBaseArticleResource =
builder.authentication(
"test@liferay.com", "learn"
).build();
knowledgeBaseArticleResource.deleteKnowledgeBaseArticle(
Long.valueOf(System.getProperty("knowledgeBaseArticleId")));
}
ナレッジベースフォルダ用のcURLコマンドとJavaクラスは、ナレッジベースの記事と同じように機能します。
| ファイル | 説明 |
|---|
KnowledgeBaseFolders_DELETE_ById.[java\|sh] | ナレッジベースフォルダをIDで削除する。 |
KnowledgeBaseFolders_GET_ById.[java\|sh] | 特定のナレッジベースフォルダをIDで取得する |
KnowledgeBaseFolders_PATCH_ById.[java\|sh] | IDでナレッジベースフォルダにパッチを適用する。 |
KnowledgeBaseFolders_POST_ToSite.[java\|sh] | ナレッジベースフォルダをサイトに投稿する。 |
KnowledgeBaseFolders_PUT_ToSite.[java\|sh] | ナレッジベースフォルダをIDで上書きする。 |
KnowledgeBaseFolders_GET_FromSite.[java\|sh] | サイトからナレッジベースフォルダの一覧を取得する。 |
API エクスプローラー には、すべての KnowledgeBaseArticle および KnowledgeBaseFolder サービスとスキーマが表示され、各サービスを試すためのインターフェースがあります。
) を開き、 デザインを展開して、 テンプレート → 情報テンプレートに移動します。
) では、選択したアイテム タイプの構造から使用可能なフィールドにすばやくアクセスできます。
注
) で、テンプレートに 説明 または 画像 を追加します。
をクリックし、 [スクリプトのエクスポート] または [スクリプトのインポート]を選択します。
