Jump to

• Request
• Response

Rate an article

post

/articles/{id}/rate

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

Request

Path Parameters

• id(required): string

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• answer(required): answer
• answerComment: string
  Maximum Length: 4000
• dateAdded: string (date)
  Title: Date Added

  Read Only: true

  Timestamp for when this rating was created.
• locale: object LocaleKeyBO
  Documentation for BO mode: LocaleKeyBO:

  Localized Name of the Locale is currently NOT provided (i.e. The word Japanese is always in Japanese and never localized in say Arabic.)

• recordId: string
• survey: object DataFormKeyBO
  Documentation for BO mode: DataFormKeyBO
• user: object UserKeyBO
  Documentation for BO mode: UserKeyBO

{
    "required":[
        "answer"
    ],
    "type":"object",
    "properties":{
        "answer":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/DataFormAnswerKeyBO"
                },
                {
                    "nullable":false
                }
            ]
        },
        "answerComment":{
            "maxLength":"4000",
            "type":"string"
        },
        "dateAdded":{
            "format":"date",
            "title":"Date Added",
            "description":"Timestamp for when this rating was created.",
            "type":"string",
            "readOnly":true
        },
        "locale":{
            "$ref":"#/components/schemas/LocaleKeyBO"
        },
        "recordId":{
            "type":"string"
        },
        "survey":{
            "$ref":"#/components/schemas/DataFormKeyBO"
        },
        "user":{
            "$ref":"#/components/schemas/UserKeyBO"
        }
    }
}

Nested Schema : answer

Match All

Show Source

• object DataFormAnswerKeyBO
  Documentation for BO mode: AnswerKeyBO

{
    "allOf":[
        {
            "$ref":"#/components/schemas/DataFormAnswerKeyBO"
        },
        {
            "nullable":false
        }
    ]
}

Nested Schema : LocaleKeyBO

Type: object

Documentation for BO mode: LocaleKeyBO:

Localized Name of the Locale is currently NOT provided (i.e. The word Japanese is always in Japanese and never localized in say Arabic.)

Show Source

• links: array Links
  Title: Links

  Read Only: true

  REST API canonical and/or collection links for this Singular Resource
• localeDesc: string
  Title: Locale Desc

  Read Only: true

  Maximum Length: 100

  The description about the language and country that the Locale object represents.
• recordId: string
  Title: Record Id

  The unique identifier of the Locale object.

{
    "description":"Documentation for BO mode: LocaleKeyBO: <p>Localized Name of the Locale is currently NOT provided (i.e. The word Japanese is always in Japanese and never localized in say Arabic.)</p>",
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "description":"REST API canonical and/or collection links for this Singular Resource",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            },
            "readOnly":true
        },
        "localeDesc":{
            "title":"Locale Desc",
            "description":"The description about the language and country that the Locale object represents.",
            "maxLength":"100",
            "type":"string",
            "readOnly":true
        },
        "recordId":{
            "title":"Record Id",
            "description":"The unique identifier of the Locale object.",
            "type":"string",
            "readOnly":false
        }
    }
}

Nested Schema : DataFormKeyBO

Type: object

Documentation for BO mode: DataFormKeyBO

Show Source

• links: array Links
  Title: Links

  REST API canonical and/or collection links for this Singular Resource
• recordId(required): string
  Title: Record Id

  Read Only: true

  The unique identifier of the DataForm object
• referenceKey(required): string
  Title: Reference Key

  Minimum Length: 1

  Maximum Length: 255

  The reference key for the DataForm object

{
    "description":"Documentation for BO mode: DataFormKeyBO",
    "required":[
        "recordId",
        "referenceKey"
    ],
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "description":"REST API canonical and/or collection links for this Singular Resource",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            },
            "readOnly":false
        },
        "recordId":{
            "title":"Record Id",
            "description":"The unique identifier of the DataForm object",
            "type":"string",
            "readOnly":true
        },
        "referenceKey":{
            "title":"Reference Key",
            "description":"The reference key for the DataForm object",
            "maxLength":"255",
            "minLength":"1",
            "type":"string",
            "readOnly":false,
            "nullable":false
        }
    }
}

Nested Schema : UserKeyBO

Type: object

Documentation for BO mode: UserKeyBO

Show Source

• canAssignTask: boolean
  Title: Can Assign tasks

  Returns whether this user can assign tasks to other users.
• contentTypePrivileges: array Content Type Privileges
  Title: Content Type Privileges

  This field will return list of all contenttype privileges user have
• email: string
  Title: Email

  Maximum Length: 100

  The user's e-mail address
• externalId: integer (int64)
  Title: External Id

  Read Only: true

  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.
• functionalPrivileges: object Functional Privileges of user
  Title: Functional Privileges of user

  Additional Properties Allowed: additionalProperties

  This field will return list of all fucntional privileges user have
• links: array Links
  Title: Links

  Read Only: true

  REST API canonical and/or collection links for this Singular Resource
• login: string
  Title: Login

  Maximum Length: 100

  The user's login
• name: string
  Title: Name

  Read Only: true

  Maximum Length: 100

  User's full name
• recordId(required): integer (int64)
  Title: Record Id

  Read Only: true

  The unique identifier of the user

{
    "description":"Documentation for BO mode: UserKeyBO",
    "required":[
        "recordId"
    ],
    "type":"object",
    "properties":{
        "canAssignTask":{
            "title":"Can Assign tasks",
            "description":"Returns whether this user can assign tasks to other users.",
            "type":"boolean",
            "readOnly":false
        },
        "contentTypePrivileges":{
            "title":"Content Type Privileges",
            "description":"This field will return list of all contenttype privileges user have",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CompositeContentTypeBO"
            },
            "readOnly":false
        },
        "email":{
            "title":"Email",
            "description":"The user's e-mail address",
            "maxLength":"100",
            "type":"string",
            "readOnly":false
        },
        "externalId":{
            "format":"int64",
            "title":"External Id",
            "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",
            "readOnly":true
        },
        "functionalPrivileges":{
            "title":"Functional Privileges of user ",
            "description":"This field will return list of all fucntional privileges user have",
            "type":"object",
            "additionalProperties":{
                "type":"boolean"
            },
            "readOnly":false
        },
        "links":{
            "title":"Links",
            "description":"REST API canonical and/or collection links for this Singular Resource",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            },
            "readOnly":true
        },
        "login":{
            "title":"Login",
            "description":"The user's login",
            "maxLength":"100",
            "type":"string",
            "readOnly":false
        },
        "name":{
            "title":"Name",
            "description":"User's full name",
            "maxLength":"100",
            "type":"string",
            "readOnly":true
        },
        "recordId":{
            "format":"int64",
            "title":"Record Id",
            "description":"The unique identifier of the user",
            "type":"integer",
            "readOnly":true
        }
    }
}

Nested Schema : DataFormAnswerKeyBO

Type: object

Documentation for BO mode: AnswerKeyBO

Show Source

• links: array Links
  Title: Links

  REST API canonical and/or collection links for this Singular Resource
• recordId(required): string
  Title: Record Id

  Read Only: true

  The unique identifier of the DataFormAnswer object
• referenceKey: string
  Title: Reference Key

  Maximum Length: 255

  The reference key for the DataFormAnswer object

{
    "description":"Documentation for BO mode: AnswerKeyBO",
    "required":[
        "recordId"
    ],
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "description":"REST API canonical and/or collection links for this Singular Resource",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            },
            "readOnly":false
        },
        "recordId":{
            "title":"Record Id",
            "description":"The unique identifier of the DataFormAnswer object",
            "type":"string",
            "readOnly":true
        },
        "referenceKey":{
            "title":"Reference Key",
            "description":"The reference key for the DataFormAnswer object",
            "maxLength":"255",
            "type":"string",
            "readOnly":false
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

REST API canonical and/or collection links for this Singular Resource

Show Source

• Array of: object Link

{
    "title":"Links",
    "description":"REST API canonical and/or collection links for this Singular Resource",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Link"
    },
    "readOnly":false
}

Nested Schema : Link

Type: object

Show Source

• href: string
• mediaType: string
• method: string
• profile: string
• rel: string
• sinceVersion: string
• templated: boolean

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "mediaType":{
            "type":"string"
        },
        "templated":{
            "type":"boolean"
        },
        "method":{
            "type":"string"
        },
        "profile":{
            "type":"string"
        },
        "sinceVersion":{
            "type":"string"
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

Read Only: true

REST API canonical and/or collection links for this Singular Resource

Show Source

• Array of: object Link

{
    "title":"Links",
    "description":"REST API canonical and/or collection links for this Singular Resource",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Link"
    },
    "readOnly":true
}

Nested Schema : Links

Type: array

Title: Links

REST API canonical and/or collection links for this Singular Resource

Show Source

• Array of: object Link

{
    "title":"Links",
    "description":"REST API canonical and/or collection links for this Singular Resource",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Link"
    },
    "readOnly":false
}

Nested Schema : Content Type Privileges

Type: array

Title: Content Type Privileges

This field will return list of all contenttype privileges user have

Show Source

• Array of: object CompositeContentTypeBO
  Composite of ContentTypeBO and its flattened relation. Keep in mind we can add more stuff down the line

{
    "title":"Content Type Privileges",
    "description":"This field will return list of all contenttype privileges user have",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/CompositeContentTypeBO"
    },
    "readOnly":false
}

Nested Schema : Functional Privileges of user

Type: object

Title: Functional Privileges of user

Additional Properties Allowed

Show Source

• boolean

{
    "title":"Functional Privileges of user ",
    "description":"This field will return list of all fucntional privileges user have",
    "type":"object",
    "additionalProperties":{
        "type":"boolean"
    },
    "readOnly":false
}

This field will return list of all fucntional privileges user have

Nested Schema : Links

Type: array

Title: Links

Read Only: true

REST API canonical and/or collection links for this Singular Resource

Show Source

• Array of: object Link

{
    "title":"Links",
    "description":"REST API canonical and/or collection links for this Singular Resource",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Link"
    },
    "readOnly":true
}

Nested Schema : CompositeContentTypeBO

Type: object

Composite of ContentTypeBO and its flattened relation. Keep in mind we can add more stuff down the line

Show Source

• compositeWorkflowSteps(required): array WorkflowSteps Composite BO
  Title: WorkflowSteps Composite BO

  WorkflowSteps mapped to this content type and user privileges on that
• contentTypeKeyBO(required): contentTypeKeyBO
• hasContentTypeAccess: boolean
  Title: Has Content Type Access

  Verifies if ContentTypeBO privileges are valid for user
• listOfPrivilege(required): array List Of Privilege
  Title: List Of Privilege

  List of Privileges for the ContentType

{
    "description":"Composite of ContentTypeBO and its flattened relation. Keep in mind we can add more stuff down the line",
    "required":[
        "compositeWorkflowSteps",
        "contentTypeKeyBO",
        "listOfPrivilege"
    ],
    "type":"object",
    "properties":{
        "compositeWorkflowSteps":{
            "title":"WorkflowSteps Composite BO",
            "description":"WorkflowSteps mapped to this content type and user privileges on that",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CompositeWorkflowStepBO"
            },
            "readOnly":false,
            "nullable":false
        },
        "contentTypeKeyBO":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/ContentTypeKeyBO"
                },
                {
                    "title":"Content Type Key BO",
                    "description":"ContentBO object being created or updated",
                    "readOnly":false,
                    "nullable":false
                }
            ]
        },
        "hasContentTypeAccess":{
            "title":"Has Content Type Access",
            "description":"Verifies if ContentTypeBO privileges are valid for user",
            "type":"boolean",
            "readOnly":false
        },
        "listOfPrivilege":{
            "title":"List Of Privilege",
            "description":"List of Privileges for the ContentType",
            "type":"array",
            "items":{
                "type":"string"
            },
            "readOnly":false,
            "nullable":false
        }
    }
}

Nested Schema : WorkflowSteps Composite BO

Type: array

Title: WorkflowSteps Composite BO

WorkflowSteps mapped to this content type and user privileges on that

Show Source

• Array of: object CompositeWorkflowStepBO
  Composite of WorkflowStepBO with user privileges on this step.

{
    "title":"WorkflowSteps Composite BO",
    "description":"WorkflowSteps mapped to this content type and user privileges on that",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/CompositeWorkflowStepBO"
    },
    "readOnly":false,
    "nullable":false
}

Nested Schema : contentTypeKeyBO

Match All

ContentBO object being created or updated

Show Source

• object ContentTypeKeyBO
  Documentation for BO mode: ContentTypeKeyBO
• Title: Content Type Key BO

  ContentBO object being created or updated

{
    "allOf":[
        {
            "$ref":"#/components/schemas/ContentTypeKeyBO"
        },
        {
            "title":"Content Type Key BO",
            "description":"ContentBO object being created or updated",
            "readOnly":false,
            "nullable":false
        }
    ]
}

Nested Schema : List Of Privilege

Type: array

Title: List Of Privilege

List of Privileges for the ContentType

Show Source

• Array of: string

{
    "title":"List Of Privilege",
    "description":"List of Privileges for the ContentType",
    "type":"array",
    "items":{
        "type":"string"
    },
    "readOnly":false,
    "nullable":false
}

Nested Schema : CompositeWorkflowStepBO

Type: object

Composite of WorkflowStepBO with user privileges on this step.

Show Source

• listOfPrivilege(required): array List Of Privilege
  Title: List Of Privilege

  List of Privileges for the WorkflowStep
• WorkflowStepKeyBO(required): WorkflowStepKeyBO

{
    "description":"Composite of WorkflowStepBO with user privileges on this step.",
    "required":[
        "listOfPrivilege",
        "WorkflowStepKeyBO"
    ],
    "type":"object",
    "properties":{
        "listOfPrivilege":{
            "title":"List Of Privilege",
            "description":"List of Privileges for the WorkflowStep",
            "type":"array",
            "items":{
                "type":"string"
            },
            "readOnly":false,
            "nullable":false
        },
        "WorkflowStepKeyBO":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/WorkflowStepKeyBO"
                },
                {
                    "title":"WorkflowStep Key BO",
                    "description":"WorkflowStep object being fetched",
                    "readOnly":false,
                    "nullable":false
                }
            ]
        }
    }
}

Nested Schema : List Of Privilege

Type: array

Title: List Of Privilege

List of Privileges for the WorkflowStep

Show Source

• Array of: string

{
    "title":"List Of Privilege",
    "description":"List of Privileges for the WorkflowStep",
    "type":"array",
    "items":{
        "type":"string"
    },
    "readOnly":false,
    "nullable":false
}

Nested Schema : WorkflowStepKeyBO

Match All

WorkflowStep object being fetched

Show Source

• object WorkflowStepKeyBO
  Documentation for BO mode: WorkflowStepKeyBO
• Title: WorkflowStep Key BO

  WorkflowStep object being fetched

{
    "allOf":[
        {
            "$ref":"#/components/schemas/WorkflowStepKeyBO"
        },
        {
            "title":"WorkflowStep Key BO",
            "description":"WorkflowStep object being fetched",
            "readOnly":false,
            "nullable":false
        }
    ]
}

Nested Schema : WorkflowStepKeyBO

Type: object

Documentation for BO mode: WorkflowStepKeyBO

Show Source

• links: array Links
  Title: Links

  REST API canonical and/or collection links for this Singular Resource
• name: string
  Title: Name

  Maximum Length: 255

  Localized name of the workflow step
• recordId(required): string
  Title: Record Id

  Read Only: true

  GUID from the WORKFLOWSTEP table
• referenceKey(required): string
  Title: Reference Key

  Minimum Length: 1

  Maximum Length: 100

  Non localized name of the workflow step
• workflowId(required): string
  Title: WorkflowRecord Id

  Read Only: true

  GUID from the WORKFLOW table

{
    "description":"Documentation for BO mode: WorkflowStepKeyBO",
    "required":[
        "recordId",
        "referenceKey",
        "workflowId"
    ],
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "description":"REST API canonical and/or collection links for this Singular Resource",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            },
            "readOnly":false
        },
        "name":{
            "title":"Name",
            "description":"Localized name of the workflow step",
            "maxLength":"255",
            "type":"string",
            "readOnly":false
        },
        "recordId":{
            "title":"Record Id",
            "description":"GUID from the WORKFLOWSTEP table",
            "type":"string",
            "readOnly":true
        },
        "referenceKey":{
            "title":"Reference Key",
            "description":"Non localized name of the workflow step",
            "maxLength":"100",
            "minLength":"1",
            "type":"string",
            "readOnly":false,
            "nullable":false
        },
        "workflowId":{
            "title":"WorkflowRecord Id",
            "description":"GUID from the WORKFLOW table",
            "type":"string",
            "readOnly":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

REST API canonical and/or collection links for this Singular Resource

Show Source

• Array of: object Link

{
    "title":"Links",
    "description":"REST API canonical and/or collection links for this Singular Resource",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Link"
    },
    "readOnly":false
}

Nested Schema : ContentTypeKeyBO

Type: object

Documentation for BO mode: ContentTypeKeyBO

Show Source

• description: string
  Title: Description

  Maximum Length: 255

  The description for the ContentType object. Content Types support multiple languages. This field identifies the object associated with the language specified by the user.
• links: array Links
  Title: Links

  Read Only: true

  REST API canonical and/or collection links for this Singular Resource
• name(required): string
  Title: Name

  Minimum Length: 1

  Maximum Length: 255

  The name for the ContentType object. The name field can only be used for sorting. Content Types support multiple languages. This field identifies the object associated with the language specified by the user.
• recordId: string
  Title: Record Id

  Read Only: true

  The unique identifier of the ContentType object.
• referenceKey(required): string
  Title: Reference Key

  Minimum Length: 1

  Maximum Length: 255

  The reference key for the ContentType object. ContentType objects support multiple languages. This field can be used to identify the associated objects for all languages.
• stripeCd(required): string
  Title: Stripe Cd

  Maximum Length: 30

  Lookup code that indicates the stripe code.
• usageCode: string
  Title: Usage Code

  Read Only: true

  Maximum Length: 30

  Lookup code that indicates the product usage code.
• workflow: workflow

{
    "description":"Documentation for BO mode: ContentTypeKeyBO",
    "required":[
        "name",
        "referenceKey",
        "stripeCd"
    ],
    "type":"object",
    "properties":{
        "description":{
            "title":"Description",
            "description":"The description for the ContentType object. Content Types support multiple languages. This field identifies the object associated with the language specified by the user.",
            "maxLength":"255",
            "type":"string",
            "readOnly":false
        },
        "links":{
            "title":"Links",
            "description":"REST API canonical and/or collection links for this Singular Resource",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            },
            "readOnly":true
        },
        "name":{
            "title":"Name",
            "description":"The name for the ContentType object.  The name field can only be used for sorting. Content Types support multiple languages. This field identifies the object associated with the language specified by the user. ",
            "maxLength":"255",
            "minLength":"1",
            "type":"string",
            "readOnly":false,
            "nullable":false
        },
        "recordId":{
            "title":"Record Id",
            "description":"The unique identifier of the ContentType object.",
            "type":"string",
            "readOnly":true
        },
        "referenceKey":{
            "title":"Reference Key",
            "description":"The reference key for the ContentType object. ContentType objects support multiple languages. This field can be used to identify the associated objects for all languages.",
            "maxLength":"255",
            "minLength":"1",
            "type":"string",
            "readOnly":false,
            "nullable":false
        },
        "stripeCd":{
            "title":"Stripe Cd",
            "description":"Lookup code that indicates the stripe code.",
            "maxLength":"30",
            "type":"string",
            "readOnly":false
        },
        "usageCode":{
            "title":"Usage Code",
            "description":"Lookup code that indicates the product usage code.",
            "maxLength":"30",
            "type":"string",
            "readOnly":true
        },
        "workflow":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/WorkflowKeyBO"
                },
                {
                    "title":"Workflow",
                    "description":"The workflow definition that the author can use while content authoring in a content type.",
                    "readOnly":false
                }
            ]
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

Read Only: true

REST API canonical and/or collection links for this Singular Resource

Show Source

• Array of: object Link

{
    "title":"Links",
    "description":"REST API canonical and/or collection links for this Singular Resource",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Link"
    },
    "readOnly":true
}

Nested Schema : workflow

Match All

The workflow definition that the author can use while content authoring in a content type.

Show Source

• object WorkflowKeyBO
• Title: Workflow

  The workflow definition that the author can use while content authoring in a content type.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/WorkflowKeyBO"
        },
        {
            "title":"Workflow",
            "description":"The workflow definition that the author can use while content authoring in a content type.",
            "readOnly":false
        }
    ]
}

Nested Schema : WorkflowKeyBO

Type: object

Show Source

• enabled: boolean
• links: array links
• name: string
  Maximum Length: 255
• recordId: string
• referenceKey: string
  Minimum Length: 0

  Maximum Length: 100
• workflowVersion: integer (int32)

{
    "type":"object",
    "properties":{
        "enabled":{
            "type":"boolean"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            }
        },
        "name":{
            "maxLength":"255",
            "type":"string"
        },
        "recordId":{
            "type":"string"
        },
        "referenceKey":{
            "maxLength":"100",
            "minLength":"0",
            "type":"string"
        },
        "workflowVersion":{
            "format":"int32",
            "type":"integer"
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Link"
    }
}

Back to Top

Response

204 Response

No Content

Back to Top