REST API for Oracle Fusion Cloud SCM

Update locations for one cluster

patch

/fscmRestApi/resources/11.13.18.05/planningClustersV2/{ClusterId}/child/ClusterLocations/{ClusterLocationId}

Request

Path Parameters

ClusterId(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=
ClusterLocationId(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: string

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: string

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

ClusterId: integer (int64)

Value that uniquely identifies the planning cluster.
ClusterLocationId: integer (int64)

Value that uniquely identifies the cluster location combination.
Description: string

Maximum Length: 481

Description of the planning cluster.
Location: string

Maximum Length: 60

Name of the cluster location.
LocationId: integer (int64)

Value that uniquely identifies the cluster location.
LocationPriority: number

Value that indicates priority of the cluster location.
ObjectVersionNumber: integer (int32)

Number of times the object has been updated.

{
    "type":"object",
    "properties":{
        "ClusterId":{
            "type":"integer",
            "description":"Value that uniquely identifies the planning cluster.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ClusterLocationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the cluster location combination.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "Description":{
            "maxLength":481,
            "type":"string",
            "description":"Description of the planning cluster.",
            "nullable":true
        },
        "Location":{
            "maxLength":60,
            "type":"string",
            "description":"Name of the cluster location.",
            "nullable":true
        },
        "LocationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the cluster location.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "LocationPriority":{
            "type":"number",
            "description":"Value that indicates priority of the cluster location.",
            "nullable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Number of times the object has been updated.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            }
        }
    }
}

Response

Supported Media Types

application/json

Default Response

The following table describes the default response for this task.

Headers

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.

Root Schema : planningClustersV2-ClusterLocations-item-response

Type: object

Show Source

ClusterId: integer (int64)

Value that uniquely identifies the planning cluster.
ClusterLocationId: integer (int64)

Value that uniquely identifies the cluster location combination.
CreatedBy: string

Read Only: true

Maximum Length: 64

User who created the planning cluster locations.
CreationDate: string (date-time)

Read Only: true

Date when the user created the planning cluster locations.
Description: string

Maximum Length: 481

Description of the planning cluster.
LastUpdateDate: string (date-time)

Read Only: true

Date when the user most recently updated the planning cluster locations.
LastUpdatedBy: string

Read Only: true

Maximum Length: 64

User who most recently updated the planning cluster locations.
LastUpdateLogin: string

Read Only: true

Maximum Length: 32

Login that the user used when updating the planning cluster locations.
links: array Links

Title: Links

The link relations associated with the resource instance.
Location: string

Maximum Length: 60

Name of the cluster location.
LocationId: integer (int64)

Value that uniquely identifies the cluster location.
LocationPriority: number

Value that indicates priority of the cluster location.
ObjectVersionNumber: integer (int32)

Number of times the object has been updated.

{
    "type":"object",
    "properties":{
        "ClusterId":{
            "type":"integer",
            "description":"Value that uniquely identifies the planning cluster.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ClusterLocationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the cluster location combination.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the planning cluster locations.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the user created the planning cluster locations.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "maxLength":481,
            "type":"string",
            "description":"Description of the planning cluster.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the user most recently updated the planning cluster locations.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Login that the user used when updating the planning cluster locations.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the planning cluster locations.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Location":{
            "maxLength":60,
            "type":"string",
            "description":"Name of the cluster location.",
            "nullable":true,
            "x-queryable":true
        },
        "LocationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the cluster location.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LocationPriority":{
            "type":"number",
            "description":"Value that indicates priority of the cluster location.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Number of times the object has been updated.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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 locations for clusters.

Example 1

This example describes how to update locations for one cluster.

Example 1 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/planningClustersV2/ClusterId/child/ClusterLocations/ClusterLocationId"

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/planningClustersV2/300100607459404/child/ClusterLocations/300100607468750"

Example 1 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 updates.

{"LocationPriority":"1"}

Example 1 Response Body

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

{
    "ClusterLocationId": 300100607468750,
    "ClusterId": 300100607459404,
    "LocationId": 10149,
    "Location": "ZC9",
    "Description": "ZC9",
    "LocationPriority": 1,
    "CreationDate": "2024-08-02T05:42:34.497+00:00",
    "CreatedBy": "REPL_USER",
    "LastUpdateDate": "2024-08-02T05:56:13+00:00",
    "LastUpdateLogin": "1D6EE34C203F47ECE0637E04060A733A",
    "LastUpdatedBy": "REPL_USER",
    "ObjectVersionNumber": 2,
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/planningClustersV2/300100607459404/child/ClusterLocations/300100607468750",
            "name": "ClusterLocations",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername/fscmRestApi/resources/version/planningClustersV2/300100607459404/child/ClusterLocations/300100607468750",
            "name": "ClusterLocations",
            "kind": "item"
        },
        {
            "rel": "parent",
            "href": "https://servername/fscmRestApi/resources/version/planningClustersV2/300100607459404",
            "name": "planningClustersV2",
            "kind": "item"
        }
    ]
}

Example 2

This example describes how to update locations for all clusters.

Example 2 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/planningClustersV2/ClusterId/child/ClusterLocations"

Example 2 Request Body

{
   "parts": [{
   "id": "1",
   "path":"/planningClustersV2/300100607459404/child/ClusterLocations/300100607468749",
   "operation": "update",
   "payload": 
{"LocationPriority":"3"}},
{
    "id": "2",
    "path":"/planningClustersV2/300100607459404/child/ClusterLocations/300100607468746",
   "operation": "update",
   "payload": 
{"LocationPriority":"2"}}]
}

Example 2 Response Body

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

{
    "parts": [
        {
            "id": "1",
            "path": "https://servername/fscmRestApi/resources/version/planningClustersV2/300100607459404/child/ClusterLocations/300100607468749",
            "operation": "update",
            "payload": {
                "ClusterLocationId": 300100607468749,
                "ClusterId": 300100607459404,
                "LocationId": 88179,
                "Location": "IOCOO2",
                "Description": "IOCOO2",
                "LocationPriority": 3,
                "CreationDate": "2024-08-02T05:42:34.495+00:00",
                "CreatedBy": "REPL_USER",
                "LastUpdateDate": "2024-08-02T05:59:59+00:00",
                "LastUpdateLogin": "1D70247058B347F0E0637E04060ACFF6",
                "LastUpdatedBy": "REPL_USER",
                "ObjectVersionNumber": 2,
                "links": [
                    {
                        "rel": "self",
                        "href": "https://servername/fscmRestApi/resources/version/planningClustersV2/300100607459404/child/ClusterLocations/300100607468749",
                        "name": "ClusterLocations",
                        "kind": "item",
                        "properties": {
                            "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
                        }
                    },
                    {
                        "rel": "canonical",
                        "href": "https://servername/fscmRestApi/resources/version/planningClustersV2/300100607459404/child/ClusterLocations/300100607468749",
                        "name": "ClusterLocations",
                        "kind": "item"
                    },
                    {
                        "rel": "parent",
                        "href": "https://servername/fscmRestApi/resources/version/planningClustersV2/300100607459404",
                        "name": "planningClustersV2",
                        "kind": "item"
                    }
                ]
            }
        },
        {
            "id": "2",
            "path": "https://servername/fscmRestApi/resources/version/planningClustersV2/300100607459404/child/ClusterLocations/300100607468746",
            "operation": "update",
            "payload": {
                "ClusterLocationId": 300100607468746,
                "ClusterId": 300100607459404,
                "LocationId": 88181,
                "Location": "IOCOO1",
                "Description": "IOCOO1",
                "LocationPriority": 2,
                "CreationDate": "2024-08-02T05:42:34.453+00:00",
                "CreatedBy": "REPL_USER",
                "LastUpdateDate": "2024-08-02T05:59:59.003+00:00",
                "LastUpdateLogin": "1D70247058B347F0E0637E04060ACFF6",
                "LastUpdatedBy": "REPL_USER",
                "ObjectVersionNumber": 2,
                "links": [
                    {
                        "rel": "self",
                        "href": "https://servername/fscmRestApi/resources/version/planningClustersV2/300100607459404/child/ClusterLocations/300100607468746",
                        "name": "ClusterLocations",
                        "kind": "item",
                        "properties": {
                            "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
                        }
                    },
                    {
                        "rel": "canonical",
                        "href": "https://servername/fscmRestApi/resources/version/planningClustersV2/300100607459404/child/ClusterLocations/300100607468746",
                        "name": "ClusterLocations",
                        "kind": "item"
                    },
                    {
                        "rel": "parent",
                        "href": "https://servername/fscmRestApi/resources/version/planningClustersV2/300100607459404",
                        "name": "planningClustersV2",
                        "kind": "item"
                    }
                ]
            }
        }
    ]
}