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

アンサーIDで記事を検索

get

/km/api/v1/content/articles/{answerId}

このメソッドは、指定された回答IDに一致する記事ビジネス・オブジェクトを返します。 オプションで、レコードのコンテンツ・スキーマとそのすべての評点レスポンスを返します。

URIのanswerIdは、Oracle Engagement CloudがService Cloudの回答をOracle Knowledgeリポジトリのコンテンツ・レコードにマップできるようにする一意のIDです。 回答IDはlongまたは整数値にすることができ、特定のコンテンツIDおよびロケールIDに対して一意です。

モードKEY、DATA、EXTENDEDおよびFULLはリクエストの一部として指定できますが、返されるデータには影響しません。

条件付き属性を持つリクエスト・コンテンツ

条件付き属性を持つドキュメントをリクエストするには、additionalFieldsリクエスト・パラメータを使用します。 このパラメータは、ドキュメントに追加される小文字のフィールド名のカンマ区切りリストを使用します。 フィールド名は任意の順序で指定できます。

フィールド名の完全なリストを次に示します:

  • コンテンツチェマ - ドキュメントの翻訳済コンテンツ・スキーマ
  • aggregateformresults - 記事のすべての評価レスポンス(レスポンス合計、平均評価など)を表すAggregateFormResultsオブジェクト

たとえば、コンテンツ・スキーマ・フィールドを取得するには、additionalFieldsをadditionalFields=contentschemaとして指定できます。 コンテンツ・スキーマと集計フォームの結果の両方を取得するには、additionalFieldsをadditionalFields=contentschema,aggregateformresultsとして指定できます。

フィールドの値を取得できない場合、または値の取得中にエラーが発生した場合、フィールドの戻り値は空白になります。 評点タイプが評点なしとして構成されている場合、AggregrateFormResultsオブジェクトは返されません。

リクエスト・コンテンツ・アクセス・イベント記録

コンテンツ・アクセス・イベントを記録して、エンド・ユーザーが行ったアクティビティを分類できます。 記録されたコンテンツ・アクセス・イベントは、カスタムOracle Engagement Cloud分析レポートで表示できます。

コンテンツ・アクセス・イベントでの記録を有効にするには、HTTPリクエストで次のパラメータを指定する必要があります:

  • recordContentViewEventリクエスト・パラメータをHTTPリクエストとともに指定し、パラメータ値をtrueに設定します。
  • コンテンツ・オブジェクトのモードをEXTENDEDまたはFULLとして指定します。
  • isForEditリクエスト・パラメータをHTTPリクエストとともに指定し、パラメータ値をfalseに設定します。 デフォルト値はfalseです。

たとえば、URI http://<IM_REST_API_HOST>/km/api/content/answers/{id}/article?mode=FULL&activityType=SomeActivityを使用してリクエストが送信されると、デフォルト・ロケールのFULLモードで読取り専用コンテンツ・オブジェクトを取得します。 分析コンテンツ・アクセス・イベントは、アクティビティ・タイプとしてSomeActivityを使用して記録されます。

分析コンテンツ・アクセス・イベントの記録をオフにするには、recordContentViewEventリクエスト・パラメータ値をfalseに設定する必要があります。

次の表では、コンテンツの分析を管理するためのリクエスト・パラメータについて説明します。

パラメータ 動作
recordContentViewEvent

このパラメータは、コンテンツ・アクセス・イベントの記録をオンまたはオフにします。 パラメータの値はtrueまたはfalseです。 パラメータ値がtrueに設定されている場合、サービスによってコンテンツ・アクセスに関する情報が記録されます。

パラメータがHTTPリクエストで使用されていない場合、デフォルトでは値はtrueとみなされます。
activityType

このパラメータは、特定のコンテンツ・アクセス・イベントに関連付けられているアクセスのタイプを指定します。 パラメータは任意の文字列値を受け入れます。 コンテンツ・アクセス・イベントを分類して、カスタムOracle Knowledge Analyticsレポートに詳細情報を提供するために使用されます。

パラメータがHTTPリクエストで使用されていない場合、デフォルトでは、値はnullとみなされます。

翻訳済コンテンツのリクエスト

バージョンIDまたは回答IDを使用して翻訳済コンテンツをリクエストすることはできません。

バージョンIDは、メジャー・バージョンとマイナー・バージョンのコンテンツの特定の翻訳を表します。 たとえば、ドキュメントFA54には、英語のコンテンツ用に2つの異なるバージョンIDがあります。1つはバージョン1.0、もう1つは2.0です。

回答IDは、コンテンツの特定の翻訳を表します。 たとえば、ドキュメントFA54には、英語の場合は回答ID 101、スペイン語の場合は回答ID 102があります。

コンテンツ・セキュリティ

サービスは、ユーザーに割り当てられたセキュリティ・ロール権限を使用してコンテンツを表示します。 webユーザーは、次の条件でコンテンツにアクセスできます:

  • ユーザーには、指定したコンテンツ・レコードが保存されるコンテンツ・タイプに対する表示権限が必要です。
  • ユーザーに割り当てられたUserGroupオブジェクトは、コンテンツに割り当てられたUserGroupオブジェクトの少なくとも1つと一致する必要があります。
  • ユーザーに割り当てられたビューは、コンテンツに割り当てられたビューの少なくとも1つと一致します。

レスポンス・エラー

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

  • OK-GEN0020

    このエラーは、isForEditまたはagentModeリクエスト・パラメータ値がtrueに設定されている場合に発生します。

  • OKDOM-GEN0001

    このエラーは、指定した回答IDのコンテンツが見つからない場合に発生します。

  • $ERROR.General.BO_MODE_NOT_FOUND_CODE$

    このエラーは、リクエストに無効なモードが指定されている場合に発生します。 有効なモード値は、KEY、DATA、EXTENDEDおよびFULLです。

  • OKDOM-GEN0006

    このエラーは、HTTPサービス・リクエストのcontentStateパラメータで無効な値を指定した場合に発生します。

    contentStateパラメータの有効な値は次のとおりです: PUBLISHED、LATESTおよびLATESTVALID。

  • OKDOM-CONT0121

    このエラーは、HTTPサービス・リクエストとともにcontentState値としてLATESTを指定した場合に発生します。

    コンテンツ・リソースでは、contentStateパラメータ値としてLATESTは許可されません。

URIの例

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

  • http://<IM_REST_API_HOST>/km/api/content/answers/{id}/article

    リクエストは、指定された回答IDパラメータを持つ項目オブジェクトを返します。 デフォルトでは、公開されたバージョンのコンテンツがデフォルト・ロケールで表示されます。

  • http://<IM_REST_API_HOST>/km/api/content/answers/{id}/article?additionalFields=contentschema,aggregateformresults

    リクエストは、指定された回答IDパラメータを持つ項目オブジェクトを返します。 記事オブジェクトには、コンテンツ・スキーマと、記事のすべての評価レスポンスを表すAggregateFormResultsオブジェクトも含まれます。

  • http://<IM_REST_API_HOST>/km/api/content/answers/{id}/article?additionalFields=aggregateformresults

    このリクエストは、指定されたIDパラメータを持つArticleオブジェクトの評価の集計質問および回答を返します。 返される集計評価は、評価レベルがいいねおよびよくないねの5つ星評価にできます。

リクエスト

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

レスポンス

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

200 レスポンス

「OK」をクリックします。
本文( )
ルート・スキーマ : 記事
タイプ: object
タイトル: Article
ソースを表示
ネストされたスキーマ : AggregateFormResults
タイプ: object
タイトル: AggregateFormResults
ソースを表示
ネストされたスキーマ : スキーマ
タイプ: object
タイトル: Schema
ソースを表示
ネストされたスキーマ : ContentTypeKey
タイプ: object
タイトル: ContentTypeKey
ソースを表示

  • ContentTypeオブジェクトの説明。 コンテンツ・タイプは複数の言語をサポートしています。

    このフィールドは、ユーザーが指定した言語に関連付けられているオブジェクトを識別します。

  • links

  • ContentTypeオブジェクトの名前。 名前フィールドはソートにのみ使用できます。

    コンテンツ・タイプは複数の言語をサポートしています。 このフィールドは、ユーザーが指定した言語に関連付けられているオブジェクトを識別します。

  • ContentTypeオブジェクトの一意の識別子。

  • ContentTypeオブジェクトの参照キー。

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

  • ストライプ・コードを示す参照コード。

ネストされたスキーマ : UserKey
タイプ: object
タイトル: UserKey
ソースを表示
  • ユーザー・オブジェクトの電子メール
  • ExternalIdは、外部システムからの対応するユーザーのIDです。 ExternalTypeとともに、このシステムからのユーザーと外部システムのユーザーとの間のギャップを埋めるために使用できます。
  • ExternalTypeは、外部システムからの対応するユーザーのタイプです。 ExternalIdとともに使用すると、このシステムからのユーザーと外部システムのユーザーとの間のギャップを埋めることができます。
  • links
  • ユーザーのフルネーム
  • ユーザー・オブジェクトの一意のレコードID。
ネストされたスキーマ : リンク
タイプ: array
ソースを表示
  • instanceLink
ネストされたスキーマ : LocaleKey
タイプ: object
タイトル: LocaleKey
ソースを表示
ネストされたスキーマ : 質問
タイプ: array
AggregateQuestionResultとの関係が多すぎます
ソースを表示
ネストされたスキーマ : AggregateQuestionResult
タイプ: object
タイトル: AggregateQuestionResult
ソースを表示
ネストされたスキーマ : 答え
タイプ: array
AggregateAnswerResultとの関係が多すぎます
ソースを表示
ネストされたスキーマ : AggregateAnswerResult
タイプ: object
タイトル: AggregateAnswerResult
ソースを表示
ネストされたスキーマ : schemaAttributes
タイプ: array
スキーマのスキーマ属性のリスト
ソースを表示
ネストされたスキーマ : SchemaAttribute
タイプ: object
タイトル: SchemaAttribute
ソースを表示
ネストされたスキーマ : 子供
タイプ: array
現在の要素の子ノードのリスト
ソースを表示
ネストされたスキーマ : localizedAttributes
タイプ: array
様々なロケールでのこのSchemaAttribute名のLocalizedAttributesおよび説明のリスト
ソースを表示
ネストされたスキーマ : schemaAttributeUserGroupList
タイプ: array
この属性を保護するために使用できるユーザー・グループのリスト。 これは、ContentTypeに割り当てられたユーザー・グループのリストのサブセットである必要があります
ソースを表示
ネストされたスキーマ : LocalizedAttributes
タイプ: object
タイトル: LocalizedAttributes
ソースを表示
ネストされたスキーマ : SchemaAttributeUserGroup
タイプ: object
タイトル: SchemaAttributeUserGroup
ソースを表示
ネストされたスキーマ : UserGroupKey
タイプ: object
タイトル: UserGroupKey
ソースを表示
トップに戻る

例

次の例は、cURLを使用してRESTリソースに対する取得リクエストを発行することによって、指定された回答IDを持つコンテンツ・オブジェクトを検索する方法を示しています。

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

レスポンス本文の例

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

{
    "isForEdit": false,
    "categories": [
        {
            "recordId": "FDCF1C34F45A48669D651CE553398AC1",
            "referenceKey": "FUSION_PRODUCT_999994000663240",
            "objectId": "017.001.002.004.003",
            "name": "NAME_VALUE",
            "externalId": 999994000663240,
            "externalType": "PRODUCT",
            "links": [
                {
                    "rel": "canonical",
                    "href": "http://IM_REST_API_HOST/km/api/latest/categories/FDCF1C34F45A48669D651CE553398AC1",
                    "mediaType": "application/json, application/xml",
                    "method": "GET"
                }
            ]
        }
    ],
    "userGroups": [],
    "views": [
        {
            "recordId": "C3643883234B4B319793840918246A31",
            "referenceKey": "TENANT",
            "name": "fusion_fuscdrmsmc84",
            "links": [
                {
                    "rel": "canonical",
                    "href": "http://IM_REST_API_HOST/km/api/latest/views/C3643883234B4B319793840918246A31",
                    "mediaType": "application/json, application/xml",
                    "method": "GET"
                }
            ]
        }
    ],
    "recordId": "04003603ae8b6fa015b67b70ab2007fed",
    "versionId": "040087c2c9880015b887da26f007feb",
    "documentId": "SOL5",
    "title": "kcz - test solution - one prod 1",
    "version": "2.0",
    "answerId": 1000840,
    "locale": {
        "recordId": "en_US",
        "links": [
            {
                "rel": "canonical",
                "href": "http://IM_REST_API_HOST/km/api/latest/locales/en_US",
                "mediaType": "application/json, application/xml",
                "method": "GET"
            }
        ]
    },
    "dateModified": "2017-04-19T18:04:57-0600",
    "links": [
        {
            "rel": "canonical",
            "href": "http://IM_REST_API_HOST/km/api/latest/content/04003603ae8b6fa015b67b70ab2007fed",
            "mediaType": "application/json, application/xml",
            "method": "GET"
        },
        {
            "rel": "collection",
            "href": "http://IM_REST_API_HOST/km/api/latest/content",
            "mediaType": "application/json, application/xml",
            "method": "GET",
            "profile": "http://IM_REST_API_HOST/km/api/latest/metadata-catalog/content"
        }
    ],
    "contentType": {
        "recordId": "C6FAA0D5AFF442C2BED0EED8D8EDD9C0",
        "referenceKey": "SOLUTION",
        "name": "Solution",
        "links": [
            {
                "rel": "canonical",
                "href": "http://IM_REST_API_HOST/km/api/latest/contentTypes/C6FAA0D5AFF442C2BED0EED8D8EDD9C0",
                "mediaType": "application/json, application/xml",
                "method": "GET"
            }
        ]
    },
    "priority": "PRIORITY_0",
    "createDate": "2017-04-18T11:26:20-0600",
    "dateAdded": "2017-04-19T18:04:57-0600",
    "displayStartDate": "2017-04-18T11:24:56-0600",
    "displayEndDate": "9999-12-31T00:00:00-0700",
    "owner": {
        "recordId": "0400876c97c918015af96da5cc007f1c",
        "name": "kmtest1 svc",
        "externalType": "ACCOUNT",
        "links": [
            {
                "rel": "canonical",
                "href": "http://IM_REST_API_HOST/km/api/latest/users/0400876c97c918015af96da5cc007f1c",
                "mediaType": "application/json, application/xml",
                "method": "GET"
            }
        ]
    },
    "lastModifier": {
        "recordId": "0400876c97c918015af96da5cc007f1c",
        "name": "kmtest1 svc",
        "externalType": "ACCOUNT",
        "links": [
            {
                "rel": "canonical",
                "href": "http://IM_REST_API_HOST/km/api/latest/users/0400876c97c918015af96da5cc007f1c",
                "mediaType": "application/json, application/xml",
                "method": "GET"
            }
        ]
    },
    "creator": {
        "recordId": "0400876c97c918015af96da5cc007f1c",
        "name": "kmtest1 svc",
        "externalType": "ACCOUNT",
        "links": [
            {
                "rel": "canonical",
                "href": "http://IM_REST_API_HOST/km/api/latest/users/0400876c97c918015af96da5cc007f1c",
                "mediaType": "application/json, application/xml",
                "method": "GET"
            }
        ]
    },
    "published": true,
    "pending": false,
    "publishDate": "2017-04-19T18:04:57-0600",
    "checkedOut": false,
    "publishedVersion": "2.0",
    "xml": "<SOLUTION><SUMMARY><![CDATA[kcz - test solution - one prod 1]]></SUMMARY><ISSUE><![CDATA[kcz - test solution]]></ISSUE><RESOLUTION><![CDATA[kcz - test solution]]></RESOLUTION></SOLUTION>",
    "resourcePath": "http://IM_REST_API_HOST/content/draft/04003603ae8b6fa015b67b70ab2007fed/040087c2c9880015b887da26f007feb/"
}
「トップに戻る」