1. REST API for Oracle Fusion Cloud Financials
  2. Tasks
  3. Bank Account User Rules

Get all country-specific rules

get

/fscmRestApi/resources/11.13.18.05/bankAccountUserRules

Request

Query Parameters
  • When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
  • This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.

    Format: ?fields=Attribute1,Attribute2

    Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
  • Used as a predefined finder to search the collection.

    Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables:

    • PrimaryKey: Finds all the UI rules with the UI rule identifier.
      Finder Variables:
      • CountrySpecificUIRuleId; integer; Identifier of the country-specific UI rule.
    • findApplicableCountryRules: Finds applicable UI rules for a specific country, page name, and attribute combination.
      Finder Variables:
      • CountryCode; string; Country code for which the UI rule is defined.
      • PageName; string; Page name for which the UI rule is defined.
    • findCtryRule: Finds all the UI rules for a specific country, page name, and attribute combination.
      Finder Variables:
      • BankAccountFieldName; string; Name of the bank account attribute for which the UI rule is defined.
      • CountryCode; string; Country code for which the UI rule is defined.
      • PageName; string; Page name for which the UI rule is defined.
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>

    Example:
    self,canonical
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • BankAccountFieldLabel; string; Display label of the attribute for the country.
    • BankAccountFieldName; string; Attribute for which the country-specific display rule is applied.
    • CountryCode; string; Code that identifies the country where the UI rule is applied.
    • CountrySpecificUIRuleId; integer; Unique identifier of the UI rule.
    • CreatedBy; string; Who column: indicates the user who created the row.
    • CreationDate; string; Who column: indicates the date and time of the creation of the row.
    • DisplayFlag; boolean; Option that indicates whether the attribute is displayed on the UI.
    • LabelCode; string; Display name of the attribute for the country.
    • LastUpdateDate; string; Who column: indicates the date and time of the last update of the row.
    • LastUpdateLogin; string; Who column: indicates the session login associated to the user who last updated the row.
    • LastUpdatedBy; string; Who column: indicates the user who last updated the row.
    • ObjectVersionNumber; integer; 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; Name of the page where the country-specific UI rule is applied.
    • RequiredFlag; boolean; Option that indicates the attribute is required for the country.
    • SeedDataSource; string; Source of the predefined data record.
    • SeededFlag; boolean; Option that indicates whether the country-specific rule is predefined.
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
  • 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".
  • 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.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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.
Body ()
Root Schema : bankAccountUserRules
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : bankAccountUserRules-item-response
Type: object
Show Source
Back to Top

Examples

Example 1

The following example shows how to retrieve all the country-specific rules by submitting a GET request on the REST resource using cURL.

curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourcecollection+json" -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/bankAccountUserRules

Example Response Body

The following example shows the contents of the response body in JSON format:

{
    "items": [
        {
            "CountrySpecificUIRuleId": 300100035853906,
            "CountryCode": "AE",
            "BankAccountFieldName": "ACCOUNT_NAME",
            "DisplayFlag": true,
            ...
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/bankAccountUserRules/300100035853906",
                    "name": "bankAccountUserRules",
                    "kind": "item",
                    "properties": {
                                     "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                                  }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/bankAccountUserRules/300100035853906",
                    "name": "bankAccountUserRules",
                    "kind": "item"
                }
            ]
        },
        ...
    ],
    "count": 25,
    "hasMore": true,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/bankAccountUserRules",
            "name": "bankAccountUserRules",
            "kind": "collection"
        }
    ]
}

Example 2

The following example shows how to retrieve all the country-specific rules by using finders and submitting a GET request on the REST resource using cURL.

curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourcecollection+json" -X GET -d <payload> https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/bankAccountUserRules?finder=findCtryRule;CountryCode=US

Example Response Body

The following example shows the contents of the response body in JSON format:

{
    "items": [
        {
            "CountrySpecificUIRuleId": 300100035854068,
            "CountryCode": "US",
            "BankAccountFieldName": "ACCOUNT_NAME",
            "DisplayFlag": true,
            ...
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/bankAccountUserRules/300100035854068",
                    "name": "bankAccountUserRules",
                    "kind": "item",
                    "properties": {
                                     "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                                  }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/bankAccountUserRules/300100035854068",
                    "name": "bankAccountUserRules",
                    "kind": "item"
                }
            ]
        },
        ...
    ],
    "count": 22,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/bankAccountUserRules",
            "name": "bankAccountUserRules",
            "kind": "collection"
        }
    ]
}
Back to Top