Jump to

• Request
• Response

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

Body ()

The following table describes the body parameters in the request for this task.

Root Schema : publicSectorAdhocEmails-item

Type: object

Show Source

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

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The unique identifier of the agency associated with the ad hoc email.",
            "title":"Agency ID"
        },
        "BccAddress":{
            "type":"string",
            "description":"The email addresses of the ad hoc email's blind copied recipients.",
            "title":"Bcc Email Address"
        },
        "Body":{
            "type":"string",
            "description":"The body of the ad hoc email.",
            "title":"Body"
        },
        "CcAddress":{
            "type":"string",
            "description":"The email addresses of the ad hoc email's copied recipients.",
            "title":"Cc Email Address"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the ad hoc email request.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time that the ad hoc email request was created.",
            "title":"Creation Date"
        },
        "EventId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for the communication event.",
            "title":"Event ID"
        },
        "FromAddress":{
            "type":"string",
            "description":"The sender address of the ad hoc email.",
            "title":"From Address"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date that the ad hoc email request was last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the communication ad hoc email request.",
            "title":"Last Updated By"
        },
        "Log":{
            "type":"string",
            "description":"The communication ad hoc email request error details.",
            "title":"Error Text"
        },
        "LogId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for the communication ad hoc email. This ID is automatically generated by the application.",
            "title":"Log ID"
        },
        "MimeType":{
            "type":"string",
            "description":"The MIME type of the ad hoc email message. The possible values are HTML and Text.",
            "title":"Mime Type"
        },
        "PayloadData":{
            "type":"string",
            "description":"The data payload provided with ad hoc email request."
        },
        "PreferredLanguage":{
            "type":"string",
            "description":"The language used for the email message.",
            "title":"Message Language"
        },
        "RecordFifthKeyName":{
            "maxLength":32,
            "type":"string",
            "description":"The fifth key name of the communication resource associated with the event.",
            "title":"Record Fifth Key Name"
        },
        "RecordFifthKeyValue":{
            "maxLength":100,
            "type":"string",
            "description":"The fifth key value of the communication resource associated with the event.",
            "title":"Record Fifth Key Value"
        },
        "RecordFirstKeyName":{
            "maxLength":32,
            "type":"string",
            "description":"The first key name of the communication resource associated with the event.",
            "title":"Record First Key Name"
        },
        "RecordFirstKeyValue":{
            "maxLength":100,
            "type":"string",
            "description":"The first key value of the communication resource associated with the event.",
            "title":"Record First Key Value"
        },
        "RecordFourthKeyName":{
            "maxLength":32,
            "type":"string",
            "description":"The fourth key name of the communication resource associated with the event.",
            "title":"Record Fourth Key Name"
        },
        "RecordFourthKeyValue":{
            "maxLength":100,
            "type":"string",
            "description":"The fourth key value of the communication resource associated with the event.",
            "title":"Record Fourth Key Value"
        },
        "RecordIdentifier":{
            "maxLength":100,
            "type":"string",
            "description":"The communication request identifier passed through the communication request.",
            "title":"Record Identifier"
        },
        "RecordSecondKeyName":{
            "maxLength":32,
            "type":"string",
            "description":"The second key name of the communication resource associated with the event.",
            "title":"Record Second Key Name"
        },
        "RecordSecondKeyValue":{
            "maxLength":100,
            "type":"string",
            "description":"The second key value of the communication resource associated with the event.",
            "title":"Record Second Key Value"
        },
        "RecordSubIdentifier":{
            "maxLength":100,
            "type":"string",
            "description":"The communication request sub identifier passed through the communication request.",
            "title":"Record Sub Identifier"
        },
        "RecordThirdKeyName":{
            "maxLength":32,
            "type":"string",
            "description":"The third key name of the communication resource associated with the event.",
            "title":"Record Third Key Name"
        },
        "RecordThirdKeyValue":{
            "maxLength":100,
            "type":"string",
            "description":"The third key value of the communication resource associated with the event.",
            "title":"Record Third Key Value"
        },
        "ResourceEndPoint":{
            "type":"string",
            "description":"The communication resource REST endpoint for generating data payload to replace parameters from the ad hoc email.",
            "title":"Resource Endpoint"
        },
        "Status":{
            "maxLength":30,
            "type":"string",
            "description":"The status of the ad hoc email request.",
            "title":"Status"
        },
        "Subject":{
            "type":"string",
            "description":"The subject of the ad hoc email.",
            "title":"Subject"
        },
        "ToAddress":{
            "type":"string",
            "description":"The email addresses of the ad hoc email's primary recipients.",
            "title":"To Email Address"
        },
        "Visibility":{
            "type":"string",
            "description":"The visibility option of the triggered ad hoc email.",
            "title":"Visibility"
        },
        "WebFormData":{
            "type":"string",
            "description":"The web form details attached to the email."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

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

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top

Response

Supported Media Types

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

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : publicSectorAdhocEmails-item

Type: object

Show Source

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

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The unique identifier of the agency associated with the ad hoc email.",
            "title":"Agency ID"
        },
        "BccAddress":{
            "type":"string",
            "description":"The email addresses of the ad hoc email's blind copied recipients.",
            "title":"Bcc Email Address"
        },
        "Body":{
            "type":"string",
            "description":"The body of the ad hoc email.",
            "title":"Body"
        },
        "CcAddress":{
            "type":"string",
            "description":"The email addresses of the ad hoc email's copied recipients.",
            "title":"Cc Email Address"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the ad hoc email request.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time that the ad hoc email request was created.",
            "title":"Creation Date"
        },
        "EventId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for the communication event.",
            "title":"Event ID"
        },
        "FromAddress":{
            "type":"string",
            "description":"The sender address of the ad hoc email.",
            "title":"From Address"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date that the ad hoc email request was last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the communication ad hoc email request.",
            "title":"Last Updated By"
        },
        "Log":{
            "type":"string",
            "description":"The communication ad hoc email request error details.",
            "title":"Error Text"
        },
        "LogId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for the communication ad hoc email. This ID is automatically generated by the application.",
            "title":"Log ID"
        },
        "MimeType":{
            "type":"string",
            "description":"The MIME type of the ad hoc email message. The possible values are HTML and Text.",
            "title":"Mime Type"
        },
        "PayloadData":{
            "type":"string",
            "description":"The data payload provided with ad hoc email request."
        },
        "PreferredLanguage":{
            "type":"string",
            "description":"The language used for the email message.",
            "title":"Message Language"
        },
        "RecordFifthKeyName":{
            "maxLength":32,
            "type":"string",
            "description":"The fifth key name of the communication resource associated with the event.",
            "title":"Record Fifth Key Name"
        },
        "RecordFifthKeyValue":{
            "maxLength":100,
            "type":"string",
            "description":"The fifth key value of the communication resource associated with the event.",
            "title":"Record Fifth Key Value"
        },
        "RecordFirstKeyName":{
            "maxLength":32,
            "type":"string",
            "description":"The first key name of the communication resource associated with the event.",
            "title":"Record First Key Name"
        },
        "RecordFirstKeyValue":{
            "maxLength":100,
            "type":"string",
            "description":"The first key value of the communication resource associated with the event.",
            "title":"Record First Key Value"
        },
        "RecordFourthKeyName":{
            "maxLength":32,
            "type":"string",
            "description":"The fourth key name of the communication resource associated with the event.",
            "title":"Record Fourth Key Name"
        },
        "RecordFourthKeyValue":{
            "maxLength":100,
            "type":"string",
            "description":"The fourth key value of the communication resource associated with the event.",
            "title":"Record Fourth Key Value"
        },
        "RecordIdentifier":{
            "maxLength":100,
            "type":"string",
            "description":"The communication request identifier passed through the communication request.",
            "title":"Record Identifier"
        },
        "RecordSecondKeyName":{
            "maxLength":32,
            "type":"string",
            "description":"The second key name of the communication resource associated with the event.",
            "title":"Record Second Key Name"
        },
        "RecordSecondKeyValue":{
            "maxLength":100,
            "type":"string",
            "description":"The second key value of the communication resource associated with the event.",
            "title":"Record Second Key Value"
        },
        "RecordSubIdentifier":{
            "maxLength":100,
            "type":"string",
            "description":"The communication request sub identifier passed through the communication request.",
            "title":"Record Sub Identifier"
        },
        "RecordThirdKeyName":{
            "maxLength":32,
            "type":"string",
            "description":"The third key name of the communication resource associated with the event.",
            "title":"Record Third Key Name"
        },
        "RecordThirdKeyValue":{
            "maxLength":100,
            "type":"string",
            "description":"The third key value of the communication resource associated with the event.",
            "title":"Record Third Key Value"
        },
        "ResourceEndPoint":{
            "type":"string",
            "description":"The communication resource REST endpoint for generating data payload to replace parameters from the ad hoc email.",
            "title":"Resource Endpoint"
        },
        "Status":{
            "maxLength":30,
            "type":"string",
            "description":"The status of the ad hoc email request.",
            "title":"Status"
        },
        "Subject":{
            "type":"string",
            "description":"The subject of the ad hoc email.",
            "title":"Subject"
        },
        "ToAddress":{
            "type":"string",
            "description":"The email addresses of the ad hoc email's primary recipients.",
            "title":"To Email Address"
        },
        "Visibility":{
            "type":"string",
            "description":"The visibility option of the triggered ad hoc email.",
            "title":"Visibility"
        },
        "WebFormData":{
            "type":"string",
            "description":"The web form details attached to the email."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

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

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top