Create a survey
post
/crmRestApi/resources/11.13.18.05/surveys
Request
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
-
ConfigId(required): integer
(int64)
Title:
Survey Configuration ID
The identification number of the survey. -
ConfigName(required): string
Title:
Survey Configuration Name
Maximum Length:400
The name of the survey configuration. -
DecisionModelName: string
Title:
Decision Model Name
Maximum Length:400
The name of the survey decision model which is used to determine when to send the survey. -
DecisionModelService: string
Title:
Decision Model Service
Maximum Length:64
The service of the survey decision model which is used to determine when to send the survey. -
DecisionModelSpace: string
Title:
Decision Model Space
Maximum Length:64
The space of the survey decision model which is used to determine when to send the survey. -
DecisionModelSpaceName: string
Title:
Decision Model Space
Maximum Length:64
The space name of the survey decision model which is used to determine when to send the survey. -
DecisionModelVersion: string
Title:
Decision Model Version
Maximum Length:30
The version number of the survey decision model which is used to determine when to send the survey. -
Description: string
Title:
Survey Template Description
Maximum Length:1000
The description of the survey. -
EndDate: string
(date-time)
Title:
Survey End Date
The date the survey is no longer available to send. -
Name(required): string
Title:
Survey Template Name
Maximum Length:400
The name of the survey. -
ObjectTypeCd(required): string
Title:
Object Type
Maximum Length:30
The type of the object associate with the survey. Example -
ObjectVersionNumber: integer
(int32)
Title:
Object Version Number
The version number of the survey. -
questions: array
Survey Questions
Title:
Survey Questions
The questions resource is used to view and update the questions in the survey. -
requests: array
Survey Requests
Title:
Survey Requests
The request resource is used to view and update the survey requests. -
StartDate(required): string
(date-time)
Title:
Survey Start Date
The start date of the survey. -
StripeCd: string
Title:
Stripe Code
Maximum Length:30
The stripe code that's associated to the survey. -
SurveyNumber: string
Title:
Survey Number
Maximum Length:30
The survey number. -
VendorSurveyId(required): string
Title:
Survey Product ID
Maximum Length:1000
This is the product-specific supplier identification number for the survey. -
VendorSurveyName(required): string
Title:
External Survey Name
Maximum Length:64
This is the product-specific name for the survey. For example, SURVEY_MONKEY. -
VendorSurveyURL: string
Title:
External Survey URL
Maximum Length:1000
This is the product-specific url for the survey.
Nested Schema : Survey Questions
Type:
array
Title:
Survey Questions
The questions resource is used to view and update the questions in the survey.
Show Source
Nested Schema : Survey Requests
Type:
array
Title:
Survey Requests
The request resource is used to view and update the survey requests.
Show Source
Nested Schema : surveys-questions-item-post-request
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(required): 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(required): integer
(int64)
Title:
Survey ID
The identification number of the survey of which this question is a part of. -
Text(required): string
Title:
Survey Question Text
Maximum Length:4000
The text of the question. -
VendorQuestionId(required): 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.
Nested Schema : surveys-requests-item-post-request
Type:
Show Source
object
-
ObjectId(required): integer
(int64)
Title:
Survey Request Object ID
The identifier of the object for which the survey will be assigned. Example Service Request ID. -
ObjectTypeCd(required): string
Title:
Survey Request Object Type Code
Maximum Length:30
The type of the object for which the survey will be assigned. Example Service Request, Account. -
ObjectVersionNumber: integer
(int32)
Title:
Object Version Number
The version number of the survey request. -
OwnerId: integer
(int64)
Title:
Owner ID
The person who owns the survey responses. -
PartyId(required): integer
(int64)
Title:
Survey Request Party ID
The identifier of the contact who will receive the survey. -
RespondedFlag(required): boolean
Title:
Survey Request Response Indicator
Maximum Length:1
The indicator that indicates whether survey is answered. -
ResponseDate: string
(date-time)
Title:
Response Date
The date when survey was answered. -
responses: array
Survey Responses
Title:
Survey Responses
The response resource is used to view and update the survey responses. -
SurveyId(required): integer
(int64)
Title:
Survey ID
The key identifier of the survey. -
VendorRequestId: string
Title:
Survey Product Request ID
Maximum Length:64
The key identifier of the external survey product request.
Nested Schema : Survey Responses
Type:
array
Title:
Survey Responses
The response resource is used to view and update the survey responses.
Show Source
Nested 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-item-response
Type:
Show Source
object
-
ConfigId: integer
(int64)
Title:
Survey Configuration ID
The identification number of the survey. -
ConfigName: string
Title:
Survey Configuration Name
Maximum Length:400
The name of the survey configuration. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the survey. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the survey was created -
DecisionModelName: string
Title:
Decision Model Name
Maximum Length:400
The name of the survey decision model which is used to determine when to send the survey. -
DecisionModelService: string
Title:
Decision Model Service
Maximum Length:64
The service of the survey decision model which is used to determine when to send the survey. -
DecisionModelSpace: string
Title:
Decision Model Space
Maximum Length:64
The space of the survey decision model which is used to determine when to send the survey. -
DecisionModelSpaceName: string
Title:
Decision Model Space
Maximum Length:64
The space name of the survey decision model which is used to determine when to send the survey. -
DecisionModelVersion: string
Title:
Decision Model Version
Maximum Length:30
The version number of the survey decision model which is used to determine when to send the survey. -
Description: string
Title:
Survey Template Description
Maximum Length:1000
The description of the survey. -
EndDate: string
(date-time)
Title:
Survey End Date
The date the survey is no longer available to send. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date the survey was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the survey. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login details of the user who last updated the survey. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Title:
Survey Template Name
Maximum Length:400
The name of the survey. -
ObjectTypeCd: string
Title:
Object Type
Maximum Length:30
The type of the object associate with the survey. Example -
ObjectVersionNumber: integer
(int32)
Title:
Object Version Number
The version number of the survey. -
ProductName: string
Title:
Survey Product
Read Only:true
Maximum Length:80
The survey product which a particular survey belongs to, such as SurveyMonkey. -
questions: array
Survey Questions
Title:
Survey Questions
The questions resource is used to view and update the questions in the survey. -
requests: array
Survey Requests
Title:
Survey Requests
The request resource is used to view and update the survey requests. -
StartDate: string
(date-time)
Title:
Survey Start Date
The start date of the survey. -
StripeCd: string
Title:
Stripe Code
Maximum Length:30
The stripe code that's associated to the survey. -
SurveyId: integer
(int64)
Title:
Survey ID
Read Only:true
The survey unique identification number. -
SurveyNumber: string
Title:
Survey Number
Maximum Length:30
The survey number. -
VendorSurveyId: string
Title:
Survey Product ID
Maximum Length:1000
This is the product-specific supplier identification number for the survey. -
VendorSurveyName: string
Title:
External Survey Name
Maximum Length:64
This is the product-specific name for the survey. For example, SURVEY_MONKEY. -
VendorSurveyURL: string
Title:
External Survey URL
Maximum Length:1000
This is the product-specific url for the survey.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Survey Questions
Type:
array
Title:
Survey Questions
The questions resource is used to view and update the questions in the survey.
Show Source
Nested Schema : Survey Requests
Type:
array
Title:
Survey Requests
The request resource is used to view and update the survey requests.
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.
Nested 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 : surveys-requests-item-response
Type:
Show Source
object
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the survey request. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the survey request was created. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date the survey request was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the survey request. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login details of the user who last updated the survey request. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectId: integer
(int64)
Title:
Survey Request Object ID
The identifier of the object for which the survey will be assigned. Example Service Request ID. -
ObjectTypeCd: string
Title:
Survey Request Object Type Code
Maximum Length:30
The type of the object for which the survey will be assigned. Example Service Request, Account. -
ObjectVersionNumber: integer
(int32)
Title:
Object Version Number
The version number of the survey request. -
OwnerId: integer
(int64)
Title:
Owner ID
The person who owns the survey responses. -
PartyId: integer
(int64)
Title:
Survey Request Party ID
The identifier of the contact who will receive the survey. -
RespondedFlag: boolean
Title:
Survey Request Response Indicator
Maximum Length:1
The indicator that indicates whether survey is answered. -
ResponseDate: string
(date-time)
Title:
Response Date
The date when survey was answered. -
responses: array
Survey Responses
Title:
Survey Responses
The response resource is used to view and update the survey responses. -
SurveyId: integer
(int64)
Title:
Survey ID
The key identifier of the survey. -
SurveyRequestId: integer
(int64)
Title:
Survey Request ID
Read Only:true
The key identifier of the survey request. -
SurveyTemplateName: string
Title:
Survey Template Name
Read Only:true
Maximum Length:400
The name of the survey template associated with the survey request. -
VendorRequestId: string
Title:
Survey Product Request ID
Maximum Length:64
The key identifier of the external survey product request.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Survey Responses
Type:
array
Title:
Survey Responses
The response resource is used to view and update the survey responses.
Show Source
Nested 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
Links
- ObjectTypeLookup
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_SVC_SURVEY_OBJECT_TYPE_CD
The following properties are defined on the LOV link relation:- Source Attribute: ObjectTypeCd; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- StripeCodeLookup
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_SVC_STRIPE_CD
The following properties are defined on the LOV link relation:- Source Attribute: StripeCd; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- questions
-
Parameters:
- SurveyId:
$request.path.SurveyId
The questions resource is used to view and update the questions in the survey. - SurveyId:
- requests
-
Parameters:
- SurveyId:
$request.path.SurveyId
The request resource is used to view and update the survey requests. - SurveyId: