Jump to

• Request
• Response

Update one supplier negotiation cost factor

patch

/fscmRestApi/resources/11.13.18.05/supplierNegotiationCostFactors/{CostFactorId}

Request

Path Parameters

• CostFactorId(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=

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

• CostFactorDescription: string
  Title: Description

  Maximum Length: 240

  Description of the cost factor.
• CostFactorName: string
  Title: Cost Factor

  Maximum Length: 80

  Name of the cost factor.
• EnabledFlag: boolean
  Title: Status

  Maximum Length: 1

  Default Value: true

  Contains one of these values: true or false. If true, then the cost factor is enabled. If false, then the cost factor isn't enabled. This attribute doesn't have default value.
• PricingBasisCode: string
  Title: Pricing Basis

  Maximum Length: 30

  Default Value: PER_UNIT

  Abbreviation identifying the basis used to calculate the cost factor. Valid values are defined in the lookup type PON_PRICING_BASIS.

{
    "type":"object",
    "properties":{
        "CostFactorDescription":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"Description of the cost factor.",
            "nullable":true,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"true"
            }
        },
        "CostFactorName":{
            "title":"Cost Factor",
            "maxLength":80,
            "type":"string",
            "description":"Name of the cost factor.",
            "nullable":false,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"true"
            }
        },
        "EnabledFlag":{
            "title":"Status",
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of these values: true or false. If true, then the cost factor is enabled. If false, then the cost factor isn't enabled. This attribute doesn't have default value.",
            "nullable":false,
            "default":true
        },
        "PricingBasisCode":{
            "title":"Pricing Basis",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation identifying the basis used to calculate the cost factor. Valid values are defined in the lookup type PON_PRICING_BASIS.",
            "nullable":false,
            "default":"PER_UNIT",
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "CostFactorCode"
                ]
            }
        }
    }
}

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 : supplierNegotiationCostFactors-item-response

Type: object

Show Source

• CostFactorCode: string
  Title: Code

  Maximum Length: 30

  Abbreviation that identifies the cost factor.
• CostFactorDescription: string
  Title: Description

  Maximum Length: 240

  Description of the cost factor.
• CostFactorId: integer (int64)
  Unique identifier for the cost factor row.
• CostFactorName: string
  Title: Cost Factor

  Maximum Length: 80

  Name of the cost factor.
• CostFactorType: string
  Title: Type

  Read Only: true

  Maximum Length: 80

  Abbreviation that identifies the type of cost factor. Valid values are EXTERNAL and INTERNAL.
• CostFactorTypeCode: string
  Maximum Length: 30

  Default Value: EXTERNAL

  Code that identifies the cost factor type.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the cost factor row.
• CreationDate: string (date-time)
  Read Only: true

  Date and time when the user added the cost factor value.
• EnabledFlag: boolean
  Title: Status

  Maximum Length: 1

  Default Value: true

  Contains one of these values: true or false. If true, then the cost factor is enabled. If false, then the cost factor isn't enabled. This attribute doesn't have default value.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date and time of the last update of the cost factor row.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who last updated the cost factor value.
• links: array Links
  Title: Links

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

  Read Only: true

  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

  Maximum Length: 30

  Default Value: PER_UNIT

  Abbreviation identifying the basis used to calculate the cost factor. Valid values are defined in the lookup type PON_PRICING_BASIS.

{
    "type":"object",
    "properties":{
        "CostFactorCode":{
            "title":"Code",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the cost factor.",
            "nullable":false,
            "x-queryable":true
        },
        "CostFactorDescription":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"Description of the cost factor.",
            "nullable":true,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "CostFactorId":{
            "type":"integer",
            "description":"Unique identifier for the cost factor row.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CostFactorName":{
            "title":"Cost Factor",
            "maxLength":80,
            "type":"string",
            "description":"Name of the cost factor.",
            "nullable":false,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "CostFactorType":{
            "title":"Type",
            "maxLength":80,
            "type":"string",
            "description":"Abbreviation that identifies the type of cost factor. Valid values are EXTERNAL and INTERNAL.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CostFactorTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code that identifies the cost factor type.",
            "nullable":true,
            "default":"EXTERNAL",
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the cost factor row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user added the cost factor value.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EnabledFlag":{
            "title":"Status",
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of these values: true or false. If true, then the cost factor is enabled. If false, then the cost factor isn't enabled. This attribute doesn't have default value.",
            "nullable":false,
            "default":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time of the last update of the cost factor row.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who last updated the cost factor value.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"false"
            },
            "x-queryable":true
        },
        "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":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PricingBasisCode":{
            "title":"Pricing Basis",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation identifying the basis used to calculate the cost factor. Valid values are defined in the lookup type PON_PRICING_BASIS.",
            "nullable":false,
            "default":"PER_UNIT",
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "CostFactorCode"
                ]
            }
        },
        "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