Get one singular scenario to review the exceptions
get
/fscmRestApi/resources/11.13.18.05/costScenarioExceptions/{ScenarioId}
Request
Path Parameters
-
ScenarioId(required): integer(int64)
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : costScenarioExceptions-item-response
Type:
Show Source
object
-
AssignmentSetId: integer
(int64)
Read Only:
true
Indicates the name of the sourcing assignment set. This attribute is only applicable for cost scenarios enabled for supply chain cost rollup. -
AssignmentSetName: string
Read Only:
true
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. -
CostBookCode: string
Read Only:
true
Maximum Length:30
Value that indicates the accounting cost book code of the cost scenario. -
CostBookDescription: string
Title:
Description
Read Only:true
Maximum Length:240
Identifies the cost book description associated with the selected cost book. -
CostBookId: integer
(int64)
Read Only:
true
Default Value:-1
Unique identifier for the cost book. -
CostOrgCode: string
Read Only:
true
Maximum Length:150
Indicates the cost organization code. -
CostOrgId: integer
(int64)
Read Only:
true
Default Value:-1
Unique identifier for the cost organization. -
CostOrgName: string
Read Only:
true
Maximum Length:240
Name of the cost organization. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
RollupGroupDescription: string
Read Only:
true
Maximum Length:240
Value that indicates the supply chain rollup group that the cost scenario is created for. -
RollupGroupName: string
Read Only:
true
Maximum Length:80
Value that indicates the supply chain rollup group name that the cost scenario is created for. -
ScenarioEventMessages: array
Scenario Event Messages
Title:
Scenario Event Messages
Summary of exceptions for a specific scenario. -
ScenarioId: integer
(int64)
Read Only:
true
Unique identifier for the cost scenario. -
ScenarioNumber: string
Read Only:
true
Maximum Length:30
User-entered name for the cost scenario. -
ScenarioType: string
Read Only:
true
Maximum Length:30
Default Value:STANDARD
Value that indicates the type of the cost scenario. -
StateCode: string
Read Only:
true
Maximum Length:30
Default Value:NEW
Value that indicates the state of the cost scenario. -
StatusCode: string
Read Only:
true
Maximum Length:30
Default Value:NEW
Value that indicates the status of the cost scenario.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Scenario Event Messages
Type:
array
Title:
Scenario Event Messages
Summary of exceptions for a specific scenario.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : costScenarioExceptions-ScenarioEventMessages-item-response
Type:
Show Source
object
-
ErrorCount: number
Read Only:
true
Indicates the number of errors for the specific message. -
EventMessageDetails: array
Scenario Event Message Details
Title:
Scenario Event Message Details
Details of a specific message in the scenario exceptions. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MessageDetails: string
Read Only:
true
Maximum Length:4000
Indicates the message details. -
MessageName: string
Read Only:
true
Maximum Length:30
Indicates the name of the message reported for the scenario event. -
MessageSource: string
Read Only:
true
Maximum Length:80
Indicates the source of the message reported for the scenario event. -
MessageText: string
Read Only:
true
Maximum Length:1000
Indicates the text of the message in the language of the user submitting the process that generates the scenario event messages. -
MessageType: string
Read Only:
true
Maximum Length:30
Indicates the type of message reported for the scenario event. -
MessageTypeDescription: string
Read Only:
true
Maximum Length:80
Indicates the description of the type of the message reported for the scenario event. -
RowCount: integer
(int64)
Read Only:
true
Indicates the number of rows affected by the message. -
ScenarioEventId: integer
(int64)
Indicates the reference of the cost planning scenario event.
-
ScenarioEventNumber: string
Maximum Length:
30
Indicates the number of the scenario event. -
ScenarioId: integer
(int64)
Indicates the scenario for which the events are created.
Nested Schema : Scenario Event Message Details
Type:
array
Title:
Scenario Event Message Details
Details of a specific message in the scenario exceptions.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : costScenarioExceptions-ScenarioEventMessages-EventMessageDetails-item-response
Type:
Show Source
object
-
AllocationPercent: string
Read Only:
true
Maximum Length:240
Percent of supply allocated to this source. -
Automatic: string
Read Only:
true
Maximum Length:240
Indicates if the item is automatic. -
CostBook: string
Read Only:
true
Maximum Length:240
Unique code for a cost book named to indicate the purpose of the cost book. -
CostingEnabled: string
Read Only:
true
Maximum Length:240
Indicates if the cost is enabled for costing -
CostOrganization: string
Read Only:
true
Maximum Length:240
Indicates the cost organization name of the scenario -
CostType: string
Read Only:
true
Maximum Length:240
Indicates the cost type. This can be either a STANDARD or a BUY cost. -
FromUOMCode: string
Read Only:
true
Maximum Length:240
Indicates the UOM code used for UOM conversion-factor calculations. -
IncludeInRollup: string
Read Only:
true
Maximum Length:240
Indicate whether an item is included in the cost rollup. -
ItemCategory: string
Read Only:
true
Maximum Length:240
Indicates the category of the item. -
ItemDescription: string
Read Only:
true
Maximum Length:240
Description of the item. -
ItemNumber: string
Read Only:
true
Maximum Length:240
Unique item identifier -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LowerLevelError: string
Read Only:
true
Maximum Length:240
Indicates if the message has a lower level error. -
MessageName: string
Read Only:
true
Maximum Length:30
Indicates the name of the message reported for the scenario event. -
OperationDescription: string
Read Only:
true
Maximum Length:240
Indicates the description of the work definition operation. -
OperationName: string
Read Only:
true
Maximum Length:240
Indicates the name of the work definition operation. -
Path: string
Read Only:
true
Maximum Length:240
Identifies the path of the circular reference. -
Plant: string
Read Only:
true
Maximum Length:240
Indicates the plant of the item or resource. -
PrimaryProduct: string
Read Only:
true
Maximum Length:240
Indicates if the item is a primary product. -
ResourceClass: string
Read Only:
true
Maximum Length:240
Indicates the class to which this resource belongs. -
ResourceCode: string
Read Only:
true
Maximum Length:240
Code that represents the user key to the resource. -
ResourceType: string
Read Only:
true
Maximum Length:240
Indicates the type of resource. -
ScenarioEventId: integer
(int64)
Read Only:
true
Indicates the reference of the cost planning scenario event. -
ScenarioEventMessageId: integer
(int64)
Indicates the surrogate identifier for the scenario event messages.
-
SegmentName: string
Read Only:
true
Maximum Length:240
Indicates the segment name. -
SourceOrganization: string
Read Only:
true
Maximum Length:240
Indicates the source organization of the item. -
SourcingRuleName: string
Read Only:
true
Maximum Length:240
Indicates the sourcing rule name. -
SubassemblyComponent: string
Read Only:
true
Maximum Length:240
Indicates the item number of the subassembly component. -
SubassemblyPlant: string
Read Only:
true
Maximum Length:240
Indicates the plant of the subassembly component. -
SupplyType: string
Read Only:
true
Maximum Length:240
Indicates the supply type of the item. -
ToUOMCode: string
Read Only:
true
Maximum Length:240
Indicates the UOM code used for UOM conversion-factor calculations. -
WorkDefinition: string
Read Only:
true
Maximum Length:240
Indicates the work definition name.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- ScenarioEventMessages
-
Operation: /fscmRestApi/resources/11.13.18.05/costScenarioExceptions/{ScenarioId}/child/ScenarioEventMessagesParameters:
- ScenarioId:
$request.path.ScenarioId
Summary of exceptions for a specific scenario. - ScenarioId: