機械翻訳について

ジャンプ先

• リクエスト
• レスポンス

コンテンツの評価

post

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

このメソッドは、指定されたIDでコンテンツ・オブジェクトの最新の有効バージョンを評価します。

Contentオブジェクトの最新の有効バージョンは、コンテンツ・オブジェクトの最新バージョンまたは公開済のライブ・バージョンです。 新しいリソースのリクエスト・ペイロードおよびURIは、POSTメソッドとともに指定する必要があります。

ノート: コンテンツ所有者はコンテンツを評価できません。

レスポンス・エラー

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

• OKDOM-GEN0001

  このエラーは、指定されたIDが無効な場合に発生します。

リクエスト

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

• application/json
• application/xml

パス・パラメータ

• id: string
  コンテンツ識別子。

本文( )

単一の回答の評価リクエスト・ペイロードには、サーベイ質問の回答のrecordIdを含める必要があり、オプションでサーベイのrecordId (/dataForms/{id})、ロケールのrecordIdおよびanswerComment要素を介して取得)を含めることができます。

ルート・スキーマ : SingleAnswerRating

タイプ: object

タイトル: SingleAnswerRating

ソースを表示

• answer(optional): object DataFormAnswerKey
  タイトル: DataFormAnswerKey
• answerComment(optional): string
  評価のコメント
• dateAdded(optional): string(date-time)
  このロケールの置換トークンのdateAdded
• locale(optional): object LocaleKey
  タイトル: LocaleKey
• recordId(optional): string
  SingleAnswerRatingオブジェクトの一意のレコードID。
• survey(optional): object DataFormKey
  タイトル: DataFormKey
• user(optional): object UserKey
  タイトル: UserKey

{
    "title":"SingleAnswerRating",
    "properties":{
        "recordId":{
            "description":"The unique record ID of the SingleAnswerRating object.",
            "type":"string"
        },
        "answerComment":{
            "description":"Comment for the rating",
            "type":"string"
        },
        "locale":{
            "description":"Relationship to Locale",
            "$ref":"#/definitions/LocaleKey"
        },
        "answer":{
            "description":"Relationship to SurveyAnswer",
            "$ref":"#/definitions/DataFormAnswerKey"
        },
        "dateAdded":{
            "description":"The dateAdded for the replacement token for this locale",
            "format":"date-time",
            "type":"string"
        },
        "survey":{
            "description":"Relationship to SurveyAnswer",
            "$ref":"#/definitions/DataFormKey"
        },
        "user":{
            "description":"Relationship to User",
            "$ref":"#/definitions/UserKey"
        }
    }
}

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

タイプ: object

タイトル: DataFormAnswerKey

ソースを表示

• links(optional): array links
• recordId(optional): string
  DataFormAnswerオブジェクトの一意のレコードID。
• referenceKey(optional): string
  DataFormAnswerオブジェクトの参照キー。 DataFormAnswerオブジェクトは、複数の言語をサポートしています。 このフィールドを使用して、すべての言語の関連オブジェクトを識別できます。

{
    "title":"DataFormAnswerKey",
    "properties":{
        "recordId":{
            "description":"The unique record ID of the DataFormAnswer object.",
            "type":"string"
        },
        "referenceKey":{
            "description":"The reference key for the DataFormAnswer object. DataFormAnswer objects support multiple languages. This field can be used to identify the associated objects for all languages.",
            "type":"string"
        },
        "links":{
            "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"
        }
    }
}

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

タイプ: object

タイトル: DataFormKey

ソースを表示

• links(optional): array links
• recordId(optional): string
  DataFormオブジェクトの一意のレコードID。
• referenceKey(optional): string
  DataFormオブジェクトの参照キー。 DataFormオブジェクトは、複数の言語をサポートしています。 このフィールドを使用して、すべての言語の関連オブジェクトを識別できます。

{
    "title":"DataFormKey",
    "properties":{
        "recordId":{
            "description":"The unique record ID of the DataForm object.",
            "type":"string"
        },
        "referenceKey":{
            "description":"The reference key for the DataForm object. DataForm objects support multiple languages. This field can be used to identify the associated objects for all languages.",
            "type":"string"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/instanceLink"
            },
            "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"
        }
    }
}

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

タイプ: array

ソースを表示

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

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

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

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

タイプ: array

ソースを表示

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

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

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

タイプ: array

ソースを表示

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

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

トップに戻る

レスポンス

204 レスポンス

コンテンツがありません。

「トップに戻る」