Jump to

• Request
• Response

Get details of all demand exceptions

get

/fscmRestApi/resources/11.13.18.05/demandAndSupplyPlans/{PlanId}/child/DemandExceptions

Request

Path Parameters

• PlanId(required): integer
  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
• 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 the demand exception according to the value that identifies the demand exception.
    Finder Variables
    • ExceptionDetailId; integer; Value that uniquely identifies the demand exception detail associated with the demand exception.
    • PlanId; integer; Value that uniquely identifies the plan associated with the demand exception.
• 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:
  

  • ActionTaken; integer; Contains one of the following values: 1 or 2. If 1, then it indicates that an action is taken to resolve the exception. If 2, then no action is taken. Default value is 2.
  • AvailableLeadTime; number; Number that represents the available lead time of the supply in the exception.
  • Category; string; Category of the demand's item in the exception. The category is derived from the default product hierarchy or any product hierarchy of the item associated in the plan's dimension catalog.
  • ConstrainedDate; string; Value that represents the constrained date of the resource or the supplier capacity in the exception.
  • CurrencyCode; string; Code for the currency of the demand's organization in the exception.
  • Customer; string; Name of the customer in the demand in the exception.
  • CustomerId; integer; Value that uniquely identifies the customer in the exception.
  • CustomerSite; string; Name of the customer site in the demand in the exception.
  • CustomerSiteId; integer; Value that uniquely identifies the customer site in the exception.
  • DaysLate; number; Number that represents the number of days a demand is satisfied late or a supply pegged to a demand is late or number of days a demand is past due. Based on the exception, the days late provides the details.
  • DemandClass; string; Demand class associated with the demand in the exception.
  • DemandId; integer; Value that uniquely identifies the demand in the exception.
  • DemandLineNumber; string; Line number of the demand in the exception.
  • DemandOrderNumber; string; Order number of the demand in the exception.
  • DemandOrderType; string; Type of order of the demand in the exception. For example, the type of demand order could be a sales order or a forecast.
  • DemandQuantity; number; Quantity of the demand in the exception.
  • DemandSatisfiedDate; string; Date in the exception when the demand quantity is completely satisfied.
  • DepartmentId; integer; Value that uniquely identifies the department or the work center of a resource in the exception.
  • Exception; string; Name of an exception.
  • ExceptionDetailId; integer; Value that uniquely identifies the demand exception detail.
  • ExceptionId; integer; Number that uniquely identifies an exception.
  • ExceptionValue; number; Number that represents the value of the delay, or the value of the unplanned portion, or the value of the demand quantity, or a part of the demand quantity in the exception.
  • InventoryItemId; integer; Value that uniquely identifies the demand's item in the exception.
  • Item; string; Name of the item in the demand in the exception.
  • ItemDescription; string; Description of the item in the demand in the exception.
  • LastUpdateDate; string; Date when the exception detail was last updated.
  • LastUpdatedBy; string; Name of the user who last updated the exception detail.
  • MaturityDate; string; Date of maturity of the supply pegged to the demand in the exception.
  • MtqSupplyDate; string; The supply date of the minimum transfer quantity (MTQ) of the supply pegged to the demand in the exception
  • Notes; integer; Contains information created or updated for an exception detail represented as notes.
  • OrderDate; string; Date of the demand in the exception.
  • OrderValue; number; Order value of the demand in the exception.
  • Organization; string; Name of the demand's organization in the exception.
  • OrganizationId; integer; Value that uniquely identifies the demand's organization in the exception.
  • PartialPlannedQuantity; number; Partial planned quantity of the demand in the exception.
  • PeggedQuantity; number; Pegged quantity of the supply to the demand in the exception.
  • PlanId; integer; Value that uniquely identifies the plan in which exception is generated.
  • PlannerCode; string; Name of the planner associated with the demand's item in the exception.
  • PlannerDescription; string; Description of the planner associated with the demand's item in the exception.
  • PlanningAttribute10; string; Value that identifies planning attribute number 10 associated with the demand in the exception in an attribute-based plan.
  • PlanningAttribute11; string; Value that identifies planning attribute number 11 associated with the demand in the exception in an attribute-based plan.
  • PlanningAttribute12; string; Value that identifies planning attribute number 12 associated with the demand in the exception in an attribute-based plan.
  • PlanningAttribute13; string; Value that identifies planning attribute number 13 associated with the demand in the exception in an attribute-based plan.
  • PlanningAttribute14; string; Value that identifies planning attribute number 14 associated with the demand in the exception in an attribute-based plan.
  • PlanningAttribute15; string; Value that identifies planning attribute number 15 associated with the demand in the exception in an attribute-based plan.
  • PlanningAttribute3; string; Value that identifies planning attribute number 3 associated with the demand in the exception in an attribute-based plan.
  • PlanningAttribute4; string; Value that identifies planning attribute number 4 associated with the demand in the exception in an attribute-based plan.
  • PlanningAttribute5; string; Value that identifies planning attribute number 5 associated with the demand in the exception in an attribute-based plan.
  • PlanningAttribute6; string; Value that identifies planning attribute number 6 associated with the demand in the exception in an attribute-based plan.
  • PlanningAttribute7; string; Value that identifies planning attribute number 7 associated with the demand in the exception in an attribute-based plan.
  • PlanningAttribute8; string; Value that identifies planning attribute number 8 associated with the demand in the exception in an attribute-based plan.
  • PlanningAttribute9; string; Value that identifies planning attribute number 9 associated with the demand in the exception in an attribute-based plan.
  • Priority; number; Priority of the demand in the exception.
  • ProjectGroupValue; string; Value that identifies the project group associated with the demand in the exception in an attribute-based plan.
  • ProjectValue; string; Value that identifies the project associated with the demand in the exception in an attribute-based plan.
  • QuantityMismatch; number; Number that represents the unsatisfied quantity of the demand in the exception.
  • QuantitySatisfiedByDemandDate; number; Number that represents the quantity of the demand satisfied by the demand order date in the exception.
  • RequiredLeadTime; number; Number that represents the lead time required by the supply pegged to the demand in the exception.
  • ResourceCode; string; Name of the resource in the demand exception.
  • ResourceId; integer; Value that uniquely identifies the resource in the demand exception.
  • ResourceOrganization; string; Name of the organization of the resource in the demand exception.
  • StartDate; string; Start date in the demand exception. For example, the plan start date in the Late Replenishment for Sales Order exception.
  • Supplier; string; Name of the supplier in the demand exception.
  • SupplierId; integer; Value that uniquely identifies the supplier in the demand exception.
  • SupplierItem; string; Supplier item in the demand exception.
  • SupplierItemDescription; string; Supplier item description in the demand exception.
  • SupplierSite; string; Name of the supplier site in the demand exception.
  • SupplierSiteId; integer; Value that uniquely identifies the supplier site in the demand exception.
  • SupplyDueDate; string; Due date of the supply in the demand exception.
  • SupplyItem; string; Name of the supply's item pegged to the demand in the demand exception.
  • SupplyItemDescription; string; Description of the supply's item pegged to the demand in the demand exception.
  • SupplyLineNumber; string; Line number of the supply in the demand exception.
  • SupplyOrderDemandDueDate; string; Due date of the supply order demand in the demand exception.
  • SupplyOrderNumber; string; Order number of the supply in the demand exception.
  • SupplyOrderType; string; Type of order of the supply in the demand exception. For example, a planned order or a work order.
  • SupplyOrganization; string; Name of the supply organization in the demand exception.
  • SupplyQuantity; number; Number that represents the quantity of the supply in the demand exception.
  • TaskValue; string; Value that identifies the task associated with the demand in the exception in an attribute-based plan.
  • TransactionId; integer; Value that uniquely identifies the supply in the demand exception.
  • WorkCenter; string; Name of the work center of the resource in the demand exception.
• 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:
  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 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 : demandAndSupplyPlans-DemandExceptions

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/demandAndSupplyPlans-DemandExceptions-item-response"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object demandAndSupplyPlans-DemandExceptions-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/demandAndSupplyPlans-DemandExceptions-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 : demandAndSupplyPlans-DemandExceptions-item-response

Type: object

Show Source

• ActionTaken: integer (int64)
  Title: Action Taken

  Read Only: true

  Contains one of the following values: 1 or 2. If 1, then it indicates that an action is taken to resolve the exception. If 2, then no action is taken. Default value is 2.
• AvailableLeadTime: number
  Title: Available Lead Time

  Read Only: true

  Number that represents the available lead time of the supply in the exception.
• Category: string
  Title: Category

  Read Only: true

  Maximum Length: 4000

  Category of the demand's item in the exception. The category is derived from the default product hierarchy or any product hierarchy of the item associated in the plan's dimension catalog.
• ConstrainedDate: string (date)
  Title: Constrained Date

  Read Only: true

  Value that represents the constrained date of the resource or the supplier capacity in the exception.
• CurrencyCode: string
  Title: Currency

  Read Only: true

  Maximum Length: 4000

  Code for the currency of the demand's organization in the exception.
• Customer: string
  Title: Customer

  Read Only: true

  Maximum Length: 4000

  Name of the customer in the demand in the exception.
• CustomerId: integer
  Read Only: true

  Value that uniquely identifies the customer in the exception.
• CustomerSite: string
  Title: Customer Site

  Read Only: true

  Maximum Length: 4000

  Name of the customer site in the demand in the exception.
• CustomerSiteId: integer
  Read Only: true

  Value that uniquely identifies the customer site in the exception.
• DaysLate: number
  Title: Days Late

  Read Only: true

  Number that represents the number of days a demand is satisfied late or a supply pegged to a demand is late or number of days a demand is past due. Based on the exception, the days late provides the details.
• DemandClass: string
  Title: Demand Class

  Read Only: true

  Maximum Length: 4000

  Demand class associated with the demand in the exception.
• DemandId: integer
  Read Only: true

  Value that uniquely identifies the demand in the exception.
• DemandLineNumber: string
  Title: Demand Line Number

  Read Only: true

  Maximum Length: 250

  Line number of the demand in the exception.
• DemandOrderNumber: string
  Title: Demand Order Number

  Read Only: true

  Maximum Length: 4000

  Order number of the demand in the exception.
• DemandOrderType: string
  Title: Demand Order Type

  Read Only: true

  Maximum Length: 4000

  Type of order of the demand in the exception. For example, the type of demand order could be a sales order or a forecast.
• DemandQuantity: number
  Title: Demand Quantity

  Read Only: true

  Quantity of the demand in the exception.
• DemandSatisfiedDate: string (date)
  Title: Demand Satisfied Date

  Read Only: true

  Date in the exception when the demand quantity is completely satisfied.
• DepartmentId: integer
  Read Only: true

  Value that uniquely identifies the department or the work center of a resource in the exception.
• Exception: string
  Title: Exception

  Read Only: true

  Maximum Length: 120

  Name of an exception.
• ExceptionDetailId: integer
  Read Only: true

  Value that uniquely identifies the demand exception detail.
• ExceptionId: integer
  Read Only: true

  Number that uniquely identifies an exception.
• ExceptionValue: number
  Title: Exception Value

  Read Only: true

  Number that represents the value of the delay, or the value of the unplanned portion, or the value of the demand quantity, or a part of the demand quantity in the exception.
• InventoryItemId: integer
  Read Only: true

  Value that uniquely identifies the demand's item in the exception.
• Item: string
  Title: Item

  Read Only: true

  Maximum Length: 4000

  Name of the item in the demand in the exception.
• ItemDescription: string
  Title: Item Description

  Read Only: true

  Maximum Length: 4000

  Description of the item in the demand in the exception.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  Date when the exception detail was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  Name of the user who last updated the exception detail.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MaturityDate: string (date)
  Title: Maturity Date

  Read Only: true

  Date of maturity of the supply pegged to the demand in the exception.
• MtqSupplyDate: string (date)
  Title: MTQ Supply Date

  Read Only: true

  The supply date of the minimum transfer quantity (MTQ) of the supply pegged to the demand in the exception
• Notes: integer (int64)
  Title: Notes

  Read Only: true

  Contains information created or updated for an exception detail represented as notes.
• OrderDate: string (date)
  Title: Order Date

  Read Only: true

  Date of the demand in the exception.
• OrderValue: number
  Title: Order Value

  Read Only: true

  Order value of the demand in the exception.
• Organization: string
  Title: Organization

  Read Only: true

  Maximum Length: 4000

  Name of the demand's organization in the exception.
• OrganizationId: integer
  Read Only: true

  Value that uniquely identifies the demand's organization in the exception.
• PartialPlannedQuantity: number
  Title: Partial Planned Quantity

  Read Only: true

  Partial planned quantity of the demand in the exception.
• PeggedQuantity: number
  Title: Pegged Quantity

  Read Only: true

  Pegged quantity of the supply to the demand in the exception.
• PlanId: integer
  Read Only: true

  Value that uniquely identifies the plan in which exception is generated.
• PlannerCode: string
  Title: Planner

  Read Only: true

  Maximum Length: 4000

  Name of the planner associated with the demand's item in the exception.
• PlannerDescription: string
  Title: Planner Description

  Read Only: true

  Maximum Length: 4000

  Description of the planner associated with the demand's item in the exception.
• PlanningAttribute10: string
  Read Only: true

  Maximum Length: 4000

  Value that identifies planning attribute number 10 associated with the demand in the exception in an attribute-based plan.
• PlanningAttribute11: string
  Read Only: true

  Maximum Length: 4000

  Value that identifies planning attribute number 11 associated with the demand in the exception in an attribute-based plan.
• PlanningAttribute12: string
  Read Only: true

  Maximum Length: 4000

  Value that identifies planning attribute number 12 associated with the demand in the exception in an attribute-based plan.
• PlanningAttribute13: string
  Read Only: true

  Maximum Length: 4000

  Value that identifies planning attribute number 13 associated with the demand in the exception in an attribute-based plan.
• PlanningAttribute14: string
  Read Only: true

  Maximum Length: 4000

  Value that identifies planning attribute number 14 associated with the demand in the exception in an attribute-based plan.
• PlanningAttribute15: string
  Read Only: true

  Maximum Length: 4000

  Value that identifies planning attribute number 15 associated with the demand in the exception in an attribute-based plan.
• PlanningAttribute3: string
  Read Only: true

  Maximum Length: 4000

  Value that identifies planning attribute number 3 associated with the demand in the exception in an attribute-based plan.
• PlanningAttribute4: string
  Read Only: true

  Maximum Length: 4000

  Value that identifies planning attribute number 4 associated with the demand in the exception in an attribute-based plan.
• PlanningAttribute5: string
  Read Only: true

  Maximum Length: 4000

  Value that identifies planning attribute number 5 associated with the demand in the exception in an attribute-based plan.
• PlanningAttribute6: string
  Read Only: true

  Maximum Length: 4000

  Value that identifies planning attribute number 6 associated with the demand in the exception in an attribute-based plan.
• PlanningAttribute7: string
  Read Only: true

  Maximum Length: 4000

  Value that identifies planning attribute number 7 associated with the demand in the exception in an attribute-based plan.
• PlanningAttribute8: string
  Read Only: true

  Maximum Length: 4000

  Value that identifies planning attribute number 8 associated with the demand in the exception in an attribute-based plan.
• PlanningAttribute9: string
  Read Only: true

  Maximum Length: 4000

  Value that identifies planning attribute number 9 associated with the demand in the exception in an attribute-based plan.
• Priority: number
  Title: Priority

  Read Only: true

  Priority of the demand in the exception.
• ProjectGroupValue: string
  Read Only: true

  Maximum Length: 4000

  Value that identifies the project group associated with the demand in the exception in an attribute-based plan.
• ProjectValue: string
  Read Only: true

  Maximum Length: 4000

  Value that identifies the project associated with the demand in the exception in an attribute-based plan.
• QuantityMismatch: number
  Title: Quantity Mismatch

  Read Only: true

  Number that represents the unsatisfied quantity of the demand in the exception.
• QuantitySatisfiedByDemandDate: number
  Title: Quantity Satisfied by Demand Date

  Read Only: true

  Number that represents the quantity of the demand satisfied by the demand order date in the exception.
• RequiredLeadTime: number
  Title: Required Lead Time

  Read Only: true

  Number that represents the lead time required by the supply pegged to the demand in the exception.
• ResourceCode: string
  Title: Resource Code

  Read Only: true

  Maximum Length: 4000

  Name of the resource in the demand exception.
• ResourceId: integer
  Read Only: true

  Value that uniquely identifies the resource in the demand exception.
• ResourceOrganization: string
  Title: Resource Organization

  Read Only: true

  Maximum Length: 4000

  Name of the organization of the resource in the demand exception.
• StartDate: string (date)
  Title: Start Date

  Read Only: true

  Start date in the demand exception. For example, the plan start date in the Late Replenishment for Sales Order exception.
• Supplier: string
  Title: Supplier

  Read Only: true

  Maximum Length: 4000

  Name of the supplier in the demand exception.
• SupplierId: integer
  Read Only: true

  Value that uniquely identifies the supplier in the demand exception.
• SupplierItem: string
  Title: Supplier Item

  Read Only: true

  Maximum Length: 4000

  Supplier item in the demand exception.
• SupplierItemDescription: string
  Title: Supplier Item Description

  Read Only: true

  Maximum Length: 4000

  Supplier item description in the demand exception.
• SupplierSite: string
  Title: Supplier Site

  Read Only: true

  Maximum Length: 4000

  Name of the supplier site in the demand exception.
• SupplierSiteId: integer
  Read Only: true

  Value that uniquely identifies the supplier site in the demand exception.
• SupplyDueDate: string (date)
  Title: Supply Due Date

  Read Only: true

  Due date of the supply in the demand exception.
• SupplyItem: string
  Title: Supply Item

  Read Only: true

  Maximum Length: 4000

  Name of the supply's item pegged to the demand in the demand exception.
• SupplyItemDescription: string
  Title: Supply Item Description

  Read Only: true

  Maximum Length: 4000

  Description of the supply's item pegged to the demand in the demand exception.
• SupplyLineNumber: string
  Title: Supply Line Number

  Read Only: true

  Maximum Length: 50

  Line number of the supply in the demand exception.
• SupplyOrderDemandDueDate: string (date)
  Title: Supply Order Demand Due Date

  Read Only: true

  Due date of the supply order demand in the demand exception.
• SupplyOrderNumber: string
  Title: Supply Order Number

  Read Only: true

  Maximum Length: 240

  Order number of the supply in the demand exception.
• SupplyOrderType: string
  Title: Supply Order Type

  Read Only: true

  Maximum Length: 4000

  Type of order of the supply in the demand exception. For example, a planned order or a work order.
• SupplyOrganization: string
  Title: Supply Organization

  Read Only: true

  Maximum Length: 4000

  Name of the supply organization in the demand exception.
• SupplyQuantity: number
  Title: Supply Quantity

  Read Only: true

  Number that represents the quantity of the supply in the demand exception.
• TaskValue: string
  Read Only: true

  Maximum Length: 4000

  Value that identifies the task associated with the demand in the exception in an attribute-based plan.
• TransactionId: integer
  Read Only: true

  Value that uniquely identifies the supply in the demand exception.
• WorkCenter: string
  Title: Work Center

  Read Only: true

  Maximum Length: 4000

  Name of the work center of the resource in the demand exception.

{
    "type":"object",
    "properties":{
        "SupplyOrderType":{
            "title":"Supply Order Type",
            "maxLength":"4000",
            "type":"string",
            "description":"Type of order of the supply in the demand exception. For example, a planned order or a work order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrderValue":{
            "title":"Order Value",
            "type":"number",
            "description":"Order value of the demand in the exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Customer":{
            "title":"Customer",
            "maxLength":"4000",
            "type":"string",
            "description":"Name of the customer in the demand in the exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DemandOrderType":{
            "title":"Demand Order Type",
            "maxLength":"4000",
            "type":"string",
            "description":"Type of order of the demand in the exception. For example, the type of demand order could be a sales order or a forecast.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CustomerSite":{
            "title":"Customer Site",
            "maxLength":"4000",
            "type":"string",
            "description":"Name of the customer site in the demand in the exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"Start date in the demand exception. For example, the plan start date in the Late Replenishment for Sales Order exception.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":"4000",
            "type":"string",
            "description":"Code for the currency of the demand's organization in the exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Item":{
            "title":"Item",
            "maxLength":"4000",
            "type":"string",
            "description":"Name of the item in the demand in the exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExceptionValue":{
            "title":"Exception Value",
            "type":"number",
            "description":"Number that represents the value of the delay, or the value of the unplanned portion, or the value of the demand quantity, or a part of the demand quantity in the exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplyDueDate":{
            "title":"Supply Due Date",
            "type":"string",
            "description":"Due date of the supply in the demand exception.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExceptionDetailId":{
            "type":"integer",
            "description":"Value that uniquely identifies the demand exception detail.",
            "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"
            }
        },
        "SupplyQuantity":{
            "title":"Supply Quantity",
            "type":"number",
            "description":"Number that represents the quantity of the supply in the demand exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"Name of the user who last updated the exception detail.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceOrganization":{
            "title":"Resource Organization",
            "maxLength":"4000",
            "type":"string",
            "description":"Name of the organization of the resource in the demand exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MtqSupplyDate":{
            "title":"MTQ Supply Date",
            "type":"string",
            "description":"The supply date of the minimum transfer quantity (MTQ) of the supply pegged to the demand in the exception",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Priority":{
            "title":"Priority",
            "type":"number",
            "description":"Priority of the demand in the exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the demand's item in the exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplyItem":{
            "title":"Supply Item",
            "maxLength":"4000",
            "type":"string",
            "description":"Name of the supply's item pegged to the demand in the demand exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CustomerId":{
            "type":"integer",
            "description":"Value that uniquely identifies the customer in the exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExceptionId":{
            "type":"integer",
            "description":"Number that uniquely identifies an exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TransactionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supply in the demand exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplyOrganization":{
            "title":"Supply Organization",
            "maxLength":"4000",
            "type":"string",
            "description":"Name of the supply organization in the demand exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplierId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier in the demand exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "QuantitySatisfiedByDemandDate":{
            "title":"Quantity Satisfied by Demand Date",
            "type":"number",
            "description":"Number that represents the quantity of the demand satisfied by the demand order date in the exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CustomerSiteId":{
            "type":"integer",
            "description":"Value that uniquely identifies the customer site in the exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanningAttribute11":{
            "maxLength":"4000",
            "type":"string",
            "description":"Value that identifies planning attribute number 11 associated with the demand in the exception in an attribute-based plan.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanningAttribute10":{
            "maxLength":"4000",
            "type":"string",
            "description":"Value that identifies planning attribute number 10 associated with the demand in the exception in an attribute-based plan.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplierSite":{
            "title":"Supplier Site",
            "maxLength":"4000",
            "type":"string",
            "description":"Name of the supplier site in the demand exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplyOrderNumber":{
            "title":"Supply Order Number",
            "maxLength":"240",
            "type":"string",
            "description":"Order number of the supply in the demand exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DemandOrderNumber":{
            "title":"Demand Order Number",
            "maxLength":"4000",
            "type":"string",
            "description":"Order number of the demand in the exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ConstrainedDate":{
            "title":"Constrained Date",
            "type":"string",
            "description":"Value that represents the constrained date of the resource or the supplier capacity in the exception.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProjectValue":{
            "maxLength":"4000",
            "type":"string",
            "description":"Value that identifies the project associated with the demand in the exception in an attribute-based plan.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ActionTaken":{
            "title":"Action Taken",
            "type":"integer",
            "description":"Contains one of the following values: 1 or 2. If 1, then it indicates that an action is taken to resolve the exception. If 2, then no action is taken. Default value is 2.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "DaysLate":{
            "title":"Days Late",
            "type":"number",
            "description":"Number that represents the number of days a demand is satisfied late or a supply pegged to a demand is late or number of days a demand is past due. Based on the exception, the days late provides the details.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Organization":{
            "title":"Organization",
            "maxLength":"4000",
            "type":"string",
            "description":"Name of the demand's organization in the exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Category":{
            "title":"Category",
            "maxLength":"4000",
            "type":"string",
            "description":"Category of the demand's item in the exception. The category is derived from the default product hierarchy or any product hierarchy of the item associated in the plan's dimension catalog.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanningAttribute15":{
            "maxLength":"4000",
            "type":"string",
            "description":"Value that identifies planning attribute number 15 associated with the demand in the exception in an attribute-based plan.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProjectGroupValue":{
            "maxLength":"4000",
            "type":"string",
            "description":"Value that identifies the project group associated with the demand in the exception in an attribute-based plan.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DemandId":{
            "type":"integer",
            "description":"Value that uniquely identifies the demand in the exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanningAttribute14":{
            "maxLength":"4000",
            "type":"string",
            "description":"Value that identifies planning attribute number 14 associated with the demand in the exception in an attribute-based plan.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PeggedQuantity":{
            "title":"Pegged Quantity",
            "type":"number",
            "description":"Pegged quantity of the supply to the demand in the exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanningAttribute13":{
            "maxLength":"4000",
            "type":"string",
            "description":"Value that identifies planning attribute number 13 associated with the demand in the exception in an attribute-based plan.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the demand's organization in the exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanningAttribute12":{
            "maxLength":"4000",
            "type":"string",
            "description":"Value that identifies planning attribute number 12 associated with the demand in the exception in an attribute-based plan.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemDescription":{
            "title":"Item Description",
            "maxLength":"4000",
            "type":"string",
            "description":"Description of the item in the demand in the exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PartialPlannedQuantity":{
            "title":"Partial Planned Quantity",
            "type":"number",
            "description":"Partial planned quantity of the demand in the exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplierSiteId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier site in the demand exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanningAttribute9":{
            "maxLength":"4000",
            "type":"string",
            "description":"Value that identifies planning attribute number 9 associated with the demand in the exception in an attribute-based plan.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplyItemDescription":{
            "title":"Supply Item Description",
            "maxLength":"4000",
            "type":"string",
            "description":"Description of the supply's item pegged to the demand in the demand exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanningAttribute8":{
            "maxLength":"4000",
            "type":"string",
            "description":"Value that identifies planning attribute number 8 associated with the demand in the exception in an attribute-based plan.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanningAttribute7":{
            "maxLength":"4000",
            "type":"string",
            "description":"Value that identifies planning attribute number 7 associated with the demand in the exception in an attribute-based plan.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanningAttribute6":{
            "maxLength":"4000",
            "type":"string",
            "description":"Value that identifies planning attribute number 6 associated with the demand in the exception in an attribute-based plan.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanningAttribute5":{
            "maxLength":"4000",
            "type":"string",
            "description":"Value that identifies planning attribute number 5 associated with the demand in the exception in an attribute-based plan.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Supplier":{
            "title":"Supplier",
            "maxLength":"4000",
            "type":"string",
            "description":"Name of the supplier in the demand exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanningAttribute4":{
            "maxLength":"4000",
            "type":"string",
            "description":"Value that identifies planning attribute number 4 associated with the demand in the exception in an attribute-based plan.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanningAttribute3":{
            "maxLength":"4000",
            "type":"string",
            "description":"Value that identifies planning attribute number 3 associated with the demand in the exception in an attribute-based plan.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkCenter":{
            "title":"Work Center",
            "maxLength":"4000",
            "type":"string",
            "description":"Name of the work center of the resource in the demand exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "QuantityMismatch":{
            "title":"Quantity Mismatch",
            "type":"number",
            "description":"Number that represents the unsatisfied quantity of the demand in the exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Notes":{
            "title":"Notes",
            "type":"integer",
            "description":"Contains information created or updated for an exception detail represented as notes.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ResourceCode":{
            "title":"Resource Code",
            "maxLength":"4000",
            "type":"string",
            "description":"Name of the resource in the demand exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DemandQuantity":{
            "title":"Demand Quantity",
            "type":"number",
            "description":"Quantity of the demand in the exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AvailableLeadTime":{
            "title":"Available Lead Time",
            "type":"number",
            "description":"Number that represents the available lead time of the supply in the exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanId":{
            "type":"integer",
            "description":"Value that uniquely identifies the plan in which exception is generated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplyLineNumber":{
            "title":"Supply Line Number",
            "maxLength":"50",
            "type":"string",
            "description":"Line number of the supply in the demand exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DemandSatisfiedDate":{
            "title":"Demand Satisfied Date",
            "type":"string",
            "description":"Date in the exception when the demand quantity is completely satisfied.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DemandLineNumber":{
            "title":"Demand Line Number",
            "maxLength":"250",
            "type":"string",
            "description":"Line number of the demand in the exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MaturityDate":{
            "title":"Maturity Date",
            "type":"string",
            "description":"Date of maturity of the supply pegged to the demand in the exception.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlannerDescription":{
            "title":"Planner Description",
            "maxLength":"4000",
            "type":"string",
            "description":"Description of the planner associated with the demand's item in the exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplyOrderDemandDueDate":{
            "title":"Supply Order Demand Due Date",
            "type":"string",
            "description":"Due date of the supply order demand in the demand exception.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Exception":{
            "title":"Exception",
            "maxLength":"120",
            "type":"string",
            "description":"Name of an exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DemandClass":{
            "title":"Demand Class",
            "maxLength":"4000",
            "type":"string",
            "description":"Demand class associated with the demand in the exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrderDate":{
            "title":"Order Date",
            "type":"string",
            "description":"Date of the demand in the exception.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlannerCode":{
            "title":"Planner",
            "maxLength":"4000",
            "type":"string",
            "description":"Name of the planner associated with the demand's item in the exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RequiredLeadTime":{
            "title":"Required Lead Time",
            "type":"number",
            "description":"Number that represents the lead time required by the supply pegged to the demand in the exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the resource in the demand exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DepartmentId":{
            "type":"integer",
            "description":"Value that uniquely identifies the department or the work center of a resource in the exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplierItemDescription":{
            "title":"Supplier Item Description",
            "maxLength":"4000",
            "type":"string",
            "description":"Supplier item description in the demand exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplierItem":{
            "title":"Supplier Item",
            "maxLength":"4000",
            "type":"string",
            "description":"Supplier item in the demand exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"Date when the exception detail was last updated.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TaskValue":{
            "maxLength":"4000",
            "type":"string",
            "description":"Value that identifies the task associated with the demand in the exception in an attribute-based plan.",
            "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"
    }
}

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

Back to Top