Update one value
patch
/fscmRestApi/resources/11.13.18.05/channelSettings/{SettingId}/child/Values/{SettingValueId}
Request
Path Parameters
-
SettingId(required): integer(int64)
Value that uniquely identifies the channel setting. It is a primary key that the application generates when it creates the channel setting.
-
SettingValueId(required): integer(int64)
Value that uniquely identifies the channel setting value. It is a primary key that the application generates when it creates the channel setting value.
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
-
EnabledFlag: boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, then the channel setting value is enabled. If false, then the channel setting value is disabled. The default value is true. -
LedgerCurrency: string
Maximum Length:
4000
Name of the ledger currency. -
Value: string
Name of the value of the channel setting entered by the user.
-
ValueId: string
Value that uniquely identifies the channel setting value entered by the user.
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 : channelSettings-Values-item-response
Type:
Show Source
object
-
BusinessUnit: string
Name of the business unit.
-
BusinessUnitId: integer
(int64)
Value that uniquely identifies the business unit.
-
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. -
EnabledFlag: boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, then the channel setting value is enabled. If false, then the channel setting value is disabled. The default value is true. -
LastUpdateDate: string
(date-time)
Read Only:
true
Login that the user used when updating the record. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the record. -
LedgerCurrency: string
Maximum Length:
4000
Name of the ledger currency. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
SettingId: integer
(int64)
Value that uniquely identifies the channel setting.
-
SettingValueId: integer
(int64)
Value that uniquely identifies the channel setting value. It is a primary key that the application generates when it creates the channel setting value.
-
Value: string
Name of the value of the channel setting entered by the user.
-
ValueCode: string
Maximum Length:
240
Abbreviation that identifies the channel setting value. -
ValueId: string
Value that uniquely identifies the channel setting value entered by the user.
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 a cost adjustment detail.
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/channelSettings/SettingId/child/Values/SettingValueId"
curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/channelSettings/300100210201569/child/Values/300100291823759"
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.
{ "BusinessUnit": "Vision Services", "Value": "Ava Jones", "EnabledFlag": false }
Example Response Body
The following example includes the contents of the response body in JSON format:
{ "SettingValueId": 300100291823759, "SettingId": 300100210201569, "ValueCode": "VISION_REVIEWER", "BusinessUnit": "Vision Services", "BusinessUnitId": 458, "Value": "Ava Jones", "ValueId": "300100120602591", "EnabledFlag": false, "CreatedBy": "channel_user", "CreationDate": "2020-11-11T09:24:30+00:00", "LastUpdatedBy": "channel_user", "LastUpdateDate": "2020-11-11T09:29:41+00:00", "LedgerCurrency": null, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/channelSettings/300100210201569/child/Values/300100291823759", "name": "Values", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/channelSettings/300100210201569/child/Values/300100291823759", "name": "Values", "kind": "item" }, { "rel": "parent", "href": "https://servername/fscmRestApi/resources/version/channelSettings/300100210201569", "name": "channelSettings", "kind": "item" } ] }