Get Question

Preview a question submission

GET/data/submitquestion.json

Use it in a workflow

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

Request

Query parameters

ApiVersionstringrequired

The API version, e.g. 5.4.

ProductIdstringrequired

The id of the product that this content is being submitted on.

Actionstring

The submission action to take

QuestionSummarystringrequired

Contains the text of the question summary. Only a single line of text is allowed.

Userstring

Value of the encrypted user. This parameter demonstrates that a user has been authenticated. Note that the UserId parameter does not contain authentication information and should not be used for hosted authentication. See the Authenticate User method for more information.

agreedtotermsandconditionsboolean

Boolean indicating whether or not the user agreed to the terms and conditions. Required depending on the client's settings.

usernicknamestring

User nickname display text.

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 {{getQuestion.response.data.<field>}}.

Localestring

Errorsarray<object>

Formarray<object>

Typestring

Idstring

FormErrorsobject

SubmissionIdstring

Dataobject

Fieldsobject26 fields

Groupsobject9 fields

FieldsOrderarray<string>

GroupsOrderarray<string>

Questionobject

QuestionSummarystring

SubmissionTimestring

SubmissionIdstring

SendEmailAlertWhenAnsweredboolean

TypicalHoursToPoststring

QuestionDetailsstring

Idstring

SendEmailAlertWhenPublishedboolean

TypicalHoursToPostinteger

AuthorSubmissionTokenstring

HasErrorsboolean

json

{
  "Locale": "string",
  "Errors": [
    {}
  ],
  "Form": [
    {
      "Type": "string",
      "Id": "string"
    }
  ],
  "FormErrors": {},
  "SubmissionId": "string",
  "Data": {
    "Fields": {
      "photourl_6": {
        "Options": [
          "string"
        ],
        "Type": "string",
        "Required": false,
        "Label": "string",
        "Value": "string",
        "MinLength": 0,
        "Id": "string",
        "MaxLength": 0,
        "Default": "string"
      },
      "photourl_2": {
        "Options": [
          "string"
        ],
        "Type": "string",
        "Required": false,
        "Label": "string",
        "Value": "string",
        "MinLength": 0,
        "Id": "string",
        "MaxLength": 0,
        "Default": "string"
      },
      "photourl_3": {
        "Options": [
          "string"
        ],
        "Type": "string",
        "Required": false,
        "Label": "string",
        "Value": "string",
        "MinLength": 0,
        "Id": "string",
        "MaxLength": 0,
        "Default": "string"
      },
      "photourl_4": {
        "Options": [
          "string"
        ],
        "Type": "string",
        "Required": false,
        "Label": "string",
        "Value": "string",
        "MinLength": 0,
        "Id": "string",
        "MaxLength": 0,
        "Default": "string"
      },
      "photourl_5": {
        "Options": [
          "string"
        ],
        "Type": "string",
        "Required": false,
        "Label": "string",
        "Value": "string",
        "MinLength": 0,
        "Id": "string",
        "MaxLength": 0,
        "Default": "string"
      },
      "sendemailalertwhenanswered": {
        "Options": [
          "string"
        ],
        "Type": "string",
        "Required": false,
        "Label": "string",
        "Value": "string",
        "MinLength": 0,
        "Id": "string",
        "MaxLength": 0,
        "Default": "string"
      },
      "photocaption_2": {
        "Options": [
          "string"
        ],
        "Type": "string",
        "Required": false,
        "Label": "string",
        "Value": "string",
        "MinLength": 0,
        "Id": "string",
        "MaxLength": 0,
        "Default": "string"
      },
      "photocaption_1": {
        "Options": [
          "string"
        ],
        "Type": "string",
        "Required": false,
        "Label": "string",
        "Value": "string",
        "MinLength": 0,
        "Id": "string",
        "MaxLength": 0,
        "Default": "string"
      },
      "photocaption_6": {
        "Options": [
          "string"
        ],
        "Type": "string",
        "Required": false,
        "Label": "string",
        "Value": "string",
        "MinLength": 0,
        "Id": "string",
        "MaxLength": 0,
        "Default": "string"
      },
      "photocaption_5": {
        "Options": [
          "string"
        ],
        "Type": "string",
        "Required": false,
        "Label": "string",
        "Value": "string",
        "MinLength": 0,
        "Id": "string",
        "MaxLength": 0,
        "Default": "string"
      },
      "photocaption_4": {
        "Options": [
          "string"
        ],
        "Type": "string",
        "Required": false,
        "Label": "string",
        "Value": "string",
        "MinLength": 0,
        "Id": "string",
        "MaxLength": 0,
        "Default": "string"
      },
      "photourl_1": {
        "Options": [
          "string"
        ],
        "Type": "string",
        "Required": false,
        "Label": "string",
        "Value": "string",
        "MinLength": 0,
        "Id": "string",
        "MaxLength": 0,
        "Default": "string"
      }
    },
    "Groups": {
      "photo_1": {
        "Type": "string",
        "SubElements": [
          {
            "Type": "string",
            "Id": "string"
          }
        ],
        "Required": false,
        "Label": "string",
        "Id": "string"
      },
      "photo_2": {
        "Type": "string",
        "SubElements": [
          {
            "Type": "string",
            "Id": "string"
          }
        ],
        "Required": false,
        "Label": "string",
        "Id": "string"
      },
      "photo_3": {
        "Type": "string",
        "SubElements": [
          {
            "Type": "string",
            "Id": "string"
          }
        ],
        "Required": false,
        "Label": "string",
        "Id": "string"
      },
      "photo_4": {
        "Type": "string",
        "SubElements": [
          {
            "Type": "string",
            "Id": "string"
          }
        ],
        "Required": false,
        "Label": "string",
        "Id": "string"
      },
      "userlocationgeocode": {
        "Type": "string",
        "SubElements": [
          {
            "Type": "string",
            "Id": "string"
          }
        ],
        "Required": false,
        "Label": "string",
        "Id": "string"
      },
      "hostedauthentication": {
        "Type": "string",
        "SubElements": [
          {
            "Type": "string",
            "Id": "string"
          }
        ],
        "Required": false,
        "Label": "string",
        "Id": "string"
      },
      "photo": {
        "Type": "string",
        "SubElements": [
          {
            "Type": "string",
            "Id": "string"
          }
        ],
        "Required": false,
        "Label": "string",
        "Id": "string"
      },
      "photo_5": {
        "Type": "string",
        "SubElements": [
          {
            "Type": "string",
            "Id": "string"
          }
        ],
        "Required": false,
        "Label": "string",
        "Id": "string"
      },
      "photo_6": {
        "Type": "string",
        "SubElements": [
          {
            "Type": "string",
            "Id": "string"
          }
        ],
        "Required": false,
        "Label": "string",
        "Id": "string"
      }
    },
    "FieldsOrder": [
      "string"
    ],
    "GroupsOrder": [
      "string"
    ]
  },
  "Question": {
    "QuestionSummary": "string",
    "SubmissionTime": "string",
    "SubmissionId": "string",
    "SendEmailAlertWhenAnswered": false,
    "TypicalHoursToPost": "string",
    "QuestionDetails": "string",
    "Id": "string",
    "SendEmailAlertWhenPublished": false
  },
  "TypicalHoursToPost": 0,
  "AuthorSubmissionToken": "string",
  "HasErrors": false
}

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

Was this page helpful?