Jump to

• Request
• Response

Create tier lines

post

/fscmRestApi/resources/11.13.18.05/priceLists/{PriceListId}/child/items/{PriceListItemId}/child/ratePlans/{RatePlanId}/child/ratePlanCharges/{RatePlanChargeId}/child/pricingTiers/{TierHeaderId}/child/lines

Request

Path Parameters

• PriceListId(required): integer(int64)
  Value that uniquely identifies the price list.
• PriceListItemId(required): integer(int64)
  Value that uniquely identifies the price list item.
• RatePlanChargeId(required): integer(int64)
  Value that uniquely identifies the charge of the rate plan.
• RatePlanId(required): integer(int64)
  Value that uniquely identifies the rate plan.
• TierHeaderId(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:
  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.
• Upsert-Mode:
  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

• AdjustmentAmount(required): number
  Title: Adjustment Amount

  Value of the adjustment amount.
• AdjustmentBasis: string
  Name of the adjustment basis.
• AdjustmentBasisId: integer (int64)
  Title: Adjustment Basis

  Value that identifies the adjustment basis.
• AdjustmentType: string
  Name of the type of adjustment. A list of accepted values is defined in the lookup type ORA_QP_LINE_ADJ_TYPES.
• AdjustmentTypeCode: string
  Title: Adjustment Type

  Maximum Length: 30

  Abbreviation that identifies the type of adjustment.
• ApplicationMethod: string
  Name of the tier application method. Valid values include Per unit and As block. A list of accepted values is defined in the lookup type ORA_QP_APPLICATION_METHODS.
• ApplicationMethodCode: string
  Title: Application Method

  Maximum Length: 30

  Abbreviation that identifies the method of tier application.
• IncrementValue: integer
  Title: Increment Value

  Increment value number.
• linesDFF: array Flexfields for Tier Lines
  Title: Flexfields for Tier Lines

  The Flexfields for Tier Lines resource associates descriptive flexfield segments and its values with a tier line.
• Maximum: number
  Title: Maximum

  Maximum value for the tier line.
• Minimum(required): number
  Title: Minimum

  Minimum value for the tier line.
• TierHeaderId(required): integer (int64)
  Value that uniquely identifies the tier header.
• TierLineId: integer (int64)
  Value that uniquely identifies the tier line.
• TierLineNumber(required): integer (int32)
  Line number of the tier.

{
    "required":[
        "AdjustmentAmount",
        "Minimum",
        "TierHeaderId",
        "TierLineNumber"
    ],
    "type":"object",
    "properties":{
        "TierHeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the tier header.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "TierLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the tier line.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "Minimum":{
            "title":"Minimum",
            "type":"number",
            "description":"Minimum value for the tier line.",
            "nullable":false
        },
        "linesDFF":{
            "title":"Flexfields for Tier Lines",
            "type":"array",
            "description":"The Flexfields for Tier Lines resource associates descriptive flexfield segments and its values with a tier line.",
            "items":{
                "$ref":"#/components/schemas/priceLists-items-ratePlans-ratePlanCharges-pricingTiers-lines-linesDFF-item-post-request"
            },
            "x-cardinality":"1"
        },
        "AdjustmentBasis":{
            "type":"string",
            "description":"Name of the adjustment basis.",
            "nullable":true
        },
        "AdjustmentType":{
            "type":"string",
            "description":"Name of the type of adjustment. A list of accepted values is defined in the lookup type ORA_QP_LINE_ADJ_TYPES.",
            "nullable":true
        },
        "IncrementValue":{
            "title":"Increment Value",
            "type":"integer",
            "description":"Increment value number.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "ApplicationMethodCode"
                ]
            }
        },
        "AdjustmentTypeCode":{
            "title":"Adjustment Type",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the type of adjustment.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Maximum":{
            "title":"Maximum",
            "type":"number",
            "description":"Maximum value for the tier line.",
            "nullable":true
        },
        "ApplicationMethodCode":{
            "title":"Application Method",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the method of tier application.",
            "nullable":true
        },
        "AdjustmentBasisId":{
            "title":"Adjustment Basis",
            "type":"integer",
            "description":"Value that identifies the adjustment basis.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "AdjustmentAmount":{
            "title":"Adjustment Amount",
            "type":"number",
            "description":"Value of the adjustment amount.",
            "nullable":false
        },
        "TierLineNumber":{
            "type":"integer",
            "description":"Line number of the tier.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            }
        },
        "ApplicationMethod":{
            "type":"string",
            "description":"Name of the tier application method. Valid values include Per unit and As block. A list of accepted values is defined in the lookup type ORA_QP_APPLICATION_METHODS.",
            "nullable":true
        }
    }
}

Nested Schema : Flexfields for Tier Lines

Type: array

Title: Flexfields for Tier Lines

The Flexfields for Tier Lines resource associates descriptive flexfield segments and its values with a tier line.

Show Source

• Array of: object schema

{
    "title":"Flexfields for Tier Lines",
    "type":"array",
    "description":"The Flexfields for Tier Lines resource associates descriptive flexfield segments and its values with a tier line.",
    "items":{
        "$ref":"#/components/schemas/priceLists-items-ratePlans-ratePlanCharges-pricingTiers-lines-linesDFF-item-post-request"
    },
    "x-cardinality":"1"
}

Nested Schema : schema

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Value

  Maximum Length: 150

  Descriptive flexfield context name for tier lines.
• __FLEX_Context_DisplayValue: string
  Title: Context Value
• TieredPricingLineId: integer (int64)
  Value that uniquely identifies the tier line of a pricing charge or discount to which the descriptive flexfields belong.

{
    "type":"object",
    "properties":{
        "TieredPricingLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the tier line of a pricing charge or discount to which the descriptive flexfields belong.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Value",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "__FLEX_Context":{
            "title":"Context Value",
            "maxLength":150,
            "type":"string",
            "description":"Descriptive flexfield context name for tier lines.",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context(required):
  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(required):
  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 : priceLists-items-ratePlans-ratePlanCharges-pricingTiers-lines-item-response

Type: object

Show Source

• AdjustmentAmount: number
  Title: Adjustment Amount

  Value of the adjustment amount.
• AdjustmentBasis: string
  Name of the adjustment basis.
• AdjustmentBasisId: integer (int64)
  Title: Adjustment Basis

  Value that identifies the adjustment basis.
• AdjustmentType: string
  Name of the type of adjustment. A list of accepted values is defined in the lookup type ORA_QP_LINE_ADJ_TYPES.
• AdjustmentTypeCode: string
  Title: Adjustment Type

  Maximum Length: 30

  Abbreviation that identifies the type of adjustment.
• ApplicationMethod: string
  Name of the tier application method. Valid values include Per unit and As block. A list of accepted values is defined in the lookup type ORA_QP_APPLICATION_METHODS.
• ApplicationMethodCode: string
  Title: Application Method

  Maximum Length: 30

  Abbreviation that identifies the method of tier application.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

  Date and time when the record was created.
• IncrementValue: integer
  Title: Increment Value

  Increment value number.
• LastUpdateDate: string (date-time)
  Read Only: true

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

  Maximum Length: 64

  User who most recently updated the record.
• linesDFF: array Flexfields for Tier Lines
  Title: Flexfields for Tier Lines

  The Flexfields for Tier Lines resource associates descriptive flexfield segments and its values with a tier line.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Maximum: number
  Title: Maximum

  Maximum value for the tier line.
• Minimum: number
  Title: Minimum

  Minimum value for the tier line.
• TierHeaderId: integer (int64)
  Value that uniquely identifies the tier header.
• TierLineId: integer (int64)
  Value that uniquely identifies the tier line.
• TierLineNumber: integer (int32)
  Line number of the tier.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TierHeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the tier header.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TierLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the tier line.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "Minimum":{
            "title":"Minimum",
            "type":"number",
            "description":"Minimum value for the tier line.",
            "nullable":false,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "linesDFF":{
            "title":"Flexfields for Tier Lines",
            "type":"array",
            "description":"The Flexfields for Tier Lines resource associates descriptive flexfield segments and its values with a tier line.",
            "items":{
                "$ref":"#/components/schemas/priceLists-items-ratePlans-ratePlanCharges-pricingTiers-lines-linesDFF-item-response"
            },
            "x-cardinality":"1"
        },
        "AdjustmentBasis":{
            "type":"string",
            "description":"Name of the adjustment basis.",
            "nullable":true,
            "x-queryable":true
        },
        "AdjustmentType":{
            "type":"string",
            "description":"Name of the type of adjustment. A list of accepted values is defined in the lookup type ORA_QP_LINE_ADJ_TYPES.",
            "nullable":true,
            "x-queryable":true
        },
        "IncrementValue":{
            "title":"Increment Value",
            "type":"integer",
            "description":"Increment value number.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "ApplicationMethodCode"
                ]
            },
            "x-queryable":true
        },
        "AdjustmentTypeCode":{
            "title":"Adjustment Type",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the type of adjustment.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Maximum":{
            "title":"Maximum",
            "type":"number",
            "description":"Maximum value for the tier line.",
            "nullable":true,
            "x-queryable":true
        },
        "ApplicationMethodCode":{
            "title":"Application Method",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the method of tier application.",
            "nullable":true,
            "x-queryable":true
        },
        "AdjustmentBasisId":{
            "title":"Adjustment Basis",
            "type":"integer",
            "description":"Value that identifies the adjustment basis.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AdjustmentAmount":{
            "title":"Adjustment Amount",
            "type":"number",
            "description":"Value of the adjustment amount.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "TierLineNumber":{
            "type":"integer",
            "description":"Line number of the tier.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "ApplicationMethod":{
            "type":"string",
            "description":"Name of the tier application method. Valid values include Per unit and As block. A list of accepted values is defined in the lookup type ORA_QP_APPLICATION_METHODS.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the record was most recently updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Flexfields for Tier Lines

Type: array

Title: Flexfields for Tier Lines

The Flexfields for Tier Lines resource associates descriptive flexfield segments and its values with a tier line.

Show Source

• Array of: object priceLists-items-ratePlans-ratePlanCharges-pricingTiers-lines-linesDFF-item-response

{
    "title":"Flexfields for Tier Lines",
    "type":"array",
    "description":"The Flexfields for Tier Lines resource associates descriptive flexfield segments and its values with a tier line.",
    "items":{
        "$ref":"#/components/schemas/priceLists-items-ratePlans-ratePlanCharges-pricingTiers-lines-linesDFF-item-response"
    },
    "x-cardinality":"1"
}

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 : priceLists-items-ratePlans-ratePlanCharges-pricingTiers-lines-linesDFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Value

  Maximum Length: 150

  Descriptive flexfield context name for tier lines.
• __FLEX_Context_DisplayValue: string
  Title: Context Value
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• TieredPricingLineId: integer (int64)
  Value that uniquely identifies the tier line of a pricing charge or discount to which the descriptive flexfields belong.

{
    "type":"object",
    "properties":{
        "TieredPricingLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the tier line of a pricing charge or discount to which the descriptive flexfields belong.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Value",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Value",
            "maxLength":150,
            "type":"string",
            "description":"Descriptive flexfield context name for tier lines.",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        }
    }
}

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

linesDFF

Operation: /fscmRestApi/resources/11.13.18.05/priceLists/{PriceListId}/child/items/{PriceListItemId}/child/ratePlans/{RatePlanId}/child/ratePlanCharges/{RatePlanChargeId}/child/pricingTiers/{TierHeaderId2}/child/lines/{TierLineId}/child/linesDFF

Parameters:

• PriceListId: $request.path.PriceListId
• PriceListItemId: $request.path.PriceListItemId
• RatePlanChargeId: $request.path.RatePlanChargeId
• RatePlanId: $request.path.RatePlanId
• TierHeaderId2: $request.path.TierHeaderId2
• TierLineId2: $request.path.TierLineId2

The Flexfields for Tier Lines resource associates descriptive flexfield segments and its values with a tier line.

Back to Top