機械翻訳について

バージョンIDによるすべての翻訳済コンテンツの取得

get

/km/api/v1/content/versions/{versionId}/allTranslations

このメソッドは、指定されたバージョンIDを持つドキュメントの使用可能なすべての翻訳のリストを返します。 ドキュメントの翻訳は、ContentDataオブジェクトのリストとして返されます。

サービスでは、HTTPリクエストでcontentStateリクエスト・パラメータを使用できます。 有効なcontentStateパラメータ値は、PUBLISHEDおよびLATESTVALIDのみです。

ノート: サービスでは、HTTPリクエストでモードおよびisForEditリクエスト・パラメータを使用できません。 このサービスを使用して編集可能なドキュメントをリクエストすることはできません。

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

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

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

レスポンス・エラー

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

  • OKDOM-GEN0006

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

  • OKDOM-GEN0001

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

  • OK-GEN0020

    このエラーは、HTTPリクエストでmodeまたはlangprefリクエスト・パラメータが指定されている場合に発生します。

URIの例

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

  • http://<IM_REST_API_HOST>/km/api/content/versions/{versionId}/allTranslations

    このリクエストは、指定されたバージョンIDを持つドキュメントを含め、指定されたドキュメントの使用可能なすべての翻訳を返します。 翻訳されたドキュメントは、ContentKeyオブジェクトのリストとして返されます。 デフォルトでは、サービスは、追加された日付でソートされたドキュメントの公開済バージョンを返します。

  • http://<IM_REST_API_HOST>/km/api/content/versions/{versionId}/allTranslations?orderBy=publishDate

    このリクエストは、指定されたバージョンIDを持つドキュメントを含め、指定されたドキュメントの使用可能なすべての翻訳を返します。 翻訳されたドキュメントは、ContentKeyオブジェクトのリストとして返されます。 リスト内のオブジェクトは、公開日でソートされます。

    このリソースは、ContentDataオブジェクトの返されたリストをソートできるorderByリクエスト・パラメータをサポートしています。

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

    リソースのスキーマおよびカタログ情報を取得するURIの例を次に示します : http://<IM_REST_API_HOST>/km/api/latests/metadata-catalog/content

リクエスト

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

レスポンス

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

200 レスポンス

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

このフィールドは、ユーザーが表示できるすべての翻訳済コンテンツのリストを返します

このフィールドは、allTranslations問合せパラメータが値trueで渡された場合にのみ移入されます。

ソースを表示
ネストされたスキーマ : ArticleStatusKey
タイプ: object
タイトル: ArticleStatusKey
ソースを表示
ネストされたスキーマ : LocaleKey
タイプ: object
タイトル: LocaleKey
ソースを表示
ネストされたスキーマ : UserKey
タイプ: object
タイトル: UserKey
ソースを表示
  • ユーザー・オブジェクトの電子メール
  • ExternalIdは、外部システムからの対応するユーザーのIDです。 ExternalTypeとともに、このシステムからのユーザーと外部システムのユーザーとの間のギャップを埋めるために使用できます。
  • ExternalTypeは、外部システムからの対応するユーザーのタイプです。 ExternalIdとともに使用すると、このシステムからのユーザーと外部システムのユーザーとの間のギャップを埋めることができます。
  • links
  • ユーザーのフルネーム
  • ユーザー・オブジェクトの一意のレコードID。
ネストされたスキーマ : ContentTypeKey
タイプ: object
タイトル: ContentTypeKey
ソースを表示
  • ContentTypeオブジェクトの説明。 コンテンツ・タイプは複数の言語をサポートしています。

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

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

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

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

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

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

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

ネストされたスキーマ : ContentKey
タイプ: object
タイトル: ContentKey
ソースを表示
ネストされたスキーマ : DataForm
タイプ: object
タイトル: DataForm
ソースを表示
ネストされたスキーマ : AggregateFormResults
タイプ: object
タイトル: AggregateFormResults
ソースを表示
ネストされたスキーマ : schemaAttributes
タイプ: array

このフィールドには、このコンテンツのコンテンツ・タイプに関連付けられたスキーマ属性のリストが返されます。

このフィールドは、additionalFields問合せパラメータが値schemaAttributesとともに渡された場合にのみ移入されます。

ソースを表示
ネストされたスキーマ : allTranslations
タイプ: array

このフィールドは、ユーザーが表示できるすべての翻訳済コンテンツのリストを返します

このフィールドは、allTranslations問合せパラメータが値trueで渡された場合にのみ移入されます。

ソースを表示
ネストされたスキーマ : schemaAttributes
タイプ: array

このフィールドには、このコンテンツのコンテンツ・タイプに関連付けられたスキーマ属性のリストが返されます。

このフィールドは、additionalFields問合せパラメータが値schemaAttributesとともに渡された場合にのみ移入されます。

ソースを表示
ネストされたスキーマ : SchemaAttribute
タイプ: object
タイトル: SchemaAttribute
ソースを表示
ネストされたスキーマ : 子供
タイプ: array
現在の要素の子ノードのリスト
ソースを表示
ネストされたスキーマ : localizedAttributes
タイプ: array
様々なロケールでのこのSchemaAttribute名のLocalizedAttributesおよび説明のリスト
ソースを表示
ネストされたスキーマ : schemaAttributeUserGroupList
タイプ: array
この属性を保護するために使用できるユーザー・グループのリスト。 これは、ContentTypeに割り当てられたユーザー・グループのリストのサブセットである必要があります
ソースを表示
ネストされたスキーマ : LocalizedAttributes
タイプ: object
タイトル: LocalizedAttributes
ソースを表示
ネストされたスキーマ : SchemaAttributeUserGroup
タイプ: object
タイトル: SchemaAttributeUserGroup
ソースを表示
ネストされたスキーマ : UserGroupKey
タイプ: object
タイトル: UserGroupKey
ソースを表示
ネストされたスキーマ : 質問
タイプ: array
質問と多数の関係
ソースを表示
ネストされたスキーマ : ビュー
タイプ: array
表示する関係が多すぎます
ソースを表示
ネストされたスキーマ : DataFormQuestion
タイプ: object
タイトル: DataFormQuestion
ソースを表示
ネストされたスキーマ : 答え
タイプ: array
回答との関連性が多すぎます
ソースを表示
ネストされたスキーマ : DataFormKey
タイプ: object
タイトル: DataFormKey
ソースを表示
ネストされたスキーマ : DataFormAnswer
タイプ: object
タイトル: DataFormAnswer
ソースを表示
ネストされたスキーマ : DataFormQuestionKey
タイプ: object
タイトル: DataFormQuestionKey
ソースを表示
ネストされたスキーマ : ViewKey
タイプ: object
タイトル: ViewKey
ソースを表示
ネストされたスキーマ : 質問
タイプ: array
AggregateQuestionResultとの関係が多すぎます
ソースを表示
ネストされたスキーマ : AggregateQuestionResult
タイプ: object
タイトル: AggregateQuestionResult
ソースを表示
ネストされたスキーマ : 答え
タイプ: array
AggregateAnswerResultとの関係が多すぎます
ソースを表示
ネストされたスキーマ : AggregateAnswerResult
タイプ: object
タイトル: AggregateAnswerResult
ソースを表示
トップに戻る

次の例は、指定されたバージョンIDを持つドキュメントの使用可能なすべての翻訳を検索する方法を示しています。

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

レスポンス本文の例

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

{
  "items": [
    {
      "contentType": {
        "recordId": "33B9C302D8264371B6A12EDAF3FD974B",
        "referenceKey": "FAQ",
        "name": "FAQ",
        "links": [
          {
            "rel": "canonical",
            "href": "https://IM_REST_API_HOST/km/api/latest/contentTypes/33B9C302D8264371B6A12EDAF3FD974B",
            "mediaType": "application/json, application/xml",
            "method": "GET"
          }
        ]
      },
      "priority": "PRIORITY_0",
      "createDate": "2017-03-13T15:54:04-0600",
      "dateAdded": "2017-03-13T15:54:05-0600",
      "displayStartDate": "2017-03-13T15:53:24-0600",
      "displayEndDate": "9999-12-31T00:00:00-0700",
      "owner": {
        "recordId": "0400864aa0bf1015796a9cbbf007fea",
        "name": "NAME_VALUE",
        "externalType": "ACCOUNT",
        "links": [
          {
            "rel": "canonical",
            "href": "https://IM_REST_API_HOST/km/api/latest/users/0400864aa0bf1015796a9cbbf007fea",
            "mediaType": "application/json, application/xml",
            "method": "GET"
          }
        ]
      },
      "lastModifier": {
        "recordId": "0400864aa0bf1015796a9cbbf007fea",
        "name": "NAME_VALUE",
        "externalType": "ACCOUNT",
        "links": [
          {
            "rel": "canonical",
            "href": "https://IM_REST_API_HOST/km/api/latest/users/0400864aa0bf1015796a9cbbf007fea",
            "mediaType": "application/json, application/xml",
            "method": "GET"
          }
        ]
      },
      "creator": {
        "recordId": "0400864aa0bf1015796a9cbbf007fea",
        "name": "NAME_VALUE",
        "externalType": "ACCOUNT",
        "links": [
          {
            "rel": "canonical",
            "href": "https://IM_REST_API_HOST/km/api/latest/users/0400864aa0bf1015796a9cbbf007fea",
            "mediaType": "application/json, application/xml",
            "method": "GET"
          }
        ]
      },
      "published": true,
      "publishDate": "2017-03-13T15:54:04-0600",
      "checkedOut": false,
      "publishedVersion": "1.0",
      "recordId": "0400864099b39f015ac8eb9e8b007fe6",
      "versionId": "0400864099b39f015ac8eb9e8b007fe7",
      "documentId": "FAQ225",
      "title": "3D touch not working",
      "version": "1.0",
      "answerId": 1000347,
      "locale": {
        "recordId": "en_US",
        "links": [
          {
            "rel": "canonical",
            "href": "https://IM_REST_API_HOST/km/api/latest/locales/en_US",
            "mediaType": "application/json, application/xml",
            "method": "GET"
          }
        ]
      },
      "dateModified": "2017-03-13T15:54:05-0600",
      "links": [
        {
          "rel": "canonical",
          "href": "https://IM_REST_API_HOST/km/api/latest/content/0400864099b39f015ac8eb9e8b007fe6",
          "mediaType": "application/json, application/xml",
          "method": "GET"
        },
        {
          "rel": "collection",
          "href": "https://IM_REST_API_HOST/km/api/latest/content",
          "mediaType": "application/json, application/xml",
          "method": "GET",
          "profile": "https://IM_REST_API_HOST/km/api/latest/metadata-catalog/content"
        }
      ]
    }
  ],
  "hasMore": false,
  "links": [
    {
      "rel": "canonical",
      "href": "https://IM_REST_API_HOST/km/api/latest/content/versions/0400864099b39f015ac8eb9e8b007fe7/allTranslations?limit=20&offset=0",
      "mediaType": "application/json, application/xml",
      "method": "GET"
    }
  ],
  "count": 1
}
「トップに戻る」