Jump to

• Request
• Response
• Examples

Get all overhead rate details

get

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

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
• finder: string
  Used as a predefined finder to search the collection.
  
  Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables:
  
  

  • PrimaryKey: Finds overhead rate details according to the specified primary key criteria.
    Finder Variables:
    • StandardOverheadRateDetailId; integer; Value that uniquely identifies the standard overhead rate detail.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• 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
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • AbsorptionType; string; 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; Meaning of the absorption type. This value is user defined.
  • CostElementCode; string; Abbreviation that identifies the cost element for which the overhead rate details are displayed.
  • CostElementDescription; string; Description of the cost element.
  • CostElementId; integer; Value that uniquely identifies the cost element.
  • CostElementType; string; Type of cost element.
  • CostElementTypeMeaning; string; Meaning of the cost element type. This value is user-defined.
  • ExpensePoolCode; string; Abbreviation that identifies the expense pool. This value is user defined.
  • ExpensePoolId; integer; Value that uniquely identifies the expense pool of the overhead rate detail.
  • ExpensePoolName; string; Name of the expense pool.
  • StandardOverheadRateDetailId; integer; Value that uniquely identifies the standard overhead rate detail.
  • UnitRate; string; 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; Value that indicates the cost component in the overhead rate currency. The value of this attribute is null when absorption type is PERCENTAGE.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

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.

There's no request body for this operation.

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

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/standardOverheadRates-standardOverheadRateDetails-item-response"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object standardOverheadRates-standardOverheadRateDetails-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/standardOverheadRates-standardOverheadRateDetails-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 : 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."
        }
    }
}

Back to Top

Examples

This example describes how to get all overhead rate details.

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/child/standardOverheadRateDetails"

Example Response Body

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

{
	"items": [
	  {
		    "StandardOverheadRateDetailId": 300100121090543,
		    "CostElementId": 300100071793421,
		    "CostElementCode": "CML Overhead",
		    "CostElementDescription": "CML Overhead",
		    "CostElementType": "OVERHEAD",
		    "ExpensePoolId": 300100071793422,
		    "ExpensePoolCode": "CML Exp Pool",
		    "ExpensePoolName": "CML Exp Pool",
		    "AbsorptionType": "PERCENTAGE",
		    "AbsorptionTypeMeaning": "Percentage",
		    "UnitRate": "50",
		    "UnitValue": null,
		    "links": [
		      {
			        "rel": "self",
			        "href": "https://servername/fscmRestApi/resources/version/standardOverheadRates/300100121090539/child/standardOverheadRateDetails/300100121090543",
			        "name": "standardOverheadRateDetails",
			        "kind": "item",
			        "properties": {
				          "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
				        }
			      },
		      {
			        "rel": "canonical",
			        "href": "https://servername/fscmRestApi/resources/version/standardOverheadRates/300100121090539/child/standardOverheadRateDetails/300100121090543",
			        "name": "standardOverheadRateDetails",
			        "kind": "item"
			      },
		      {
			        "rel": "parent",
			        "href": "https://servername/fscmRestApi/resources/version/standardOverheadRates/300100121090539",
			        "name": "standardOverheadRates",
			        "kind": "item"
			      }
		    ]
		  },
	  {
		    "StandardOverheadRateDetailId": 300100121090541,
		    "CostElementId": 300100089910922,
		    "CostElementCode": "iPlantOH",
		    "CostElementDescription": "iPlantOH",
		    "CostElementType": "OVERHEAD",
		    "ExpensePoolId": 300100089910916,
		    "ExpensePoolCode": "iPlantOH",
		    "ExpensePoolName": "iPlantOH",
		    "AbsorptionType": "FIXED_AMOUNT",
		    "AbsorptionTypeMeaning": "Fixed",
		    "UnitRate": null,
		    "UnitValue": "150",
		    "links": [
		      {
			        "rel": "self",
			        "href": "https://servername/fscmRestApi/resources/version/standardOverheadRates/300100121090539/child/standardOverheadRateDetails/300100121090541",
			        "name": "standardOverheadRateDetails",
			        "kind": "item",
			        "properties": {
				          "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
				        }
			      },
		      {
			        "rel": "canonical",
			        "href": "https://servername/fscmRestApi/resources/version/standardOverheadRates/300100121090539/child/standardOverheadRateDetails/300100121090541",
			        "name": "standardOverheadRateDetails",
			        "kind": "item"
			      },
		      {
			        "rel": "parent",
			        "href": "https://servername/fscmRestApi/resources/version/standardOverheadRates/300100121090539",
			        "name": "standardOverheadRates",
			        "kind": "item"
			      }
		    ]
		  }
	],
	"count": 2,
	"hasMore": false,
	"limit": 25,
	"offset": 0,
	"links": [
	  {
		    "rel": "self",
		    "href": "https://servername/fscmRestApi/resources/version/standardOverheadRates/300100121090539/child/standardOverheadRateDetails",
		    "name": "standardOverheadRateDetails",
		    "kind": "collection"
		  }
	]
}

Back to Top