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

総合評価結果の取得

get

/km/api/v1/content/{id}/ratingsAggregate

このメソッドは、指定されたコンテンツ翻訳のすべての評価レスポンスを表すAggregateFormResultsオブジェクトを返します。 AggregateFormResultsオブジェクトには、リクエストで指定されたロケールに表示される評価の質問および評価の回答が含まれます。

ロケールを指定するには、Oracle Engagement Cloud Knowledge REST APIにリクエストするときに、kmauthtokenヘッダーのlocaleIdパラメータを設定します。 または、localeIdパラメータ値が指定されていない場合、メソッドは、指定されたロケールを、ログイン・ユーザーに割り当てられたデフォルトのロケール・オブジェクトとして解釈します。

どちらの場合も、指定されたロケールをセッションのロケールと呼びます。 kmauthtokenヘッダーのuserToken属性が、ログイン・ユーザーに対して作成されます。 また、Langprefリクエスト・パラメータでロケールを指定できます。

このメソッドは、各質問に対する回答を合計し、指定されたロケールの評価タイプに基づいてコンテンツ・オブジェクトの平均評価を計算します。 5つ星以外の評価タイプの平均評価はゼロです。

評価には3つのタイプがあります:

  • 5つ星評価? 5つの星アイコンの行が記事の最後に表示されます。 各星アイコンは品質レベルを表します。
  • いいねとよくないね - サム・アップ記号はいいねを表し、サム・ダウン記号はよくないねを表します。
  • 評価なし

ノート: コンテンツ・オブジェクトは、特定のロケールに対してのみ評価できます。 したがって、異なるロケール・オブジェクトでリクエストが行われた場合、メソッドは同じコンテンツ・オブジェクトに対して異なるAggregateFormResultsオブジェクトを返します。

URIの例

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

  • http://<IM_REST_API_HOST>/km/api/latest/content/{id}/ratingsAggregate

    このリクエストは、指定されたContentオブジェクトのAggregateFormResultsオブジェクトを、セッションのロケールに翻訳して返します。

  • http://<IM_REST_API_HOST>/km/api/latest/content/{id}/ratingsAggregate?langpref=es_ES

    リクエストは、指定したContentオブジェクトのAggregateFormResultsオブジェクトを、リクエストのロケールに翻訳して返します。

レスポンス・エラー

  • OKDOM-GEN0001

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

  • OKDOM-SURV0018

    このエラーは、評点タイプが評点なしとして構成されている場合に発生します。

リクエスト

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

レスポンス

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

200 レスポンス

「OK」をクリックします。
本文( )
ルート・スキーマ : AggregateFormResults
タイプ: object
タイトル: AggregateFormResults
ソースを表示
ネストされたスキーマ : 質問
タイプ: array
AggregateQuestionResultとの関係が多すぎます
ソースを表示
ネストされたスキーマ : AggregateQuestionResult
タイプ: object
タイトル: AggregateQuestionResult
ソースを表示
ネストされたスキーマ : 答え
タイプ: array
AggregateAnswerResultとの関係が多すぎます
ソースを表示
ネストされたスキーマ : AggregateAnswerResult
タイプ: object
タイトル: AggregateAnswerResult
ソースを表示
トップに戻る

例

例1

次の例では、評価タイプが五つ星の場合に、指定されたコンテンツ・オブジェクトの評価の質問と回答を集約して検索する方法を示します。

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

レスポンス本文の例

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

{
    "questions": [
        {
            "answers": [
                {
                    "totalResponses": 2,
                    "recordId": "29C9EEA5CB2B484A94762A4B1517EB57",
                    "referenceKey": "A5",
                    "name": "5"
                },
                {
                    "totalResponses": 1,
                    "recordId": "3A9A0952D3CF4A138FA4518A0F25F020",
                    "referenceKey": "A3",
                    "name": "3"
                },
                {
                    "totalResponses": 0,
                    "recordId": "4EFDA9A45A144CFDA9E0973A04BD5114",
                    "referenceKey": "A2",
                    "name": "2"
                },
                {
                    "totalResponses": 1,
                    "recordId": "6BF001ED4CEB4EF1A007355BEE421F46",
                    "referenceKey": "A4",
                    "name": "4"
                },
                {
                    "totalResponses": 0,
                    "recordId": "FC0EBC5507A041029D0FFE62A7DEAA6A",
                    "referenceKey": "A1",
                    "name": "1"
                }
            ],
            "recordId": "D56585C3385846B5A8D700593E1C96F4",
            "referenceKey": "Q1",
            "name": "How would you rate this document?",
            "totalResponses": 4,
            "averageResponse": 4.25
        }
    ],
    "recordId": "EBA5CB446E25451C994D881F60FDA0BD",
    "referenceKey": "5_STAR_RATING",
    "links": [
        {
            "rel": "canonical",
            "href": "https://<IM_REST_API_HOST>/km/api/latest/content/<content ID>/ratingsAggregate",
            "mediaType": "application/json, application/xml",
            "method": "GET"
        }
    ],
    "totalResponses": 4
}

例2

次の例は、評価タイプがLikeでDislikeの場合に、指定したコンテンツ・オブジェクトの評価の質問と回答を集計する方法を示しています。

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

レスポンス本文の例

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

{
    "questions": [
        {
            "answers": [
                {
                    "totalResponses": 2,
                    "recordId": "874CF739B99F4D358050B6C5CCC819F6",
                    "referenceKey": "YES_OR_NO_RATING_A1",
                    "name": "Dislike"
                },
                {
                    "totalResponses": 1,
                    "recordId": "B73836830DC0401FA931120E4634408A",
                    "referenceKey": "YES_OR_NO_RATING_A2",
                    "name": "Like"
                }
            ],
            "recordId": "94AEF5ABE53A4E609EFD0A208E9007C3",
            "referenceKey": "YES_OR_NO_RATING_Q1",
            "name": "Do you like this Article?",
            "totalResponses": 3,
            "averageResponse": 0
        }
    ],
    "recordId": "45C98B085B044881821DE07F68DC14CF",
    "referenceKey": "YES_OR_NO_RATING",
    "links": [
        {
            "rel": "canonical",
            "href": "https://<IM_REST_API_HOST>/km/api/latest/content/<content ID>/ratingsAggregate",
            "mediaType": "application/json, application/xml",
            "method": "GET"
        }
    ],
    "totalResponses": 3
}
「トップに戻る」