Jump to

• Request
• Response
• Examples

Update one cost factor

patch

/fscmRestApi/resources/11.13.18.05/supplierNegotiations/{supplierNegotiationsUniqID}/child/lines/{LineId}/child/costFactors/{LineCostFactorId}

Request

Path Parameters

• LineCostFactorId(required): number
  Value that uniquely identifies the sequence of the cost factor within a negotiation line.
• LineId(required): number
  Value that uniquely identifies the negotiation line.
• 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

• CostFactor: string
  Title: Cost Factor

  Maximum Length: 80

  Name of the cost factor.
• CostFactorId: integer (int64)
  Title: Cost Factor ID

  Value that identifies the cost factor.
• DisplayTargetFlag: boolean
  Title: Display Target

  Maximum Length: 1

  Contains one of the following values: true or false. If true, then allow the supplier to view the value for the cost factor target. If false, then do not allow. The default value is false.
• PricingBasis: string
  Title: Pricing Basis

  Maximum Length: 80

  Basis that the application uses to calculate the cost factor. A list of accepted values is defined in the lookup type PON_PRICING_BASIS.
• PricingBasisCode: string
  Title: Pricing Basis Code

  Maximum Length: 30

  Abbreviation that identifies the basis that the application uses to calculate the cost factor. A list of accepted values is defined in the lookup type PON_PRICING_BASIS.
• TargetValue: number
  Title: Target Value

  Target value of the cost factor.

{
    "type":"object",
    "properties":{
        "TargetValue":{
            "title":"Target Value",
            "type":"number",
            "description":"Target value of the cost factor.",
            "nullable":true
        },
        "PricingBasisCode":{
            "title":"Pricing Basis Code",
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the basis that the application uses to calculate the cost factor. A list of accepted values is defined in the lookup type PON_PRICING_BASIS.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "CostFactor",
                    "CostFactorId"
                ]
            }
        },
        "PricingBasis":{
            "title":"Pricing Basis",
            "maxLength":"80",
            "type":"string",
            "description":"Basis that the application uses to calculate the cost factor. A list of accepted values is defined in the lookup type PON_PRICING_BASIS.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "CostFactor",
                    "CostFactorId"
                ]
            }
        },
        "DisplayTargetFlag":{
            "title":"Display Target",
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then allow the supplier to view the value for the cost factor target. If false, then do not allow. The default value is false.",
            "nullable":true
        },
        "CostFactorId":{
            "title":"Cost Factor ID",
            "type":"integer",
            "description":"Value that identifies the cost factor.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            }
        },
        "CostFactor":{
            "title":"Cost Factor",
            "maxLength":"80",
            "type":"string",
            "description":"Name of the cost factor.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "fnd:OA_TRANSLATABLE":"true"
            }
        }
    }
}

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-lines-costFactors-item-response

Type: object

Show Source

• AuctionHeaderId: integer (int64)
  Read Only: true

  Value that uniquely identifies the negotiation.
• CostFactor: string
  Title: Cost Factor

  Maximum Length: 80

  Name of the cost factor.
• CostFactorId: integer (int64)
  Title: Cost Factor ID

  Value that identifies the cost factor.
• Description: string
  Title: Description

  Read Only: true

  Maximum Length: 240

  Description of the cost factor.
• DisplayTargetFlag: boolean
  Title: Display Target

  Maximum Length: 1

  Contains one of the following values: true or false. If true, then allow the supplier to view the value for the cost factor target. If false, then do not allow. The default value is false.
• Line: number
  Read Only: true

  Number that identifies the negotiation line.
• LineCostFactorId: number
  Read Only: true

  Value that uniquely identifies the sequence of the cost factor within a negotiation line.
• LineDescription: string
  Read Only: true

  Description of the negotiation line.
• LineId: number
  Title: Line ID

  Read Only: true

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

  The link relations associated with the resource instance.
• PricingBasis: string
  Title: Pricing Basis

  Maximum Length: 80

  Basis that the application uses to calculate the cost factor. A list of accepted values is defined in the lookup type PON_PRICING_BASIS.
• PricingBasisCode: string
  Title: Pricing Basis Code

  Maximum Length: 30

  Abbreviation that identifies the basis that the application uses to calculate the cost factor. A list of accepted values is defined in the lookup type PON_PRICING_BASIS.
• TargetValue: number
  Title: Target Value

  Target value of the cost factor.

{
    "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
        },
        "TargetValue":{
            "title":"Target Value",
            "type":"number",
            "description":"Target value of the cost factor.",
            "nullable":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"240",
            "type":"string",
            "description":"Description of the cost factor.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"true"
            }
        },
        "LineId":{
            "title":"Line ID",
            "type":"number",
            "description":"Value that uniquely identifies the negotiation line.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PricingBasisCode":{
            "title":"Pricing Basis Code",
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the basis that the application uses to calculate the cost factor. A list of accepted values is defined in the lookup type PON_PRICING_BASIS.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "CostFactor",
                    "CostFactorId"
                ]
            },
            "x-queryable":true
        },
        "CostFactorId":{
            "title":"Cost Factor ID",
            "type":"integer",
            "description":"Value that identifies the cost factor.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            },
            "x-queryable":true
        },
        "CostFactor":{
            "title":"Cost Factor",
            "maxLength":"80",
            "type":"string",
            "description":"Name of the cost factor.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "LineCostFactorId":{
            "type":"number",
            "description":"Value that uniquely identifies the sequence of the cost factor within a negotiation line.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Line":{
            "type":"number",
            "description":"Number that identifies the negotiation line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"255"
            }
        },
        "LineDescription":{
            "type":"string",
            "description":"Description of the negotiation line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PricingBasis":{
            "title":"Pricing Basis",
            "maxLength":"80",
            "type":"string",
            "description":"Basis that the application uses to calculate the cost factor. A list of accepted values is defined in the lookup type PON_PRICING_BASIS.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "CostFactor",
                    "CostFactorId"
                ]
            },
            "x-queryable":true
        },
        "DisplayTargetFlag":{
            "title":"Display Target",
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then allow the supplier to view the value for the cost factor target. If false, then do not allow. The default value is false.",
            "nullable":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 : 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

Examples

This example describes how to update a cost factor.

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/lines/LineId/child/costFactors/LineCostFactorId"

For example

curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload'  "https://servername/fscmRestApi/resources/version/supplierNegotiations/300100152357495/child/lines/1/child/costFactors/10"

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.

{
	"CostFactor": "FREIGHT"
}

Example Response Body

The following example includes the contents of the response body in JSON format:

{
	"AuctionHeaderId": 300100186479682,
	"LineId": 1,
	"LineCostFactorId": 10,
	"Description": "Freight",
	"CostFactorId": 62,
	"CostFactor": "FREIGHT",
	"PricingBasisCode": "PER_UNIT",
	"PricingBasis": "Per unit",
	"TargetValue": null,
	"DisplayTargetFlag": false,
	"links": [
	{
		"rel": "self",
		"href": "https://servername/fscmRestApi/resources/version/supplierNegotiations/300100186479682/child/lines/1/child/costFactors/10",
		"name": "costFactors",
		"kind": "item",
		"properties": {
			"changeIndicator": "ACED000..."
		}
	},
	{
		"rel": "canonical",
		"href": "https://servername/fscmRestApi/resources/version/supplierNegotiations/300100186479682/child/lines/1/child/costFactors/10",
		"name": "costFactors",
		"kind": "item"
	},
	{
		"rel": "parent",
		"href": "https://servername/fscmRestApi/resources/version/supplierNegotiations/300100186479682/child/lines/1",
		"name": "lines",
		"kind": "item"
	}
	]
}

Back to Top