Get one backlog planning option
get
/fscmRestApi/resources/11.13.18.05/backlogPlanningOptions/{ConfigurationId}
Request
Path Parameters
-
ConfigurationId(required): integer(int64)
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 -
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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 : backlogPlanningOptions-item-response
Type:
Show Source
object
-
BucketsPerHorizon: integer
(int64)
Title:
Planning Horizon in Days
Value that specifies the number of days over which demand is considered by backlog plan. -
CalculateConstraint: integer
Title:
Display constraints for configure-to-order items, shipment sets, and arrival sets
Value that indicates whether the constraints for configure-to-order and sets order will be calculated by the backlog plan. -
CategorySetId: integer
Value that uniquely identifies the category set.
-
CategorySetName: string
Title:
Category Set
Read Only:true
Maximum Length:255
Name of the category set specified in backlog planning option. -
ConfigurationId: integer
(int64)
Value that uniquely identifies the backlog plan run.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
Name of the user who initially created the backlog planning options. -
CreationDate: string
(date-time)
Read Only:
true
Date when user created the backlog planning options. -
DaysPastdue: integer
Title:
Past-Due Supply and Demand Considered in Days
Value that determines which past due supplies and demands are considered in the backlog plan. -
DefaultAssignmentSetId: integer
Value that uniquely identifies the assignment set.
-
DefaultAssignmentSetName: string
Title:
Assignment Set Name
Maximum Length:255
Name of the assignment set used. -
DefaultPriorityRuleId: integer
Value that uniquely identifies the demand priority rule.
-
DefaultPriorityRuleName: string
Title:
Demand Priority Rule
Maximum Length:255
Name of the default priority rule that's used in planning demands in backlog management. -
DemFulfilLeadTime: integer
Title:
Default Demand Fulfillment Lead Time in Days
Value that specifies the default lead time that's used to determine the fulfillment lead time date on demands. -
HorizonStart: string
(date-time)
Title:
Horizon Start Date
Date that signifies the start of the planning horizon and is typically defaulted to the system date. -
LastBaselineHorizonStart: string
(date-time)
Date that indicates the start of planning horizon for previous base line plan run.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Message: string
Maximum Length:
255
Text of the error message, if any, encountered when creating or updating the backlog planning options. -
SupplyPlan: string
Title:
Supply Plans
Maximum Length:4000
Values of the supply plan unique identifiers or the plan ID that are used as supply schedules in backlog management. -
SupplyPlanName: string
Maximum Length:
255
Names of the supply plans that are used as supply schedules in backlog management.
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.
Examples
This example describes how to get one backlog planning option.
Example cURL Command
Use the following cURL command to submit a request on the REST resource:
curl -u username:password "https://servername/fscmRestApi/resources/version/backlogPlanningOptions/ConfigurationId"
For example:
curl -u username:password "https://servername/fscmRestApi/resources/version/backlogPlanningOptions/-1"
Example Response Body
The following example includes the contents of the response body
in JSON format:
{ "BucketsPerHorizon": 366, "CalculateConstraint": 1, "CategorySetId": 10154, "ConfigurationId": -1, "CreatedBy": "BLM_ALL", "CreationDate": "2019-03-27T09:14:04+00:00", "DaysPastdue": 10, "DefaultAssignmentSetId": 100000012037099, "DefaultPriorityRuleId": 300100178581705, "DemFulfilLeadTime": 10, "HorizonStart": null, "LastBaselineHorizonStart": null, "SupplyPlan": "300100550649238", "SupplyPlanName": "BLM_RT-SP-INT", "DefaultAssignmentSetName": "BLM_ASET_DEFAULT", "DefaultPriorityRuleName": "Default_reqdate_revenue", "CategorySetName": "GOP_Catalog", "Message": null, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/backlogPlanningOptions/-1", "name": "backlogPlanningOptions", "kind": "item" }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/backlogPlanningOptions/-1", "name": "backlogPlanningOptions", "kind": "item" } ] }