Get one plan
get
/fscmRestApi/resources/11.13.18.05/backlogManagementPlans/{BmRunId}
Request
Path Parameters
-
BmRunId(required): integer
Value that uniquely identifies the backlog management plan run.
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 : backlogManagementPlans-item-response
Type:
Show Source
object
-
allocations: array
Allocations
Title:
Allocations
The Allocations resource gets supply allocation details from the backlog management plan. -
BmRunId: integer
Value that uniquely identifies the backlog management plan run.
-
demands: array
Demands
Title:
Demands
The Demands resource manages the attributes of demands within the backlog management plan. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
releases: array
Releases
Title:
Releases
The Releases resource publishes results from the backlog management plan to Oracle Order Management Cloud. -
runs: array
Runs
Title:
Runs
The Runs resource runs a backlog management plan.
Nested Schema : Allocations
Type:
array
Title:
Allocations
The Allocations resource gets supply allocation details from the backlog management plan.
Show Source
Nested Schema : Demands
Type:
array
Title:
Demands
The Demands resource manages the attributes of demands within the backlog management plan.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Releases
Type:
array
Title:
Releases
The Releases resource publishes results from the backlog management plan to Oracle Order Management Cloud.
Show Source
Nested Schema : Runs
Type:
array
Title:
Runs
The Runs resource runs a backlog management plan.
Show Source
Nested Schema : backlogManagementPlans-allocations-item-response
Type:
Show Source
object
-
AllocationDate: string
(date)
Date of the week when the supply is allocated.
-
AllocSteal: number
Read Only:
true
Quantity of the allocation that's consumed by demands at other allocation nodes. -
AllocSup: number
Read Only:
true
Quantity of the allocated supply. -
AllocUserDef: integer
Quantity of the allocated supply that's manually specified.
-
AttributeId: integer
Value that uniquely identifies the allocation level.
-
AttributeValueId: integer
Value that uniquely identifies the allocation node.
-
AvailSteal: number
Read Only:
true
Quantity of allocation that's available for consumption by other allocation nodes. -
AvailSup: number
Read Only:
true
Quantity of allocation available at the allocation node. -
BmRunId: integer
Value that uniquely identifies the backlog management plan run.
-
ConsumHistory: number
Read Only:
true
Quantity of supply consumed at an allocation node by shipped orders. -
ConsumSup: number
Read Only:
true
Quantity of allocation that's consumed at the allocation node. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the allocation entry. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the user created the allocation entry. -
CumlAvailSup: number
Read Only:
true
Quantity of cumulative allocation at the allocation node. -
ESSJobId: integer
Value that uniquely identifies the process that updates the allocation data.
-
GrossAlloc: number
Read Only:
true
Quantity of allocation at a node and all other nodes within its hierarchy. -
GrossAllocSteal: number
Read Only:
true
Quantity of allocation that was at a node and all other nodes within its hierarchy. -
GrossAvail: number
Read Only:
true
Quantity of allocation available at a node and all other nodes within its hierarchy. -
GrossConsum: number
Read Only:
true
Quantity of allocation consumed at a node and all other nodes within its hierarchy. -
GrossConsumHistory: number
Read Only:
true
Quantity of allocation consumed by shipped orders at a node and all other nodes within its hierarchy. -
GrossCumlAvail: number
Read Only:
true
Quantity of cumulative allocation available at a node and all other nodes within its hierarchy. -
GrossSup: number
Read Only:
true
Quantity that's the sum of the supply in a week across all allocation nodes and the supply consumed by the shipped sales orders across all allocation nodes. -
InventoryItemId: integer
Value that uniquely identifies the item for which the allocation data is requested.
-
InventoryItemName: string
Maximum Length:
255
Name of the item for which allocation data is requested. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the user most recently updated the allocation record. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the allocation record. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
Login that the user used when updating the allocation record. -
Level1AttributeName: string
Maximum Length:
255
Name of the top hierarchical allocation level in the allocation hierarchy. -
Level1AttributeValName: string
Maximum Length:
255
Name of the top hierarchical allocation level value in the allocation hierarchy. -
Level1AttributeValueId: integer
Value that uniquely identifies the top hierarchical allocation level in the allocation hierarchy.
-
Level2AttributeName: string
Maximum Length:
255
Name of the intermediate hierarchical allocation level in the allocation hierarchy. -
Level2AttributeValName: string
Maximum Length:
255
Name of the intermediate hierarchical allocation level value in the allocation hierarchy. -
Level2AttributeValueId: integer
Value that uniquely identifies the intermediate hierarchical allocation level in the allocation hierarchy.
-
Level3AttributeName: string
Maximum Length:
255
Name of the lowest hierarchical allocation level in the allocation hierarchy. -
Level3AttributeValName: string
Maximum Length:
255
Name of the lowest hierarchical allocation level value in the allocation hierarchy. -
Level3AttributeValueId: integer
Value that uniquely identifies the lowest hierarchical allocation level in the allocation hierarchy.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Message: string
Message that indicates the success or failure of the bulk allocation upload.
-
NetWeekSup: number
Read Only:
true
Quantity of overall supply for an item and organization in a week. -
OrganizationCode: string
Maximum Length:
255
Abbreviation that identifies the organization for which the allocation data is requested. -
OrganizationId: integer
Value that uniquely identifies the organization for which the allocation data is requested.
-
OrganizationName: string
Maximum Length:
255
Name of the organization for which the allocation data is requested. -
UpdateAsync: string
(byte)
Encoded allocation data when updating the allocation data using bulk update.
-
UpdateMode: string
Mode that indicates whether the allocation data is updated using the bulk update process or not.
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.
Nested Schema : backlogManagementPlans-demands-item-response
Type:
Show Source
object
-
AllowSplitsIndicator: integer
Read Only:
true
Value that indicates whether the demand can be split for fulfillment or not. -
ArrivalSetName: string
Maximum Length:
30
Value that uniquely identifies the fulfillment line arrival set. -
BmRunId: integer
Read Only:
true
Value that uniquely identifies the backlog management plan run. -
CarrierId: integer
(int64)
Value that uniquely identifies the carrier from the ship-from organization to the customer ship-to site that you enter on the fulfillment line.
-
CarrierName: string
Maximum Length:
255
Value that identifies the carrier from the source inventory organization to destination inventory organization that you enter on the fulfillment line. -
ConfiguredItem: string
Maximum Length:
1200
Value that identifies the unique configuration item corresponding to the configuration sent for promising. This attribute is applicable only in the case of assemble to order demands. -
ConstraintRank: integer
Read Only:
true
Value that identifies the item constraint ranking based on the difference between their respective item availability dates and requested dates. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the demand. -
CreationDate: string
(date-time)
Read Only:
true
Date when the user created the demand. -
CustomerId: integer
(int64)
Value that uniquely identifies the customer on the demand.
-
CustomerName: string
Maximum Length:
255
Name of the customer on the demand. -
CustomerPurchOrderLineNumber: string
Maximum Length:
50
Number that identifies the purchase order line that's reserved against the drop ship sales order. This attribute is for future use. -
CustomerPurchOrderNumber: string
Maximum Length:
240
Number that identifies the purchase order that's reserved against the drop ship sales order. This attribute is for future use. -
CustomerPurchOrderScheduleNumber: string
Maximum Length:
50
Value that identifies the purchase order schedule that's reserved against the drop ship sales order. This attribute is for future use. -
CustomerSiteId: integer
(int64)
Value that uniquely identifies the customer site of the demand.
-
CustomerSiteName: string
Maximum Length:
255
Name of the customer site on the demand. -
DaysPotentiallyImprove: integer
Read Only:
true
Value that identifies the number of days by which the planned date will improve if all items with a constraint rank higher than or equal to this item's constraint rank are removed. -
DemandClass: string
Maximum Length:
34
Name of the demand class on the demand. -
DemandFulfillmentLeadTime: integer
Value that indicates the delivery lead time that you enter on the fulfillment line.
-
DemandId: integer
Value that uniquely identifies a demand within a backlog management plan run.
-
DemandLeadTimeDate: string
(date)
Date that corresponds to the lead time available to fulfill the demand.
-
DemandPriority: integer
Priority of a demand within the backlog management plan run.
-
DemandQuantity: number
Read Only:
true
Quantity of the demand fulfilled in the split demand. -
EarliestAcceptableDate: string
(date)
Earliest date that's acceptable on the fulfillment line.
-
EarliestPromisedDate: string
(date)
Date when the item can be available.
-
EccIndicator: integer
Contains one of the following values: Yes or No. If Yes, then the existing scheduled information on the demand must be respected when planning the demand. If No, then the existing commitments can be ignored. The default value is Yes.
-
ErrorText: string
Read Only:
true
Maximum Length:255
Textual description for an error that the backlog planner encountered while planning for a demand line. -
ESSJobId: integer
Value that uniquely identifies the process that updates the demand attribute's data.
-
ExpectedArrivalDate: string
(date)
Date when the requested item line is expected to arrive at the customer ship-to site from the ship-from organization.
-
ExpectedCarrierId: integer
(int64)
Value that uniquely identifies the planned carrier from the ship-from organization to the customer ship-to site that you enter on the fulfillment line.
-
ExpectedCarrierName: string
Maximum Length:
255
Value that identifies the planned carrier from the ship-from organization to the customer ship-to site that you enter on the fulfillment line. -
ExpectedModeOfTransport: integer
(int64)
Value that uniquely identifies the planned transport mode from the source inventory organization to destination inventory organization that you enter on the fulfillment line.
-
ExpectedModeOfTransportName: string
Maximum Length:
255
Value that identifies the planned transport mode from the source inventory organization to destination inventory organization that you enter on the fulfillment line. -
ExpectedServiceLevel: integer
(int64)
Value that uniquely identifies the planned service level used for shipping from the ship-from organization to the customer ship-to site that you enter on the fulfillment line.
-
ExpectedServiceLevelName: string
Maximum Length:
255
Value that identifies the planned service level used for shipping from the ship-from organization to the customer ship-to site that you enter on the fulfillment line. -
ExpectedShipDate: string
(date)
Date when the requested item line is expected to be shipped from the ship-from organization to the customer ship-to site.
-
ExpectedShipMethod: string
Maximum Length:
30
Value that identifies the planned shipping method from the ship-from organization to the customer ship-to site that you enter on the fulfillment line. -
ExpectedSupplierId: integer
(int64)
Value that identifies the drop ship supplier from where material is to be shipped to the customer ship-to site.
-
ExpectedSupplierName: string
Maximum Length:
255
Name of the planned drop ship supplier from where material is to be shipped to the customer ship-to site. -
ExpectedSupplierSiteId: integer
(int64)
Value that identifies the drop ship supplier site from where material is to be shipped to the customer ship-to site.
-
ExpectedSupplierSiteName: string
Maximum Length:
255
Name of the planned drop ship supplier site from where material is to be shipped to the customer ship-to site. -
FirmArrivalSetName: string
Maximum Length:
30
Value that indicates the user-specified arrival set on the demand. -
FirmOrganizationName: string
Maximum Length:
255
Name of the user-specified organization from which the item will be planned. -
FirmSalesOrder: integer
Value that indicates whether a demand has been locked or not.
-
FirmShipFromOrg: integer
(int64)
Value that indicates the user-specified organization on the demand.
-
FirmShipSetName: string
Maximum Length:
30
Value that indicates the user-specified shipment set on the demand. -
FulfillmentLineNumber: integer
Number that uniquely identifies the fulfillment line.
-
InventoryItemId: integer
Value that uniquely identifies the item that's requested on the demand.
-
InventoryItemName: string
Maximum Length:
255
Name of the item requested on the demand. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date when the user most recently updated the demand. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the demand. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
Login that the user used when updating the demand. -
LatestAcceptableDate: string
(date)
Last date that's acceptable on the fulfillment line.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ManualOverrideIndicator: integer
(int32)
Value that indicates whether the planned information on the demand has been manually overridden.
-
MarkedForRelease: integer
(int32)
Value that indicates whether the demand has been identified for release to order management.
-
Message: string
Maximum Length:
255
Message that indicates the success or failure of the bulk upload of the demand attributes. -
ModeOfTransport: integer
(int64)
Value that uniquely identifies the transport mode from the source inventory organization to destination inventory organization that you enter on the fulfillment line.
-
ModeOfTransportName: string
Maximum Length:
255
Value that identifies the transport mode from the source inventory organization to destination inventory organization that you enter on the fulfillment line. -
NewPromisedDate: string
(date)
Date when the demand is planned in the backlog management plan.
-
OldPromisedDate: string
(date)
Date when the demand was originally scheduled.
-
OrchOrderLineNumber: string
Maximum Length:
50
Number that uniquely identifies the orchestration line in Oracle Order Management Cloud for a demand. -
OrchOrderNumber: string
Maximum Length:
50
Number that uniquely identifies the orchestration in Oracle Order Management Cloud for a demand. -
OrderDateTypeCode: integer
Value that indicates whether the request is the arrival date or ship date type. Depending on the request type, the requested date represents the requested ship date and requested arrival date respectively.
-
OrderLineStatus: number
Read Only:
true
Status of the sales order line that indicates whether an order is in picked, shipped, or in any other status. The order lines that are in the picked, shipped, or canceled status aren't released. -
OrderNumber: string
Maximum Length:
240
Number that uniquely identifies the sales order for which the fulfillment line is created. -
OrderRevenue: integer
Revenue from the demand.
-
OrganizationCode: string
Maximum Length:
255
Abbreviation that identifies the organization from which an item is requested. -
OrganizationId: integer
Value that uniquely identifies the organization from which an item is requested.
-
OrganizationName: string
Maximum Length:
255
Name of the organization from which an item is requested. -
OriginationType: integer
Type of demand. Values include Sales Order demand or Simulation demand.
-
OverridePriority: integer
Manually overridden priority on a demand.
-
ParentFulfillmentLine: string
Maximum Length:
400
Value that uniquely identifies the fulfillment line for the immediate parent item in a configure-to-order item structure. -
PlannedDateWithoutItem: string
(date)
Read Only:
true
Date when the configure to order item order or set order can be fulfilled, if all items with a constraint rank higher than or equal to this item's constraint rank are removed. -
PromisedQuantity: integer
Quantity planned in case a demand is partially fulfilled.
-
PullInIndicator: integer
Contains one of the following values: Yes or No. If Yes, then the order can be planned earlier than its current Scheduled date until its Requested Date. If No, then the order can't be planned earlier than its existing Scheduled Date. The default value is Yes.
-
ReasonCode: integer
Value that indicates the reason why the demand wasn't planned.
-
ReleaseStatus: integer
Value that indicates the release status. Values include Release, Released, Marked for Release, or blank. If Release, then the demand is eligible for release to the order management application. If Marked for Release, then the demand has been confirmed to be released to the order management application. If Released, then the line has already been released to order management.
-
RequestedDate: string
(date)
Date when the material is requested to be available. Depending on the order date type code this attribute represents the requested ship date or the requested arrival date.
-
RequestedDateQuantity: integer
Quantity available on the requested date.
-
RootFulfillmentLine: string
Maximum Length:
400
Value that uniquely identifies the fulfillment line for the end item in a configure-to-order item structure. -
SalesOrderNumber: string
Read Only:
true
Maximum Length:240
Number that uniquely identifies the sales order for the demand. -
ServiceLevel: integer
(int64)
Value that uniquely identifies the service level used for shipping from the ship-from organization to the customer ship-to site that you enter on the fulfillment line.
-
ServiceLevelName: string
Maximum Length:
255
Value that identifies the service level used for shipping from the ship-from organization to the customer ship-to site that you enter on the fulfillment line. -
ShipMethod: string
Maximum Length:
30
Shipping method used to ship the requested item line from the ship-from organization to the customer ship-to site. -
ShipSetName: string
Maximum Length:
30
Value that uniquely identifies the fulfillment line shipment set. -
SoLineNumber: string
Read Only:
true
Maximum Length:150
Number that uniquely identifies the sales order line for the demand. -
SourceOrganizationCode: string
Maximum Length:
255
Abbreviation that identifies the source organization from which an item is planned. -
SourceOrganizationId: integer
Value that uniquely identifies the source organization on the demand.
-
SourceOrganizationName: string
Maximum Length:
255
Name of the source organization from which an item is requested. -
SplitFromDemandId: integer
(int64)
Value that uniquely identifies the demand from which the current demand was split for fulfillment.
-
SupplierId: integer
(int64)
Value that uniquely identifies the drop ship supplier from where material is to be shipped to the customer ship-to site.
-
SupplierName: string
Maximum Length:
255
Name of the drop ship supplier from where material is to be shipped to the customer ship-to site. -
SupplierSiteId: integer
(int64)
Value that uniquely identifies the drop ship supplier site from where material is to be shipped to the customer ship-to site.
-
SupplierSiteName: string
Maximum Length:
255
Name of the drop ship supplier site from where material is to be shipped to the customer ship-to site. -
SupplyPickDate: string
(date)
Date to pick and pack the item that's to be shipped from the warehouse.
-
UpdateAsync: string
(byte)
Encoded demand data used when updating the demand attribute's data in bulk.
-
UpdateMode: string
Maximum Length:
255
Mode that indicates whether the demand attribute's data is updated using the bulk update process. -
UserDefinedPriority: string
Read Only:
true
Maximum Length:100
Priority of a demand defined on the order line, collected either from Oracle Fusion Cloud Order Management or from an external source and shown in the backlog management plan.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : backlogManagementPlans-releases-item-response
Type:
Show Source
object
-
BmRunId: integer
(int64)
Value that uniquely identifies the backlog management run from which releases are made to order management.
-
Category: string
Item category whose demands need to be released.
-
CreatedBy: string
Maximum Length:
64
Name of the user who initiated the release process. -
CreationDate: string
(date-time)
Date when the user initiated the release process.
-
Customer: string
Customer whose demands need to be released.
-
Item: string
Item whose demands need to be released.
-
LastUpdateDate: string
(date-time)
Date when the user most recently updated the backlog management release process data.
-
LastUpdatedBy: string
Maximum Length:
64
User who most recently updated the backlog management release process data. -
LastUpdateLogin: string
Maximum Length:
32
Login of the user who most recently updated the backlog management release process data. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Organization: string
Organization from which demands need to be released.
-
ProcessId: integer
(int64)
Value that uniquely identifies the process that releases demands from backlog management to order management.
-
Status: number
Status of the release process. Valid values are 0 for failure and 1 for success.
-
StepSequence: number
Sequence number within the technical release process.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : backlogManagementPlans-runs-item-response
Type:
Show Source
object
-
BmRunId: integer
(int64)
Value that uniquely identifies the backlog management plan run.
-
Category: string
Item category whose demands must be planned.
-
CreatedBy: string
Maximum Length:
64
User who created the backlog management plan run. -
CreationDate: string
(date-time)
Date when the user created the demand.
-
Customer: string
Customer whose demands must be planned.
-
DemandPriorityRule: string
Demand priority rule used by the backlog management plan run.
-
ExecutionId: integer
(int64)
Value that uniquely identifies the process of the backlog management run.
-
InstanceCode: string
Maximum Length:
255
Value that uniquely identifies the application instance or the source system code for which the backlog plan is run. -
Item: string
Item whose demands must be planned.
-
LastUpdateDate: string
(date-time)
Date when the user most recently updated the data within the backlog management plan run.
-
LastUpdatedBy: string
Maximum Length:
64
User who most recently updated the data in the backlog management plan run. -
LastUpdateLogin: string
Maximum Length:
32
Login of the user who most recently updated the backlog management plan run. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Organization: string
Organization whose demands must be planned.
-
PercentageCompleted: integer
Percent completion of the backlog management plan run.
-
RefreshSupplyChainData: string
Value that indicates whether relationships between items must be determined. Valid values include True to indicate that relationships must be recalculated and False to indicate they should not be.
-
Status: integer
Status of the backlog management plan run. Valid values include 1 for success and 2 for failure.
-
Step: integer
Value that identifies the step of the backlog management plan run. There are 10 steps.
-
StepSequence: integer
Step of the backlog management plan run that has been completed.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- allocations
-
Parameters:
- BmRunId:
$request.path.BmRunId
The Allocations resource gets supply allocation details from the backlog management plan. - BmRunId:
- demands
-
Parameters:
- BmRunId:
$request.path.BmRunId
The Demands resource manages the attributes of demands within the backlog management plan. - BmRunId:
- releases
-
Parameters:
- BmRunId:
$request.path.BmRunId
The Releases resource publishes results from the backlog management plan to Oracle Order Management Cloud. - BmRunId:
- runs
-
Parameters:
- BmRunId:
$request.path.BmRunId
The Runs resource runs a backlog management plan. - BmRunId:
Examples
This example describes how to get one plan from the backlog management plan.
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/backlogManagementPlans/BmRunId"
For example:
curl -u username:password "https://servername/fscmRestApi/resources/version/backlogManagementPlans/-1"
Example Response Body
The following example includes the contents of the response
body in JSON format:
{ "BmRunId": -1, "links": [ { "rel": "self", "href": "https//servername/fscmRestApi/resources/version/backlogManagementPlans/-1", "name": "backlogManagementPlans", "kind": "item" }, { "rel": "canonical", "href": "https//servername/fscmRestApi/resources/version/backlogManagementPlans/-1", "name": "backlogManagementPlans", "kind": "item" }, { "rel": "child", "href": "https//servername/fscmRestApi/resources/version/backlogManagementPlans/-1/child/allocations", "name": "allocations", "kind": "collection" }, { "rel": "child", "href": "https//servername/fscmRestApi/resources/version/backlogManagementPlans/-1/child/demands", "name": "demands", "kind": "collection" }, { "rel": "child", "href": "https//servername/fscmRestApi/resources/version/backlogManagementPlans/-1/child/releases", "name": "releases", "kind": "collection" }, { "rel": "child", "href": "https//servername/fscmRestApi/resources/version/backlogManagementPlans/-1/child/runs", "name": "runs", "kind": "collection" } ] }