1. REST API for Oracle Fusion Cloud SCM
  2. Tasks
  3. Supply Chain Planning
  4. Supply Chain Plans
  5. Planning Tables
  6. Planning Table Data

Get one data

get

/fscmRestApi/resources/11.13.18.05/supplyChainPlans/{PlanId}/child/PlanningTables/{TableId}/child/Data/{Filter}

Request

Path Parameters
  • 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=
  • 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=
  • 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
  • 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>
  • 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
  • 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
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
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 : supplyChainPlans-PlanningTables-Data-item-response
Type: object
Show Source
  • Value that uniquely identifies the scheduled process for update. This attribute is used only for the POST operation and only when the UpdateMode is Batch.
  • Value that uniquely identifies a set of filter criteria. The filter criteria is used for both query and update of pivot table data. The filter criteria is expressed as a base-64 encoded string of filter conditions using any level members of the pivot table.
  • Links
  • Text of the error message from the table query.
  • Status of the POST Data API query. Contains one of the following values. 0: success, 1: warning, or 2: error.
  • Hierarchy members and measure values that the pivot table contains. The text separates each unique combination of hierarchy member and measure values, and a comma separates each measure value.
  • List of hierarchy level names and the list of measure names that the pivot table contains. A comma separates each value.
  • Names of the hierarchies that the pivot table contains. A comma separates each value.
  • Read Only: true
    Value that uniquely identifies the pivot table.
  • Method used to update the data. Valid values are Interactive and Batch. The default value is Interactive. In the interactive mode, the POST operation is performed synchronously and in batch mode, it's performed asynchronously using a scheduled process. The scheduled process job identifier is returned in the response message. This attribute isn't used in the GET operation.
Back to Top

Examples

Example cURL Command

Include the encoded filter in the cURL command as shown:

curl -u username:password "https://servername/fscmRestApi/resources/version/supplyChainPlans/PlanId/child/PlanningTables/TableId/child/Data/Filter

For example:

curl -u username:password "https://servername/fscmRestApi/resources/version/supplyChainPlans/300100543820864/child/PlanningTables/1001/child/Data?finder=FindByFilter;Filter="WwogICAgeyJMZXZlbCI6Ikl0ZW0iLCAiVmFsdWUiOlsiS0ItQVM2NTEwMSIsIktCLUhERzEyMCJdfSwKICAgIHsiTGV2ZWwiOiJPcmdhbml6YXRpb24iLCAiVmFsdWUiOlsiTTEiLCJNMiJdfQpd"

Example Response Body

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

{
    "items": [
        {
            "TableId": 1001,
            "TableHierarchies": "Product,Enterprise,APS Calendar,APS Calendar",
            "TableDataHeader": "Item,Organization,Period,Week,Net Forecast,Sales Orders,Manual Demand,Total Demand,On Hand,In Transit,Planned Orders,Purchase Orders,Work Orders,Transfer Orders,Purchase Requisitions,Scheduled Receipts,Total Supply,Projected On Hand,Projected Available Balance",
            "TableData": "KB-HDG120,M1,2029-12-10,2029-12-31,,,,80,,,111,,,,,,,-80,-80\r\nKB-HDG120,M1,2030-01-07,2030-01-07,,,,,,,122,,,,,,9000,-80,8920\r\nKB-HDG120,M1,2030-01-07,2030-01-14,,,,,,,,,,,,,,-80,8920\r\nKB-HDG120,M1,2030-01-07,2030-01-21,,,,,,,,,,,,,,-80,8920\r\nKB-HDG120,M1,2030-01-07,2030-01-28,,,,,,,,,,,,,,-80,8920\r\nKB-HDG120,M1,2030-02-04,2030-02-04,,,,,,,,,,,,,,-80,8920\r\nKB-HDG120,M1,2030-02-04,2030-02-11,,,,,,,,,,,,,,-80,8920\r\nKB-HDG120,M1,2030-02-04,2030-02-18,,,,,,,,,,,,,,-80,8920\r\nKB-HDG120,M1,2030-02-04,2030-02-25,,,,,,,,,,,,,,-80,8920\r\nKB-HDG120,M1,2030-02-04,2030-03-04,,,,,,,,,,,,,,-80,8920\r\nKB-AS65101,M1,2029-12-10,2029-12-31,,20,,20,20,,,,,,,80,20,80,0\r\nKB-AS65101,M1,2030-01-07,2030-01-07,450.77,30,,480.77,,,401,,80,,,,481,-400.77,.23\r\nKB-AS65101,M1,2030-01-07,2030-01-14,525.9,,,525.9,,,526,,,,,,526,-926.67,.33\r\nKB-AS65101,M1,2030-01-07,2030-01-21,525.9,,,525.9,,,526,,,,,,526,-1452.57,.43\r\nKB-AS65101,M1,2030-01-07,2030-01-28,525.9,,,525.9,,,526,,,,,,526,-1978.47,.53\r\nKB-AS65101,M1,2030-02-04,2030-02-04,546.88,,,546.88,,,547,,,,,,547,-2525.35,.65\r\nKB-AS65101,M1,2030-02-04,2030-02-11,546.88,,,546.88,,,547,,,,,,547,-3072.24,.76\r\nKB-AS65101,M1,2030-02-04,2030-02-18,546.88,,,546.88,,,547,,,,,,547,-3619.12,.88\r\nKB-AS65101,M1,2030-02-04,2030-02-25,546.88,,,546.88,,,547,,,,,,547,-4166,1\r\nKB-AS65101,M1,2030-02-04,2030-03-04,78.13,,,78.13,,,78,,,,,,78,-4244.13,.87\r\n",
            "Message": null,
            "UpdateMode": null,
            "ESSJobId": null,
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/supplyChainPlans/300100543820864/child/PlanningTables/1001/child/Data/WwogICAgeyJMZXZlbCI6Ikl0ZW0iLCAiVmFsdWUiOlsiS0ItQVM2NTEwMSIsIktCLUhERzEyMCJdfSwKICAgIHsiTGV2ZWwiOiJPcmdhbml6YXRpb24iLCAiVmFsdWUiOlsiTTEiLCJNMiJdfQpd",
                    "name": "Data",
                    "kind": "item"
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/supplyChainPlans/300100543820864/child/PlanningTables/1001/child/Data/WwogICAgeyJMZXZlbCI6Ikl0ZW0iLCAiVmFsdWUiOlsiS0ItQVM2NTEwMSIsIktCLUhERzEyMCJdfSwKICAgIHsiTGV2ZWwiOiJPcmdhbml6YXRpb24iLCAiVmFsdWUiOlsiTTEiLCJNMiJdfQpd",
                    "name": "Data",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername/fscmRestApi/resources/version/supplyChainPlans/300100543820864/child/PlanningTables/1001",
                    "name": "PlanningTables",
                    "kind": "item"
                },
                {
                    "rel": "enclosure",
                    "href": "https://servername/fscmRestApi/resources/version/supplyChainPlans/300100543820864/child/PlanningTables/1001/child/Data/WwogICAgeyJMZXZlbCI6Ikl0ZW0iLCAiVmFsdWUiOlsiS0ItQVM2NTEwMSIsIktCLUhERzEyMCJdfSwKICAgIHsiTGV2ZWwiOiJPcmdhbml6YXRpb24iLCAiVmFsdWUiOlsiTTEiLCJNMiJdfQpd/enclosure/Filter",
                    "name": "Filter",
                    "kind": "other"
                }
            ]
        }
    ],
    "count": 1,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/supplyChainPlans/300100543820864/child/PlanningTables/1001/child/Data",
            "name": "Data",
            "kind": "collection"
        }
    ]
}

Example 2: Using Filters

This example describes how to get one data subset using filters.

You can apply filters to retrieve a subset of data from a planning table. The structure of the filter is as follows:
 [
{"Level":<level-name1>,"Value":[value1, value2]},
{"Level":"<level-name2>,"Value":[value3, value4]},
...
]

For example, let's say you want to filter the Material Plan table to bring back two items from two different organizations, your filter criteria should look something like the following:

[
    {"Level":"Item", "Value":["KB-AS65101","KB-HDG120"]},
    {"Level":"Organization", "Value":["M1","M2"]}
]

Next, you'll need to convert the filter to a base64 encoded filter. There are various tools available on the internet that will do the encoding. The encoded result using the example above will produce the following string:

WwogICAgeyJMZXZlbCI6Ikl0ZW0iLCAiVmFsdWUiOlsiS0ItQVM2NTEwMSIsIktCLUhERzEyMCJdfSwKICAgIHsiTGV2ZWwiOiJPcmdhbml6YXRpb24iLCAiVmFsdWUiOlsiTTEiLCJNMiJdfQpd

Example 2: Using Filters, Request Body

The following example includes the contents of the request body in JSON format can include the optional Filter and UpdateMode attribute. You can use Filter JSON format [{"Level":"Item", "Value":["HCOP-Cylinder-Assy2","HCOP-Bolt2"]}] for which the base64 encoded value is W3siTGV2ZWwiOiJJdGVtIiwgIlZhbHVlIjpbIkhDT1AtQ3lsaW5kZXItQXNzeTIiLCJIQ09QLUJvbHQyIl19XQ==. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it creates. 

{
	"Filter":"W3siTGV2ZWwiOiJJdGVtIiwgIlZhbHVlIjpbIkhDT1AtQ3lsaW5kZXItQXNzeTIiLCJIQ09QLUJvbHQyIl19XQ==",
	"TableHierarchies": "SCC High Tech,Enterprise,APS Calendar1,APS Calendar1",
	"TableDataHeader": "Item,Organization,Period,Week,Net Forecast,Sales Orders,Manual Demand,Total Demand,On Hand,In Transit,Planned Orders,Purchase Orders,Work Orders,Transfer Orders,Purchase Requisitions,Scheduled Receipts,Total Supply,Projected On Hand,Projected Available Balance",
	"TableData": "HCOP-Cylinder-Assy2,M1,2018-12-04,2018-12-31,182,,152,60,,,60,,,,,,60,-60,0\r\nHCOP-Cylinder-Assy1,M1,2019-05-05,2019-05-20,101,,302,,,,603,,,,,,,-1410,0\r\nHCOP-Bolt2,M1,2019-06-04,2019-06-24,104,,305,,,,606,,,,,,,-10575,0\r\n",
	"UpdateMode" :"batch"
}

Example 2: Using Filters, Response Body

The following example includes the contents of the response body in JSON format. When you use the Filter attribute, links in the response are disabled:

{
	"TableId": 1001,
	"TableHierarchies": "SCC High Tech,Enterprise,APS Calendar1,APS Calendar1",
	"TableDataHeader": "Item,Organization,Period,Week,Net Forecast,Sales Orders,Manual Demand,Total Demand,On Hand,In Transit,Planned Orders,Purchase Orders,Work Orders,Transfer Orders,Purchase Requisitions,Scheduled Receipts,Total Supply,Projected On Hand,Projected Available Balance",
	"TableData": "HCOP-Cylinder-Assy2,M1,2018-12-04,2018-12-31,182,,152,60,,,60,,,,,,60,-60,0\r\nHCOP-Cylinder-Assy1,M1,2019-05-05,2019-05-20,101,,302,,,,603,,,,,,,-1410,0\r\nHCOP-Bolt2,M1,2019-06-04,2019-06-24,104,,305,,,,606,,,,,,,-10575,0\r\n",
	"Message": "A scheduled process with process ID 302 has been submitted. Refer to the scheduled processes log file for the detailed response. (MSC-2806192)",
        "Status":null,
	"UpdateMode": "batch",
	"ESSJobId": "302",
	"links": [
	{
		"rel": "self"
	}
	]
}
Back to Top