Jump to

• Request
• Response
• Examples

Create an outbound message for a business object

post

/crmRestApi/resources/11.13.18.05/outboundMessages/action/getMessageDetails

Create an outbound message and outbound message recipients

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/vnd.oracle.adf.action+json

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

Root Schema : schema

Type: object

Show Source

• channelId: number
  Create an outbound message for a channel ID
• messageId: number
  Create an outbound message for a message ID
• messageType: string
  Create an outbound message for a message type
• objectId: number
  Create an outbound message for an object ID
• objectType: string
  Create an outbound message for an object type
• preview: boolean
  Create preview for an outbound message
• sourceCd: string
  The source code used to create the outbound message.
• subject: string
  The subject of the outbound message.
• templateName: string
  Create an outbound message for a template name

{
    "type":"object",
    "properties":{
        "preview":{
            "type":"boolean",
            "description":"Create preview for an outbound message",
            "nullable":true
        },
        "messageType":{
            "type":"string",
            "description":"Create an outbound message for a message type",
            "nullable":true
        },
        "templateName":{
            "type":"string",
            "description":"Create an outbound message for a template name",
            "nullable":true
        },
        "subject":{
            "type":"string",
            "description":"The subject of the outbound message.",
            "nullable":true
        },
        "messageId":{
            "type":"number",
            "description":"Create an outbound message for a message ID",
            "nullable":true
        },
        "sourceCd":{
            "type":"string",
            "description":"The source code used to create the outbound message.",
            "nullable":true
        },
        "objectId":{
            "type":"number",
            "description":"Create an outbound message for an object ID",
            "nullable":true
        },
        "channelId":{
            "type":"number",
            "description":"Create an outbound message for a channel ID",
            "nullable":true
        },
        "objectType":{
            "type":"string",
            "description":"Create an outbound message for an object type",
            "nullable":true
        }
    },
    "additionalProperties":false
}

Back to Top

Response

Supported Media Types

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

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : schema

Type: object

Show Source

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

  The response payload that includes the identifiers of the message.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            },
            "description":"The response payload that includes the identifiers of the message."
        }
    },
    "additionalProperties":false
}

Nested Schema : result

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    },
    "description":"The response payload that includes the identifiers of the message."
}

The response payload that includes the identifiers of the message.

Back to Top

Examples

The following example shows how to get message details of an outbound message by submitting a POST request on the REST resource using cURL.

cURL Command

https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/outboundMessages/action/getMessageDetails

Example of Request Body

The following shows the contents of the request body in JSON format.

{
   "objectType":"ServiceRequest",
   "messageType": "ORA_SVC_RESPONSE",
   "objectId":300100192362479,
   "messageId":300100192453576,
   "sourceCd" : "ORA_SVC_AGENT_UI",
   "preview" : true
}

Example of Response Body

The following shows the contents of the response body in JSON format.

{
  {
  "result": {
    "content": "<br/><br/><div style='color:#808080;'><div>[## Envie sua resposta como resposta ao e-mail acima ##]</div></div></div style='border:none;border-top:dashed #808080 1.0pt;padding:3.0pt'/><div style='color:#808080;'>[Response]</div> <br/> <div style='color:#808080;font-size:80%'>To</div> [e-mail] <br/><div style='color:#808080;font-size:80%'>Cc</div>[e-mail]<br/><div  style='color:#808080;font-size:80%'> Sent on <div/> Sun, Jul 26, 2020 at 12:29 PM GMT <br/><br/><br/>Message Content<br/><br/><div style='color:#808080;'><div>[## Fim da conversa ##]<div/><div/>",
    "sender": "Gabrielle   Lee <[e-mail]>",
    "replyTo": "Gabrielle   Lee <[e-mail]>",
    "attachmentNames": "",
    "subject": "SR0000080333 - Test"
  }
} 

Back to Top