Create multiple cost scenarios
/fscmRestApi/resources/11.13.18.05/costScenarios
Request
-
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
- application/json
object
-
AssignmentSetId: integer
(int64)
Primary key that uniquely identifies the sourcing assignment set referenced in the cost scenario. This attribute is only applicable for cost scenarios enabled for supply chain cost rollup.
-
AssignmentSetName: string
Maximum Length:
34
Indicates the name of the sourcing assignment set. This attribute is only applicable for cost scenarios enabled for supply chain cost rollup. -
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. -
EffectiveStartDate(required): string
(date)
Indicates the date for which the scenario becomes effective.
-
EndTime: string
(date-time)
Indicates the end time of the scenario event.
-
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.
-
OrganizationContext: string
Maximum Length:
30
Organization context specifies whether the cost rollup would be for a cost organization and cost book combination or for a group of cost organization and cost book combinations. This attribute is only applicable for cost scenarios enabled for supply chain cost rollup. -
PeriodName: string
Maximum Length:
15
Indicates the period for periodic average cost book based scenarios. -
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. -
RollupGroupId: integer
(int64)
Default Value:
-1
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
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. -
RuleSetName: string
Maximum Length:
80
Indicates the transfer charge rule set referenced in the cost scenario. This attribute is only applicable for cost scenarios enabled for supply chain cost rollup. -
ScenarioEventDate: string
(date-time)
Indicates the date and time in which the event occurred.
-
ScenarioNumber(required): string
Maximum Length:
30
User defined number to identify the cost 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. -
SupplyChainRollupFlag: boolean
Maximum Length:
1
Default Value:false
Indicates whether the cost scenario is enabled for supply chain cost rollup. -
TotalCount: integer
(int32)
Indicates the total count of rows processed for the scenario event.
-
TransferCostRuleSetId: integer
(int64)
Primary key that uniquely identifies the transfer charge rule set. This attribute is only applicable for cost scenarios enabled for supply chain cost rollup.
-
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.
array
Work Definition Criteria Details
object
-
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. -
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.
-
ItemNumber: string
Maximum Length:
255
Indicates the unique name of the selected item to be rolled up within the scenario.
Response
- application/json
Default Response
-
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.
object
-
AssignmentSetId: integer
(int64)
Primary key that uniquely identifies the sourcing assignment set referenced in the cost scenario. This attribute is only applicable for cost scenarios enabled for supply chain cost rollup.
-
AssignmentSetName: string
Maximum Length:
34
Indicates the name of the sourcing assignment set. This attribute is only applicable for cost scenarios enabled for supply chain cost rollup. -
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. -
OrganizationContext: string
Maximum Length:
30
Organization context specifies whether the cost rollup would be for a cost organization and cost book combination or for a group of cost organization and cost book combinations. This attribute is only applicable for cost scenarios enabled for supply chain cost rollup. -
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)
Default Value:
-1
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
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. -
RuleSetName: string
Maximum Length:
80
Indicates the transfer charge rule set referenced in the cost scenario. This attribute is only applicable for cost scenarios enabled for supply chain cost rollup. -
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. -
SupplyChainRollupFlag: boolean
Maximum Length:
1
Default Value:false
Indicates whether the cost scenario is enabled for supply chain cost rollup. -
TotalCount: integer
(int32)
Indicates the total count of rows processed for the scenario event.
-
TransferCostRuleSetId: integer
(int64)
Primary key that uniquely identifies the transfer charge rule set. This attribute is only applicable for cost scenarios enabled for supply chain cost rollup.
-
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.
array
Links
array
Work Definition Criteria Details
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.
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
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.
array
Links
- WorkDefinitionCriteriaDetails
-
Parameters:
- costScenariosUniqID:
$request.path.costScenariosUniqID
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. - costScenariosUniqID:
Examples
These examples describe how to create cost scenarios.
Example cURL Command
Use the following cURL command to submit a request on the REST resource.
curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/costScenarios"
Example Number | Description |
---|---|
Example 1 | Create a scenario to roll up all items. |
Example 2 | Create a scenario to roll up selected items. |
Example 3 | Create a scenario to roll up selected item categories. |
Example 1
This example describes how to create a scenario to roll up all items.
Example 1 Request Body
The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it updates.
"ScenarioNumber": "VisionJan2023", "CostOrgName": "ZCST-Vision Ops", "CostBookCode": "ZCST-Vision Ops", "EffectiveStartDate": "2023-01-01" }
Example 1 Response Body
The following example includes the contents of the response body in JSON format:
{ "ScenarioId" : 300100577274939, "ScenarioNumber" : "VisionJan2023", "CostOrgId" : 100000012270096, "CostOrgName" : "ZCST-Vision Ops", "CostOrgCode" : "ORG4", "CostBookId" : 100000010001016, "CostBookCode" : "ZCST-Vision Ops", "CostBookDescription" : "Cost Book for Vision Operations", "PeriodicAverageFlag" : false, "PrimaryBookFlag" : null, "EffectiveStartDate" : "2023-01-01", "PeriodName" : null, "ScenarioType" : "STANDARD", "StatusCode" : "NEW", "StateCode" : "NEW", "ReasonCode" : null, "Comments" : null, "ExplosionSequence" : "PCN", "ExplosionBasis" : "TOP_DOWN", "WorkDefinitionNameId" : null, "WorkDefName" : null, "RefreshWdFlag" : true, "RollupScope" : "ALL_ITEMS", "SingleLevelRollupFlag" : false, "ScenarioEventType" : "CREATE", "ScenarioEventNumber" : "CREATE", "ScenarioEventDate" : "2023-01-27T00:04:28.774+00:00", "EventStatusCode" : "SUCCESS", "StartTime" : "2023-01-27T00:04:28.778+00:00", "EndTime" : "2023-01-27T00:04:28.778+00:00", "TotalCount" : 1, "CompletedCount" : 1, "FailedCount" : 0, "CreatedBy" : "COST_ACCT_ALL_COST_ORGS", "CreationDate" : "2023-01-27T00:04:27+00:00", "LastUpdateDate" : "2023-01-27T00:04:28.174+00:00", "LastUpdatedBy" : "COST_ACCT_ALL_COST_ORGS", "links" : [ { "rel" : "self", "href" : "https://servername/fscmRestApi/resources/version/costScenarios /00030000000EACED00057708000110F09C4E2C3B0000000EACED00057708000110F09C4E2C3C0000000EACED00057708000110F09 C4E2C3D", "name" : "costScenarios", "kind" : "item", "properties" : { "changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A6578700000000377040 0000003737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C6 16E672E4E756D62657286AC951D0B94E08B0200007870000000017371007E0002000000017372001B6F7261636C652E6A626F2E646F6 D61696E2E4E756C6C56616C75655899C1C58DAABEEB02000149000A6D53514C54797065496478700000000C78" } }, { "rel" : "canonical", "href" : "https://servername/fscmRestApi/resources/version/costScenarios /00030000000EACED00057708000110F09C4E2C3B0000000EACED00057708000110F09C4E2C3C0000000EACED00057708000110F09 C4E2C3D", "name" : "costScenarios", "kind" : "item" }, { "rel" : "child", "href" : "https://servername/fscmRestApi/resources/version/costScenarios /00030000000EACED00057708000110F09C4E2C3B0000000EACED00057708000110F09C4E2C3C0000000EACED00057708000110F09 C4E2C3D/child/WorkDefinitionCriteriaDetails", "name" : "WorkDefinitionCriteriaDetails", "kind" : "collection" } ] }
Example 2
This example describes how to create a scenario to roll up selected items.
Example 2 Request Body
The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it updates.
{ "ScenarioNumber": "VisionJan2023-SelItems", "CostOrgName": "ZCST-Vision Ops", "CostBookCode": "ZCST-Vision Ops", "EffectiveStartDate": "2023-01-01", "RollupScope": "SELECTED_ITEMS", "WorkDefinitionCriteriaDetails": [ { "ItemNumber": "ZQIM-LotSerial" } ] }
Example 2 Response Body
The following example includes the contents of the response body in JSON format:
{ "ScenarioId" : 300100577274383, "ScenarioNumber" : "VisionJan2023-SelItems", "CostOrgId" : 100000012270096, "CostOrgName" : "ZCST-Vision Ops", "CostOrgCode" : "ORG4", "CostBookId" : 100000010001016, "CostBookCode" : "ZCST-Vision Ops", "CostBookDescription" : "Cost Book for Vision Operations", "PeriodicAverageFlag" : false, "PrimaryBookFlag" : null, "EffectiveStartDate" : "2023-01-01", "PeriodName" : null, "ScenarioType" : "STANDARD", "StatusCode" : "NEW", "StateCode" : "NEW", "ReasonCode" : null, "Comments" : null, "ExplosionSequence" : "PCN", "ExplosionBasis" : "TOP_DOWN", "WorkDefinitionNameId" : null, "WorkDefName" : null, "RefreshWdFlag" : true, "RollupScope" : "SELECTED_ITEMS", "SingleLevelRollupFlag" : false, "ScenarioEventType" : "CREATE", "ScenarioEventNumber" : "CREATE", "ScenarioEventDate" : "2023-01-27T00:08:03.424+00:00", "EventStatusCode" : "SUCCESS", "StartTime" : "2023-01-27T00:08:03.428+00:00", "EndTime" : "2023-01-27T00:08:03.428+00:00", "TotalCount" : 1, "CompletedCount" : 1, "FailedCount" : 0, "CreatedBy" : "COST_ACCT_ALL_COST_ORGS", "CreationDate" : "2023-01-27T00:08:02+00:00", "LastUpdateDate" : "2023-01-27T00:08:05.194+00:00", "LastUpdatedBy" : "COST_ACCT_ALL_COST_ORGS", "WorkDefinitionCriteriaDetails" : [ { "WdCriterionDetailId" : 300100577274387, "InventoryItemId" : 300100122347285, "ItemNumber" : "ZQIM-LotSerial", "ItemDescription" : null, "CategoryId" : null, "CategoryName" : null, "CategoryDescription" : null, "CategorySetId" : null, "CategorySetName" : null, "CategorySetDescription" : null, "links" : [ { "rel" : "self", "href" : "https://servername/fscmRestApi/resources/version/costScenarios /00030000000EACED00057708000110F09C4E2A0F0000000EACED00057708000110F09C4E2A100000000EACED00057708000110F09 C4E2A11/child/WorkDefinitionCriteriaDetails/300100577274387", "name" : "WorkDefinitionCriteriaDetails", "kind" : "item", "properties" : { "changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A6578700000000177040 0000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C6 16E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel" : "canonical", "href" : "https://servername/fscmRestApi/resources/version/costScenarios /00030000000EACED00057708000110F09C4E2A0F0000000EACED00057708000110F09C4E2A100000000EACED00057708000110F09 C4E2A11/child/WorkDefinitionCriteriaDetails/300100577274387", "name" : "WorkDefinitionCriteriaDetails", "kind" : "item" }, { "rel" : "parent", "href" : "https://servername/fscmRestApi/resources/version/costScenarios /00030000000EACED00057708000110F09C4E2A0F0000000EACED00057708000110F09C4E2A100000000EACED00057708000110F09 C4E2A11", "name" : "costScenarios", "kind" : "item" } ] } ], "links" : [ { "rel" : "self", "href" : "https://servername/fscmRestApi/resources/version/costScenarios /00030000000EACED00057708000110F09C4E2A0F0000000EACED00057708000110F09C4E2A100000000EACED00057708000110F09 C4E2A11", "name" : "costScenarios", "kind" : "item", "properties" : { "changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A6578700000000377040 0000003737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C6 16E672E4E756D62657286AC951D0B94E08B0200007870000000017371007E0002000000017372001B6F7261636C652E6A626F2E646F6 D61696E2E4E756C6C56616C75655899C1C58DAABEEB02000149000A6D53514C54797065496478700000000C78" } }, { "rel" : "canonical", "href" : "https://servername/fscmRestApi/resources/version/costScenarios /00030000000EACED00057708000110F09C4E2A0F0000000EACED00057708000110F09C4E2A100000000EACED00057708000110F09 C4E2A11", "name" : "costScenarios", "kind" : "item" }, { "rel" : "child", "href" : "https://servername/fscmRestApi/resources/version/costScenarios /00030000000EACED00057708000110F09C4E2A0F0000000EACED00057708000110F09C4E2A100000000EACED00057708000110F09 C4E2A11/child/WorkDefinitionCriteriaDetails", "name" : "WorkDefinitionCriteriaDetails", "kind" : "collection" } ] }
Example 3
This example describes how to create a scenario to roll up selected item categories.
Example 3 Request Body
The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it updates.
{ "ScenarioNumber": "VisionJan2023-SelCat", "CostOrgName": "ZCST-Vision Ops", "CostBookCode": "ZCST-Vision Ops", "EffectiveStartDate": "2022-08-10", "RollupScope": "SELECTED_ITEM_CATEGORIES", "WorkDefinitionCriteriaDetails": [ { "CategoryName": "32000000", "CategorySetName": "Inv.Items" } ] }
Example 3 Response Body
The following example includes the contents of the response body in JSON format:
{ "ScenarioId" : 300100577274388, "ScenarioNumber" : "VisionJan2023-SelCat", "CostOrgId" : 100000012270096, "CostOrgName" : "ZCST-Vision Ops", "CostOrgCode" : "ORG4", "CostBookId" : 100000010001016, "CostBookCode" : "ZCST-Vision Ops", "CostBookDescription" : "Cost Book for Vision Operations", "PeriodicAverageFlag" : false, "PrimaryBookFlag" : null, "EffectiveStartDate" : "2022-08-10", "PeriodName" : null, "ScenarioType" : "STANDARD", "StatusCode" : "NEW", "StateCode" : "NEW", "ReasonCode" : null, "Comments" : null, "ExplosionSequence" : "PCN", "ExplosionBasis" : "TOP_DOWN", "WorkDefinitionNameId" : null, "WorkDefName" : null, "RefreshWdFlag" : true, "RollupScope" : "SELECTED_ITEM_CATEGORIES", "SingleLevelRollupFlag" : false, "ScenarioEventType" : "CREATE", "ScenarioEventNumber" : "CREATE", "ScenarioEventDate" : "2023-01-27T00:12:02.065+00:00", "EventStatusCode" : "SUCCESS", "StartTime" : "2023-01-27T00:12:02.066+00:00", "EndTime" : "2023-01-27T00:12:02.066+00:00", "TotalCount" : 1, "CompletedCount" : 1, "FailedCount" : 0, "CreatedBy" : "COST_ACCT_ALL_COST_ORGS", "CreationDate" : "2023-01-27T00:12:01+00:00", "LastUpdateDate" : "2023-01-27T00:12:02.443+00:00", "LastUpdatedBy" : "COST_ACCT_ALL_COST_ORGS", "WorkDefinitionCriteriaDetails" : [ { "WdCriterionDetailId" : 300100577274392, "InventoryItemId" : null, "ItemNumber" : null, "ItemDescription" : null, "CategoryId" : 100000019372730, "CategoryName" : "32000000", "CategoryDescription" : null, "CategorySetId" : 27, "CategorySetName" : "Inv.Items", "CategorySetDescription" : null, "links" : [ { "rel" : "self", "href" : "https://servername/fscmRestApi/resources/version/costScenarios /00030000000EACED00057708000110F09C4E2A140000000EACED00057708000110F09C4E2A150000000EACED00057708000110F09 C4E2A16/child/WorkDefinitionCriteriaDetails/300100577274392", "name" : "WorkDefinitionCriteriaDetails", "kind" : "item", "properties" : { "changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A6578700000000177040 0000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C6 16E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel" : "canonical", "href" : "https://servername/fscmRestApi/resources/version/costScenarios /00030000000EACED00057708000110F09C4E2A140000000EACED00057708000110F09C4E2A150000000EACED00057708000110F09 C4E2A16/child/WorkDefinitionCriteriaDetails/300100577274392", "name" : "WorkDefinitionCriteriaDetails", "kind" : "item" }, { "rel" : "parent", "href" : "https://servername/fscmRestApi/resources/version/costScenarios /00030000000EACED00057708000110F09C4E2A140000000EACED00057708000110F09C4E2A150000000EACED00057708000110F09 C4E2A16", "name" : "costScenarios", "kind" : "item" } ] } ], "links" : [ { "rel" : "self", "href" : "https://servername/fscmRestApi/resources/version/costScenarios /00030000000EACED00057708000110F09C4E2A140000000EACED00057708000110F09C4E2A150000000EACED00057708000110F09 C4E2A16", "name" : "costScenarios", "kind" : "item", "properties" : { "changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A6578700000000377040 0000003737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C6 16E672E4E756D62657286AC951D0B94E08B0200007870000000017371007E0002000000017372001B6F7261636C652E6A626F2E646F6 D61696E2E4E756C6C56616C75655899C1C58DAABEEB02000149000A6D53514C54797065496478700000000C78" } }, { "rel" : "canonical", "href" : "https://servername/fscmRestApi/resources/version/costScenarios /00030000000EACED00057708000110F09C4E2A140000000EACED00057708000110F09C4E2A150000000EACED00057708000110F09 C4E2A16", "name" : "costScenarios", "kind" : "item" }, { "rel" : "child", "href" : "https://servername/fscmRestApi/resources/version/costScenarios /00030000000EACED00057708000110F09C4E2A140000000EACED00057708000110F09C4E2A150000000EACED00057708000110F09 C4E2A16/child/WorkDefinitionCriteriaDetails", "name" : "WorkDefinitionCriteriaDetails", "kind" : "collection" } ] }