REST API for Oracle Fusion Cloud SCM

Update one standard overhead rate detail

patch

/fscmRestApi/resources/11.13.18.05/standardOverheadRates/{standardOverheadRatesUniqID}/child/standardOverheadRateDetails/{StandardOverheadRateDetailId}

Request

Path Parameters

StandardOverheadRateDetailId(required): integer(int64)

Value that uniquely identifies the standard overhead rate detail.
standardOverheadRatesUniqID(required): string

This is the hash key of the attributes which make up the composite key for the Standard Cost Overhead Rates resource and used to uniquely identify an instance of Standard Cost Overhead Rates. The client should not generate the hash key value. Instead, the client should query on the Standard Cost Overhead Rates collection resource in order to navigate to a specific instance of Standard Cost Overhead Rates to get the hash key.

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.

Supported Media Types

application/json

Root Schema : schema

Type: object

Show Source

AbsorptionType: string

Title: Absorption Type Code

Maximum Length: 30

Default Value: PERCENTAGE

Type of absorption of the displayed overhead rate. Valid values include FIXED_AMOUNT and PERCENTAGE. A list of accepted values is defined in the lookup type ORA_CST_ABSORPTION_TYPE.
CostElementCode: string

Title: Cost Element Code

Maximum Length: 30

Abbreviation that identifies the cost element for which the overhead rate details are displayed.
CostElementId: integer (int64)

Title: Cost Element ID

Value that uniquely identifies the cost element.
ExpensePoolId: integer (int64)

Title: Expense Pool ID

Value that uniquely identifies the expense pool of the overhead rate detail.
ExpensePoolName: string

Title: Expense Pool

Maximum Length: 80

Name of the expense pool.
UnitRate: string

Title: Rate

Value that indicates the unit rate for the cost component in the overhead rate. The value for this attribute is null when absorption type is FIXED.
UnitValue: string

Title: Value

Value that indicates the cost component in the overhead rate currency. The value of this attribute is null when absorption type is PERCENTAGE.

{
    "type":"object",
    "properties":{
        "AbsorptionType":{
            "title":"Absorption Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"Type of absorption of the displayed overhead rate. Valid values include FIXED_AMOUNT and PERCENTAGE. A list of accepted values is defined in the lookup type ORA_CST_ABSORPTION_TYPE.",
            "nullable":true,
            "default":"PERCENTAGE",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CostElementCode":{
            "title":"Cost Element Code",
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the cost element for which the overhead rate details are displayed.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "UnitRate":{
            "title":"Rate",
            "type":"string",
            "description":"Value that indicates the unit rate for the cost component in the overhead rate. The value for this attribute is null when absorption type is FIXED.",
            "nullable":true
        },
        "CostElementId":{
            "title":"Cost Element ID",
            "type":"integer",
            "description":"Value that uniquely identifies the cost element.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Display",
                "precision":"18"
            }
        },
        "ExpensePoolName":{
            "title":"Expense Pool",
            "maxLength":"80",
            "type":"string",
            "description":"Name of the expense pool.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ExpensePoolId":{
            "title":"Expense Pool ID",
            "type":"integer",
            "description":"Value that uniquely identifies the expense pool of the overhead rate detail.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Display",
                "precision":"18"
            }
        },
        "UnitValue":{
            "title":"Value",
            "type":"string",
            "description":"Value that indicates the cost component in the overhead rate currency. The value of this attribute is null when absorption type is PERCENTAGE.",
            "nullable":true
        }
    }
}

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 : standardOverheadRates-standardOverheadRateDetails-item-response

Type: object

Show Source

AbsorptionType: string

Title: Absorption Type Code

Maximum Length: 30

Default Value: PERCENTAGE

Type of absorption of the displayed overhead rate. Valid values include FIXED_AMOUNT and PERCENTAGE. A list of accepted values is defined in the lookup type ORA_CST_ABSORPTION_TYPE.
AbsorptionTypeMeaning: string

Title: Absorption Type

Read Only: true

Maximum Length: 80

Meaning of the absorption type. This value is user defined.
CostElementCode: string

Title: Cost Element Code

Maximum Length: 30

Abbreviation that identifies the cost element for which the overhead rate details are displayed.
CostElementDescription: string

Title: Cost Element Description

Read Only: true

Maximum Length: 240

Description of the cost element.
CostElementId: integer (int64)

Title: Cost Element ID

Value that uniquely identifies the cost element.
CostElementType: string

Title: Cost Element Type

Read Only: true

Maximum Length: 30

Default Value: OVERHEAD

Type of cost element.
CostElementTypeMeaning: string

Title: Cost Element Type

Read Only: true

Maximum Length: 80

Meaning of the cost element type. This value is user-defined.
ExpensePoolCode: string

Title: Expense Pool Code

Read Only: true

Maximum Length: 30

Abbreviation that identifies the expense pool. This value is user defined.
ExpensePoolId: integer (int64)

Title: Expense Pool ID

Value that uniquely identifies the expense pool of the overhead rate detail.
ExpensePoolName: string

Title: Expense Pool

Maximum Length: 80

Name of the expense pool.
links: array Links

Title: Links

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

Value that uniquely identifies the standard overhead rate detail.
UnitRate: string

Title: Rate

Value that indicates the unit rate for the cost component in the overhead rate. The value for this attribute is null when absorption type is FIXED.
UnitValue: string

Title: Value

Value that indicates the cost component in the overhead rate currency. The value of this attribute is null when absorption type is PERCENTAGE.

{
    "type":"object",
    "properties":{
        "StandardOverheadRateDetailId":{
            "type":"integer",
            "description":"Value that uniquely identifies the standard overhead rate detail.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "AbsorptionType":{
            "title":"Absorption Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"Type of absorption of the displayed overhead rate. Valid values include FIXED_AMOUNT and PERCENTAGE. A list of accepted values is defined in the lookup type ORA_CST_ABSORPTION_TYPE.",
            "nullable":true,
            "default":"PERCENTAGE",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CostElementCode":{
            "title":"Cost Element Code",
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the cost element for which the overhead rate details are displayed.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "UnitRate":{
            "title":"Rate",
            "type":"string",
            "description":"Value that indicates the unit rate for the cost component in the overhead rate. The value for this attribute is null when absorption type is FIXED.",
            "nullable":true,
            "x-queryable":true
        },
        "ExpensePoolName":{
            "title":"Expense Pool",
            "maxLength":"80",
            "type":"string",
            "description":"Name of the expense pool.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "UnitValue":{
            "title":"Value",
            "type":"string",
            "description":"Value that indicates the cost component in the overhead rate currency. The value of this attribute is null when absorption type is PERCENTAGE.",
            "nullable":true,
            "x-queryable":true
        },
        "CostElementType":{
            "title":"Cost Element Type",
            "maxLength":"30",
            "type":"string",
            "description":"Type of cost element.",
            "nullable":false,
            "readOnly":true,
            "default":"OVERHEAD",
            "x-queryable":true
        },
        "CostElementTypeMeaning":{
            "title":"Cost Element Type",
            "maxLength":"80",
            "type":"string",
            "description":"Meaning of the cost element type. This value is user-defined.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ExpensePoolCode":{
            "title":"Expense Pool Code",
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the expense pool. This value is user defined.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CostElementDescription":{
            "title":"Cost Element Description",
            "maxLength":"240",
            "type":"string",
            "description":"Description of the cost element.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AbsorptionTypeMeaning":{
            "title":"Absorption Type",
            "maxLength":"80",
            "type":"string",
            "description":"Meaning of the absorption type. This value is user defined.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CostElementId":{
            "title":"Cost Element ID",
            "type":"integer",
            "description":"Value that uniquely identifies the cost element.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Display",
                "precision":"18"
            },
            "x-queryable":true
        },
        "ExpensePoolId":{
            "title":"Expense Pool ID",
            "type":"integer",
            "description":"Value that uniquely identifies the expense pool of the overhead rate detail.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Display",
                "precision":"18"
            },
            "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."
        }
    }
}

Examples

This example describes how to update one standard overhead rate detail.

Example cURL Command

Use the following cURL command to submit a request on the REST resource.

curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload'  "https://servername/fscmRestApi/resources/version/standardOverheadRates/standardOverheadRatesUniqID/child/standardOverheadRateDetails/StandardOverheadRateDetailId"

Example Request Body

The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it updates.

{
"CostElementCode": "ZCST-GAS",
"CostElementType": "OVERHEAD",
"ExpensePoolCode": "0554EP1",
"AbsorptionType": "FIXED",
"UnitValue": "10"
}

Example Response Body

The following example includes the contents of the response body in JSON format:

{
    "StandardOverheadRateId": 300100613274377,
    "ScenarioId": 300100613275874,
    "ScenarioNumber": "Example_OH2",
    "CostOrgId": 100000012270096,
    "CostOrgCode": "ORG4",
    "CostOrgName": "ZCST-Vision Ops",
    "CostBookId": 100000010001016,
    "CostBookCode": "ZCST-Vision Ops",
    "CostBookDescription": "Cost Book for Vision Operations",
    "InventoryOrgId": 204,
    "InventoryOrgCode": "V1",
    "InventoryOrgName": "Vision Operations",
    "OverheadRateType": "WORKCENTER",
    "OverheadRateTypeMeaning": "Work center overhead",
    "EffectiveStartDate": "2023-02-01",
    "EffectiveEndDate": null,
    "StatusCode": "IN_PROCESS",
    "StatusCodeMeaning": "In process",
    "ItemId": null,
    "ItemNumber": null,
    "ItemDescription": null,
    "CategoryId": null,
    "CategoryCode": null,
    "CategoryName": null,
    "WorkCenterId": 300100081228553,
    "WorkCenterCode": "ELECTRICAL",
    "WorkCenterName": "Electrical",
    "WorkCenterDescription": "Electrical",
    "CurrencyCode": "USD",
    "CurrencyName": "US Dollar",
    "ResourceType": "LABOR",
    "ResourceTypeMeaning": "Labor",
    "HeaderReferenceNumber": null,
    "standardOverheadRateDetails": [
        {
            "StandardOverheadRateDetailId": 300100613274378,
            "CostElementId": 300100071793421,
            "CostElementCode": "CML Overhead",
            "CostElementDescription": "CML Overhead",
            "CostElementType": "OVERHEAD",
            "CostElementTypeMeaning": "Overhead",
            "ExpensePoolId": 300100071793422,
            "ExpensePoolCode": "CML Exp Pool",
            "ExpensePoolName": "CML Exp Pool",
            "AbsorptionType": "PERCENTAGE",
            "AbsorptionTypeMeaning": "Percentage",
            "UnitRate": "25",
            "UnitValue": null,
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/standardOverheadRates/300100613274377/child/standardOverheadRateDetails/300100613274378",
                    "name": "standardOverheadRateDetails",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/standardOverheadRates/300100613274377/child/standardOverheadRateDetails/300100613274378",
                    "name": "standardOverheadRateDetails",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername/fscmRestApi/resources/version/standardOverheadRates/300100613274377",
                    "name": "standardOverheadRates",
                    "kind": "item"
                }
            ]
        }
    ],
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/standardOverheadRates/300100613274377",
            "name": "standardOverheadRates",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername/fscmRestApi/resources/version/standardOverheadRates/300100613274377",
            "name": "standardOverheadRates",
            "kind": "item"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/standardOverheadRates/300100613274377/child/standardOverheadRateDetails",
            "name": "standardOverheadRateDetails",
            "kind": "collection"
        }
    ]
}