Jump to

• Request
• Response

Create one cost factor list

post

/fscmRestApi/resources/11.13.18.05/supplierNegotiationCostFactorLists

Request

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

• costFactors: array Cost Factors
  Title: Cost Factors

  Cost components used to structure supplier cost breakdowns during negotiations.
• Description: string
  Title: Description

  Maximum Length: 240

  Description of the cost factor list.
• ListId: integer (int64)
  Value that uniquely identifies the cost factor list.
• ListName(required): string
  Title: Cost Factor List

  Maximum Length: 80

  Name of the cost factor list.
• ListStatusCode(required): string
  Maximum Length: 30

  Abbreviation that identifies the cost factor list status.
• ListTypeCode: string
  Maximum Length: 30

  Abbreviation that identifies the type of cost factor list. Valid values are EXTERNAL and INTERNAL.

{
    "required":[
        "ListName",
        "ListStatusCode"
    ],
    "type":"object",
    "properties":{
        "Description":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"Description of the cost factor list.",
            "nullable":true
        },
        "ListId":{
            "type":"integer",
            "description":"Value that uniquely identifies the cost factor list.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "ListName":{
            "title":"Cost Factor List",
            "maxLength":80,
            "type":"string",
            "description":"Name of the cost factor list.",
            "nullable":false
        },
        "ListStatusCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the cost factor list status.",
            "nullable":false
        },
        "ListTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the type of cost factor list. Valid values are EXTERNAL and INTERNAL.",
            "nullable":true
        },
        "costFactors":{
            "title":"Cost Factors",
            "type":"array",
            "description":"Cost components used to structure supplier cost breakdowns during negotiations.",
            "items":{
                "$ref":"#/components/schemas/supplierNegotiationCostFactorLists-costFactors-item-post-request"
            }
        }
    }
}

Nested Schema : Cost Factors

Type: array

Title: Cost Factors

Cost components used to structure supplier cost breakdowns during negotiations.

Show Source

• Array of: object supplierNegotiationCostFactorLists-costFactors-item-post-request

{
    "title":"Cost Factors",
    "type":"array",
    "description":"Cost components used to structure supplier cost breakdowns during negotiations.",
    "items":{
        "$ref":"#/components/schemas/supplierNegotiationCostFactorLists-costFactors-item-post-request"
    }
}

Nested Schema : supplierNegotiationCostFactorLists-costFactors-item-post-request

Type: object

Show Source

• ListCostFactorId: integer (int64)
  Sequence number of the cost factor.
• ListId: integer (int64)
  Value that uniquely identifies the cost factor.
• PriceElementTypeId: integer (int64)
  Value that uniquely identifies the price element type.

{
    "type":"object",
    "properties":{
        "ListCostFactorId":{
            "type":"integer",
            "description":"Sequence number of the cost factor.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ListId":{
            "type":"integer",
            "description":"Value that uniquely identifies the cost factor.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "PriceElementTypeId":{
            "type":"integer",
            "description":"Value that uniquely identifies the price element type.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        }
    }
}

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

Type: object

Show Source

• costFactors: array Cost Factors
  Title: Cost Factors

  Cost components used to structure supplier cost breakdowns during negotiations.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

  Date and time when the cost factor list was created.
• Description: string
  Title: Description

  Maximum Length: 240

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

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

  Maximum Length: 64

  User who most recently updated the cost factor list.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ListId: integer (int64)
  Value that uniquely identifies the cost factor list.
• ListName: string
  Title: Cost Factor List

  Maximum Length: 80

  Name of the cost factor list.
• ListStatus: string
  Title: Status

  Read Only: true

  Maximum Length: 80

  Status of the cost factor list.
• ListStatusCode: string
  Maximum Length: 30

  Abbreviation that identifies the cost factor list status.
• ListType: string
  Title: Type

  Read Only: true

  Maximum Length: 80

  Abbreviation that identifies the cost factor list type.
• ListTypeCode: string
  Maximum Length: 30

  Abbreviation that identifies the type of cost factor list. Valid values are EXTERNAL and INTERNAL.

{
    "type":"object",
    "properties":{
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the cost factor list.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the cost factor list was created.",
            "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 list.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the cost factor list was most recently updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the cost factor list.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "ListId":{
            "type":"integer",
            "description":"Value that uniquely identifies the cost factor list.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ListName":{
            "title":"Cost Factor List",
            "maxLength":80,
            "type":"string",
            "description":"Name of the cost factor list.",
            "nullable":false,
            "x-queryable":true
        },
        "ListStatus":{
            "title":"Status",
            "maxLength":80,
            "type":"string",
            "description":"Status of the cost factor list.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ListStatusCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the cost factor list status.",
            "nullable":false,
            "x-queryable":true
        },
        "ListType":{
            "title":"Type",
            "maxLength":80,
            "type":"string",
            "description":"Abbreviation that identifies the cost factor list type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ListTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the type of cost factor list. Valid values are EXTERNAL and INTERNAL.",
            "nullable":true,
            "x-queryable":true
        },
        "costFactors":{
            "title":"Cost Factors",
            "type":"array",
            "description":"Cost components used to structure supplier cost breakdowns during negotiations.",
            "items":{
                "$ref":"#/components/schemas/supplierNegotiationCostFactorLists-costFactors-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Cost Factors

Type: array

Title: Cost Factors

Cost components used to structure supplier cost breakdowns during negotiations.

Show Source

• Array of: object supplierNegotiationCostFactorLists-costFactors-item-response

{
    "title":"Cost Factors",
    "type":"array",
    "description":"Cost components used to structure supplier cost breakdowns during negotiations.",
    "items":{
        "$ref":"#/components/schemas/supplierNegotiationCostFactorLists-costFactors-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 : supplierNegotiationCostFactorLists-costFactors-item-response

Type: object

Show Source

• CostFactorTypeCode: string
  Read Only: true

  Maximum Length: 30

  Default Value: EXTERNAL

  Type 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.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ListCostFactorId: integer (int64)
  Sequence number of the cost factor.
• ListId: integer (int64)
  Value that uniquely identifies the cost factor.
• Name: string
  Title: Cost Factor

  Read Only: true

  Maximum Length: 80

  Name of the cost factor.
• PriceElementTypeId: integer (int64)
  Value that uniquely identifies the price element type.
• PricingBasis: string
  Title: Pricing Basis

  Read Only: true

  Maximum Length: 80

  Pricing basis for the cost factor.

{
    "type":"object",
    "properties":{
        "CostFactorTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Type of the cost factor.",
            "nullable":true,
            "readOnly":true,
            "default":"EXTERNAL",
            "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":{
                "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
            }
        },
        "ListCostFactorId":{
            "type":"integer",
            "description":"Sequence number of the cost factor.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ListId":{
            "type":"integer",
            "description":"Value that uniquely identifies the cost factor.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Name":{
            "title":"Cost Factor",
            "maxLength":80,
            "type":"string",
            "description":"Name of the cost factor.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "PriceElementTypeId":{
            "type":"integer",
            "description":"Value that uniquely identifies the price element type.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PricingBasis":{
            "title":"Pricing Basis",
            "maxLength":80,
            "type":"string",
            "description":"Pricing basis for the cost factor.",
            "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"
            }
        }
    }
}

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

Links

costFactors

Operation: /fscmRestApi/resources/11.13.18.05/supplierNegotiationCostFactorLists/{ListId}/child/costFactors

Parameters:

• ListId: $request.path.ListId

Cost components used to structure supplier cost breakdowns during negotiations.

Back to Top