Jump to

• Request
• Response

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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "ResponsePageContent":{
            "title":"Response Page Content",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

Back to Top

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.

Body ()

Root Schema : communicationResponses-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ResponseToken":{
            "title":"Response Token",
            "maxLength":"64",
            "type":"string",
            "description":"The unique identifier for a communication response row.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MessageResponseCode":{
            "title":"Message Response Code",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "MessageResponse"
                ]
            }
        },
        "ResponsePageContent":{
            "title":"Response Page Content",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top