Create a customer trading partner
post
/fscmRestApi/resources/11.13.18.05/nettingAgreements/{nettingAgreementsUniqID}/child/nettingCustomerTradingPartners
Request
Path Parameters
-
nettingAgreementsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Netting Agreements resource and used to uniquely identify an instance of Netting Agreements. The client should not generate the hash key value. Instead, the client should query on the Netting Agreements collection resource in order to navigate to a specific instance of Netting Agreements to get the hash key.
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
-
CustomerAccountNumber: string
Maximum Length:
255
The account number of the customer trading partner. -
CustomerName: string
Maximum Length:
255
The name of the customer trading partner. -
CustomerPriority: integer
(int64)
Indicates the priority of the customer trading partner in the netting agreement.
-
CustomerSite: string
Maximum Length:
255
The site of the customer trading partner. -
NettingCustomerId: integer
(int64)
The unique identifier of the customer 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 : nettingAgreements-nettingCustomerTradingPartners-item-response
Type:
Show Source
object
-
CustomerAccountNumber: string
Maximum Length:
255
The account number of the customer trading partner. -
CustomerName: string
Maximum Length:
255
The name of the customer trading partner. -
CustomerPriority: integer
(int64)
Indicates the priority of the customer trading partner in the netting agreement.
-
CustomerSite: string
Maximum Length:
255
The site of the customer trading partner. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NettingCustomerId: integer
(int64)
The unique identifier of the customer 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
The following example shows how to create a customer trading partner for a netting agreement by submitting a POST request on the REST resource using cURL.
curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -X POST -d <payload> https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/nettingAgreements/300100548064810/child/nettingCustomerTradingPartners
Example Request Body
The following example shows the contents of the request body in JSON format:
{ "CustomerPriority": 2, "CustomerName": "DE Int Customer", "CustomerAccountNumber": "CDRM_213279", "CustomerSite": "CDRM_190374" }
Example Response Body
The following example shows the contents of the response body in JSON format:
{ "NettingCustomerId": 300100548119811, "CustomerPriority": 2, "CustomerName": "DE Int Customer", "CustomerAccountNumber": "CDRM_213279", "CustomerSite": "CDRM_190374", "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/nettingAgreements/300100548064810/child/nettingCustomerTradingPartners/300100548119811", "name": "nettingCustomerTradingPartners", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/nettingAgreements/300100548064810/child/nettingCustomerTradingPartners/300100548119811", "name": "nettingCustomerTradingPartners", "kind": "item" }, { "rel": "parent", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/nettingAgreements/300100548064810", "name": "nettingAgreements", "kind": "item" } ] }