Jump to

• Request
• Response

Update one cost scenario

patch

/fscmRestApi/resources/11.13.18.05/costScenarios/{costScenariosUniqID}

Request

Path Parameters

• costScenariosUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Cost Scenarios resource and used to uniquely identify an instance of Cost Scenarios. The client should not generate the hash key value. Instead, the client should query on the Cost Scenarios collection resource in order to navigate to a specific instance of Cost Scenarios to get the hash key.

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• 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.
• 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: string (date)
  Indicates the date for which the scenario becomes effective.
• 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).
• 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.
• 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.
• 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.
• 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.

{
    "type":"object",
    "properties":{
        "CostOrgId":{
            "type":"integer",
            "description":"Value that uniquely identifies the cost organization.",
            "format":"int64",
            "nullable":true,
            "default":"-1",
            "x-hints":{
                "precision":"18"
            }
        },
        "CostBookDescription":{
            "title":"Description",
            "maxLength":"240",
            "type":"string",
            "description":"Description of the cost book.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "StatusCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the status of the scenario.",
            "nullable":false,
            "default":"NEW"
        },
        "AssignmentSetId":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "RollupGroupName":{
            "maxLength":"80",
            "type":"string",
            "description":"Indicates the cost rollup group name. This attribute is only applicable for cost scenarios enabled for supply chain cost rollup.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "TransferCostRuleSetId":{
            "type":"integer",
            "description":"Primary key that uniquely identifies the transfer charge rule set. This attribute is only applicable for cost scenarios enabled for supply chain cost rollup.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "WorkDefinitionCriteriaDetails":{
            "title":"Work Definition Criteria Details",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/costScenarios-WorkDefinitionCriteriaDetails-item-patch-request"
            }
        },
        "WorkDefName":{
            "maxLength":"255",
            "type":"string",
            "description":"Indicates the name of the work definition.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "RollupGroupId":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":true,
            "default":"-1",
            "x-hints":{
                "precision":"18"
            }
        },
        "OrganizationContext":{
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "RuleSetName":{
            "maxLength":"80",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CostOrgCode":{
            "maxLength":"150",
            "type":"string",
            "description":"Code that identifies cost organization associated with the cost scenario.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RefreshWdFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "default":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Comments":{
            "maxLength":"1000",
            "type":"string",
            "description":"Indicates the detailed information or comments about the cost scenario.",
            "nullable":true
        },
        "StateCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the state of the scenario.",
            "nullable":false,
            "default":"NEW"
        },
        "SupplyChainRollupFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the cost scenario is enabled for supply chain cost rollup.",
            "nullable":false,
            "default":false,
            "x-queryable":false
        },
        "ReasonCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the reason code of why the scenario became modified.",
            "nullable":true
        },
        "AssignmentSetName":{
            "maxLength":"34",
            "type":"string",
            "description":"Indicates the name of the sourcing assignment set. This attribute is only applicable for cost scenarios enabled for supply chain cost rollup.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RollupScope":{
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the scope of the data to roll up.",
            "nullable":false,
            "default":"ALL_ITEMS",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CostBookCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Code that identifies the cost book associated with the cost scenario.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "SingleLevelRollupFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates that only the first level of the item structure for the selected items will be rolled up.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ExplosionBasis":{
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the explosion basis to be used for work definition explosion in the scenario.",
            "nullable":false,
            "default":"TOP_DOWN"
        },
        "PeriodName":{
            "maxLength":"15",
            "type":"string",
            "description":"Indicates the period for periodic average cost book based scenarios.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "ExplosionSequence":{
            "maxLength":"30",
            "type":"string",
            "description":"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:\nWD Name - Costing Priority - Planning Priority (NCP)\nWD Name - Planning Priority - Costing Priority (NPC)\nCosting Priority - Planning Priority - WD Name (CPN)\nCosting Priority - WD Name - Planning Priority (CNP)\nPlanning Priority - Costing Priority - WD Name (PCN)\nPlanning Priority - WD Name - Costing Priority (PNC).",
            "nullable":false,
            "default":"PCN"
        },
        "WorkDefinitionNameId":{
            "title":"Work Definition",
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "CostOrgName":{
            "maxLength":"240",
            "type":"string",
            "description":"Name of the cost organization associated with the cost scenario.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "EffectiveStartDate":{
            "type":"string",
            "description":"Indicates the date for which the scenario becomes effective.",
            "format":"date",
            "nullable":false
        },
        "CostBookId":{
            "type":"integer",
            "description":"Indicates the accounting cost book associated with the cost scenario.",
            "format":"int64",
            "nullable":true,
            "default":"-1",
            "x-hints":{
                "precision":"18"
            }
        }
    }
}

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

• Array of: object costScenarios-WorkDefinitionCriteriaDetails-item-patch-request

{
    "title":"Work Definition Criteria Details",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/costScenarios-WorkDefinitionCriteriaDetails-item-patch-request"
    }
}

Nested Schema : costScenarios-WorkDefinitionCriteriaDetails-item-patch-request

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "CategoryId":{
            "type":"integer",
            "description":"Uniquely identifies the item category for which the overhead rates are displayed.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":"18"
            }
        },
        "ItemNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"Indicates the unique name of the selected item to be rolled up within the scenario.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"Indicates the unique identifier of the selected item to be rolled up within the scenario.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":"18"
            }
        },
        "CategoryName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the item category where items would be rolled up within the scenario.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CategorySetName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the item catalog.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CategorySetId":{
            "type":"integer",
            "description":"Unique identifier for item catalog.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        }
    }
}

Back to Top

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.

Body ()

Root Schema : costScenarios-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "EventStatusCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the status of the scenario event. Valid values are NOT_STARTED, PROCESSING, SUCCESS, WARNING, ERROR, CANCELED.",
            "nullable":false,
            "readOnly":true,
            "default":"SUCCESS",
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Indicates the date and time of the creation of the row.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EndTime":{
            "type":"string",
            "description":"Indicates the end time of the scenario event.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "CostOrgId":{
            "type":"integer",
            "description":"Value that uniquely identifies the cost organization.",
            "format":"int64",
            "nullable":true,
            "default":"-1",
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CompletedCount":{
            "type":"integer",
            "description":"Indicates the total count of rows successfully completed for the scenario event.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "PrimaryBookFlag":{
            "maxLength":"255",
            "type":"boolean",
            "description":"Identifies if the cost book has been associated with primary or secondary ledger or whetehr it is a ledger less book.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CostBookDescription":{
            "title":"Description",
            "maxLength":"240",
            "type":"string",
            "description":"Description of the cost book.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "StatusCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the status of the scenario.",
            "nullable":false,
            "default":"NEW",
            "x-queryable":true
        },
        "AssignmentSetId":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "RollupGroupDescription":{
            "maxLength":"240",
            "type":"string",
            "description":"Indicates the cost rollup group description. This attribute is only applicable for cost scenarios enabled for supply chain cost rollup.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RollupGroupName":{
            "maxLength":"80",
            "type":"string",
            "description":"Indicates the cost rollup group name. This attribute is only applicable for cost scenarios enabled for supply chain cost rollup.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "TransferCostRuleSetId":{
            "type":"integer",
            "description":"Primary key that uniquely identifies the transfer charge rule set. This attribute is only applicable for cost scenarios enabled for supply chain cost rollup.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "WorkDefinitionCriteriaDetails":{
            "title":"Work Definition Criteria Details",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/costScenarios-WorkDefinitionCriteriaDetails-item-response"
            }
        },
        "ScenarioEventDate":{
            "type":"string",
            "description":"Indicates the date and time in which the event occurred.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "WorkDefName":{
            "maxLength":"255",
            "type":"string",
            "description":"Indicates the name of the work definition.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "RollupGroupId":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":true,
            "default":"-1",
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "OrganizationContext":{
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RuleSetName":{
            "maxLength":"80",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CostOrgCode":{
            "maxLength":"150",
            "type":"string",
            "description":"Code that identifies cost organization associated with the cost scenario.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RefreshWdFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "default":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"Indicates the user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ScenarioId":{
            "type":"integer",
            "description":"Surrogate key and unique identifier for each cost scenario.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"Indicates the user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ScenarioEventNumber":{
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the user defined event number for scenario events. Value is defaulted based on the event type as follows:\nCREATE\nBUILD-1\nBUILD-2\nROLLUP-1\nROLLUP-2\nPUBLISH-1\nPUBLISH-2 and so on.",
            "nullable":true,
            "readOnly":true,
            "default":"CREATE",
            "x-queryable":true
        },
        "Comments":{
            "maxLength":"1000",
            "type":"string",
            "description":"Indicates the detailed information or comments about the cost scenario.",
            "nullable":true,
            "x-queryable":true
        },
        "StartTime":{
            "type":"string",
            "description":"Indicates the start time of the scenario event.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "StateCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the state of the scenario.",
            "nullable":false,
            "default":"NEW",
            "x-queryable":true
        },
        "SupplyChainRollupFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the cost scenario is enabled for supply chain cost rollup.",
            "nullable":false,
            "default":false,
            "x-queryable":false
        },
        "ReasonCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the reason code of why the scenario became modified.",
            "nullable":true,
            "x-queryable":true
        },
        "AssignmentSetName":{
            "maxLength":"34",
            "type":"string",
            "description":"Indicates the name of the sourcing assignment set. This attribute is only applicable for cost scenarios enabled for supply chain cost rollup.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ScenarioNumber":{
            "maxLength":"30",
            "type":"string",
            "description":"User defined number to identify the cost scenario.",
            "nullable":false,
            "x-queryable":true
        },
        "TotalCount":{
            "type":"integer",
            "description":"Indicates the total count of rows processed for the scenario event.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "PeriodicAverageFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if the Cost Book is a periodic average cost-enabled cost book.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RollupScope":{
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the scope of the data to roll up.",
            "nullable":false,
            "default":"ALL_ITEMS",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CostBookCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Code that identifies the cost book associated with the cost scenario.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "ScenarioEventType":{
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the type of scenario event. Valid values are CREATE, BUILD, ROLLUP, PUBLISH.",
            "nullable":false,
            "readOnly":true,
            "default":"CREATE",
            "x-queryable":true
        },
        "SingleLevelRollupFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates that only the first level of the item structure for the selected items will be rolled up.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "FailedCount":{
            "type":"integer",
            "description":"Indicates the total count of rows failed for the scenario event.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "ExplosionBasis":{
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the explosion basis to be used for work definition explosion in the scenario.",
            "nullable":false,
            "default":"TOP_DOWN",
            "x-queryable":true
        },
        "PeriodName":{
            "maxLength":"15",
            "type":"string",
            "description":"Indicates the period for periodic average cost book based scenarios.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "ExplosionSequence":{
            "maxLength":"30",
            "type":"string",
            "description":"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:\nWD Name - Costing Priority - Planning Priority (NCP)\nWD Name - Planning Priority - Costing Priority (NPC)\nCosting Priority - Planning Priority - WD Name (CPN)\nCosting Priority - WD Name - Planning Priority (CNP)\nPlanning Priority - Costing Priority - WD Name (PCN)\nPlanning Priority - WD Name - Costing Priority (PNC).",
            "nullable":false,
            "default":"PCN",
            "x-queryable":true
        },
        "WorkDefinitionNameId":{
            "title":"Work Definition",
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CostOrgName":{
            "maxLength":"240",
            "type":"string",
            "description":"Name of the cost organization associated with the cost scenario.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "EffectiveStartDate":{
            "type":"string",
            "description":"Indicates the date for which the scenario becomes effective.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "ScenarioType":{
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the type of the scenario.",
            "nullable":false,
            "readOnly":true,
            "default":"STANDARD",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Indicates the date and time of the last update of the row.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CostBookId":{
            "type":"integer",
            "description":"Indicates the accounting cost book associated with the cost scenario.",
            "format":"int64",
            "nullable":true,
            "default":"-1",
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        }
    }
}

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

• Array of: object costScenarios-WorkDefinitionCriteriaDetails-item-response

{
    "title":"Work Definition Criteria Details",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/costScenarios-WorkDefinitionCriteriaDetails-item-response"
    }
}

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 : costScenarios-WorkDefinitionCriteriaDetails-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "CategoryId":{
            "type":"integer",
            "description":"Uniquely identifies the item category for which the overhead rates are displayed.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":"18"
            },
            "x-queryable":true
        },
        "ItemNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"Indicates the unique name of the selected item to be rolled up within the scenario.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "WdCriterionDetailId":{
            "type":"integer",
            "description":"Surrogate key and unique identifier for criteria detail.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "CategorySetDescription":{
            "maxLength":"255",
            "type":"string",
            "description":"Description of the item catalog.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"Indicates the unique identifier of the selected item to be rolled up within the scenario.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":"18"
            },
            "x-queryable":true
        },
        "CategoryName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the item category where items would be rolled up within the scenario.",
            "nullable":true,
            "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"
            }
        },
        "CategoryDescription":{
            "maxLength":"255",
            "type":"string",
            "description":"Description of the item category where items would be rolled up within the scenario.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CategorySetName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the item catalog.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ItemDescription":{
            "maxLength":"255",
            "type":"string",
            "description":"Description of the selected item to be rolled up within the scenario.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CategorySetId":{
            "type":"integer",
            "description":"Unique identifier for item catalog.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        }
    }
}

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

Links

WorkDefinitionCriteriaDetails

Operation: /fscmRestApi/resources/11.13.18.05/costScenarios/{costScenariosUniqID}/child/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.

Back to Top