Update one outbound message
patch
/fscmRestApi/resources/11.13.18.05/b2bTradingPartners/{TradingPartnerId}/child/outboundCollaborationMessages/{PartnerMessageId}
Request
Path Parameters
-
PartnerMessageId(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=
-
TradingPartnerId(required): integer(int64)
Value that uniquely identifies the trading partner. It is a primary key that the application generates when it creates a trading partner record. This attribute is required.
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/json
Root Schema : schema
Type:
Show Source
object
-
AlternateDeliveryMethodId: integer
(int64)
Value that uniquely identifies the alternate delivery method. It is a primary key that the application generates when it creates a delivery method record.
-
AlternateDeliveryMethodName: string
Name of the alternate delivery method.
-
AttachmentProcessingMethod: string
Maximum Length:
64
Value that indicates how the message attachments are sent to trading partners. Valid values include In message, In payload, and MIME part. -
DeliveryMethodId: integer
(int64)
Value that uniquely identifies the delivery method for the outbound collaboration message. This attribute is a foreign key reference to the delivery method for the outbound collaboration message.
-
DeliveryMethodName: string
Name of the delivery method for the outbound collaboration message.
-
domainValueMaps: array
Domain Value Maps
Title:
Domain Value Maps
The Domain Value Maps resource gets all the mappings associated with the trading partner that are implemented while processing a message. -
MessageId: integer
(int64)
Title:
Collaboration Message Definition
Value that uniquely identifies the collaboration message. This attribute is a foreign key reference to the collaboration message. -
MessageName: string
Name of the collaboration message name.
-
messageProcessingRules: array
Message Processing Rules
Title:
Message Processing Rules
The Message Processing Rules resource gets all the rules associated with the trading partner that are implemented while processing a message. -
OverrideStatus: string
Maximum Length:
100
Value that specifies the override status of the outbound collaboration message. Values include Inactive, Active, or Loopback. The default value is Inactive. -
OverrideStatusDate: string
(date-time)
Date when the status of the outbound collaboration message was overridden.
-
PartnerMessageStatus: string
Maximum Length:
100
Value that specifies the status of the outbound collaboration message. -
PartnerMessageStatusDate: string
(date-time)
Date when the outbound collaboration message status is set.
-
ProcessingAction: string
Maximum Length:
256
Value that defines the action of outbound message which is sent through SOAP headers. -
RetentionDuration: integer
(int32)
Title:
Retention Duration
Value that specifies the duration of retention of the outbound collaboration message. -
RetentionDurationType: string
Title:
Retention Duration Unit
Maximum Length:100
Value that specifies the type of duration of retention of the outbound collaboration message.
Nested Schema : Domain Value Maps
Type:
array
Title:
Domain Value Maps
The Domain Value Maps resource gets all the mappings associated with the trading partner that are implemented while processing a message.
Show Source
Nested Schema : Message Processing Rules
Type:
array
Title:
Message Processing Rules
The Message Processing Rules resource gets all the rules associated with the trading partner that are implemented while processing a message.
Show Source
Nested Schema : b2bTradingPartners-outboundCollaborationMessages-domainValueMaps-item-patch-request
Type:
Show Source
object
Nested Schema : b2bTradingPartners-outboundCollaborationMessages-messageProcessingRules-item-patch-request
Type:
Show Source
object
-
DefaultValue: string
Maximum Length:
512
Value that specifies the default value of the node identified in the XPath. -
IncludeInOutputFlag: boolean
Maximum Length:
100
Contains one of the following values: true or false. If true, then the field should be included in the message. If false, then the field should not be included in the message. The default value is false. -
MessageNodeXpath: string
Maximum Length:
2000
Value that specifies the cross reference path of the external message. -
Name: string
Maximum Length:
512
Name of the message processing rule. -
ValueRequiredFlag: boolean
Maximum Length:
100
Contains one of the following values: true or false. If true, then a value is required for a field. If false, then value is not required for a field. This attribute does not have a default value.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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(required):
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 : b2bTradingPartners-outboundCollaborationMessages-item-response
Type:
Show Source
object
-
AlternateDeliveryMethodId: integer
(int64)
Value that uniquely identifies the alternate delivery method. It is a primary key that the application generates when it creates a delivery method record.
-
AlternateDeliveryMethodName: string
Name of the alternate delivery method.
-
AttachmentProcessingMethod: string
Maximum Length:
64
Value that indicates how the message attachments are sent to trading partners. Valid values include In message, In payload, and MIME part. -
CreationDate: string
(date-time)
Read Only:
true
Date when the user set up the inbound collaboration message for the trading partner. -
DeliveryMethodId: integer
(int64)
Value that uniquely identifies the delivery method for the outbound collaboration message. This attribute is a foreign key reference to the delivery method for the outbound collaboration message.
-
DeliveryMethodName: string
Name of the delivery method for the outbound collaboration message.
-
DocumentId: integer
(int64)
Value that uniquely identifies the collaboration document. This attribute is a foreign key reference to the collaboration document.
-
DocumentName: string
Read Only:
true
Maximum Length:256
Name of document associated with the outbound collaboration message. -
domainValueMaps: array
Domain Value Maps
Title:
Domain Value Maps
The Domain Value Maps resource gets all the mappings associated with the trading partner that are implemented while processing a message. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date when the user most recently updated the inbound collaboration message for the trading partner. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MessageId: integer
(int64)
Title:
Collaboration Message Definition
Value that uniquely identifies the collaboration message. This attribute is a foreign key reference to the collaboration message. -
MessageName: string
Name of the collaboration message name.
-
messageProcessingRules: array
Message Processing Rules
Title:
Message Processing Rules
The Message Processing Rules resource gets all the rules associated with the trading partner that are implemented while processing a message. -
OverrideStatus: string
Maximum Length:
100
Value that specifies the override status of the outbound collaboration message. Values include Inactive, Active, or Loopback. The default value is Inactive. -
OverrideStatusDate: string
(date-time)
Date when the status of the outbound collaboration message was overridden.
-
PartnerMessageCustomizationId: integer
(int64)
Value that uniquely identifies the trading partner message customization. This attribute is a foreign key reference to the trading partner message customization.
-
PartnerMessageId: integer
(int64)
Value that uniquely identifies the trading partner message. This attribute is a foreign key reference to the trading partner message.
-
PartnerMessageName: string
Title:
Name
Maximum Length:256
Name of the outbound collaboration message. -
PartnerMessageStatus: string
Maximum Length:
100
Value that specifies the status of the outbound collaboration message. -
PartnerMessageStatusDate: string
(date-time)
Date when the outbound collaboration message status is set.
-
ProcessingAction: string
Maximum Length:
256
Value that defines the action of outbound message which is sent through SOAP headers. -
RetentionDuration: integer
(int32)
Title:
Retention Duration
Value that specifies the duration of retention of the outbound collaboration message. -
RetentionDurationType: string
Title:
Retention Duration Unit
Maximum Length:100
Value that specifies the type of duration of retention of the outbound collaboration message. -
ServiceProviderId: integer
(int64)
Value that uniquely identifies the service provider. This attribute is a foreign key reference to the service provider.
-
UserDefinedFlag: boolean
Read Only:
true
Value that indicates whether the outbound collaboration message is user defined. This value is not editable.
Nested Schema : Domain Value Maps
Type:
array
Title:
Domain Value Maps
The Domain Value Maps resource gets all the mappings associated with the trading partner that are implemented while processing a message.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Message Processing Rules
Type:
array
Title:
Message Processing Rules
The Message Processing Rules resource gets all the rules associated with the trading partner that are implemented while processing a message.
Show Source
Nested Schema : b2bTradingPartners-outboundCollaborationMessages-domainValueMaps-item-response
Type:
Show Source
object
-
CreationDate: string
(date-time)
Read Only:
true
Date when the user set up the domain value map associated with the trading partner's predefined message definition. -
DvmName: string
Read Only:
true
Maximum Length:256
Name of the domain value map defined in the SOA composer. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date when the user most recently updated the domain value map associated with the trading partner's predefined message definition. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MessageDvmId: integer
(int64)
Read Only:
true
Value that uniquely identifies the domain value map. It is a primary key that the application generates when it creates a domain value map record. This attribute is required. -
MessageId: integer
(int64)
Read Only:
true
Value that uniquely identifies the collaboration message. This attribute is a foreign key reference to the collaboration message. -
MessageName: string
Read Only:
true
Name of the collaboration message.
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.
Nested Schema : b2bTradingPartners-outboundCollaborationMessages-messageProcessingRules-item-response
Type:
Show Source
object
-
CreationDate: string
(date-time)
Read Only:
true
Date when the user set up the processing rule for the trading partner's collaboration message. -
DefaultValue: string
Maximum Length:
512
Value that specifies the default value of the node identified in the XPath. -
IncludeInOutputFlag: boolean
Maximum Length:
100
Contains one of the following values: true or false. If true, then the field should be included in the message. If false, then the field should not be included in the message. The default value is false. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date when the user most recently updated the processing rule for the trading partner's collaboration message. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MessageNodeXpath: string
Maximum Length:
2000
Value that specifies the cross reference path of the external message. -
Name: string
Maximum Length:
512
Name of the message processing rule. -
NodeId: integer
(int64)
Value that uniquely identifies the message processing rule. It is a primary key that the application generates when it creates a message processing rule record. This attribute is required.
-
ValueRequiredFlag: boolean
Maximum Length:
100
Contains one of the following values: true or false. If true, then a value is required for a field. If false, then value is not required for a field. This attribute does not have a default value.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- domainValueMaps
-
Parameters:
- PartnerMessageId2:
$request.path.PartnerMessageId2
- TradingPartnerId:
$request.path.TradingPartnerId
The Domain Value Maps resource gets all the mappings associated with the trading partner that are implemented while processing a message. - PartnerMessageId2:
- messageProcessingRules
-
Parameters:
- PartnerMessageId2:
$request.path.PartnerMessageId2
- TradingPartnerId:
$request.path.TradingPartnerId
The Message Processing Rules resource gets all the rules associated with the trading partner that are implemented while processing a message. - PartnerMessageId2:
Examples
This example describes how to update one outbound message.
Example cURL Command
Use the following cURL command to submit a request on the REST resource.
curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/b2bTradingPartners/TradingPartnerId/child/outboundCollaborationMessages/PartnerMessageId"
Example Request Body
The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it updates.
{ "OverrideStatus" : "Active" }
Example Response Body
The following example includes the contents of the response body in JSON format:
{ "PartnerMessageId" : 300100083098961, "PartnerMessageName" : "Nameout10_1.2", "PartnerMessageStatus" : "Entered", "PartnerMessageStatusDate" : "2015-12-09T19:48:50.536+00:00", "ProcessingAction" : "ChangePurchaseOrder", "MessageId" : 40022, "MessageName" : "OAGIS_10.1_CHANGE_PO_COLLAB_MSG_OUT", "ServiceProviderId" : 50055, "DocumentId" : 40055, "DeliveryMethodId" : 300100073313018, "DeliveryMethodName" : "891678078DUNS", "PartnerMessageCustomizationId" : 300100083098961, "RetentionDuration" : null, "RetentionDurationType" : null, "OverrideStatus" : "Active", "OverrideStatusDate" : null, "links" : [ { "rel" : "self", "href" : "https://servername/fscmRestApi/resources/version/b2bTradingPartners/300100073313017/child/outboundCollaborationMessages/300100083098961", "name" : "outboundCollaborationMessages", "kind" : "item", "properties" : { "changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000002770400000002737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000374001353434D5F494D504C5F434F4E53554C54414E5478" } }, { "rel" : "canonical", "href" : "https://servername/fscmRestApi/resources/version/b2bTradingPartners/300100073313017/child/outboundCollaborationMessages/300100083098961", "name" : "outboundCollaborationMessages", "kind" : "item" }, { "rel" : "parent", "href" : "https://servername/fscmRestApi/resources/version/b2bTradingPartners/300100073313017", "name" : "b2bTradingPartners", "kind" : "item" }, { "rel" : "lov", "href" : "https://servername/fscmRestApi/resources/version/b2bTradingPartners/300100073313017/child/outboundCollaborationMessages/300100083098961/lov/retentionDurationTypesLOV", "name" : "retentionDurationTypesLOV", "kind" : "collection" }, { "rel" : "lov", "href" : "https://servername/fscmRestApi/resources/version/b2bTradingPartners/300100073313017/child/outboundCollaborationMessages/300100083098961/lov/messagesLOV", "name" : "messagesLOV", "kind" : "collection" }, { "rel" : "lov", "href" : "https://servername/fscmRestApi/resources/version/b2bTradingPartners/300100073313017/child/outboundCollaborationMessages/300100083098961/lov/deliveryMethodsLOV", "name" : "deliveryMethodsLOV", "kind" : "collection" }, { "rel" : "lov", "href" : "https://servername/fscmRestApi/resources/version/b2bTradingPartners/300100073313017/child/outboundCollaborationMessages/300100083098961/lov/overrideStatusLOV", "name" : "overrideStatusLOV", "kind" : "collection" }, { "rel" : "lov", "href" : "https://servername/fscmRestApi/resources/version/b2bTradingPartners/300100073313017/child/outboundCollaborationMessages/300100083098961/lov/partnerMessageStatusLOV", "name" : "partnerMessageStatusLOV", "kind" : "collection" }, { "rel" : "child", "href" : "https://servername/fscmRestApi/resources/version/b2bTradingPartners/300100073313017/child/outboundCollaborationMessages/300100083098961/child/messageProcessingRules", "name" : "messageProcessingRules", "kind" : "collection" }, { "rel" : "child", "href" : "https://servername/fscmRestApi/resources/version/b2bTradingPartners/300100073313017/child/outboundCollaborationMessages/300100083098961/child/domainValueMaps", "name" : "domainValueMaps", "kind" : "collection" } ] }