Jump to

• Request
• Response
• Examples

Get one table

get

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

Request

Path Parameters

• PlanId(required): integer(int64)
  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=
• TableId(required): integer(int64)
  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

• 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 Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context(required):
  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(required):
  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

• Data: array Planning Table Data
  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.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PlanId: integer
  Read Only: true

  Value that uniquely identifies the plan.
• TableDefinition: string (byte)
  Read Only: true

  Definition of the pivot table in XML format. Values include the measures, hierarchies, and levels.
• TableDescription: string
  Read Only: true

  Maximum Length: 250

  Description of the pivot table.
• TableId: integer (int64)
  Read Only: true

  Value that uniquely identifies the pivot table.
• TableName: string
  Read Only: true

  Maximum Length: 250

  Name of the pivot table.

{
    "type":"object",
    "properties":{
        "TableId":{
            "type":"integer",
            "description":"Value that uniquely identifies the pivot table.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TableName":{
            "maxLength":250,
            "type":"string",
            "description":"Name of the pivot table.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanId":{
            "type":"integer",
            "description":"Value that uniquely identifies the plan.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TableDefinition":{
            "type":"string",
            "description":"Definition of the pivot table in XML format. Values include the measures, hierarchies, and levels.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Data":{
            "title":"Planning Table Data",
            "type":"array",
            "description":"The Planning Table Data resource manages the data from each pivot table defined in the Oracle Supply Chain Planning Cloud applications.",
            "items":{
                "$ref":"#/components/schemas/supplyChainPlans-PlanningTables-Data-item-response"
            },
            "x-cardinality":"1"
        },
        "TableDescription":{
            "maxLength":250,
            "type":"string",
            "description":"Description of the pivot table.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

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

• Array of: object supplyChainPlans-PlanningTables-Data-item-response

{
    "title":"Planning Table Data",
    "type":"array",
    "description":"The Planning Table Data resource manages the data from each pivot table defined in the Oracle Supply Chain Planning Cloud applications.",
    "items":{
        "$ref":"#/components/schemas/supplyChainPlans-PlanningTables-Data-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : supplyChainPlans-PlanningTables-Data-item-response

Type: object

Show Source

• ESSJobId: integer
  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.
• Filter: string (byte)
  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: array Links
  Title: Links

  The link relations associated with the resource instance.
• Message: string
  Text of the error message from the table query.
• Status: integer (int32)
  Status of the POST Data API query. Contains one of the following values. 0: success, 1: warning, or 2: error.
• TableData: string
  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.
• TableDataHeader: string
  List of hierarchy level names and the list of measure names that the pivot table contains. A comma separates each value.
• TableHierarchies: string
  Names of the hierarchies that the pivot table contains. A comma separates each value.
• TableId: integer (int64)
  Read Only: true

  Value that uniquely identifies the pivot table.
• UpdateMode: string
  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.

{
    "type":"object",
    "properties":{
        "TableId":{
            "type":"integer",
            "description":"Value that uniquely identifies the pivot table.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Status":{
            "type":"integer",
            "description":"Status of the POST Data API query. Contains one of the following values. 0: success, 1: warning, or 2: error.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":5
            },
            "x-queryable":true
        },
        "TableHierarchies":{
            "type":"string",
            "description":"Names of the hierarchies that the pivot table contains. A comma separates each value.",
            "nullable":true,
            "x-queryable":true
        },
        "Message":{
            "type":"string",
            "description":"Text of the error message from the table query.",
            "nullable":true,
            "x-queryable":true
        },
        "Filter":{
            "type":"string",
            "description":"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.",
            "format":"byte",
            "nullable":true,
            "x-queryable":true
        },
        "UpdateMode":{
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "TableData":{
            "type":"string",
            "description":"Hierarchy members and measure values that the pivot table contains. The text \r\n separates each unique combination of hierarchy member and measure values, and a comma separates each measure value.",
            "nullable":true,
            "x-queryable":true
        },
        "ESSJobId":{
            "type":"integer",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "TableDataHeader":{
            "type":"string",
            "description":"List of hierarchy level names and the list of measure names that the pivot table contains. A comma separates each value.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Links

Data

Operation: /fscmRestApi/resources/11.13.18.05/supplyChainPlans/{PlanId}/child/PlanningTables/{TableId}/child/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