Update one segment member
patch
/fscmRestApi/resources/11.13.18.05/planningSegmentGroupsV2/{SegmentGroupId}/child/SegmentMembers/{SegmentMembersUniqID}
Request
Path Parameters
-
SegmentGroupId(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=
-
SegmentMembersUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Segment Members resource and used to uniquely identify an instance of Segment Members. The client should not generate the hash key value. Instead, the client should query on the Segment Members collection resource in order to navigate to a specific instance of Segment Members 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
-
CustomerSiteId: integer
Value that uniquely identifies the customer site.
-
CustomerSiteName: string
Maximum Length:
255
Name of the customer site. -
DemandClassId: integer
Value that uniquely identifies the demand class.
-
DemandClassName: string
Maximum Length:
255
Name of the demand class. -
ItemId: integer
Value that uniquely identifies the inventory item.
-
ItemName: string
Maximum Length:
255
Name of the item. -
LocationId: integer
Value that uniquely identifies the location.
-
LocationName: string
Maximum Length:
255
Name of the location. -
OverrideSegmentId: integer
(int64)
Value that uniquely identifies a segment that's used as a segment override.
-
OverrideSegmentName: string
Maximum Length:
255
Name of the override segment. -
PreviousSegmentName: string
Maximum Length:
255
Name of the previous segment. -
SegmentGroupName: string
Maximum Length:
255
Name of the segment group. -
SegmentName: string
Maximum Length:
255
Name of the segment.
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 : planningSegmentGroupsV2-SegmentMembers-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the segment members. -
CreationDate: string
(date-time)
Read Only:
true
Date when the user created the segment members. -
CustomerSiteId: integer
Value that uniquely identifies the customer site.
-
CustomerSiteName: string
Maximum Length:
255
Name of the customer site. -
DemandClassId: integer
Value that uniquely identifies the demand class.
-
DemandClassName: string
Maximum Length:
255
Name of the demand class. -
ItemId: integer
Value that uniquely identifies the inventory item.
-
ItemName: string
Maximum Length:
255
Name of the item. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date when the user most recently updated the segment members. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the segment members. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LocationId: integer
Value that uniquely identifies the location.
-
LocationName: string
Maximum Length:
255
Name of the location. -
OverrideSegmentId: integer
(int64)
Value that uniquely identifies a segment that's used as a segment override.
-
OverrideSegmentName: string
Maximum Length:
255
Name of the override segment. -
PreviousSegmentId: integer
(int64)
Value that uniquely identifies the previous segment name.
-
PreviousSegmentName: string
Maximum Length:
255
Name of the previous segment. -
SegmentGroupId: integer
(int64)
Value that uniquely identifies the segment group.
-
SegmentGroupName: string
Maximum Length:
255
Name of the segment group. -
SegmentId: integer
(int64)
Value that uniquely identifies the segment.
-
SegmentName: string
Maximum Length:
255
Name of the segment.
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 one segment member.
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/planningSegmentGroupsV2/SegmentGroupId/child/SegmentMembers/SegmentMembersUniqID"
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/planningSegmentGroupsV2/300100607276682/child/SegmentMembers/00070000000EACED0005770800000000000C7FEA0000000EACED0005770800000000000027150000000EACED00057708FFFFFFFFFFFFFFFF0000000EACED00057708FFFFFFFFFFFFFFFF0000000EACED00057708FFFFFFFFFFFFFFFF0000000EACED00057708FFFFFFFFFFFFFFFF0000000EACED00057708000110F09E17F68A "
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 updates.
{ "OverrideSegmentName": "LowCostLowVolume", "OverrideSegmentId": 300100607276715 } OR { "OverrideSegmentName": "LowCostLowVolume" } OR { "OverrideSegmentId": 300100607276715 }
Example Response Body
The following example includes the contents of the response
body in JSON format:
{ "CreatedBy": "REPL_USER", "CreationDate": "2024-08-01T06:05:22+00:00", "LastUpdateDate": "2024-08-01T06:17:40+00:00", "LastUpdatedBy": "REPL_MN", "OverrideSegmentId": 300100607276715, "PreviousSegmentId": null, "SegmentGroupId": 300100607276682, "SegmentId": 300100607276685, "ItemId": 819178, "ItemName": "YM-LED-1080P-43", "LocationId": 10005, "LocationName": "M3", "CustomerSiteId": null, "CustomerSiteName": null, "DemandClassId": null, "DemandClassName": null, "SegmentName": "HighCostHighVolume", "PreviousSegmentName": null, "OverrideSegmentName": "LowCostLowVolume", "SegmentGroupName": "SG-COST-VOL", "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/planningSegmentGroupsV2/300100607276682/child/SegmentMembers/00070000000EACED0005770800000000000C7FEA0000000EACED0005770800000000000027150000000EACED00057708FFFFFFFFFFFFFFFF0000000EACED00057708FFFFFFFFFFFFFFFF0000000EACED00057708FFFFFFFFFFFFFFFF0000000EACED00057708FFFFFFFFFFFFFFFF0000000EACED00057708000110F09E17F68A", "name": "SegmentMembers", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/planningSegmentGroupsV2/300100607276682/child/SegmentMembers/00070000000EACED0005770800000000000C7FEA0000000EACED0005770800000000000027150000000EACED00057708FFFFFFFFFFFFFFFF0000000EACED00057708FFFFFFFFFFFFFFFF0000000EACED00057708FFFFFFFFFFFFFFFF0000000EACED00057708FFFFFFFFFFFFFFFF0000000EACED00057708000110F09E17F68A", "name": "SegmentMembers", "kind": "item" }, { "rel": "parent", "href": "https://servername/fscmRestApi/resources/version/planningSegmentGroupsV2/300100607276682", "name": "planningSegmentGroupsV2", "kind": "item" } ] }