Get Comment

Preview Comments Form

GET/data/submitreviewcomment.json

Use it in a workflow

Add a step and choose the Bazaarvoice connector.
Pick the Get Comment action (under submission).
Fill in the fields below, then reference the result from later steps as {{getComment.response.data}}.

Request

Query parameters

ApiVersionstringrequired

The API version, e.g. 5.4.

ReviewIdstringrequired

The id of the review that this comment is being submitted on. Required for review comments.

UserIdstring

User's external ID. This value should come from your authentication system. See Client-Mastered Authentication for more information. Alert: Do not use an email address for this value.

PassKeystringrequired

API key is required to authenticate API user and check permission to access particular client's data.

Response

Returns 200 with an object. Read it in later steps with {{getComment.response.data.<field>}}.

Localestring

Commentobject

SubmissionTimestring

The submission time of the comment.

CommentTextstring

The text content of the comment.

SubmissionIdstring

The submission ID of the comment.

Titlestring

TypicalHoursToPoststring

Idstring

SendEmailAlertWhenPublishedboolean

Errorsarray<object>

Formarray<object>

Typestring

Idstring

FormErrorsobject

SubmissionIdstring

Dataobject

Fieldsobject11 fields

Groupsobject

userlocationgeocodeobject5 fields

FieldsOrderarray<string>

GroupsOrderarray<string>

TypicalHoursToPostnumber

The typical number of hours it takes for a comment to be posted.

AuthorSubmissionTokenstring

HasErrorsboolean

json

{
  "Locale": "string",
  "Comment": {
    "SubmissionTime": "string",
    "CommentText": "string",
    "SubmissionId": "string",
    "Title": "string",
    "TypicalHoursToPost": "string",
    "Id": "string",
    "SendEmailAlertWhenPublished": false
  },
  "Errors": [
    {}
  ],
  "Form": [
    {
      "Type": "string",
      "Id": "string"
    }
  ],
  "FormErrors": {},
  "SubmissionId": "string",
  "Data": {
    "Fields": {
      "userlocationgeocode_latitude": {
        "Options": [
          "string"
        ],
        "Type": "string",
        "Required": false,
        "Label": "string",
        "Value": "string",
        "MinLength": 0,
        "Id": "string",
        "MaxLength": 0,
        "Default": "string"
      },
      "commenttext": {
        "Options": [
          "string"
        ],
        "Type": "string",
        "Required": false,
        "Value": "string",
        "Label": "string",
        "MinLength": 0,
        "Id": "string",
        "MaxLength": 0,
        "Default": "string"
      },
      "userlocationgeocode_region": {
        "Options": [
          "string"
        ],
        "Type": "string",
        "Required": false,
        "Label": "string",
        "Value": "string",
        "MinLength": 0,
        "Id": "string",
        "MaxLength": 0,
        "Default": "string"
      },
      "title": {
        "Options": [
          "string"
        ],
        "Type": "string",
        "Required": false,
        "Label": "string",
        "Value": "string",
        "MinLength": 0,
        "Id": "string",
        "MaxLength": 0,
        "Default": "string"
      },
      "sendemailalertwhenpublished": {
        "Options": [
          "string"
        ],
        "Type": "string",
        "Required": false,
        "Label": "string",
        "Value": "string",
        "MinLength": "string",
        "Id": "string",
        "MaxLength": "string",
        "Default": "string"
      },
      "userlocationgeocode_country": {
        "Options": [
          "string"
        ],
        "Type": "string",
        "Required": false,
        "Label": "string",
        "Value": "string",
        "MinLength": 0,
        "Id": "string",
        "MaxLength": 0,
        "Default": "string"
      },
      "userlocationgeocode_longitude": {
        "Options": [
          "string"
        ],
        "Type": "string",
        "Required": false,
        "Label": "string",
        "Value": "string",
        "MinLength": 0,
        "Id": "string",
        "MaxLength": 0,
        "Default": "string"
      },
      "userlocationgeocode_city": {
        "Options": [
          "string"
        ],
        "Type": "string",
        "Required": false,
        "Label": "string",
        "Value": "string",
        "MinLength": 0,
        "Id": "string",
        "MaxLength": 0,
        "Default": "string"
      },
      "usernickname": {
        "Options": [
          "string"
        ],
        "Type": "string",
        "Required": false,
        "Label": "string",
        "Value": "string",
        "MinLength": 0,
        "Id": "string",
        "MaxLength": 0,
        "Default": "string"
      },
      "userlocation": {
        "Options": [
          "string"
        ],
        "Type": "string",
        "Required": false,
        "Label": "string",
        "Value": "string",
        "MinLength": 0,
        "Id": "string",
        "MaxLength": 0,
        "Default": "string"
      },
      "useremail": {
        "Options": [
          "string"
        ],
        "Type": "string",
        "Required": false,
        "Label": "string",
        "Value": "string",
        "MinLength": 0,
        "Id": "string",
        "MaxLength": 0,
        "Default": "string"
      }
    }
  },
  "Groups": {
    "userlocationgeocode": {
      "Type": "string",
      "SubElements": [
        {
          "Type": "string",
          "Id": "string"
        }
      ],
      "Required": false,
      "Label": "string",
      "Id": "string"
    }
  },
  "FieldsOrder": [
    "string"
  ],
  "GroupsOrder": [
    "string"
  ],
  "TypicalHoursToPost": 0,
  "AuthorSubmissionToken": "string"
}

Need more? See the Bazaarvoice guide for connection setup and behaviour shared by every action.

Was this page helpful?