1. REST API for Oracle Fusion Cloud SCM
  2. Tasks
  3. Supply Chain Planning
  4. Allocation Scenarios

Get all allocation scenarios

get

/fscmRestApi/resources/11.13.18.05/bmAllocationScenarios

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 an allocation scenario according to the scenario identifier.
      Finder Variables
      • ScenarioId; integer; Update one allocation scenario
  • 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:
    • AllocMeasures; string; Value that uniquely identifies an allocation scenario.
    • AttributeNamesList; string; List of attributes names in an allocation scenario.
    • AttributeValueIds; string; Unique identifier of attribute values in an allocation scenario.
    • AttributeValueNamesList; string; List of value of the attributes used in an allocation scenario.
    • CreatedBy; string; Name of the user who created the allocation scenario.
    • CreationDate; string; Date when the user created the allocation scenario.
    • DefaultCode; integer; Value to indicate if the allocation scenario is default or not. The value 1 indicates that the allocation scenario is default and 2 or 0 indicate that the allocation scenario isn't a default scenario.
    • Description; string; Description of an allocation scenario.
    • IncludeChildLevel; integer; Value to indicate if the calculated demand metrics at a parent allocation node need to consider the demands at the child node also. The value 1 indicates that demand at the child nodes will be considered and the value 2 or 0 indicate that demand at the child nodes won't be considered.
    • InventoryItemId; number; Unique identifier of an inventory item specified in an allocation scenario.
    • ItemIds; string; Unique identifier of the items specified in an allocation scenario.
    • ItemNames; string; Names of the items specified in an allocation scenario.
    • LastUpdateDate; string; Date when the user most recently updated the allocation scenario.
    • LastUpdateLogin; string; Sign in of the user who most recently updated an allocation scenario.
    • LastUpdatedBy; string; User who most recently updated an allocation scenario.
    • Message; string; Message that indicates if the allocation scenario was successfully created.
    • MetricMeasures; string; Measures that are part of the demand satisfaction metrics in an allocation.
    • Name; string; Name of an allocation scenario.
    • NumberOfBuckets; integer; Number of buckets specified in an allocation scenario.
    • ObjectVersionNumber; integer; Value to indicate the changed version of an allocation scenario for every edit and save made by the user.
    • OrganizationCodes; string; Code of the organizations specified in an allocation scenario.
    • OrganizationIdList; string; List of the organization identifier specified in an allocation scenario.
    • OwnedBy; string; Name of the user who owns the allocation scenario.
    • ScenarioId; integer; Unique identifier of an allocation scenario.
    • StartDate; string; Date when an allocation scenario starts.
  • 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 : bmAllocationScenarios
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : bmAllocationScenarios-item-response
Type: object
Show Source
Back to Top

Examples

This example describes how to get all allocation scenarios.

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/bmAllocationScenarios"

Example Response Body

The following example includes the contents of the response body in JSON format:
{
    "items": [
        {
            "AllocMeasures": "ALLOC_SUP,CONSUM_SUP,AVAIL_SUP,GROSS_ALLOC_STEAL,AVAIL_STEAL,ALLOC_STEAL",
            "AttributeValueIds": "300100544207360:8394830,300100544207361:8395994,300100544207363:8395967,300100544207363:8395968,300100544207361:8395998,300100544207363:8395977,300100544207363:8395978",
            "CreatedBy": "BLM_ALL",
            "CreationDate": "2025-03-28T10:35:11+00:00",
            "DefaultCode": 0,
            "Description": null,
            "IncludeChildLevel": null,
            "InventoryItemId": 26921945,
            "ItemIds": "26921945,26921946,26921947",
            "LastUpdateDate": "2025-03-28T10:37:35.032+00:00",
            "LastUpdateLogin": "308A20BB33CABD69E0632B15060AF381",
            "LastUpdatedBy": "BLM_ALL",
            "MetricMeasures": "DMD_QTY,DMD_QTY_ON_TIME,PLN_FILL_PER",
            "Name": "Ankush1234",
            "NumberOfBuckets": 8,
            "ObjectVersionNumber": 1,
            "OrganizationIdList": "45635",
            "OwnedBy": "BLM_ALL",
            "ScenarioId": 300100646500825,
            "StartDate": "2030-01-07",
            "AttributeNamesList": "BLM-All,BLM-CustParentGrp,BLM-CustGrp,BLM-CustGrp,BLM-CustParentGrp,BLM-CustGrp,BLM-CustGrp",
            "AttributeValueNamesList": "ALL,BLM-North,BLM-NorthEast,BLM-NorthWest,BLM-South,BLM-SouthEast,BLM-SouthWest",
            "Message": null,
            "ItemNames": "BLM-ALLOC-RT-ARR-ST-ITEMA,BLM-ALLOC-RT-ARR-ST-ITEMB,BLM-ALLOC-RT-ARR-ST-ITEMC",
            "OrganizationCodes": "BLM:BLM_M9",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/bmAllocationScenarios/300100646500825",
                    "name": "bmAllocationScenarios",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/bmAllocationScenarios/300100646500825",
                    "name": "bmAllocationScenarios",
                    "kind": "item"
                }
            ]
        },
        {
            "AllocMeasures": "ALLOC_SUP,CONSUM_SUP,AVAIL_SUP",
            "AttributeValueIds": "300100544207360:8394830",
            "CreatedBy": "BLM_ALL",
            "CreationDate": "2025-03-19T07:06:28+00:00",
            "DefaultCode": 0,
            "Description": null,
            "IncludeChildLevel": 2,
            "InventoryItemId": 26921942,
            "ItemIds": "26921942",
            "LastUpdateDate": "2025-03-19T07:06:28.005+00:00",
            "LastUpdateLogin": "308A31FAFBCC6098E063C55B060A2219",
            "LastUpdatedBy": "BLM_ALL",
            "MetricMeasures": "DMD_QTY,DMD_QTY_ON_TIME,PLN_FILL_PER",
            "Name": "KP",
            "NumberOfBuckets": null,
            "ObjectVersionNumber": 1,
            "OrganizationIdList": "58633",
            "OwnedBy": "BLM_ALL",
            "ScenarioId": 300100639781206,
            "StartDate": null,
            "AttributeNamesList": "BLM-All",
            "AttributeValueNamesList": "ALL",
            "Message": null,
            "ItemNames": "BLM-ALLOC-RES-B2B-Buy",
            "OrganizationCodes": "BLM:BLM_DSHIP",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/bmAllocationScenarios/300100639781206",
                    "name": "bmAllocationScenarios",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/bmAllocationScenarios/300100639781206",
                    "name": "bmAllocationScenarios",
                    "kind": "item"
                }
            ]
        }
    ],
    "count": 2,
    "hasMore": true,
    "limit": 2,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/bmAllocationScenarios",
            "name": "bmAllocationScenarios",
            "kind": "collection"
        }
    ]
}
Back to Top