1. REST API for Oracle Fusion Cloud SCM
  2. Tasks
  3. Supply Chain Planning
  4. Backlog Management Plans

Get all plans

get

/fscmRestApi/resources/11.13.18.05/backlogManagementPlans

Request

Query Parameters
  • 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).
  • 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
  • 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 backlog management plans according to the plan identifier.
      Finder Variables:
      • BmRunId; integer; Value that uniquely identifies the backlog management plan run.
  • 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.
  • 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
  • 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.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • 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
  • 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:
    • BmRunId; integer; Value that uniquely identifies the backlog management plan run.
  • 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
  • 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".
  • 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

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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 : backlogManagementPlans
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : backlogManagementPlans-item-response
Type: object
Show Source
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 : 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: object
Show Source
Nested Schema : backlogManagementPlans-demands-item-response
Type: object
Show Source
  • Read Only: true
    Value that indicates whether the demand can be split for fulfillment or not.
  • Maximum Length: 30
    Value that uniquely identifies the fulfillment line arrival set.
  • Read Only: true
    Value that uniquely identifies the backlog management plan run.
  • Value that uniquely identifies the carrier from the ship-from organization to the customer ship-to site that you enter on the fulfillment line.
  • Maximum Length: 255
    Value that identifies the carrier from the source inventory organization to destination inventory organization that you enter on the fulfillment line.
  • 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.
  • Read Only: true
    Value that identifies the item constraint ranking based on the difference between their respective item availability dates and requested dates.
  • Read Only: true
    Maximum Length: 64
    User who created the demand.
  • Read Only: true
    Date when the user created the demand.
  • Value that uniquely identifies the customer on the demand.
  • Maximum Length: 255
    Name of the customer on the demand.
  • 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.
  • Maximum Length: 240
    Number that identifies the purchase order that's reserved against the drop ship sales order. This attribute is for future use.
  • 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.
  • Value that uniquely identifies the customer site of the demand.
  • Maximum Length: 255
    Name of the customer site on the demand.
  • 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.
  • Maximum Length: 34
    Name of the demand class on the demand.
  • Value that indicates the delivery lead time that you enter on the fulfillment line.
  • Value that uniquely identifies a demand within a backlog management plan run.
  • Date that corresponds to the lead time available to fulfill the demand.
  • Priority of a demand within the backlog management plan run.
  • Read Only: true
    Quantity of the demand fulfilled in the split demand.
  • Earliest date that's acceptable on the fulfillment line.
  • Date when the item can be available.
  • 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.
  • Read Only: true
    Maximum Length: 255
    Textual description for an error that the backlog planner encountered while planning for a demand line.
  • Value that uniquely identifies the process that updates the demand attribute's data.
  • Date when the requested item line is expected to arrive at the customer ship-to site from the ship-from organization.
  • 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.
  • 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.
  • Value that uniquely identifies the planned transport mode from the source inventory organization to destination inventory organization that you enter on the fulfillment line.
  • 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.
  • 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.
  • 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.
  • Date when the requested item line is expected to be shipped from the ship-from organization to the customer ship-to site.
  • 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.
  • Value that identifies the drop ship supplier from where material is to be shipped to the customer ship-to site.
  • Maximum Length: 255
    Name of the planned drop ship supplier from where material is to be shipped to the customer ship-to site.
  • Value that identifies the drop ship supplier site from where material is to be shipped to the customer ship-to site.
  • Maximum Length: 255
    Name of the planned drop ship supplier site from where material is to be shipped to the customer ship-to site.
  • Maximum Length: 30
    Value that indicates the user-specified arrival set on the demand.
  • Maximum Length: 255
    Name of the user-specified organization from which the item will be planned.
  • Value that indicates whether a demand has been locked or not.
  • Value that indicates the user-specified organization on the demand.
  • Maximum Length: 30
    Value that indicates the user-specified shipment set on the demand.
  • Number that uniquely identifies the fulfillment line.
  • Value that uniquely identifies the item that's requested on the demand.
  • Maximum Length: 255
    Name of the item requested on the demand.
  • Read Only: true
    Date when the user most recently updated the demand.
  • Read Only: true
    Maximum Length: 64
    User who most recently updated the demand.
  • Read Only: true
    Maximum Length: 32
    Login that the user used when updating the demand.
  • Last date that's acceptable on the fulfillment line.
  • Links
  • Value that indicates whether the planned information on the demand has been manually overridden.
  • Value that indicates whether the demand has been identified for release to order management.
  • Maximum Length: 255
    Message that indicates the success or failure of the bulk upload of the demand attributes.
  • Value that uniquely identifies the transport mode from the source inventory organization to destination inventory organization that you enter on the fulfillment line.
  • 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.
  • Date when the demand is planned in the backlog management plan.
  • Date when the demand was originally scheduled.
  • Maximum Length: 50
    Number that uniquely identifies the orchestration line in Oracle Order Management Cloud for a demand.
  • Maximum Length: 50
    Number that uniquely identifies the orchestration in Oracle Order Management Cloud for a demand.
  • 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.
  • 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.
  • Maximum Length: 240
    Number that uniquely identifies the sales order for which the fulfillment line is created.
  • Revenue from the demand.
  • Maximum Length: 255
    Abbreviation that identifies the organization from which an item is requested.
  • Value that uniquely identifies the organization from which an item is requested.
  • Maximum Length: 255
    Name of the organization from which an item is requested.
  • Type of demand. Values include Sales Order demand or Simulation demand.
  • Manually overridden priority on a demand.
  • Maximum Length: 400
    Value that uniquely identifies the fulfillment line for the immediate parent item in a configure-to-order item structure.
  • 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.
  • Quantity planned in case a demand is partially fulfilled.
  • 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.
  • Value that indicates the reason why the demand wasn't planned.
  • Unique identifier of the demand that will be released.
  • 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.
  • 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.
  • Quantity available on the requested date.
  • Read Only: true
    Status that indicates the extent of reservation of the fulfillment line in the fulfillment system. Contains one of the following values: Yes or No. If Yes, then order line is in reserved status as it's reserved to a source of supply. If No, then the order line isn't reserved to a source of supply.
  • Maximum Length: 400
    Value that uniquely identifies the fulfillment line for the end item in a configure-to-order item structure.
  • Read Only: true
    Maximum Length: 240
    Number that uniquely identifies the sales order for the demand.
  • 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.
  • 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.
  • Maximum Length: 30
    Shipping method used to ship the requested item line from the ship-from organization to the customer ship-to site.
  • Maximum Length: 30
    Value that uniquely identifies the fulfillment line shipment set.
  • Read Only: true
    Maximum Length: 150
    Number that uniquely identifies the sales order line for the demand.
  • Read Only: true
    Maximum Length: 240
    Identifier for the order number in the source system against which the fulfillment line has been created.
  • Read Only: true
    Maximum Length: 4000
    Order type of the document in the source system against which the fulfillment line has been created. A list of accepted values is defined in the lookup type MSC_ORDER_TYPE.
  • Maximum Length: 255
    Abbreviation that identifies the source organization from which an item is planned.
  • Value that uniquely identifies the source organization on the demand.
  • Maximum Length: 255
    Name of the source organization from which an item is requested.
  • Value that uniquely identifies the demand from which the current demand was split for fulfillment.
  • Value that uniquely identifies the drop ship supplier from where material is to be shipped to the customer ship-to site.
  • Maximum Length: 255
    Name of the drop ship supplier from where material is to be shipped to the customer ship-to site.
  • Value that uniquely identifies the drop ship supplier site from where material is to be shipped to the customer ship-to site.
  • Maximum Length: 255
    Name of the drop ship supplier site from where material is to be shipped to the customer ship-to site.
  • Date to pick and pack the item that's to be shipped from the warehouse.
  • Encoded demand data used when updating the demand attribute's data in bulk.
  • Maximum Length: 255
    Mode that indicates whether the demand attribute's data is updated using the bulk update process.
  • 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 : backlogManagementPlans-releases-item-response
Type: object
Show Source
Nested Schema : backlogManagementPlans-runs-item-response
Type: object
Show Source
Back to Top

Examples

This example describes how to get all plans.

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"

Example Response Body

The following shows an example of the response body in JSON format.

{
	"items": [
	{
		"BmRunId": -1,
		"links": [
		{
			"rel": "self",
			"href": "https://servername/fscmRestApi/resources/version/backlogManagementPlans/-1",
			"name": "backlogManagementPlans",
			"kind": "item"
		},
		{
			"rel": "canonical",
			"https://servername/fscmRestApi/resources/version/backlogManagementPlans/-1",
			"name": "backlogManagementPlans",
			"kind": "item"
		},
		{
			"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"
		}
		]
	}
}
Back to Top