Jump to

• Request
• Response

Update one bidder

patch

/fscmRestApi/resources/11.13.18.05/sellerNegotiations/{sellerNegotiationsUniqID}/child/bidders/{BidderInvitationId}

Request

Path Parameters

• BidderInvitationId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
• sellerNegotiationsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Seller Negotiations resource and used to uniquely identify an instance of Seller Negotiations. The client should not generate the hash key value. Instead, the client should query on the Seller Negotiations collection resource in order to navigate to a specific instance of Seller Negotiations to get the hash key.

Header Parameters

• Metadata-Context: string
  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: string
  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

• BidderContact: string
  Title: Bidder Contact

  Maximum Length: 255

  Name of the contact person associated with the bidder invited to participate in the seller negotiation.
• BidderContactId: integer (int64)
  Value that uniquely identifies the contact person associated with the bidder invited to participate in the seller negotiation.
• BidderSite: string
  Title: Bidder Site

  Maximum Length: 240

  Bidder site name linked to the bidder invited for seller negotiation.
• BidderSiteId: integer (int64)
  Value that uniquely identifies the bidder site associated with the bidder invited to participate in the seller negotiation.
• RequestedBidderContact: string
  Title: Bidder Contact

  Maximum Length: 255

  The name of the contact person at the bidding company who should respond to the negotiation. This value applies when the bidder approval is pending.
• RequestedBidderContactId: integer (int64)
  The value identifies the contact person at the bidder who's invited to respond to the negotiation. This value applies when the bidder approval is pending.

{
    "type":"object",
    "properties":{
        "BidderContact":{
            "title":"Bidder Contact",
            "maxLength":255,
            "type":"string",
            "description":"Name of the contact person associated with the bidder invited to participate in the seller negotiation.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "sortable":false,
                "dependencies":[
                    "PersonFirstName",
                    "PersonLastName",
                    "PersonMiddleName",
                    "PersonTitle"
                ]
            }
        },
        "BidderContactId":{
            "type":"integer",
            "description":"Value that uniquely identifies the contact person associated with the bidder invited to participate in the seller negotiation.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18,
                "sortable":false,
                "dependencies":[
                    "BidderId"
                ]
            }
        },
        "BidderSite":{
            "title":"Bidder Site",
            "maxLength":240,
            "type":"string",
            "description":"Bidder site name linked to the bidder invited for seller negotiation.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "BidderSiteId":{
            "type":"integer",
            "description":"Value that uniquely identifies the bidder site associated with the bidder invited to participate in the seller negotiation.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18,
                "sortable":false,
                "dependencies":[
                    "BidderId"
                ]
            }
        },
        "RequestedBidderContact":{
            "title":"Bidder Contact",
            "maxLength":255,
            "type":"string",
            "description":"The name of the contact person at the bidding company who should respond to the negotiation. This value applies when the bidder approval is pending.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "sortable":false,
                "dependencies":[
                    "ContactTitle",
                    "FirstName",
                    "LastName",
                    "MiddleName"
                ]
            }
        },
        "RequestedBidderContactId":{
            "type":"integer",
            "description":"The value identifies the contact person at the bidder who's invited to respond to the negotiation. This value applies when the bidder approval is pending.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18,
                "sortable":false,
                "dependencies":[
                    "RequestedBidderId"
                ]
            }
        }
    }
}

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 : sellerNegotiations-bidders-item-response

Type: object

Show Source

• Bidder: string
  Title: Bidder

  Maximum Length: 360

  Name of the bidder that the application invited to participate in the seller negotiation.
• BidderContact: string
  Title: Bidder Contact

  Maximum Length: 255

  Name of the contact person associated with the bidder invited to participate in the seller negotiation.
• BidderContactId: integer (int64)
  Value that uniquely identifies the contact person associated with the bidder invited to participate in the seller negotiation.
• BidderCreationStatus: string
  Read Only: true

  Maximum Length: 255

  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.
• BidderCreationStatusCode: string
  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.
• BidderId: integer (int64)
  Value that uniquely identifies the bidder that the application invited to participate in the seller negotiation.
• BidderInvitationId: integer (int64)
  Read Only: true

  Value that uniquely identifies the bidder invited to the negotiation.
• BidderSite: string
  Title: Bidder Site

  Maximum Length: 240

  Bidder site name linked to the bidder invited for seller negotiation.
• BidderSiteId: integer (int64)
  Value that uniquely identifies the bidder site associated with the bidder invited to participate in the seller negotiation.
• BusinessRelationship: string
  Read Only: true

  Maximum Length: 255

  Type of business relationship that the bidder has with the organization conducting the seller negotiation. Values include None, Prospective, and Spend Authorized.
• BusinessRelationshipCode: string
  Title: Business Relationship

  Read Only: true

  Maximum Length: 30

  Abbreviation that identifies the type of business relationship that the bidder has with the organization conducting the seller negotiation. Values include NONE, PROSPECTIVE, and SPEND_AUTHORIZED. A list of accepted values is defined in the lookup type ORA_POZ_PURCHASING_RELATIONSHIP.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who added the bidder to the negotiation.
• CreationDate: string (date-time)
  Read Only: true

  Date and time when the user added the bidder to the negotiation.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date and time when the user most recently updated the bidder.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the bidder.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• RegistrationStatus: string
  Read Only: true

  Maximum Length: 255

  Status of the bidder's registration request. Values include Approved, Not Submitted, Pending Approval, and Rejected.
• RegistrationStatusCode: string
  Read Only: true

  Maximum Length: 30

  Abbreviation that identifies the status of the bidder's registration request. Values include APPROVED, DRAFT, PENDING, and REJECTED.
• RequestedBidder: string
  Read Only: true

  Maximum Length: 240

  Name of the bidder invited to the negotiation whose registration is pending approval.
• RequestedBidderContact: string
  Title: Bidder Contact

  Maximum Length: 255

  The name of the contact person at the bidding company who should respond to the negotiation. This value applies when the bidder approval is pending.
• RequestedBidderContactId: integer (int64)
  The value identifies the contact person at the bidder who's invited to respond to the negotiation. This value applies when the bidder approval is pending.
• RequestedBidderId: integer (int64)
  Value that identifies the bidder that the application invites to respond to the negotiation. Applies during approval pending.
• SellerAuctionHeaderId: integer (int64)
  Read Only: true

  Value that uniquely identifies the seller negotiation.
• SpendAuthorizationReviewStatus: string
  Read Only: true

  Maximum Length: 255

  Status of the bidder's spend authorization review. Values include Pending Approval and Rejected.
• SpendAuthorizationReviewStatusCode: string
  Read Only: true

  Maximum Length: 30

  Abbreviation that indicates the status of the bidder's spend authorization review. The possible statuses are PENDING_APPROVAL and REJECTED. Accepted statuses can be found in the lookup type ORA_POZ_SPEND_AUTH_REV_STATUS.
• VendorId: integer (int64)
  Read Only: true

  Number that uniquely identifies the supplier.

{
    "type":"object",
    "properties":{
        "Bidder":{
            "title":"Bidder",
            "maxLength":360,
            "type":"string",
            "description":"Name of the bidder that the application invited to participate in the seller negotiation.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "BidderContact":{
            "title":"Bidder Contact",
            "maxLength":255,
            "type":"string",
            "description":"Name of the contact person associated with the bidder invited to participate in the seller negotiation.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "sortable":false,
                "dependencies":[
                    "PersonFirstName",
                    "PersonLastName",
                    "PersonMiddleName",
                    "PersonTitle"
                ]
            }
        },
        "BidderContactId":{
            "type":"integer",
            "description":"Value that uniquely identifies the contact person associated with the bidder invited to participate in the seller negotiation.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18,
                "sortable":false,
                "dependencies":[
                    "BidderId"
                ]
            }
        },
        "BidderCreationStatus":{
            "maxLength":255,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false,
                "dependencies":[
                    "Bidder",
                    "BidderId",
                    "RequestedBidder",
                    "RequestedBidderId",
                    "BidderCreationStatusCode"
                ]
            }
        },
        "BidderCreationStatusCode":{
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "BidderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the bidder that the application invited to participate in the seller negotiation.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "sortable":false
            },
            "x-queryable":true
        },
        "BidderInvitationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the bidder invited to the negotiation.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "sortable":false,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "BidderSite":{
            "title":"Bidder Site",
            "maxLength":240,
            "type":"string",
            "description":"Bidder site name linked to the bidder invited for seller negotiation.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "BidderSiteId":{
            "type":"integer",
            "description":"Value that uniquely identifies the bidder site associated with the bidder invited to participate in the seller negotiation.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18,
                "sortable":false,
                "dependencies":[
                    "BidderId"
                ]
            }
        },
        "BusinessRelationship":{
            "maxLength":255,
            "type":"string",
            "description":"Type of business relationship that the bidder has with the organization conducting the seller negotiation. Values include None, Prospective, and Spend Authorized.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false,
                "dependencies":[
                    "Bidder",
                    "BidderId",
                    "BusinessRelationshipCode",
                    "RequestedBidder",
                    "RequestedBidderId"
                ]
            }
        },
        "BusinessRelationshipCode":{
            "title":"Business Relationship",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the type of business relationship that the bidder has with the organization conducting the seller negotiation. Values include NONE, PROSPECTIVE, and SPEND_AUTHORIZED. A list of accepted values is defined in the lookup type ORA_POZ_PURCHASING_RELATIONSHIP.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who added the bidder to the negotiation.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user added the bidder to the negotiation.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user most recently updated the bidder.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the bidder.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "RegistrationStatus":{
            "maxLength":255,
            "type":"string",
            "description":"Status of the bidder's registration request. Values include Approved, Not Submitted, Pending Approval, and Rejected.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false,
                "dependencies":[
                    "Bidder",
                    "BidderId",
                    "RegistrationStatusCode",
                    "RequestedBidder",
                    "RequestedBidderId"
                ]
            }
        },
        "RegistrationStatusCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the status of the bidder's registration request. Values include APPROVED, DRAFT, PENDING, and REJECTED.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "RequestedBidder":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the bidder invited to the negotiation whose registration is pending approval.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "RequestedBidderContact":{
            "title":"Bidder Contact",
            "maxLength":255,
            "type":"string",
            "description":"The name of the contact person at the bidding company who should respond to the negotiation. This value applies when the bidder approval is pending.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "sortable":false,
                "dependencies":[
                    "ContactTitle",
                    "FirstName",
                    "LastName",
                    "MiddleName"
                ]
            }
        },
        "RequestedBidderContactId":{
            "type":"integer",
            "description":"The value identifies the contact person at the bidder who's invited to respond to the negotiation. This value applies when the bidder approval is pending.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18,
                "sortable":false,
                "dependencies":[
                    "RequestedBidderId"
                ]
            }
        },
        "RequestedBidderId":{
            "type":"integer",
            "description":"Value that identifies the bidder that the application invites to respond to the negotiation. Applies during approval pending.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18,
                "sortable":false
            }
        },
        "SellerAuctionHeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the seller negotiation.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "sortable":false
            },
            "x-queryable":true
        },
        "SpendAuthorizationReviewStatus":{
            "maxLength":255,
            "type":"string",
            "description":"Status of the bidder's spend authorization review. Values include Pending Approval and Rejected.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false,
                "dependencies":[
                    "Bidder",
                    "BidderId",
                    "RequestedBidder",
                    "RequestedBidderId",
                    "SpendAuthorizationReviewStatusCode"
                ]
            }
        },
        "SpendAuthorizationReviewStatusCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that indicates the status of the bidder's spend authorization review. The possible statuses are PENDING_APPROVAL and REJECTED. Accepted statuses can be found in the lookup type ORA_POZ_SPEND_AUTH_REV_STATUS.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "VendorId":{
            "type":"integer",
            "description":"Number that uniquely identifies the supplier.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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

Back to Top