Get a web form response
get
/fscmRestApi/resources/11.13.18.05/publicSectorWebFormResponses/{LogMessageId}
Request
Path Parameters
-
LogMessageId: integer
The unique identifier of the communication message. This ID generated automatically by the application.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are attributes that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The attributes 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 attributes 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 attributes. 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 attributes. Only the specified attributes are returned, which means that if no attributes are specified, no attributes 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 attributes. 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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Response
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Default Response
The following table describes the default response for this task.
Root Schema : publicSectorWebFormResponses-item
Type:
Show Source
object
-
CreationDate(optional):
string(date-time)
The date and time that the communication message was created.
-
LastUpdateDate(optional):
string(date-time)
The user who last updated the communication message.
-
links(optional):
array Items
Title:
Items
Link Relations -
LogId(optional):
integer(int64)
Title:
Log ID
The unique identifier for the ad hoc communication request. This ID is automatically generated by the application. -
LogMessageId(optional):
integer(int64)
Title:
Log Message ID
The unique identifier of the communication message. This ID generated automatically by the application. -
Status(optional):
string
Title:
Status
Maximum Length:30
The status of the communication message. -
WebForms(optional):
array Web Forms
Title:
Web Forms
The web form responses resource is used to view all web form responses received against communications triggered through ad hoc email and ad hoc notification.
Nested Schema : Web Forms
Type:
array
Title:
Web Forms
The web form responses resource is used to view all web form responses received against communications triggered through ad hoc email and ad hoc notification.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href(optional):
string
Title:
hyperlink reference
The URI to the related resource. -
rel(optional):
string
Title:
relation
The name of the relation to the resource instance. Example: self.
Nested Schema : publicSectorWebFormResponses-WebForms-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int32)
Title:
Agency ID
The unique identifier for the agency associated with the web form. -
AnswerDate(optional):
string(date)
The date and time answer of the web form message.
-
AnswerNumber(optional):
number
The numeric answer of the web form message.
-
AnswerText(optional):
string
Maximum Length:
1000
The text answer of the web form message. -
AnswerType(optional):
string
Title:
Answer Type
Maximum Length:15
The answer type of the web form message. -
CreatedBy(optional):
string
Title:
Created By
Maximum Length:64
The user who created the web form message. -
CreationDate(optional):
string(date-time)
Title:
Creation Date
The creation date of the web form message. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated Date
The date that the web form message was last updated. -
LastUpdatedBy(optional):
string
Title:
Last Updated By
Maximum Length:64
The user who last updated the web form message. -
links(optional):
array Items
Title:
Items
Link Relations -
LogId(optional):
integer(int64)
Title:
Log ID
The unique identifier of the log associated with the web form message. -
LogMessageId(optional):
integer(int64)
Title:
Log Message ID
The unique identifier for the communication message. -
Question(optional):
string
Title:
Question Text
Maximum Length:1000
The question text of the web form message. -
WebformId(optional):
integer(int64)
Title:
Web Form ID
The unique identifier for the web form attached with the communication message. This ID is automatically generated by the application.