Create multiple cost scenarios

post

/fscmRestApi/resources/11.13.18.05/costScenarios

Request

Header Parameters
  • 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".
  • 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.
  • 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.
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
Nested Schema : Work Definition Criteria Details
Type: array
Title: Work Definition Criteria Details
Item number, resource code, catalog name, and category name specified in a cost scenario.
Show Source
Nested Schema : schema
Type: object
Show Source
  • Title: Category Name
    Indicates the item category identifier used to identify the work definitions to be used for cost rollup for a cost planning scenario.
  • Maximum Length: 2400
    Indicates the name of the item category used to set the scope of the cost planning scenario.
  • Indicates the item cost category set to be used for identifying the work definitions used for work definition explosion in a cost planning scenario.
  • Maximum Length: 30
    Indicates the set to which the category is mapped.
  • Title: Item
    Indicates the item identifier used to identify the work definitions used for rolling up the cost in a cost planning scenario.
  • Maximum Length: 255
    Indicates the identifier of the item used to identify the work definitions used for rolling up the cost in a cost planning scenario.
  • Code for the resource used to set the scope of a type of configured item cost scenario.
  • Indicates the resource to be used for identifying the work definitions used for rolling up cost in a cost planning scenario.
  • Name of the resource used to set the scope of a type of configured item cost scenario.
Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Body ()
Root Schema : costScenarios-item-response
Type: object
Show Source
Nested Schema : Work Definition Criteria Details
Type: array
Title: Work Definition Criteria Details
Item number, resource code, catalog name, and category name specified in a cost scenario.
Show Source
Nested Schema : costScenarios-WorkDefinitionCriteriaDetails-item-response
Type: object
Show Source
  • Read Only: true
    Maximum Length: 240
    Indicates the item category used to set the scope of the cost planning scenario.
  • Title: Category Name
    Indicates the item category identifier used to identify the work definitions to be used for cost rollup for a cost planning scenario.
  • Maximum Length: 2400
    Indicates the name of the item category used to set the scope of the cost planning scenario.
  • Read Only: true
    Maximum Length: 240
    Indicates the catalog to which the category is assigned.
  • Indicates the item cost category set to be used for identifying the work definitions used for work definition explosion in a cost planning scenario.
  • Maximum Length: 30
    Indicates the set to which the category is mapped.
  • Title: Item
    Indicates the item identifier used to identify the work definitions used for rolling up the cost in a cost planning scenario.
  • Title: Item Description
    Read Only: true
    Maximum Length: 240
    Indicates the description of the item used to identify the work definitions used for rolling up the cost in a cost planning scenario.
  • Maximum Length: 255
    Indicates the identifier of the item used to identify the work definitions used for rolling up the cost in a cost planning scenario.
  • Links
  • Code for the resource used to set the scope of a type of configured item cost scenario.
  • Indicates the resource to be used for identifying the work definitions used for rolling up cost in a cost planning scenario.
  • Name of the resource used to set the scope of a type of configured item cost scenario.
  • Title: Type
    Read Only: true
    Maximum Length: 30
    Contains the resource type.
  • Read Only: true
    Indicates the unique identifier for criteria detail.
Back to Top

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"
} ]
}
Back to Top