Jump to

• Request
• Response
• Examples

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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "RequestedSupplierContactId":{
            "type":"integer",
            "description":"Value that identifies the contact at the supplier that the application invites to respond to the negotiation. Applies during approval pending.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "AdditionalContactEmail":{
            "title":"Additional Email",
            "maxLength":240,
            "type":"string",
            "description":"Email address of the additional contact for each invited supplier.",
            "nullable":true
        },
        "SupplierSiteId":{
            "type":"integer",
            "description":"Value that identifies the supplier site.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "NotifyAllSupplierContactsFlag":{
            "title":"Notify All Contacts",
            "maxLength":1,
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "SupplierSite":{
            "title":"Supplier Site",
            "maxLength":240,
            "type":"string",
            "description":"Name of the supplier site.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SupplierContact":{
            "type":"string",
            "description":"Name of the supplier employee who represents the supplier during communication with the buying organization.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "PersonTitle",
                    "PersonFirstName",
                    "PersonLastName",
                    "PersonMiddleName"
                ]
            }
        },
        "SupplierContactId":{
            "type":"integer",
            "description":"Value that identifies the supplier employee who represents the supplier during communication with the buying organization.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "supplierLineAccessRestrictions":{
            "title":"Access Restrictions",
            "type":"array",
            "description":"The Access Restrictions resource manages details about negotiation lines where supplier access is restricted.",
            "items":{
                "$ref":"#/components/schemas/supplierNegotiations-suppliers-supplierLineAccessRestrictions-item-patch-request"
            }
        },
        "RequestedSupplierContact":{
            "type":"string",
            "description":"Name of the contact at the supplier that the application invites to respond to the negotiation. Applies during approval pending.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        }
    }
}

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

• Array of: object supplierNegotiations-suppliers-supplierLineAccessRestrictions-item-patch-request

{
    "title":"Access Restrictions",
    "type":"array",
    "description":"The Access Restrictions resource manages details about negotiation lines where supplier access is restricted.",
    "items":{
        "$ref":"#/components/schemas/supplierNegotiations-suppliers-supplierLineAccessRestrictions-item-patch-request"
    }
}

Nested Schema : supplierNegotiations-suppliers-supplierLineAccessRestrictions-item-patch-request

Type: object

Show Source

• Line: string
  Title: Line

  Maximum Length: 25

  Number that identifies the negotiation line.
• LineId: number
  Value that uniquely identifies the negotiation line.

{
    "type":"object",
    "properties":{
        "Line":{
            "title":"Line",
            "maxLength":25,
            "type":"string",
            "description":"Number that identifies the negotiation line.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "LineId":{
            "type":"number",
            "description":"Value that uniquely identifies the negotiation line.",
            "nullable":false
        }
    }
}

Back to Top

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.

Body ()

Root Schema : supplierNegotiations-suppliers-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user created the supplier.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "SupplierInvitationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier invited to the negotiation.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SupplierContact":{
            "type":"string",
            "description":"Name of the supplier employee who represents the supplier during communication with the buying organization.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "PersonTitle",
                    "PersonFirstName",
                    "PersonLastName",
                    "PersonMiddleName"
                ]
            },
            "x-queryable":true
        },
        "SupplierContactId":{
            "type":"integer",
            "description":"Value that identifies the supplier employee who represents the supplier during communication with the buying organization.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RequestedSupplier":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the supplier that the application invites to respond to the negotiation. Applies during approval pending.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PricePrecision":{
            "title":"Price Precision",
            "type":"number",
            "description":"Number of decimal places that the application displays for price attributes in the response.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RequestedSupplierContactId":{
            "type":"integer",
            "description":"Value that identifies the contact at the supplier that the application invites to respond to the negotiation. Applies during approval pending.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SupplierSiteId":{
            "type":"integer",
            "description":"Value that identifies the supplier site.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "NotifyAllSupplierContactsFlag":{
            "title":"Notify All Contacts",
            "maxLength":1,
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Supplier":{
            "title":"Supplier",
            "maxLength":360,
            "type":"string",
            "description":"Name of the supplier company that the application invited to response to the negotiation.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "supplierLineAccessRestrictions":{
            "title":"Access Restrictions",
            "type":"array",
            "description":"The Access Restrictions resource manages details about negotiation lines where supplier access is restricted.",
            "items":{
                "$ref":"#/components/schemas/supplierNegotiations-suppliers-supplierLineAccessRestrictions-item-response"
            }
        },
        "RequestedSupplierContact":{
            "type":"string",
            "description":"Name of the contact at the supplier that the application invites to respond to the negotiation. Applies during approval pending.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AuctionHeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the negotiation.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the supplier.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the supplier.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "SupplierNumber":{
            "type":"integer",
            "description":"Number that identifies the supplier that the application invited to respond to the negotiation.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ResponseCurrencyCode":{
            "title":"Response Currency Code",
            "maxLength":15,
            "type":"string",
            "description":"Abbreviation that identifies the currency that the supplier uses in the negotiation response.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RequestedSupplierId":{
            "type":"integer",
            "description":"Value that identifies the supplier that the application invites to respond to the negotiation. Applies during approval pending.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SupplierId":{
            "type":"integer",
            "description":"Value that identifies the supplier company that the application invited to respond to the negotiation.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AdditionalContactEmail":{
            "title":"Additional Email",
            "maxLength":240,
            "type":"string",
            "description":"Email address of the additional contact for each invited supplier.",
            "nullable":true,
            "x-queryable":true
        },
        "ConversionRate":{
            "title":"Conversion Rate",
            "type":"number",
            "description":"Rate at which the negotiation currency equals one response currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplierSite":{
            "title":"Supplier Site",
            "maxLength":240,
            "type":"string",
            "description":"Name of the supplier site.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ResponseCurrency":{
            "title":"Response Currency",
            "maxLength":80,
            "type":"string",
            "description":"Name of currency that the supplier uses in the negotiation response.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user most recently updated the supplier.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

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

• Array of: object supplierNegotiations-suppliers-supplierLineAccessRestrictions-item-response

{
    "title":"Access Restrictions",
    "type":"array",
    "description":"The Access Restrictions resource manages details about negotiation lines where supplier access is restricted.",
    "items":{
        "$ref":"#/components/schemas/supplierNegotiations-suppliers-supplierLineAccessRestrictions-item-response"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : supplierNegotiations-suppliers-supplierLineAccessRestrictions-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "AuctionHeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the negotiation.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the restriction.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "Line":{
            "title":"Line",
            "maxLength":25,
            "type":"string",
            "description":"Number that identifies the negotiation line.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user created the restriction.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the restriction.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "LineId":{
            "type":"number",
            "description":"Value that uniquely identifies the negotiation line.",
            "nullable":false,
            "x-queryable":true
        },
        "LineDescription":{
            "title":"Line Description",
            "maxLength":2500,
            "type":"string",
            "description":"Description of the negotiation line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplierInvitationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier invited to the negotiation.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user most recently updated the restriction.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Links

supplierLineAccessRestrictions

Operation: /fscmRestApi/resources/11.13.18.05/supplierNegotiations/{supplierNegotiationsUniqID}/child/suppliers/{SupplierInvitationId}/child/supplierLineAccessRestrictions

Parameters:

• SupplierInvitationId: $request.path.SupplierInvitationId
• supplierNegotiationsUniqID: $request.path.supplierNegotiationsUniqID

The Access Restrictions resource manages details about negotiation lines where supplier access is restricted.

Back to Top

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": [. . .]
}

Back to Top