REST Web Service in Oracle Fusion to manage Banks

 REST Web Service 

=================

Rest Resources

Resources would have 5 end-points(methods) usually. 

Ex:

Create a Bank

Read-Get a/all Banks

Update Bank

Delete a Bank




Fusion Navigation for managing Banks 

Setup and Maintenance

Tasks

Global Tasks

Manage Banks


Get All Banks 

/fscmRestApi/resources/11.13.18.05/cashBanks

https://fa-eubg-saasfademo1.ds-fa.oraclepdemos.com/fscmRestApi/resources/11.13.18.05/cashBanks


Get a specific Bank 

https://fa-eubg-saasfademo1.ds-fa.oraclepdemos.com/fscmRestApi/resources/11.13.18.05/cashBanks/{BankPartyId}



Create a Bank 

https://fa-eubg-saasfademo1.ds-fa.oraclepdemos.com/fscmRestApi/resources/11.13.18.05/cashBanks


patch 

Update 

https://fa-eubg-saasfademo1.ds-fa.oraclepdemos.com/fscmRestApi/resources/11.13.18.05/cashBanks/{BankPartyId}


Put

https://fa-eubg-saasfademo1.ds-fa.oraclepdemos.com/fscmRestApi/resources/11.13.18.05/cashBanks/{BankPartyId}


Delete 

https://fa-eubg-saasfademo1.ds-fa.oraclepdemos.com/fscmRestApi/resources/11.13.18.05/cashBanks/{BankPartyId}



Template Parameter 

{BankPartyId}

https://fa-eubg-saasfademo1.ds-fa.oraclepdemos.com/fscmRestApi/resources/11.13.18.05/cashBanks/300000150981220

Query Parameter 

Format:

?q=expression1;expression2

https://fa-eubg-saasfademo1.ds-fa.oraclepdemos.com/fscmRestApi/resources/11.13.18.05/cashBanks?q=CountryName="United States";BankName="Wells Fargo Bank"




REST 

RESTful(Representational State Transfer) Web Services are basically REST Architecture based Web Services.


Key Features:

In REST Architecture, everthing is a Resource.

REST Service uses JASON(Java Script Object Notation) format.

JASON format ex:

{

"Attribute1":"Value",

"Attribute2":"Value",

......etc

}

REST web services are light weight, highly scalable and maintainable.

REST API deliver better performance than SOAP services on any given day.

REST API are widely used in web-based applications.

Universal Resource Identifier(URI): Actual resources that a service exposes. It is also called as Relative path(not a complete path)

Method: A protocol mechanism used to transfer the data(GET,GET ALL,POST,PATCH,PUT,DELETE)

Types of Data Transferred: XML and JASON. 

Recommended to use JASON in REST Services.


-----------------Practicals----------

Get All 

https://fa-eubg-saasfademo1.ds-fa.oraclepdemos.com/fscmRestApi/resources/11.13.18.05/cashBanks?q=CountryName="United States";BankName="Wells Fargo Bank" 


{

    "items": [

        {

            "BankPartyId": 300000094206228,

            "BankName": "Wells Fargo Bank",

            "BankNameAlt": null,

            "BankNumber": null,

            "Description": null,

            "TaxpayerIdNumber": null,

            "TaxRegistrationNumber": null,

            "CreatedBy": "FIN_IMPL",

            "CreationDate": "2014-11-14T10:33:32+00:00",

            "LastUpdateDate": "2014-11-14T10:33:48.297+00:00",

            "LastUpdateLogin": "07CED5C2D2506957E0536204548C4903",

            "LastUpdatedBy": "FIN_IMPL",

            "BankPartyNumber": "193736",

            "CountryName": "United States",

            "links": [

                {

                    "rel": "self",

                    "href": "https://fa-eubg-saasfademo1.ds-fa.oraclepdemos.com:443/fscmRestApi/resources/11.13.18.05/cashBanks/300000094206228",

                    "name": "cashBanks",

                    "kind": "item",

                    "properties": {

                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000378"

                    }

                },

                {

                    "rel": "canonical",

                    "href": "https://fa-eubg-saasfademo1.ds-fa.oraclepdemos.com:443/fscmRestApi/resources/11.13.18.05/cashBanks/300000094206228",

                    "name": "cashBanks",

                    "kind": "item"

                },

                {

                    "rel": "lov",

                    "href": "https://fa-eubg-saasfademo1.ds-fa.oraclepdemos.com:443/fscmRestApi/resources/11.13.18.05/cashBanks/300000094206228/lov/TerritoryPVOVOVA",

                    "name": "TerritoryPVOVOVA",

                    "kind": "collection"

                }

            ]

        }

    ],

    "count": 1,

    "hasMore": false,

    "limit": 500,

    "offset": 0,

    "links": [

        {

            "rel": "self",

            "href": "https://fa-eubg-saasfademo1.ds-fa.oraclepdemos.com:443/fscmRestApi/resources/11.13.18.05/cashBanks",

            "name": "cashBanks",

            "kind": "collection"

        }

    ]

}

-----------------

Get Specific Bank

https://fa-eubg-saasfademo1.ds-fa.oraclepdemos.com/fscmRestApi/resources/11.13.18.05/cashBanks/300000150981220

{

    "BankPartyId": 300000150981220,

    "BankName": " Abu Dhabi Islamic Bank",

    "BankNameAlt": null,

    "BankNumber": "ADIB",

    "Description": "ADIB",

    "TaxpayerIdNumber": null,

    "TaxRegistrationNumber": null,

    "CreatedBy": "FIN_IMPL",

    "CreationDate": "2017-08-22T11:06:55+00:00",

    "LastUpdateDate": "2017-08-23T10:19:21.455+00:00",

    "LastUpdateLogin": "576926B87AA1074BE0538DADFD0A6849",

    "LastUpdatedBy": "FIN_IMPL",

    "BankPartyNumber": "611259",

    "CountryName": "United Arab Emirates",

    "links": [

        {

            "rel": "self",

            "href": "https://fa-eubg-saasfademo1.ds-fa.oraclepdemos.com:443/fscmRestApi/resources/11.13.18.05/cashBanks/300000150981220",

            "name": "cashBanks",

            "kind": "item",

            "properties": {

                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000378"

            }

        },

        {

            "rel": "canonical",

            "href": "https://fa-eubg-saasfademo1.ds-fa.oraclepdemos.com:443/fscmRestApi/resources/11.13.18.05/cashBanks/300000150981220",

            "name": "cashBanks",

            "kind": "item"

        },

        {

            "rel": "lov",

            "href": "https://fa-eubg-saasfademo1.ds-fa.oraclepdemos.com:443/fscmRestApi/resources/11.13.18.05/cashBanks/300000150981220/lov/TerritoryPVOVOVA",

            "name": "TerritoryPVOVOVA",

            "kind": "collection"

        }

    ]

}

===================

Create Bank(POST)

https://fa-eubg-saasfademo1.ds-fa.oraclepdemos.com/fscmRestApi/resources/11.13.18.05/cashBanks


Request Payload

{

   "CountryName": "United States",

   "BankName": "REST_CE_Bank_011",

   "BankNumber": 87698001,

   "BankNameAlt": "REST_CE_Bank_011_Alt",

   "Description": "REST CE Bank 01 Description",

   "TaxpayerIdNumber": "11121"

}

Response Payload

{

    "BankPartyId": 300000324461851,

    "BankName": "REST_CE_Bank_011",

    "BankNameAlt": "REST_CE_Bank_011_Alt",

    "BankNumber": "87698001",

    "Description": "REST CE Bank 01 Description",

    "TaxpayerIdNumber": "11121",

    "TaxRegistrationNumber": null,

    "CreatedBy": "HCM_IMPL",

    "CreationDate": "2026-02-15T05:30:35+00:00",

    "LastUpdateDate": "2026-02-15T05:30:39.669+00:00",

    "LastUpdateLogin": "4AD681A8FEE875FBE0639B15000A976A",

    "LastUpdatedBy": "HCM_IMPL",

    "BankPartyNumber": "1127878",

    "CountryName": "United States",

    "links": [

        {

            "rel": "self",

            "href": "https://fa-eubg-saasfademo1.ds-fa.oraclepdemos.com:443/fscmRestApi/resources/11.13.18.05/cashBanks/1",

            "name": "cashBanks",

            "kind": "item",

            "properties": {

                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"

            }

        },

        {

            "rel": "canonical",

            "href": "https://fa-eubg-saasfademo1.ds-fa.oraclepdemos.com:443/fscmRestApi/resources/11.13.18.05/cashBanks/1",

            "name": "cashBanks",

            "kind": "item"

        },

        {

            "rel": "lov",

            "href": "https://fa-eubg-saasfademo1.ds-fa.oraclepdemos.com:443/fscmRestApi/resources/11.13.18.05/cashBanks/1/lov/TerritoryPVOVOVA",

            "name": "TerritoryPVOVOVA",

            "kind": "collection"

        }

    ]

}

-----------------

Patch(Update)

https://fa-eubg-saasfademo1.ds-fa.oraclepdemos.com/fscmRestApi/resources/11.13.18.05/cashBanks/300000324461851


Request Payload 

{


"Description": "REST CE Bank 011 Description Updated one time"

}


Response Payload 

{

    "BankPartyId": 300000324461851,

    "BankName": "REST_CE_Bank_011",

    "BankNameAlt": "REST_CE_Bank_011_Alt",

    "BankNumber": "87698001",

    "Description": "REST CE Bank 011 Description Updated one time",

    "TaxpayerIdNumber": "11121",

    "TaxRegistrationNumber": null,

    "CreatedBy": "HCM_IMPL",

    "CreationDate": "2026-02-15T05:30:35.805+00:00",

    "LastUpdateDate": "2026-02-15T05:33:11.089+00:00",

    "LastUpdateLogin": "4AD60405E7E17807E0639B15000A02BB",

    "LastUpdatedBy": "HCM_IMPL",

    "BankPartyNumber": "1127878",

    "CountryName": "United States",

    "links": [

        {

            "rel": "self",

            "href": "https://fa-eubg-saasfademo1.ds-fa.oraclepdemos.com:443/fscmRestApi/resources/11.13.18.05/cashBanks/300000324461851",

            "name": "cashBanks",

            "kind": "item",

            "properties": {

                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"

            }

        },

        {

            "rel": "canonical",

            "href": "https://fa-eubg-saasfademo1.ds-fa.oraclepdemos.com:443/fscmRestApi/resources/11.13.18.05/cashBanks/300000324461851",

            "name": "cashBanks",

            "kind": "item"

        },

        {

            "rel": "lov",

            "href": "https://fa-eubg-saasfademo1.ds-fa.oraclepdemos.com:443/fscmRestApi/resources/11.13.18.05/cashBanks/300000324461851/lov/TerritoryPVOVOVA",

            "name": "TerritoryPVOVOVA",

            "kind": "collection"

        }

    ]

}

===================

What are differences between Patch and Put in REST Web Service? 

PATCH

Action:Updates specific fields only.

Payload:Only include fields being changed.

Missing Fields: Remain unchanged.

Analogy: Changing a flat tire.

PUT

Action:Replaces the entire resource.

Payload:Must include all required fields.

Missing Fields:May be cleared/nulled out.

Analogy:Replacing the whole car.



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/cashBanks


Comments

Popular posts from this blog

Importance of Incremental Data in Oracle Fusion

'Generate CSV File' Not Working in Oracle Fusion FBDI template

Mastering Parameters in Oracle Fusion BI Publisher