Attachment Applet REST APIs
A file attachment applet is a type of applet that provides access to an external document, such as a spreadsheet, word processing document, or slide presentation in Siebel CRM. It provides the following capabilities:
-
Allows the user to click the name of a file from a list to open a document.
-
Allows the user to add a document file to a list, edit it, or remove it.
-
Provides synchronization and shared access support for attached documents.
Use the configuration of the config.json depicted in Applet APIs.
PUT Operation - Upload File
PUT URL: https://<hostname:port>/oracle/openintegration/v1.0/ui/Account Attachment View/SIS Account Entry Applet/1-2Z2/Account Attachment Applet/AccntFileName/NewFile
1-2Z2: This is the record Id of SIS Account Entry Applet.
AccntFileName: Control corresponding to filename in Account Attachment Applet.
Note: Control names can be fetched from openapi (refer to Paths section) - https://<hostname:port>/oracle/openintegration/v1.0/ui/Account Attachment View/SIS Account Entry Applet/id/Account Attachment Applet/describe
Request Headers:
Content-Type: multipart/form-data
Form Parameters - Key: s_SweFileName, Value: <file-along-with-path> (Ex: Users/Documents/Sample.json).
curl --location --request PUT 'https://<hostname:port>/oracle/openintegration/v1.0/ui/Account%20Attachment%20View/SIS%20Account%20Entry%20Applet/1-2Z2/Account%20Attachment%20Applet/AccntFileName/NewFile' \
--header 'SBL_REMOTE_USER: <userName>' \
--form 's_SweFileName=@/<file-along-with-path>'{
"items": {
"Id": "88-3CM36Q",
"AccntFileAutoUpdFlg": "Y",
"AccntFileSize": "1843",
"Comment": "",
"AccntFileDate": "03/12/2025 05:02:56",
"AccntFileExt": "json",
"AccntFileName": "Sample"
},
"UIMetadata": { .... }
}GET Operation - Download File
GET URL: https://<hostname:port>/oracle/openintegration/v1.0/ui/Account Attachment View/SIS Account Entry Applet/1-2Z2/Account Attachment Applet/88-3CM36Q/AccntFileName/Drilldown
1-2Z2: This is the record Id of SIS Account Entry Applet.
88-3CM36Q: This is the record Id of Attachment.
AccntFileName: Control corresponding to filename in Account Attachment Applet.
Response Headers:
Content-Disposition: attachment; filename="Sample.json"
Content-Type: application/x-msdownload
Response payload:
It downloads the attachment and opens a popup with save option.
PUT Operation - Update Record with New File
GET URL: https://<hostname:port>/oracle/openintegration/v1.0/ui/Account Attachment View/SIS Account Entry Applet/1-2Z2/Account Attachment Applet/88-3CM36Q/AccntFileName/NewFile
1-2Z2: This is the record Id of SIS Account Entry Applet.
88-3CM36Q: This is the record Id of Attachment/URL.
AccntFileName: Control corresponding to filename in Account Attachment Applet.
Update action can be performed on either File record or URL record.
Request Headers:
Content-Type: multipart/form-data
Request payload:
Form Parameters - Key: s_SweFileName, Value: <file-along-with-path> (Ex: Users/Documents/Sample.json).
curl --location --request PUT 'https://<hostname:port>/oracle/openintegration/v1.0/ui/Account%20Attachment%20View/SIS%20Account%20Entry%20Applet/1-2Z2/Account%20Attachment%20Applet/88-3CM36Q/AccntFileName/NewFile' \
--header 'SBL_REMOTE_USER: <userName>' \
--form 's_SweFileName=@/<file-along-with-path>'{
"items": {
"Id": "88-3CM36Q",
"AccntFileAutoUpdFlg": "Y",
"AccntFileSize": "2062",
"Comment": "",
"AccntFileDate": "03/12/2025 20:30:55",
"AccntFileExt": "json",
"AccntFileName": "Test"
},
"UIMetadata": { .... }
}PUT Operation - Upload URL
PUT URL: https://<hostname:port>/oracle/openintegration/v1.0/ui/Account Attachment View/SIS Account Entry Applet/1-2Z2/Account Attachment Applet/AccntFileName/NewUrl
1-2Z2: This is the record Id of SIS Account Entry Applet.
AccntFileName: Control corresponding to filename in Account Attachment Applet.
Request Headers:
Content-Type: application/json
{
"s_SweUrl": "https://oracle.com"
}{
"items": {
"Id": "88-3CKUCT",
"AccntFileAutoUpdFlg": "N",
"AccntFileSize": "",
"Comment": "",
"AccntFileDate": "",
"AccntFileExt": "URL",
"AccntFileName": "https://oracle.com"
},
"UIMetadata": { .... }
}PUT Operation - Update Record with New Url
PUT URL: https://<hostname:port>/oracle/openintegration/v1.0/ui/Account Attachment View/SIS Account Entry Applet/1-2Z2/Account Attachment Applet/88-3CM36Q/AccntFileName/NewUrl
1-2Z2: This is the record Id of SIS Account Entry Applet.
88-3CM36Q: This is the record Id of Attachment/URL.
AccntFileName: Control corresponding to filename in Account Attachment Applet.
Update action can be performed on either File record or URL record.
Request Headers:
Content-Type: application/json
{
"s_SweUrl": "https://google.com"
}{
"items": {
"Id": "88-3CM36Q",
"AccntFileAutoUpdFlg": "N",
"AccntFileSize": "",
"Comment": "",
"AccntFileDate": "",
"AccntFileExt": "URL",
"AccntFileName": "https://google.com"
},
"UIMetadata": { .... }
}GET Operation - Retrieve Metadata
GET URL: https://<hostname:port>/oracle/openintegration/v1.0/ui/Account Attachment View/SIS Account Entry Applet/1-2Z2/Account Attachment Applet/88-3CM36Q
1-2Z2: This is the record Id of SIS Account Entry Applet.
88-3CM36Q: This is the record Id of Attachment/URL.
{
"Id": "88-3CM36Q",
"AccntFileAutoUpdFlg": "N",
"AccntFileSize": "",
"Comment": "",
"AccntFileDate": "",
"AccntFileExt": "URL",
"AccntFileName": "https://google.com"
"Link": [],
"UIMetadata": { .... }
}GET Operation - Retrieve Metadata using Query Params
GET URL: https://<hostname:port>/oracle/openintegration/v1.0/ui/Account Attachment View/SIS Account Entry Applet/1-2Z2/Account Attachment Applet/?pagesize=2&fields=AccntFileName,AccntFileExt&searchspec=([AccntFileName] LIKE 'h*')&sortspec=AccntFileName:desc&startrownum=1
1-2Z2: This is the record Id of SIS Account Entry Applet.
searchspec=([AccntFileName] LIKE 'h*'): Fetch all the records that starts with 'h'
sortspec=AccntFileName:desc: Sort the records in descending order
fields=AccntFileName,AccntFileExt: Filter the fields AccntFileName, AccntFileExt from the result
startrownum=1: consider starting from row 1 while ignoring row 0 from the result
pagesize=2: return only two records from the result
{
"items": [
{
"AccntFileExt": "URL",
"AccntFileName": "https://oracle.com",
"Link": []
},
{
"AccntFileExt": "pdf",
"AccntFileName": "helloWorld",
"Link": []
}
],
"Link": [],
"UIMetadata": { .... }
}Delete Operation - Delete Record
DELETE URL: https://<hostname:port>/oracle/openintegration/v1.0/ui/Account Attachment View/SIS Account Entry Applet/1-2Z2/Account Attachment Applet/88-3CM36Q
1-2Z2: This is the record Id of SIS Account Entry Applet.
88-3CM36Q: This is the record Id of Attachment/URL.