Get a survey configuration
get
/crmRestApi/resources/11.13.18.05/surveyConfigurations/{ConfigId}
Request
Path Parameters
-
ConfigId(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=
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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.
There's no request body for this operation.
Back to TopResponse
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:
Examples
The following example shows how to get a survey configuration by submitting a get request on the REST resource using cURL.
cURL Command
curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/surveyConfigurations/{ConfigId}
Example of Response Body
The following shows an example of the response body in JSON format.
{ "ConfigId": 300100205501354, "Name": "BIQA_Survey_Config_CDRM_1", "VendorCd": "ORA_SVC_SURVEY_MONKEY", "Description": null, "CreationDate": "2020-04-08T09:09:29+00:00", "CreatedBy": "SALES_ADMIN", "LastUpdateDate": "2020-04-08T09:09:29.540+00:00", "LastUpdatedBy": "SALES_ADMIN", "LastUpdateLogin": "A2695E930113EAC9E0533CFDF40AD639", "ObjectVersionNumber": 1, "SurveyConfigNumber": "CDRM_0000000001", "ProductName": "SurveyMonkey", "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/surveyConfigurations/300100205501354", "name": "surveyConfigurations", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/surveyConfigurations/300100205501354", "name": "surveyConfigurations", "kind": "item" }, { "rel": "lov", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/surveyConfigurations/300100205501354/lov/VendorCodeLookup", "name": "VendorCodeLookup", "kind": "collection" }, { "rel": "child", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/surveyConfigurations/300100205501354/child/configurationAttributes", "name": "configurationAttributes", "kind": "collection" } ] }