Update one transfer cost rule set
patch
/fscmRestApi/resources/11.13.18.05/transferChargeRuleSets/{TransferChargeRuleSetId}
Request
Path Parameters
-
TransferChargeRuleSetId(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:
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
-
Description: string
Title:
Transfer Charge Rule Set Description
Maximum Length:240
Stores the user specified description of transfer cost rule set. -
RuleSetName: string
Title:
Transfer Charge Rule Set Name
Maximum Length:80
Identifies the unique name of the rule set for the transfer costs. The rule set name is user defined.
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 : transferChargeRuleSets-item-response
Type:
Show Source
object
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
Name of the user who created the transfer cost rule set. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date on which the transfer cost rule set was created. -
Description: string
Title:
Transfer Charge Rule Set Description
Maximum Length:240
Stores the user specified description of transfer cost rule set. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
Date on which the transfer cost rule set was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
Name of the user who last updated the transfer cost rule set. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
RuleSetName: string
Title:
Transfer Charge Rule Set Name
Maximum Length:80
Identifies the unique name of the rule set for the transfer costs. The rule set name is user defined. -
TransferChargeRuleSetId: integer
(int64)
Title:
Transfer Charge Rule Set ID
Read Only:true
Value that uniquely identifies the user specified transfer cost rule set name.
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 transfer cost rule set.
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/transferChargeRuleSets/TransferChargeRuleSetId"
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/transferChargeRuleSets/300100562523592"
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.
{ "RuleSetName" : "ACHIEVERS-Rule set 2", "Description" : "ACHIEVERS-Rule set 2" }
Example Response Body
The following example includes the contents of the response
body in JSON format:
{ "CreatedBy": "COST_ACCT_ALL_COST_ORGS", "CreationDate": "2022-11-11T14:16:36.071+00:00", "Description": "ACHIEVERS-Rule set 2", "LastUpdateDate": "2022-11-11T14:20:36.071+00:00", "LastUpdatedBy": "COST_ACCT_ALL_COST_ORGS", "RuleSetName": "ACHIEVERS-Rule set 2", "TransferChargeRuleSetId": 300100562523592, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/transferChargeRuleSets/300100562523592", "name": "transferChargeRuleSets", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/transferChargeRuleSets/300100562523592", "name": "transferChargeRuleSets", "kind": "item" } ] }