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

すべてのユーザー・キー値を取得

get

/km/api/v1/users/{userId}/userKeyValues

このメソッドは、指定されたユーザーの使用可能なUserKeyValueオブジェクトのリストを返します。

このリソースは、UserKeyValuesオブジェクトのページ区切りリストを戻してソートできるorderByリクエスト・パラメータをサポートしています。

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


URIの例

このメソッドのURIの例は、次のとおりです:

  • http://<IM_REST_API_HOST>/km/api/latest/users/{userId}/userKeyValues

    このメソッドは、指定されたユーザーのUserKeyValueビジネス・オブジェクトのページ区切りリストを返します。


問合せで検索

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


このメソッドは、指定されたユーザーIDの指定された基準に一致するUserKeyValueオブジェクトのリストを返します。

URIの例

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

  • http://<IM_REST_API_HOST>/km/api/latest/users/{userId}/userKeyValues?q=key eq 'FAVORITES

    このリクエストは、FAVORITESキーを持つUserKeyValueビジネス・オブジェクトのページ区切りリストを返します。

  • http://<IM_REST_API_HOST>/km/api/latest/users/{userId}/userKeyValues?q=dateAdded gt '2015-02-01'

    このリクエストは、2015年2月1日より後に作成されたUserKeyValueオブジェクトのリストを返します。

  • http://<IM_REST_API_HOST>/km/api/latest/users/{userId}/userKeyValues?q=recordId eq '{recordId}' and dateModified gt '2016-01-02'

    このリクエストは、指定されたレコードIDを持ち、2016年1月2日より後に最後に変更されたUserKeyValuesオブジェクトのリストを返します。

レスポンス・エラー

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

  • OKDOM-CRIT0025

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

問合せパラメータ

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

パラメータ問合せ可能ソート可能タイプ説明
recordIdYY'type' : 'string'userKeyValueリソースを表す一意の識別子。
dateAddedYY'type' : 'string', 'format' : 'date-time'UserKeyValueオブジェクトが作成された日付。
dateModifiedYY'type' : 'string', 'format' : 'date-time'UserKeyValueオブジェクトが最後に変更された日付。
keyYY'type' : 'string'UserKeyValueオブジェクトに関連付けられたキー。 このフィールドは、ユーザーの値フィールドに関連付けられています。 FAVORITESは鍵の例です。
valueYY'type' : 'string'UserKeyValueオブジェクトに関連付けられた値。 このフィールドは、ユーザーのキー・フィールドに関連付けられています。 FAQ1、FAQ23、FAQ44は値の例です。
userInformationYN'$ref' : '#/definitions/UserKey'ユーザーとオブジェクトの関係。

リクエスト

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

レスポンス

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

200 レスポンス

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

例

次の例は、cURLを使用してRESTリソースに対する取得リクエストを発行することによって、指定されたユーザーのユーザー・キー値オブジェクトのリストを検索する方法を示しています。

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

レスポンス本文の例

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

{
    "items": [
        {
            "recordId": "0800EFC596C244529709C93CCCFBB219",
            "links": [
                {
                    "rel": "canonical",
                    "href": "https://IM_REST_API_HOST/km/api/latest/users/300100098184652/userKeyValues/0800EFC596C244529709C93CCCFBB219",
                    "mediaType": "application/json, application/xml",
                    "method": "GET"
                },
                {
                    "rel": "collection",
                    "href": "https://IM_REST_API_HOST/km/api/latest/users/300100098184652/userKeyValues",
                    "mediaType": "application/json, application/xml",
                    "method": "GET"
                }
            ],
            "dateAdded": "2019-01-16T12:46:21+0000",
            "dateModified": "2019-01-16T12:46:27+0000",
            "key": "favorite_document",
            "value": "1016003,1016004,1017004,1017005,1017006,1016006"
        },
        {
            "recordId": "4C984E575AD84F559B3EC3524304791C",
            "links": [
                {
                    "rel": "canonical",
                    "href": "https://IM_REST_API_HOST/km/api/latest/users/300100098184652/userKeyValues/4C984E575AD84F559B3EC3524304791C",
                    "mediaType": "application/json, application/xml",
                    "method": "GET"
                },
                {
                    "rel": "collection",
                    "href": "https://IM_REST_API_HOST/km/api/latest/users/300100098184652/userKeyValues",
                    "mediaType": "application/json, application/xml",
                    "method": "GET"
                }
            ],
            "dateAdded": "2018-06-06T07:38:21+0000",
            "dateModified": "2020-04-10T16:18:31+0000",
            "key": "RECENT_SEARCH",
            "value": "FAQ57"
        }
    ],
    "hasMore": false,
    "links": [
        {
            "rel": "canonical",
            "href": "IM_REST_API_HOST/km/api/latest/users/300100098184652/userKeyValues?limit=20&offset=0",
            "mediaType": "application/json, application/xml",
            "method": "GET"
        }
    ],
    "count": 2
}
「トップに戻る」