Update a web form response
patch
/fscmRestApi/resources/11.13.18.05/publicSectorWebFormResponses/{LogMessageId}
Request
Path Parameters
-
LogMessageId(required): integer(int64)
The unique identifier of the communication message. This ID generated automatically by the application.
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
LogId(required): integer
(int64)
Title:
Log ID
The unique identifier for the ad hoc communication request. This ID is automatically generated by the application. -
Status: string
Title:
Status
Maximum Length:30
The status of the communication message. -
WebForms: array
Web Forms
Title:
Web Forms
The web forms resource is used to view web form details associated with the communications triggered through ad hoc emails and ad hoc notifications.
Nested Schema : Web Forms
Type:
array
Title:
Web Forms
The web forms resource is used to view web form details associated with the communications triggered through ad hoc emails and ad hoc notifications.
Show Source
Nested Schema : publicSectorWebFormResponses-WebForms-item-patch-request
Type:
Show Source
object
-
AnswerDate: string
(date)
The date and time answer of the web form message.
-
AnswerNumber: number
The numeric answer of the web form message.
-
AnswerText: string
Maximum Length:
1000
The text answer of the web form message.
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 : publicSectorWebFormResponses-item-response
Type:
Show Source
object
-
CreationDate: string
(date-time)
Read Only:
true
The date and time that the communication message was created. -
LastUpdateDate: string
(date-time)
Read Only:
true
The user who last updated the communication message. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LogId: integer
(int64)
Title:
Log ID
The unique identifier for the ad hoc communication request. This ID is automatically generated by the application. -
LogMessageId: integer
(int64)
Title:
Log Message ID
Read Only:true
The unique identifier of the communication message. This ID generated automatically by the application. -
Status: string
Title:
Status
Maximum Length:30
The status of the communication message. -
WebForms: array
Web Forms
Title:
Web Forms
The web forms resource is used to view web form details associated with the communications triggered through ad hoc emails and ad hoc notifications.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Web Forms
Type:
array
Title:
Web Forms
The web forms resource is used to view web form details associated with the communications triggered through ad hoc emails and ad hoc notifications.
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 : publicSectorWebFormResponses-WebForms-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Title:
Agency ID
Default Value:1
The unique identifier for the agency associated with the web form. -
AnswerDate: string
(date)
The date and time answer of the web form message.
-
AnswerNumber: number
The numeric answer of the web form message.
-
AnswerText: string
Maximum Length:
1000
The text answer of the web form message. -
AnswerType: string
Title:
Answer Type
Maximum Length:15
The answer type of the web form message. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the web form message. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The creation date of the web form message. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date that the web form message was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the web form message. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LogId: integer
(int64)
Title:
Log ID
Read Only:true
The unique identifier of the log associated with the web form message. -
LogMessageId: integer
(int64)
Title:
Log Message ID
The unique identifier for the communication message. -
Question: string
Title:
Question Text
Maximum Length:1000
The question text of the web form message. -
WebformId: integer
(int64)
Title:
Web Form ID
Read Only:true
The unique identifier for the web form attached with the communication message. This ID is automatically generated by the application.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- WebForms
-
Operation: /fscmRestApi/resources/11.13.18.05/publicSectorWebFormResponses/{LogMessageId}/child/WebFormsParameters:
- LogMessageId:
$request.path.LogMessageId
The web forms resource is used to view web form details associated with the communications triggered through ad hoc emails and ad hoc notifications. - LogMessageId: