Post Data Progressivesubmit Json

progressiveSubmit

POST/data/progressiveSubmit.json

Use it in a workflow

Add a step and choose the Bazaarvoice connector.
Pick the Post Data Progressivesubmit Json action (under submission).
Fill in the fields below, then reference the result from later steps as {{postDataProgressivesubmitJson.response.data}}.

Request

Query parameters

apiVersionnumberrequired

The API version, e.g. 5.4.

actionstring

Action is always submit

fieldsboolean

A dictionary of form fields for a review form. Format depends on whether "extended" parameter is set. fields will be pre-populated with previously submitted content.

passkeystringrequired

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

hostedauthstring

Indicates the action being performed, is using hosted authentication

extendedstring

This parameter is sent as a single key and does not need a value. When omitted, the fields elements are returned in an ordered list that honors the submission field order as specified in the configuration hub, with the exception that required fields are presented first in the ordered list. When included, fields elements are returned in full submission-style format.

Headers

Content-Typestringrequired

Request body

Enter the body as JSON in the step's Body field.

localestring

Locale information

productIdstring

Product identifier

userIdstring

User identifier

submissionSessionTokenstring

Submission session token

submissionFieldsobject

ratingstring

Rating value

agreedtotermsandconditionsstring

Agreement to terms and conditions

reviewtextstring

Review text. The minimum length is configurable, default is 50 but can be lower.

titlestring

Value is content title text. The minimum and maximum lengths are configurable. The current default is 50 characters, but can be lower to 1 or higher to 255.

json

{
  "locale": "string",
  "productId": "string",
  "userId": "string",
  "submissionSessionToken": "string",
  "submissionFields": {
    "rating": "string",
    "agreedtotermsandconditions": "string",
    "reviewtext": "string",
    "title": "string"
  }
}

Response

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

hasErrorsboolean

responseobject

reviewobject6 fields

submissionIdstring

The submission ID.

isFormCompleteboolean

Flag indicating whether the form is complete.

SubmissionSessionTokenstring

json

{
  "hasErrors": false,
  "response": {
    "review": {
      "SendEmailAlertWhenCommented": false,
      "Rating": 0,
      "SubmissionTime": "string",
      "ReviewText": "string",
      "Title": "string",
      "SendEmailAlertWhenPublished": false
    },
    "submissionId": "string",
    "isFormComplete": false,
    "SubmissionSessionToken": "string"
  }
}

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

Was this page helpful?