Update an existing country-specific rule
patch
/fscmRestApi/resources/11.13.18.05/bankAccountUserRules/{CountrySpecificUIRuleId}
Request
Path Parameters
-
CountrySpecificUIRuleId(required): integer(int64)
Unique identifier of the UI rule.
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
-
BankAccountFieldName: string
Maximum Length:
30
Attribute for which the country-specific display rule is applied. -
CountryCode: string
Maximum Length:
2
Code that identifies the country where the UI rule is applied. -
CountrySpecificUIRuleId: integer
(int64)
Unique identifier of the UI rule.
-
DisplayFlag: boolean
Maximum Length:
1
Option that indicates whether the attribute is displayed on the UI. -
LabelCode: string
Maximum Length:
30
Display name of the attribute for the country. -
ObjectVersionNumber: integer
(int32)
The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.
-
PageName: string
Maximum Length:
30
Name of the page where the country-specific UI rule is applied. -
RequiredFlag: boolean
Maximum Length:
1
Option that indicates the attribute is required for the country. -
SeedDataSource: string
Maximum Length:
512
Source of the predefined data record. -
SeededFlag: boolean
Maximum Length:
1
Option that indicates whether the country-specific rule is predefined.
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 : bankAccountUserRules-item-response
Type:
Show Source
object
-
BankAccountFieldLabel: string
Read Only:
true
Maximum Length:255
Display label of the attribute for the country. -
BankAccountFieldName: string
Maximum Length:
30
Attribute for which the country-specific display rule is applied. -
CountryCode: string
Maximum Length:
2
Code that identifies the country where the UI rule is applied. -
CountrySpecificUIRuleId: integer
(int64)
Unique identifier of the UI rule.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
Who column: indicates the user who created the row. -
CreationDate: string
(date-time)
Read Only:
true
Who column: indicates the date and time of the creation of the row. -
DisplayFlag: boolean
Maximum Length:
1
Option that indicates whether the attribute is displayed on the UI. -
LabelCode: string
Maximum Length:
30
Display name of the attribute for the country. -
LastUpdateDate: string
(date-time)
Read Only:
true
Who column: indicates the date and time of the last update of the row. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
Who column: indicates the user who last updated the row. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
Who column: indicates the session login associated to the user who last updated the row. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.
-
PageName: string
Maximum Length:
30
Name of the page where the country-specific UI rule is applied. -
RequiredFlag: boolean
Maximum Length:
1
Option that indicates the attribute is required for the country. -
SeedDataSource: string
Maximum Length:
512
Source of the predefined data record. -
SeededFlag: boolean
Maximum Length:
1
Option that indicates whether the country-specific rule is predefined.
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
The following example shows how to update a country-specific rule by submitting a PATCH request on the REST resource using cURL.
curl -i -u "<username>:<password>" -H "Content-Type: application/json" -X PATCH -d <payload> https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/bankAccountUserRules/300100176456144
Example Request Payload
The following example shows the contents of the request body in JSON format:
{ "RequiredFlag": true }
Example Response Body
The following example shows the contents of the response body in JSON format:
{ "CountrySpecificUIRuleId": 300100176456144, "CountryCode": "GB", "BankAccountFieldName": "ORA_ACCOUNT_NAME", "RequiredFlag": true, ... "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/bankAccountUserRules/300100176456144", "name": "bankAccountUserRules", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/bankAccountUserRules/300100176456144", "name": "bankAccountUserRules", "kind": "item" } ] }