REST API for Oracle Supply Chain Management Cloud

Get all overhead rates

get

/fscmRestApi/resources/11.13.18.05/standardOverheadRates

Request

Query Parameters

effectiveDate: string

This query parameter is used to fetch resources which are effective dated as of the specified start date. The value of this query parameter is a string having a date in yyyy-MM-dd format
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 rates according to the specified primary key criteria.
  Finder Variables:
  - StandardOverheadRateId; integer; Value that uniquely identifies the standard overhead rate.
- PublishedOverheadByItemOrgAsOfDateFinder: Finds published overheads for a standard costed item in a given organization or plant according to the specified date.
  Finder Variables:
  - bindAsOfDate; string; Date when the overhead rate is effective. The default value is the current application date.
  - bindInventoryOrgId; integer; Value that uniquely identifies the inventory organization or plant for which the standard overhead rate is displayed.
  - bindItemId; integer; Value that uniquely identifies the item.
- findStandardOverheadRate: Finds standard overhead rates according to the specified parameters.
  Finder Variables:
  - bindCategoryCode; string; Abbreviation that identifies the item category.
  - bindCategoryId; string; Value that uniquely identifies the item category for which the overhead rates are displayed.
  - bindCategoryName; string; Name of the category to which the item belongs.
  - bindCostBookCode; string; Abbreviation that identifies the cost book for which the standard overhead rate details are displayed.
  - bindCostBookId; string; Value that uniquely identifies the cost book.
  - bindCostOrgCode; string; Abbreviation that identifies the cost organization for which the standard overhead rate is displayed.
  - bindCostOrgId; string; Value that uniquely identifies the cost organization.
  - bindCostOrgName; string.
  - bindEffectiveDate; string; Date when the overhead is effective.
  - bindEffectiveEndDate; string; Date when the overhead is effective to.
  - bindEffectiveStartDate; string; Date when the overhead is effective from.
  - bindInventoryOrgCode; string; Abbreviation that identifies the organization to which the item belongs.
  - bindInventoryOrgId; integer; Value that uniquely identifies the inventory organization or plant for which the standard overhead rate is displayed.
  - bindItemId; integer; Value that uniquely identifies the item.
  - bindItemNumber; string; Number that identifies the item.
  - bindOverheadRateType; string; Type of overhead rate. Values include PLANT and WORKCENTER.
  - bindResourceType; string; Type of resource. This value is user-defined. Values include LABOR and EQUIPMENT.
  - bindScenarioId; string; Value that uniquely identifies the cost scenario for which the overhead rate is set up.
  - bindScenarioNumber; string; Number that identifies the cost planning scenario. This value is user defined.
  - bindStatusCode; string; Abbreviation that identifies the status of the displayed overhead rate.
  - bindWorkCenterCode; string; Abbreviation that identifies the work center for the overhead rate under the work definition operation.
  - bindWorkCenterId; string; Value that uniquely identifies the work center for which the overhead rates are displayed.
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:
- AttachmentEntityName; string; Identifies the entity name of the attachment for the overhead rates.
- CategoryCode; string; Abbreviation that identifies the item category.
- CategoryId; integer; Value that uniquely identifies the item category for which the overhead rates are displayed.
- CategoryName; string; Name of the item category.
- CostBookCode; string; Abbreviation that identifies the cost book in which the standard overhead rate details are displayed.
- CostBookDescription; string; Description of the cost book.
- CostBookId; integer; Value that uniquely identifies the cost book.
- CostOrgCode; string; Abbreviation that identifies the cost organization for which the standard overhead rate is displayed.
- CostOrgId; integer; Value that uniquely identifies the cost organization.
- CostOrgName; string; Name of the cost organization for which the standard overhead rate is displayed.
- CurrencyCode; string; Abbreviation that identifies the currency in which the overhead rate is set up.
- CurrencyName; string; Name of the currency.
- EffectiveEndDate; string; 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 when the standard overhead rate is effective.
- HeaderReferenceNumber; string; Unique reference number added by the user to link an overhead rate header with the detail record. This is only applicable when the overhead rate is created through Oracle Visual Builder Cloud Service template.
- InventoryOrgCode; string; Abbreviation that identifies the organization to which the item belongs.
- InventoryOrgId; integer; Value that uniquely identifies the inventory organization or plant for which the standard overhead rate is displayed.
- InventoryOrgName; string; Name of the organization to which the component item belongs.
- ItemDescription; string; Description of the item for which standard overhead rate is displayed.
- ItemId; integer; Value that uniquely identifies an item.
- ItemNumber; string; Number that identifies the item.
- OverheadRateType; string; 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; Translatable name for overhead rate type code.
- ResourceType; string; 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; Translatable name for resource type codes.
- ScenarioId; integer; Value that uniquely identifies the cost scenario for which the overhead rate is set up.
- ScenarioNumber; string; Number that identifies the cost planning scenario. This value is defined by the user.
- StandardOverheadRateId; integer; Value that uniquely identifies the standard overhead rate.
- StatusCode; string; 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; Translatable name for the status code.
- WorkCenterCode; string; Abbreviation that identifies the work center for the overhead rate under the work definition operation.
- WorkCenterDescription; string; Description of the work center for the work definition operation.
- WorkCenterId; integer; Value that uniquely identifies the work center for which the overhead rates are displayed.
- WorkCenterName; string; Name of the work center for the work definition operation.
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

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.

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

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-item-response"
            }
        }
    },
    "x-hints":{
        "subgroup":"InventoryManagement",
        "usage":"BusinessObject",
        "group":"SCM"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

Array of: object standardOverheadRates-item-response

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

Type: object

Show Source

AttachmentEntityName: string

Default Value: CST_STD_OVERHEAD_RATES

Identifies the entity name of the attachment for the overhead rates.
Attachments: array Attachments

Title: Attachments

The attachments resource is used to view, create, and update attachments.
CategoryCode: string

Maximum Length: 820

Abbreviation that identifies the item category.
CategoryId: integer (int64)

Title: Item Category

Value that uniquely identifies the item category for which the overhead rates are displayed.
CategoryName: string

Title: Item Category

Read Only: true

Maximum Length: 2400

Name of the item category.
CostBookCode: string

Title: Cost Book

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

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

Value that uniquely identifies the cost organization.
CostOrgName: string

Title: Cost Organization

Maximum Length: 240

Name of the cost organization for which the standard overhead rate is displayed.
CurrencyCode: string

Title: Currency Code

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

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

Date when the standard overhead rate is effective.
HeaderReferenceNumber: string

Maximum Length: 18

Unique reference number added by the user to link an overhead rate header with the detail record. This is only applicable when the overhead rate is created through Oracle Visual Builder Cloud Service template.
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: Plant

Value that uniquely identifies the inventory organization or plant for which the standard overhead rate is displayed.
InventoryOrgName: string

Title: Plant

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

Value that uniquely identifies an item.
ItemNumber: string

Title: Item

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

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

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: Resource Type

Read Only: true

Maximum Length: 80

Translatable name for resource type codes.
ScenarioId: integer (int64)

Title: Scenario

Value that uniquely identifies the cost scenario for which the overhead rate is set up.
ScenarioNumber: string

Title: Scenario

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)

Value that uniquely identifies the standard overhead rate.
StatusCode: string

Title: Status

Maximum Length: 30

Default Value: IN_PROCESS

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

Value that uniquely identifies the work center for which the overhead rates are displayed.
WorkCenterName: string

Title: Work Center

Maximum Length: 120

Name of the work center for the work definition operation.

{
    "type":"object",
    "properties":{
        "CategoryId":{
            "title":"Item Category",
            "type":"integer",
            "description":"Value that uniquely identifies the item category for which the overhead rates are displayed.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CategoryCode":{
            "maxLength":"820",
            "type":"string",
            "description":"Abbreviation that identifies the item category.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "OverheadRateTypeMeaning":{
            "title":"Overhead Rate Type",
            "maxLength":"80",
            "type":"string",
            "description":"Translatable name for overhead rate type code.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkCenterDescription":{
            "title":"Work Center Description",
            "maxLength":"240",
            "type":"string",
            "description":"Description of the work center for the work definition operation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkCenterId":{
            "title":"Work Center",
            "type":"integer",
            "description":"Value that uniquely identifies the work center for which the overhead rates are displayed.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "dependencies":[
                    "InventoryOrgId"
                ]
            },
            "x-queryable":true
        },
        "standardOverheadRateDetails":{
            "title":"Standard Cost Overhead Rate Details",
            "type":"array",
            "description":"The Standard Cost Overhead Rate Details resource manages cost element-level details of the standard overhead rate.",
            "items":{
                "$ref":"#/components/schemas/standardOverheadRates-standardOverheadRateDetails-item-response"
            }
        },
        "CostOrgId":{
            "title":"Cost Organization",
            "type":"integer",
            "description":"Value that uniquely identifies the cost organization.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "dependencies":[
                    "ScenarioId"
                ]
            },
            "x-queryable":true
        },
        "CostBookDescription":{
            "title":"Cost Book Description",
            "maxLength":"240",
            "type":"string",
            "description":"Description of the cost book.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemDescription":{
            "title":"Item Description",
            "maxLength":"240",
            "type":"string",
            "description":"Description of the item for which standard overhead rate is displayed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StatusCode":{
            "title":"Status",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "default":"IN_PROCESS",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ItemId":{
            "title":"Item",
            "type":"integer",
            "description":"Value that uniquely identifies an item.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "dependencies":[
                    "InventoryOrgId"
                ]
            },
            "x-queryable":true
        },
        "Attachments":{
            "title":"Attachments",
            "type":"array",
            "description":"The attachments resource is used to view, create, and update attachments.",
            "items":{
                "$ref":"#/components/schemas/standardOverheadRates-Attachments-item-response"
            }
        },
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":"15",
            "type":"string",
            "description":"Abbreviation that identifies the currency in which the overhead rate is set up.",
            "nullable":false,
            "x-hints":{
                "dependencies":[
                    "ScenarioId"
                ]
            },
            "x-queryable":true
        },
        "HeaderReferenceNumber":{
            "maxLength":"18",
            "type":"string",
            "description":"Unique reference number added by the user to link an overhead rate header with the detail record. This is only applicable when the overhead rate is created through Oracle Visual Builder Cloud Service template.",
            "nullable":true,
            "x-queryable":true
        },
        "ItemNumber":{
            "title":"Item",
            "maxLength":"1000",
            "type":"string",
            "description":"Number that identifies the item.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "InventoryOrgName":{
            "title":"Plant",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the organization to which the component item belongs.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "OverheadRateType":{
            "title":"Overhead Rate Type",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CostOrgCode":{
            "title":"Cost Organization Code",
            "maxLength":"150",
            "type":"string",
            "description":"Abbreviation that identifies the cost organization for which the standard overhead rate is displayed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkCenterCode":{
            "title":"Work Center Code",
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the work center for the overhead rate under the work definition operation.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StandardOverheadRateId":{
            "type":"integer",
            "description":"Value that uniquely identifies the standard overhead rate.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "WorkCenterName":{
            "title":"Work Center",
            "maxLength":"120",
            "type":"string",
            "description":"Name of the work center for the work definition operation.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ScenarioId":{
            "title":"Scenario",
            "type":"integer",
            "description":"Value that uniquely identifies the cost scenario for which the overhead rate is set up.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "EffectiveEndDate":{
            "title":"Effective End Date",
            "type":"string",
            "description":"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.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "InventoryOrgId":{
            "title":"Plant",
            "type":"integer",
            "description":"Value that uniquely identifies the inventory organization or plant for which the standard overhead rate is displayed.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "dependencies":[
                    "CostOrgId"
                ]
            },
            "x-queryable":true
        },
        "ResourceType":{
            "title":"Resource Type",
            "maxLength":"30",
            "type":"string",
            "description":"Type of resource. Values include LABOR and EQUIPMENT. A list of accepted values is defined in the lookup type ORA_WIS_RESOURCE_TYPE.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CurrencyName":{
            "title":"Currency Name",
            "maxLength":"80",
            "type":"string",
            "description":"Name of the currency.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ScenarioNumber":{
            "title":"Scenario",
            "maxLength":"30",
            "type":"string",
            "description":"Number that identifies the cost planning scenario. This value is defined by the user.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CostBookCode":{
            "title":"Cost Book",
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the cost book in which the standard overhead rate details are displayed.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "InventoryOrgCode":{
            "title":"Inventory Organization Code",
            "maxLength":"18",
            "type":"string",
            "description":"Abbreviation that identifies the organization to which the item belongs.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StatusCodeMeaning":{
            "title":"Status",
            "maxLength":"80",
            "type":"string",
            "description":"Translatable name for the status code.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CategoryName":{
            "title":"Item Category",
            "maxLength":"2400",
            "type":"string",
            "description":"Name of the item category.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CostOrgName":{
            "title":"Cost Organization",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the cost organization for which the standard overhead rate is displayed.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ResourceTypeMeaning":{
            "title":"Resource Type",
            "maxLength":"80",
            "type":"string",
            "description":"Translatable name for resource type codes.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EffectiveStartDate":{
            "title":"Effective Start Date",
            "type":"string",
            "description":"Date when the standard overhead rate  is effective.",
            "format":"date",
            "nullable":false,
            "x-hints":{
                "dependencies":[
                    "ScenarioId"
                ]
            },
            "x-queryable":true
        },
        "AttachmentEntityName":{
            "type":"string",
            "description":"Identifies the entity name of the attachment for the overhead rates.",
            "nullable":true,
            "default":"CST_STD_OVERHEAD_RATES",
            "x-queryable":true
        },
        "CostBookId":{
            "title":"Cost Book",
            "type":"integer",
            "description":"Value that uniquely identifies the cost book.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "dependencies":[
                    "ScenarioId"
                ]
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Attachments

Type: array

Title: Attachments

The attachments resource is used to view, create, and update attachments.

Show Source

Array of: object standardOverheadRates-Attachments-item-response

{
    "title":"Attachments",
    "type":"array",
    "description":"The attachments resource is used to view, create, and update attachments.",
    "items":{
        "$ref":"#/components/schemas/standardOverheadRates-Attachments-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 : 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

Array of: object standardOverheadRates-standardOverheadRateDetails-item-response

{
    "title":"Standard Cost Overhead Rate Details",
    "type":"array",
    "description":"The Standard Cost Overhead Rate Details resource manages cost element-level details of the standard overhead rate.",
    "items":{
        "$ref":"#/components/schemas/standardOverheadRates-standardOverheadRateDetails-item-response"
    }
}

Nested Schema : standardOverheadRates-Attachments-item-response

Type: object

Show Source

AsyncTrackerId: string

Title: Asynchronous Upload Tracker Id

Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.
AttachedDocumentId: integer (int64)

Title: Attached Document Id

The unique identifier of the attached document.
CategoryName: string

Title: Category

Maximum Length: 30

The category of the attachment.
ContentRepositoryFileShared: boolean

Title: Shared

Indicates whether the attachment is shared
CreatedBy: string

Title: Created By

Read Only: true

Maximum Length: 255

The user who created the record.
CreatedByUserName: string

Title: Created By User Name

Read Only: true

The user name who created the record.
CreationDate: string (date-time)

Title: Creation Date

Read Only: true

The date when the record was created.
DatatypeCode: string

Title: Type

Maximum Length: 30

Default Value: FILE

A value that indicates the data type.
Description: string

Title: Description

Maximum Length: 255

The description of the attachment.
DmDocumentId: string

Maximum Length: 255

The document ID from which the attachment is created.
DmFolderPath: string

Title: Dm Folder Path

Maximum Length: 1000

The folder path from which the attachment is created.
DmVersionNumber: string

Maximum Length: 255

The document version number from which the attachment is created.
DownloadInfo: string

Title: DownloadInfo

JSON object represented as a string containing information used to programmatically retrieve a file attachment.
ErrorStatusCode: string

Title: Error Status Code

The error code, if any, for the attachment.
ErrorStatusMessage: string

Title: Error Status Message

The error message, if any, for the attachment.
ExpirationDate: string (date-time)

Title: Expiration Date

The expiration date of the contents in the attachment.
FileContents: string (byte)

Title: File Contents

The contents of the attachment.
FileName: string

Title: File Name

Maximum Length: 2048

The file name of the attachment.
FileUrl: string

Title: File Url

The URI of the file.
FileWebImage: string (byte)

Title: File Web Image

Read Only: true

The base64 encoded image of the file displayed in .png format if the source is a convertible image.
LastUpdateDate: string (date-time)

Title: Last Update Date

Read Only: true

The date when the record was last updated.
LastUpdatedBy: string

Title: Last Updated By

Read Only: true

Maximum Length: 255

The user who last updated the record.
LastUpdatedByUserName: string

Title: Last Updated By User

Read Only: true

The user name who last updated the record.
links: array Links

Title: Links

The link relations associated with the resource instance.
PostProcessingAction: string

Title: PostProcessingAction

The name of the action that can be performed after an attachment is uploaded.
Title: string

Title: Title

The title of the attachment.
UploadedFileContentType: string

Title: Uploaded File Content Type

The content type of the attachment.
UploadedFileLength: integer

Title: File Size

The size of the attachment file.
UploadedFileName: string

Title: Uploaded File Name

The name to assign to a new attachment file.
UploadedText: string

Title: Uploaded Text

The text content for a new text attachment.
Uri: string

Title: Uri

Maximum Length: 4000

The URI of a Topology Manager type attachment.
Url: string

Title: Url

Maximum Length: 4000

The URL of a web page type attachment.
UserName: string

Title: User Name

Read Only: true

Maximum Length: 255

The login credentials of the user who created the attachment.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"255",
            "type":"string",
            "description":"The description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":"2048",
            "type":"string",
            "description":"The file name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "FileWebImage":{
            "title":"File Web Image",
            "type":"string",
            "description":"The base64 encoded image of the file displayed in .png format if the source is a convertible image.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide",
                "PAYLOADHINT":"Show"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":"4000",
            "type":"string",
            "description":"The URI of a Topology Manager type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "Url":{
            "title":"Url",
            "maxLength":"4000",
            "type":"string",
            "description":"The URL of a web page type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DmDocumentId":{
            "maxLength":"255",
            "type":"string",
            "description":"The document ID from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"The unique identifier of the attached document.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"The content type of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"JSON object represented as a string containing information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CreatedByUserName":{
            "title":"Created By User Name",
            "type":"string",
            "description":"The user name who created the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"The size of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmVersionNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"The document version number from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"255",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"The error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UserName":{
            "title":"User Name",
            "maxLength":"255",
            "type":"string",
            "description":"The login credentials of the user who created the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"255",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"A value that indicates the data type.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"The name of the action that can be performed after an attachment is uploaded.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"The title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "LastUpdatedByUserName":{
            "title":"Last Updated By User",
            "type":"string",
            "description":"The user name who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"The name to assign to a new attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"The URI of the file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates whether the attachment is shared",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"The contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The expiration date of the contents in the attachment.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"The error code, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":"1000",
            "type":"string",
            "description":"The folder path from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"The text content for a new text attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":"30",
            "type":"string",
            "description":"The category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "FMT_FORMAT":"d-MMM-yyyy HH:mm:ss"
            },
            "x-queryable":true
        },
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "type":"string",
            "description":"Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        }
    }
}

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

Nested Schema : standardOverheadRates-standardOverheadRateDetails-item-response

Type: object

Show Source

AbsorptionType: string

Title: Absorption Type

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

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

Read Only: true

Maximum Length: 30

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

Title: Expense Pool

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

Examples

This example describes how to get all overhead rates.

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"

Example Response Body

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

{
	  "items": [
	    {
		      "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"
			        }
		      ]
		    },
	    {
		      "StandardOverheadRateId": 300100181560241,
		      "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": 300100059526520,
		      "ItemNumber": "ZDQ-Enj",
		      "ItemDescription": "ZDQ-Enj",
		      "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/300100181560241",
			          "name": "standardOverheadRates",
			          "kind": "item"
			        },
		        {
			          "rel": "canonical",
			          "href": "https://servername/fscmRestApi/resources/version/standardOverheadRates/300100181560241",
			          "name": "standardOverheadRates",
			          "kind": "item"
			        },
		        {
			          "rel": "child",
			          "href": "https://servername/fscmRestApi/resources/version/standardOverheadRates/300100181560241/child/standardOverheadRateDetails",
			          "name": "standardOverheadRateDetails",
			          "kind": "collection"
			        }
		      ]
		    },],
	  "count": 19,
	  "hasMore": false,
	  "limit": 25,
	  "offset": 0,
	  "links": [
	    {
		      "rel": "self",
		      "href": "https://servername/fscmRestApi/resources/version/standardOverheadRates",
		      "name": "standardOverheadRates",
		      "kind": "collection"
		    }
	  ]
}