Update one supplier
patch
/fscmRestApi/resources/11.13.18.05/supplierNegotiations/{supplierNegotiationsUniqID}/child/suppliers/{SupplierInvitationId}
Request
Path Parameters
-
SupplierInvitationId(required): integer(int64)
Value that uniquely identifies the supplier invited to the negotiation.
-
supplierNegotiationsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Supplier Negotiations resource and used to uniquely identify an instance of Supplier Negotiations. The client should not generate the hash key value. Instead, the client should query on the Supplier Negotiations collection resource in order to navigate to a specific instance of Supplier Negotiations 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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
AdditionalContactEmail: string
Title:
Additional Email
Maximum Length:240
Email address of the additional contact for each invited supplier. -
NotifyAllSupplierContactsFlag: boolean
Title:
Notify All Contacts
Maximum Length:1
Contains one of the following values: true or false. If true, then notifications are sent to all contacts of the supplier. If false, notifications are sent only to the invited contact or additional email of the supplier. The default value is false. -
RequestedSupplierContact: string
Name of the contact at the supplier that the application invites to respond to the negotiation. Applies during approval pending.
-
RequestedSupplierContactId: integer
(int64)
Value that identifies the contact at the supplier that the application invites to respond to the negotiation. Applies during approval pending.
-
SupplierContact: string
Name of the supplier employee who represents the supplier during communication with the buying organization.
-
SupplierContactId: integer
(int64)
Value that identifies the supplier employee who represents the supplier during communication with the buying organization.
-
supplierLineAccessRestrictions: array
Access Restrictions
Title:
Access Restrictions
The Access Restrictions resource manages details about negotiation lines where supplier access is restricted. -
SupplierSite: string
Title:
Supplier Site
Maximum Length:240
Name of the supplier site. -
SupplierSiteId: integer
(int64)
Value that identifies the supplier site.
Nested Schema : Access Restrictions
Type:
array
Title:
Access Restrictions
The Access Restrictions resource manages details about negotiation lines where supplier access is restricted.
Show Source
Nested Schema : supplierNegotiations-suppliers-supplierLineAccessRestrictions-item-patch-request
Type:
Show Source
object
-
Line: string
Title:
Line
Maximum Length:25
Number that identifies the negotiation line. -
LineId: number
Value that uniquely identifies the negotiation line.
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 : supplierNegotiations-suppliers-item-response
Type:
Show Source
object
-
AdditionalContactEmail: string
Title:
Additional Email
Maximum Length:240
Email address of the additional contact for each invited supplier. -
AuctionHeaderId: integer
(int64)
Read Only:
true
Value that uniquely identifies the negotiation. -
ConversionRate: number
Title:
Conversion Rate
Read Only:true
Rate at which the negotiation currency equals one response currency. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the supplier. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the user created the supplier. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the user most recently updated the supplier. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the supplier. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NotifyAllSupplierContactsFlag: boolean
Title:
Notify All Contacts
Maximum Length:1
Contains one of the following values: true or false. If true, then notifications are sent to all contacts of the supplier. If false, notifications are sent only to the invited contact or additional email of the supplier. The default value is false. -
PricePrecision: number
Title:
Price Precision
Read Only:true
Number of decimal places that the application displays for price attributes in the response. -
RequestedSupplier: string
Maximum Length:
240
Name of the supplier that the application invites to respond to the negotiation. Applies during approval pending. -
RequestedSupplierContact: string
Name of the contact at the supplier that the application invites to respond to the negotiation. Applies during approval pending.
-
RequestedSupplierContactId: integer
(int64)
Value that identifies the contact at the supplier that the application invites to respond to the negotiation. Applies during approval pending.
-
RequestedSupplierId: integer
(int64)
Value that identifies the supplier that the application invites to respond to the negotiation. Applies during approval pending.
-
ResponseCurrency: string
Title:
Response Currency
Read Only:true
Maximum Length:80
Name of currency that the supplier uses in the negotiation response. -
ResponseCurrencyCode: string
Title:
Response Currency Code
Read Only:true
Maximum Length:15
Abbreviation that identifies the currency that the supplier uses in the negotiation response. -
Supplier: string
Title:
Supplier
Maximum Length:360
Name of the supplier company that the application invited to response to the negotiation. -
SupplierContact: string
Name of the supplier employee who represents the supplier during communication with the buying organization.
-
SupplierContactId: integer
(int64)
Value that identifies the supplier employee who represents the supplier during communication with the buying organization.
-
SupplierId: integer
(int64)
Value that identifies the supplier company that the application invited to respond to the negotiation.
-
SupplierInvitationId: integer
(int64)
Read Only:
true
Value that uniquely identifies the supplier invited to the negotiation. -
supplierLineAccessRestrictions: array
Access Restrictions
Title:
Access Restrictions
The Access Restrictions resource manages details about negotiation lines where supplier access is restricted. -
SupplierNumber: integer
(int64)
Read Only:
true
Number that identifies the supplier that the application invited to respond to the negotiation. -
SupplierSite: string
Title:
Supplier Site
Maximum Length:240
Name of the supplier site. -
SupplierSiteId: integer
(int64)
Value that identifies the supplier site.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Access Restrictions
Type:
array
Title:
Access Restrictions
The Access Restrictions resource manages details about negotiation lines where supplier access is restricted.
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 : supplierNegotiations-suppliers-supplierLineAccessRestrictions-item-response
Type:
Show Source
object
-
AuctionHeaderId: integer
(int64)
Read Only:
true
Value that uniquely identifies the negotiation. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the restriction. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the user created the restriction. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the user most recently updated the restriction. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the restriction. -
Line: string
Title:
Line
Maximum Length:25
Number that identifies the negotiation line. -
LineDescription: string
Title:
Line Description
Read Only:true
Maximum Length:2500
Description of the negotiation line. -
LineId: number
Value that uniquely identifies the negotiation line.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
SupplierInvitationId: integer
(int64)
Read Only:
true
Value that uniquely identifies the supplier invited to the negotiation.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- supplierLineAccessRestrictions
-
Parameters:
- SupplierInvitationId:
$request.path.SupplierInvitationId
- supplierNegotiationsUniqID:
$request.path.supplierNegotiationsUniqID
The Access Restrictions resource manages details about negotiation lines where supplier access is restricted. - SupplierInvitationId:
Examples
This example describes how to update one supplier.
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/supplierNegotiations/supplierNegotiationsUniqID/child/suppliers/SupplierInvitationId"
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.
{ "SupplierContact": "Smith, Andrew", "NotifyAllSupplierContactsFlag": true, "AdditionalContactEmail": null }
Example Response Body
The following example includes the contents of the response body in JSON format:
{ "AuctionHeaderId": 300100195048519, "SupplierInvitationId": 10, "SupplierNumber": 641, "Supplier": "Tall Manufacturing", "SupplierId": 35320, "SupplierSite": "Atlanta", "SupplierSiteId": 5298, "SupplierContact": "Smith, Andrew", "SupplierContactId": 399802, "AdditionalContactEmail": null, "NotifyAllSupplierContactsFlag": true, "RequestedSupplier": null, "RequestedSupplierId": null, "RequestedSupplierContact": null, "RequestedSupplierContactId": null, "ResponseCurrency": null, "ResponseCurrencyCode": null, "ConversionRate": null, "PricePrecision": null, "CreatedBy": "CLARE.JONES", "CreationDate": "2020-05-28T17:23:01.025+00:00", "LastUpdateDate": "2020-05-28T17:26:23+00:00", "LastUpdatedBy": "CLARE.JONES", "links": [. . .] }