REST API for Oracle Fusion Cloud SCM

Create data

post

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

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=

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.

Supported Media Types

application/json

Root Schema : schema

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.
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.
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":{
        "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
            }
        },
        "TableHierarchies":{
            "type":"string",
            "description":"Names of the hierarchies that the pivot table contains. A comma separates each value.",
            "nullable":true
        },
        "Message":{
            "type":"string",
            "description":"Text of the error message from the table query.",
            "nullable":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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        }
    }
}

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.

Root 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."
        }
    }
}

Examples

This example describes how to update data on a pivot table of a plan.

Example cURL Command

Use the following cURL command to submit a request on the REST resource.

curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' 
"https://servername/fscmRestApi/resources/version/supplyChainPlans/PlanId/child/PlanningTables/TableId/child/Data"

For example:

curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' 
"https://servername/fscmRestApi/resources/version/supplyChainPlans/300100560600460/child/PlanningTables/9002/child/Data"

Example Request Body

The following example includes the contents of the request body in JSON format. 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.

{ 
"TableHierarchies": "Product,Enterprise,Gregorian Calendar",
"TableDataHeader": "Item,Organization,Month,Shipments History 1 Year Ago,Shipments History,Adjusted Shipments History,Final Shipments History,Sales Orders,Shipments Forecast,Adjusted Shipments Forecast,Final Shipments Forecast,Shipments Forecast MAPE,Shipments Forecast Bias,Shipments Forecast MAD",
"TableData": "HL-DISPLAY,M1,07/01/29,,,55,20,,,,,2.246,-2.246,37.429\r\nHL-DISPLAY,M1,08/01/29,,,55,100,,,,,2.246,-2.246,37.429"
}

Example Response Body

The following example includes the contents of the response body in JSON format:

{
    "TableId": 9002, 
       "TableHierarchies": "Product,Enterprise,Gregorian Calendar",
       "TableDataHeader": "Item,Organization,Month,Shipments History 1 Year Ago,Shipments History,Adjusted Shipments History,Final Shipments History,Sales Orders,Shipments Forecast,Adjusted Shipments Forecast,Final Shipments Forecast,Shipments Forecast MAPE,Shipments Forecast Bias,Shipments Forecast MAD",
       "TableData": "HL-DISPLAY,M1,07/01/29,,,55,20,,,,,2.246,-2.246,37.429\r\nHL-DISPLAY,M1,08/01/29,,,55,100,,,,,2.246,-2.246,37.429\n\r",
       "UpdateMode": null,
       "Message": "The service was completed. Please refer to message details for diagnostic information.Payload combination points=2, Parsed combination points=2, No value points =2, Same value points=0, Found points=2. For more details check application log at the  ServiceServer_1 service server
       "Status":0
       "ESSJobId": null,
       "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/supplyChainPlans/300100560600460/child/PlanningTables/9002/child/Data/",
            "name": "Data",
            "kind": "item"
        },
        {
            "rel": "canonical",
            "href": "https://servername/fscmRestApi/resources/version/supplyChainPlans/300100560600460/child/PlanningTables/9002/child/Data/",
            "name": "Data",
            "kind": "item"
        },
        {
            "rel": "parent",
            "href": "https://servername/fscmRestApi/resources/version/supplyChainPlans/300100560600460/child/PlanningTables/9002",
            "name": "PlanningTables",
            "kind": "item"
        },
        {
            "rel": "enclosure",
            "href": "https://servername/fscmRestApi/resources/version/supplyChainPlans/300100560600460/child/PlanningTables/9002/child/Data//enclosure/Filter",
            "name": "Filter",
            "kind": "other"
        }
    ]
}