Jump to

• Request
• Response

Rate content

post

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

This method rates the latest valid version of the Content object with the specified ID.

The latest valid version of the Content object is either the published live or the latest version of the Content object. The request payload and the URI for the new resource must be specified along with the POST method.

Note: The content owner cannot rate the content.

Response Errors

The possible error response for this method is as follows:

• OKDOM-GEN0001

  The error occurs when the specified ID is invalid.

Request

Supported Media Types

• application/json
• application/xml

Path Parameters

• id: string
  The content identifier.

Body ()

The single answer rating request payload should include the survey question answer's recordId and could optionally include the survey's recordId (retrieved via /dataForms/{id}), the locale's recordId and the answerComment element.

Root Schema : SingleAnswerRating

Type: object

Title: SingleAnswerRating

Show Source

• answer(optional): object DataFormAnswerKey
  Title: DataFormAnswerKey
• answerComment(optional): string
  Comment for the rating
• dateAdded(optional): string(date-time)
  The dateAdded for the replacement token for this locale
• locale(optional): object LocaleKey
  Title: LocaleKey
• recordId(optional): string
  The unique record ID of the SingleAnswerRating object.
• survey(optional): object DataFormKey
  Title: DataFormKey
• user(optional): object UserKey
  Title: 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"
        }
    }
}

Nested Schema : DataFormAnswerKey

Type: object

Title: DataFormAnswerKey

Show Source

• links(optional): array links
• recordId(optional): string
  The unique record ID of the DataFormAnswer object.
• referenceKey(optional): string
  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.

{
    "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"
        }
    }
}

Nested Schema : LocaleKey

Type: object

Title: LocaleKey

Show Source

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

  The unique identifier of the Locale object.

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

Nested Schema : DataFormKey

Type: object

Title: DataFormKey

Show Source

• links(optional): array links
• recordId(optional): string
  The unique record ID of the DataForm object.
• referenceKey(optional): string
  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.

{
    "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"
        }
    }
}

Nested Schema : UserKey

Type: object

Title: UserKey

Show Source

• email(optional): string
  Email of the User object
• externalId(optional): integer
  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.
• externalType(optional): string
  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.
• links(optional): array links
• name(optional): string
  User's full name
• recordId(optional): string
  The unique record ID of the User object.

{
    "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"
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object instanceLink
  Metadata describing link description objects that MAY appear in the JSON instance representation.

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

Nested Schema : instanceLink

Type: object

Metadata describing link description objects that MAY appear in the JSON instance representation.

Show Source

• href: string
  URI [RFC3986] or URI Template [RFC6570]. If the value is set to URI Template, then the "templated" property must be set to true.
• mediaType(optional): string
  Media type, as defined by RFC 2046, describing the link target.
• method(optional): string
  HTTP method for requesting the target of the link.
• profile(optional): string
  Link to the metadata of the resource, such as JSON-schema, that describes the resource expected when dereferencing the target resource..
• rel: string
  Name of the link relation that, in addition to the type property, can be used to retrieve link details. For example, href or profile.
• templated(optional): boolean
  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.

{
    "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"
}

Nested Schema : links

Type: array

Show Source

• Array of: object instanceLink
  Metadata describing link description objects that MAY appear in the JSON instance representation.

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

Nested Schema : links

Type: array

Show Source

• Array of: object instanceLink
  Metadata describing link description objects that MAY appear in the JSON instance representation.

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

Nested Schema : links

Type: array

Show Source

• Array of: object instanceLink
  Metadata describing link description objects that MAY appear in the JSON instance representation.

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

Back to Top

Response

204 Response

No Content.

Back to Top