Jump to

• Request
• Response

Get details of all supply exceptions

get

/fscmRestApi/resources/11.13.18.05/supplyPlans/{PlanId}/child/SupplyExceptions

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 supply exception according to the value that identifies the supply exception.
    Finder Variables
    • ExceptionDetailId; integer; Value that uniquely identifies the supply exception detail associated with the supply exception.
    • PlanId; integer; Value that uniquely identifies the plan associated with the supply 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.
  • AlternateBOM; string; Name of the alternate bill of material in the supply exception.
  • AlternateBOMId; integer; Number that uniquely identifies the alternate bill of material in the supply exception.
  • AlternateFacilityRank; number; Number that represents the alternate facility rank from the sourcing rule used in the supply in the exception.
  • AlternateResourceUsage; number; Number that represents the usage of an alternate resource in the supply in the exception.
  • AlternateRouting; string; Name of the alternate routing or work definition in the supply exception.
  • AlternateRoutingId; integer; Number that uniquely identifies the alternate routing or work definition in the supply exception.
  • AlternateSupplier; string; Name of the alternate supplier in the supply exception.
  • AlternateSupplierId; integer; Number that uniquely identifies the alternate supplier in the supply exception.
  • AlternateSupplierRank; number; Number that represents the alternate supplier rank in the supply exception.
  • AlternateSupplierSite; string; Name of the alternate supplier site in the supply exception.
  • AlternateSupplierSiteId; integer; Number that uniquely identifies the alternate supplier site in the supply exception.
  • Category; string; Category of the item in the supply exception.
  • CompressionDays; number; Number that represents the compression days of the supply in the exception.
  • CompressionRatio; number; Compression ratio of the supply in the exception.
  • CurrencyCode; string; Code for the currency of the supply's organization in the exception.
  • DaysPastDue; number; Number that represents the number of days the supply is past due based on the plan start date in the exception.
  • Exception; string; Name of an exception.
  • ExceptionDetailId; integer; Value that uniquely identifies the supply exception detail.
  • ExceptionId; integer; Number that uniquely identifies an exception.
  • ExceptionStoreId; integer; Value that uniquely identifies the stored supply exception.
  • FirmStatus; number; Status that indicates whether the order is firm or not in the exception. Valid values include Firm and Not firm.
  • FromDate; string; From date in the supply exception.
  • InventoryItemId; integer; Number that uniquely identifies the item in the supply exception.
  • Item; string; Name of the item in the supply exception.
  • ItemDescription; string; Description of the item in the supply 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; Lot number of the on-hand supply in the supply exception.
  • Notes; integer; Contains information created or updated for an exception detail represented as notes.
  • OldDueDate; string; Old due date of the supply order in the supply exception.
  • OrderDate; string; Supply order date in the exception.
  • OrderLineNumber; string; Line number of the supply in the exception.
  • OrderNumber; string; Order number of the supply in the exception.
  • OrderStartDate; string; Start date of the supply order in the supply exception.
  • OrderValue; number; Order value of the supply in the exception.
  • Organization; string; Name of the organization of the supply in the supply exception.
  • OrganizationId; integer; Value that uniquely identifies the organization of the supply in the supply exception.
  • PlanId; integer; Value that uniquely identifies the plan in which exception is generated.
  • PlanStartDate; string; Start date of the plan the exception is generated in.
  • 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.
  • PlanningAttribute10; string; Value that identifies planning attribute number 10 associated with the supply in the exception in an attribute-based plan.
  • PlanningAttribute11; string; Value that identifies planning attribute number 11 associated with the supply in the exception in an attribute-based plan.
  • PlanningAttribute12; string; Value that identifies planning attribute number 12 associated with the supply in the exception in an attribute-based plan.
  • PlanningAttribute13; string; Value that identifies planning attribute number 13 associated with the supply in the exception in an attribute-based plan.
  • PlanningAttribute14; string; Value that identifies planning attribute number 14 associated with the supply in the exception in an attribute-based plan.
  • PlanningAttribute15; string; Value that identifies planning attribute number 15 associated with the supply in the exception in an attribute-based plan.
  • PlanningAttribute3; string; Value that identifies planning attribute number 3 associated with the supply in the exception in an attribute-based plan.
  • PlanningAttribute4; string; Value that identifies planning attribute number 4 associated with the supply in the exception in an attribute-based plan.
  • PlanningAttribute5; string; Value that identifies planning attribute number 5 associated with the supply in the exception in an attribute-based plan.
  • PlanningAttribute6; string; Value that identifies planning attribute number 6 associated with the supply in the exception in an attribute-based plan.
  • PlanningAttribute7; string; Value that identifies planning attribute number 7 associated with the supply in the exception in an attribute-based plan.
  • PlanningAttribute8; string; Value that identifies planning attribute number 8 associated with the supply in the exception in an attribute-based plan.
  • PlanningAttribute9; string; Value that identifies planning attribute number 9 associated with the supply in the exception in an attribute-based plan.
  • PrimaryResourceRequirement; number; Resource requirement of the primary resource of the supply in the exception.
  • ProjectGroupValue; string; Value that identifies the project group associated with the supply in the exception of an attribute-based plan.
  • ProjectValue; string; Value that identifies the project associated with the supply in the exception of an attribute-based plan.
  • Quantity; number; Number that represents the quantity of the supply in the supply exception.
  • RescheduledDays; number; Number that represents rescheduled days for the supply in the exception.
  • ResourceCode; string; Code of the supply's resource in the supply exception.
  • ResourceId; integer; Value that uniquely identifies the supply's resource in the supply exception.
  • ShipMethod; string; Name of the ship method associated with the supply in the supply exception.
  • SourceOrganization; string; Name of the source organization of the supply in the supply exception.
  • SourceOrganizationId; integer; Value that uniquely identifies the source organization of the supply in the supply exception.
  • StoreKey; string; Name of the store key in the supply exception.
  • SubInventory; string; Name of the subinventory of supply in the supply exception.
  • SubstituteResourceCode; string; Code of the supply's alternate resource in the supply exception.
  • SubstituteResourceId; integer; Value that uniquely identifies the supply's alternate resource in the supply exception.
  • Supplier; string; Name of the supplier in the supply exception.
  • SupplierId; integer; Number that uniquely identifies the supplier in the supply exception.
  • SupplierSite; string; Name of the supplier site in the supply exception.
  • SupplierSiteId; integer; Number that uniquely identifies the supplier site in the supply exception.
  • SupplyOrderType; string; Type of supply order in the exception, such as a planned order or transfer order.
  • TaskValue; string; Value that identifies the task associated with the supply in the exception in an attribute-based plan.
  • ToDate; string; To date of the supply in the supply exception.
  • TransactionId; integer; Value that uniquely identifies the supply in the supply exception.
  • WorkCenter; string; Code of the work center of the supply's resource in the supply exception.
  • WorkCenterId; integer; Value that uniquely identifies the work center of the supply's resource in the supply 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 : supplyPlans-SupplyExceptions

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/supplyPlans-SupplyExceptions-item-response"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object supplyPlans-SupplyExceptions-item-response

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

  Read Only: true

  Maximum Length: 4000

  Name of the alternate bill of material in the supply exception.
• AlternateBOMId: integer
  Read Only: true

  Number that uniquely identifies the alternate bill of material in the supply exception.
• AlternateFacilityRank: number
  Title: Alternate Facility Rank

  Read Only: true

  Number that represents the alternate facility rank from the sourcing rule used in the supply in the exception.
• AlternateResourceUsage: number
  Title: Alternate Resource Requirement

  Read Only: true

  Number that represents the usage of an alternate resource in the supply in the exception.
• AlternateRouting: string
  Title: Alternate Routing

  Read Only: true

  Maximum Length: 4000

  Name of the alternate routing or work definition in the supply exception.
• AlternateRoutingId: integer
  Read Only: true

  Number that uniquely identifies the alternate routing or work definition in the supply exception.
• AlternateSupplier: string
  Title: Alternate Supplier

  Read Only: true

  Maximum Length: 4000

  Name of the alternate supplier in the supply exception.
• AlternateSupplierId: integer
  Read Only: true

  Number that uniquely identifies the alternate supplier in the supply exception.
• AlternateSupplierRank: number
  Title: Alternate Supplier Rank

  Read Only: true

  Number that represents the alternate supplier rank in the supply exception.
• AlternateSupplierSite: string
  Title: Alternate Supplier Site

  Read Only: true

  Maximum Length: 4000

  Name of the alternate supplier site in the supply exception.
• AlternateSupplierSiteId: integer
  Read Only: true

  Number that uniquely identifies the alternate supplier site in the supply exception.
• Category: string
  Title: Category

  Read Only: true

  Maximum Length: 4000

  Category of the item in the supply exception.
• CompressionDays: number
  Title: Compression Days

  Read Only: true

  Number that represents the compression days of the supply in the exception.
• CompressionRatio: number
  Title: Compression Ratio

  Read Only: true

  Compression ratio of the supply in the exception.
• CurrencyCode: string
  Title: Currency

  Read Only: true

  Maximum Length: 4000

  Code for the currency of the supply's organization in the exception.
• DaysPastDue: number
  Title: Days Past Due

  Read Only: true

  Number that represents the number of days the supply is past due based on the plan start date in the exception.
• Exception: string
  Title: Exception

  Read Only: true

  Maximum Length: 15

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

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

  Number that uniquely identifies an exception.
• ExceptionStoreId: integer (int64)
  Read Only: true

  Value that uniquely identifies the stored supply exception.
• FirmStatus: number
  Title: Firm Status

  Read Only: true

  Status that indicates whether the order is firm or not in the exception. Valid values include Firm and Not firm.
• FromDate: string (date)
  Title: From Date

  Read Only: true

  From date in the supply exception.
• InventoryItemId: integer
  Read Only: true

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

  Read Only: true

  Maximum Length: 300

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

  Read Only: true

  Maximum Length: 240

  Description of the item in the supply 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

  Lot number of the on-hand supply in the supply exception.
• Notes: integer (int64)
  Title: Notes

  Read Only: true

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

  Read Only: true

  Old due date of the supply order in the supply exception.
• OrderDate: string (date)
  Title: Order Date

  Read Only: true

  Supply order date in the exception.
• OrderLineNumber: string
  Title: Order Line Number

  Read Only: true

  Maximum Length: 50

  Line number of the supply in the exception.
• OrderNumber: string
  Title: Order Number

  Read Only: true

  Maximum Length: 240

  Order number of the supply in the exception.
• OrderStartDate: string (date)
  Title: Order Start Date

  Read Only: true

  Start date of the supply order in the supply exception.
• OrderValue: number
  Title: Order Value

  Read Only: true

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

  Read Only: true

  Maximum Length: 4000

  Name of the organization of the supply in the supply exception.
• OrganizationId: integer
  Read Only: true

  Value that uniquely identifies the organization of the supply in the supply 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.
• PlanningAttribute10: string
  Read Only: true

  Maximum Length: 4000

  Value that identifies planning attribute number 10 associated with the supply 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 supply 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 supply 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 supply 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 supply 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 supply 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 supply 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 supply 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 supply 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 supply 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 supply 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 supply 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 supply in the exception in an attribute-based plan.
• PlanStartDate: string (date)
  Title: Plan Start Date

  Read Only: true

  Start date of the plan the exception is generated in.
• PrimaryResourceRequirement: number
  Title: Primary Resource Requirement

  Read Only: true

  Resource requirement of the primary resource of the supply in the exception.
• ProjectGroupValue: string
  Read Only: true

  Maximum Length: 4000

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

  Maximum Length: 4000

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

  Read Only: true

  Number that represents the quantity of the supply in the supply exception.
• RescheduledDays: number
  Title: Reschedule Days

  Read Only: true

  Number that represents rescheduled days for the supply in the exception.
• ResourceCode: string
  Title: Resource

  Read Only: true

  Maximum Length: 4000

  Code of the supply's resource in the supply exception.
• ResourceId: integer
  Read Only: true

  Value that uniquely identifies the supply's resource in the supply exception.
• ShipMethod: string
  Title: Shipping Method

  Read Only: true

  Maximum Length: 4000

  Name of the ship method associated with the supply in the supply exception.
• SourceOrganization: string
  Title: Source Organization

  Read Only: true

  Maximum Length: 4000

  Name of the source organization of the supply in the supply exception.
• SourceOrganizationId: integer
  Read Only: true

  Value that uniquely identifies the source organization of the supply in the supply exception.
• StoreKey: string
  Read Only: true

  Maximum Length: 240

  Name of the store key in the supply exception.
• SubInventory: string
  Title: Subinventory

  Read Only: true

  Maximum Length: 80

  Name of the subinventory of supply in the supply exception.
• SubstituteResourceCode: string
  Title: Alternate Resource

  Read Only: true

  Maximum Length: 4000

  Code of the supply's alternate resource in the supply exception.
• SubstituteResourceId: integer
  Read Only: true

  Value that uniquely identifies the supply's alternate resource in the supply exception.
• Supplier: string
  Title: Supplier

  Read Only: true

  Maximum Length: 4000

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

  Number that uniquely identifies the supplier in the supply exception.
• SupplierSite: string
  Title: Supplier Site

  Read Only: true

  Maximum Length: 4000

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

  Number that uniquely identifies the supplier site in the supply exception.
• SupplyOrderType: string
  Title: Supply Order Type

  Read Only: true

  Maximum Length: 4000

  Type of supply order in the exception, such as a planned order or transfer order.
• TaskValue: string
  Read Only: true

  Maximum Length: 4000

  Value that identifies the task associated with the supply in the exception in an attribute-based plan.
• ToDate: string (date)
  Title: To Date

  Read Only: true

  To date of the supply in the supply exception.
• TransactionId: integer
  Read Only: true

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

  Read Only: true

  Maximum Length: 4000

  Code of the work center of the supply's resource in the supply exception.
• WorkCenterId: integer
  Read Only: true

  Value that uniquely identifies the work center of the supply's resource in the supply exception.

{
    "type":"object",
    "properties":{
        "SupplyOrderType":{
            "title":"Supply Order Type",
            "maxLength":"4000",
            "type":"string",
            "description":"Type of supply order in the exception, such as a planned order or transfer order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ShipMethod":{
            "title":"Shipping Method",
            "maxLength":"4000",
            "type":"string",
            "description":"Name of the ship method associated with the supply in the supply exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AlternateFacilityRank":{
            "title":"Alternate Facility Rank",
            "type":"number",
            "description":"Number that represents the alternate facility rank from the sourcing rule used in the supply in the exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrderValue":{
            "title":"Order Value",
            "type":"number",
            "description":"Order value of the supply in the exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubstituteResourceCode":{
            "title":"Alternate Resource",
            "maxLength":"4000",
            "type":"string",
            "description":"Code of the supply's alternate resource in the supply exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrderNumber":{
            "title":"Order Number",
            "maxLength":"240",
            "type":"string",
            "description":"Order number of the supply in the exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":"4000",
            "type":"string",
            "description":"Code for the currency of the supply's organization in the exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Item":{
            "title":"Item",
            "maxLength":"300",
            "type":"string",
            "description":"Name of the item in the supply exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryResourceRequirement":{
            "title":"Primary Resource Requirement",
            "type":"number",
            "description":"Resource requirement of the primary resource of the supply in the exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExceptionDetailId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supply 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"
            }
        },
        "DaysPastDue":{
            "title":"Days Past Due",
            "type":"number",
            "description":"Number that represents the number of days the supply is past due based on the plan start date in the 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
        },
        "SubInventory":{
            "title":"Subinventory",
            "maxLength":"80",
            "type":"string",
            "description":"Name of the subinventory of supply in the supply exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AlternateRouting":{
            "title":"Alternate Routing",
            "maxLength":"4000",
            "type":"string",
            "description":"Name of the alternate routing or work definition in the supply exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"Number that uniquely identifies the item in the supply 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
        },
        "AlternateSupplier":{
            "title":"Alternate Supplier",
            "maxLength":"4000",
            "type":"string",
            "description":"Name of the alternate supplier in the supply exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AlternateBOM":{
            "title":"Alternate BOM",
            "maxLength":"4000",
            "type":"string",
            "description":"Name of the alternate bill of material in the supply exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TransactionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supply in the supply exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplierId":{
            "type":"integer",
            "description":"Number that uniquely identifies the supplier in the supply exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanningAttribute11":{
            "maxLength":"4000",
            "type":"string",
            "description":"Value that identifies planning attribute number 11 associated with the supply 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 supply 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 supply exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FromDate":{
            "title":"From Date",
            "type":"string",
            "description":"From date in the supply exception.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProjectValue":{
            "maxLength":"4000",
            "type":"string",
            "description":"Value that identifies the project associated with the supply in the exception of 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
        },
        "OrderStartDate":{
            "title":"Order Start Date",
            "type":"string",
            "description":"Start date of the supply order in the supply exception.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Organization":{
            "title":"Organization",
            "maxLength":"4000",
            "type":"string",
            "description":"Name of the organization of the supply in the supply exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkCenterId":{
            "type":"integer",
            "description":"Value that uniquely identifies the work center of the supply's resource in the supply exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Category":{
            "title":"Category",
            "maxLength":"4000",
            "type":"string",
            "description":"Category of the item in the supply exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OldDueDate":{
            "title":"Old Due Date",
            "type":"string",
            "description":"Old due date of the supply order in the supply exception.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AlternateSupplierSite":{
            "title":"Alternate Supplier Site",
            "maxLength":"4000",
            "type":"string",
            "description":"Name of the alternate supplier site in the supply exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanningAttribute15":{
            "maxLength":"4000",
            "type":"string",
            "description":"Value that identifies planning attribute number 15 associated with the supply 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 supply in the exception of an attribute-based plan.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanningAttribute14":{
            "maxLength":"4000",
            "type":"string",
            "description":"Value that identifies planning attribute number 14 associated with the supply in the exception in an attribute-based plan.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanningAttribute13":{
            "maxLength":"4000",
            "type":"string",
            "description":"Value that identifies planning attribute number 13 associated with the supply in the exception in an attribute-based plan.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the organization of the supply in the supply exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanningAttribute12":{
            "maxLength":"4000",
            "type":"string",
            "description":"Value that identifies planning attribute number 12 associated with the supply in the exception in an attribute-based plan.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RescheduledDays":{
            "title":"Reschedule Days",
            "type":"number",
            "description":"Number that represents rescheduled days for the supply in the exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AlternateRoutingId":{
            "type":"integer",
            "description":"Number that uniquely identifies the alternate routing or work definition in the supply exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AlternateSupplierId":{
            "type":"integer",
            "description":"Number that uniquely identifies the alternate supplier in the supply exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemDescription":{
            "title":"Item Description",
            "maxLength":"240",
            "type":"string",
            "description":"Description of the item in the supply exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceOrganization":{
            "title":"Source Organization",
            "maxLength":"4000",
            "type":"string",
            "description":"Name of the source organization of the supply in the supply exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplierSiteId":{
            "type":"integer",
            "description":"Number that uniquely identifies the supplier site in the supply exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanningAttribute9":{
            "maxLength":"4000",
            "type":"string",
            "description":"Value that identifies planning attribute number 9 associated with the supply in the exception in an attribute-based plan.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanningAttribute8":{
            "maxLength":"4000",
            "type":"string",
            "description":"Value that identifies planning attribute number 8 associated with the supply in the exception in an attribute-based plan.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FirmStatus":{
            "title":"Firm Status",
            "type":"number",
            "description":"Status that indicates whether the order is firm or not in the exception. Valid values include Firm and Not firm.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanningAttribute7":{
            "maxLength":"4000",
            "type":"string",
            "description":"Value that identifies planning attribute number 7 associated with the supply 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 supply 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 supply 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 supply exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanningAttribute4":{
            "maxLength":"4000",
            "type":"string",
            "description":"Value that identifies planning attribute number 4 associated with the supply 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 supply in the exception in an attribute-based plan.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkCenter":{
            "title":"Work Center",
            "maxLength":"4000",
            "type":"string",
            "description":"Code of the work center of the supply's resource in the supply exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CompressionRatio":{
            "title":"Compression Ratio",
            "type":"number",
            "description":"Compression ratio of the supply in the exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExceptionStoreId":{
            "type":"integer",
            "description":"Value that uniquely identifies the stored supply exception.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AlternateResourceUsage":{
            "title":"Alternate Resource Requirement",
            "type":"number",
            "description":"Number that represents the usage of an alternate resource in the supply 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
        },
        "LotNumber":{
            "title":"Lot Number",
            "maxLength":"80",
            "type":"string",
            "description":"Lot number of the on-hand supply in the supply exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceOrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the source organization of the supply in the supply exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceCode":{
            "title":"Resource",
            "maxLength":"4000",
            "type":"string",
            "description":"Code of the supply's resource in the supply exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrderLineNumber":{
            "title":"Order Line Number",
            "maxLength":"50",
            "type":"string",
            "description":"Line number 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
        },
        "Quantity":{
            "title":"Quantity",
            "type":"number",
            "description":"Number that represents the quantity of the supply in the supply exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CompressionDays":{
            "title":"Compression Days",
            "type":"number",
            "description":"Number that represents the compression days of the supply in the 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
        },
        "StoreKey":{
            "maxLength":"240",
            "type":"string",
            "description":"Name of the store key in the supply exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Exception":{
            "title":"Exception",
            "maxLength":"15",
            "type":"string",
            "description":"Name of an exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubstituteResourceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supply's alternate resource in the supply exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrderDate":{
            "title":"Order Date",
            "type":"string",
            "description":"Supply order date in the exception.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AlternateBOMId":{
            "type":"integer",
            "description":"Number that uniquely identifies the alternate bill of material in the supply exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AlternateSupplierSiteId":{
            "type":"integer",
            "description":"Number that uniquely identifies the alternate supplier site in the supply exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supply's resource in the supply exception.",
            "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
        },
        "ToDate":{
            "title":"To Date",
            "type":"string",
            "description":"To date of the supply in the supply exception.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AlternateSupplierRank":{
            "title":"Alternate Supplier Rank",
            "type":"number",
            "description":"Number that represents the alternate supplier rank in the supply exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanStartDate":{
            "title":"Plan Start Date",
            "type":"string",
            "description":"Start date of the plan the exception is generated in.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TaskValue":{
            "maxLength":"4000",
            "type":"string",
            "description":"Value that identifies the task associated with the supply in the exception in an attribute-based plan.",
            "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
        }
    }
}

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