機械翻訳について
  1. Oracle Fusionサービスでのナレッジ管理のREST API
  2. タスク
  3. コンテンツ(IM)
  4. コンテンツ

すべてのコンテンツを取得

get

/km/api/v1/content

このサービスは、ナレッジ・ベースから記事のリストを返します。

このリソースは、コンテンツ・オブジェクトの返されたリストをソートできるorderByリクエスト・パラメータをサポートしています。

orderByパラメータで使用する様々な値は、スキーマおよびリソースのカタログ情報で確認できます。 スキーマおよびカタログ情報を取得するには、HTTPリクエストでmediaType値を'application/schema+json' としてGETメソッドを使用します。

リソースのスキーマおよびカタログ情報を取得するURIの例を次に示します : http://<IM_REST_API_HOST>/km/api/latest/metadata-catalog/content

レスポンス・エラー

このメソッドの考えられるエラー・レスポンスは次のとおりです:

  • OK-GEN0020

    このエラーは、リクエストでisForEditパラメータ値が指定されている場合に発生します。

  • $ERROR.General.BO_MODE_NOT_FOUND_CODE$

    このエラーは、リクエストに無効なモードが指定されている場合に発生します。 有効なモード値は、KEY、DATA、EXTENDEDおよびFULLです。

  • OKDOM-GEN0006

    このエラーは、HTTPサービス・リクエストのcontentStateパラメータで無効な値を指定した場合に発生します。

    contentStateパラメータの有効な値は次のとおりです: PUBLISHED、LATESTおよびLATESTVALID。

  • OKDOM-CONT0121

    このエラーは、webユーザーとしてログインしているときにHTTPリクエストとともにcontentState値としてLATESTを指定した場合に発生します。 webユーザーとしてログインしている場合、コンテンツ・リソースでは、contentStateパラメータ値としてLATESTを使用できません。

URIの例

このメソッドのURIの例を次に示します:

  • http://<IM_REST_API_HOST>/km/api/content

    リクエストは、DATAモードでコンテンツ・オブジェクトのページ区切りリストを返します。 デフォルトでは、リストにはコンテンツの公開済バージョンがデフォルトで含まれています。

  • http://<IM_REST_API_HOST>/km/api/content?mode=KEY

    リクエストは、キー・モードでコンテンツ・オブジェクトのページ区切りリストを返します。

  • http://<IM_REST_API_HOST>/km/api/content?mode=EXTENDED

    リクエストは、拡張モードでコンテンツ・オブジェクトのページ区切りリストを返します。

  • http://<IM_REST_API_HOST>/km/api/content?mode=FULL

    リクエストは、フル・モードでコンテンツ・オブジェクトのページ区切りリストを返します。

  • http://<IM_REST_API_HOST>/km/api/content?mode=KEY&limit=5&offset=10

    リクエストは、キー・モードで最大5つのコンテンツ・オブジェクトのページ区切りリストを返します。 このリストは、すべてのコンテンツの10番目のコンテンツから始まります。


問合せで検索

サポートされているメディア・タイプ: 'application/json', 'application/xml'


このメソッドは、指定された基準に一致するナレッジ項目のリストを返します。

記事バージョン

通常、サービスは記事の公開済およびライブ・バージョンを返します。

記事の公開(およびライブ)バージョンと最新バージョンのどちらを使用するかを指定するには、contentStateパラメータを使用して、値をそれぞれPUBLISHEDまたはLATESTVALIDに設定します。 デフォルト値はPUBLISHEDです。

記事サイズ

このサービスは、コンテンツ・ビジネス・オブジェクト(またはコンテンツBO)のナレッジ記事を返します。 開発者は、modeパラメータを使用して、アプリケーションによって返されるコンテンツBOのサイズを選択できます。 ソフトウェアでは、最小から最大までの4つの値がサポートされます: KEY、DATA、EXTENDEDおよびFULL。 大きいモードで返される情報には、小さいモードで返されるすべての情報が含まれます。 たとえば、DATAコンテンツBOには、KEYコンテンツBOのすべての情報が含まれます。

KEYモードを使用する場合、ソフトウェアは、タイトル、ドキュメントID、変更日などの限定された量の記事情報を返します。 KEYモードを使用して、記事のリストを作成できます。

DATAモードを使用すると、記事の内容ではなく、記事に関するより多くの情報が返されます。 これは、記事のリストをリクエストするときのデフォルト値です。

EXTENDEDモードを使用すると、セキュリティおよび表示フィルタ・フィールドの属性(カテゴリ、userGroups、ビューなど)を除き、コンテンツに関するすべての情報が返されます。 EXTENDEDモードを使用すると、記事をエンド・カスタマ、エージェントまたは作成者に表示できます。

FULLモードを使用すると、ソフトウェアは記事に関するすべての情報を返します。 FULLモードは、ユーザーまたはプログラムが記事を更新できるように使用できます。 これは、単一の記事をリクエストするときのmodeパラメータのデフォルト値です。

たとえば、特定のdocumentIdを持つ記事に関するすべての情報を取得するには、URIを使用してコールを発行します:

GET http://<IM_REST_API_HOST>/km/api/latest/content/?q=documentId+eq+'id'&mode=FULL

レスポンス・エラー

このメソッドの考えられるエラー・レスポンスは次のとおりです:

  • OK-GEN0020

    isForEditパラメータ値がリクエストに指定されている場合にエラーが発生

  • $ERROR.General.BO_MODE_NOT_FOUND_CODE$

    このエラーは、リクエストに無効なモードが指定されている場合に発生します。 有効なモード値は、KEY、DATA、EXTENDEDおよびFULLです。

  • OKDOM-GEN0006

    HTTPサービス・リクエストで無効な値を指定すると、エラーが発生します。

    contentStateパラメータの有効な値は次のとおりです: PUBLISHEDおよびLATESTVALID。

  • OKDOM-CRIT0026

    このエラーは、langprefリクエスト・パラメータとともにロケール基準パラメータを指定した場合に発生します。

  • OKDOM-GEN0001

    このエラーは、次のいずれかの場合に発生します:

    • 指定したレコードIDでコンテンツが見つかりません。
    • kmauthtokenヘッダーには、インタフェースが見つからないインタフェースIDが含まれています。
    • interfaceIdパラメータで指定されたインタフェースIDが無効です。

問合せパラメータ

次の表では、このリソースの問合せパラメータについて説明します。

パラメータ問合せ可能ソート可能タイプ説明
recordIdYY'type' : 'string'

文書の一意の識別子。 このIDは、ドキュメントのすべてのロケールのすべてのバージョンで同じです。

documentIdYY'type' : 'string'

コンテンツが保存されるコンテンツ・タイプを示す文書の一意の識別子。

titleYY'type' : 'string'

ドキュメントのタイトル。

answerIdYY'type' : 'integer'

アンサーとコンテンツ間のマッピングを可能にする一意の識別子。

ロケールYN'$ref' : '#/definitions/LocaleKey'

ドキュメントのバージョンのロケール。 ロケール・コードは、Localeオブジェクトに関連付けられた言語と国を表します。 次のサブフィールドをロケール問合せパラメータで使用できます:

  • locale.recordId : ロケール・オブジェクトの一意の識別子。 たとえば、Spanish-Spainロケールで記事をリクエストするには、URIを使用してコールを送信します:
    http://<IM_REST_API_HOST>/km/api/content?q=locale.recordId eq 'es_ES'
articleStatusYN'$ref' : '#/definitions/ArticleStatusKey'

記事ステータス。

    articleStatus.refKeyパラメータを渡すと、サービス・レスポンスは、リクエストで指定された記事ステータスのコンテンツ・オブジェクト(デフォルトでPUBLISHED)と一致します。

    articleStatusパラメータのURIの例を次に示します:

  • http://<IM_REST_API_HOST>/km/api/content?q=articleStatus.referenceKey+eq+'DRAFT'

    • OR

  • http://<IM_REST_API_HOST>/km/api/content?q=articleStatus.referenceKey+in+('DRAFT', 'WORK_IN_PROGRESS')

    • 次のURIの例は、contentStateが最新であるコンテンツ・オブジェクトを返します:

  • http://<IM_REST_API_HOST>/km/api/content?q=articleStatus.referenceKey+eq+'DRAFT' and contentState eq 'LATEST'

    • 次のURIの例は、記事ステータスが割り当てられていないコンテンツ・オブジェクトを返します:

  • http://<IM_REST_API_HOST>/km/api/content?q=articleStatusRefKey+eq+'IM_NULL_ARTICLE_STATUS'

    • 次のURIの例は、記事ステータスが割り当てられていないコンテンツ・オブジェクト、およびドラフト記事ステータスが割り当てられているコンテンツ・オブジェクトを返します:

  • http://<IM_REST_API_HOST>/km/api/content?q=articleStatusRefKey+in+('IM_NULL_ARTICLE_STATUS', 'DRAFT')

    • 指定したarticleStatus問合せに一致するコンテンツ・オブジェクトがない場合、レスポンスには、レコードなしで200 OKのステータスが含まれます。


    指定したarticleStatus問合せに一致するコンテンツ・オブジェクトがない場合、レスポンスには、レコードなしで200 OKのステータスが含まれます。

articleStatusRefKeyYN'type' : 'string'このパラメータは、articleStatus refKeyでコンテンツをフィルタします。
dateModifiedYY'type' : 'string', 'format' : 'date-time'

Oracle Knowledge Repositoryでコンテンツが最後に変更された日付。

displayStartDateYY'type' : 'string', 'format' : 'date-time'

文書をエンドユーザーに表示できるようになる日付。

displayEndDateYY'type' : 'string', 'format' : 'date-time'

サービスがエンド・ユーザーへのドキュメントの表示を停止する日付。

displayReviewDateYY'type' : 'string', 'format' : 'date-time'

レビューを実行できる作成者によるレビューが文書に必要な日付。

contentTypeYN'$ref' : '#/definitions/ContentTypeKey'

コンテンツの分類および保存先となるチャネル。 次に、contentType問合せパラメータで使用できるサブフィールドを示します:

  • contentType.recordId : ContentTypeオブジェクトの一意の識別子。
  • contentType.referenceKey : ContentTypeオブジェクトの参照キー。 ContentTypeオブジェクトは、複数の言語をサポートしています。 このフィールドを使用して、すべての言語の関連オブジェクトを識別できます。 コンテンツ・タイプのFAQの記事をリクエストする例については、URIを使用してコールを送信します:
    http://<IM_REST_API_HOST>/km/api/content?q=contentType.referenceKey eq 'FAQ'
  • contentType.allowRecommendations : このフラグは、エンド・ユーザーがコンテンツに対して推奨を作成できるコンテンツ・タイプを示します。 また、推奨コンテンツをコンテンツ・タイプに関連付けることができるかどうかも示します。
priorityYY'enum' : ['PRIORITY_0', 'PRIORITY_1', 'PRIORITY_2', 'PRIORITY_3', 'PRIORITY_4', 'PRIORITY_5', 'PRIORITY_6', 'PRIORITY_7', 'PRIORITY_8', 'PRIORITY_9', 'PRIORITY_10', 'PRIORITY_11', 'PRIORITY_12', 'PRIORITY_13', 'PRIORITY_14', 'PRIORITY_15', 'PRIORITY_16', 'PRIORITY_17', 'PRIORITY_18', 'PRIORITY_19', 'PRIORITY_20']

コンテンツに割り当てられた優先度。

有効な値は次のとおりです: PRIORITY_0からPRIORITY_20。 たとえば、PRIORITY_1またはPRIORITY_18は有効な値ですが、PRIORITY_21は有効ではありません。

createDateYY'type' : 'string', 'format' : 'date-time'

コンテンツが作成された日付。 レガシー・システムの場合、作成日は、それらのシステムでドキュメントが作成された日付です。

lastModifiedDateYY'type' : 'string', 'format' : 'date-time'

コンテンツが最後に変更された日付。 レガシー・システムの場合、lastModifiedDate日付は、これらのシステムでドキュメントが最後に変更された日付です。

dateAddedYY'type' : 'string', 'format' : 'date-time'

コンテンツがコンテンツ・タイプに追加された日付。 レガシー・システムの場合、作成日は、ドキュメントがレガシー・システムからOracle Knowledge Repositoryに移行された日付です。

eventStartDateYY'type' : 'string', 'format' : 'date-time'

ドキュメントのイベントが開始する日付。

eventEndDateYY'type' : 'string', 'format' : 'date-time'

ドキュメントのイベントが終了する日付。

所有者YN'$ref' : '#/definitions/UserKey'

ドキュメントを所有または担当するユーザーまたは作成者。 次に、オーナー問合せパラメータで使用できるサブフィールドを示します:

  • owner.recordId : 所有者オブジェクトの一意の識別子。 たとえば、一意のIDを持つ記事をリクエストするには、URIを使用してコールを発行します:
    http://<IM_REST_API_HOST>/km/api/content?q=owner.recordId eq '{id}'
  • owner.email : ユーザーのeメール。
  • owner.firstName : ユーザーの名。
  • owner.lastName : ユーザーの姓。
  • owner.login : User's login.
lastModifierYN'$ref' : '#/definitions/UserKey'

最後のコンテンツ変更を実行したユーザーまたは作成者。 次に、lastModifier問合せパラメータで使用できるサブフィールドを示します:

  • lastModifier.recordId : lastModifierオブジェクトの一意の識別子。 たとえば、一意のIDを持つ記事をリクエストするには、URIを使用してコールを発行します:
    http://<IM_REST_API_HOST>/km/api/content?q=lastModifier.recordId eq '{id}'
  • lastModifier.email : User's email.
  • lastModifier.firstName : ユーザーの名。
  • lastModifier.lastName : ユーザーの姓。
  • lastModifier.login : User's login.
創造者YN'$ref' : '#/definitions/UserKey'

最初にドキュメントを作成または作成したユーザー。 作成者問合せパラメータで使用できるサブフィールドは次のとおりです:

  • creator.recordId : 作成者オブジェクトの一意の識別子。 たとえば、一意のIDを持つ記事をリクエストするには、URIを使用してコールを発行します:
    http://<IM_REST_API_HOST>/km/api/content?q=creator.recordId eq '{id}'
  • creator.email : User's email.
  • creator.firstName : ユーザーの名。
  • creator.lastName : ユーザーの姓。
  • creator.login : User's login.
publishDateYY'type' : 'string', 'format' : 'date-time'

文書がエンド・ユーザーに最初に表示される日付。

checkedOutYY'type' : 'boolean'

作成者がドキュメントを編集のためにチェックアウトまたはロックした日付。

checkedOutByYN'$ref' : '#/definitions/UserKey'

最後のコンテンツ・チェックアウトを実行したユーザーまたは作成者。 次に、checkedOutBy問合せパラメータで使用できるサブフィールドを示します:

  • checkedOutBy.recordId : checkedOutByオブジェクトの一意の識別子。 たとえば、一意のIDを持つ記事をリクエストするには、URIを使用してコールを発行します:
    http://<IM_REST_API_HOST>/km/api/content?q=checkedOutBy.recordId eq '{id}'
  • checkedOutBy.email : User's email.
  • checkedOutBy.firstName : ユーザーの名。
  • checkedOutBy.lastName : ユーザーの姓。
  • checkedOutBy.login : User's login.
mostPopularYY'type' : 'string'

これは、返されるリスト内のコンテンツ・オブジェクトのソートに使用できるソート・フィールドです。

mostPopularパラメータ値は、エンド・ユーザーがドキュメントを表示した回数によって決まります。 値は、contentmetrics表の件数でソートされます。 mostPopularソート・フィールドでは、エンド・ユーザー間で人気順にオブジェクトがソートされます。 最も人気のあるものがリストの上部に表示されます。

問合せの値としてmostPopularを使用せず、ソート・フィールドとして使用します。

ノート: mostRecentおよびmostPopularソート・フィールドは同時に使用できません。

例U RImostPopularソート・フィールドがcontentStateおよびModeパラメータとともに使用される場合の組合せは次のとおりです:

  • http://<IM_REST_API_HOST>/km/api/content?q=&orderBy=mostPopular

    リクエストは、最も人気のあるコンテンツ・オブジェクトを降順にソートします。 最も一般的なドキュメントがリストの先頭に表示されます。

  • http://<IM_REST_API_HOST>/km/api/content?q=&orderBy=mostPopular,dateAdded

    リクエストによって、コンテンツ・オブジェクトが人気順に降順にソートされ、追加された日付が昇順にソートされます。

  • http://<IM_REST_API_HOST>/km/api/content?q=contentState eq 'LATESTVALID'&orderBy=mostPopular,dateAdded&mode=KEY

    リクエストによって、コンテンツ・オブジェクトはmostPopularパラメータ値で降順にソートされ、dateAddedパラメータ値は昇順にソートされます。 このリストには、KEYモードのオブジェクトのみが含まれ、contentStateパラメータ値がLATESTVALIDとなっています。

例U RIカテゴリ・パラメータでmostPopularソート・フィールドが使用されている場合の組合せは次のとおりです:

  • http://<IM_REST_API_HOST>/km/api/content?q=contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey in ('WORLD')&orderBy=mostPopular&mode=KEY

    リクエストは、コンテンツ・タイプagile_channelのコンテンツ・オブジェクトとカテゴリworldをmostPopularパラメータ値でソートします。

  • http://<IM_REST_API_HOST>/km/api/content?q=contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey in ('WORLD') and filterMode.contentState eq 'LATESTVALID'&orderBy=mostPopular&mode=KEY

    リクエストによって、コンテンツ・タイプagile_channelのコンテンツ・オブジェクトとカテゴリworldがリストの先頭で最も人気のあるものでソートされます。 リストには、最新の有効なドキュメントが含まれています。

mostRecentYY'type' : 'string'

これは、返されたリスト内のコンテンツ・オブジェクトを最後に作成された順にソートするために使用できるソート・フィールドです。

問合せの値としてmostRecentを使用せず、ソート・フィールドとして使用します。

ノート: mostRecentおよびmostPopularソート・フィールドは同時に使用できません。

例U RImostPopularソート・フィールドがcontentStateで使用される場合、カテゴリ・オブジェクトおよびモード・パラメータは次のようになります:

  • http://<IM_REST_API_HOST>/km/api/content?q=contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey in ('WORLD')&orderBy=mostRecent&mode=KEY

    リクエストは、コンテンツ・タイプagile_channelのコンテンツ・オブジェクトとカテゴリ・ワールドを、リストの最上部で最近作成されたドキュメントでソートします。 コンテンツの状態が言及されていないため、公開日によって結果がソートされます。 contentStateパラメータのデフォルト値はPUBLISHEDです。

  • http://<IM_REST_API_HOST>/km/api/content?q=contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey in ('WORLD') and filterMode.contentState eq 'LATESTVALID'&orderBy=mostRecent&mode=KEY

    リクエストは、コンテンツ・タイプagile_channelのコンテンツ・オブジェクトとカテゴリ・ワールドを、リストの最上部で最近作成されたドキュメントでソートします。 リストには、公開を必要としない最新の有効なドキュメントが含まれています。 コンテンツの状態がLATESTVALIDサービスであるため、リストは、publishedDateパラメータ値ではなくdateModifiedパラメータ値でソートされます。

  • http://<IM_REST_API_HOST>/km/api/content?q=contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey in ('WORLD') and filterMode.contentState eq 'PUBLISHED'&orderBy=mostRecent&mode=KEY

    リクエストは、コンテンツ・タイプagile_channelのコンテンツ・オブジェクトとカテゴリ・ワールドを、リストの最上部で最近作成されたドキュメントでソートします。 リストには、公開されたドキュメントが含まれます。

期限切れYN'type' : 'boolean'失効した文書のみを返すフラグ。
contentStateYN'enum' : ['PUBLISHED', 'LATEST', 'LATESTVALID', 'EXPIRED', 'DRAFT']

コンテンツの状態。 有効な値は、PUBLISHEDおよびLATESTVALIDです。

contentStateパラメータ値をcontentStateとしてではなく、filterMode.contentStateとして指定します。 コンテンツ以外のリソースからコンテンツ関係を移動する場合は、content.contentStateまたはfilterModeではなく、filterMode.contentStateとしても指定する必要があります。関係トラバース・パターンが失われるため、content.contentState。

作成者は、公開済ライブまたは公開待ちの2つのタイプのいずれかで文書を公開できます。 その定義は次のとおりです:

  • パブリッシュされたライブは、ドキュメントがエンドユーザーが現在使用可能になっているときです。
  • 公開待ちは、文書が公開されて、将来エンド・ユーザーが使用できるようになるときです。

ノート: 公開されているcontentStateパラメータ値では、公開されているドキュメントのみが考慮されます。

displayStartDateおよびdisplayEndDateは、表示日と呼ばれ、ドキュメント・バージョンがcontentState要件を満たすかどうかを決定する基準です。 リクエストが行われた日付がdisplayStartDateとdisplayEndDateの範囲内にない場合、サービスでは表示日が無効とみなされます。

ノート: リクエストの実行時にエンドユーザーがドキュメントを使用できない場合、ドキュメントの表示日は無効であるとみなされます。 これには、displayStartDateが将来存在する公開済の保留中のドキュメントは含まれません。

例U RI組合せ(contentStateパラメータを有効な値とともに使用する場合):

公開されたcontentStateパラメータ。

  • http://<IM_REST_API_HOST>/km/api/content?q=filterMode.contentState eq 'PUBLISHED'

    リクエストは、ライブで公開されているドキュメントの公開済ライブ・バージョンを返します。

    最新の有効とともに使用されるcontentStateパラメータ。

  • http://<IM_REST_API_HOST>/km/api/content?q=filterMode.contentState eq 'LATESTVALID'

    このリクエストは、最新の有効なバージョンを持つドキュメントを返します。

次に、ドキュメントのどのバージョンが最新の有効なバージョンになるかを決定するルールを示します:

  • 公開済のライブ・バージョンと公開済の保留中のバージョンの両方が存在する場合、サービスは公開済のライブ・バージョンを返します。
  • 公開済の保留中バージョンのみが存在する場合は、何も返しません。
  • 公開済の保留中バージョンが存在しない場合、表示日が有効であれば、サービスは最新バージョンを返します。
  • 公開済の保留中バージョンが存在せず、最新バージョンの表示日が無効な場合、サービスは公開済のライブ・バージョンを返します。
  • 公開済バージョンが存在せず、最新バージョンの表示日が無効な場合は、何も返されません。
workflowStepYN'$ref' : '#/definitions/WorkflowStepKey'

ドキュメント・バージョンが現在存在しているワークフローのステップ。

wfStepNotificationOverrideYY'type' : 'string', 'format' : 'date-time'

レビューに関与する作成者にサービスが通知を送信する日付。 ワークフロー通知が提供されると、サービスは次のレビュー日を更新します。

categoriesYN'$ref' : '#/definitions/ListCategoryKey'

コンテンツに割り当てられたカテゴリ・オブジェクトまたはカテゴリ・オブジェクトのリスト。

たとえば 世界がレベル1のカテゴリである場合、レベル2にアフリカ、ウクライナ、アメリカなどがある可能性があります。 カテゴリ内のオブジェクトのリクエストは、階層的または非階層的に指定できます。 フロリダが割り当てられているコンテンツが階層型のリクエスト・ワールドを使用してリクエストされると、結果が表示されます。 一方、同じリクエストが非階層的に実行されても、結果はありません。

カテゴリ・パラメータを使用すると、単一構成と複数構成の両方で、結果を第1レベル・カテゴリおよび階層カテゴリでフィルタできます。

    いずれかと一致

    リクエストとともに contentType.refKey eqパラメータまたはcontentType.refKey inパラメータを渡すと、サービスはリクエストで指定されたカテゴリのいずれかに一致します。

    categoryパラメータのURIの例を次に示します:

  • http://<IM_REST_API_HOST>/km/api/content?q=contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey eq 'WORLD'&mode=KEY

    • OR

  • http://<IM_REST_API_HOST>/km/api/content?q=contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey in ('WORLD')&mode=KEY

    • 次のURIの例は、指定したカテゴリのレベルに存在するコンテンツ・オブジェクトを返します。 これにより、子コンテンツ・オブジェクトは返されません。

  • http://<IM_REST_API_HOST>/km/api/content?q=contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey withNoChildren 'WORLD'&mode=KEY

    • OR

  • http://<IM_REST_API_HOST>/km/api/content?q=contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey inWithNoChildren ('WORLD')&mode=KEY

    • 次のURIの例は、リクエストで指定された複数の基準に一致するコンテンツ・オブジェクトを返します。

  • http://<IM_REST_API_HOST>/km/api/content?q=contentType.refKey in ('AGILE_CHANNEL', 'NEWS_CHANNEL') and categories.refKey inWithNoChildren ('USA', 'EUROPE')&mode=KEY&orderBy=mostPopular

    次のURIの例は、リクエストで指定された複数の基準に一致するコンテンツ・オブジェクトを返します

  • http://<IM_REST_API_HOST>/km/api/content?q=contentType.refKey in ('AGILE_CHANNEL', 'NEWS_CHANNEL') and categories.refKey inWithNoChildren ('USA', 'EUROPE') and filterMode.contentState eq 'PUBLISHED'&mode=KEY&orderBy=mostRecent

    返されたリストのオブジェクトは、公開日に基づいてソートされます。

  • http://<IM_REST_API_HOST>/km/api/content?q=contentType.refKey in ('AGILE_CHANNEL', 'NEWS_CHANNEL') and categories.refKey inWithNoChildren ('USA', 'EUROPE') and filterMode.contentState eq 'LATESTVALID'&mode=KEY&orderBy=mostRecent

    返されるリスト内のオブジェクトは、dateModifiedでソートされます。

    すべて一致

    リクエストとともに andcategories.refKey matchAll パラメータを渡すと、リクエストで指定されたすべてのカテゴリがサービスによって照合されます。

  • http://<IM_REST_API_HOST>/km/api/content?q=contentState eq 'LATEST' and contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey matchAll ('WORLD', 'MOVIES')&mode=KEY

    このリクエストは、ワールドおよびムービー・カテゴリ内のすべてのコンテンツ・オブジェクトを返します。 アフリカはカテゴリworldの子カテゴリであるため、サービスはAfricaカテゴリのコンテンツ・オブジェクトを返します。

  • http://<IM_REST_API_HOST>/km/api/content?q=contentState eq 'LATEST' and contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey matchAll ('WORLD', 'MOVIES')&mode=KEY&orderBy=mostPopular

    返されたリストのオブジェクトは、ビューによって降順にソートされます。

  • http://<IM_REST_API_HOST>/km/api/content?q=contentState eq 'PUBLISHED' and contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey matchAll ('WORLD', 'MOVIES')&mode=KEY&orderBy=mostRecent

    返されたリストのオブジェクトは、公開された日付の降順でソートされます。

userGroupsYN'$ref' : '#/definitions/ListUserGroupKey'

コンテンツに割り当てられたユーザー・グループ。 割り当てられたユーザー・グループのメンバーのみがコンテンツにアクセスできます。 デフォルト値は全員です。

ビューYN'$ref' : '#/definitions/ListViewKey'

コンテンツに割り当てられたビュー。 コンテンツにビューが割り当てられているユーザー、またはコンテンツが保存されているコンテンツ・タイプは、そのコンテンツにのみアクセスできます。

リクエスト

問合せパラメータ
  • このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。 制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
  • このパラメータは、返されるリソースに含める情報の量を定義 - KEYは情報の最小化(したがって、パフォーマンスが向上)されており、FULLはほとんどの情報を持つ情報です。
    許可された値: [ "KEY", "DATA", "EXTENDED", "FULL" ]
  • リソース・コレクションの開始位置を定義するために使用します。 オフセットがリソース数を超えると、リソースは返されません。 デフォルト値は0です。
  • このパラメータは、指定された属性に基づいてリソース・コレクションを順序付けします。 パラメータ値は、属性名のカンマ区切りの文字列で、それぞれオプションでコロンと'asc'または'desc'が続きます。 昇順には'asc'を指定し、降順には'desc'を指定します。 デフォルト値は'asc'です。 たとえば、?orderBy=field1:asc,field2:descです。
  • このパラメータの値はOracle Knowledge Q問合せである必要があります - この操作の『スタート・ガイド』ドキュメント(「問合せ」ページ)およびQ問合せのドキュメントを参照してください。
トップに戻る

レスポンス

サポートされるメディア・タイプ

200 レスポンス

「OK」をクリックします。
本文( )
ルート・スキーマ : ResultList ContentData
タイプ: object
タイトル: ResultList ContentData
ソースを表示
ネストされたスキーマ : アイテム
タイプ: array
ソースを表示
ネストされたスキーマ : ContentData
タイプ: object
タイトル: ContentData
ソースを表示
ネストされたスキーマ : allTranslations
タイプ: array

このフィールドは、ユーザーが表示できるすべての翻訳済コンテンツのリストを返します

このフィールドは、allTranslations問合せパラメータが値trueで渡された場合にのみ移入されます。

ソースを表示
ネストされたスキーマ : ArticleStatusKey
タイプ: object
タイトル: ArticleStatusKey
ソースを表示
ネストされたスキーマ : LocaleKey
タイプ: object
タイトル: LocaleKey
ソースを表示
ネストされたスキーマ : UserKey
タイプ: object
タイトル: UserKey
ソースを表示
  • ユーザー・オブジェクトの電子メール
  • ExternalIdは、外部システムからの対応するユーザーのIDです。 ExternalTypeとともに、このシステムからのユーザーと外部システムのユーザーとの間のギャップを埋めるために使用できます。
  • ExternalTypeは、外部システムからの対応するユーザーのタイプです。 ExternalIdとともに使用すると、このシステムからのユーザーと外部システムのユーザーとの間のギャップを埋めることができます。
  • links
  • ユーザーのフルネーム
  • ユーザー・オブジェクトの一意のレコードID。
ネストされたスキーマ : ContentTypeKey
タイプ: object
タイトル: ContentTypeKey
ソースを表示

  • ContentTypeオブジェクトの説明。 コンテンツ・タイプは複数の言語をサポートしています。

    このフィールドは、ユーザーが指定した言語に関連付けられているオブジェクトを識別します。

  • links

  • ContentTypeオブジェクトの名前。 名前フィールドはソートにのみ使用できます。

    コンテンツ・タイプは複数の言語をサポートしています。 このフィールドは、ユーザーが指定した言語に関連付けられているオブジェクトを識別します。

  • ContentTypeオブジェクトの一意の識別子。

  • ContentTypeオブジェクトの参照キー。

    ContentTypeオブジェクトは、複数の言語をサポートしています。 このフィールドを使用して、すべての言語の関連オブジェクトを識別できます。

  • ストライプ・コードを示す参照コード。

ネストされたスキーマ : ContentKey
タイプ: object
タイトル: ContentKey
ソースを表示
ネストされたスキーマ : DataForm
タイプ: object
タイトル: DataForm
ソースを表示
ネストされたスキーマ : AggregateFormResults
タイプ: object
タイトル: AggregateFormResults
ソースを表示
ネストされたスキーマ : schemaAttributes
タイプ: array

このフィールドには、このコンテンツのコンテンツ・タイプに関連付けられたスキーマ属性のリストが返されます。

このフィールドは、additionalFields問合せパラメータが値schemaAttributesとともに渡された場合にのみ移入されます。

ソースを表示
ネストされたスキーマ : allTranslations
タイプ: array

このフィールドは、ユーザーが表示できるすべての翻訳済コンテンツのリストを返します

このフィールドは、allTranslations問合せパラメータが値trueで渡された場合にのみ移入されます。

ソースを表示
ネストされたスキーマ : schemaAttributes
タイプ: array

このフィールドには、このコンテンツのコンテンツ・タイプに関連付けられたスキーマ属性のリストが返されます。

このフィールドは、additionalFields問合せパラメータが値schemaAttributesとともに渡された場合にのみ移入されます。

ソースを表示
ネストされたスキーマ : SchemaAttribute
タイプ: object
タイトル: SchemaAttribute
ソースを表示
ネストされたスキーマ : 子供
タイプ: array
現在の要素の子ノードのリスト
ソースを表示
ネストされたスキーマ : localizedAttributes
タイプ: array
様々なロケールでのこのSchemaAttribute名のLocalizedAttributesおよび説明のリスト
ソースを表示
ネストされたスキーマ : schemaAttributeUserGroupList
タイプ: array
この属性を保護するために使用できるユーザー・グループのリスト。 これは、ContentTypeに割り当てられたユーザー・グループのリストのサブセットである必要があります
ソースを表示
ネストされたスキーマ : LocalizedAttributes
タイプ: object
タイトル: LocalizedAttributes
ソースを表示
ネストされたスキーマ : SchemaAttributeUserGroup
タイプ: object
タイトル: SchemaAttributeUserGroup
ソースを表示
ネストされたスキーマ : UserGroupKey
タイプ: object
タイトル: UserGroupKey
ソースを表示
ネストされたスキーマ : 質問
タイプ: array
質問と多数の関係
ソースを表示
ネストされたスキーマ : ビュー
タイプ: array
表示する関係が多すぎます
ソースを表示
ネストされたスキーマ : DataFormQuestion
タイプ: object
タイトル: DataFormQuestion
ソースを表示
ネストされたスキーマ : 答え
タイプ: array
回答との関連性が多すぎます
ソースを表示
ネストされたスキーマ : DataFormKey
タイプ: object
タイトル: DataFormKey
ソースを表示
ネストされたスキーマ : DataFormAnswer
タイプ: object
タイトル: DataFormAnswer
ソースを表示
ネストされたスキーマ : DataFormQuestionKey
タイプ: object
タイトル: DataFormQuestionKey
ソースを表示
ネストされたスキーマ : ViewKey
タイプ: object
タイトル: ViewKey
ソースを表示
ネストされたスキーマ : 質問
タイプ: array
AggregateQuestionResultとの関係が多すぎます
ソースを表示
ネストされたスキーマ : AggregateQuestionResult
タイプ: object
タイトル: AggregateQuestionResult
ソースを表示
ネストされたスキーマ : 答え
タイプ: array
AggregateAnswerResultとの関係が多すぎます
ソースを表示
ネストされたスキーマ : AggregateAnswerResult
タイプ: object
タイトル: AggregateAnswerResult
ソースを表示
トップに戻る

例

次の例は、Oracle Knowledgeリポジトリからすべてのコンテンツ・レコード・オブジェクトを検索する方法を示しています。

curl -X GET "https://<IM_REST_API_HOST>/km/api/latest/content" -u "<username:password>" -H "Accept: application/json" -H "Content-Type: application/json"

レスポンス本文の例

次の例は、JSON形式のレスポンス本文のコンテンツを示しています:

{
  "items": [
    {
      "contentType": {
        "recordId": "BC015169991F49738196682D57E7C5E3",
        "referenceKey": "SOLUTION",
        "name": "Solution",
        "links": [
          {
            "rel": "canonical",
            "href": "https://IM_REST_API_HOST/km/api/latest/contentTypes/BC015169991F49738196682D57E7C5E3",
            "mediaType": "application/json, application/xml",
            "method": "GET"
          }
        ]
      },
      "priority": "PRIORITY_0",
      "createDate": "2016-10-19T07:48:11-0600",
      "dateAdded": "2017-03-07T16:06:08-0700",
      "displayStartDate": "2016-10-19T07:45:47-0600",
      "displayEndDate": "9999-12-31T00:00:00-0700",
      "owner": {
        "recordId": "040036719791200157210710b5007f80",
        "name": "John Baird",
        "externalType": "ACCOUNT",
        "links": [
          {
            "rel": "canonical",
            "href": "https://IM_REST_API_HOST/km/api/latest/users/040036719791200157210710b5007f80",
            "mediaType": "application/json, application/xml",
            "method": "GET"
          }
        ]
      },
      "lastModifier": {
        "recordId": "0400864aa0bf1015796a9cbbf007fea",
        "name": "autocsoadm1 svc",
        "externalType": "ACCOUNT",
        "links": [
          {
            "rel": "canonical",
            "href": "https://IM_REST_API_HOST/km/api/latest/users/0400864aa0bf1015796a9cbbf007fea",
            "mediaType": "application/json, application/xml",
            "method": "GET"
          }
        ]
      },
      "creator": {
        "recordId": "040036719791200157210710b5007f80",
        "name": "John Baird",
        "externalType": "ACCOUNT",
        "links": [
          {
            "rel": "canonical",
            "href": "https://IM_REST_API_HOST/km/api/latest/users/040036719791200157210710b5007f80",
            "mediaType": "application/json, application/xml",
            "method": "GET"
          }
        ]
      },
      "published": true,
      "publishDate": "2017-03-07T16:06:08-0700",
      "checkedOut": false,
      "publishedVersion": "3.0",
      "recordId": "0400362a57eb0e0157d88fc1db007f16",
      "versionId": "040036745e3985015aaa717506007f48",
      "documentId": "SOL64",
      "title": "Problems Caused When Service Item Flexfield is not Defined Correctly",
      "version": "3.0",
      "answerId": 1000147,
      "locale": {
        "recordId": "en_US",
        "links": [
          {
            "rel": "canonical",
            "href": "https://IM_REST_API_HOST/km/api/latest/locales/en_US",
            "mediaType": "application/json, application/xml",
            "method": "GET"
          }
        ]
      },
      "dateModified": "2017-03-07T16:06:08-0700",
      "links": [
        {
          "rel": "canonical",
          "href": "https://IM_REST_API_HOST/km/api/latest/content/0400362a57eb0e0157d88fc1db007f16",
          "mediaType": "application/json, application/xml",
          "method": "GET"
        },
        {
          "rel": "collection",
          "href": "https://IM_REST_API_HOST/km/api/latest/content",
          "mediaType": "application/json, application/xml",
          "method": "GET",
          "profile": "https://IM_REST_API_HOST/km/api/latest/metadata-catalog/content"
        }
      ]
    }
  ]
  "hasMore": true,
  "limit": 20,
  "offset": 0,
  "links": [
    {
      "rel": "canonical",
      "href": "https://IM_REST_API_HOST/km/api/latest/content?limit=20&offset=0",
      "mediaType": "application/json, application/xml",
      "method": "GET"
    },
    {
      "rel": "next",
      "href": "https://IM_REST_API_HOST/km/api/latest/content?limit=20&offset=20",
      "mediaType": "application/json, application/xml",
      "method": "GET"
    }
  ],
  "count": 1
}
「トップに戻る」