REST API for Oracle Fusion Cloud SCM

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

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

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

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

Maximum Length: 30
CostBookDescription: string

Title: Description

Maximum Length: 240
CostBookId: integer (int64)

Default Value: -1
CostOrgCode: string

Maximum Length: 150
CostOrgId: integer (int64)

Default Value: -1
CostOrgName: string

Maximum Length: 240
EffectiveStartDate: string (date)
ExplosionBasis: string

Maximum Length: 30

Default Value: TOP_DOWN
ExplosionSequence: string

Title: Explosion Basis

Maximum Length: 30

Default Value: PCN
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
ReasonCode: string

Maximum Length: 30
RefreshWdFlag: boolean

Maximum Length: 1

Default Value: true
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
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
StateCode: string

Maximum Length: 30

Default Value: NEW
StatusCode: string

Maximum Length: 30

Default Value: NEW
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

Item number, resource code, catalog name, and category name specified in a cost scenario.
WorkDefinitionNameId: integer (int64)

Title: Work Definition
WorkDefName: string

Title: Work Definition

Maximum Length: 80

{
    "type":"object",
    "properties":{
        "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
            }
        },
        "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"
            }
        },
        "Comments":{
            "maxLength":1000,
            "type":"string",
            "nullable":true
        },
        "CostBookCode":{
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "CostBookDescription":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CostBookId":{
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "default":-1,
            "x-hints":{
                "precision":18
            }
        },
        "CostOrgCode":{
            "maxLength":150,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CostOrgId":{
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "default":-1,
            "x-hints":{
                "precision":18
            }
        },
        "CostOrgName":{
            "maxLength":240,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "EffectiveStartDate":{
            "type":"string",
            "format":"date",
            "nullable":false
        },
        "ExplosionBasis":{
            "maxLength":30,
            "type":"string",
            "nullable":false,
            "default":"TOP_DOWN"
        },
        "ExplosionSequence":{
            "title":"Explosion Basis",
            "maxLength":30,
            "type":"string",
            "nullable":false,
            "default":"PCN"
        },
        "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
        },
        "PeriodName":{
            "maxLength":15,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "ReasonCode":{
            "maxLength":30,
            "type":"string",
            "nullable":true
        },
        "RefreshWdFlag":{
            "maxLength":1,
            "type":"boolean",
            "nullable":true,
            "default":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "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
            }
        },
        "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"
            }
        },
        "RollupScope":{
            "maxLength":30,
            "type":"string",
            "nullable":false,
            "default":"ALL_ITEMS",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "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"
            }
        },
        "SingleLevelRollupFlag":{
            "maxLength":1,
            "type":"boolean",
            "nullable":true,
            "default":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "StateCode":{
            "maxLength":30,
            "type":"string",
            "nullable":false,
            "default":"NEW"
        },
        "StatusCode":{
            "maxLength":30,
            "type":"string",
            "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
        },
        "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
            }
        },
        "WorkDefName":{
            "title":"Work Definition",
            "maxLength":80,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "WorkDefinitionCriteriaDetails":{
            "title":"Work Definition Criteria Details",
            "type":"array",
            "description":"Item number, resource code, catalog name, and category name specified in a cost scenario.",
            "items":{
                "$ref":"#/components/schemas/costScenarios-WorkDefinitionCriteriaDetails-item-patch-request"
            }
        },
        "WorkDefinitionNameId":{
            "title":"Work Definition",
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        }
    }
}

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

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

{
    "title":"Work Definition Criteria Details",
    "type":"array",
    "description":"Item number, resource code, catalog name, and category name specified in a 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)

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.
CategoryName: string

Maximum Length: 2400

Indicates the name of the item category used to set the scope of the cost planning scenario.
CategorySetId: integer (int64)

Indicates the item cost category set to be used for identifying the work definitions used for work definition explosion in a cost planning scenario.
CategorySetName: string

Maximum Length: 30

Indicates the set to which the category is mapped.
InventoryItemId: integer (int64)

Title: Item

Indicates the item identifier used to identify the work definitions used for rolling up the cost in a cost planning scenario.
ItemNumber: string

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.
ResourceCode: string

Code for the resource used to set the scope of a type of configured item cost scenario.
ResourceId: integer (int64)

Indicates the resource to be used for identifying the work definitions used for rolling up cost in a cost planning scenario.
ResourceName: string

Name of the resource used to set the scope of a type of configured item cost scenario.

{
    "type":"object",
    "properties":{
        "CategoryId":{
            "title":"Category Name",
            "type":"integer",
            "description":"Indicates the item category identifier used to identify the work definitions to be used for cost rollup for a cost planning scenario.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18
            }
        },
        "CategoryName":{
            "maxLength":2400,
            "type":"string",
            "description":"Indicates the name of the item category used to set the scope of the cost planning scenario.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CategorySetId":{
            "type":"integer",
            "description":"Indicates the item cost category set to be used for identifying the work definitions used for work definition explosion in a cost planning scenario.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "CategorySetName":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates the set to which the category is mapped.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            }
        },
        "InventoryItemId":{
            "title":"Item",
            "type":"integer",
            "description":"Indicates the item identifier used to identify the work definitions used for rolling up the cost in a cost planning scenario.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18
            }
        },
        "ItemNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Indicates the identifier of the item used to identify the work definitions used for rolling up the cost in a cost planning scenario.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ResourceCode":{
            "type":"string",
            "description":"Code for the resource used to set the scope of a type of configured item cost scenario.",
            "nullable":true
        },
        "ResourceId":{
            "type":"integer",
            "description":"Indicates the resource to be used for identifying the work definitions used for rolling up cost in a cost planning scenario.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18
            }
        },
        "ResourceName":{
            "type":"string",
            "description":"Name of the resource used to set the scope of a type of configured item cost scenario.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        }
    }
}

Response

Supported Media Types

application/json

Default Response

The following table describes the default response for this task.

Headers

Metadata-Context:

If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
REST-Framework-Version:

The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Root Schema : 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
CompletedCount: integer (int32)
CostBookCode: string

Maximum Length: 30
CostBookDescription: string

Title: Description

Maximum Length: 240
CostBookId: integer (int64)

Default Value: -1
CostOrgCode: string

Maximum Length: 150
CostOrgId: integer (int64)

Default Value: -1
CostOrgName: string

Maximum Length: 240
CreatedBy: string

Read Only: true

Maximum Length: 64
CreationDate: string (date-time)

Read Only: true
EffectiveStartDate: string (date)
EndTime: string (date-time)
EventStatusCode: string

Read Only: true

Maximum Length: 30

Default Value: SUCCESS
ExplosionBasis: string

Maximum Length: 30

Default Value: TOP_DOWN
ExplosionSequence: string

Title: Explosion Basis

Maximum Length: 30

Default Value: PCN
FailedCount: integer (int32)
LastUpdateDate: string (date-time)

Read Only: true
LastUpdatedBy: string

Read Only: true

Maximum Length: 64
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
PeriodName: string

Maximum Length: 15
PrimaryBookFlag: boolean

Title: Primary Book

Read Only: true

Maximum Length: 1
ReasonCode: string

Maximum Length: 30
RefreshWdFlag: boolean

Maximum Length: 1

Default Value: true
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
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)
ScenarioEventNumber: string

Read Only: true

Maximum Length: 30

Default Value: CREATE
ScenarioEventType: string

Read Only: true

Maximum Length: 30

Default Value: CREATE
ScenarioId: integer (int64)

Read Only: true
ScenarioNumber: string

Maximum Length: 30
ScenarioType: string

Read Only: true

Maximum Length: 30

Default Value: STANDARD
SingleLevelRollupFlag: boolean

Maximum Length: 1

Default Value: false
StartTime: string (date-time)
StateCode: string

Maximum Length: 30

Default Value: NEW
StatusCode: string

Maximum Length: 30

Default Value: NEW
SupplyChainRollupFlag: boolean

Maximum Length: 1

Default Value: false

Indicates whether the cost scenario is enabled for supply chain cost rollup.
TotalCount: integer (int32)
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

Item number, resource code, catalog name, and category name specified in a cost scenario.
WorkDefinitionNameId: integer (int64)

Title: Work Definition
WorkDefName: string

Title: Work Definition

Maximum Length: 80

{
    "type":"object",
    "properties":{
        "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
            }
        },
        "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
        },
        "Comments":{
            "maxLength":1000,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "CompletedCount":{
            "type":"integer",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "CostBookCode":{
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "CostBookDescription":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CostBookId":{
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "default":-1,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CostOrgCode":{
            "maxLength":150,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CostOrgId":{
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "default":-1,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CostOrgName":{
            "maxLength":240,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EffectiveStartDate":{
            "type":"string",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "EndTime":{
            "type":"string",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "EventStatusCode":{
            "maxLength":30,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "default":"SUCCESS",
            "x-queryable":true
        },
        "ExplosionBasis":{
            "maxLength":30,
            "type":"string",
            "nullable":false,
            "default":"TOP_DOWN",
            "x-queryable":true
        },
        "ExplosionSequence":{
            "title":"Explosion Basis",
            "maxLength":30,
            "type":"string",
            "nullable":false,
            "default":"PCN",
            "x-queryable":true
        },
        "FailedCount":{
            "type":"integer",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "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
        },
        "PeriodName":{
            "maxLength":15,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "PeriodicAverageFlag":{
            "maxLength":1,
            "type":"boolean",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryBookFlag":{
            "title":"Primary Book",
            "maxLength":1,
            "type":"boolean",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ReasonCode":{
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "RefreshWdFlag":{
            "maxLength":1,
            "type":"boolean",
            "nullable":true,
            "default":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "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
        },
        "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
        },
        "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
        },
        "RollupScope":{
            "maxLength":30,
            "type":"string",
            "nullable":false,
            "default":"ALL_ITEMS",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "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
        },
        "ScenarioEventDate":{
            "type":"string",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "ScenarioEventNumber":{
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "default":"CREATE",
            "x-queryable":true
        },
        "ScenarioEventType":{
            "maxLength":30,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "default":"CREATE",
            "x-queryable":true
        },
        "ScenarioId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ScenarioNumber":{
            "maxLength":30,
            "type":"string",
            "nullable":false,
            "x-queryable":true
        },
        "ScenarioType":{
            "maxLength":30,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "default":"STANDARD",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SingleLevelRollupFlag":{
            "maxLength":1,
            "type":"boolean",
            "nullable":true,
            "default":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "StartTime":{
            "type":"string",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "StateCode":{
            "maxLength":30,
            "type":"string",
            "nullable":false,
            "default":"NEW",
            "x-queryable":true
        },
        "StatusCode":{
            "maxLength":30,
            "type":"string",
            "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
        },
        "TotalCount":{
            "type":"integer",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            },
            "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
            }
        },
        "WorkDefName":{
            "title":"Work Definition",
            "maxLength":80,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "WorkDefinitionCriteriaDetails":{
            "title":"Work Definition Criteria Details",
            "type":"array",
            "description":"Item number, resource code, catalog name, and category name specified in a cost scenario.",
            "items":{
                "$ref":"#/components/schemas/costScenarios-WorkDefinitionCriteriaDetails-item-response"
            }
        },
        "WorkDefinitionNameId":{
            "title":"Work Definition",
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

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

Array of: object costScenarios-WorkDefinitionCriteriaDetails-item-response

{
    "title":"Work Definition Criteria Details",
    "type":"array",
    "description":"Item number, resource code, catalog name, and category name specified in a 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: 240

Indicates the item category used to set the scope of the cost planning scenario.
CategoryId: integer (int64)

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.
CategoryName: string

Maximum Length: 2400

Indicates the name of the item category used to set the scope of the cost planning scenario.
CategorySetDescription: string

Read Only: true

Maximum Length: 240

Indicates the catalog to which the category is assigned.
CategorySetId: integer (int64)

Indicates the item cost category set to be used for identifying the work definitions used for work definition explosion in a cost planning scenario.
CategorySetName: string

Maximum Length: 30

Indicates the set to which the category is mapped.
InventoryItemId: integer (int64)

Title: Item

Indicates the item identifier used to identify the work definitions used for rolling up the cost in a cost planning scenario.
ItemDescription: string

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.
ItemNumber: string

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

Title: Links

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

Code for the resource used to set the scope of a type of configured item cost scenario.
ResourceId: integer (int64)

Indicates the resource to be used for identifying the work definitions used for rolling up cost in a cost planning scenario.
ResourceName: string

Name of the resource used to set the scope of a type of configured item cost scenario.
ResourceType: string

Title: Type

Read Only: true

Maximum Length: 30

Contains the resource type.
WdCriterionDetailId: integer (int64)

Read Only: true

Indicates the unique identifier for criteria detail.

{
    "type":"object",
    "properties":{
        "CategoryDescription":{
            "maxLength":240,
            "type":"string",
            "description":"Indicates the item category used to set the scope of the cost planning scenario.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CategoryId":{
            "title":"Category Name",
            "type":"integer",
            "description":"Indicates the item category identifier used to identify the work definitions to be used for cost rollup for a cost planning scenario.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18
            },
            "x-queryable":true
        },
        "CategoryName":{
            "maxLength":2400,
            "type":"string",
            "description":"Indicates the name of the item category used to set the scope of the cost planning scenario.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CategorySetDescription":{
            "maxLength":240,
            "type":"string",
            "description":"Indicates the catalog to which the category is assigned.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "CategorySetId":{
            "type":"integer",
            "description":"Indicates the item cost category set to be used for identifying the work definitions used for work definition explosion in a cost planning scenario.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CategorySetName":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates the set to which the category is mapped.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "InventoryItemId":{
            "title":"Item",
            "type":"integer",
            "description":"Indicates the item identifier used to identify the work definitions used for rolling up the cost in a cost planning scenario.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18
            },
            "x-queryable":true
        },
        "ItemDescription":{
            "title":"Item Description",
            "maxLength":240,
            "type":"string",
            "description":"Indicates the description of the item used to identify the work definitions used for rolling up the cost in a cost planning scenario.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Indicates the identifier of the item used to identify the work definitions used for rolling up the cost in a cost planning scenario.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ResourceCode":{
            "type":"string",
            "description":"Code for the resource used to set the scope of a type of configured item cost scenario.",
            "nullable":true,
            "x-queryable":true
        },
        "ResourceId":{
            "type":"integer",
            "description":"Indicates the resource to be used for identifying the work definitions used for rolling up cost in a cost planning scenario.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18
            },
            "x-queryable":true
        },
        "ResourceName":{
            "type":"string",
            "description":"Name of the resource used to set the scope of a type of configured item cost scenario.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ResourceType":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"Contains the resource type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "WdCriterionDetailId":{
            "type":"integer",
            "description":"Indicates the unique identifier for criteria detail.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Links

WorkDefinitionCriteriaDetails

Operation: /fscmRestApi/resources/11.13.18.05/costScenarios/{costScenariosUniqID}/child/WorkDefinitionCriteriaDetails

Parameters:

costScenariosUniqID: $request.path.costScenariosUniqID