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

機械翻訳について

カテゴリの取得

get

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

このメソッドは、一意の識別子で指定されたカテゴリ・オブジェクトを返します。一意の識別子は、recordIdパラメータ、referenceKeyパラメータまたはexternalIdパラメータです。

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

製品およびカテゴリの表示は、リクエストに関連付けられているビューによって異なります。

URIの例

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

http://<IM_REST_API_HOST>/km/api/latest/categories/{id}
リクエストは、指定されたIDパラメータを持つCategoryオブジェクトを返します。
http://<IM_REST_API_HOST>/km/api/latest/categories/{referenceKey}
リクエストは、指定されたreferenceKeyパラメータ値を持つCategoryオブジェクトを返します。
http://<IM_REST_API_HOST>/km/api/latest/categories/{externalId}
リクエストは、指定されたexternalIdパラメータ値を持つCategoryオブジェクトを返します。

リクエスト

パス・パラメータ

id: string

取得するオブジェクトの一意の識別子。

トップに戻る

レスポンス

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

application/json
application/xml

200 レスポンス

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

ルート・スキーマ : カテゴリ

タイプ: object

タイトル: Category

ソースを表示

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
dateAdded(optional): string(date-time)

カテゴリ・オブジェクトが作成または追加された日付。
dateModified(optional): string(date-time)
カテゴリ・オブジェクトが最後に変更された日付。

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

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

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

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

カテゴリに子があるかどうかを決定するフラグ。
inventoryOrgId(optional): integer

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

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

カテゴリの階層位置
parent(optional): object CategoryKey

タイトル: CategoryKey
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

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

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

{
    "title":"Category",
    "properties":{
        "recordId":{
            "description":"<p>The unique record ID of the Category object.</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"
        },
        "hasChildren":{
            "description":"Flag to determine if category has children.",
            "type":"boolean"
        },
        "dateModified":{
            "description":"<p>The date when the Category object was last modified.</p> <p>A category is considered to be modified in any of the following situations:</p><p>     <ul> <li> The category is created. The parent category to which the new category is added to is also considered as modified.</li> <li> The name of the category is changed in any locale.</li> <li> A child category is deleted.</li> <li> The category is moved. A moved category has a new parent,so the previous and new parent categories are also considered as modified.</li> <li> The sort order of the category is changed. The sort orders of sibling categories also undergo change, so those categories are also considered as modified.</li> </ul> </p>",
            "format":"date-time",
            "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"
        },
        "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"
        },
        "sortOrder":{
            "description":"<p>The assigned position of category object in the list of objects.</p>",
            "type":"integer"
        },
        "inventoryOrgId":{
            "description":"<p>The inventory organization id of the specific product.</p>",
            "type":"integer"
        },
        "parent":{
            "description":"<p>The parent category of the specific category.</p>",
            "$ref":"#/definitions/CategoryKey"
        },
        "dateAdded":{
            "description":"<p>The date when the Category object was created or added.</p>",
            "format":"date-time",
            "type":"string"
        },
        "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"
        },
        "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"
        },
        "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"
        },
        "description":{
            "description":"Description of the Category object",
            "type":"string"
        },
        "objectId":{
            "description":"The hierarchichal position of the category",
            "type":"string"
        },
        "name":{
            "description":"<p>The name of the category.</p>",
            "type":"string"
        }
    }
}

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

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

このフィールドは、カテゴリのすべての親を返します。

このフィールドは、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"
}

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

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

トップに戻る

例

次の例は、一意の識別子で指定されたカテゴリ・オブジェクトを表示する方法を示しています。一意の識別子は、recordIdパラメータ、referenceKeyパラメータまたはexternalIdパラメータです。

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

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

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

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

レスポンス本文の例

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

{
    "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
}

「トップに戻る」