Create a survey configuration
post
/crmRestApi/resources/11.13.18.05/surveyConfigurations
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
-
configurationAttributes: array
Survey Configuration Attributes
Title:
Survey Configuration Attributes
The survey configuration attribute resource is used to create, read, update and delete the attributes associated to the survey configuration. -
Description: string
Title:
Survey Configuration Description
Maximum Length:1000
The description of the survey configuration. -
Name(required): string
Title:
Survey Configuration Name
Maximum Length:400
The name of the survey configuration. -
ObjectVersionNumber: integer
(int32)
Title:
Object Version Number
The version number of the survey configuration. -
SurveyConfigNumber: string
Maximum Length:
30
This number is an auto-generated unique number that's used for import and export of Survey Configurations. -
VendorCd(required): string
Title:
Survey Product
Maximum Length:30
This is the product-specific code for the survey. For example, SURVEY_MONKEY.
Nested Schema : Survey Configuration Attributes
Type:
array
Title:
Survey Configuration Attributes
The survey configuration attribute resource is used to create, read, update and delete the attributes associated to the survey configuration.
Show Source
Nested Schema : schema
Type:
Show Source
object
-
AttributeCd: string
Title:
Survey Configuration Attribute Code
Maximum Length:30
This is the type of the survey configuration attribute. For example, SURVEY_LIST_API, or SURVEY_DETAIL_API. -
AttributeValue: string
Title:
Survey Configuration Attribute Value
Maximum Length:4000
This is the value of the survey configuration attribute. -
ObjectVersionNumber: integer
(int32)
Title:
Object Version Number
The version number of the survey configuration attribute.
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 : surveyConfigurations-item-response
Type:
Show Source
object
-
ConfigId: integer
(int64)
Title:
Survey Configuration ID
Read Only:true
The unique identifier of the survey configuration. -
configurationAttributes: array
Survey Configuration Attributes
Title:
Survey Configuration Attributes
The survey configuration attribute resource is used to create, read, update and delete the attributes associated to the survey configuration. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the survey configuration. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the survey configuration was created. -
Description: string
Title:
Survey Configuration Description
Maximum Length:1000
The description of the survey configuration. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the survey configuration was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the survey configuration. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login details of the user who last updated the survey configuration. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Title:
Survey Configuration Name
Maximum Length:400
The name of the survey configuration. -
ObjectVersionNumber: integer
(int32)
Title:
Object Version Number
The version number of the survey configuration. -
ProductName: string
Title:
Survey Product
Read Only:true
Maximum Length:80
The survey product which a particular survey belongs to, such as Survey Monkey. -
SurveyConfigNumber: string
Maximum Length:
30
This number is an auto-generated unique number that's used for import and export of Survey Configurations. -
VendorCd: string
Title:
Survey Product
Maximum Length:30
This is the product-specific code for the survey. For example, SURVEY_MONKEY.
Nested Schema : Survey Configuration Attributes
Type:
array
Title:
Survey Configuration Attributes
The survey configuration attribute resource is used to create, read, update and delete the attributes associated to the survey configuration.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : surveyConfigurations-configurationAttributes-item-response
Type:
Show Source
object
-
AttributeCd: string
Title:
Survey Configuration Attribute Code
Maximum Length:30
This is the type of the survey configuration attribute. For example, SURVEY_LIST_API, or SURVEY_DETAIL_API. -
AttributeValue: string
Title:
Survey Configuration Attribute Value
Maximum Length:4000
This is the value of the survey configuration attribute. -
ConfigAttrId: integer
(int64)
Title:
Survey Configuration Attribute ID
Read Only:true
This is the identifier of the survey configuration attribute. -
ConfigId: integer
(int64)
Title:
Survey Configuration ID
Read Only:true
This is the unique identifier of the survey configuration attribute. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the survey configuration attribute. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the survey configuration attribute was created. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the survey configuration attribute was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the survey configuration attribute. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login details of the user who last updated the survey configuration attribute. -
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 configuration attribute. -
SurveyConfigNumber: string
Read Only:
true
Maximum Length:30
This number is an auto-generated unique number that's used for import and export of Survey Configuration Attributes.
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
- VendorCodeLookup
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_SVC_SURVEY_VENDOR_TYPE_CD
The following properties are defined on the LOV link relation:- Source Attribute: VendorCd; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- configurationAttributes
-
Operation: /crmRestApi/resources/11.13.18.05/surveyConfigurations/{ConfigId}/child/configurationAttributesParameters:
- ConfigId:
$request.path.ConfigId
The survey configuration attribute resource is used to create, read, update and delete the attributes associated to the survey configuration. - ConfigId: