Update
patch
/fscmRestApi/resources/11.13.18.05/b2bTradingPartners/{TradingPartnerId}/child/inboundCollaborationMessages/{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)
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: string
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version: string
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object-
AcknowledgementCode: string
Maximum Length:
100Default Value:Never -
ApplicationPartnerCodeXpath: string
Maximum Length:
2000 -
domainValueMaps: array
domainValueMaps
-
LastUpdateDate: string
(date-time)
-
MessageId: integer
(int64)
Title:
Collaboration Message Definition -
MessageName: string
-
messageProcessingRules: array
messageProcessingRules
-
ObjectKey1Xpath: string
Maximum Length:
2000 -
ObjectKey2Xpath: string
Maximum Length:
2000 -
ObjectKey3Xpath: string
Maximum Length:
2000 -
ObjectKey4Xpath: string
Maximum Length:
2000 -
ObjectKey5Xpath: string
Maximum Length:
2000 -
ObjectKey6Xpath: string
Maximum Length:
2000 -
OverrideStatus: string
Maximum Length:
100 -
OverrideStatusDate: string
(date-time)
-
PartnerMessageStatus: string
Maximum Length:
100 -
PartnerMessageStatusDate: string
(date-time)
-
ProcessingAction: string
Maximum Length:
256 -
RetentionDuration: integer
(int32)
Title:
Retention Duration -
RetentionDurationType: string
Title:
Retention Duration UnitMaximum Length:100
Nested Schema : b2bTradingPartners-inboundCollaborationMessages-domainValueMaps-item-patch-request
Type:
Show Source
objectNested Schema : b2bTradingPartners-inboundCollaborationMessages-messageProcessingRules-item-patch-request
Type:
Show Source
object-
DefaultValue: string
Maximum Length:
512 -
IncludeInOutputFlag: boolean
Maximum Length:
100 -
MessageNodeXpath: string
Maximum Length:
2000 -
Name: string
Maximum Length:
512 -
ValueRequiredFlag: boolean
Maximum Length:
100
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 : b2bTradingPartners-inboundCollaborationMessages-item-response
Type:
Show Source
object-
AcknowledgementCode: string
Maximum Length:
100Default Value:Never -
ApplicationPartnerCodeXpath: string
Maximum Length:
2000 -
CreationDate: string
(date-time)
-
DocumentId: integer
(int64)
-
DocumentName: string
Read Only:
trueMaximum Length:256 -
domainValueMaps: array
domainValueMaps
-
LastUpdateDate: string
(date-time)
-
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MessageId: integer
(int64)
Title:
Collaboration Message Definition -
MessageName: string
-
messageProcessingRules: array
messageProcessingRules
-
ObjectKey1Xpath: string
Maximum Length:
2000 -
ObjectKey2Xpath: string
Maximum Length:
2000 -
ObjectKey3Xpath: string
Maximum Length:
2000 -
ObjectKey4Xpath: string
Maximum Length:
2000 -
ObjectKey5Xpath: string
Maximum Length:
2000 -
ObjectKey6Xpath: string
Maximum Length:
2000 -
OverrideStatus: string
Maximum Length:
100 -
OverrideStatusDate: string
(date-time)
-
PartnerMessageCustomizationId: integer
(int64)
-
PartnerMessageId: integer
(int64)
-
PartnerMessageName: string
Title:
NameMaximum Length:256 -
PartnerMessageStatus: string
Maximum Length:
100 -
PartnerMessageStatusDate: string
(date-time)
-
ProcessingAction: string
Maximum Length:
256 -
RetentionDuration: integer
(int32)
Title:
Retention Duration -
RetentionDurationType: string
Title:
Retention Duration UnitMaximum Length:100 -
UserDefinedFlag: boolean
Read Only:
true
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : b2bTradingPartners-inboundCollaborationMessages-domainValueMaps-item-response
Type:
Show Source
object-
CreationDate: string
(date-time)
Read Only:
true -
DvmName: string
Read Only:
trueMaximum Length:256 -
LastUpdateDate: string
(date-time)
Read Only:
true -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MessageDvmId: integer
(int64)
Read Only:
true -
MessageId: integer
(int64)
Read Only:
true -
MessageName: string
Read Only:
true
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed 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-inboundCollaborationMessages-messageProcessingRules-item-response
Type:
Show Source
object-
CreationDate: string
(date-time)
Read Only:
true -
DefaultValue: string
Maximum Length:
512 -
IncludeInOutputFlag: boolean
Maximum Length:
100 -
LastUpdateDate: string
(date-time)
Read Only:
true -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MessageNodeXpath: string
Maximum Length:
2000 -
Name: string
Maximum Length:
512 -
NodeId: integer
(int64)
-
ValueRequiredFlag: boolean
Maximum Length:
100
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Links
- domainValueMaps
-
Parameters:
- PartnerMessageId:
$request.path.PartnerMessageId - TradingPartnerId:
$request.path.TradingPartnerId
- PartnerMessageId:
- messageProcessingRules
-
Parameters:
- PartnerMessageId:
$request.path.PartnerMessageId - TradingPartnerId:
$request.path.TradingPartnerId
- PartnerMessageId:
Examples
This example describes how to update one inbound collaboration 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/inboundCollaborationMessages/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" : "Inactive"
}
Example Response Body
The following example includes the contents of the response body in JSON format:
"{
""PartnerMessageId"" : 300100073313023,
""PartnerMessageName"" : ""Namein10_1_1"",
""PartnerMessageStatus"" : ""Entered"",
""PartnerMessageStatusDate"" : ""2015-12-03T12:02:04.987+00:00"",
""AcknowledgementCode"" : ""Never"",
""ProcessingAction"" : ""AcknowledgeReceiptAdvice"",
""ApplicationPartnerCodeXpath"" : ""AcknowledgeReceiveDelivery/DataArea/ReceiveDelivery/ReceiveDeliveryItem/Party/Location/ID"",
""ObjectKey1Xpath"" : null,
""ObjectKey2Xpath"" : null,
""ObjectKey3Xpath"" : null,
""ObjectKey4Xpath"" : null,
""ObjectKey5Xpath"" : null,
""ObjectKey6Xpath"" : null,
""MessageId"" : 40033,
""MessageName"" : ""OAGIS_10.1_ACK_RCV_DEL_COLLAB_MSG_IN"",
""DocumentId"" : 40022,
""PartnerMessageCustomizationId"" : 300100073313023,
""RetentionDuration"" : null,
""RetentionDurationType"" : null,
""OverrideStatus"" : ""Inactive"",
""OverrideStatusDate"" : null,
""links"" : [ {
""rel"" : ""self"",
""href"" : ""https://servername/fscmRestApi/resources/version/b2bTradingPartners/300100073313017/child/inboundCollaborationMessages/300100073313023"",
""name"" : ""inboundCollaborationMessages"",
""kind"" : ""item"",
""properties"" : {
""changeIndicator"" : ""ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000002770400000002737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000274001353434D5F494D504C5F434F4E53554C54414E5478""
}
}, {
""rel"" : ""canonical"",
""href"" : ""https://servername/fscmRestApi/resources/version/b2bTradingPartners/300100073313017/child/inboundCollaborationMessages/300100073313023"",
""name"" : ""inboundCollaborationMessages"",
""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/inboundCollaborationMessages/300100073313023/lov/retentionDurationTypesLOV"",
""name"" : ""retentionDurationTypesLOV"",
""kind"" : ""collection""
}, {
""rel"" : ""lov"",
""href"" : ""https://servername/fscmRestApi/resources/version/b2bTradingPartners/300100073313017/child/inboundCollaborationMessages/300100073313023/lov/messagesLOV"",
""name"" : ""messagesLOV"",
""kind"" : ""collection""
}, {
""rel"" : ""lov"",
""href"" : ""https://servername/fscmRestApi/resources/version/b2bTradingPartners/300100073313017/child/inboundCollaborationMessages/300100073313023/lov/overrideStatusLOV"",
""name"" : ""overrideStatusLOV"",
""kind"" : ""collection""
}, {
""rel"" : ""child"",
""href"" : ""https://servername/fscmRestApi/resources/version/b2bTradingPartners/300100073313017/child/inboundCollaborationMessages/300100073313023/child/messageProcessingRules"",
""name"" : ""messageProcessingRules"",
""kind"" : ""collection""
}, {
""rel"" : ""child"",
""href"" : ""https://servername/fscmRestApi/resources/version/b2bTradingPartners/300100073313017/child/inboundCollaborationMessages/300100073313023/child/domainValueMaps"",
""name"" : ""domainValueMaps"",
""kind"" : ""collection""
} ]
}"