1. REST API for Oracle Fusion Cloud Procurement
  2. Tasks
  3. Supplier Negotiations
  4. Suppliers

Get one supplier

get

/fscmRestApi/resources/11.13.18.05/supplierNegotiations/{supplierNegotiationsUniqID}/child/suppliers/{SupplierInvitationId}

Request

Path Parameters
  • Value that uniquely identifies the supplier invited to the negotiation.
  • 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.
Query Parameters
  • This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2

    Format: <attr1>=<val1>,<attr2>=<value2>
  • When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
  • This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.

    Format: ?fields=Attribute1,Attribute2

    Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
  • This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>

    Example:
    self,canonical
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
  • 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".
  • 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.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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
  • Title: Acknowledged By
    Read Only: true
    Maximum Length: 255
    Name of the supplier contact who acknowledged whether they would participate in the negotiation.
  • Title: Acknowledgment Date
    Read Only: true
    Value that indicates the time when the supplier acknowledged whether they would participate in the negotiation.
  • Title: Note to Buyer
    Read Only: true
    Maximum Length: 4000
    Value that indicates the reason provided by the supplier for participating or not participating in the negotiation.
  • Title: Additional Email
    Maximum Length: 240
    Email address of the additional contact for each invited supplier.
  • Read Only: true
    Value that uniquely identifies the negotiation.
  • Read Only: true
    Maximum Length: 80
    Display name of the business relationship of the supplier's enterprise. Values include None, Prospective, and Spend Authorized.
  • Title: Business Relationship
    Read Only: true
    Maximum Length: 30
    Abbreviation that identifies the business relationship of the supplier's enterprise. Values include NONE, PROSPECTIVE, and SPEND_AUTHORIZED. A list of accepted values is defined in the lookup type ORA_POZ_BUSINESS_RELATIONSHIP.
  • Title: Conversion Rate
    Read Only: true
    Rate at which the negotiation currency equals one response currency.
  • Read Only: true
    Maximum Length: 64
    User who created the supplier.
  • Read Only: true
    Date and time when the user created the supplier.
  • Read Only: true
    Date and time when the user most recently updated the supplier.
  • Read Only: true
    Maximum Length: 64
    User who most recently updated the supplier.
  • Links
  • 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.
  • Read Only: true
    Contains one of the following values: true or false. If true, the price precision is read-only. If false, the price precision is editable.
  • Title: Price Precision
    Read Only: true
    Number of decimal places that the application displays for price attributes in the response.
  • Read Only: true
    Contains one of the following values: true or false. If true, the conversion rate is read-only. If false, the conversion rate is editable.
  • Read Only: true
    Maximum Length: 80
    Display name of the status of the supplier's registration request. Values include Approved, Not Submitted, Pending Approval, and Rejected.
  • Read Only: true
    Maximum Length: 30
    Abbreviation that identifies the status of the supplier's registration request. Values include APPROVED, DRAFT, PENDING, and REJECTED.
  • Maximum Length: 240
    Name of the supplier that the application invites to respond to the negotiation. Applies during approval pending.
  • Name of the contact at the supplier that the application invites to respond to the negotiation. Applies during approval pending.
  • Value that identifies the contact at the supplier that the application invites to respond to the negotiation. Applies during approval pending.
  • Value that identifies the supplier that the application invites to respond to the negotiation. Applies during approval pending.
  • Title: Response Currency
    Read Only: true
    Maximum Length: 80
    Name of currency that the supplier uses in the negotiation response.
  • Title: Response Currency Code
    Read Only: true
    Maximum Length: 15
    Abbreviation that identifies the currency that the supplier uses in the negotiation response.
  • Read Only: true
    Maximum Length: 80
    Display name of the supplier's spend authorization review status. Values include Pending Approval and Rejected.
  • Read Only: true
    Maximum Length: 30
    Abbreviation that identifies the supplier's spend authorization review status. Values include PENDING_APPROVAL and REJECTED. A list of accepted values is defined in the lookup type ORA_POZ_SPEND_AUTH_REV_STATUS.
  • Title: Will Participate
    Read Only: true
    Maximum Length: 1
    Value that indicates whether the supplier intends to participate in the negotiation.
  • Title: Supplier
    Maximum Length: 360
    Name of the supplier company that the application invited to response to the negotiation.
  • Name of the supplier employee who represents the supplier during communication with the buying organization.
  • Value that identifies the supplier employee who represents the supplier during communication with the buying organization.
  • Read Only: true
    Maximum Length: 80
    Display name of the status indicating whether supplier creation was successful after approval. Values include Canceled, Completed, and Error. A list of accepted values is defined in the lookup type POZ_SUPPLIER_CREATION_STATUS.
  • Read Only: true
    Maximum Length: 30
    Abbreviation that identifies the status indicating whether supplier creation was successful after approval. Values include CANCELED, COMPLETED, and ERROR. A list of accepted values is defined in the lookup type POZ_SUPPLIER_CREATION_STATUS.
  • Read Only: true
    Maximum Length: 255
    Display name of the supplier's sourcing eligibility status. Values include Eligible, Not eligible, and Eligible with warning.
  • Read Only: true
    Maximum Length: 255
    Abbreviation that identifies the supplier's sourcing eligibility status. Values include ALLOWED, NOT_ALLOWED, and WARNING. A list of accepted values is defined in the lookup type ORA_POQ_SOURCING_ELIGIBILITY.
  • Value that identifies the supplier company that the application invited to respond to the negotiation.
  • Read Only: true
    Value that uniquely identifies the supplier invited to the negotiation.
  • Access Restrictions
    Title: Access Restrictions
    The Access Restrictions resource manages details about negotiation lines where supplier access is restricted.
  • Read Only: true
    Number that identifies the supplier that the application invited to respond to the negotiation.
  • Read Only: true
    Value that uniquely identifies the supplier company.
  • Title: Supplier Responses
    Read Only: true
    Number of active responses submitted by a supplier.
  • Title: Supplier Site
    Maximum Length: 240
    Name of the supplier site.
  • Value that identifies the supplier site.
  • Read Only: true
    Number that uniquely identifies the supplier.
  • Title: Supplier Number
    Read Only: true
    Maximum Length: 30
    Number that identifies the supplier and may be visible to the buying organization.
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-response
Type: object
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.
Back to Top

Examples

This example describes how to get one supplier.

Example cURL Command

Use the following cURL command to submit a request on the REST resource:

curl -u username:password "https://servername/fscmRestApi/resources/version/supplierNegotiations/supplierNegotiationsUniqID/child/suppliers/SupplierInvitationId"

Example Response Body

The following example includes the contents of the response body in JSON format:
{
    "AuctionHeaderId": 300100152357495,
    "SupplierInvitationId": 30,
    "SupplierNumber": 12,
    "Supplier": "CV_SuppA01",
    "SupplierId": 12496,
    "SupplierSite": "CVSuppA01Site01",
    "SupplierSiteId": 2444,
    "SupplierContact": "Brown, Rob",
    "SupplierContactId": 299647,
    "AdditionalContactEmail": null,
    "NotifyAllSupplierContactsFlag": true,
    "RequestedSupplier": null,
    "RequestedSupplierId": null,
    "RequestedSupplierContact": null,
    "RequestedSupplierContactId": null,
    "ResponseCurrency": "US Dollar",
    "ResponseCurrencyCode": "USD",
    "ConversionRate": 1,
    "PricePrecision": 2,
    "CreatedBy": "CVBUYER01",
    "CreationDate": "2018-06-28T11:33:14.566+00:00",
    "LastUpdateDate": "2018-06-28T11:34:48.919+00:00",
    "LastUpdatedBy": "CVBUYER01",
    "links": [<Do not change anything here>]
}
Back to Top