Multiple Attachments APIs
Metadata API
Metadata API supports the new type of property in the property related operations, so that integrations are able to create, update and remove the properties with new type.
- Property attribute type is extended with new allowed value "attachments"
- New attribute "storageApplication" is added to the property schema. It accepts labels of "Oracle Storage" applications. If the provided value is not a label of an "Oracle Storage" application, the request is rejected with 400 code and the message "{...} is not a label of Oracle Storage application"
- The property with type "attachments" are not meant to support the following attributes.
Events API
Events API provides updates for the 'Attachment' properties as a part of 'formSubmitted' event.
|
"time": "2024-03-07 17:22:40", "user": "maksym", "formIdentifier": { "formSubmitId": "36", "formLabel": "iak_form_rw" }, "activityDetails": { "activityId": 4232352, "iak_act_attachments_ObS": { "items": [ "fileName": "20240307185230352_1_4232352_iak_act_attachments_ObS.jpg", "href": "https://axabnyzh1qxb.objectstorage.eu-amsterdam-1.oci.customer-oci.com/n/axabnyzh1qxb/b/multiImageBucket/o/1_4232352_iak_act_attachments_ObS/20240307185230352_1_4232352_iak_act_attachments_ObS.jpg", "uploadStatus": "uploaded", "mediaType": "image/jpeg" }, "fileName": "20240307185231869_1_4232352_iak_act_attachments_ObS.jpg", "href": "https://axabnyzh1qxb.objectstorage.eu-amsterdam-1.oci.customer-oci.com/n/axabnyzh1qxb/b/multiImageBucket/o/1_4232352_iak_act_attachments_ObS/20240307185231869_1_4232352_iak_act_attachments_ObS.jpg", "uploadStatus": "uploaded", "mediaType": "image/jpeg" }, "fileName": "20240307185235994_1_4232352_iak_act_attachments_ObS.jpg", "href": "https://axabnyzh1qxb.objectstorage.eu-amsterdam-1.oci.customer-oci.com/n/axabnyzh1qxb/b/multiImageBucket/o/1_4232352_iak_act_attachments_ObS/20240307185235994_1_4232352_iak_act_attachments_ObS.jpg", "uploadStatus": "uploaded", "mediaType": "image/jpeg" }, "fileName": "20240307192226408_1_4232352_iak_act_attachments_ObS.jpg", "uploadStatus": "pending", "mediaType": "image/jpeg" } ] }, "iak_act_attachments_ObS_geo": { "items": [] } } } |
'Get activity' API
It will be possible to fetch data showing taken photos via the 'Get activity' API calls.
|
{ "customerName": "Juna Scheffler", "streetAddress": "3105 STONEBROOK DR", .... "DISPATCHER_COMMENTS": "EXPLODE", "attachments_property": { "items": [ { "filename": "Console.jpg", "uploadStatus": "uploaded", "mediaType": "image/png", "href": "https://oceintegration-oce0004.cec.ocp.oraclecloud.com/system/api/v1/ofs/folder/activityId/filename5" }, { "filename": "Console2.jpg", "uploadStatus": "pending", "mediaType": "image/png", "href": "https://oceintegration-oce0004.cec.ocp.oraclecloud.com/system/api/v1/ofs/folder/activityId/filename5" } }, "links": [ ... ] } |
The feature decreases integration efforts because photos will be stored directly in the customer's storage and associated with work orders in customer's systems
- For Fusion customers, photos are properly structured and attached to either the Service Work Order or the Maintenance Work Order
- For non-Fusion customers, photos will be saved in OCI Object storage
Steps to Enable
Review the REST service definition in the REST API guides to leverage (available from the Oracle Help Center > your apps service area of interest > APIs & Schema). If you are new to Oracle's REST services you may want to begin with the Quick Start section.
Tips And Considerations
'Attachments' properties are not supported in:
- Plugin API Framework
- Inbound & Outbound SOAP APIs