Get details of all supplier exceptions
get
/fscmRestApi/resources/11.13.18.05/demandAndSupplyPlans/{PlanId}/child/SupplierExceptions
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 supplier exception according to the value that identifies the supplier exception.
Finder Variables- ExceptionDetailId; integer; Value that uniquely identifies the supplier exception detail associated with the supplier exception.
- PlanId; integer; Value that uniquely identifies the plan associated with the supplier exception.
- PrimaryKey Finds the supplier exception according to the value that identifies the supplier 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.
- AdditionalCapacityRequiredByDateOfSupplierCapacityConstraint; number; Additional capacity required by the item supplier and supplier site combination by date of the supplier capacity constraint in the supplier exception.
- AvailableCapacity; number; Available capacity of the item supplier and supplier site combination in the supplier exception.
- Category; string; Category of the item in the supplier exception.
- DateOfSupplierCapacityConstraint; string; Date of the supplier capacity constraint in the supplier exception.
- Exception; string; Name of an exception.
- ExceptionDetailId; integer; Value that uniquely identifies the supplier exception detail.
- ExceptionId; integer; Number that uniquely identifies an exception.
- ExceptionStoreId; integer; Value that uniquely identifies the stored supplier exception.
- FromDate; string; From date of the supplier capacity overload in the supplier exception.
- InventoryItemId; integer; Number that uniquely identifies the item in the supplier exception.
- Item; string; Name of the item in the supplier exception.
- ItemDescription; string; Description of the item in the supplier exception.
- LastUpdateDate; string; Date when the exception detail was last updated.
- LastUpdatedBy; string; Name of the user who last updated the 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
- OverloadPercent; number; Percentage of supplier capacity overload in the supplier 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.
- RequiredCapacity; number; Required supplier capacity of the item supplier and supplier site combination in the supplier exception.
- Supplier; string; Name of the supplier in the supplier exception.
- SupplierAvailability; number; Supplier availability in the supplier exception.
- SupplierCapacityBySupplierCapacityConstraintDate; number; Supplier capacity required by date of supplier capacity constraint in the supplier exception.
- SupplierId; integer; Number that uniquely identifies the supplier in the supplier exception.
- SupplierSite; string; Name of the supplier site in the supplier exception.
- SupplierSiteId; integer; Number that uniquely identifies the supplier site in the supplier exception.
- ToDate; string; To date of the supplier capacity overload in the supplier 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 TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : demandAndSupplyPlans-SupplierExceptions
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : demandAndSupplyPlans-SupplierExceptions-item-response
Type:
Show Source
object
-
ActionTaken: integer
(int64)
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. -
AdditionalCapacityRequiredByDateOfSupplierCapacityConstraint: number
Read Only:
true
Additional capacity required by the item supplier and supplier site combination by date of the supplier capacity constraint in the supplier exception. -
AvailableCapacity: number
Read Only:
true
Available capacity of the item supplier and supplier site combination in the supplier exception. -
Category: string
Read Only:
true
Maximum Length:4000
Category of the item in the supplier exception. -
DateOfSupplierCapacityConstraint: string
(date)
Read Only:
true
Date of the supplier capacity constraint in the supplier exception. -
Exception: string
Title:
Exception
Read Only:true
Maximum Length:29
Name of an exception. -
ExceptionDetailId: integer
Read Only:
true
Value that uniquely identifies the supplier 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 supplier exception. -
FromDate: string
(date)
Read Only:
true
From date of the supplier capacity overload in the supplier exception. -
InventoryItemId: integer
Read Only:
true
Number that uniquely identifies the item in the supplier exception. -
Item: string
Title:
Item
Read Only:true
Maximum Length:4000
Name of the item in the supplier exception. -
ItemDescription: string
Title:
Item Description
Read Only:true
Maximum Length:4000
Description of the item in the supplier exception. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date when the exception detail was last updated. -
LastUpdatedBy: string
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. -
Notes: integer
(int64)
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 -
OverloadPercent: number
Read Only:
true
Percentage of supplier capacity overload in the supplier exception. -
PlanId: integer
Read Only:
true
Value that uniquely identifies the plan in which exception is generated. -
Planner: string
Read Only:
true
Maximum Length:10
Name of the planner associated with the item in the exception. -
PlannerDescription: string
Read Only:
true
Maximum Length:4000
Description of the planner associated with the item in the exception. -
RequiredCapacity: number
Read Only:
true
Required supplier capacity of the item supplier and supplier site combination in the supplier exception. -
Supplier: string
Title:
Supplier
Read Only:true
Maximum Length:4000
Name of the supplier in the supplier exception. -
SupplierAvailability: number
Read Only:
true
Supplier availability in the supplier exception. -
SupplierCapacityBySupplierCapacityConstraintDate: number
Read Only:
true
Supplier capacity required by date of supplier capacity constraint in the supplier exception. -
SupplierId: integer
Read Only:
true
Number that uniquely identifies the supplier in the supplier exception. -
SupplierSite: string
Title:
Supplier Site
Read Only:true
Maximum Length:4000
Name of the supplier site in the supplier exception. -
SupplierSiteId: integer
Read Only:
true
Number that uniquely identifies the supplier site in the supplier exception. -
ToDate: string
(date)
Read Only:
true
To date of the supplier capacity overload in the supplier exception.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.