Jump to

• Request
• Response

Send notifications to resources

post

/crmRestApi/resources/11.13.18.05/activityTemplates/{TemplateId}/child/Activity/action/sendNotificationToResources

This method lets you send notification to resources along with the details of the interaction.

Request

Path Parameters

• TemplateId(required): integer(int64)
  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/vnd.oracle.adf.action+json

Request Body - application/vnd.oracle.adf.action+json ()

Root Schema : schema

Type: object

Show Source

• atkNotificationData: object atkNotificationData
  Additional Properties Allowed: additionalProperties

  The notification content of the interaction.
• emailData: object emailData
  Additional Properties Allowed: additionalProperties

  The content of the email.
• emailRecipients: array emailRecipients
  Email addresses of the recipient.
• resourceIds: array resourceIds
  The notification content of the interaction.

{
    "type":"object",
    "properties":{
        "atkNotificationData":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            },
            "description":"The notification content of the interaction.",
            "nullable":true
        },
        "emailRecipients":{
            "type":"array",
            "description":"Email addresses of the recipient.",
            "nullable":true,
            "items":{
                "type":"string"
            }
        },
        "emailData":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            },
            "description":"The content of the email.",
            "nullable":true
        },
        "resourceIds":{
            "type":"array",
            "description":"The notification content of the interaction.",
            "nullable":true,
            "items":{
                "type":"number"
            }
        }
    },
    "additionalProperties":false
}

Nested Schema : atkNotificationData

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    },
    "description":"The notification content of the interaction.",
    "nullable":true
}

The notification content of the interaction.

Nested Schema : emailData

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    },
    "description":"The content of the email.",
    "nullable":true
}

The content of the email.

Nested Schema : emailRecipients

Type: array

Email addresses of the recipient.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Email addresses of the recipient.",
    "nullable":true,
    "items":{
        "type":"string"
    }
}

Nested Schema : resourceIds

Type: array

The notification content of the interaction.

Show Source

• Array of: number

{
    "type":"array",
    "description":"The notification content of the interaction.",
    "nullable":true,
    "items":{
        "type":"number"
    }
}

Back to Top

Response

Supported Media Types

• application/json
• application/vnd.oracle.adf.actionresult+json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : schema

Type: object

Show Source

• result(required): object result
  Additional Properties Allowed: additionalProperties

  Returns the ATK message identifier.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            },
            "description":"Returns the ATK message identifier."
        }
    },
    "additionalProperties":false
}

Nested Schema : result

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    },
    "description":"Returns the ATK message identifier."
}

Returns the ATK message identifier.

Back to Top