Get all cost scenarios
get
/fscmRestApi/resources/11.13.18.05/costScenarios
Request
Query Parameters
-
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 the cost scenario that matches the primary key criteria specified.
Finder Variables:- ScenarioId; integer; Unique cost-scenario identifier.
- findByCostOrgCostBook: Finds the cost scenario based on cost organization and cost book.
Finder Variables:- bindCostBookCode; string; Code of the cost book associated with the cost scenario.
- bindCostOrgName; string; Name of the cost organization associated with the cost scenario.
- findByScenarioNumber: Finds the cost scenario based on the cost-scenario number.
Finder Variables:- bindScenarioNumber; string; Cost scenario number.
- findUnpublishedByCostOrgCostBook: Finds the unpublished cost scenario based on cost organization and cost book.
Finder Variables:- bindCostBookCode; string; Code of the cost book associated with the unpublished cost scenario.
- bindCostOrgName; string; Name of the cost organization associated with the unpublished cost scenario.
- PrimaryKey: Finds the cost scenario that matches the primary key criteria specified.
-
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:- Comments; string; Indicates the detailed information or comments about the cost scenario.
- CompletedCount; integer; Indicates the total count of rows successfully completed for the scenario event.
- CostBookCode; string; Code that identifies the cost book associated with the cost scenario.
- CostBookDescription; string; Description of the cost book.
- CostBookId; integer; Indicates the accounting cost book associated with the cost scenario.
- CostOrgCode; string; Code that identifies cost organization associated with the cost scenario.
- CostOrgId; integer; Value that uniquely identifies the cost organization.
- CostOrgName; string; Name of the cost organization associated with the cost scenario.
- CreatedBy; string; Indicates the user who created the row.
- CreationDate; string; Indicates the date and time of the creation of the row.
- EffectiveStartDate; string; Indicates the date for which the scenario becomes effective.
- EndTime; string; Indicates the end time of the scenario event.
- EventStatusCode; string; Indicates the status of the scenario event. Valid values are NOT_STARTED, PROCESSING, SUCCESS, WARNING, ERROR, CANCELED.
- ExplosionBasis; string; Indicates the explosion basis to be used for work definition explosion in the scenario.
- ExplosionSequence; string; Indicates the order in which the explosion logic would apply the priorities during the work definition explosion in a cost planning scenario. Valid values are: WD Name - Costing Priority - Planning Priority (NCP) WD Name - Planning Priority - Costing Priority (NPC) Costing Priority - Planning Priority - WD Name (CPN) Costing Priority - WD Name - Planning Priority (CNP) Planning Priority - Costing Priority - WD Name (PCN) Planning Priority - WD Name - Costing Priority (PNC).
- FailedCount; integer; Indicates the total count of rows failed for the scenario event.
- LastUpdateDate; string; Indicates the date and time of the last update of the row.
- LastUpdatedBy; string; Indicates the user who last updated the row.
- PeriodName; string; Indicates the period for periodic average cost book based scenarios.
- PeriodicAverageFlag; boolean; Indicates if the Cost Book is a periodic average cost-enabled cost book.
- PrimaryBookFlag; boolean; Identifies if the cost book has been associated with primary or secondary ledger or whetehr it is a ledger less book.
- ReasonCode; string; Indicates the reason code of why the scenario became modified.
- RefreshWdFlag; boolean; Indicates whether during the build and rollup process, the work definition snapshots should be refreshed from the manufacturing tables or should the last used work definition for the item and plant combination from a previous scenario be used. Valid values are 'Y' and 'N'. Default is 'Y' indicating the work definitions would be refreshed.
- RollupGroupDescription; string; Indicates the cost rollup group description. This attribute is only applicable for cost scenarios enabled for supply chain cost rollup.
- RollupGroupId; integer; Primary key that uniquely identifies the cost rollup group specified on the scenario. This attribute is only applicable for cost scenarios enabled for supply chain cost rollup.
- RollupGroupName; string; Indicates the cost rollup group name. This attribute is only applicable for cost scenarios enabled for supply chain cost rollup.
- RollupScope; string; Indicates the scope of the data to roll up.
- ScenarioEventDate; string; Indicates the date and time in which the event occurred.
- ScenarioEventNumber; string; Indicates the user defined event number for scenario events. Value is defaulted based on the event type as follows: CREATE BUILD-1 BUILD-2 ROLLUP-1 ROLLUP-2 PUBLISH-1 PUBLISH-2 and so on.
- ScenarioEventType; string; Indicates the type of scenario event. Valid values are CREATE, BUILD, ROLLUP, PUBLISH.
- ScenarioId; integer; Surrogate key and unique identifier for each cost scenario.
- ScenarioNumber; string; User defined number to identify the cost scenario.
- ScenarioType; string; Indicates the type of the scenario.
- SingleLevelRollupFlag; boolean; Indicates that only the first level of the item structure for the selected items will be rolled up.
- StartTime; string; Indicates the start time of the scenario event.
- StateCode; string; Indicates the state of the scenario.
- StatusCode; string; Indicates the status of the scenario.
- TotalCount; integer; Indicates the total count of rows processed for the scenario event.
- WorkDefName; string; Indicates the name of the work definition.
- WorkDefinitionNameId; integer; Indicates the work definition name identifier that would be used during the work definition explosion in the cost scenario, when the work definition name option is considered.
-
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 TopResponse
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 : costScenarios
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : costScenarios-item-response
Type:
Show Source
object
-
Comments: string
Maximum Length:
1000
Indicates the detailed information or comments about the cost scenario. -
CompletedCount: integer
(int32)
Indicates the total count of rows successfully completed for the scenario event.
-
CostBookCode: string
Maximum Length:
30
Code that identifies the cost book associated with the cost scenario. -
CostBookDescription: string
Title:
Description
Maximum Length:240
Description of the cost book. -
CostBookId: integer
(int64)
Default Value:
-1
Indicates the accounting cost book associated with the cost scenario. -
CostOrgCode: string
Maximum Length:
150
Code that identifies cost organization associated with the cost scenario. -
CostOrgId: integer
(int64)
Default Value:
-1
Value that uniquely identifies the cost organization. -
CostOrgName: string
Maximum Length:
240
Name of the cost organization associated with the cost scenario. -
CreatedBy: string
Read Only:
true
Maximum Length:64
Indicates the user who created the row. -
CreationDate: string
(date-time)
Read Only:
true
Indicates the date and time of the creation of the row. -
EffectiveStartDate: string
(date)
Indicates the date for which the scenario becomes effective.
-
EndTime: string
(date-time)
Indicates the end time of the scenario event.
-
EventStatusCode: string
Read Only:
true
Maximum Length:30
Default Value:SUCCESS
Indicates the status of the scenario event. Valid values are NOT_STARTED, PROCESSING, SUCCESS, WARNING, ERROR, CANCELED. -
ExplosionBasis: string
Maximum Length:
30
Default Value:TOP_DOWN
Indicates the explosion basis to be used for work definition explosion in the scenario. -
ExplosionSequence: string
Maximum Length:
30
Default Value:PCN
Indicates the order in which the explosion logic would apply the priorities during the work definition explosion in a cost planning scenario. Valid values are: WD Name - Costing Priority - Planning Priority (NCP) WD Name - Planning Priority - Costing Priority (NPC) Costing Priority - Planning Priority - WD Name (CPN) Costing Priority - WD Name - Planning Priority (CNP) Planning Priority - Costing Priority - WD Name (PCN) Planning Priority - WD Name - Costing Priority (PNC). -
FailedCount: integer
(int32)
Indicates the total count of rows failed for the scenario event.
-
LastUpdateDate: string
(date-time)
Read Only:
true
Indicates the date and time of the last update of the row. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
Indicates the user who last updated the row. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PeriodicAverageFlag: boolean
Read Only:
true
Maximum Length:1
Indicates if the Cost Book is a periodic average cost-enabled cost book. -
PeriodName: string
Maximum Length:
15
Indicates the period for periodic average cost book based scenarios. -
PrimaryBookFlag: boolean
Read Only:
true
Maximum Length:255
Identifies if the cost book has been associated with primary or secondary ledger or whetehr it is a ledger less book. -
ReasonCode: string
Maximum Length:
30
Indicates the reason code of why the scenario became modified. -
RefreshWdFlag: boolean
Maximum Length:
1
Default Value:true
Indicates whether during the build and rollup process, the work definition snapshots should be refreshed from the manufacturing tables or should the last used work definition for the item and plant combination from a previous scenario be used. Valid values are 'Y' and 'N'. Default is 'Y' indicating the work definitions would be refreshed. -
RollupGroupDescription: string
Read Only:
true
Maximum Length:240
Indicates the cost rollup group description. This attribute is only applicable for cost scenarios enabled for supply chain cost rollup. -
RollupGroupId: integer
(int64)
Read Only:
true
Primary key that uniquely identifies the cost rollup group specified on the scenario. This attribute is only applicable for cost scenarios enabled for supply chain cost rollup. -
RollupGroupName: string
Read Only:
true
Maximum Length:80
Indicates the cost rollup group name. This attribute is only applicable for cost scenarios enabled for supply chain cost rollup. -
RollupScope: string
Maximum Length:
30
Default Value:ALL_ITEMS
Indicates the scope of the data to roll up. -
ScenarioEventDate: string
(date-time)
Indicates the date and time in which the event occurred.
-
ScenarioEventNumber: string
Read Only:
true
Maximum Length:30
Default Value:CREATE
Indicates the user defined event number for scenario events. Value is defaulted based on the event type as follows: CREATE BUILD-1 BUILD-2 ROLLUP-1 ROLLUP-2 PUBLISH-1 PUBLISH-2 and so on. -
ScenarioEventType: string
Read Only:
true
Maximum Length:30
Default Value:CREATE
Indicates the type of scenario event. Valid values are CREATE, BUILD, ROLLUP, PUBLISH. -
ScenarioId: integer
(int64)
Read Only:
true
Surrogate key and unique identifier for each cost scenario. -
ScenarioNumber: string
Maximum Length:
30
User defined number to identify the cost scenario. -
ScenarioType: string
Read Only:
true
Maximum Length:30
Default Value:STANDARD
Indicates the type of the scenario. -
SingleLevelRollupFlag: boolean
Maximum Length:
1
Default Value:false
Indicates that only the first level of the item structure for the selected items will be rolled up. -
StartTime: string
(date-time)
Indicates the start time of the scenario event.
-
StateCode: string
Maximum Length:
30
Default Value:NEW
Indicates the state of the scenario. -
StatusCode: string
Maximum Length:
30
Default Value:NEW
Indicates the status of the scenario. -
TotalCount: integer
(int32)
Indicates the total count of rows processed for the scenario event.
-
WorkDefinitionCriteriaDetails: array
Work Definition Criteria Details
Title:
Work Definition Criteria Details
The Work Definition Criteria Details resource allows users to create, query, and update criteria details for cost scenarios. The details include items or item categories selected for cost rollup in the cost scenario. -
WorkDefinitionNameId: integer
(int64)
Title:
Work Definition
Indicates the work definition name identifier that would be used during the work definition explosion in the cost scenario, when the work definition name option is considered. -
WorkDefName: string
Maximum Length:
255
Indicates the name of the work definition.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Work Definition Criteria Details
Type:
array
Title:
Work Definition Criteria Details
The Work Definition Criteria Details resource allows users to create, query, and update criteria details for cost scenarios. The details include items or item categories selected for cost rollup in the cost scenario.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : costScenarios-WorkDefinitionCriteriaDetails-item-response
Type:
Show Source
object
-
CategoryDescription: string
Read Only:
true
Maximum Length:255
Description of the item category where items would be rolled up within the scenario. -
CategoryId: integer
(int64)
Uniquely identifies the item category for which the overhead rates are displayed.
-
CategoryName: string
Maximum Length:
255
Name of the item category where items would be rolled up within the scenario. -
CategorySetDescription: string
Read Only:
true
Maximum Length:255
Description of the item catalog. -
CategorySetId: integer
(int64)
Unique identifier for item catalog.
-
CategorySetName: string
Maximum Length:
255
Name of the item catalog. -
InventoryItemId: integer
(int64)
Indicates the unique identifier of the selected item to be rolled up within the scenario.
-
ItemDescription: string
Read Only:
true
Maximum Length:255
Description of the selected item to be rolled up within the scenario. -
ItemNumber: string
Maximum Length:
255
Indicates the unique name of the selected item to be rolled up within the scenario. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
WdCriterionDetailId: integer
(int64)
Read Only:
true
Surrogate key and unique identifier for criteria detail.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source