1. REST API for Oracle Supply Chain Management Cloud
  2. Tasks
  3. Supply Chain Planning
  4. Planning Clusters

Update one planning cluster

patch

/fscmRestApi/resources/11.13.18.05/planningClusters/{ClusterId}

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=
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.
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
Nested Schema : Cluster Locations
Type: array
Title: Cluster Locations
The Cluster Locations resource manages all locations within the cluster.
Show Source
Nested Schema : Cluster Members
Type: array
Title: Cluster Members
The Cluster Members resource manages the location priority of all locations within the cluster.
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : planningClusters-ClusterMembers-item-patch-request
Type: object
Show Source
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 : planningClusters-item-response
Type: object
Show Source
Nested Schema : Cluster Locations
Type: array
Title: Cluster Locations
The Cluster Locations resource manages all locations within the cluster.
Show Source
Nested Schema : Cluster Members
Type: array
Title: Cluster Members
The Cluster Members resource manages the location priority of all locations within the cluster.
Show Source
Nested Schema : planningClusters-ClusterLocations-item-response
Type: object
Show Source
Nested Schema : planningClusters-ClusterMembers-item-response
Type: object
Show Source
Links
ClusterLocations
Parameters:
  • ClusterId: $request.path.ClusterId
The Cluster Locations resource manages all locations within the cluster.
ClusterMembers
Parameters:
  • ClusterId: $request.path.ClusterId
The Cluster Members resource manages the location priority of all locations within the cluster.
Back to Top

Examples

This example describes how to update a planning cluster.

Example cURL Command

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

curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/planningClusters/ClusterId"

For example:

curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload' https://servername/fscmRestApi/resources/version/planningClusters/300100557477359"

Example Request Body

The following example includes the contents of the request body in JSON format.

{
    "ClusterName": "GP0002",
    "Description": "Testing for Updated Cluster Description",
    "SourceSystem": "GPR",
    "SweepLocation": "M1",
    "ExcessLeadTimeMultiplier": 3.95,
    "ShortageLeadTimeMultiplier": 2.576,
    "ReservedSafetyStockPercentage": 98,
     "LocationHierarchy": "Location"

}

Example Response Body

The following example includes the contents of the response body in JSON format:
{
    "ClusterId": 300100557477359,
    "ClusterName": "GP0002",
    "Description": "Testing for Updated Cluster Description",
    "SourceSystemId": 100010026240309,
    "SourceSystem": "GPR",
    "SweepLocationId": 10001,
    "SweepLocation": "M1",
    "ExcessLeadTimeMultiplier": 3.95,
    "ShortageLeadTimeMultiplier": 2.58,
    "ReservedSafetyStockPercentage": 98,
    "LocationHierarchyCode": 1,
    "LocationHierarchy": "Location",
    "CreatedBy": "REPL_USER",
    "CreationDate": "2021-09-16T14:13:28+00:00",
    "LastUpdatedBy": "REPL_USER",
    "LastUpdateDate": "2021-09-16T14:17:19+00:00",
    "LastUpdateLogin": "CBD9B8B363D0C69BE053A80AF20A777D",
    "ObjectVersionNumber": 2,
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/planningClusters/300100557477359",
            "name": "planningClusters",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername/fscmRestApi/resources/version/planningClusters/300100557477359",
            "name": "planningClusters",
            "kind": "item"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/planningClusters/300100557477359/child/ClusterLocations",
            "name": "ClusterLocations",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/planningClusters/300100557477359/child/ClusterMembers",
            "name": "ClusterMembers",
            "kind": "collection"
        }
    ]
}
Back to Top