Jump to

• Request
• Response

Gets all the scenarios to review the exceptions

get

/fscmRestApi/resources/11.13.18.05/costScenarioExceptions

Request

Query Parameters

• 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
• finder: string
  Used as a predefined finder to search the collection.
  
  Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables
  
  

  • PrimaryKey Finds a scenario with the specified primary key.
    Finder Variables
    • ScenarioId; integer; Unique identifier for a scenario.
  • findByCostOrgCostBook Finds exceptions for a scenario with specified cost organization and cost book.
    Finder Variables
    • bindCostBookCode; string; Unique identifier to search a scenario with its cost book code.
    • bindCostOrgName; string; Unique identifier to search a scenario with its cost organization name.
  • findByScenarioNumber Finds exceptions by the specified scenario number.
    Finder Variables
    • bindScenarioNumber; string; Unique identifier to search for a scenario.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• 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
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • AssignmentSetName; string; Indicates the name of the sourcing assignment set. This attribute is only applicable for cost scenarios enabled for supply chain cost rollup.
  • CostBookCode; string; Value that indicates the accounting cost book code of the cost scenario.
  • CostBookDescription; string; Identifies the cost book description associated with the selected cost book.
  • CostBookId; integer; Unique identifier for the cost book.
  • CostOrgCode; string; Indicates the cost organization code.
  • CostOrgId; integer; Unique identifier for the cost organization.
  • CostOrgName; string; Name of the cost organization.
  • EffectiveStartDate; string; Indicates the effective date of the cost scenario.
  • RollupGroupDescription; string; Value that indicates the supply chain rollup group that the cost scenario is created for.
  • RollupGroupName; string; Value that indicates the supply chain rollup group name that the cost scenario is created for.
  • RollupScope; string; Indicates the rollup scope of the cost scenario.
  • ScenarioId; integer; Unique identifier for the cost scenario.
  • ScenarioLatestEventDate; string; Indicates the completion date of the most recent activity in the cost scenario.
  • ScenarioNumber; string; User-entered name for the cost scenario.
  • ScenarioRollupscopeMeaning; string; Meaning of the rollup scope of the cost scenario.
  • ScenarioStateMeaning; string; Meaning of the state of the cost scenario.
  • ScenarioStatusMeaning; string; Meaning of the status of the cost scenario.
  • ScenarioType; string; Value that indicates the type of the cost scenario.
  • ScenarioTypeMeaning; string; Value that indicates the type of the cost scenario.
  • StateCode; string; Value that indicates the state of the cost scenario.
  • StatusCode; string; Value that indicates the status of the cost scenario.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

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.

There's no request body for this operation.

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

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/costScenarioExceptions-item-response"
            }
        }
    },
    "x-hints":{
        "subgroup":"InventoryManagement",
        "usage":"BusinessObject",
        "group":"SCM"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object costScenarioExceptions-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/costScenarioExceptions-item-response"
    }
}

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 : costScenarioExceptions-item-response

Type: object

Show Source

• 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.
• EffectiveStartDate: string (date)
  Read Only: true

  Indicates the effective date of the cost scenario.
• 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.
• RollupScope: string
  Read Only: true

  Maximum Length: 30

  Indicates the rollup scope of the cost scenario.
• 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.
• ScenarioLatestEventDate: string (date)
  Read Only: true

  Indicates the completion date of the most recent activity in the cost scenario.
• ScenarioNumber: string
  Read Only: true

  Maximum Length: 30

  User-entered name for the cost scenario.
• ScenarioRollupscopeMeaning: string
  Read Only: true

  Maximum Length: 80

  Meaning of the rollup scope of the cost scenario.
• ScenarioStateMeaning: string
  Read Only: true

  Maximum Length: 80

  Meaning of the state of the cost scenario.
• ScenarioStatusMeaning: string
  Read Only: true

  Maximum Length: 80

  Meaning of the status of the cost scenario.
• ScenarioType: string
  Read Only: true

  Maximum Length: 30

  Default Value: STANDARD

  Value that indicates the type of the cost scenario.
• ScenarioTypeMeaning: string
  Read Only: true

  Maximum Length: 80

  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.

{
    "type":"object",
    "properties":{
        "ScenarioTypeMeaning":{
            "maxLength":80,
            "type":"string",
            "description":"Value that indicates the type of the cost scenario.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ScenarioId":{
            "type":"integer",
            "description":"Unique identifier for the cost scenario.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "StateCode":{
            "maxLength":30,
            "type":"string",
            "description":"Value that indicates the state of the cost scenario.",
            "nullable":false,
            "readOnly":true,
            "default":"NEW",
            "x-queryable":true
        },
        "ScenarioStateMeaning":{
            "maxLength":80,
            "type":"string",
            "description":"Meaning of the state of the cost scenario.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CostOrgId":{
            "type":"integer",
            "description":"Unique identifier for the cost organization.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "default":-1,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ScenarioEventMessages":{
            "title":"Scenario Event Messages",
            "type":"array",
            "description":"Summary of exceptions for a specific scenario.",
            "items":{
                "$ref":"#/components/schemas/costScenarioExceptions-ScenarioEventMessages-item-response"
            }
        },
        "CostBookDescription":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"Identifies the cost book description associated with the selected cost book.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StatusCode":{
            "maxLength":30,
            "type":"string",
            "description":"Value that indicates the status of the cost scenario.",
            "nullable":false,
            "readOnly":true,
            "default":"NEW",
            "x-queryable":true
        },
        "AssignmentSetId":{
            "type":"integer",
            "description":"Indicates the name of the sourcing assignment set. This attribute is only applicable for cost scenarios enabled for supply chain cost rollup.",
            "format":"int64",
            "nullable":true,
            "readOnly":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":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RollupGroupName":{
            "maxLength":80,
            "type":"string",
            "description":"Value that indicates the supply chain rollup group name that the cost scenario is created for.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RollupGroupDescription":{
            "maxLength":240,
            "type":"string",
            "description":"Value that indicates the supply chain rollup group that the cost scenario is created for.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ScenarioNumber":{
            "maxLength":30,
            "type":"string",
            "description":"User-entered name for the cost scenario.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ScenarioStatusMeaning":{
            "maxLength":80,
            "type":"string",
            "description":"Meaning of the status of the cost scenario.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RollupScope":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates the rollup scope of the cost scenario.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CostBookCode":{
            "maxLength":30,
            "type":"string",
            "description":"Value that indicates the accounting cost book code of the cost scenario.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ScenarioRollupscopeMeaning":{
            "maxLength":80,
            "type":"string",
            "description":"Meaning of the rollup scope of the cost scenario.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CostOrgName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the cost organization.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CostOrgCode":{
            "maxLength":150,
            "type":"string",
            "description":"Indicates the cost organization code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EffectiveStartDate":{
            "type":"string",
            "description":"Indicates the effective date of the cost scenario.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ScenarioType":{
            "maxLength":30,
            "type":"string",
            "description":"Value that indicates the type of the cost scenario.",
            "nullable":false,
            "readOnly":true,
            "default":"STANDARD",
            "x-queryable":true
        },
        "ScenarioLatestEventDate":{
            "type":"string",
            "description":"Indicates the completion date of the most recent activity in the cost scenario.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CostBookId":{
            "type":"integer",
            "description":"Unique identifier for the cost book.",
            "format":"int64",
            "nullable":true,
            "readOnly":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 : Scenario Event Messages

Type: array

Title: Scenario Event Messages

Summary of exceptions for a specific scenario.

Show Source

• Array of: object costScenarioExceptions-ScenarioEventMessages-item-response

{
    "title":"Scenario Event Messages",
    "type":"array",
    "description":"Summary of exceptions for a specific scenario.",
    "items":{
        "$ref":"#/components/schemas/costScenarioExceptions-ScenarioEventMessages-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 : costScenarioExceptions-ScenarioEventMessages-item-response

Type: object

Show Source

• DownloadErrorsCsv: string (byte)
  Read Only: true

  Downloads the .csv file that contains all errors of a specific message.
• 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.
• ScenarioEventTypeCode: string
  Read Only: true

  Maximum Length: 30

  Lookup code of the source of the message reported for the scenario event.
• ScenarioId: integer (int64)
  Indicates the scenario for which the events are created.

{
    "type":"object",
    "properties":{
        "ScenarioEventTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Lookup code of the source of the message reported for the scenario event.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DownloadErrorsCsv":{
            "type":"string",
            "description":"Downloads the .csv file that contains all errors of a specific message.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ScenarioId":{
            "type":"integer",
            "description":"Indicates the scenario for which the events are created.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ScenarioEventNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates the number of the scenario event.",
            "nullable":true,
            "x-queryable":true
        },
        "MessageSource":{
            "maxLength":80,
            "type":"string",
            "description":"Indicates the source of the message reported for the scenario event.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MessageText":{
            "maxLength":1000,
            "type":"string",
            "description":"Indicates the text of the message in the language of the user submitting the process that generates the scenario event messages.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EventMessageDetails":{
            "title":"Scenario Event Message Details",
            "type":"array",
            "description":"Details of a specific message in the scenario exceptions.",
            "items":{
                "$ref":"#/components/schemas/costScenarioExceptions-ScenarioEventMessages-EventMessageDetails-item-response"
            }
        },
        "ErrorCount":{
            "type":"number",
            "description":"Indicates the number of errors for the specific message.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MessageTypeDescription":{
            "maxLength":80,
            "type":"string",
            "description":"Indicates the description of the type of the message reported for the scenario event.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MessageName":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates the name of the message reported for the scenario event.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MessageDetails":{
            "maxLength":4000,
            "type":"string",
            "description":"Indicates the message details.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ScenarioEventId":{
            "type":"integer",
            "description":"Indicates the reference of the cost planning scenario event.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "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"
            }
        },
        "RowCount":{
            "type":"integer",
            "description":"Indicates the number of rows affected by the message.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "MessageType":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates the type of message reported for the scenario event.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Scenario Event Message Details

Type: array

Title: Scenario Event Message Details

Details of a specific message in the scenario exceptions.

Show Source

• Array of: object costScenarioExceptions-ScenarioEventMessages-EventMessageDetails-item-response

{
    "title":"Scenario Event Message Details",
    "type":"array",
    "description":"Details of a specific message in the scenario exceptions.",
    "items":{
        "$ref":"#/components/schemas/costScenarioExceptions-ScenarioEventMessages-EventMessageDetails-item-response"
    }
}

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 : costScenarioExceptions-ScenarioEventMessages-EventMessageDetails-item-response

Type: object

Show Source

• 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
• CostProfileCode: string
  Read Only: true

  Maximum Length: 240

  Unique cost profile code.
• 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.
• RollupHeaderLevel: string
  Read Only: true

  Maximum Length: 240

  Indicates the level at which the cost rollup should pick up the rollup header for processing.
• 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.

{
    "type":"object",
    "properties":{
        "PrimaryProduct":{
            "maxLength":240,
            "type":"string",
            "description":"Indicates if the item is a primary product.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemDescription":{
            "maxLength":240,
            "type":"string",
            "description":"Description of the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CostType":{
            "maxLength":240,
            "type":"string",
            "description":"Indicates the cost type. This can be either a STANDARD or a BUY cost.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MessageName":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates the name of the message reported for the scenario event.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RollupHeaderLevel":{
            "maxLength":240,
            "type":"string",
            "description":"Indicates the level at which the cost rollup should pick up the rollup header for processing.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FromUOMCode":{
            "maxLength":240,
            "type":"string",
            "description":"Indicates the UOM code used for UOM conversion-factor calculations.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Plant":{
            "maxLength":240,
            "type":"string",
            "description":"Indicates the plant of the item or resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemCategory":{
            "maxLength":240,
            "type":"string",
            "description":"Indicates the category of the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemNumber":{
            "maxLength":240,
            "type":"string",
            "description":"Unique item identifier",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceOrganization":{
            "maxLength":240,
            "type":"string",
            "description":"Indicates the source organization of the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IncludeInRollup":{
            "maxLength":240,
            "type":"string",
            "description":"Indicate whether an item is included in the cost rollup.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkDefinition":{
            "maxLength":240,
            "type":"string",
            "description":"Indicates the work definition name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplyType":{
            "maxLength":240,
            "type":"string",
            "description":"Indicates the supply type of the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ResourceClass":{
            "maxLength":240,
            "type":"string",
            "description":"Indicates the class to which this resource belongs.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CostingEnabled":{
            "maxLength":240,
            "type":"string",
            "description":"Indicates if the cost is enabled for costing",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CostOrganization":{
            "maxLength":240,
            "type":"string",
            "description":"Indicates the cost organization name of the scenario",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Path":{
            "maxLength":240,
            "type":"string",
            "description":"Identifies the path of the circular reference.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceCode":{
            "maxLength":240,
            "type":"string",
            "description":"Code that represents the user key to the resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CostProfileCode":{
            "maxLength":240,
            "type":"string",
            "description":"Unique cost profile code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SegmentName":{
            "maxLength":240,
            "type":"string",
            "description":"Indicates the segment name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OperationName":{
            "maxLength":240,
            "type":"string",
            "description":"Indicates the name of the work definition operation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceType":{
            "maxLength":240,
            "type":"string",
            "description":"Indicates the type of resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SourcingRuleName":{
            "maxLength":240,
            "type":"string",
            "description":"Indicates the sourcing rule name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubassemblyPlant":{
            "maxLength":240,
            "type":"string",
            "description":"Indicates the plant of the subassembly component.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ScenarioEventId":{
            "type":"integer",
            "description":"Indicates the reference of the cost planning scenario event.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OperationDescription":{
            "maxLength":240,
            "type":"string",
            "description":"Indicates the description of the work definition operation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ToUOMCode":{
            "maxLength":240,
            "type":"string",
            "description":"Indicates the UOM code used for UOM conversion-factor calculations.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CostBook":{
            "maxLength":240,
            "type":"string",
            "description":"Unique code for a cost book named to indicate the purpose of the cost book.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AllocationPercent":{
            "maxLength":240,
            "type":"string",
            "description":"Percent of supply allocated to this source.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubassemblyComponent":{
            "maxLength":240,
            "type":"string",
            "description":"Indicates the item number of the subassembly component.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ScenarioEventMessageId":{
            "type":"integer",
            "description":"Indicates the surrogate identifier for the scenario event messages.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LowerLevelError":{
            "maxLength":240,
            "type":"string",
            "description":"Indicates if the message has a lower level error.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Automatic":{
            "maxLength":240,
            "type":"string",
            "description":"Indicates if the item is automatic.",
            "nullable":true,
            "readOnly":true,
            "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"
    }
}

Back to Top