Update a survey question
patch
/crmRestApi/resources/11.13.18.05/surveys/{SurveyId}/child/questions/{QuestionId}
Request
Path Parameters
-
QuestionId(required): integer(int64)
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
-
SurveyId(required): integer(int64)
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
answerChoices: array
Survey Answer Choices
Title:
Survey Answer Choices
The answer choices resource is used to view and update the answer choices in the survey. -
ObjectVersionNumber: integer
(int32)
Title:
Object Version Number
The version number of the survey question. -
QuestionTypeCd: string
Title:
Survey Question Type Code
Maximum Length:30
The question type of the survey question, such as Select One Choice, Text, and so on. -
Text: string
Title:
Survey Question Text
Maximum Length:4000
The text of the question. -
VendorQuestionId: string
Title:
Survey Product Question ID
Maximum Length:64
The external product question identification number.
Nested Schema : Survey Answer Choices
Type:
array
Title:
Survey Answer Choices
The answer choices resource is used to view and update the answer choices in the survey.
Show Source
Nested Schema : schema
Type:
Show Source
object
-
ObjectVersionNumber: integer
(int32)
Title:
Object Version Number
The version number of the survey answer choices. -
Text: string
Title:
Survey Answer Text
Maximum Length:4000
The text of the answer choice. -
VendorAnswerId: string
Title:
Survey Product Answer ID
Maximum Length:64
The external product answer choice identification number.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : surveys-questions-item-response
Type:
Show Source
object
-
answerChoices: array
Survey Answer Choices
Title:
Survey Answer Choices
The answer choices resource is used to view and update the answer choices in the survey. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the survey question. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the survey question was created. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date the survey question was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the survey question. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login details of the user who last updated the survey question. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
Title:
Object Version Number
The version number of the survey question. -
QuestionId: integer
(int64)
Title:
Survey Question ID
Read Only:true
The identification number of the survey question. -
QuestionTypeCd: string
Title:
Survey Question Type Code
Maximum Length:30
The question type of the survey question, such as Select One Choice, Text, and so on. -
SurveyId: integer
(int64)
Title:
Survey ID
The identification number of the survey of which this question is a part of. -
Text: string
Title:
Survey Question Text
Maximum Length:4000
The text of the question. -
VendorQuestionId: string
Title:
Survey Product Question ID
Maximum Length:64
The external product question identification number.
Nested Schema : Survey Answer Choices
Type:
array
Title:
Survey Answer Choices
The answer choices resource is used to view and update the answer choices in the survey.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : surveys-questions-answerChoices-item-response
Type:
Show Source
object
-
AnswerId: integer
(int64)
Title:
Survey Answer ID
Read Only:true
The answer choice identification number. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the survey answer choices. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the survey answer choices was created. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date the survey answer choices was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the survey answer choices. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login details of the user who last updated the survey answer choices. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
Title:
Object Version Number
The version number of the survey answer choices. -
QuestionId: integer
(int64)
Title:
Survey Question ID
Read Only:true
The identification number of the question of which this answer choice is a part of. -
Text: string
Title:
Survey Answer Text
Maximum Length:4000
The text of the answer choice. -
VendorAnswerId: string
Title:
Survey Product Answer ID
Maximum Length:64
The external product answer choice identification number.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Links
- QuestionTypeLookup
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_SVC_SURVEY_QUES_TYPE_CD
The following properties are defined on the LOV link relation:- Source Attribute: QuestionTypeCd; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- answerChoices
-
Parameters:
- QuestionId:
$request.path.QuestionId
- SurveyId:
$request.path.SurveyId
The answer choices resource is used to view and update the answer choices in the survey. - QuestionId: