Get all outbound messages
get
/crmRestApi/resources/11.13.18.05/outboundMessages
Request
Query Parameters
-
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
finder: string
Used as a predefined finder to search the collection.
Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables- PrimaryKey Finds an outbound message with the primary key.
Finder Variables- OutboundMessageId; integer; The unique identifier of the outbound message.
- PrimaryKey Finds an outbound message with the primary key.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- AlternateMessageId; string; The unique identifier of the outbound email in the email delivery application.
- BUOrgId; integer; The unique identifier of the business unit organization Id.
- ChannelId; integer; The unique identifier of the channel of the outbound Message.
- ChannelTypeCd; string; The channel type code.
- CorpCurrencyCode; string; The corporate currency code associated with the outbound message. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
- CreatedBy; string; The user who created the code.
- CreationDate; string; The date when the record was created.
- CurcyConvRateType; string; The currency conversion rate type associated with the outbound message. A list of valid values are defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.
- CurrencyCode; string; The currency code associated with the outbound message. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
- DeliveryTypeCd; string; The delivery type code of the outbound message.
- LastUpdateDate; string; The date when the outbound message was last updated.
- LastUpdatedBy; string; The user who last updated the outbound message.
- OutboundMessageId; integer; The unique identifier of the outbound message.
- OutboundMessageNumber; string; The alternate key identifier of the outbound message.
- PostedByPartyid; integer; The unique party identifier of the user who posted the outbound message.
- ProcessingStatusCd; string; The processing status code of the outbound message.
- ReplyToAddress; string; The reply to address of the outbound message.
- RetryCount; integer; The retry count of the outbound message.
- SenderEmailSourceCd; string; The source code of the sender email for the outbound message.
- SenderName; string; The name of the sender who sent the outbound message.
- SentDate; string; The date when the message was sent by the sender.
- SourceCd; string; The source code of the outbound message.
- SourceMsgObjId; integer; The object identifier of the outbound message.
- SourceMsgObjTypeCd; string; The source message object type code of the outbound message.
- SourceObjId; integer; The source object identifier of the outbound message.
- SourceObjPkName; string; The source object primary key of the outbound message.
- SourceObjTemplateName; string; The template name of the outbound message.
- SourceObjTypeCd; string; The source object type code of the outbound message.
- StatusCd; string; The status code of the outbound message.
- StatusDetails; string; The status details of the outbound message.
- StripeCd; string; The stripe code of the outbound message.
- Subject; string; The subject of the outbound message.
- UsePostedByEmailFlag; boolean; The email of the user who posted the outbound message.
- UsePostedByNameFlag; boolean; The name of the user who posted the outbound message.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
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.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
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.
Root Schema : outboundMessages
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : outboundMessages-item-response
Type:
Show Source
object
-
AlternateMessageId: string
Title:
Alternate Message ID
Maximum Length:2000
The unique identifier of the outbound email in the email delivery application. -
Body: string
(byte)
Title:
Body
The body of the outbound message. -
BUOrgId: integer
(int64)
Title:
Business Organization ID
The unique identifier of the business unit organization Id. -
ChannelId: integer
(int64)
Title:
Channel ID
The unique identifier of the channel of the outbound Message. -
ChannelTypeCd: string
Title:
Channel Type Code
Maximum Length:30
The channel type code. -
CorpCurrencyCode: string
Title:
Corporate Currency Code
Maximum Length:15
The corporate currency code associated with the outbound message. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the code. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the record was created. -
CurcyConvRateType: string
Title:
Type of Currency Conversion Rate
Maximum Length:30
The currency conversion rate type associated with the outbound message. A list of valid values are defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task. -
CurrencyCode: string
Title:
Currency Code
Maximum Length:15
The currency code associated with the outbound message. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. -
DeleteFlag: boolean
Title:
Can Delete Message
Read Only:true
Indicates whether the outbound message record can be deleted. -
DeliveryTypeCd: string
Title:
Delivery Type Code
Maximum Length:30
Default Value:ORA_SVC_IMMEDIATE
The delivery type code of the outbound message. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the outbound message was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the outbound message. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login of the user who last updated the outbound message. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MessageContent: string
(byte)
Title:
Message Content
The content of the outbound message, such as the contents of an email. -
OutboundMessageId: integer
(int64)
Title:
Outbound Message ID
The unique identifier of the outbound message. -
OutboundMessageNumber: string
Title:
Outbound Message Number
Maximum Length:30
The alternate key identifier of the outbound message. -
OutboundMsgParts: array
Outbound Message Parts
Title:
Outbound Message Parts
The outbound message parts resource is used to view, create, update, and delete an outbound message part. It's used to get the description of the root outbound message resource part. -
PostedByPartyid: integer
(int64)
Title:
Posted by Party ID
The unique party identifier of the user who posted the outbound message. -
ProcessingStatusCd: string
Title:
Processing Status Code
Maximum Length:30
The processing status code of the outbound message. -
ReplyToAddress: string
Title:
Reply to Address
Maximum Length:240
The reply to address of the outbound message. -
RetryCount: integer
(int64)
Title:
Retry Count
Default Value:0
The retry count of the outbound message. -
SenderEmailSourceCd: string
Title:
Sender Email Source Code
Maximum Length:30
The source code of the sender email for the outbound message. -
SenderName: string
Title:
Sender Name
Maximum Length:100
The name of the sender who sent the outbound message. -
SentDate: string
(date-time)
Title:
Sent Date
The date when the message was sent by the sender. -
SourceCd: string
Title:
Source Code
Maximum Length:30
The source code of the outbound message. -
SourceMsgObjId: integer
(int64)
Title:
Source Message Object ID
The object identifier of the outbound message. -
SourceMsgObjTypeCd: string
Title:
Source Message Object Type Code
Maximum Length:30
The source message object type code of the outbound message. -
SourceObjId: integer
(int64)
Title:
Source Object ID
The source object identifier of the outbound message. -
SourceObjPkName: string
Title:
Source Object Primary Key Name
Maximum Length:30
The source object primary key of the outbound message. -
SourceObjTemplateName: string
Title:
Source Object Template Name
Maximum Length:240
The template name of the outbound message. -
SourceObjTypeCd: string
Title:
Source Object Type Code
Maximum Length:30
The source object type code of the outbound message. -
StatusCd: string
Title:
Status Code
Maximum Length:30
The status code of the outbound message. -
StatusDetails: string
Title:
Status Details
Maximum Length:1000
The status details of the outbound message. -
StripeCd: string
Title:
Stripe Code
Maximum Length:30
The stripe code of the outbound message. -
Subject: string
Title:
Subject
Maximum Length:400
The subject of the outbound message. -
UpdateFlag: boolean
Title:
Can Update Message
Indicates whether the outbound message has been updated. -
UsePostedByEmailFlag: boolean
Title:
Use Posted by Party Email
Maximum Length:1
Default Value:false
The email of the user who posted the outbound message. -
UsePostedByNameFlag: boolean
Title:
Use Posted by Party Name
Maximum Length:1
Default Value:false
The name of the user who posted the outbound message.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Outbound Message Parts
Type:
array
Title:
Outbound Message Parts
The outbound message parts resource is used to view, create, update, and delete an outbound message part. It's used to get the description of the root outbound message resource part.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : outboundMessages-OutboundMsgParts-item-response
Type:
Show Source
object
-
CorpCurrencyCode: string
Title:
Corporate Currency Code
Maximum Length:15
The corporate currency code associated with the message part. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the outbound message recipient. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the outbound message was created. -
CurcyConvRateType: string
Title:
Type of Currency Conversion Rate
Maximum Length:30
The currency conversion rate type for the message part. A list of valid values are defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task. -
CurrencyCode: string
Title:
Currency Code
Maximum Length:15
The currency code associated with the message part. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. -
DeleteFlag: boolean
Title:
Can Delete Message Part
Read Only:true
Indicates whether the outbound message is deleted. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the outbound message detail was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The login of the user who last updated the outbound message detail. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login of the user who last updated the outbound message detail. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OutboundMessageId: integer
(int64)
Title:
Outbound Message ID
The unique identifier of the outbound message detail. -
OutboundMsgPartId: integer
(int64)
Title:
Outbound Message Part ID
The unique part identifier of the outbound message detail. -
PartName: string
Title:
Part Name
Maximum Length:64
The part name of the outbound message detail. -
PartTypeCd: string
Title:
Part Type Code
Maximum Length:30
The part type of the outbound message details. -
PartValue: string
Title:
Part Value
Maximum Length:2000
The part value of the outbound message details. -
UpdateFlag: boolean
Title:
Can Update Message Part
Read Only:true
Indicates whether the outbound message can be updated.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- getMessageDetails
-
Create an outbound message and outbound message recipients
Examples
The following example shows how to get all outbound messages by submitting a GET request on the REST resource using cURL.
cURL Command
https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/outboundMessages
Example of Response Body
The following example shows the contents of the response body in JSON format.
{ "items": [ { "OutboundMessageId": 300100185236180, "SourceMsgObjId": 300100185236178, "SourceObjId": null, "SourceObjTypeCd": null, "SourceObjTemplateName": null, "SourceObjPkName": null, "PostedByPartyid": 300100112113725, "Subject": "Test Inboud Email", "SourceCd": "ORA_SVC_API", "ChannelId": 100100104291163, "StatusCd": "ORA_SVC_COMMITTED", "StatusDetails": null, "ProcessingStatusCd": "ORA_SVC_READY", "SentDate": null, "ReplyToAddress": null, "BUOrgId": 204, "StripeCd": "ORA_SVC_CRM", "CreationDate": "2020-04-22T15:55:30.607+00:00", "CreatedBy": "SALES_ADMIN", "LastUpdateDate": "2020-04-22T15:55:30.607+00:00", "LastUpdatedBy": "SALES_ADMIN", "LastUpdateLogin": "A3C4EB7111592134E053773AF80AD383", "ChannelTypeCd": "ORA_SVC_EMAIL", "RetryCount": 0, "SourceMsgObjTypeCd": "ConversationMessage", "OutboundMessageNumber": "CDRM_0000000001", "SenderName": null, "UsePostedByEmailFlag": false, "UsePostedByNameFlag": false, "UpdateFlag": true, "DeleteFlag": true, "CorpCurrencyCode": null, "CurcyConvRateType": null, "CurrencyCode": null, "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/outboundMessages/300100185236180", "name": "outboundMessages", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/outboundMessages/300100185236180", "name": "outboundMessages", "kind": "item" }, { "rel": "child", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/outboundMessages/300100185236180/child/OutboundMsgParts", "name": "OutboundMsgParts", "kind": "collection" }, { "rel": "enclosure", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/outboundMessages/300100185236180/enclosure/Body", "name": "Body", "kind": "other" }, { "rel": "enclosure", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/outboundMessages/300100185236180/enclosure/MessageContent", "name": "MessageContent", "kind": "other" } ] }, ...