Jump to

• Request
• Response

Get exception details of all item exceptions

get

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

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 item exception according to the value that identifies the item exception.
    Finder Variables
    • ExceptionDetailId; integer; Value that uniquely identifies the item exception detail associated with the item exception.
    • PlanId; integer; Value that uniquely identifies the plan associated with the item 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.
  • Category; string; Category of the 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.
  • CurrencyCode; string; Code for the currency of the demand's organization in the exception.
  • DaysOfExcess; number; Number of days of excess inventory calculated by the plan in an item with excess inventory exception.
  • DaysOfShortage; number; Number of days of shortage of supply for an item calculated by the plan in an items with a shortage exception.
  • Exception; string; Name of an exception.
  • ExceptionDetailId; integer; Value that uniquely identifies the item exception detail.
  • ExceptionId; integer; Number that uniquely identifies an exception.
  • ExceptionQuantity; number; Number that represents the quantity of supply in an item exception. This represents the shortage quantity in the item with a shortage exception, the quantity below safety sock in items below safety stock, the quantity of excess in item with excess inventory exception, and the expired quantity in items with expired lot exception.
  • ExceptionStoreId; integer; Value that uniquely identifies the item stored item exception.
  • ExpirationDate; string; Date of expiration of an on hand lot in items with expired lot exceptions.
  • FromDate; string; Effective start date of an exception detail calculated by the plan.
  • InventoryItemId; integer; Value that uniquely identifies the item in the exception.
  • Item; string; Name of the item 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.
  • LotNumber; string; Name of the lot of the on hand in an exception detail.
  • Notes; integer; Contains information created or updated for an exception detail represented as notes.
  • Organization; string; Name of the organization of an item for which an exception was calculated by the plan.
  • OrganizationId; integer; Value that uniquely identifies the organization of an item in the exception
  • PlanId; integer; Value that uniquely identifies the plan in which exception is generated.
  • Planner; string; Name of the planner associated with the item in the exception.
  • PlannerDescription; string; Description of the planner associated with the item in the exception.
  • ProjectedAvailableBalance; number; Number that represents the projected available balance of the item in the exception.
  • SafetyStockTarget; number; Number that represents the target level of the safety stock for an item in an organization in the exception.
  • SubInventoryCode; string; Name of the subinventory of on hand for an item in exception.
  • ToDate; string; Effective end date of an exception detail calculated by the plan.
  • ValueOfShortage; number; Name that represents the value of the shortage quantity of supply for an item that's in an 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-ItemExceptions

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-ItemExceptions-item-response"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

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

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/demandAndSupplyPlans-ItemExceptions-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-ItemExceptions-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.
• Category: string
  Title: Category

  Read Only: true

  Maximum Length: 4000

  Category of the 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.
• CurrencyCode: string
  Title: Currency

  Read Only: true

  Maximum Length: 4000

  Code for the currency of the demand's organization in the exception.
• DaysOfExcess: number
  Title: Days of Excess

  Read Only: true

  Number of days of excess inventory calculated by the plan in an item with excess inventory exception.
• DaysOfShortage: number
  Title: Days of Shortage

  Read Only: true

  Number of days of shortage of supply for an item calculated by the plan in an items with a shortage exception.
• Exception: string
  Title: Exception

  Read Only: true

  Maximum Length: 34

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

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

  Number that uniquely identifies an exception.
• ExceptionQuantity: number
  Title: Exception Quantity

  Read Only: true

  Number that represents the quantity of supply in an item exception. This represents the shortage quantity in the item with a shortage exception, the quantity below safety sock in items below safety stock, the quantity of excess in item with excess inventory exception, and the expired quantity in items with expired lot exception.
• ExceptionStoreId: integer (int64)
  Read Only: true

  Value that uniquely identifies the item stored item exception.
• ExpirationDate: string (date)
  Title: Expiration Date

  Read Only: true

  Date of expiration of an on hand lot in items with expired lot exceptions.
• FromDate: string (date)
  Title: From Date

  Read Only: true

  Effective start date of an exception detail calculated by the plan.
• InventoryItemId: integer
  Read Only: true

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

  Read Only: true

  Maximum Length: 4000

  Name of the item 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.
• LotNumber: string
  Title: Lot Number

  Read Only: true

  Maximum Length: 80

  Name of the lot of the on hand in an exception detail.
• Notes: integer (int64)
  Title: Notes

  Read Only: true

  Contains information created or updated for an exception detail represented as notes.
• Organization: string
  Title: Organization

  Read Only: true

  Maximum Length: 4000

  Name of the organization of an item for which an exception was calculated by the plan.
• OrganizationId: integer
  Read Only: true

  Value that uniquely identifies the organization of an item in the exception
• PlanId: integer
  Read Only: true

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

  Read Only: true

  Maximum Length: 10

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

  Read Only: true

  Maximum Length: 4000

  Description of the planner associated with the item in the exception.
• ProjectedAvailableBalance: number
  Title: Projected Available Balance

  Read Only: true

  Number that represents the projected available balance of the item in the exception.
• SafetyStockTarget: number
  Title: Safety Stock Target

  Read Only: true

  Number that represents the target level of the safety stock for an item in an organization in the exception.
• SubInventoryCode: string
  Title: Subinventory

  Read Only: true

  Maximum Length: 80

  Name of the subinventory of on hand for an item in exception.
• ToDate: string (date)
  Title: To Date

  Read Only: true

  Effective end date of an exception detail calculated by the plan.
• ValueOfShortage: number
  Title: Value of Shortage

  Read Only: true

  Name that represents the value of the shortage quantity of supply for an item that's in an exception.

{
    "type":"object",
    "properties":{
        "Organization":{
            "title":"Organization",
            "maxLength":"4000",
            "type":"string",
            "description":"Name of the organization of an item for which an exception was calculated by the plan.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Category":{
            "title":"Category",
            "maxLength":"4000",
            "type":"string",
            "description":"Category of the 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
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the organization of an item in the exception",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubInventoryCode":{
            "title":"Subinventory",
            "maxLength":"80",
            "type":"string",
            "description":"Name of the subinventory of on hand for an item in exception.",
            "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
        },
        "DaysOfExcess":{
            "title":"Days of Excess",
            "type":"number",
            "description":"Number of days of excess inventory calculated by the plan in an item with excess inventory exception.",
            "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 exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SafetyStockTarget":{
            "title":"Safety Stock Target",
            "type":"number",
            "description":"Number that represents the target level of the safety stock for an item in an organization in the exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExceptionDetailId":{
            "type":"integer",
            "description":"Value that uniquely identifies the item 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"
            }
        },
        "ProjectedAvailableBalance":{
            "title":"Projected Available Balance",
            "type":"number",
            "description":"Number that represents the projected available balance of the item in the exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExceptionStoreId":{
            "type":"integer",
            "description":"Value that uniquely identifies the item stored item exception.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "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
        },
        "LotNumber":{
            "title":"Lot Number",
            "maxLength":"80",
            "type":"string",
            "description":"Name of the lot of the on hand in an exception detail.",
            "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
        },
        "ValueOfShortage":{
            "title":"Value of Shortage",
            "type":"number",
            "description":"Name that represents the value of the shortage quantity of supply for an item that's in an 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
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the item 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
        },
        "PlannerDescription":{
            "title":"Planner Description",
            "maxLength":"4000",
            "type":"string",
            "description":"Description of the planner associated with the item in the exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Exception":{
            "title":"Exception",
            "maxLength":"34",
            "type":"string",
            "description":"Name of an exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DaysOfShortage":{
            "title":"Days of Shortage",
            "type":"number",
            "description":"Number of days of shortage of supply for an item calculated by the plan in an items with a shortage exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"Date of expiration of an on hand lot in items with expired lot exceptions.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Planner":{
            "title":"Planner",
            "maxLength":"10",
            "type":"string",
            "description":"Name of the planner associated with the item in the exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FromDate":{
            "title":"From Date",
            "type":"string",
            "description":"Effective start date of an exception detail calculated by the plan.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ToDate":{
            "title":"To Date",
            "type":"string",
            "description":"Effective end date of an exception detail calculated by the plan.",
            "format":"date",
            "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
        },
        "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
        },
        "ExceptionQuantity":{
            "title":"Exception Quantity",
            "type":"number",
            "description":"Number that represents the quantity of supply in an item exception. This represents the shortage quantity in the item with a shortage exception, the quantity below safety sock in items below safety stock, the quantity of excess in item with excess inventory exception, and the expired quantity in items with expired lot exception.",
            "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