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

機械翻訳について

コンテンツの評価結果を取得

get

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

このメソッドは、コンテンツ・レコードに対する全ての評価結果のリストを返します。

URIの例

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

http://<IM_REST_API_HOST>/km/api/latest/content/{id}/ratings?orderBy=dateAdded:asec
リクエストによって、コンテンツ・レコードのすべての評価結果のページ区切りリストが、日付の昇順で追加された順にソートされて返されます。
http://<IM_REST_API_HOST>/km/api/latest /content/{id}/ratings?orderBy=dateAdded:desc
リクエストによって、コンテンツ・レコードに対する全ての評価結果のページ区切りリストが、日付の降順で追加された日付でソートされて返されます。ソートできるフィールドは、recordId、dateAddedおよびdateModifiedです。

リクエスト

パス・パラメータ

id: string

コンテンツ識別子。

トップに戻る

レスポンス

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

application/json
application/xml

200 レスポンス

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

ルート・スキーマ : ResultList DataFormResults

タイプ: object

タイトル: ResultList DataFormResults

ソースを表示

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 DataFormResults",
    "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/DataFormResults"
            },
            "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 DataFormResults

タイトル: DataFormResults

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

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

タイプ: array

ソースを表示

Array of: object instanceLink

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

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

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

タイプ: object

タイトル: DataFormResults

ソースを表示

dateAdded(optional): string(date-time)

DataFormResultsオブジェクトが作成または追加された日付
dateModified(optional): string(date-time)

DataFormResultsオブジェクトが最後に変更された日付。
links(optional): array links
locale(optional): object LocaleKey

タイトル: LocaleKey
questions(optional): array questions

DetailQuestionResultとの関係が多すぎます
recordId(optional): string

DataFormResultsオブジェクトの一意のレコードID。
user(optional): object UserKey

タイトル: UserKey

{
    "title":"DataFormResults",
    "properties":{
        "recordId":{
            "description":"The unique record ID of the DataFormResults object.",
            "type":"string"
        },
        "dateModified":{
            "description":"The date when the DataFormResults object was last modified.",
            "format":"date-time",
            "type":"string"
        },
        "locale":{
            "description":"Relationship to Locale",
            "$ref":"#/definitions/LocaleKey"
        },
        "dateAdded":{
            "description":"The date when the DataFormResults object was created or added",
            "format":"date-time",
            "type":"string"
        },
        "questions":{
            "items":{
                "$ref":"#/definitions/DetailQuestionResult"
            },
            "description":"To Many Relationship to DetailQuestionResult",
            "type":"array"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/instanceLink"
            },
            "type":"array"
        },
        "user":{
            "description":"Relationship to User",
            "$ref":"#/definitions/UserKey"
        }
    }
}

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

タイプ: array

ソースを表示

Array of: object instanceLink

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

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

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

タイプ: object

タイトル: LocaleKey

ソースを表示

links(optional): array links
recordId(optional): string

ロケール・オブジェクトの一意の識別子。

{
    "title":"LocaleKey",
    "properties":{
        "recordId":{
            "description":"<p>The unique identifier of the Locale object.</p>",
            "type":"string"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/instanceLink"
            },
            "type":"array"
        }
    }
}

ネストされたスキーマ : 質問

タイプ: array

DetailQuestionResultとの関係が多すぎます

ソースを表示

Array of: object DetailQuestionResult

タイトル: DetailQuestionResult

{
    "items":{
        "$ref":"#/definitions/DetailQuestionResult"
    },
    "description":"To Many Relationship to DetailQuestionResult",
    "type":"array"
}

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

タイプ: object

タイトル: UserKey

ソースを表示

email(optional): string

ユーザー・オブジェクトの電子メール
externalId(optional): integer

ExternalIdは、外部システムからの対応するユーザーのIDです。 ExternalTypeとともに、このシステムからのユーザーと外部システムのユーザーとの間のギャップを埋めるために使用できます。
externalType(optional): string

ExternalTypeは、外部システムからの対応するユーザーのタイプです。 ExternalIdとともに使用すると、このシステムからのユーザーと外部システムのユーザーとの間のギャップを埋めることができます。
links(optional): array links
name(optional): string

ユーザーのフルネーム
recordId(optional): string

ユーザー・オブジェクトの一意のレコードID。

{
    "title":"UserKey",
    "properties":{
        "recordId":{
            "description":"The unique record ID of the User object.",
            "type":"string"
        },
        "externalType":{
            "description":"The ExternalType is the type of the corresponding User from an external system.  It, along with ExternalId, can be used to bridge the gap between a User from this system and a User from an external system.",
            "type":"string"
        },
        "email":{
            "description":"Email of the User object",
            "type":"string"
        },
        "name":{
            "description":"User's full name",
            "type":"string"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/instanceLink"
            },
            "type":"array"
        },
        "externalId":{
            "description":"The ExternalId is the Id of the corresponding User from an external system.  It, along with ExternalType, can be used to bridge the gap between a User from this system and a User from an external system.",
            "type":"integer"
        }
    }
}

ネストされたスキーマ : 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"
}

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

タイプ: object

タイトル: DetailQuestionResult

ソースを表示

answers(optional): array answers

DetailAnswerResultとの関係が多すぎます
recordId(optional): string

DetailQuestionResultオブジェクトの一意のレコードID。
referenceKey(optional): string

DetailQuestionResultオブジェクトの参照キー。 DetailQuestionResultオブジェクトは、複数の言語をサポートしています。このフィールドを使用して、すべての言語の関連オブジェクトを識別できます。

{
    "title":"DetailQuestionResult",
    "properties":{
        "recordId":{
            "description":"The unique record ID of the DetailQuestionResult object.",
            "type":"string"
        },
        "referenceKey":{
            "description":"The reference key for the DetailQuestionResult object. DetailQuestionResult objects support multiple languages. This field can be used to identify the associated objects for all languages.",
            "type":"string"
        },
        "answers":{
            "items":{
                "$ref":"#/definitions/DetailAnswerResult"
            },
            "description":"To Many Relationship to DetailAnswerResult",
            "type":"array"
        }
    }
}

ネストされたスキーマ : 答え

タイプ: array

DetailAnswerResultとの関係が多すぎます

ソースを表示

Array of: object DetailAnswerResult

タイトル: DetailAnswerResult

{
    "items":{
        "$ref":"#/definitions/DetailAnswerResult"
    },
    "description":"To Many Relationship to DetailAnswerResult",
    "type":"array"
}

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

タイプ: object

タイトル: DetailAnswerResult

ソースを表示

recordId(optional): string

DetailAnswerResultオブジェクトの一意のレコードID。
referenceKey(optional): string

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

DetailAnswerResultオブジェクトのテキスト
value(optional): integer

DetailAnswerResultオブジェクトの値

{
    "title":"DetailAnswerResult",
    "properties":{
        "recordId":{
            "description":"The unique record ID of the DetailAnswerResult object.",
            "type":"string"
        },
        "text":{
            "description":"Text of the DetailAnswerResult object",
            "type":"string"
        },
        "referenceKey":{
            "description":"The reference key for the DetailAnswerResult object. DetailAnswerResult objects support multiple languages. This field can be used to identify the associated objects for all languages.",
            "type":"string"
        },
        "value":{
            "description":"Value of the DetailAnswerResult object",
            "type":"integer"
        }
    }
}

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

タイプ: array

ソースを表示

Array of: object instanceLink

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

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

トップに戻る

例

次の例は、コンテンツ・レコードのすべての評価結果を検索する方法を示しています。

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

レスポンス本文の例

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

{
    "items": [
        {
            "locale": {
                "recordId": "en_US",
                "links": [
                    {
                        "rel": "canonical",
                        "href": "<IM_REST_API_HOST>/km/api/latest/locales/en_US",
                        "mediaType": "application/json, application/xml",
                        "method": "GET"
                    }
                ]
            },
            "questions": [
                {
                    "answers": [
                        {
                            "value": 2,
                            "recordId": "B73836830DC0401FA931120E4634408A",
                            "referenceKey": "YES_OR_NO_RATING_A2"
                        }
                    ],
                    "recordId": "94AEF5ABE53A4E609EFD0A208E9007C3",
                    "referenceKey": "YES_OR_NO_RATING_Q1"
                }
            ],
            "user": {
                "recordId": "503DA13674984E0BA909F2BFAAEEC06A",
                "name": "Default Administrator",
                "email": "admin@example.com",
                "externalType": "ACCOUNT",
                "links": [
                    {
                        "rel": "canonical",
                        "href": "<IM_REST_API_HOST>/km/api/latest/users/503DA13674984E0BA909F2BFAAEEC06A",
                        "mediaType": "application/json, application/xml",
                        "method": "GET"
                    }
                ]
            },
            "recordId": "00E16FA3AF5442F9A5B7E3C085D2DACD",
            "links": [
                {
                    "rel": "canonical",
                    "href": "<IM_REST_API_HOST>/km/api/latest/content/A2231630FC6C491A848E579138F25664/ratings",
                    "mediaType": "application/json, application/xml",
                    "method": "GET"
                }
            ],
            "dateAdded": "2018-09-06T14:15:14-0700",
            "dateModified": "2018-09-06T14:15:14-0700"
        },
        {
            "locale": {
                "recordId": "es_ES",
                "links": [
                    {
                        "rel": "canonical",
                        "href": "<IM_REST_API_HOST>/km/api/latest/locales/es_ES",
                        "mediaType": "application/json, application/xml",
                        "method": "GET"
                    }
                ]
            },
            "questions": [
                {
                    "answers": [
                        {
                            "value": 5,
                            "recordId": "29C9EEA5CB2B484A94762A4B1517EB57",
                            "referenceKey": "A5"
                        }
                    ],
                    "recordId": "D56585C3385846B5A8D700593E1C96F4",
                    "referenceKey": "Q1"
                }
            ],
            "user": {
                "recordId": "F74010DC1794481CA3272D74F1FCC07E",
                "name": "Guest User",
                "externalType": "CONTACT",
                "links": [
                    {
                        "rel": "canonical",
                        "href": "<IM_REST_API_HOST>/km/api/latest/users/F74010DC1794481CA3272D74F1FCC07E",
                        "mediaType": "application/json, application/xml",
                        "method": "GET"
                    }
                ]
            },
            "recordId": "4E44495FBFDB4498B63A382A8390A04E",
            "links": [
                {
                    "rel": "canonical",
                    "href": "<IM_REST_API_HOST>/km/api/latest/content/A2231630FC6C491A848E579138F25664/ratings",
                    "mediaType": "application/json, application/xml",
                    "method": "GET"
                }
            ],
            "dateAdded": "2018-09-10T23:45:40-0700",
            "dateModified": "2018-09-10T23:45:40-0700"
        },
        {
            "locale": {
                "recordId": "es_ES",
                "links": [
                    {
                        "rel": "canonical",
                        "href": "<IM_REST_API_HOST>/km/api/latest/locales/es_ES",
                        "mediaType": "application/json, application/xml",
                        "method": "GET"
                    }
                ]
            },
            "questions": [
                {
                    "answers": [
                        {
                            "value": 5,
                            "recordId": "29C9EEA5CB2B484A94762A4B1517EB57",
                            "referenceKey": "A5"
                        }
                    ],
                    "recordId": "D56585C3385846B5A8D700593E1C96F4",
                    "referenceKey": "Q1"
                }
            ],
            "user": {
                "recordId": "F74010DC1794481CA3272D74F1FCC07E",
                "name": "Guest User",
                "externalType": "CONTACT",
                "links": [
                    {
                        "rel": "canonical",
                        "href": "<IM_REST_API_HOST>/km/api/latest/users/F74010DC1794481CA3272D74F1FCC07E",
                        "mediaType": "application/json, application/xml",
                        "method": "GET"
                    }
                ]
            },
            "recordId": "CE35BC48D50C4235BF16689CE56CBF0B",
            "links": [
                {
                    "rel": "canonical",
                    "href": "<IM_REST_API_HOST>/km/api/latest/content/<content ID>/ratings",
                    "mediaType": "application/json, application/xml",
                    "method": "GET"
                }
            ],
            "dateAdded": "2018-09-11T00:45:01-0700",
            "dateModified": "2018-09-11T00:45:01-0700"
        }
    ],
    "hasMore": false,
    "limit": 20,
    "offset": 0,
    "links": [
        {
            "rel": "canonical",
            "href": "<IM_REST_API_HOST>/km/api/latest/content/<content ID>/ratings?limit=20&offset=0",
            "mediaType": "application/json, application/xml",

            "method": "GET"
        }
    ],
    "count": 3
}

「トップに戻る」