afv-library/skills/platform-data-and-tooling-api-context-get/assets/enterprise_api/SurveyQuestionResponse.json

194 lines
5.9 KiB
JSON
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

{
"sections": [
"title",
"description",
"fields",
"associated_objects",
"field_reference"
],
"title": "SurveyQuestionResponse - Data API",
"description": "Represents a participants answer to a specific question.",
"fields_columns": [
"type",
"properties",
"description"
],
"fields": {
"ChoiceValue": {
"type": "textarea",
"properties": "Filter, Nillable, Sort",
"description": "Response provided by a participant for the following question types: Multiple choice Picklist Radio Ranking"
},
"Datatype": {
"properties": "Filter, Group, Nillable, Restricted picklist, Sort",
"description": "The data type of the question response. Possible values are: Boolean This value is available in API v49.0 and later. Date Double Int Number String"
},
"DateTimeValue": {
"type": "dateTime",
"properties": "Filter, Nillable, Sort",
"description": "Response provided by a participant for a question of the type date time."
},
"DateValue": {
"type": "date",
"properties": "Filter, Group, Nillable, Sort",
"description": "Response provided by a participant for a question of the type date."
},
"InvitationId": {
"type": "reference",
"properties": "Filter, Group, Nillable, Sort",
"description": "The ID of the SurveyInvitation that was sent to the survey participant."
},
"IsTrueOrFalse": {
"type": "boolean",
"properties": "Defaulted on create, Filter, Group, Sort",
"description": "Response provided by a participant for a question type which has only two possible values: True and False."
},
"NumberValue": {
"type": "int",
"properties": "Filter, Group, Nillable, Sort",
"description": "Response provided by a participant for the following question types: Net Promoter Score (NPS) Rating Score Slider"
},
"QuestionChoiceId": {
"type": "reference",
"properties": "Filter, Group, Nillable, Sort",
"description": "The ID of SurveyQuestionChoice that a participant chose in response to a question."
},
"QuestionId": {
"type": "reference",
"properties": "Filter, Group, Nillable, Sort",
"description": "The ID of the SurveyQuestion that a participant provided an answer for."
},
"Rank": {
"type": "int",
"properties": "Filter, Group, Nillable, Sort",
"description": "Rank provided by a participant for an answer choice for the ranking question type."
},
"ResponseId": {
"type": "reference",
"properties": "Filter, Group, Sort",
"description": "The ID of the SurveyResponse that is the parent of this SurveyQuestionResponse."
},
"ResponseShortText": {
"type": "string",
"properties": "Filter, Group, idLookup, Sort",
"description": "Up to the first 250 characters of the response provided by a participant for a text type question."
},
"ResponseValue": {
"type": "textarea",
"properties": "Nillable",
"description": "Response provided by a participant for a question."
},
"SurveyVersionId": {
"type": "reference",
"properties": "Filter, Group, Sort",
"description": "The ID of the SurveyVersion that the response belongs to."
}
},
"associated_objects": "This object has the following associated objects. If the API version isnt specified, theyre available in the same API versions as this object. Otherwise, theyre available in the specified API version and later.\n\n- **SurveyQuestionResponseChangeEvent**: Change events are available for the object.",
"field_reference": {
"ChoiceValue": {
"field_label": "Choice Value",
"type": "textarea",
"length": "1000"
},
"CreatedById": {
"field_label": "Created By ID",
"type": "reference",
"length": "18"
},
"CreatedDate": {
"field_label": "Created Date",
"type": "datetime"
},
"Datatype": {
"field_label": "Data Type",
"type": "picklist",
"length": "255"
},
"DateTimeValue": {
"field_label": "Date Time Value",
"type": "datetime"
},
"DateValue": {
"field_label": "Date Value",
"type": "date"
},
"Id": {
"field_label": "Survey Question Response ID",
"type": "id",
"length": "18"
},
"InvitationId": {
"field_label": "Survey Invitation ID",
"type": "reference",
"length": "18"
},
"IsDeleted": {
"field_label": "Deleted",
"type": "boolean"
},
"IsTrueOrFalse": {
"field_label": "True or False",
"type": "boolean"
},
"LastModifiedById": {
"field_label": "Last Modified By ID",
"type": "reference",
"length": "18"
},
"LastModifiedDate": {
"field_label": "Last Modified Date",
"type": "datetime"
},
"NumberValue": {
"field_label": "Number Value",
"type": "int",
"digits": "9"
},
"QuestionChoiceId": {
"field_label": "Survey Question Choice ID",
"type": "reference",
"length": "18"
},
"QuestionId": {
"field_label": "Survey Question ID",
"type": "reference",
"length": "18"
},
"Rank": {
"field_label": "Rank",
"type": "int",
"digits": "9"
},
"ResponseId": {
"field_label": "Survey Response ID",
"type": "reference",
"length": "18"
},
"ResponseShortText": {
"field_label": "Name",
"type": "string",
"length": "255"
},
"ResponseValue": {
"field_label": "Response Value",
"type": "textarea",
"length": "32000"
},
"SurveyVersionId": {
"field_label": "Survey Version ID",
"type": "reference",
"length": "18"
},
"SystemModstamp": {
"field_label": "System Modstamp",
"type": "datetime"
}
},
"field_reference_columns": [
"field_label",
"type",
"length",
"digits"
]
}