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

ビューに割り当てられたすべてのカテゴリの取得

get

/km/api/v1/repositories/default/categoriesAssignedToView

このメソッドは、デフォルトのリポジトリ・オブジェクトに関連付けられたカテゴリ・オブジェクトのリストを返します

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

スキーマ内の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/repositories/default/categoriesAssignedToView

    このリクエストは、デフォルトのリポジトリ・オブジェクトに関連付けられているカテゴリ・オブジェクトのリストを、参照キーでソートして昇順で返します。

  • http://<IM_REST_API_HOST>/km/api/latest/repositories/default/categoriesAssignedToView?orderBy=referenceKey:desc

    このリクエストは、デフォルトのリポジトリ・オブジェクトに関連付けられているカテゴリ・オブジェクトのリストを、参照キーでソートして降順に返します。

リクエスト

パス・パラメータ
  • リポジトリ・オブジェクトの一意の識別子
トップに戻る

レスポンス

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

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を使用してRESTリソースに対する取得リクエストを発行することによって、デフォルトのリポジトリ・オブジェクトに関連付けられたカテゴリ・オブジェクトのリストを検索する方法を示しています。

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

レスポンス本文の例

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

{
    "items": [
        {
            "recordId": "7CD781EF6EBA4C4387BCA39869637F67",
            "referenceKey": "FUSION_CATEGORY_300100090490681",
            "objectId": "021",
            "name": "NAME_VALUE1",
            "externalId": 300100090490681,
            "externalType": "CATEGORY",
            "description": "479035114395544",
            "links": [
                {
                    "rel": "canonical",
                    "href": "http://IM_REST_API_HOST/km/api/latest/categories/7CD781EF6EBA4C4387BCA39869637F67",
                    "mediaType": "application/json, application/xml",
                    "method": "GET"
                },
                {
                    "rel": "collection",
                    "href": "http://IM_REST_API_HOST/km/api/latest/categories",
                    "mediaType": "application/json, application/xml",
                    "method": "GET",
                    "profile": "http://IM_REST_API_HOST/km/api/latest/metadata-catalog/categories"
                }
            ]
        },
        {
            "recordId": "A3D96BA9F16F44BC97E0359C615E2966",
            "referenceKey": "FUSION_CATEGORY_300100090490682",
            "objectId": "022",
            "name": "NAME_VALUE2",
            "externalId": 300100090490682,
            "externalType": "CATEGORY",
            "description": "479036550047561",
            "links": [
                {
                    "rel": "canonical",
                    "href": "http://IM_REST_API_HOST/km/api/latest/categories/A3D96BA9F16F44BC97E0359C615E2966",
                    "mediaType": "application/json, application/xml",
                    "method": "GET"
                },
                {
                    "rel": "collection",
                    "href": "http://IM_REST_API_HOST/km/api/latest/categories",
                    "mediaType": "application/json, application/xml",
                    "method": "GET",
                    "profile": "http://IM_REST_API_HOST/km/api/latest/metadata-catalog/categories"
                }
            ]
        }
    ],
    "hasMore": true,
    "limit": 20,
    "offset": 0,
    "links": [
        {
            "rel": "canonical",
            "href": "http://IM_REST_API_HOST/km/api/latest/repositories/default/categoriesAssignedToView?limit=20&offset=0",
            "mediaType": "application/json, application/xml",
            "method": "GET"
        },
        {
            "rel": "next",
            "href": "http://IM_REST_API_HOST/km/api/latest/repositories/default/categoriesAssignedToView?limit=20&offset=20",
            "mediaType": "application/json, application/xml",
            "method": "GET"
        }
    ],
    "count": 2
}
「トップに戻る」