Jump to

• Request
• Response
• Examples

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.
• 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.
  • DeliveryServiceCd; string; The delivery service code of the outbound message.
  • 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: 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.

There's no request body for this operation.

Back to Top

Response

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.

Body ()

Root Schema : outboundMessages

Type: object

Show Source

• 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.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"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":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/outboundMessages-item-response"
            }
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        }
    },
    "x-hints":{
        "usage":"BusinessObject",
        "group":"OEC"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object outboundMessages-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/outboundMessages-item-response"
    }
}

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 : outboundMessages-item-response

Type: object

Show Source

• 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.
• DeliveryServiceCd: string
  Title: Delivery Service Code

  Maximum Length: 30

  Default Value: ORA_SVC_UMS

  The delivery service code of the outbound message.
• 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.

{
    "type":"object",
    "properties":{
        "AlternateMessageId":{
            "title":"Alternate Message ID",
            "maxLength":2000,
            "type":"string",
            "description":"The unique identifier of the outbound email in the email delivery application.",
            "nullable":true,
            "x-queryable":true
        },
        "BUOrgId":{
            "title":"Business Organization ID",
            "type":"integer",
            "description":"The unique identifier of the business unit organization Id.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Body":{
            "title":"Body",
            "type":"string",
            "description":"The body of the outbound message.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "ChannelId":{
            "title":"Channel ID",
            "type":"integer",
            "description":"The unique identifier of the channel of the outbound Message.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ChannelTypeCd":{
            "title":"Channel Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The channel type code.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CorpCurrencyCode":{
            "title":"Corporate Currency Code",
            "maxLength":15,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the code.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurcyConvRateType":{
            "title":"Type of Currency Conversion Rate",
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":15,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "DeleteFlag":{
            "title":"Can Delete Message",
            "type":"boolean",
            "description":"Indicates whether the outbound message record can be deleted.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "DeliveryServiceCd":{
            "title":"Delivery Service Code",
            "maxLength":30,
            "type":"string",
            "description":"The delivery service code of the outbound message.",
            "nullable":true,
            "default":"ORA_SVC_UMS",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "DeliveryTypeCd":{
            "title":"Delivery Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The delivery type code of the outbound message.",
            "nullable":false,
            "default":"ORA_SVC_IMMEDIATE",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the outbound message was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the outbound message.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the outbound message.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MessageContent":{
            "title":"Message Content",
            "type":"string",
            "description":"The content of the outbound message, such as the contents of an email.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "OutboundMessageId":{
            "title":"Outbound Message ID",
            "type":"integer",
            "description":"The unique identifier of the outbound message.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OutboundMessageNumber":{
            "title":"Outbound Message Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate key identifier of the outbound message.",
            "nullable":false,
            "x-queryable":true
        },
        "OutboundMsgParts":{
            "title":"Outbound Message Parts",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/outboundMessages-OutboundMsgParts-item-response"
            }
        },
        "PostedByPartyid":{
            "title":"Posted by Party ID",
            "type":"integer",
            "description":"The unique party identifier of the user who posted the outbound message.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ProcessingStatusCd":{
            "title":"Processing Status Code",
            "maxLength":30,
            "type":"string",
            "description":"The processing status code of the outbound message.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ReplyToAddress":{
            "title":"Reply to Address",
            "maxLength":240,
            "type":"string",
            "description":"The reply to address of the outbound message.",
            "nullable":true,
            "x-queryable":true
        },
        "RetryCount":{
            "title":"Retry Count",
            "type":"integer",
            "description":"The retry count of the outbound message.",
            "format":"int64",
            "nullable":false,
            "default":0,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SenderEmailSourceCd":{
            "title":"Sender Email Source Code",
            "maxLength":30,
            "type":"string",
            "description":"The source code of the sender email for the outbound message.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SenderName":{
            "title":"Sender Name",
            "maxLength":100,
            "type":"string",
            "description":"The name of the sender who sent the outbound message.",
            "nullable":true,
            "x-queryable":true
        },
        "SentDate":{
            "title":"Sent Date",
            "type":"string",
            "description":"The date when the message was sent by the sender.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "SourceCd":{
            "title":"Source Code",
            "maxLength":30,
            "type":"string",
            "description":"The source code of the outbound message.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SourceMsgObjId":{
            "title":"Source Message Object ID",
            "type":"integer",
            "description":"The object identifier of the outbound message.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SourceMsgObjTypeCd":{
            "title":"Source Message Object Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The source message object type code of the outbound message.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SourceObjId":{
            "title":"Source Object ID",
            "type":"integer",
            "description":"The source object identifier of the outbound message.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SourceObjPkName":{
            "title":"Source Object Primary Key Name",
            "maxLength":30,
            "type":"string",
            "description":"The source object primary key of the outbound message.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceObjTemplateName":{
            "title":"Source Object Template Name",
            "maxLength":240,
            "type":"string",
            "description":"The template name of the outbound message.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceObjTypeCd":{
            "title":"Source Object Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The source object type code of the outbound message.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "StatusCd":{
            "title":"Status Code",
            "maxLength":30,
            "type":"string",
            "description":"The status code of the outbound message.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "StatusDetails":{
            "title":"Status Details",
            "maxLength":1000,
            "type":"string",
            "description":"The status details of the outbound message.",
            "nullable":true,
            "x-queryable":true
        },
        "StripeCd":{
            "title":"Stripe Code",
            "maxLength":30,
            "type":"string",
            "description":"The stripe code of the outbound message.",
            "nullable":true,
            "x-queryable":true
        },
        "Subject":{
            "title":"Subject",
            "maxLength":400,
            "type":"string",
            "description":"The subject of the outbound message.",
            "nullable":true,
            "x-queryable":true
        },
        "UpdateFlag":{
            "title":"Can Update Message",
            "type":"boolean",
            "description":"Indicates whether the outbound message has been updated.",
            "nullable":true,
            "x-queryable":false
        },
        "UsePostedByEmailFlag":{
            "title":"Use Posted by Party Email",
            "maxLength":1,
            "type":"boolean",
            "description":"The email of the user who posted the outbound message.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "UsePostedByNameFlag":{
            "title":"Use Posted by Party Name",
            "maxLength":1,
            "type":"boolean",
            "description":"The name of the user who posted the outbound message.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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 : 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

• Array of: object outboundMessages-OutboundMsgParts-item-response

{
    "title":"Outbound Message Parts",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/outboundMessages-OutboundMsgParts-item-response"
    }
}

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."
        }
    }
}

Nested Schema : outboundMessages-OutboundMsgParts-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "CorpCurrencyCode":{
            "title":"Corporate Currency Code",
            "maxLength":15,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the outbound message recipient.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the outbound message was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurcyConvRateType":{
            "title":"Type of Currency Conversion Rate",
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":15,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "DeleteFlag":{
            "title":"Can Delete Message Part",
            "type":"boolean",
            "description":"Indicates whether the outbound message is deleted.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the outbound message detail was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the outbound message detail.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The login of the user who last updated the outbound message detail.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OutboundMessageId":{
            "title":"Outbound Message ID",
            "type":"integer",
            "description":"The unique identifier of the outbound message detail.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OutboundMsgPartId":{
            "title":"Outbound Message Part ID",
            "type":"integer",
            "description":"The unique part identifier of the outbound message detail.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PartName":{
            "title":"Part Name",
            "maxLength":64,
            "type":"string",
            "description":"The part name of the outbound message detail.",
            "nullable":true,
            "x-queryable":true
        },
        "PartTypeCd":{
            "title":"Part Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The part type of the outbound message details.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PartValue":{
            "title":"Part Value",
            "maxLength":2000,
            "type":"string",
            "description":"The part value of the outbound message details.",
            "nullable":true,
            "x-queryable":true
        },
        "UpdateFlag":{
            "title":"Can Update Message Part",
            "type":"boolean",
            "description":"Indicates whether the outbound message can be updated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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"
    }
}

Links

getMessageDetails

Operation: /crmRestApi/resources/11.13.18.05/outboundMessages/action/getMessageDetails

Create an outbound message and outbound message recipients

getOutboundMsgAttachments

Operation: /crmRestApi/resources/11.13.18.05/outboundMessages/action/getOutboundMsgAttachments

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

getOutboundMsgDetails

Operation: /crmRestApi/resources/11.13.18.05/outboundMessages/action/getOutboundMsgDetails

This method lets you get outbound message and outbound message part details. It also gets template content and attachment details associated with template.

updateOutboundMsgProcessingStatus

Operation: /crmRestApi/resources/11.13.18.05/outboundMessages/action/updateOutboundMsgProcessingStatus

This method lets you update the processing status of the outbound message and the processing status object.

Back to Top

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"
        }
      ]
    },
...

Back to Top