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

すべてのコンテンツ・タイプの取得

get

/km/api/v1/contentTypes

このメソッドは、Oracle KnowledgeリポジトリからContentTypeオブジェクトのリストを返します。

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

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

リソースのスキーマおよびカタログを取得するURIの例を次に示します:

  • http://<IM_REST_API_HOST>/km/api/latest/metadata-catalog/contentTypes

URIの例

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

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

    リクエストは、DATAモードでContentTypeオブジェクトのページ区切りリストを返します。 デフォルトでは、ContentTypeオブジェクトはreferenceKey値に従って昇順にソートされます。

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

    このリクエストは、KEYモードでContentTypeオブジェクトのページ区切りリストを返します。

  • http://<IM_REST_API_HOST>/km/api/contentTypes?orderBy=name:asc

    リクエストは、DATAモードでContentTypeオブジェクトのページ区切りリストを返します。 リスト内のオブジェクトは、ContentTypeオブジェクトの名前に従ってソートされます。


問合せで検索

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


このメソッドは、指定された基準に一致するContentTypeオブジェクトのリストを返します。

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

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

リソースのスキーマおよびカタログを取得するURIの例を次に示します:

  • http://<IM_REST_API_HOST>/km/api/latest/metadata-catalog/contentTypes

URIの例

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

  • http://<IM_REST_API_HOST>/km/api/contentTypes?q=referenceKey eq 'FAQ'

    リクエストによって、ContentTypeオブジェクトのページ区切りリストがDATAモードで返され、参照キー値としてFAQが指定されます。

  • http://<IM_REST_API_HOST>/km/api/contentTypes?q=translationRequestLocales.id in ('en_US', 'es_ES', 'iT_IT')&mode=FULL

    リクエストはContentTypeオブジェクトのページ区切りリストを返します。このリストは、コンテンツ・オーサリング中に自動翻訳リクエストを生成するように構成されています。 リクエストは、次のような指定した言語に対して生成されます: 英語の米国、スペイン語(半島)、イタリア語。

  • NOTE : 条件オブジェクトは、即時利用可能なContentTypeオブジェクトのカテゴリ関連問合せのみをサポートします。 ユーザー定義ContentTypeオブジェクトは問合せによって返されません。

レスポンス・エラー

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

  • OKDOM-CRIT0025

    このエラーは、リクエストに無効な基準フィールドが指定されている場合に発生します。

問合せパラメータ

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

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

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

referenceKeyYY'type' : 'string'

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

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

nameNY'type' : 'string'

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

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

説明YY'type' : 'string'

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

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

stripeCdYY'type' : 'string'

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

allowCheckOutYY'type' : 'boolean'

このフラグは、ContentTypeオブジェクトでコンテンツのチェックアウトが許可されているかどうかを示し、他の作成者が同じコンテンツを編集できないようにします。

allowRecommendationsYY'type' : 'boolean'

このフラグは、エンド・ユーザーがコンテンツに対して推奨を作成できるコンテンツ・タイプを示します。 また、推奨コンテンツをコンテンツ・タイプに関連付けることができるかどうかも示します。

counterPrefixYY'type' : 'string'

コンテンツ・タイプのすべてのドキュメントIDで使用されるプレフィクス。 たとえば、FAはコンテンツ・タイプFAQのcontentPrefixです。 コンテンツ・タイプFAQのすべてのドキュメントIDは、アフィクスFAで始まります。

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

コンテンツ・タイプが作成された日付。

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

コンテンツ・タイプが最後に変更された日付。

defaultLifespanYY'type' : 'integer'

エンド・ユーザーがコンテンツを使用できる合計日数。 コンテンツが作成された日から開始して、指定した日数だけエンド・ユーザーがコンテンツを使用できることを示します。

enableUserActivityLoggingYY'type' : 'boolean'

このフラグは、コンテンツとのユーザー・インタラクションをシステムで追跡するかどうかを示します。

hasPriorityYY'type' : 'boolean'

このフラグは、コンテンツ・タイプのコンテンツに優先度レベルを割り当てることができるかどうかを示します。 有効な優先度値は、1から20までの数値であり、なしです。

hasRelatedContentYY'type' : 'boolean'

このフラグは、コンテンツ・タイプでコンテンツ・オーサリング中に関連ドキュメントを指定できるかどうかを示します。

hasTalkBackYY'type' : 'boolean'

このフラグは、コンテンツ・タイプのコンテンツに対してディスカッションをオープンできるかどうかを示します。

isEventYY'type' : 'boolean'

このフラグは、コンテンツ・タイプで異なるイベント日がサポートされるかどうかを示します。

isModeratedYY'type' : 'boolean'

このフラグは、ディスカッションが公開される前に、開いているディスカッションに対してコンテンツがモデレーションを必要とするかどうかを示します。

notifyOnWorkflowApprovalYY'type' : 'boolean'

このフラグは、ワークフロー承認ステップが完了したときに適切なコンテンツ作成者に通知する必要があるかどうかを示します。

notifyOnWorkflowRejectionYY'type' : 'boolean'

このフラグは、ドキュメントが拒否されたときに適切なコンテンツ作成者に通知する必要があるかどうかを示します。

notifyGroupOnWorkflowRejectionYY'type' : 'boolean'

このフラグは、文書が否認されたときに、通知をコンテンツ作成者に送信するかどうかを示します。

removeVersionsYY'type' : 'boolean'

このフラグは、公開後にコンテンツのマイナー・バージョンを削除するかどうかを示します。

reviewDateYY'type' : 'integer'

記入票で確認が必要な日付。

日付が近づくと、適切な作成者がコンテンツを確認するためのタスクが生成されます。

extendReviewDateYY'type' : 'boolean'

このフラグは、コンテンツ・タイプのコンテンツのレビュー後にレビュー日を延長する必要があるかどうかを示します。

validateHtmlYY'type' : 'boolean'

このフラグは、コンテンツ・オーサリング中にHTML標準に準拠するようにコンテンツを検証する必要があるかどうかを示します。

enableIndexingYY'type' : 'boolean'

このフラグは、Oracle Knowledge Searchの索引付けがコンテンツ・タイプに対して有効かどうかを示します。

indexStatusYY'enum' : ['LIVE', 'LATEST_VALID_DRAFT', 'LIVE_AND_LATEST_VALID_DRAFT', 'NONE']

Oracle Knowledge Search索引付けがあるために割り当てられた文書のステータス。

有効な値は次のとおりです。

  • LIVE
  • LATEST_VALID_DRAFT
  • LIVE_AND_LATEST_VALID_DRAFT
  • NONE
評価YN'$ref' : '#/definitions/RatingKey'

コンテンツ・タイプに割り当てられた評価システム。

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

コンテンツ・タイプに関連付けられたUserGroupオブジェクト。 コンテンツ作成者は、特定のレベルのアクセス権を持つユーザーがコンテンツにアクセスできるように、ユーザー・グループをコンテンツに割り当てます。

customMetricsYN'$ref' : '#/definitions/ListCustomMetricKey'

コンテンツ・タイプのコンテンツに対するアクティビティの追跡に使用される測定単位。

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

コンテンツ・タイプのすべてのコンテンツに必要なカテゴリ・オブジェクト。 コンテンツ作成者は、コンテンツ作成中にこれらのカテゴリをコンテンツに割り当てる必要があります。 作成者は、カテゴリを割り当てない場合、コンテンツを保存できません。

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

コンテンツ・タイプで構成されたカテゴリ・オブジェクトのリストで、コンテンツ作成者がコンテンツに割り当てることができます。 カテゴリ・オブジェクトは、検索性を向上させるためにコンテンツにタグ付けまたはラベルを付けるために使用されます。

translationRequestLocalesYN'$ref' : '#/definitions/ListLocaleKey'

コンテンツ・タイプで自動翻訳リクエストが有効になっているロケール・オブジェクトのリスト。 コンテンツ・タイプは、コンテンツを公開する準備ができるたびに、特定の言語セットのコンテンツ翻訳者に翻訳リクエストを送信します。

ワークフローYN'$ref' : '#/definitions/WorkflowKey'

コンテンツ・タイプでのコンテンツ・オーサリング中に作成者が使用できるワークフロー定義。

リクエスト

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

レスポンス

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

200 レスポンス

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

  • このフラグは、ContentTypeオブジェクトでコンテンツのチェックアウトが許可されているかどうかを示し、他の作成者が同じコンテンツを編集できないようにします。

  • このフラグは、エンド・ユーザーがコンテンツに対して推奨を作成できるコンテンツ・タイプを示します。 また、推奨コンテンツをコンテンツ・タイプに関連付けることができるかどうかも示します。

  • ワークフローが有効な場合、カテゴリにはワークフロー承認が必要です @since 8.3

  • コンテンツ・タイプのすべてのドキュメントIDで使用されるプレフィクス。 たとえば、FAはコンテンツ・タイプFAQのcontentPrefixです。 コンテンツ・タイプFAQのすべてのドキュメントIDは、アフィクスFAで始まります。

  • コンテンツ・タイプが作成された日付。

  • コンテンツ・タイプが最後に変更された日付。

  • エンド・ユーザーがコンテンツを使用できる合計日数。 コンテンツが作成された日から開始して、指定した日数だけエンド・ユーザーがコンテンツを使用できることを示します。

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

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

  • ワークフローが有効な場合、日付の表示にはワークフローの承認が必要です @since 8.3

  • このフラグは、Oracle Knowledge Searchの索引付けがコンテンツ・タイプに対して有効かどうかを示します。

  • このフラグは、コンテンツとのユーザー・インタラクションをシステムで追跡するかどうかを示します。

  • ワークフローが有効な場合、イベント日にはワークフロー承認が必要です @since 8.3

  • このフラグは、コンテンツ・タイプのコンテンツのレビュー後にレビュー日を延長する必要があるかどうかを示します。

  • このフラグは、コンテンツ・タイプのコンテンツに優先度レベルを割り当てることができるかどうかを示します。 有効な優先度値は、1から20までの数値であり、なしです。

  • このフラグは、コンテンツ・タイプでコンテンツ・オーサリング中に関連ドキュメントを指定できるかどうかを示します。

  • このフラグは、コンテンツ・タイプのコンテンツに対してディスカッションをオープンできるかどうかを示します。

  • 許可された値: [ "LIVE", "LATEST_VALID_DRAFT", "LIVE_AND_LATEST_VALID_DRAFT", "NONE" ]

    Oracle Knowledge Search索引付けがあるために割り当てられた文書のステータス。

    有効な値は次のとおりです。

    • LIVE
    • LATEST_VALID_DRAFT
    • LIVE_AND_LATEST_VALID_DRAFT
    • NONE

  • このフラグは、コンテンツ・タイプで異なるイベント日がサポートされるかどうかを示します。

  • このフラグは、ディスカッションが公開される前に、開いているディスカッションに対してコンテンツがモデレーションを必要とするかどうかを示します。

  • links

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

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

  • このフラグは、文書が否認されたときに、通知をコンテンツ作成者に送信するかどうかを示します。

  • このフラグは、ワークフロー承認ステップが完了したときに適切なコンテンツ作成者に通知する必要があるかどうかを示します。

  • このフラグは、ドキュメントが拒否されたときに適切なコンテンツ作成者に通知する必要があるかどうかを示します。

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

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

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

  • このフラグは、公開後にコンテンツのマイナー・バージョンを削除するかどうかを示します。

  • 作成者は、必須とマークされたカテゴリに加えて、少なくとも1つのカテゴリを選択する必要があります @since 8.3
  • 作成者は、必須とマークされた製品に加えて少なくとも1つの製品を選択する必要があります @since 8.3
  • 少なくとも1つのユーザー・グループを選択する必要があります @since 8.3
  • ワークフロー・ステップ@since 8.3を実行できるユーザーにコンテンツ編集を制限
  • ユーザー・グループ選択を1つのグループのみに制限 @since 8.3

  • 記入票で確認が必要な日付。

    日付が近づくと、適切な作成者がコンテンツを確認するためのタスクが生成されます。

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

  • ワークフローが有効な場合、ユーザー・グループにはワークフロー承認が必要です @since 8.3

  • このフラグは、コンテンツ・オーサリング中にHTML標準に準拠するようにコンテンツを検証する必要があるかどうかを示します。

  • ワークフローが有効な場合、ビューにはワークフロー承認が必要です @since 8.3
トップに戻る

例

次の例は、cURLを使用してRESTリソースに対する取得リクエストを発行することによって、Oracle Knowledgeリポジトリからすべてのコンテンツ・タイプ・オブジェクトを検索する方法を示しています。

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

レスポンス本文の例

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

{
  "items": [
    {
      "allowCheckOut": false,
      "allowRecommendations": false,
      "counterPrefix": "SOL",
      "dateAdded": "2016-09-16T12:55:09-0600",
      "dateModified": "2017-01-07T00:06:31-0700",
      "defaultLifespan": -1,
      "enableUserActivityLogging": false,
      "hasPriority": false,
      "hasRelatedContent": false,
      "hasTalkBack": false,
      "isEvent": false,
      "isModerated": false,
      "requireAtLeastOneCategory": false,
      "requireAtLeastOneUserGroup": false,
      "restrictToOneUserGroupSelection": false,
      "categoriesRequireWorkflowApproval": true,
      "userGroupRequireWorkflowApproval": true,
      "viewsRequireWorkflowApproval": true,
      "displayDatesRequireWorkflowApproval": true,
      "eventDatesRequireWorkflowApproval": true,
      "restrictAuthoringToWorkflowUser": true,
      "notifyOnWorkflowApproval": false,
      "notifyOnWorkflowRejection": false,
      "notifyGroupOnWorkflowRejection": false,
      "removeVersions": false,
      "reviewDate": -1,
      "validateHtml": false,
      "enableIndexing": true,
      "indexStatus": "LIVE",
      "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"
        },
        {
          "rel": "collection",
          "href": "https://IM_REST_API_HOST/km/api/latest/contentTypes",
          "mediaType": "application/json, application/xml",
          "method": "GET",
          "profile": "https://IM_REST_API_HOST/km/api/latest/metadata-catalog/contentTypes"
        }
      ]
    }
  ],
  "hasMore": false,
  "limit": 20,
  "offset": 0,
  "links": [
    {
      "rel": "canonical",
      "href": "https://IM_REST_API_HOST/km/api/latest/contentTypes?limit=20&offset=0",
      "mediaType": "application/json, application/xml",
      "method": "GET"
    }
  ],
  "count": 1
}
「トップに戻る」