Jump to

• Request
• Response

Get outbound message attachments

post

/crmRestApi/resources/11.13.18.05/outboundMessages/action/getOutboundMsgAttachments

This method lets you get outbound message attachments with or without template attachments.

Request

Header Parameters

• Metadata-Context: string
  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: string
  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

• isTemplateAttachmentRequired: boolean
  Specify whether to get template attachments.
• outboundMsgId: number
  Get outbound message attachments for an outbound message ID.

{
    "type":"object",
    "properties":{
        "isTemplateAttachmentRequired":{
            "type":"boolean",
            "description":"Specify whether to get template attachments.",
            "nullable":true
        },
        "outboundMsgId":{
            "type":"number",
            "description":"Get outbound message attachments for an outbound message ID.",
            "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 attachments information of the outbound message.

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

Nested Schema : result

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties
  Additional Properties Allowed: additionalProperties

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

The response payload that includes attachments information of the outbound message.

Nested Schema : additionalProperties

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Back to Top