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

子カテゴリの取得

get

/km/api/v1/categories/{id}/children

このメソッドは、指定されたカテゴリの直接の子カテゴリのリストを返します。

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

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

このリソースでは、withParentsリクエスト・パラメータもサポートされます。

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

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

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

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

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

返されるカテゴリ・オブジェクトに含まれる親のリストを取得するURIの例を次に示します:

  • http://<IM_REST_API_HOST>/km/api/latest/categories/{id}/children?withParents=true

リクエスト

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

レスポンス

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

200 レスポンス

「OK」をクリックします。
本文( )
ルート・スキーマ : ResultList CategoryKey
タイプ: object
タイトル: ResultList CategoryKey
ソースを表示
ネストされたスキーマ : アイテム
タイプ: array
ソースを表示
ネストされたスキーマ : 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 -X "GET" "http://IM_REST_API_HOST/km/api/latest/categories/{id}/children"

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

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

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

レスポンス本文の例

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

{
    "items": [
        {
            "recordId": "8D6CD9BD918A4E9D8EF6302B9A2B4FD6",
            "referenceKey": "FUSION_PRODUCT_300100191655503",
            "objectId": "027.048.001.002.001.001",
            "name": "Brown_Bread42520200720_032427",
            "externalId": 300100191655503,
            "externalType": "PRODUCT",
            "description": "Brown_Bread42520200720_032427",
            "links": [
                {
                    "rel": "parent",
                    "href": "<IM_REST_API_HOST>/km/api/v1/categories/E73CC63CE99547348CA06AEA43E164E0",
                    "mediaType": "application/json, application/xml",
                    "method": "GET"
                },
                {
                    "rel": "canonical",
                    "href": "<IM_REST_API_HOST>/km/api/v1/categories/8D6CD9BD918A4E9D8EF6302B9A2B4FD6",
                    "mediaType": "application/json, application/xml",
                    "method": "GET"
                },
                {
                    "rel": "collection",
                    "href": "<IM_REST_API_HOST>/km/api/v1/categories",
                    "mediaType": "application/json, application/xml",
                    "method": "GET",
                    "profile": "<IM_REST_API_HOST>/km/api/v1/metadata-catalog/categories"
                }
            ]
        }
    ],
    "hasMore": false,
    "limit": 20,
    "offset": 0,
    "links": [
        {
            "rel": "canonical",
            "href": "<IM_REST_API_HOST>/km/api/v1/categories/E73CC63CE99547348CA06AEA43E164E0/children?limit=20&offset=0",
            "mediaType": "application/json, application/xml",
            "method": "GET"
        }
    ],
    "count": 1
}
「トップに戻る」