Survey Templates
Subcategories: Attachments, Notes
The survey templates resource is used to view, create, update, replace, and delete the name, description, and status of a survey template.
|
Resource Plural Label |
Survey Templates |
|
Resource Name |
__ORACO__SurveyTemplate_c |
Get All Survey Templates
Request: GET
URI: crmCommonApi/resources/<version>/__ORACO__SurveyTemplate_c
Request Path Parameters
There are no request path parameters for this task.
Request Query Parameters
Use these finder parameters to query the resource:
| Finder Name | Description |
|---|---|
|
Primary Key |
Finds a survey template with the specified primary key. Finder Variables:
|
Request Body
There are no elements in the request body for this task.
Response Body
This table summarizes the supported response body content types:
|
Media Type |
application/vnd.oracle.adf.resourcecollection+json |
Create a Survey Template
Request: POST
URI: crmCommonApi/resources/<version>/__ORACO__SurveyTemplate_c
Request Path Parameters
There are no request path parameters for this task.
Request Body
This table summarizes the supported request body content types:
|
Media Type |
application/vnd.oracle.adf.resourcecollection+json |
Response Body
This table summarizes the supported response body content types:
|
Media Type |
application/vnd.oracle.adf.resourcecollection+json |
Get a Survey Template
Request: GET
URI: crmCommonApi/resources/<version>/__ORACO__SurveyTemplate_c/{Id}
Request Path Parameters
This table summarizes the request path parameters:
| Name | Type | Description |
|---|---|---|
|
Id |
integer |
The unique identifier of the survey template. |
Request Body
There are no elements in the request body for this task.
Response Body
This table summarizes the supported response body content types:
|
Media Type |
application/vnd.oracle.adf.resourcecollection+json |
Update a Survey Template
Request: PATCH
URI: crmCommonApi/resources/<version>/__ORACO__SurveyTemplate_c/{Id}
Request Path Parameters
This table summarizes the request path parameters:
| Name | Type | Description |
|---|---|---|
|
Id |
integer |
The unique identifier of the survey template. |
Request Body
This table summarizes the request body content types:
|
Media Type |
application/vnd.oracle.adf.resourcecollection+json |
Response Body
This table summarizes the supported response body content types:
|
Media Type |
application/vnd.oracle.adf.resourcecollection+json |
Replace a Survey Template
Request: PUT
URI: crmCommonApi/resources/<version>/__ORACO__SurveyTemplate_c/{Id}
Request Path Parameters
This table summarizes the request path parameters:
| Name | Type | Description |
|---|---|---|
|
Id |
integer |
The unique identifier of the survey template. |
Request Body
This table summarizes the request body content types:
|
Media Type |
application/vnd.oracle.adf.resourcecollection+json |
Response Body
This table summarizes the supported response body content types:
|
Media Type |
application/vnd.oracle.adf.resourcecollection+json |
Delete a Survey Template
Request: DELETE
URI: crmCommonApi/resources/<version>/__ORACO__SurveyTemplate_c/{Id}
Request Path Parameters
This table summarizes the request path parameters:
| Name | Type | Description |
|---|---|---|
|
Id |
integer |
The unique identifier of the survey template. |
Request Body
There are no elements in the request body for this task.
Response Body
There are no elements in the response body for this task.
List of Values
This table lists all the list of values of the resource.
| LOV Name | Source Attribute in LOV | Target Attribute in Resource |
|---|---|---|
|
ViewAccessor_CurrencyCode |
CurrencyCode |
CurrencyCode |
|
LOVVA_For___ORACO__Repeat_c |
LookupCode |
__ORACO__Repeat_c |
|
FK_LOVVA_For___ORACO__OraZcxOwner_c |
ResourceProfileId |
__ORACO__OraZcxOwner_Id_c |
|
LOVVA_For___ORACO__OraZcxOwner_c |
PartyName |
__ORACO__OraZcxOwner_c |
|
LOVVA_For___ORACO__Status_c |
LookupCode |
__ORACO__Status_c |
|
LOVVA_For___ORACO__FlattenOPAEntity_c |
value |
__ORACO__FlattenOPAEntity_c |
Resource Attributes
This table lists all the attributes of the resource.
| Attribute Name | Attribute Type | Description |
|---|---|---|
|
Id |
integer |
The unique identifier of the survey template. UI Label: Record ID |
|
RowType |
string |
A system-generated read-only attribute used by the application framework. Properties: The maximum length is 80. |
|
RecordName |
string |
The name of the survey template. This should be exactly the same as the name provided in the OPA hub. Properties: The maximum length is 80. UI Label: Name |
|
CreatedBy |
string |
The user who created the survey template. Properties: The maximum length is 32. UI Label: Created By |
|
CreationDate |
datetime |
The date when the survey template was created. UI Label: Creation Date |
|
LastUpdatedBy |
string |
The user who last updated the survey template. Properties: The maximum length is 32. UI Label: Last Updated By |
|
LastUpdateDate |
datetime |
The date when the survey template was last updated. UI Label: Last Update Date |
|
LastUpdateLogin |
string |
The login of the user who last updated the survey template. Properties: The maximum length is 32. |
|
UserLastUpdateDate |
datetime |
A system-generated read-only attribute used by the application framework. Disconnected Mobile: The date and time when the record was last updated from mobile. This value is different from LAST_UPDATE_DATE if the record was originally updated in a different database (a different mobile database or the server). |
|
CurrencyCode |
string |
The currency code. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task. Properties: The maximum length is 15. UI Label: Currency Code |
|
CurcyConvRateType |
string |
The currency conversion rate type. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task. Properties: The maximum length is 15. |
|
CorpCurrencyCode |
string |
The corporate currency code associated with the survey template. This attribute is used by CRM Extensibility framework. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. Properties: The maximum length is 15. |
|
SourceType |
string |
A system-generated read-only attribute used by the application framework. Properties: The maximum length is 0. |
|
__ORACO__OPAPolicyModelName_c |
string |
The name of the policy model from the OPA hub. Properties: The maximum length is 80. UI Label: OPA Policy Model Name |
|
__ORACO__Status_c |
string |
The status of the survey template. The default value is draft. Properties: The maximum length is 1500. UI Label: Status |
|
__ORACO__FlattenOPAEntity_c |
boolean |
Used by mobile app to determine if the responses should be flattened ignoring entity context. Not needed anymore. Properties: The maximum length is 10. UI Label: Use Flattened Entity for Simple Survey |
|
__ORACO__StartDate_c |
date |
The date when the survey begins. The survey is displayed or launched only when an appointment falls after the start date. UI Label: Start Date |
|
__ORACO__EndDate_c |
date |
The date when the survey ends. The survey is not displayed or launched when an appointment falls after the end date. UI Label: End Date |
|
__ORACO__Repeat_c |
string |
Indicates whether the execution of the survey is repeated. The values are daily, weekly, monthly, yearly, quarterly, and none. Properties: The maximum length is 1500. UI Label: Repeat |
|
__ORACO__RepeatInterval_c |
integer |
The frequency at which the survey is to be repeated. The unit of the repeat interval is the value selected in the repeat field. For example, if the repeat field was set to Weekly, the unit of the interval for this field would be Week. UI Label: Repeat Interval |