Add or Replace File Contents for Sales Order Attachments
You can use the Sales Orders for Order Hub resource to create a sales order. To create an attachment on sales order, you can create a sales order with order header or order line attachment without file contents and then upload the file using enclosure.
Let's discuss these scenarios:
-
Create sales order with order header attachment without file contents
-
Upload the file using enclosure
Create Order Attachment Without File Contents
In this scenario, you create a sales order with order header attachment without file contents.
Example URL
Use this resource URL format.
POST
curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub"
Example Request
Here's an example of the request body in JSON format.
{ "SourceTransactionNumber":"R13_Header_Attach_01", "SourceTransactionSystem":"GPR", "SourceTransactionId":"R13_Header_Attach_01", "BusinessUnitName":"Vision Operations", "BuyingPartyName":"Computer Service and Rentals", "BuyingPartyContactName":"Brian Smith", "TransactionType":"Standard Orders", "RequestedShipDate":"2019-10-19T20:49:12+00:00", "RequestedFulfillmentOrganizationName":"Vision Operations", "PaymentTerms":"30 Net", "TransactionalCurrencyName":"US Dollar", "RequestingBusinessUnitName":"Vision Operations", "FreezePriceFlag":false, "FreezeShippingChargeFlag":false, "FreezeTaxFlag":false, "SubmittedFlag":true, "SourceTransactionRevisionNumber":1, "attachments": [{ "DatatypeCode" : "FILE", "FileName" : "abc.pdf", "CategoryName" : "MISC", "UploadedText" : null, "UploadedFileContentType":"application/pdf ", "UploadedFileName" : "abc.pdf", "ContentRepositoryFileShared" : "false", "Title" : "TEST1", "Description" : "Sigma Filter" }], "lines":[{ "SourceTransactionLineId":"1", "SourceTransactionLineNumber":"1", "SourceTransactionScheduleId":"1", "SourceScheduleNumber":"1", "TransactionCategoryCode":"ORDER", "TransactionLineType":"Buy", "ProductNumber":"AS92888", "OrderedQuantity":5, "OrderedUOM":"Each" }] }
Example Response
Here's an example of the response body in JSON format.
{ "HeaderId" : 300100298491278, "OrderNumber" : "R13_Header_Attach_01", "SourceTransactionNumber" : "R13_Header_Attach_01", "SourceTransactionSystem" : "GPR", "SourceTransactionId" : "R13_Header_Attach_01", "BusinessUnitId" : 204, "BusinessUnitName" : "Vision Operations", "TransactionOn" : "2020-03-17T10:03:02.001+00:00", "BuyingPartyId" : 1006, "BuyingPartyName" : "Computer Service and Rentals", "BuyingPartyNumber" : null, "BuyingPartyPersonFirstName" : null, ... ... "lines" : [ { "HeaderId" : 300100298491278, "LineId" : 300100298491282, "FulfillLineId" : 300100298491281, "SourceTransactionLineId" : "1", "SourceTransactionLineNumber" : "1", "SourceTransactionId" : "R13_Header_Attach_01", "SourceTransactionNumber" : "R13_Header_Attach_01", "SourceTransactionSystem" : "GPR", ... ... "links" : [ { "rel" : "self", "href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3AR13_Header_Attach_01/child/lines/00020000000EACED00057708000110F08BB045910000000EACED00057708000110F08BB04592", "name" : "lines", "kind" : "item", "properties" : { "changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000002770400000002737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B0200007870000000017371007E00020000000178" } }, { "rel" : "canonical", "href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3AR13_Header_Attach_01/child/lines/00020000000EACED00057708000110F08BB045910000000EACED00057708000110F08BB04592", "name" : "lines", "kind" : "item" }, { "rel" : "parent", "href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3AR13_Header_Attach_01", "name" : "salesOrdersForOrderHub", "kind" : "item" }, { "rel" : "child", "href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3AR13_Header_Attach_01/child/lines/00020000000EACED00057708000110F08BB045910000000EACED00057708000110F08BB04592/child/additionalInformation", "name" : "additionalInformation", "kind" : "collection" }, ... ... { "rel" : "child", "href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3AR13_Header_Attach_01/child/lines/00020000000EACED00057708000110F08BB045910000000EACED00057708000110F08BB04592/child/transactionItemAttributes", "name" : "transactionItemAttributes", "kind" : "collection" } ] } ], "attachments" : [ { "AttachedDocumentId" : 300100298491280, "LastUpdateDate" : "2020-03-17T10:03:13.864+00:00", "LastUpdatedBy" : "OPERATIONS", "DatatypeCode" : "FILE", "FileName" : "abc.pdf", "DmFolderPath" : null, "DmDocumentId" : null, "DmVersionNumber" : null, "Url" : null, "CategoryName" : "MISC", "UserName" : null, "Uri" : null, "FileUrl" : null, "UploadedText" : null, "UploadedFileContentType" : "application/pdf", "UploadedFileLength" : null, "UploadedFileName" : "abc.pdf", "ContentRepositoryFileShared" : "false", "Title" : "TEST1", "Description" : "Sigma Filter", "ErrorStatusCode" : null, "ErrorStatusMessage" : null, "CreatedBy" : "OPERATIONS", "CreationDate" : "2020-03-17T10:03:02.081+00:00", "ExpirationDate" : null, "LastUpdatedByUserName" : "Patric", "CreatedByUserName" : "Patric", "AsyncTrackerId" : null, "links" : [ { "rel" : "self", "href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3AR13_Header_Attach_01/child/attachments/00020000000EACED00057708000110F08BB045900000000EACED00057708000110F08BB0458F", "name" : "attachments", "kind" : "item" }, { "rel" : "canonical", "href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3AR13_Header_Attach_01/child/attachments/00020000000EACED00057708000110F08BB045900000000EACED00057708000110F08BB0458F", "name" : "attachments", "kind" : "item" }, { "rel" : "parent", "href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3AR13_Header_Attach_01", "name" : "salesOrdersForOrderHub", "kind" : "item" }, { "rel" : "enclosure", "href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3AR13_Header_Attach_01/child/attachments/00020000000EACED00057708000110F08BB045900000000EACED00057708000110F08BB0458F/enclosure/FileContents", "name" : "FileContents", "kind" : "other" } ] } ], "links" : [ { "rel" : "self", "href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3AR13_Header_Attach_01", "name" : "salesOrdersForOrderHub", "kind" : "item", "properties" : { "changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel" : "canonical", "href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3AR13_Header_Attach_01", "name" : "salesOrdersForOrderHub", "kind" : "item" }, ... ... { "rel" : "child", "href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3AR13_Header_Attach_01/child/totals", "name" : "totals", "kind" : "collection" } ] }
Add or Replace File Contents in the Attachment
In this scenario, you can add or replace the file contents of the attachment in the sales order R13_Header_Attach_01 using the PUT method. You manage file contents using enclosure through REST.
Note:
You can also replace existing file contents of the same file type.
Example URL
Use this resource URL format.
PUT
curl -i -X PUT \ -H "Authorization:Basic c2Ntb3BlcmF0aW9uczpXZWxjb21lMQ==" \ -H "REST-FRAMEWORK:4" \ -H "Content-Type:application/pdf" \ -T "./abc.pdf" \ 'https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3AR13_Header_Attach_01/child/attachments/00020000000EACED00057708000110F08BB045900000000EACED00057708000110F08BB0458F/enclosure/FileContents'