Jump to

• Request
• Response

Create one internal cost factor

post

/fscmRestApi/resources/11.13.18.05/supplierNegotiations/{supplierNegotiationsUniqID}/child/lines/{LineId}/child/lineInternalCostFactors

Request

Path Parameters

• LineId(required): number
  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=
• 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: 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.
• Upsert-Mode: string
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

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

  Identifier of the cost factor.
• PricingBasis: string
  Title: Meaning

  Maximum Length: 80

  Basis used to calculate the cost factor. Valid values are defined in the lookup type PON_PRICING_BASIS.
• PricingBasisCode: string
  Title: Pricing Basis

  Maximum Length: 30

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

{
    "type":"object",
    "properties":{
        "CostFactor":{
            "title":"Cost Factor",
            "maxLength":80,
            "type":"string",
            "description":"Name of the cost factor.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "fnd:OA_TRANSLATABLE":"true"
            }
        },
        "CostFactorId":{
            "title":"Cost Factor",
            "type":"integer",
            "description":"Identifier of the cost factor.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "sortable":false
            }
        },
        "PricingBasis":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Basis used to calculate the cost factor. Valid values are defined in the lookup type PON_PRICING_BASIS.",
            "nullable":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":true,
            "x-hints":{
                "sortable":false
            }
        }
    }
}

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

Type: object

Show Source

• AuctionHeaderId: integer (int64)
  Read Only: true

  Unique identifier of the negotiation.
• CostFactor: string
  Title: Cost Factor

  Maximum Length: 80

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

  Identifier of the cost factor.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

  Date and time when the user added the cost factor.
• Description: string
  Title: Description

  Read Only: true

  Maximum Length: 240

  Description of the cost factor.
• LastUpdateDate: string (date-time)
  Read Only: true

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

  Maximum Length: 64

  User who most recently updated the cost factor.
• LineCostFactorId: number
  Read Only: true

  Unique sequence identifier of the cost factor within a negotiation line.
• LineId: number
  Title: Line Number

  Read Only: true

  Unique identifier of the negotiation line.
• links: array Links
  Title: Links

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

  Maximum Length: 80

  Basis used to calculate the cost factor. Valid values are defined in the lookup type PON_PRICING_BASIS.
• PricingBasisCode: string
  Title: Pricing Basis

  Maximum Length: 30

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

{
    "type":"object",
    "properties":{
        "AuctionHeaderId":{
            "type":"integer",
            "description":"Unique identifier of the negotiation.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "sortable":false
            },
            "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
        },
        "CostFactorId":{
            "title":"Cost Factor",
            "type":"integer",
            "description":"Identifier of the cost factor.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "sortable":false
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who added the cost factor.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user added the cost factor.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"Description of the cost factor.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "sortable":false,
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user most recently updated the cost factor.",
            "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 cost factor.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "LineCostFactorId":{
            "type":"number",
            "description":"Unique sequence identifier of the cost factor within a negotiation line.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "sortable":false
            },
            "x-queryable":true
        },
        "LineId":{
            "title":"Line Number",
            "type":"number",
            "description":"Unique identifier of the negotiation line.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "PricingBasis":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Basis used to calculate the cost factor. Valid values are defined in the lookup type PON_PRICING_BASIS.",
            "nullable":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":true,
            "x-hints":{
                "sortable":false
            },
            "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