Jump to

• Request
• Response

GET action not supported

get

/fscmRestApi/resources/11.13.18.05/supplierNegotiations/{supplierNegotiationsUniqID}/child/negotiationRecommendedSuppliers/{HeaderSuppRecommId}

Request

Path Parameters

• HeaderSuppRecommId(required): integer(int64)
  Value that uniquely identifies the recommended supplier for a 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.

Query Parameters

• dependency: string
  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>
• expand: string
  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).
• fields: string
  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
• links: string
  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
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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.

There's no request body for this operation.

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-negotiationRecommendedSuppliers-item-response

Type: object

Show Source

• AgreementsCount: integer (int64)
  Indicates the number of past purchase agreements with the supplier, recommended by the artificial intelligence model, for the item and category in the negotiation line.
• AiScore: number
  Score assigned to a recommended supplier by the artificial-intelligence model. A supplier with close matching transactions, and frequent purchasing and sourcing transactions is assigned a higher score.
• AuctionHeaderId: integer (int64)
  Value that uniquely identifies the negotiation.
• AwardsCount: integer (int64)
  Indicates the number of past negotiation awards to the supplier, recommended by the artificial intelligence model, for the item and category in the negotiation line.
• BestMatch: string
  Maximum Length: 1

  Contains one of the following values: true or false. If true, then it denotes the best-recommended supplier. If false, then it doesn't denote the best-recommended supplier.
• BusinessRelationship: string
  Title: Business Relationship

  Read Only: true

  Maximum Length: 80

  Displays the name of the purchasing relationship with the supplier's enterprise. Possible values include None, Prospective, and Spend Authorized.
• BusinessRelationshipCode: string
  Title: Business Relationship

  Read Only: true

  Maximum Length: 30

  Abbreviation that identifies the purchasing relationship of the supplier's enterprise. Accepted values include NONE, PROSPECTIVE, and SPEND_AUTHORIZED. A list of valid values is defined in the lookup type ORA_POZ_purchasing_RELATIONSHIP.
• HeaderSuppRecommId: integer (int64)
  Value that uniquely identifies the recommended supplier for a negotiation.
• InvitationsCount: integer (int64)
  Indicates the number of past negotiation invitations extended to the supplier, recommended by the artificial intelligence model, for the item and category in the negotiation line.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• negotiationSupplierLinesCovered: array Negotiation Supplier Lines Covered
  Title: Negotiation Supplier Lines Covered

  Negotiation lines that the recommended suppliers can fulfil.
• negotiationSupplierLinesNotCovered: array Negotiation Supplier Lines not Covered
  Title: Negotiation Supplier Lines not Covered

  Negotiation lines that the recommended suppliers can't fulfil.
• NumberOfLinesCovered: integer (int64)
  Title: Lines Covered

  Number of lines in a negotiation for which a supplier is recommended for negotiation invitation.
• PurchaseOrdersCount: integer (int64)
  Indicates the number of past purchase orders from the supplier, recommended by the artificial intelligence model, for the item and category in the negotiation line.
• PurchasingDocumentOnHold: string
  Title: Purchasing Documents on Hold

  Read Only: true

  Maximum Length: 1

  Indicates that the supplier has sites where purchasing documents are on hold.
• ResponsesCount: integer (int64)
  Indicates the number of past responses submitted by the supplier, recommended by the artificial intelligence model, for the item and category in the negotiation line.
• SourcingEligible: string
  Title: Sourcing Eligible

  Read Only: true

  Maximum Length: 80

  Abbreviation that identifies the supplier's sourcing eligibility status. Accepted values include ALLOWED, NOT_ALLOWED, and WARNING. A list of valid values is defined in the lookup type ORA_POQ_SOURCING_ELIGIBILITY.
• SourcingEligibleCode: string
  Read Only: true

  Maximum Length: 30

  Display name of the supplier's sourcing eligibility status. Values include Eligible, Not eligible, and Eligible with warning.
• SourcingOnly: string
  Title: Sourcing Only

  Read Only: true

  Maximum Length: 1

  Indicates that the supplier has one or more sites restricted to sourcing-only activities.
• SupplierId: integer (int64)
  Value that identifies the supplier company that the application invited to respond to the negotiation.
• SupplierName: string
  Title: Suppliers

  Read Only: true

  Maximum Length: 360

  Name of the supplier company that the application invited to respond to the negotiation.
• SupplierSiteId: integer (int64)
  Value that identifies the supplier site.
• SupplierSiteName: string
  Title: Supplier Site

  Read Only: true

  Maximum Length: 240

  Name of the supplier site.

{
    "type":"object",
    "properties":{
        "AgreementsCount":{
            "type":"integer",
            "description":"Indicates the number of past purchase agreements with the supplier, recommended by the artificial intelligence model, for the item and category in the negotiation line.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AiScore":{
            "type":"number",
            "description":"Score assigned to a recommended supplier by the artificial-intelligence model. A supplier with close matching transactions, and frequent purchasing and sourcing transactions is assigned a higher score.",
            "nullable":true,
            "x-queryable":true
        },
        "AuctionHeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the negotiation.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AwardsCount":{
            "type":"integer",
            "description":"Indicates the number of past negotiation awards to the supplier, recommended by the artificial intelligence model, for the item and category in the negotiation line.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BestMatch":{
            "maxLength":1,
            "type":"string",
            "description":"Contains one of the following values: true or false. If true, then it denotes the best-recommended supplier. If false, then it doesn't denote the best-recommended supplier.",
            "nullable":true,
            "x-queryable":true
        },
        "BusinessRelationship":{
            "title":"Business Relationship",
            "maxLength":80,
            "type":"string",
            "description":"Displays the name of the purchasing relationship with the supplier's enterprise. Possible values include None, Prospective, and Spend Authorized.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "BusinessRelationshipCode",
                    "PartyId",
                    "SupplierId",
                    "SupplierName",
                    "SupplierSiteId",
                    "SupplierSiteName",
                    "VendorId",
                    "VendorSiteId"
                ]
            }
        },
        "BusinessRelationshipCode":{
            "title":"Business Relationship",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the purchasing relationship of the supplier's enterprise. Accepted values include NONE, PROSPECTIVE, and SPEND_AUTHORIZED. A list of valid values is defined in the lookup type ORA_POZ_purchasing_RELATIONSHIP.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HeaderSuppRecommId":{
            "type":"integer",
            "description":"Value that uniquely identifies the recommended supplier for a negotiation.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "InvitationsCount":{
            "type":"integer",
            "description":"Indicates the number of past negotiation invitations extended to the supplier, recommended by the artificial intelligence model, for the item and category in the negotiation line.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "NumberOfLinesCovered":{
            "title":"Lines Covered",
            "type":"integer",
            "description":"Number of lines in a negotiation for which a supplier is recommended for negotiation invitation.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PurchaseOrdersCount":{
            "type":"integer",
            "description":"Indicates the number of past purchase orders from the supplier, recommended by the artificial intelligence model, for the item and category in the negotiation line.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PurchasingDocumentOnHold":{
            "title":"Purchasing Documents on Hold",
            "maxLength":1,
            "type":"string",
            "description":"Indicates that the supplier has sites where purchasing documents are on hold.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResponsesCount":{
            "type":"integer",
            "description":"Indicates the number of past responses submitted by the supplier, recommended by the artificial intelligence model, for the item and category in the negotiation line.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SourcingEligible":{
            "title":"Sourcing Eligible",
            "maxLength":80,
            "type":"string",
            "description":"Abbreviation that identifies the supplier's sourcing eligibility status. Accepted values include ALLOWED, NOT_ALLOWED, and WARNING. A list of valid values is defined in the lookup type ORA_POQ_SOURCING_ELIGIBILITY.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SourcingEligibleCode":{
            "maxLength":30,
            "type":"string",
            "description":"Display name of the supplier's sourcing eligibility status. Values include Eligible, Not eligible, and Eligible with warning.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "VendorId"
                ]
            },
            "x-queryable":true
        },
        "SourcingOnly":{
            "title":"Sourcing Only",
            "maxLength":1,
            "type":"string",
            "description":"Indicates that the supplier has one or more sites restricted to sourcing-only activities.",
            "nullable":true,
            "readOnly":true,
            "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
        },
        "SupplierName":{
            "title":"Suppliers",
            "maxLength":360,
            "type":"string",
            "description":"Name of the supplier company that the application invited to respond to the negotiation.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplierSiteId":{
            "type":"integer",
            "description":"Value that identifies the supplier site.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SupplierSiteName":{
            "title":"Supplier Site",
            "maxLength":240,
            "type":"string",
            "description":"Name of the supplier site.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "negotiationSupplierLinesCovered":{
            "title":"Negotiation Supplier Lines Covered",
            "type":"array",
            "description":"Negotiation lines that the recommended suppliers can fulfil.",
            "items":{
                "$ref":"#/components/schemas/supplierNegotiations-negotiationRecommendedSuppliers-negotiationSupplierLinesCovered-item-response"
            }
        },
        "negotiationSupplierLinesNotCovered":{
            "title":"Negotiation Supplier Lines not Covered",
            "type":"array",
            "description":"Negotiation lines that the recommended suppliers can't fulfil.",
            "items":{
                "$ref":"#/components/schemas/supplierNegotiations-negotiationRecommendedSuppliers-negotiationSupplierLinesNotCovered-item-response"
            }
        }
    }
}

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 : Negotiation Supplier Lines Covered

Type: array

Title: Negotiation Supplier Lines Covered

Negotiation lines that the recommended suppliers can fulfil.

Show Source

• Array of: object supplierNegotiations-negotiationRecommendedSuppliers-negotiationSupplierLinesCovered-item-response

{
    "title":"Negotiation Supplier Lines Covered",
    "type":"array",
    "description":"Negotiation lines that the recommended suppliers can fulfil.",
    "items":{
        "$ref":"#/components/schemas/supplierNegotiations-negotiationRecommendedSuppliers-negotiationSupplierLinesCovered-item-response"
    }
}

Nested Schema : Negotiation Supplier Lines not Covered

Type: array

Title: Negotiation Supplier Lines not Covered

Negotiation lines that the recommended suppliers can't fulfil.

Show Source

• Array of: object supplierNegotiations-negotiationRecommendedSuppliers-negotiationSupplierLinesNotCovered-item-response

{
    "title":"Negotiation Supplier Lines not Covered",
    "type":"array",
    "description":"Negotiation lines that the recommended suppliers can't fulfil.",
    "items":{
        "$ref":"#/components/schemas/supplierNegotiations-negotiationRecommendedSuppliers-negotiationSupplierLinesNotCovered-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-negotiationRecommendedSuppliers-negotiationSupplierLinesCovered-item-response

Type: object

Show Source

• AiScore: number
  Read Only: true

  Score assigned to a recommended supplier by the artificial intelligence model. Suppliers with closely matching transactions and frequent purchasing and sourcing activities are assigned a higher score.
• AuctionHeaderId: integer
  Read Only: true

  Value that uniquely identifies the negotiation.
• CategoryName: string
  Title: Category

  Read Only: true

  Maximum Length: 250

  Name of the purchasing category for the negotiation line.
• Item: string
  Title: Item

  Read Only: true

  Maximum Length: 300

  Name of the inventory item.
• Line: string
  Title: Line

  Read Only: true

  Maximum Length: 25

  Number that identifies the negotiation line.
• LineDescription: string
  Title: Description

  Read Only: true

  Maximum Length: 2500

  Description of the negotiation line.
• LineId: number
  Read Only: true

  Value that uniquely identifies the negotiation line.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "AiScore":{
            "type":"number",
            "description":"Score assigned to a recommended supplier by the artificial intelligence model. Suppliers with closely matching transactions and frequent purchasing and sourcing activities are assigned a higher score.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AuctionHeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the negotiation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":250,
            "type":"string",
            "description":"Name of the purchasing category for the negotiation line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Item":{
            "title":"Item",
            "maxLength":300,
            "type":"string",
            "description":"Name of the inventory item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Line":{
            "title":"Line",
            "maxLength":25,
            "type":"string",
            "description":"Number that identifies the negotiation line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LineDescription":{
            "title":"Description",
            "maxLength":2500,
            "type":"string",
            "description":"Description of the negotiation line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LineId":{
            "type":"number",
            "description":"Value that uniquely identifies the negotiation line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "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 : supplierNegotiations-negotiationRecommendedSuppliers-negotiationSupplierLinesNotCovered-item-response

Type: object

Show Source

• AuctionHeaderId: integer
  Read Only: true

  Value that uniquely identifies the negotiation.
• CategoryName: string
  Title: Category

  Read Only: true

  Maximum Length: 250

  Name of the purchasing category for the negotiation line.
• Item: string
  Title: Item

  Read Only: true

  Maximum Length: 300

  Name of the inventory item.
• Line: string
  Title: Line

  Read Only: true

  Maximum Length: 25

  Number that identifies the negotiation line.
• LineDescription: string
  Title: Description

  Read Only: true

  Maximum Length: 2500

  Description of the negotiation line.
• LineId: number
  Read Only: true

  Value that uniquely identifies the negotiation line.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "AuctionHeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the negotiation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":250,
            "type":"string",
            "description":"Name of the purchasing category for the negotiation line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Item":{
            "title":"Item",
            "maxLength":300,
            "type":"string",
            "description":"Name of the inventory item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Line":{
            "title":"Line",
            "maxLength":25,
            "type":"string",
            "description":"Number that identifies the negotiation line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LineDescription":{
            "title":"Description",
            "maxLength":2500,
            "type":"string",
            "description":"Description of the negotiation line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LineId":{
            "type":"number",
            "description":"Value that uniquely identifies the negotiation line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "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"
    }
}

Links

negotiationSupplierLinesCovered

Operation: /fscmRestApi/resources/11.13.18.05/supplierNegotiations/{supplierNegotiationsUniqID}/child/negotiationRecommendedSuppliers/{HeaderSuppRecommId}/child/negotiationSupplierLinesCovered

Parameters:

• HeaderSuppRecommId: $request.path.HeaderSuppRecommId
• supplierNegotiationsUniqID: $request.path.supplierNegotiationsUniqID

Negotiation lines that the recommended suppliers can fulfil.

negotiationSupplierLinesNotCovered

Operation: /fscmRestApi/resources/11.13.18.05/supplierNegotiations/{supplierNegotiationsUniqID}/child/negotiationRecommendedSuppliers/{HeaderSuppRecommId}/child/negotiationSupplierLinesNotCovered

Parameters:

• HeaderSuppRecommId: $request.path.HeaderSuppRecommId
• supplierNegotiationsUniqID: $request.path.supplierNegotiationsUniqID

Negotiation lines that the recommended suppliers can't fulfil.

Back to Top