Create an ad hoc email
post
/fscmRestApi/resources/11.13.18.05/publicSectorAdhocEmails
Request
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
The following table describes the body parameters in the request for this task.
Root Schema : publicSectorAdhocEmails-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int32)
Title:
Agency ID
The unique identifier of the agency associated with the ad hoc email. -
BccAddress(optional):
string
Title:
Bcc Email Address
The email addresses of the ad hoc email's blind copied recipients. -
Body(optional):
string
Title:
Body
The body of the ad hoc email. -
CcAddress(optional):
string
Title:
Cc Email Address
The email addresses of the ad hoc email's copied recipients. -
CreatedBy(optional):
string
Title:
Created By
Maximum Length:64
The user who created the ad hoc email request. -
CreationDate(optional):
string(date-time)
Title:
Creation Date
The date and time that the ad hoc email request was created. -
EventId(optional):
integer(int64)
Title:
Event ID
The unique identifier for the communication event. -
FromAddress(optional):
string
Title:
From Address
The sender address of the ad hoc email. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated Date
The date that the ad hoc email request was last updated. -
LastUpdatedBy(optional):
string
Title:
Last Updated By
Maximum Length:64
The user who last updated the communication ad hoc email request. -
links(optional):
array Items
Title:
Items
Link Relations -
Log(optional):
string
Title:
Error Text
The communication ad hoc email request error details. -
LogId(optional):
integer(int64)
Title:
Log ID
The unique identifier for the communication ad hoc email. This ID is automatically generated by the application. -
MimeType(optional):
string
Title:
Mime Type
The MIME type of the ad hoc email message. The possible values are HTML and Text. -
PayloadData(optional):
string
The data payload provided with ad hoc email request.
-
PreferredLanguage(optional):
string
Title:
Message Language
The language used for the email message. -
RecordFifthKeyName(optional):
string
Title:
Record Fifth Key Name
Maximum Length:32
The fifth key name of the communication resource associated with the event. -
RecordFifthKeyValue(optional):
string
Title:
Record Fifth Key Value
Maximum Length:100
The fifth key value of the communication resource associated with the event. -
RecordFirstKeyName(optional):
string
Title:
Record First Key Name
Maximum Length:32
The first key name of the communication resource associated with the event. -
RecordFirstKeyValue(optional):
string
Title:
Record First Key Value
Maximum Length:100
The first key value of the communication resource associated with the event. -
RecordFourthKeyName(optional):
string
Title:
Record Fourth Key Name
Maximum Length:32
The fourth key name of the communication resource associated with the event. -
RecordFourthKeyValue(optional):
string
Title:
Record Fourth Key Value
Maximum Length:100
The fourth key value of the communication resource associated with the event. -
RecordIdentifier(optional):
string
Title:
Record Identifier
Maximum Length:100
The communication request identifier passed through the communication request. -
RecordSecondKeyName(optional):
string
Title:
Record Second Key Name
Maximum Length:32
The second key name of the communication resource associated with the event. -
RecordSecondKeyValue(optional):
string
Title:
Record Second Key Value
Maximum Length:100
The second key value of the communication resource associated with the event. -
RecordSubIdentifier(optional):
string
Title:
Record Sub Identifier
Maximum Length:100
The communication request sub identifier passed through the communication request. -
RecordThirdKeyName(optional):
string
Title:
Record Third Key Name
Maximum Length:32
The third key name of the communication resource associated with the event. -
RecordThirdKeyValue(optional):
string
Title:
Record Third Key Value
Maximum Length:100
The third key value of the communication resource associated with the event. -
ResourceEndPoint(optional):
string
Title:
Resource Endpoint
The communication resource REST endpoint for generating data payload to replace parameters from the ad hoc email. -
Status(optional):
string
Title:
Status
Maximum Length:30
The status of the ad hoc email request. -
Subject(optional):
string
Title:
Subject
The subject of the ad hoc email. -
ToAddress(optional):
string
Title:
To Email Address
The email addresses of the ad hoc email's primary recipients. -
Visibility(optional):
string
Title:
Visibility
The visibility option of the triggered ad hoc email. -
WebFormData(optional):
string
The web form details attached to the email.
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.
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 : publicSectorAdhocEmails-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int32)
Title:
Agency ID
The unique identifier of the agency associated with the ad hoc email. -
BccAddress(optional):
string
Title:
Bcc Email Address
The email addresses of the ad hoc email's blind copied recipients. -
Body(optional):
string
Title:
Body
The body of the ad hoc email. -
CcAddress(optional):
string
Title:
Cc Email Address
The email addresses of the ad hoc email's copied recipients. -
CreatedBy(optional):
string
Title:
Created By
Maximum Length:64
The user who created the ad hoc email request. -
CreationDate(optional):
string(date-time)
Title:
Creation Date
The date and time that the ad hoc email request was created. -
EventId(optional):
integer(int64)
Title:
Event ID
The unique identifier for the communication event. -
FromAddress(optional):
string
Title:
From Address
The sender address of the ad hoc email. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated Date
The date that the ad hoc email request was last updated. -
LastUpdatedBy(optional):
string
Title:
Last Updated By
Maximum Length:64
The user who last updated the communication ad hoc email request. -
links(optional):
array Items
Title:
Items
Link Relations -
Log(optional):
string
Title:
Error Text
The communication ad hoc email request error details. -
LogId(optional):
integer(int64)
Title:
Log ID
The unique identifier for the communication ad hoc email. This ID is automatically generated by the application. -
MimeType(optional):
string
Title:
Mime Type
The MIME type of the ad hoc email message. The possible values are HTML and Text. -
PayloadData(optional):
string
The data payload provided with ad hoc email request.
-
PreferredLanguage(optional):
string
Title:
Message Language
The language used for the email message. -
RecordFifthKeyName(optional):
string
Title:
Record Fifth Key Name
Maximum Length:32
The fifth key name of the communication resource associated with the event. -
RecordFifthKeyValue(optional):
string
Title:
Record Fifth Key Value
Maximum Length:100
The fifth key value of the communication resource associated with the event. -
RecordFirstKeyName(optional):
string
Title:
Record First Key Name
Maximum Length:32
The first key name of the communication resource associated with the event. -
RecordFirstKeyValue(optional):
string
Title:
Record First Key Value
Maximum Length:100
The first key value of the communication resource associated with the event. -
RecordFourthKeyName(optional):
string
Title:
Record Fourth Key Name
Maximum Length:32
The fourth key name of the communication resource associated with the event. -
RecordFourthKeyValue(optional):
string
Title:
Record Fourth Key Value
Maximum Length:100
The fourth key value of the communication resource associated with the event. -
RecordIdentifier(optional):
string
Title:
Record Identifier
Maximum Length:100
The communication request identifier passed through the communication request. -
RecordSecondKeyName(optional):
string
Title:
Record Second Key Name
Maximum Length:32
The second key name of the communication resource associated with the event. -
RecordSecondKeyValue(optional):
string
Title:
Record Second Key Value
Maximum Length:100
The second key value of the communication resource associated with the event. -
RecordSubIdentifier(optional):
string
Title:
Record Sub Identifier
Maximum Length:100
The communication request sub identifier passed through the communication request. -
RecordThirdKeyName(optional):
string
Title:
Record Third Key Name
Maximum Length:32
The third key name of the communication resource associated with the event. -
RecordThirdKeyValue(optional):
string
Title:
Record Third Key Value
Maximum Length:100
The third key value of the communication resource associated with the event. -
ResourceEndPoint(optional):
string
Title:
Resource Endpoint
The communication resource REST endpoint for generating data payload to replace parameters from the ad hoc email. -
Status(optional):
string
Title:
Status
Maximum Length:30
The status of the ad hoc email request. -
Subject(optional):
string
Title:
Subject
The subject of the ad hoc email. -
ToAddress(optional):
string
Title:
To Email Address
The email addresses of the ad hoc email's primary recipients. -
Visibility(optional):
string
Title:
Visibility
The visibility option of the triggered ad hoc email. -
WebFormData(optional):
string
The web form details attached to the email.
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.