Update a communication response row
patch
/fscmRestApi/resources/11.13.18.05/communicationResponses/{ResponseToken}
Request
Path Parameters
-
ResponseToken(required): string
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=
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
-
ResponsePageContent: string
Title:
Response Page Content
The content to be used by the consent page based on the action taken by the recipient. The content can have multiple sections like Header, Message, Confirmation and Button.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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(required):
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 : communicationResponses-item-response
Type:
Show Source
object
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MessageResponseCode: string
Title:
Message Response Code
Read Only:true
The response provided by the recipient to an actionable email. For example, values can be ORA_HEY_COMM_ACTION_ACCEPT and ORA_HEY_COMM_ACTION_DENY. A list of accepted values is defined in the lookup type ORA_HEY_COMM_ACTION_TYPE. -
ResponsePageContent: string
Title:
Response Page Content
The content to be used by the consent page based on the action taken by the recipient. The content can have multiple sections like Header, Message, Confirmation and Button. -
ResponseToken: string
Title:
Response Token
Read Only:true
Maximum Length:64
The unique identifier for a communication response row.
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.