Create an outbound message parts
post
/crmRestApi/resources/11.13.18.05/outboundMessages/{OutboundMessageId}/child/OutboundMsgParts
Request
Path Parameters
-
OutboundMessageId(required): integer(int64)
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
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. -
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. -
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.
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.
Root 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
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.
Links
- PartTypeCdLookup
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_SVC_OBM_PART_TYPE
The following properties are defined on the LOV link relation:- Source Attribute: PartTypeCd; Target Attribute: LookupCode
- Display Attribute: LookupCode
- finder:
Examples
The following example shows how to create an outbound message part 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/300100188082127/child/OutboundMsgParts
Example of Request Body
The following shows the contents of the request body in JSON format.
{ "PartTypeCd": "ORA_SVC_TO", "PartName": "To", "PartValue": "rakesh.ambat@oracle.com" }
Example of Response Body
The following shows the contents of the response body in JSON format.
{ "OutboundMsgPartId": 300100188188021, "OutboundMessageId": 300100188082127, "PartTypeCd": "ORA_SVC_TO", "PartName": "To", "PartValue": "rakesh.ambat@oracle.com", "CreationDate": "2020-08-07T07:59:46.128+00:00", "CreatedBy": "SALES_ADMIN", "LastUpdateDate": "2020-08-07T07:59:46.129+00:00", "LastUpdatedBy": "SALES_ADMIN", "LastUpdateLogin": "AB8E970B07897281E0531C5CF00A88E5", "DeleteFlag": true, "UpdateFlag": true, "CorpCurrencyCode": null, "CurcyConvRateType": null, "CurrencyCode": null, ... }