Update an adjustment reason
patch
/fscmRestApi/resources/11.13.18.05/channelAdjustmentTypes/{AdjustmentTypeId}/child/adjustmentReasons/{AdjustmentReasonId}
Request
Path Parameters
-
AdjustmentReasonId(required): integer(int64)
Value that uniquely identifies the adjustment reason. It is a primary key that the application generates when it creates the adjustment reason.
-
AdjustmentTypeId(required): integer(int64)
Value that uniquely identifies the channel adjustment type. It is a primary key that the application generates when it creates the adjustment type.
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
-
AdjustmentReason: string
Maximum Length:
120
Name of the adjustment reason. -
AdjustmentReasonId: integer
(int64)
Value that uniquely identifies the adjustment reason. It is a primary key that the application generates when it creates the adjustment reason.
-
AdjustmentTypeId: integer
(int64)
Value that uniquely identifies the adjustment type.
-
DefaultFlag: boolean
Maximum Length:
1
Default Value:false
Contains one of the following values: true or false. If true, then set the adjustment reason as the default for the adjustment type. This attribute does not have a default value. -
Description: string
Maximum Length:
1000
Description of the adjustment reason. -
EnabledFlag: boolean
Maximum Length:
1
Default Value:false
Contains one of the following values: true or false. If true, then the adjustment reason is enabled for the adjustment type. If false, then the adjustment reason is not enabled. This attribute does not have a default value.
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 : channelAdjustmentTypes-adjustmentReasons-item-response
Type:
Show Source
object
-
AdjustmentReason: string
Maximum Length:
120
Name of the adjustment reason. -
AdjustmentReasonId: integer
(int64)
Value that uniquely identifies the adjustment reason. It is a primary key that the application generates when it creates the adjustment reason.
-
AdjustmentTypeId: integer
(int64)
Value that uniquely identifies the adjustment type.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the record. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the user created the record. -
DefaultFlag: boolean
Maximum Length:
1
Default Value:false
Contains one of the following values: true or false. If true, then set the adjustment reason as the default for the adjustment type. This attribute does not have a default value. -
Description: string
Maximum Length:
1000
Description of the adjustment reason. -
EnabledFlag: boolean
Maximum Length:
1
Default Value:false
Contains one of the following values: true or false. If true, then the adjustment reason is enabled for the adjustment type. If false, then the adjustment reason is not enabled. This attribute does not have a default value. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the user most recently updated the record. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the record. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
Login details of user who most recently updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ReasonCode: string
Maximum Length:
30
Abbreviation that identifies the channel adjustment reason.
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 an adjustment reason.
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/channelAdjustmentTypes/300100185735164//child/adjustmentReasons/300100185735250"
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.
{ "DefaultFlag": "true" }
Example Response Body
The following example includes the contents of the response body in JSON format:
{ "AdjustmentReasonId": 300100185735250, "AdjustmentReason": "Quantity Mismatch", "AdjustmentTypeId": 300100185735164, "DefaultFlag": true, "EnabledFlag": true, "Description": "Quantity Mismatch", "CreatedBy": "channel_user", "CreationDate": "2020-06-02T15:37:47+00:00", "LastUpdatedBy": "channel_user", "LastUpdateDate": "2020-06-02T15:37:47.022+00:00", "LastUpdateLogin": "A6B20DCF2794DABDE053368AF00ABE94", "ReasonCode": "QUANTITY_MISMATCH", "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/channelAdjustmentTypes/300100185735164/child/adjustmentReasons/300100185735250", "name": "adjustmentReasons", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/channelAdjustmentTypes/300100185735164/child/adjustmentReasons/300100185735250", "name": "adjustmentReasons", "kind": "item" }, { "rel": "parent", "href": "https://servername/fscmRestApi/resources/version/channelAdjustmentTypes/300100185735164", "name": "channelAdjustmentTypes", "kind": "item" } ] }