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

バージョンIDによるコンテンツの取得

get

/km/api/v1/content/versions/{versionId}

このメソッドは、指定されたバージョンID (versionId)を持つドキュメントを返します。 デフォルトでは、返されるコンテンツ・ドキュメントは読取り用に設定されます。 ただし、編集可能なドキュメントをリクエストできます。

バージョンIDは、コンテンツの各バージョンの一意の識別子です。 バージョンは、コンテンツID (ドキュメントIDまたはレコードID)、ロケール、メジャー・バージョンおよびマイナー・バージョンで構成されます。

たとえば、コンテンツIDがFA54のドキュメントには、次の3つのバージョンがあります:

  • FA54(英語)(1.0)
  • FA54(英語)(2.0)
  • FA54(スペイン語、1.0)

この3つのバージョンのドキュメントには、一意のバージョンIDがあります。

編集可能なコンテンツのリクエスト

編集可能なドキュメントをリクエストするには、HTTPリクエストで次のパラメータを指定します:

ノート: リクエストを送信する前に、コンテンツ・タイプに対する表示権限があることを確認してください。

  • isForEditリクエスト・パラメータをHTTPリクエストとともに指定し、パラメータ値をtrueに設定します。
  • コンテンツ・オブジェクトのモードをFULLとして指定します。

たとえば、URI http://<IM_REST_API_HOST>/km/api/content/versions/{versionId}?mode=FULL&isForEdit=trueを使用してリクエストが送信されると、指定されたIDパラメータを持つContentオブジェクトがFULLモードで取得されます。 コンテンツの最新バージョンは、編集目的でデフォルト・ロケールに表示されます。

読取り可能なコンテンツのリクエスト

返されるドキュメントは、様々な状況で読取り可能なドキュメントをリクエストする必要がある場合でも、デフォルトで読取り用に設定されています。

読取り可能なドキュメントをリクエストするには、HTTPリクエストで次のパラメータを指定します:

ノート: リクエストを送信する前に、コンテンツ・タイプに対する表示権限があることを確認してください。

  • HTTPリクエストでisForEditリクエスト・パラメータを指定し、パラメータ値をfalseに設定します。
  • コンテンツ・オブジェクトのモードをEXTENDEDまたはFULLとして指定します。

たとえば、URI http://<IM_REST_API_HOST>/km/api/content/versions/{versionId}?mode=EXTENDEDを使用してリクエストが送信されると、EXTENDEDモードで読取り専用Contentオブジェクトを取得します。 サービスは、XMLおよびメタデータXMLのコンテンツの置換トークン参照を置換トークン値で置き換えます。

翻訳済コンテンツのリクエスト

バージョンIDまたは回答IDを使用して翻訳済コンテンツをリクエストすることはできません。

バージョンIDは、メジャー・バージョンとマイナー・バージョンのコンテンツの特定の翻訳を表します。 たとえば、ドキュメントFA54には、英語のコンテンツ用に2つの異なるバージョンIDがあります。1つはバージョン1.0、もう1つは2.0です。

回答IDは、コンテンツの特定の翻訳を表します。 たとえば、ドキュメントFA54には、英語の場合は回答ID 101、スペイン語の場合は回答ID 102があります。

コンテンツ・セキュリティ

webユーザーは、'isForEdit'問合せパラメータの値に基づいてコンテンツにアクセスできます。 サービスは、ユーザーに割り当てられたセキュリティ・ロール権限を使用してコンテンツを表示します。

  • ユーザーには、指定したコンテンツ・レコードが保存されるコンテンツ・タイプに対する表示権限が必要です。
  • ユーザーに割り当てられたビューまたは部門が、コンテンツに割り当てられた少なくとも1つのビューまたは部門と一致します。

レスポンス・エラー

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

  • OK-GEN0020

    • langprefリクエスト・パラメータはリクエストとともに指定され、バージョンのロケールと一致しません。
    • このエラーは、langprefパラメータまたはcontentStateパラメータをリクエストとともに指定すると発生します。

  • OKDOM-GEN0001

    このエラーは、指定したバージョンIDのコンテンツが見つからない場合に発生します。

  • OK-GEN0014

    このエラーは、isForEditリクエスト・パラメータ値がtrueに設定されているが、ドキュメントのモードがFULLに指定されていない場合に発生します。

  • $ERROR.General.BO_MODE_NOT_FOUND_CODE$

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

  • OK-SEC0001

    このエラーは、isForEditリクエスト・パラメータ値がtrueとして指定され、次の条件のいずれかが存在する場合に発生します:

    • ユーザーには、ドキュメントを含むコンテンツ・タイプに対する変更権限がありません。
    • バージョンのロケールは、ユーザーの使用可能なコンテンツ・ロケール・リストに存在しません

URIの例

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

  • http://<IM_REST_API_HOST>/km/api/content/versions/{versionId}?mode=FULL

    リクエストは、指定されたContentオブジェクトをFULLモードで返します。

  • http://<IM_REST_API_HOST>/km/api/content/versions/{versionId}?mode=FULL

    リクエストは、読取り可能なContentオブジェクトをFULLモードで返します。 オブジェクトのisForEditリクエスト・パラメータ値のフィールドはfalseに設定されます。

  • http://<IM_REST_API_HOST>/km/api/content/versions/{versionId}?mode=FULL&isForEdit=true

    リクエストは、指定されたバージョンIDを持つ編集可能なコンテンツ・オブジェクトをFULLモードで返します。 リスト内のコンテンツ・オブジェクトは、デフォルトのロケールで表示されます。 オブジェクトのisForEditリクエスト・パラメータ値のフィールドはtrueとして表示されます。

リクエスト

パス・パラメータ
トップに戻る

レスポンス

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

200 レスポンス

「OK」をクリックします。
本文( )
ルート・スキーマ : コンテンツ
タイプ: object
タイトル: Content
ソースを表示
  • allTranslations

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

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

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

  • ArticleStatusKey
    タイトル: ArticleStatusKey
  • LocaleKey
    タイトル: LocaleKey
  • コンテンツ・オブジェクトのバージョン
  • categories

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

    たとえば 世界がレベル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

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

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

  • UserKey
    タイトル: UserKey
  • ContentTypeKey
    タイトル: ContentTypeKey

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

  • UserKey
    タイトル: UserKey

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

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

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

  • 許可された値: [ "FIXED_AT_TOP", "PLACE_AT_TOP", "HISTORICAL_USEFULNESS" ]
    Fixed@Top、Place@Top、Historical UsefulnessのLookUpコード

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

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

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

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

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

  • 編集可能なコンテンツをリクエストするパラメータ。

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

  • UserKey
    タイトル: UserKey
  • ContentKey
    タイトル: ContentKey
  • links
  • LocaleKey
    タイトル: LocaleKey
  • コンテンツ・オブジェクトのMetaDataResourcePath
  • コンテンツ・オブジェクトのMetaDataXml
  • UserKey
    タイトル: UserKey

  • 文書が公開待ちかどうかを示すフラグ。

  • 許可された値: [ "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は有効ではありません。

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

  • 文書が公開されているかどうかを示すフラグ。

  • ContentKey
    タイトル: ContentKey
  • コンテンツ・オブジェクトのバージョン
  • DataForm
    タイトル: DataForm
  • AggregateFormResults
    タイトル: AggregateFormResults
  • コンテンツを編集または作成する理由。 これは、ドキュメントの作成または更新時にのみ使用されます。

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

  • replacementTokens

    短く、管理しやすい用語(tokenName)を作成するオブジェクト。 これらのトークンは、標準化および翻訳可能であり、場合によっては複雑なコンテンツ(統合テキスト、イメージ、リスト、表など)を表します。

  • URLの例 : http:// <IM_REST_API_HOST> /okcs/resources/{TENANTID}/content/draft/{CONTENTID}/{CONTENTTEXTID}/{FILENAME_WITH_EXTENSION}?login={USER_NAME}. ユーザー名を渡さない場合は、'guest'ユーザーにデフォルト設定されます。
  • schemaAttributes

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

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

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

  • userGroups

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

  • コンテンツ・オブジェクトのバージョン

  • 特定のロケールでのドキュメントの特定のバージョンの一意の識別子。 このフィールドは、q問合せパラメータを使用して作成された問合せでは使用できません。

  • views

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

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

  • WorkflowStepKey
    タイトル: WorkflowStepKey
  • コンテンツ・オブジェクトのxml
ネストされたスキーマ : allTranslations
タイプ: array

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

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

ソースを表示
ネストされたスキーマ : ArticleStatusKey
タイプ: object
タイトル: ArticleStatusKey
ソースを表示
ネストされたスキーマ : LocaleKey
タイプ: object
タイトル: LocaleKey
ソースを表示
ネストされたスキーマ : カテゴリ
タイプ: array

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

たとえば 世界がレベル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

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

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

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

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

  • links

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

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

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

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

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

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

ネストされたスキーマ : ContentKey
タイプ: object
タイトル: ContentKey
ソースを表示
ネストされたスキーマ : リンク
タイプ: array
ソースを表示
  • instanceLink
ネストされたスキーマ : DataForm
タイプ: object
タイトル: DataForm
ソースを表示
ネストされたスキーマ : AggregateFormResults
タイプ: object
タイトル: AggregateFormResults
ソースを表示
ネストされたスキーマ : replacementTokens
タイプ: array

短く、管理しやすい用語(tokenName)を作成するオブジェクト。 これらのトークンは、標準化および翻訳可能であり、場合によっては複雑なコンテンツ(統合テキスト、イメージ、リスト、表など)を表します。

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

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

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

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

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

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

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

ソースを表示
ネストされたスキーマ : WorkflowStepKey
タイプ: object
タイトル: WorkflowStepKey
ソースを表示
ネストされたスキーマ : CategoryKey
タイプ: object
タイトル: CategoryKey
ソースを表示

  • このフィールドには、カテゴリの直下の子の数が返されます。

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

    このパラメータのURIの例は次のとおりです:

    • http://<IM_REST_API_HOST>/km/api/categories/{id}?childrenCount=true&mode=KEY
    • http://<IM_REST_API_HOST>/km/api/categories?childrenCount=true&mode=KEY
    • http://<IM_REST_API_HOST>/km/api/categories?q=contentTypeRefKey eq 'FAQ'&childrenCount=true&mode=KEY
  • カテゴリ・オブジェクトの説明

  • リポジトリ・データを外部システムと統合する際に使用される一意の識別子。

  • リポジトリ・データを外部システムと統合する際に使用されるカテゴリのタイプ。 有効なオプションは、PRODUCTおよびCATEGORYです。

  • 特定の製品の在庫組織ID。

  • links

  • カテゴリの名前。

  • カテゴリの階層位置
  • parents

    このフィールドは、カテゴリのすべての親を返します。

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

    このパラメータのURIの例は次のとおりです:

    • http://<IM_REST_API_HOST>/km/api/categories/{id}?withParents=true&mode=KEY
    • http://<IM_REST_API_HOST>/km/api/categories?withParents=true&mode=KEY
    • http://<IM_REST_API_HOST>/km/api/categories?q=contentTypeRefKey eq 'FAQ'&withParents=true&mode=KEY
    • http://<IM_REST_API_HOST>/km/api/categories/{id}?childrenCount=true&withParents=true&mode=KEY

  • カテゴリ・オブジェクトの一意のレコードID。

  • カテゴリ・オブジェクトの参照キー。 カテゴリ・オブジェクトは複数の言語をサポートしています。 このフィールドを使用して、すべての言語の関連オブジェクトを識別できます。

  • これは、翻訳された名前が見つからない場合に名前がデフォルト・ロケールに変換される場合に移入されるカスタム・フィールドです。

ネストされたスキーマ : 両親
タイプ: array

このフィールドは、カテゴリのすべての親を返します。

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

このパラメータのURIの例は次のとおりです:

  • http://<IM_REST_API_HOST>/km/api/categories/{id}?withParents=true&mode=KEY
  • http://<IM_REST_API_HOST>/km/api/categories?withParents=true&mode=KEY
  • http://<IM_REST_API_HOST>/km/api/categories?q=contentTypeRefKey eq 'FAQ'&withParents=true&mode=KEY
  • http://<IM_REST_API_HOST>/km/api/categories/{id}?childrenCount=true&withParents=true&mode=KEY
ソースを表示
ネストされたスキーマ : 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
ソースを表示
ネストされたスキーマ : ReplacementToken
タイプ: object
タイトル: ReplacementToken
ソースを表示
トップに戻る

例

次の例は、指定されたバージョンIDを持つドキュメントを検索する方法を示しています。

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

レスポンス本文の例

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

{
  "isForEdit": false,
  "categories": [],
  "userGroups": [],
  "views": [
    {
      "recordId": "51FADC735E2344B1B183D965060B248C",
      "referenceKey": "TENANT",
      "name": "NAME_VALUE",
      "links": [
        {
          "rel": "canonical",
          "href": "https://IM_REST_API_HOST/km/api/latest/views/51FADC735E2344B1B183D965060B248C",
          "mediaType": "application/json, application/xml",
          "method": "GET"
        }
      ]
    }
  ],
  "recordId": "04008709a06d9d015aaa70657e007fd7",
  "versionId": "04008709a06d9d015aaa70657e007fd6",
  "documentId": "FAQ216",
  "title": "3D touch not working",
  "version": "1.0",
  "answerId": 1000336,
  "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-09T02:40:46-0700",
  "links": [
    {
      "rel": "canonical",
      "href": "https://IM_REST_API_HOST/km/api/latest/content/04008709a06d9d015aaa70657e007fd7",
      "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"
    }
  ],
  "contentType": {
    "recordId": "33B9C302D8264371B6A12EDAF3FD974B",
    "referenceKey": "FAQ",
    "name": "FAQ",
    "links": [
      {
        "rel": "canonical",
        "href": "https://IM_REST_API_HOST/km/api/latest/contentTypes/33B9C302D8264371B6A12EDAF3FD974B",
        "mediaType": "application/json, application/xml",
        "method": "GET"
      }
    ]
  },
  "priority": "PRIORITY_0",
  "createDate": "2017-03-08T03:03:18-0700",
  "dateAdded": "2017-03-08T03:03:18-0700",
  "displayStartDate": "2017-03-08T03:02:37-0700",
  "displayEndDate": "9999-12-31T00:00:00-0700",
  "owner": {
    "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"
      }
    ]
  },
  "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": "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"
      }
    ]
  },
  "published": false,
  "checkedOut": false,
  "xml": "XML_VALUE",
  "resourcePath": "http://IM_REST_API_HOST/content/draft/04008709a06d9d015aaa70657e007fd7/04008709a06d9d015aaa70657e007fd6/"
}
「トップに戻る」