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

Get one table

get

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

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=
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-item-response
Type: object
Show Source
Nested Schema : Planning Table Data
Type: array
Title: Planning Table Data
The Planning Table Data resource manages the data from each pivot table defined in the Oracle Supply Chain Planning Cloud applications.
Show Source
Nested 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.
Links
Data
Parameters:
  • PlanId: $request.path.PlanId
  • TableId: $request.path.TableId
The Planning Table Data resource manages the data from each pivot table defined in the Oracle Supply Chain Planning Cloud applications.
Back to Top

Examples

This example describes how to get one pivot table definition.

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/supplyChainPlans/PlanId/child/PlanningTables/TableId"

Example Response Body

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

{
    "PlanId": 300100071618784,
    "TableId": 2025,
    "TableName": "Forecast Comparison Table",
    "TableDescription": "Forecast Comparison Table"
...
}
Back to Top