Create a survey response
post
/crmRestApi/resources/11.13.18.05/surveys/{SurveyId}/child/requests/{SurveyRequestId}/child/responses
Request
Path Parameters
-
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=
-
SurveyRequestId(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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
AnswerId: integer
(int64)
Title:
Survey Answer ID
The key identifier of the answer choice. -
ObjectVersionNumber: integer
(int32)
Title:
Object Version Number
The version number of the survey response. -
QuestionId: integer
(int64)
Title:
Survey Question ID
The question identification number of the question for this response. -
SurveyRequestId: integer
(int64)
Title:
Survey Request ID
The survey request identification number for this response. -
Text: string
(byte)
Title:
Survey Response Text
The text response included in the survey.
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-requests-responses-item-response
Type:
Show Source
object
-
Answer: string
Title:
Survey Answer Text
Read Only:true
Maximum Length:4000
The answer for this survey response. -
AnswerId: integer
(int64)
Title:
Survey Answer ID
The key identifier of the answer choice. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the survey responses. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the survey response was created. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date the survey response was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the survey response. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login details of the user who last updated the survey response. -
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 response. -
Question: string
Title:
Survey Question Text
Read Only:true
Maximum Length:4000
The question for this survey response. -
QuestionId: integer
(int64)
Title:
Survey Question ID
The question identification number of the question for this response. -
SurveyRequestId: integer
(int64)
Title:
Survey Request ID
The survey request identification number for this response. -
SurveyResponseId: integer
(int64)
Title:
Survey Response ID
Read Only:true
The identification number of a survey response. -
Text: string
(byte)
Title:
Survey Response Text
The text response included in the survey.
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.