Get one overhead rate
get
/fscmRestApi/resources/11.13.18.05/standardOverheadRates/{standardOverheadRatesUniqID}
Request
Path Parameters
-
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.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
-
Effective-Of:
This header accepts a string value. The string is a semi-colon separated list of
= . It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers. -
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.
There's no request body for this operation.
Back to TopResponse
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.
Root Schema : standardOverheadRates-item-response
Type:
Show Source
object
-
CategoryCode: string
Read Only:
true
Maximum Length:820
Abbreviation that identifies the item category. -
CategoryId: integer
(int64)
Title:
Category ID
Read Only:true
Value that uniquely identifies the item category for which the overhead rates are displayed. -
CategoryName: string
Title:
Category Name
Read Only:true
Maximum Length:2400
Name of the item category. -
CostBookCode: string
Title:
Cost Book
Read Only:true
Maximum Length:30
Abbreviation that identifies the cost book in which the standard overhead rate details are displayed. -
CostBookDescription: string
Title:
Cost Book Description
Read Only:true
Maximum Length:240
Description of the cost book. -
CostBookId: integer
(int64)
Title:
Cost Book ID
Read Only:true
Value that uniquely identifies the cost book. -
CostOrgCode: string
Title:
Cost Organization Code
Read Only:true
Maximum Length:150
Abbreviation that identifies the cost organization for which the standard overhead rate is displayed. -
CostOrgId: integer
(int64)
Title:
Cost Organization ID
Read Only:true
Value that uniquely identifies the cost organization. -
CostOrgName: string
Title:
Cost Organization Name
Read Only:true
Maximum Length:240
Name of the cost organization for which the standard overhead rate is displayed. -
CurrencyCode: string
Title:
Currency Code
Read Only:true
Maximum Length:15
Abbreviation that identifies the currency in which the overhead rate is set up. -
CurrencyName: string
Title:
Currency Name
Read Only:true
Maximum Length:80
Name of the currency. -
EffectiveEndDate: string
(date)
Title:
Effective End Date
Read Only:true
Date when standard overhead rate is no longer effective. A date of 31-12-4712 indicates that this overhead rate record is the current effective rate. -
EffectiveStartDate: string
(date)
Title:
Effective Start Date
Read Only:true
Date when the standard overhead rate is effective. -
InventoryOrgCode: string
Title:
Inventory Organization Code
Read Only:true
Maximum Length:18
Abbreviation that identifies the organization to which the item belongs. -
InventoryOrgId: integer
(int64)
Title:
Inventory Organization ID
Read Only:true
Value that uniquely identifies the inventory organization or plant for which the standard overhead rate is displayed. -
InventoryOrgName: string
Title:
Inventory Organization Name
Read Only:true
Maximum Length:240
Name of the organization to which the component item belongs. -
ItemDescription: string
Title:
Item Description
Read Only:true
Maximum Length:240
Description of the item for which standard overhead rate is displayed. -
ItemId: integer
(int64)
Title:
Item ID
Read Only:true
Value that uniquely identifies an item. -
ItemNumber: string
Title:
Item
Read Only:true
Maximum Length:1000
Number that identifies the item. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OverheadRateType: string
Title:
Overhead Rate Type Code
Read Only:true
Maximum Length:30
Type of overhead rate. Values include PLANT and WORKCENTER. A list of accepted values is defined in the lookup type ORA_CST_OVERHEAD_RATE_TYPE. -
OverheadRateTypeMeaning: string
Title:
Overhead Rate Type
Read Only:true
Maximum Length:80
Translatable name for overhead rate type code. -
ResourceType: string
Title:
Resource Type Code
Read Only:true
Maximum Length:30
Type of resource. Values include LABOR and EQUIPMENT. A list of accepted values is defined in the lookup type ORA_WIS_RESOURCE_TYPE. -
ResourceTypeMeaning: string
Title:
Overhead Rate Type
Read Only:true
Maximum Length:80
Translatable name for resource type codes. -
ScenarioId: integer
(int64)
Title:
Scenario ID
Read Only:true
Value that uniquely identifies the cost scenario for which the overhead rate is set up. -
ScenarioNumber: string
Title:
Scenario
Read Only:true
Maximum Length:30
Number that identifies the cost planning scenario. This value is defined by the user. -
standardOverheadRateDetails: array
Standard Cost Overhead Rate Details
Title:
Standard Cost Overhead Rate Details
The Standard Cost Overhead Rate Details resource manages cost element-level details of the standard overhead rate. -
StandardOverheadRateId: integer
(int64)
Read Only:
true
Value that uniquely identifies the standard overhead rate. -
StatusCode: string
Title:
Status Code
Read Only:true
Maximum Length:30
Abbreviation that identifies the status of the displayed overhead rate. Values include IN_PROCESS and PUBLISHED, EXCLUDED_FROM_PUBLISH. A list of accepted values is defined in the lookup type ORA_CST_STD_COST_STATUSES. -
StatusCodeMeaning: string
Title:
Status
Read Only:true
Maximum Length:80
Translatable name for the status code. -
WorkCenterCode: string
Title:
Work Center Code
Read Only:true
Maximum Length:30
Abbreviation that identifies the work center for the overhead rate under the work definition operation. -
WorkCenterDescription: string
Title:
Work Center Description
Read Only:true
Maximum Length:240
Description of the work center for the work definition operation. -
WorkCenterId: integer
(int64)
Title:
Work Center ID
Read Only:true
Value that uniquely identifies the work center for which the overhead rates are displayed. -
WorkCenterName: string
Title:
Work Center
Read Only:true
Maximum Length:80
Name of the work center for the work definition operation.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Standard Cost Overhead Rate Details
Type:
array
Title:
Standard Cost Overhead Rate Details
The Standard Cost Overhead Rate Details resource manages cost element-level details of the standard overhead rate.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : standardOverheadRates-standardOverheadRateDetails-item-response
Type:
Show Source
object
-
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
Read Only:true
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
Type of cost element. -
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
Read Only:true
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
Read Only:true
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
Read Only:true
Value that indicates the cost component in the overhead rate currency. The value of this attribute is null when absorption type is PERCENTAGE.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- standardOverheadRateDetails
-
Parameters:
- standardOverheadRatesUniqID:
$request.path.standardOverheadRatesUniqID
The Standard Cost Overhead Rate Details resource manages cost element-level details of the standard overhead rate. - standardOverheadRatesUniqID:
Examples
This example describes how to get one overhead rate.
Example cURL Command
Use the following cURL command to submit a request on the REST resource:
curl -u username:password "https://servername/fscmRestApi/resources/version/standardOverheadRates/standardOverheadRatesUniqID"
For example, the following command gets one overhead rate:
curl -u username:password "https://servername/fscmRestApi/resources/version/standardOverheadRates/300100181560243"
Example Response Body
The following shows an example of the response body in JSON format.
{ "StandardOverheadRateId": 300100181560243, "ScenarioId": 300100172970824, "ScenarioNumber": "CSTAUTO1-Std-Base", "CostOrgId": 300100172982769, "CostOrgCode": "Auto1-CO", "CostOrgName": "Auto1-CO", "CostBookId": 300100172970785, "CostBookCode": "Auto1-Std", "CostBookDescription": "CST Automation 1 Standard Cost Book", "InventoryOrgId": 300100172909868, "InventoryOrgCode": "CSTAUTO1", "InventoryOrgName": "CSTAUTO1", "OverheadRateType": "PLANT", "OverheadRateTypeMeaning": "Plant overhead", "EffectiveStartDate": "1900-01-01", "EffectiveEndDate": "4712-12-31", "StatusCode": "PUBLISHED", "StatusCodeMeaning": "Published", "ItemId": 300100059526522, "ItemNumber": "ZC-1", "ItemDescription": "ZC-1", "CategoryId": null, "CategoryCode": null, "CategoryName": null, "WorkCenterId": null, "WorkCenterCode": null, "WorkCenterName": null, "WorkCenterDescription": null, "CurrencyCode": "USD", "CurrencyName": "US Dollar", "ResourceType": null, "ResourceTypeMeaning": null, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/standardOverheadRates/300100181560243", "name": "standardOverheadRates", "kind": "item" }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/standardOverheadRates/300100181560243", "name": "standardOverheadRates", "kind": "item" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/standardOverheadRates/300100181560243/child/standardOverheadRateDetails", "name": "standardOverheadRateDetails", "kind": "collection" } ] }