Update one confirmation code
patch
/fscmRestApi/resources/11.13.18.05/b2bTradingPartners/{TradingPartnerId}/child/confirmationCodes/{ConfStatusXrefId}
Request
Path Parameters
-
ConfStatusXrefId(required): integer(int64)
Value that uniquely identifies the confirmation code. It is a primary key that the application generates when it creates a confirmation code record. This attribute is required.
-
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
-
CollaborationStatus: string
Maximum Length:
100
Value that specifies the status of the collaboration message. -
PartnerStatus: string
Maximum Length:
256
Value that specifies the status of confirmation of the trading partner.
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-confirmationCodes-item-response
Type:
Show Source
object
-
CollaborationStatus: string
Maximum Length:
100
Value that specifies the status of the collaboration message. -
ConfStatusXrefId: integer
(int64)
Value that uniquely identifies the confirmation code. It is a primary key that the application generates when it creates a confirmation code record. This attribute is required.
-
CreationDate: string
(date-time)
Read Only:
true
Date when the user defined the confirmation code for the trading partner. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date when the user most recently updated the confirmation code associated with the trading partner. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PartnerStatus: string
Maximum Length:
256
Value that specifies the status of confirmation of the trading partner.
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.
Examples
This example describes how to update one confirmation code.
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/confirmationCodes/ConfStatusXrefId"
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.
{ "CollaborationStatus" : "Other" }
Example Response Body
The following example includes the contents of the response body in JSON format:
{ "ConfStatusXrefId" : 300100177412767, "PartnerStatus" : "12345", "CollaborationStatus" : "Other", "links" : [ { "rel" : "self", "href" : "https://servername/fscmRestApi/resources/version/b2bTradingPartners/300100123932117/child/confirmationCodes/300100177412767", "name" : "confirmationCodes", "kind" : "item", "properties" : { "changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278" } }, { "rel" : "canonical", "href" : "https://servername/fscmRestApi/resources/version/b2bTradingPartners/300100123932117/child/confirmationCodes/300100177412767", "name" : "confirmationCodes", "kind" : "item" }, { "rel" : "parent", "href" : "https://servername/fscmRestApi/resources/version/b2bTradingPartners/300100123932117", "name" : "b2bTradingPartners", "kind" : "item" }, { "rel" : "lov", "href" : "https://servername/fscmRestApi/resources/version/b2bTradingPartners/300100123932117/child/confirmationCodes/300100177412767/lov/messageStatusLOV", "name" : "messageStatusLOV", "kind" : "collection" } ] }