Jump to

• Request
• Response

Create an ad hoc email

post

/fscmRestApi/resources/11.13.18.05/publicSectorAdhocEmails

Request

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 ()

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

Root Schema : schema

Type: object

Show Source

• AgencyId: integer (int32)
  Title: Agency ID

  Default Value: 1

  The unique identifier of the agency associated with the ad hoc email.
• BccAddress: string
  Title: Bcc Email Address

  The email addresses of the ad hoc email's blind copied recipients.
• Body: string
  Title: Body

  The body of the ad hoc email.
• CcAddress: string
  Title: Cc Email Address

  The email addresses of the ad hoc email's copied recipients.
• EventId: integer (int64)
  Title: Event ID

  The unique identifier for the communication event.
• FromAddress: string
  Title: From Address

  The sender address of the ad hoc email.
• Log: string (byte)
  Title: Error Text

  The communication ad hoc email request error details.
• LogId: integer (int64)
  Title: Log ID

  The unique identifier for the communication ad hoc email. This ID is automatically generated by the application.
• LogMsgAttData: string
  The attachment details attached to the email.
• MimeType: string
  Title: Mime Type

  The MIME type of the ad hoc email message. The possible values are HTML and Text.
• PayloadData: string
  The data payload provided with ad hoc email request.
• PreferredLanguage: string
  Title: Message Language

  The language used for the email message.
• RecordFifthKeyName: string
  Title: Record Fifth Key Name

  Maximum Length: 32

  The fifth key name of the communication resource associated with the event.
• RecordFifthKeyValue: string
  Title: Record Fifth Key Value

  Maximum Length: 100

  The fifth key value of the communication resource associated with the event.
• RecordFirstKeyName: string
  Title: Record First Key Name

  Maximum Length: 32

  The first key name of the communication resource associated with the event.
• RecordFirstKeyValue: string
  Title: Record First Key Value

  Maximum Length: 100

  The first key value of the communication resource associated with the event.
• RecordFourthKeyName: string
  Title: Record Fourth Key Name

  Maximum Length: 32

  The fourth key name of the communication resource associated with the event.
• RecordFourthKeyValue: string
  Title: Record Fourth Key Value

  Maximum Length: 100

  The fourth key value of the communication resource associated with the event.
• RecordIdentifier: string
  Title: Record Identifier

  Maximum Length: 100

  The communication request identifier passed through the communication request.
• RecordSecondKeyName: string
  Title: Record Second Key Name

  Maximum Length: 32

  The second key name of the communication resource associated with the event.
• RecordSecondKeyValue: string
  Title: Record Second Key Value

  Maximum Length: 100

  The second key value of the communication resource associated with the event.
• RecordSubIdentifier: string
  Title: Record Sub Identifier

  Maximum Length: 100

  The communication request sub identifier passed through the communication request.
• RecordThirdKeyName: string
  Title: Record Third Key Name

  Maximum Length: 32

  The third key name of the communication resource associated with the event.
• RecordThirdKeyValue: string
  Title: Record Third Key Value

  Maximum Length: 100

  The third key value of the communication resource associated with the event.
• ResourceEndPoint: string
  Title: Resource Endpoint

  The communication resource REST endpoint for generating data payload to replace parameters from the ad hoc email.
• Status: string
  Title: Status

  Maximum Length: 30

  The status of the ad hoc email request.
• Subject: string
  Title: Subject

  The subject of the ad hoc email.
• ToAddress: string
  Title: To Email Address

  The email addresses of the ad hoc email's primary recipients.
• Visibility: string
  Title: Visibility

  The visibility option of the triggered ad hoc email.
• WebFormData: string
  The web form details attached to the email.

{
    "type":"object",
    "properties":{
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The unique identifier of the agency associated with the ad hoc email.",
            "format":"int32",
            "nullable":true,
            "default":1,
            "x-hints":{
                "precision":8
            }
        },
        "RecordFifthKeyValue":{
            "title":"Record Fifth Key Value",
            "maxLength":100,
            "type":"string",
            "description":"The fifth key value of the communication resource associated with the event.",
            "nullable":true
        },
        "RecordFourthKeyName":{
            "title":"Record Fourth Key Name",
            "maxLength":32,
            "type":"string",
            "description":"The fourth key name of the communication resource associated with the event.",
            "nullable":true
        },
        "RecordSecondKeyValue":{
            "title":"Record Second Key Value",
            "maxLength":100,
            "type":"string",
            "description":"The second key value of the communication resource associated with the event.",
            "nullable":true
        },
        "ResourceEndPoint":{
            "title":"Resource Endpoint",
            "type":"string",
            "description":"The communication resource REST endpoint for generating data payload to replace parameters from the ad hoc email.",
            "nullable":true
        },
        "MimeType":{
            "title":"Mime Type",
            "type":"string",
            "description":"The MIME type of the ad hoc email message. The possible values are HTML and Text.",
            "nullable":true
        },
        "RecordIdentifier":{
            "title":"Record Identifier",
            "maxLength":100,
            "type":"string",
            "description":"The communication request identifier passed through the communication request.",
            "nullable":true
        },
        "WebFormData":{
            "type":"string",
            "description":"The web form details attached to the email.",
            "nullable":true
        },
        "RecordFirstKeyValue":{
            "title":"Record First Key Value",
            "maxLength":100,
            "type":"string",
            "description":"The first key value of the communication resource associated with the event.",
            "nullable":true
        },
        "RecordFourthKeyValue":{
            "title":"Record Fourth Key Value",
            "maxLength":100,
            "type":"string",
            "description":"The fourth key value of the communication resource associated with the event.",
            "nullable":true
        },
        "FromAddress":{
            "title":"From Address",
            "type":"string",
            "description":"The sender address of the ad hoc email.",
            "nullable":true
        },
        "EventId":{
            "title":"Event ID",
            "type":"integer",
            "description":"The unique identifier for the communication event.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "CcAddress":{
            "title":"Cc Email Address",
            "type":"string",
            "description":"The email addresses of the ad hoc email's copied recipients.",
            "nullable":true
        },
        "PreferredLanguage":{
            "title":"Message Language",
            "type":"string",
            "description":"The language used for the email message.",
            "nullable":true
        },
        "RecordFifthKeyName":{
            "title":"Record Fifth Key Name",
            "maxLength":32,
            "type":"string",
            "description":"The fifth key name of the communication resource associated with the event.",
            "nullable":true
        },
        "Body":{
            "title":"Body",
            "type":"string",
            "description":"The body of the ad hoc email.",
            "nullable":true
        },
        "Status":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"The status of the ad hoc email request.",
            "nullable":false
        },
        "RecordSubIdentifier":{
            "title":"Record Sub Identifier",
            "maxLength":100,
            "type":"string",
            "description":"The communication request sub identifier passed through the communication request.",
            "nullable":true
        },
        "Log":{
            "title":"Error Text",
            "type":"string",
            "description":"The communication ad hoc email request error details.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "PayloadData":{
            "type":"string",
            "description":"The data payload provided with ad hoc email request.",
            "nullable":true
        },
        "LogMsgAttData":{
            "type":"string",
            "description":"The attachment details attached to the email.",
            "nullable":true
        },
        "RecordThirdKeyValue":{
            "title":"Record Third Key Value",
            "maxLength":100,
            "type":"string",
            "description":"The third key value of the communication resource associated with the event.",
            "nullable":true
        },
        "RecordThirdKeyName":{
            "title":"Record Third Key Name",
            "maxLength":32,
            "type":"string",
            "description":"The third key name of the communication resource associated with the event.",
            "nullable":true
        },
        "Subject":{
            "title":"Subject",
            "type":"string",
            "description":"The subject of the ad hoc email.",
            "nullable":true
        },
        "RecordFirstKeyName":{
            "title":"Record First Key Name",
            "maxLength":32,
            "type":"string",
            "description":"The first key name of the communication resource associated with the event.",
            "nullable":true
        },
        "BccAddress":{
            "title":"Bcc Email Address",
            "type":"string",
            "description":"The email addresses of the ad hoc email's blind copied recipients.",
            "nullable":true
        },
        "RecordSecondKeyName":{
            "title":"Record Second Key Name",
            "maxLength":32,
            "type":"string",
            "description":"The second key name of the communication resource associated with the event.",
            "nullable":true
        },
        "Visibility":{
            "title":"Visibility",
            "type":"string",
            "description":"The visibility option of the triggered ad hoc email.",
            "nullable":true
        },
        "LogId":{
            "title":"Log ID",
            "type":"integer",
            "description":"The unique identifier for the communication ad hoc email. This ID is automatically generated by the application.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "ToAddress":{
            "title":"To Email Address",
            "type":"string",
            "description":"The email addresses of the ad hoc email's primary recipients.",
            "nullable":true
        }
    }
}

Back to Top

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.

Body ()

Root Schema : publicSectorAdhocEmails-item-response

Type: object

Show Source

• AgencyId: integer (int32)
  Title: Agency ID

  Default Value: 1

  The unique identifier of the agency associated with the ad hoc email.
• BccAddress: string
  Title: Bcc Email Address

  The email addresses of the ad hoc email's blind copied recipients.
• Body: string
  Title: Body

  The body of the ad hoc email.
• CcAddress: string
  Title: Cc Email Address

  The email addresses of the ad hoc email's copied recipients.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the ad hoc email request.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time that the ad hoc email request was created.
• EventId: integer (int64)
  Title: Event ID

  The unique identifier for the communication event.
• FromAddress: string
  Title: From Address

  The sender address of the ad hoc email.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date that the ad hoc email request was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the communication ad hoc email request.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Log: string (byte)
  Title: Error Text

  The communication ad hoc email request error details.
• LogId: integer (int64)
  Title: Log ID

  The unique identifier for the communication ad hoc email. This ID is automatically generated by the application.
• LogMsgAttData: string
  The attachment details attached to the email.
• MimeType: string
  Title: Mime Type

  The MIME type of the ad hoc email message. The possible values are HTML and Text.
• PayloadData: string
  The data payload provided with ad hoc email request.
• PreferredLanguage: string
  Title: Message Language

  The language used for the email message.
• RecordFifthKeyName: string
  Title: Record Fifth Key Name

  Maximum Length: 32

  The fifth key name of the communication resource associated with the event.
• RecordFifthKeyValue: string
  Title: Record Fifth Key Value

  Maximum Length: 100

  The fifth key value of the communication resource associated with the event.
• RecordFirstKeyName: string
  Title: Record First Key Name

  Maximum Length: 32

  The first key name of the communication resource associated with the event.
• RecordFirstKeyValue: string
  Title: Record First Key Value

  Maximum Length: 100

  The first key value of the communication resource associated with the event.
• RecordFourthKeyName: string
  Title: Record Fourth Key Name

  Maximum Length: 32

  The fourth key name of the communication resource associated with the event.
• RecordFourthKeyValue: string
  Title: Record Fourth Key Value

  Maximum Length: 100

  The fourth key value of the communication resource associated with the event.
• RecordIdentifier: string
  Title: Record Identifier

  Maximum Length: 100

  The communication request identifier passed through the communication request.
• RecordSecondKeyName: string
  Title: Record Second Key Name

  Maximum Length: 32

  The second key name of the communication resource associated with the event.
• RecordSecondKeyValue: string
  Title: Record Second Key Value

  Maximum Length: 100

  The second key value of the communication resource associated with the event.
• RecordSubIdentifier: string
  Title: Record Sub Identifier

  Maximum Length: 100

  The communication request sub identifier passed through the communication request.
• RecordThirdKeyName: string
  Title: Record Third Key Name

  Maximum Length: 32

  The third key name of the communication resource associated with the event.
• RecordThirdKeyValue: string
  Title: Record Third Key Value

  Maximum Length: 100

  The third key value of the communication resource associated with the event.
• ResourceEndPoint: string
  Title: Resource Endpoint

  The communication resource REST endpoint for generating data payload to replace parameters from the ad hoc email.
• Status: string
  Title: Status

  Maximum Length: 30

  The status of the ad hoc email request.
• Subject: string
  Title: Subject

  The subject of the ad hoc email.
• ToAddress: string
  Title: To Email Address

  The email addresses of the ad hoc email's primary recipients.
• Visibility: string
  Title: Visibility

  The visibility option of the triggered ad hoc email.
• WebFormData: string
  The web form details attached to the email.

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

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