1. REST API for Oracle Supply Chain Management Cloud
  2. Tasks
  3. Order Management
  4. Sales Orders for Order Hub
  5. Attachments

Create one attachment

post

/fscmRestApi/resources/11.13.18.05/salesOrdersForOrderHub/{OrderKey}/child/attachments

Request

Path Parameters
  • Value that uniquely identifies the sales order. It can have the following formats.

    - Concatenation of SourceOrderSystem, a colon, and the value of SourceTransactionId. For orders created through the Oracle Fusion Cloud Order Management work area, the SourceTransactionId is same as the HeaderId. For example, if SourceOrderSystem is LEG and SourceTransactionId is R13_Sample_Order, the value of this attribute is LEG:R13_Sample_Order. This format of the OrderKey in the URL always returns the latest version of the sales order. When a draft exists, that becomes the latest version of the sales order. When invoking GET sales order using this OrderKey format, the URLs in the "links" section point to the latest version of the sales order and the corresponding child objects.
    Example: /salesOrdersForOrderHub/LEG:R13_Sample_Order points to the latest version of the order with SourceTransactionId "R13_Sample_Order" in the SourceOrderSystem "LEG".

    - Primary key of the sales order, which is HeaderId. This format of the OrderKey is useful when the order has multiple revisions because it helps in accessing either the older version or the latest version of the order. When there's a draft revision then HeaderId can be used to access the processing order. When invoking GET sales order using this OrderKey format, the URLs in the "links" section also point to that specific version of the sales order and the corresponding child objects. Only the Get operation is supported on older revisions of the order.
    Example: /salesOrdersForOrderHub/12345 points to an order with HeaderId 12345.

    When a q parameter or query finder is used to GET an order that has multiple versions then the latest version has the OrderKey in the format <sourceOrderSystem>:<SourceTransactionId> whereas reference orders have OrderKey in the format of HeaderId.
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.
  • Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
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 : salesOrdersForOrderHub-attachments-item-response
Type: object
Show Source
Back to Top

Examples

This example describes how to create one attachment.

Example cURL Command

Use the following cURL command to submit a request on the REST resource.

curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' 
"https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/OrderKey/child/attachments"

For example:

curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' 
"https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3AR13_Header_Attach_01/child/attachments"

Example Request Body

The following example includes the contents of the request body in JSON format to add a new order header attachment to an existing order.

You replace the request payload in the example cURL command with the contents of the example request body. The request payload specifies attribute values that the command uses in the record that it creates.

You can achieve the same results with Create sales orders using the upsert-mode header parameter. See the examples in the Create sales orders section.

{
      "DatatypeCode" : "FILE",
      "FileName" : "TEST1.txt",
      "CategoryName" : "MISC",
      "UploadedText" : null,
      "UploadedFileContentType":"text/xml",
      "UploadedFileName" : "TEST1.txt",
      "ContentRepositoryFileShared" : "false",
      "Title" : "TEST1",
      "Description" : "Sigma Filter",
      "FileContents": "VEVTVCBIRUFERVIgQVRUQUNITUVOVCBDT05URU5U"
   }

Example Response Body

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

{
  "AttachedDocumentId" : 300100569441858,
  "LastUpdateDate" : "2022-10-19T19:27:24.039+00:00",
  "LastUpdatedBy" : "SCMOPERATIONS",
  "DatatypeCode" : "FILE",
  "FileName" : "TEST1.txt",
  "DmFolderPath" : null,
  "DmDocumentId" : "UCMFA00097346",
  "DmVersionNumber" : "97348",
  "Url" : null,
  "CategoryName" : "MISC",
  "UserName" : null,
  "Uri" : null,
  "FileUrl" : "/content/conn/FusionAppsContentRepository/uuid/dDocID:97348?download&XFND_SCHEME_ID=1&XFND_CERT_FP=050B97D1B0F57AC305F88E205CE029181C4A07C8&XFND_RANDOM=-5422334639479197435&XFND_EXPIRES=1666208244490&XFND_SIGNATURE=ePztArhG0UCaWE2dHUXnEmxfxfQbIujB3HvhwoEBG5vLlTmQH5hP1Ir6GDeH2LLTsoUvpjXFkI9tLOVqYb~4J5M75gxcNHF-O0oh4umhsIQlF83BJNrJ8p-IxSbY8d2YesRnditGnlawdLnev5ulyxadyZjMILYk9oT25QsXZvRPAuJL3TzF4gaoISbsAknom0JYl8ELyKAaEorKuLz2oxCDtm96JdgteAO7oYqA~e74PceQd6lKd2oQBtLdrfqVF87TNJ1H6e-BvcHeigES-i6wAJDmwREjjVZJyhbRgX1W15-tPpmDxinrYGxG3sArN2Iucff1~RmQBS1ASf0V5Q__&Id=97348",
  "UploadedText" : null,
  "UploadedFileContentType" : "text/plain",
  "UploadedFileLength" : 30,
  "UploadedFileName" : "TEST1.txt",
  "ContentRepositoryFileShared" : "false",
  "Title" : "TEST1",
  "Description" : "Sigma Filter",
  "ErrorStatusCode" : null,
  "ErrorStatusMessage" : null,
  "CreatedBy" : "SCMOPERATIONS",
  "CreationDate" : "2022-10-19T19:27:22+00:00",
  "ExpirationDate" : null,
  "LastUpdatedByUserName" : "Patric",
  "CreatedByUserName" : "Patric",
  "AsyncTrackerId" : null,
  "DownloadInfo" : "{\"XFND_EXPIRES\":\"1666208244495\",\"XFND_SCHEME_ID\":\"1\",\"XFND_CERT_FP\":\"050B97D1B0F57AC305F88E205CE029181C4A07C8\",\"XFND_SIGNATURE\":\"hqqLwhsVVuoDXmBaD~sQJu6ih5arzaOOerPecyG26~ZsEim5l6CUxueqR3kRnmshR4dJPmnucg8Dp3PYIS2ziEaBGZ7OLAm2h9s8QYPJODNWFBfU7BtlMpuFhm~KhmF6QRnhxCcP2MztBAIHXnn7Qw0UNQAcdjOLt~kZFAaoVpQ10oHoBnmWTUaeHZjf8wGg7NzR3D2qfT2P5MH9RAfOHOBPepiOG~nySb9srbZuCYSddXIgd8siqfFW0lPN7j7UPzrZtGACXqcSxeWOQmBrJqgwH0LVSimafs712ocQy6kzdA7EW8qj34lL7NIpqxCPcWDEBAMs31c2QKPINZOKfw__\",\"XFND_RANDOM\":\"653305784145186663\"}",
  "links" : [ {
    "rel" : "self",
    "href" : "https://server/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3AR13_Header_Attach_01/child/attachments/00020000000EACED00057708000110F09BD6A6420000000EACED00057708000110F09BD6A641",
    "name" : "attachments",
    "kind" : "item"
  }, {
    "rel" : "canonical",
    "href" : "https://server/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3AR13_Header_Attach_01/child/attachments/00020000000EACED00057708000110F09BD6A6420000000EACED00057708000110F09BD6A641",
    "name" : "attachments",
    "kind" : "item"
  }, {
    "rel" : "parent",
    "href" : "https://server/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3AR13_Header_Attach_01",
    "name" : "salesOrdersForOrderHub",
    "kind" : "item"
  } ]
}
Back to Top