Jump to

• Request
• Response

Create an ad hoc communication request

post

/fscmRestApi/resources/11.13.18.05/publicSectorAdhocCommunications

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)
  Default Value: 1

  The unique identifier of the agency associated with the ad hoc communication.
• BccAddress: string
  The blind carbon copy to (Bcc) address for the email of the ad hoc communication request.
• Body: string
  The body of the ad hoc communication request.
• CcAddress: string
  The carbon copy (Cc) address for the email of the ad hoc communication request.
• EmailToAddress: string
  The user IDs of the ad hoc email's primary recipients.
• EventId: integer (int64)
  Title: Event ID

  The unique identifier for the communication event.
• FromAddress: string
  The sender address of the ad hoc communication request.
• Log: string (byte)
  The communication ad hoc communication request error details.
• LogId: integer (int64)
  Title: Log ID

  The unique identifier for the communication ad hoc communication request. This ID is automatically generated by the application.
• LogMsgAttData: string
  The attachment details attached to the communication.
• MessageDeleteAllowed: boolean
  Indicates that a user can delete this message from their notification list. The default value is false.
• MimeType: string
  The MIME type of the ad hoc notification message. The possible values are HTML and Text.
• NotificationToAddress: string
  The user IDs of the ad hoc notification's primary recipients.
• ObjectVersionNumber: integer (int32)
  The version of the communication request.
• PayloadData: string
  The data payload provided with the ad hoc communication request.
• PreferredLanguage: string
  The language used for the communication message.
• Priority: string
  The priority of the message for notification.
• 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
  The communication resource REST endpoint for generating data payload to replace parameters from the ad hoc communication request.
• RunEnd: string (date-time)
  The date and time when the ad hoc communication was deleted.
• RunStart: string (date-time)
  The date and time when the ad hoc communication was created.
• Status: string
  Title: Status

  Maximum Length: 30

  The status of the ad hoc communication request.
• Subject: string
  The subject of the ad hoc communication request.
• Visibility: string
  The visibility option of the ad hoc communication request.
• WebFormData: string
  The web form details attached to the communication request.

{
    "type":"object",
    "properties":{
        "AgencyId":{
            "type":"integer",
            "description":"The unique identifier of the agency associated with the ad hoc communication.",
            "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":{
            "type":"string",
            "description":"The communication resource REST endpoint for generating data payload to replace parameters from the ad hoc communication request.",
            "nullable":true
        },
        "EmailToAddress":{
            "type":"string",
            "description":"The user IDs of the ad hoc email's primary recipients.",
            "nullable":true
        },
        "MimeType":{
            "type":"string",
            "description":"The MIME type of the ad hoc notification 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 communication request.",
            "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
        },
        "FromAddress":{
            "type":"string",
            "description":"The sender address of the ad hoc communication request.",
            "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
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The version of the communication request.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            }
        },
        "CcAddress":{
            "type":"string",
            "description":"The carbon copy (Cc) address for the email of the ad hoc communication request.",
            "nullable":true
        },
        "PreferredLanguage":{
            "type":"string",
            "description":"The language used for the communication message.",
            "nullable":true
        },
        "EventId":{
            "title":"Event ID",
            "type":"integer",
            "description":"The unique identifier for the communication event.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "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":{
            "type":"string",
            "description":"The body of the ad hoc communication request.",
            "nullable":true
        },
        "Status":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"The status of the ad hoc communication request.",
            "nullable":false
        },
        "RunStart":{
            "type":"string",
            "description":"The date and time when the ad hoc communication was created.",
            "format":"date-time",
            "nullable":true
        },
        "RunEnd":{
            "type":"string",
            "description":"The date and time when the ad hoc communication was deleted.",
            "format":"date-time",
            "nullable":true
        },
        "RecordSubIdentifier":{
            "title":"Record Sub Identifier",
            "maxLength":100,
            "type":"string",
            "description":"The communication request sub identifier passed through the communication request.",
            "nullable":true
        },
        "Log":{
            "type":"string",
            "description":"The communication ad hoc communication request error details.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "PayloadData":{
            "type":"string",
            "description":"The data payload provided with the ad hoc communication request.",
            "nullable":true
        },
        "Priority":{
            "type":"string",
            "description":"The priority of the message for notification.",
            "nullable":true
        },
        "LogMsgAttData":{
            "type":"string",
            "description":"The attachment details attached to the communication.",
            "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":{
            "type":"string",
            "description":"The subject of the ad hoc communication request.",
            "nullable":true
        },
        "MessageDeleteAllowed":{
            "type":"boolean",
            "description":"Indicates that a user can delete this message from their notification list. The default value is false.",
            "nullable":true
        },
        "BccAddress":{
            "type":"string",
            "description":"The blind carbon copy to (Bcc) address for the email of the ad hoc communication request.",
            "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
        },
        "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":{
            "type":"string",
            "description":"The visibility option of the ad hoc communication request.",
            "nullable":true
        },
        "LogId":{
            "title":"Log ID",
            "type":"integer",
            "description":"The unique identifier for the communication ad hoc communication request. This ID is automatically generated by the application.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "NotificationToAddress":{
            "type":"string",
            "description":"The user IDs of the ad hoc notification'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 : publicSectorAdhocCommunications-item-response

Type: object

Show Source

• AgencyId: integer (int32)
  Default Value: 1

  The unique identifier of the agency associated with the ad hoc communication.
• BccAddress: string
  The blind carbon copy to (Bcc) address for the email of the ad hoc communication request.
• Body: string
  The body of the ad hoc communication request.
• CcAddress: string
  The carbon copy (Cc) address for the email of the ad hoc communication request.
• CreationDate: string (date-time)
  Read Only: true

  The date and time when the ad hoc communication request was created.
• EmailToAddress: string
  The user IDs of the ad hoc email's primary recipients.
• EventId: integer (int64)
  Title: Event ID

  The unique identifier for the communication event.
• FromAddress: string
  The sender address of the ad hoc communication request.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date when the ad hoc communication request was last updated.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Log: string (byte)
  The communication ad hoc communication request error details.
• LogId: integer (int64)
  Title: Log ID

  The unique identifier for the communication ad hoc communication request. This ID is automatically generated by the application.
• LogMsgAttData: string
  The attachment details attached to the communication.
• MessageDeleteAllowed: boolean
  Indicates that a user can delete this message from their notification list. The default value is false.
• MimeType: string
  The MIME type of the ad hoc notification message. The possible values are HTML and Text.
• NotificationToAddress: string
  The user IDs of the ad hoc notification's primary recipients.
• ObjectVersionNumber: integer (int32)
  The version of the communication request.
• PayloadData: string
  The data payload provided with the ad hoc communication request.
• PreferredLanguage: string
  The language used for the communication message.
• Priority: string
  The priority of the message for notification.
• 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
  The communication resource REST endpoint for generating data payload to replace parameters from the ad hoc communication request.
• RunEnd: string (date-time)
  The date and time when the ad hoc communication was deleted.
• RunStart: string (date-time)
  The date and time when the ad hoc communication was created.
• Status: string
  Title: Status

  Maximum Length: 30

  The status of the ad hoc communication request.
• Subject: string
  The subject of the ad hoc communication request.
• Visibility: string
  The visibility option of the ad hoc communication request.
• WebFormData: string
  The web form details attached to the communication request.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the ad hoc communication request was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AgencyId":{
            "type":"integer",
            "description":"The unique identifier of the agency associated with the ad hoc communication.",
            "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":{
            "type":"string",
            "description":"The communication resource REST endpoint for generating data payload to replace parameters from the ad hoc communication request.",
            "nullable":true,
            "x-queryable":true
        },
        "EmailToAddress":{
            "type":"string",
            "description":"The user IDs of the ad hoc email's primary recipients.",
            "nullable":true,
            "x-queryable":true
        },
        "MimeType":{
            "type":"string",
            "description":"The MIME type of the ad hoc notification 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 communication request.",
            "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
        },
        "FromAddress":{
            "type":"string",
            "description":"The sender address of the ad hoc communication request.",
            "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
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The version of the communication request.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "CcAddress":{
            "type":"string",
            "description":"The carbon copy (Cc) address for the email of the ad hoc communication request.",
            "nullable":true,
            "x-queryable":true
        },
        "PreferredLanguage":{
            "type":"string",
            "description":"The language used for the communication message.",
            "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
        },
        "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":{
            "type":"string",
            "description":"The body of the ad hoc communication request.",
            "nullable":true,
            "x-queryable":true
        },
        "Status":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"The status of the ad hoc communication request.",
            "nullable":false,
            "x-queryable":true
        },
        "RunStart":{
            "type":"string",
            "description":"The date and time when the ad hoc communication was created.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "RunEnd":{
            "type":"string",
            "description":"The date and time when the ad hoc communication was deleted.",
            "format":"date-time",
            "nullable":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":{
            "type":"string",
            "description":"The communication ad hoc communication request error details.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "PayloadData":{
            "type":"string",
            "description":"The data payload provided with the ad hoc communication request.",
            "nullable":true,
            "x-queryable":true
        },
        "Priority":{
            "type":"string",
            "description":"The priority of the message for notification.",
            "nullable":true,
            "x-queryable":true
        },
        "LogMsgAttData":{
            "type":"string",
            "description":"The attachment details attached to the communication.",
            "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":{
            "type":"string",
            "description":"The subject of the ad hoc communication request.",
            "nullable":true,
            "x-queryable":true
        },
        "MessageDeleteAllowed":{
            "type":"boolean",
            "description":"Indicates that a user can delete this message from their notification list. The default value is false.",
            "nullable":true,
            "x-queryable":true
        },
        "BccAddress":{
            "type":"string",
            "description":"The blind carbon copy to (Bcc) address for the email of the ad hoc communication request.",
            "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
        },
        "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":{
            "type":"string",
            "description":"The visibility option of the ad hoc communication request.",
            "nullable":true,
            "x-queryable":true
        },
        "LogId":{
            "title":"Log ID",
            "type":"integer",
            "description":"The unique identifier for the communication ad hoc communication request. This ID is automatically generated by the application.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the ad hoc communication request was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "NotificationToAddress":{
            "type":"string",
            "description":"The user IDs of the ad hoc notification's primary recipients.",
            "nullable":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