REST API for Oracle Fusion Cloud Financials

Create a sliding scale threshold

post

/fscmRestApi/resources/11.13.18.05/jointVentureOverheadMethods/{overheadMethodId}/child/slidingScaleThresholds

Request

Path Parameters

overheadMethodId(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.
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

Root Schema : schema

Type: object

Show Source

amount: number

Title: Threshold Amount

The amount up to which the threshold percentage is applied to calculate a portion of the overhead amount.
percentage: number

Title: Threshold Percentage

The threshold percentage used to calculate the portion of the overhead amount up to the threshold amount.
rate: number

Title: Threshold Rate

The threshold rate used to calculate the portion of the overhead amount up to the threshold amount.
thresholdDFF: array thresholdDFF

{
    "type":"object",
    "properties":{
        "amount":{
            "title":"Threshold Amount",
            "type":"number",
            "description":"The amount up to which the threshold percentage is applied to calculate a portion of the overhead amount.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "percentage":{
            "title":"Threshold Percentage",
            "type":"number",
            "description":"The threshold percentage used to calculate the portion of the overhead amount up to the threshold amount.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "rate":{
            "title":"Threshold Rate",
            "type":"number",
            "description":"The threshold rate used to calculate the portion of the overhead amount up to the threshold amount.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "thresholdDFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/jointVentureOverheadMethods-slidingScaleThresholds-thresholdDFF-item-post-request"
            },
            "x-cardinality":"1"
        }
    }
}

Nested Schema : thresholdDFF

Type: array

Show Source

Array of: object jointVentureOverheadMethods-slidingScaleThresholds-thresholdDFF-item-post-request

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/jointVentureOverheadMethods-slidingScaleThresholds-thresholdDFF-item-post-request"
    },
    "x-cardinality":"1"
}

Nested Schema : jointVentureOverheadMethods-slidingScaleThresholds-thresholdDFF-item-post-request

Type: object

Show Source

__FLEX_Context: string

Title: Context Segment

Maximum Length: 30

Context Segment
__FLEX_Context_DisplayValue: string

Title: Context Segment

Context Segment
ThresholdId: integer (int64)

Title: Threshold ID

{
    "type":"object",
    "properties":{
        "ThresholdId":{
            "title":"Threshold ID",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":30,
            "type":"string",
            "description":"Context Segment",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Context Segment"
                },
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "description":"Context Segment",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "help":{
                    "instruction":"Context Segment"
                },
                "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":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        }
    }
}

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.

Root Schema : jointVentureOverheadMethods-slidingScaleThresholds-item-response

Type: object

Show Source

amount: number

Title: Threshold Amount

The amount up to which the threshold percentage is applied to calculate a portion of the overhead amount.
createdBy: string

Title: Created By

Read Only: true

Maximum Length: 64

The user who created the sliding scale threshold.
creationDate: string (date-time)

Title: Creation Date

Read Only: true

The date and time when the sliding scale threshold was created.
lastUpdateDate: string (date-time)

Title: Last Updated Date

Read Only: true

The date and time when the sliding scale threshold was last updated.
lastUpdatedBy: string

Title: Last Updated By

Read Only: true

Maximum Length: 64

The user who last updated the sliding scale threshold.
links: array Links

Title: Links

The link relations associated with the resource instance.
percentage: number

Title: Threshold Percentage

The threshold percentage used to calculate the portion of the overhead amount up to the threshold amount.
rate: number

Title: Threshold Rate

The threshold rate used to calculate the portion of the overhead amount up to the threshold amount.
thresholdDFF: array thresholdDFF
thresholdId: integer (int64)

Title: Threshold ID

Read Only: true

The unique identifier of the sliding scale threshold.

{
    "type":"object",
    "properties":{
        "amount":{
            "title":"Threshold Amount",
            "type":"number",
            "description":"The amount up to which the threshold percentage is applied to calculate a portion of the overhead amount.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "createdBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the sliding scale threshold.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "creationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the sliding scale threshold was created.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "lastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the sliding scale threshold was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "lastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the sliding scale threshold.",
            "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"
            }
        },
        "percentage":{
            "title":"Threshold Percentage",
            "type":"number",
            "description":"The threshold percentage used to calculate the portion of the overhead amount up to the threshold amount.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "rate":{
            "title":"Threshold Rate",
            "type":"number",
            "description":"The threshold rate used to calculate the portion of the overhead amount up to the threshold amount.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "thresholdDFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/jointVentureOverheadMethods-slidingScaleThresholds-thresholdDFF-item-response"
            },
            "x-cardinality":"1"
        },
        "thresholdId":{
            "title":"Threshold ID",
            "type":"integer",
            "description":"The unique identifier of the sliding scale threshold.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "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 : thresholdDFF

Type: array

Show Source

Array of: object jointVentureOverheadMethods-slidingScaleThresholds-thresholdDFF-item-response

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/jointVentureOverheadMethods-slidingScaleThresholds-thresholdDFF-item-response"
    },
    "x-cardinality":"1"
}

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

Nested Schema : jointVentureOverheadMethods-slidingScaleThresholds-thresholdDFF-item-response

Type: object

Show Source

__FLEX_Context: string

Title: Context Segment

Maximum Length: 30

Context Segment
__FLEX_Context_DisplayValue: string

Title: Context Segment

Context Segment
links: array Links

Title: Links

The link relations associated with the resource instance.
ThresholdId: integer (int64)

Title: Threshold ID

{
    "type":"object",
    "properties":{
        "ThresholdId":{
            "title":"Threshold ID",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":30,
            "type":"string",
            "description":"Context Segment",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Context Segment"
                },
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "description":"Context Segment",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "help":{
                    "instruction":"Context Segment"
                },
                "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":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "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"
    }
}

Links

thresholdDFF

Operation: /fscmRestApi/resources/11.13.18.05/jointVentureOverheadMethods/{overheadMethodId}/child/slidingScaleThresholds/{thresholdId}/child/thresholdDFF

Parameters:

overheadMethodId: $request.path.overheadMethodId
thresholdId: $request.path.thresholdId

Examples

The following example shows how to create a sliding scale threshold by submitting a POST request on the REST resource using cURL.

curl -i -u "username:password" -H "Content-type: application/json" -X POST -d <payload> "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureOverheadMethods/300100549261601/child/slidingScaleThresholds"

Example Request Body

The following shows an example of the request body in JSON format.

{
    "amount":1000,
    "percentage":5
}

Example Response Body

The following shows an example of the response body in JSON format.

{
    "thresholdId": 300100549272646,
    "amount": 1000,
    "percentage": 5,
    "createdBy": "username",
    "creationDate": "2022-03-07T10:18:57+00:00",
    "lastUpdatedBy": "username",
    "lastUpdateDate": "2022-03-07T10:18:57.047+00:00",
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureOverheadMethods/300100549261601/child/slidingScaleThresholds/300100549272646",
            "name": "slidingScaleThresholds",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureOverheadMethods/300100549261601/child/slidingScaleThresholds/300100549272646",
            "name": "slidingScaleThresholds",
            "kind": "item"
        },
        {
            "rel": "parent",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureOverheadMethods/300100549261601",
            "name": "jointVentureOverheadMethods",
            "kind": "item"
        },
        {
            "rel": "child",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureOverheadMethods/300100549261601/child/slidingScaleThresholds/300100549272646/child/thresholdDFF",
            "name": "thresholdDFF",
            "kind": "collection"
        }
    ]
}