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

すべてのカテゴリの取得

get

/km/api/v1/categories

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

このリソースは、orderByリクエスト・パラメータをサポートしています。 このパラメータをHTTPサービス・リクエストとともに使用して、返されたリストをソートできます。

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

カテゴリおよび製品表示フィルタ

製品およびカテゴリの表示は、リクエストを行うユーザーのタイプと、リクエストに関連付けられたビューによって異なります。

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

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

URIの例

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

  • http://<IM_REST_API_HOST>/km/api/latest/categories

    このリクエストは、Oracle Knowledgeリポジトリ内のカテゴリ・オブジェクトのリストを返します。

  • http://<IM_REST_API_HOST>/km/api/latest/categories?orderBy=name
    •

    このリクエストは、Oracle Knowledgeリポジトリ内のカテゴリ・オブジェクトのリストを名前でソートして返します。

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

    このリクエストは、Oracle Knowledgeリポジトリのカテゴリ・オブジェクトのリストをKEYモードで返します。


問合せで検索

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


このメソッドは、指定された条件に一致するカテゴリ・オブジェクトのリストを返します。

orderByパラメータで使用できる追加の値については、リソースのスキーマおよびカタログを取得する必要があります。 リソースのスキーマおよびカタログを取得するには、HTTPリクエストでmediaType値を'application/schema json'としてGETメソッドを使用する必要があります。

withParentsリクエスト・パラメータがtrueに設定されている場合、指定された基準に一致する返されたカテゴリごとに、そのカテゴリの親カテゴリが含まれ、ルート・カテゴリから返された各カテゴリの直下の親の順に並べられます。

カテゴリおよび製品表示フィルタ

製品およびカテゴリの表示は、リクエストを行うユーザーのタイプ、リクエストに関連付けられたコンテンツ・タイプおよびビュー、およびtopLevelOnlyパラメータの値によって異なります。 コンテンツ・タイプ、インタフェースIDおよびtopLevelOnlyリクエスト・パラメータはすべてオプションです。

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

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

URIの例

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

  • http://<IM_REST_API_HOST>/km/api/latest/categories?q=sortOrder gt 3

    このリクエストは、sortOrderパラメータ値が3より大きい数値であるCategoryオブジェクトのリストを返します。

  • http://<IM_REST_API_HOST>/km/api/latest/categories?q=recordId eq '{id}'

    リクエストは、リクエストで指定されたレコードIDを持つCategoryオブジェクトを返します。

  • http://<IM_REST_API_HOST>/km/api/latest/categories?withParents=true&q=recordId eq '{id}'

    リクエストは、リクエストで指定されたレコードIDを持つCategoryオブジェクトを返します。 表示フィルタ・ルールに一致する親カテゴリのリストが、返されるカテゴリ・オブジェクトに含まれます。

  • http://<IM_REST_API_HOST>/km/api/latest/categories?q=parent.refKey eq 'SEARCH'

    このリクエストは、親参照キー値がSEARCHであるカテゴリ・オブジェクトのリストを返します。

  • http://<IM_REST_API_HOST>/km/api/latest/categories?q=contentTypeRefKey eq 'FAQ'

    このリクエストは、チャネルFAQに関連付けられているカテゴリ・オブジェクトのリストを返します。 NOTE : 即時利用可能なコンテンツ・タイプのみがサポートされています。 ユーザー定義のコンテンツ・タイプは結果を返しません。

  • http://<IM_REST_API_HOST>/km/api/latest/categories?q=contentTypeRefKey in ('FAQ','SOLUTION')

    このリクエストは、チャネルFAQまたはソリューションに関連付けられているカテゴリ・オブジェクトのリストを返します。 NOTE : 即時利用可能なコンテンツ・タイプのみがサポートされています。 ユーザー定義のコンテンツ・タイプは結果を返しません。

  • http://<IM_REST_API_HOST>/km/api/latest/categories?q=parent.refKey eq 'SEARCH' and dateAdded gt '2015-02-01'

    このリクエストは、親参照キー値がSEARCHであるカテゴリ・オブジェクトのリストを返し、2015年2月1日より後に作成されます。

  • http://<IM_REST_API_HOST>/km/api/latest/categories?q=topLevelOnly eq true

    このリクエストは、最上位レベルのカテゴリ・オブジェクト(つまり、オブジェクトに親がない)のリストを返します。

  • http://<IM_REST_API_HOST>/km/api/latest/categories?q=topLevelOnly eq true and externalType eq 'CATEGORY'

    このリクエストは、外部タイプがCATEGORYのトップレベル・カテゴリ・オブジェクトのリストを返します。

  • http://<IM_REST_API_HOST>/km/api/latest/categories?q=topLevelOnly eq true and externalType eq 'PRODUCT'

    このリクエストは、外部タイプがPRODUCTのトップレベル・カテゴリ・オブジェクトのリストを返します。

レスポンス・エラー

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

  • OKDOM-CRIT0025

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

問合せパラメータ

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

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

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

referenceKeyYY'type' : 'string'

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

nameYY'type' : 'string'

カテゴリの名前。

externalIdYY'type' : 'integer'

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

externalTypeYY'type' : 'string'

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

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

カテゴリ・オブジェクトが作成または追加された日付。

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

カテゴリ・オブジェクトが最後に変更された日付。

カテゴリは、次のいずれかの状況で変更されるとみなされます:

  • カテゴリが作成されます。 新しいカテゴリが追加される親カテゴリも変更済とみなされます。
  • カテゴリの名前は、どのロケールでも変更されます。
  • 子カテゴリが削除されます。
  • カテゴリが移動されます。 移動されたカテゴリには新しい親があるため、以前の親カテゴリと新しい親カテゴリも変更済とみなされます。
  • カテゴリのソート順が変更されます。 兄弟カテゴリのソート順も変更されるため、これらのカテゴリも変更済とみなされます。

sortOrderYY'type' : 'integer'

オブジェクトのリストにおけるカテゴリ・オブジェクトの割当位置。

topLevelOnlyYN'type' : 'boolean'トップ・レベル・カテゴリのみを返すフラグ。
contentTypeRefKeyYN'type' : 'string'このパラメータは、ContentType refKeyでカテゴリをフィルタします。
contentTypeIdYN'type' : 'string'このパラメータは、ContentType recordidによってカテゴリをフィルタします。
requiredYN'type' : 'boolean'このパラメータは、ContentTypeで必須またはオプションである場合にカテゴリをフィルタします。
子供YN'$ref' : '#/definitions/ListCategoryKey'

特定のカテゴリの子またはサブカテゴリ。

親YN'$ref' : '#/definitions/CategoryKey'

特定のカテゴリの親カテゴリ。

リクエスト

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

レスポンス

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

200 レスポンス

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

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

    このフィールドは、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
ソースを表示
ネストされたスキーマ : 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
ソースを表示
トップに戻る

例

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

curl -X "GET" "http://IM_REST_API_HOST/km/api/latest/categories"

リクエスト・ヘッダーの例

次に、リクエスト・ヘッダーの例を示します。

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

レスポンス本文の例

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

{
    "items": [
        {
            "recordId": "58921ED6778448CA8DF3D1C77336C332",
            "referenceKey": "FUSION_CATEGORY_300100163778925",
            "objectId": "029",
            "name": "BIQA_KM_TOP",
            "externalId": 300100163778925,
            "externalType": "CATEGORY",
            "description": "BIQA_KM_TOP",
            "links": [
                {
                    "rel": "children",
                    "href": "https://<IM_REST_API_HOST>/km/api/v1/categories/58921ED6778448CA8DF3D1C77336C332/children",
                    "mediaType": "application/json, application/xml",
                    "method": "GET"
                },
                {
                    "rel": "canonical",
                    "href": "https://<IM_REST_API_HOST>/km/api/v1/categories/58921ED6778448CA8DF3D1C77336C332",
                    "mediaType": "application/json, application/xml",
                    "method": "GET"
                },
                {
                    "rel": "collection",
                    "href": "https://<IM_REST_API_HOST>/km/api/v1/categories",
                    "mediaType": "application/json, application/xml",
                    "method": "GET",
                    "profile": "https://<IM_REST_API_HOST>/km/api/v1/metadata-catalog/categories"
                }
            ],
            "dateAdded": "2018-06-06T06:32:22+0000",
            "dateModified": "2018-06-06T06:32:23+0000",
            "sortOrder": 26,
            "hasChildren": true
        }
    ],
    "hasMore": true,
    "limit": 20,
    "offset": 0,
    "links": [
        {
            "rel": "canonical",
            "href": "https://<IM_REST_API_HOST>/km/api/v1/categories?limit=20&offset=0",
            "mediaType": "application/json, application/xml",
            "method": "GET"
        },
        {
            "rel": "next",
            "href": "https://<IM_REST_API_HOST>/km/api/v1/categories?limit=20&offset=20",
            "mediaType": "application/json, application/xml",
            "method": "GET"
        }
    ],
    "count": 1
}
「トップに戻る」