Oracle Fusionサービスでのナレッジ管理のREST API

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

get

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

このメソッドは、指定されたIDパラメータを持つビュー・オブジェクトに関連付けられたカテゴリ・オブジェクトのリストを返します。

このリソースは、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/views/{id}/categories
このメソッドは、指定されたIDパラメータを持つビュー・オブジェクトに関連付けられているカテゴリ・オブジェクトのリストを参照キーでソートして昇順で返します。
http://<IM_REST_API_HOST>/km/api/latest/views/{id}/categories?orderBy=referenceKey:desc
このメソッドは、指定されたIDパラメータを持つビュー・オブジェクトに関連付けられているカテゴリ・オブジェクトのリストを、参照キーによって降順にソートして返します。

リクエスト

パス・パラメータ

id: string

ビュー・オブジェクトの一意の識別子

トップに戻る

レスポンス

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

application/json
application/xml

200 レスポンス

「OK」をクリックします。

ルート・スキーマ : ResultList CategoryKey

タイプ: object

タイトル: ResultList CategoryKey

ソースを表示

count(optional): integer

現在の範囲で返されたリソース・インスタンスの数。
hasMore(optional): boolean

サーバーで使用可能なリソースが現在のページで返されたサブセットよりも多い場合にtrueに設定されるブール値。
items(optional): array items
limit(optional): integer

サーバーが使用する実際のページング・サイズ。
links(optional): array links
offset(optional): integer

現在のページで使用される相殺値。
totalResults(optional): integer

現在の範囲内のインスタンスと、リクエストを満たすサーバー上のインスタンスの両方を含む、リソース・インスタンスの合計数。

{
    "title":"ResultList CategoryKey",
    "properties":{
        "hasMore":{
            "description":"Boolean value that is set to true if more resources are available on the server than the subset returned in current page.",
            "type":"boolean"
        },
        "limit":{
            "description":"Actual paging size used by the server.",
            "type":"integer"
        },
        "count":{
            "description":"Number of resource instances returned in the current range.",
            "type":"integer"
        },
        "totalResults":{
            "description":"Total count of the resource instances, including both the instances in the current range and the instances on the server that satisfy the request.",
            "type":"integer"
        },
        "items":{
            "items":{
                "$ref":"#/definitions/CategoryKey"
            },
            "type":"array"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/instanceLink"
            },
            "type":"array"
        },
        "offset":{
            "description":"Offset value used in the current page. ",
            "type":"integer"
        }
    },
    "type":"object"
}

ネストされたスキーマ : アイテム

タイプ: array

ソースを表示

Array of: object CategoryKey

タイトル: CategoryKey

{
    "items":{
        "$ref":"#/definitions/CategoryKey"
    },
    "type":"array"
}

ネストされたスキーマ : リンク

タイプ: array

ソースを表示

Array of: object instanceLink

JSONインスタンス表現に表示される可能性があるリンク記述オブジェクトを記述するMetadata。

{
    "items":{
        "$ref":"#/definitions/instanceLink"
    },
    "type":"array"
}

ネストされたスキーマ : CategoryKey

タイプ: object

タイトル: CategoryKey

ソースを表示

childrenCount(optional): integer
このフィールドには、カテゴリの直下の子の数が返されます。

このフィールドは、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
description(optional): string

カテゴリ・オブジェクトの説明
externalId(optional): integer

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

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

特定の製品の在庫組織ID。
links(optional): array links
name(optional): string

カテゴリの名前。
objectId(optional): string

カテゴリの階層位置
parents(optional): array 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
recordId(optional): string

カテゴリ・オブジェクトの一意のレコードID。
referenceKey(optional): string

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

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

{
    "title":"CategoryKey",
    "properties":{
        "recordId":{
            "description":"<p>The unique record ID of the Category object.</p>",
            "type":"string"
        },
        "responseLocale":{
            "description":"<p>This is a custom field that will get populated if a name is translated into the default locale when the translated name is not found.</p>",
            "type":"string"
        },
        "childrenCount":{
            "description":"<p>This field will return number of immediate children a category has.</p> <p>This field will only be populated if childrenCount query parameter is passed in with value true.</p> <p>Example URIs for the this parameter are as follows:</p> <ul> <li>http://&lt;IM_REST_API_HOST&gt;/km/api/categories/{id}?childrenCount=true&mode=KEY</li> <li>http://&lt;IM_REST_API_HOST&gt;/km/api/categories?childrenCount=true&mode=KEY</li> <li>http://&lt;IM_REST_API_HOST&gt;/km/api/categories?q=contentTypeRefKey eq 'FAQ'&childrenCount=true&mode=KEY</li> </ul>",
            "type":"integer"
        },
        "externalType":{
            "description":"<p>The type of the category used while integrating the repository data with the external system. Valid options are PRODUCT and CATEGORY.</p>",
            "type":"string"
        },
        "parents":{
            "items":{
                "$ref":"#/definitions/CategoryKey"
            },
            "description":"<p>This field will return all parents of category.</p> <p>This field will only be populated if withParents query parameter is passed in with value true.</p> <p>Example URIs for the this parameter are as follows:</p> <ul> <li>http://&lt;IM_REST_API_HOST&gt;/km/api/categories/{id}?withParents=true&mode=KEY</li> <li>http://&lt;IM_REST_API_HOST&gt;/km/api/categories?withParents=true&mode=KEY</li> <li>http://&lt;IM_REST_API_HOST&gt;/km/api/categories?q=contentTypeRefKey eq 'FAQ'&withParents=true&mode=KEY</li> <li>http://&lt;IM_REST_API_HOST&gt;/km/api/categories/{id}?childrenCount=true&withParents=true&mode=KEY</li> </ul>",
            "type":"array"
        },
        "referenceKey":{
            "description":"<p>The reference key for the Category object. Category objects support multiple languages. This field can be used to identify the associated objects for all languages.</p>",
            "type":"string"
        },
        "objectId":{
            "description":"The hierarchichal position of the category",
            "type":"string"
        },
        "description":{
            "description":"Description of the Category object",
            "type":"string"
        },
        "name":{
            "description":"<p>The name of the category.</p>",
            "type":"string"
        },
        "inventoryOrgId":{
            "description":"<p>The inventory organization id of the specific product.</p>",
            "type":"integer"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/instanceLink"
            },
            "type":"array"
        },
        "externalId":{
            "description":"<p>The unique identifier used while integrating the repository data with the external system.</p>",
            "type":"integer"
        }
    }
}

ネストされたスキーマ : リンク

タイプ: array

ソースを表示

Array of: object instanceLink

JSONインスタンス表現に表示される可能性があるリンク記述オブジェクトを記述するMetadata。

{
    "items":{
        "$ref":"#/definitions/instanceLink"
    },
    "type":"array"
}

ネストされたスキーマ : 両親

タイプ: 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

ソースを表示

Array of: object CategoryKey

タイトル: CategoryKey

{
    "items":{
        "$ref":"#/definitions/CategoryKey"
    },
    "description":"<p>This field will return all parents of category.</p> <p>This field will only be populated if withParents query parameter is passed in with value true.</p> <p>Example URIs for the this parameter are as follows:</p> <ul> <li>http://&lt;IM_REST_API_HOST&gt;/km/api/categories/{id}?withParents=true&mode=KEY</li> <li>http://&lt;IM_REST_API_HOST&gt;/km/api/categories?withParents=true&mode=KEY</li> <li>http://&lt;IM_REST_API_HOST&gt;/km/api/categories?q=contentTypeRefKey eq 'FAQ'&withParents=true&mode=KEY</li> <li>http://&lt;IM_REST_API_HOST&gt;/km/api/categories/{id}?childrenCount=true&withParents=true&mode=KEY</li> </ul>",
    "type":"array"
}

ネストされたスキーマ : instanceLink

タイプ: object

JSONインスタンス表現に表示される可能性があるリンク記述オブジェクトを記述するMetadata。

ソースを表示

href: string

URI [RFC3986]またはURIテンプレート[RFC6570]。値がURI Templateに設定されている場合、「templated」プロパティをtrueに設定する必要があります。
mediaType(optional): string

RFC 2046で定義された、リンク・ターゲットを説明するメディア・タイプ。
method(optional): string

リンクのターゲットをリクエストするためのHTTPメソッド。
profile(optional): string

ターゲット・リソースの参照解除時に予期されるリソースを記述する、JSONスキーマなどのリソースのメタデータへのリンク。
rel: string

リンクの詳細を取得するためにタイプ・プロパティに加えて使用できるリンク関係の名前。たとえば、hrefやprofileです。
templated(optional): boolean

hrefプロパティがURIまたはURIテンプレートであることを指定するブール・フラグ。プロパティがURIテンプレートの場合は、この値をtrueに設定します。デフォルトでは、この値はfalseです。

{
    "description":"Metadata describing link description objects that MAY appear in the JSON instance representation.",
    "properties":{
        "templated":{
            "description":"Boolean flag that specifies that \"href\" property is a URI or URI Template. If the property is a URI template, set this value to true. By default, this value is false.",
            "type":"boolean"
        },
        "method":{
            "description":"HTTP method for requesting the target of the link.",
            "type":"string"
        },
        "rel":{
            "description":"Name of the link relation that, in addition to the type property, can be used to retrieve link details. For example, href or profile.",
            "type":"string"
        },
        "href":{
            "description":"URI [RFC3986] or URI Template [RFC6570]. If the value is set to URI Template, then the \"templated\" property must be set to true.",
            "type":"string"
        },
        "mediaType":{
            "description":"Media type, as defined by RFC 2046, describing the link target.",
            "type":"string"
        },
        "profile":{
            "description":"Link to the metadata of the resource, such as JSON-schema, that describes the resource expected when dereferencing the target resource..",
            "type":"string"
        }
    },
    "required":[
        "href",
        "rel"
    ],
    "type":"object"
}

トップに戻る

例

次の例は、cURLを使用してRESTリソースに対する取得リクエストを発行することによって、指定されたビュー・オブジェクトに関連付けられたカテゴリ・オブジェクトのリストを検索する方法を示しています。

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

レスポンス本文の例

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

{
  "items": [
    {
      "dateAdded": "2016-09-16T13:13:00-0600",
      "dateModified": "2016-09-16T13:13:01-0600",
      "objectId": "002",
      "sortOrder": 1,
      "description": "PARENT0000001111111",
      "hasChildren": true,
      "recordId": "01720CE1AE454C32BD4D496740AC66D0",
      "referenceKey": "FUSION_CATEGORY_300100089778735",
      "name": "Hierarchy test - Parent",
      "externalId": 300100089778735,
      "externalType": "CATEGORY",
      "links": [
        {
          "rel": "children",
          "href": "https://IM_REST_API_HOST/km/api/latest/categories/01720CE1AE454C32BD4D496740AC66D0/children",
          "mediaType": "application/json, application/xml",
          "method": "GET"
        },
        {
          "rel": "canonical",
          "href": "https://IM_REST_API_HOST/km/api/latest/categories/01720CE1AE454C32BD4D496740AC66D0",
          "mediaType": "application/json, application/xml",
          "method": "GET"
        },
        {
          "rel": "collection",
          "href": "https://IM_REST_API_HOST/km/api/latest/categories",
          "mediaType": "application/json, application/xml",
          "method": "GET",
          "profile": "https://IM_REST_API_HOST/km/api/latest/metadata-catalog/categories"
        }
      ]
    }
  ],
  "hasMore": true,
  "limit": 20,
  "offset": 0,
  "links": [
    {
      "rel": "canonical",
      "href": "https://IM_REST_API_HOST/km/api/latest/categories?limit=20&offset=0",
      "mediaType": "application/json, application/xml",
      "method": "GET"
    },
    {
      "rel": "next",
      "href": "https://IM_REST_API_HOST/km/api/latest/categories?limit=20&offset=20",
      "mediaType": "application/json, application/xml",
      "method": "GET"
    }
  ],
  "count": 1
}

「トップに戻る」