Update locations for one cluster
patch
/fscmRestApi/resources/11.13.18.05/planningClusters/{ClusterId}/child/ClusterLocations/{ClusterLocationsUniqID}
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=
-
ClusterLocationsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Cluster Locations resource and used to uniquely identify an instance of Cluster Locations. The client should not generate the hash key value. Instead, the client should query on the Cluster Locations collection resource in order to navigate to a specific instance of Cluster Locations to get the hash key.
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:
Show Source
object
-
ClusterId: integer
(int64)
Value that uniquely identifies the planning cluster.
-
Description: string
Maximum Length:
281
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.
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 : planningClusters-ClusterLocations-item-response
Type:
Show Source
object
-
ClusterId: integer
(int64)
Value that uniquely identifies the planning cluster.
-
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:
281
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Examples
This example describes how to update locations for a 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/child/ClusterLocations/ClusterLocationsUniqID"
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/300100557483567/child/ClusterLocations/300100557485410"
Example Request Body
The following example includes the contents of the request body in JSON format.
{"LocationPriority": 20}
Example Response Body
The following example includes the contents of the response
body in JSON format:
{ "ClusterId": 300100557483567, "LocationId": 10001, "Location": "M1", "Description": "Seattle Manufacturing", "LocationPriority": 20, "CreationDate": "2021-09-16T14:24:50.207+00:00", "CreatedBy": "REPL_USER", "LastUpdateDate": "2021-09-16T14:41:36+00:00", "LastUpdateLogin": "CBD8D9B578EFC695E053A80AF20A4E51", "LastUpdatedBy": "REPL_USER", "ObjectVersionNumber": 2, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/planningClusters/300100557483567/child/ClusterLocations/300100557485410", "name": "ClusterLocations", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/planningClusters/300100557483567/child/ClusterLocations/300100557485410", "name": "ClusterLocations", "kind": "item" }, { "rel": "parent", "href": "https://servername/fscmRestApi/resources/version/planningClusters/300100557483567", "name": "planningClusters", "kind": "item" } ] }