Update an attachment
patch
/fscmRestApi/resources/11.13.18.05/draftPurchaseOrders/{draftPurchaseOrdersUniqID}/child/lines/{POLineId}/child/attachments/{attachmentsUniqID}
Request
Path Parameters
-
POLineId(required): integer(int64)
Value that uniquely identifies the purchase order line.
-
attachmentsUniqID(required): string
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
-
draftPurchaseOrdersUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Draft Purchase Orders resource and used to uniquely identify an instance of Draft Purchase Orders. The client should not generate the hash key value. Instead, the client should query on the Draft Purchase Orders collection resource in order to navigate to a specific instance of Draft Purchase Orders to get the hash key.
Header Parameters
-
Metadata-Context:
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".
-
REST-Framework-Version:
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
CategoryName: string
Title:
Category
Maximum Length:30
Category of the attached document. - ContentRepositoryFileShared: boolean
-
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
Abbreviation that identifies the data type. -
Description: string
Title:
Description
Maximum Length:255
Description of the attached document. -
DmDocumentId: string
Maximum Length:
255
Value that uniquely identifies the attached document. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
Folder path of the attached document. -
DmVersionNumber: string
Maximum Length:
255
Number that identifies the version of the attached document. -
DownloadInfo: string
Title:
DownloadInfo
JSON-formatted string that contains information required to programmatically retrieve a large file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
Abbreviation that identifies the error code, if any, for the attached document. -
ErrorStatusMessage: string
Title:
Error Status Message
Text of the error message, if any, for the attached document. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
Date when the content in the attached document expires. -
FileContents: string
(byte)
Title:
File Contents
Contents of the attached document. -
FileName: string
Title:
File Name
Maximum Length:2048
File name of the attached document. -
FileUrl: string
Title:
File Url
URL (Uniform Resource Locator) of the attached document. -
PostProcessingAction: string
Title:
PostProcessingAction
The name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
Title
Title of the attached document. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
Content type of the attached document. -
UploadedFileLength: integer
Title:
File Size
Length of the attached document. -
UploadedFileName: string
Title:
Uploaded File Name
Name of the attached document. -
UploadedText: string
Title:
Uploaded Text
Text of the attached document. -
Uri: string
Title:
Uri
Maximum Length:4000
URI (Uniform Resource Identifier) that identifies the attached document. -
Url: string
Title:
Url
Maximum Length:4000
URI (Uniform Resource Identifier) that identifies the attached document.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
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".
-
REST-Framework-Version:
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.
Root Schema : draftPurchaseOrders-lines-attachments-item-response
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
An identifier used for tracking the uploaded files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
Value that uniquely identifies the document that is attached to the purchase order. It is a primary key that the application creates when the user attaches a document to the purchase order. -
CategoryName: string
Title:
Category
Maximum Length:30
Category of the attached document. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
User who created the attached document. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
Login that the user used when creating the document that is attached to the purchase order. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date when the user created the attached document. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
Abbreviation that identifies the data type. -
Description: string
Title:
Description
Maximum Length:255
Description of the attached document. -
DmDocumentId: string
Maximum Length:
255
Value that uniquely identifies the attached document. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
Folder path of the attached document. -
DmVersionNumber: string
Maximum Length:
255
Number that identifies the version of the attached document. -
DownloadInfo: string
Title:
DownloadInfo
JSON-formatted string that contains information required to programmatically retrieve a large file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
Abbreviation that identifies the error code, if any, for the attached document. -
ErrorStatusMessage: string
Title:
Error Status Message
Text of the error message, if any, for the attached document. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
Date when the content in the attached document expires. -
FileContents: string
(byte)
Title:
File Contents
Contents of the attached document. -
FileName: string
Title:
File Name
Maximum Length:2048
File name of the attached document. -
FileUrl: string
Title:
File Url
URL (Uniform Resource Locator) of the attached document. -
FileWebImage: string
(byte)
Title:
File Web Image
Read Only:true
The base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
Date and time when the user most recently updated the document that is attached to the purchase order. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
User who most recently updated the document that is attached to the purchase order. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
Login that the user used when updating the document that is attached to the purchase order. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingAction
The name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
Title
Title of the attached document. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
Content type of the attached document. -
UploadedFileLength: integer
Title:
File Size
Length of the attached document. -
UploadedFileName: string
Title:
Uploaded File Name
Name of the attached document. -
UploadedText: string
Title:
Uploaded Text
Text of the attached document. -
Uri: string
Title:
Uri
Maximum Length:4000
URI (Uniform Resource Identifier) that identifies the attached document. -
Url: string
Title:
Url
Maximum Length:4000
URI (Uniform Resource Identifier) that identifies the attached document. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
Login that the user used when adding or modifying the attached document.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Examples
This example describes how to update an attachment.
Example cURL Command
Use the following cURL command to submit a request on the REST resource.
curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/draftPurchaseOrders/draftPurchaseOrdersUniqID/child/lines/POLineId/child/attachments/AttachedDocumentId"
Example Request Body
The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it updates.
{ "Description": "Updated attachment description" }
Example Response Body
The following example includes the contents of the response body in JSON format:
{ "AttachedDocumentId": 300100198186746, "LastUpdateDate": "2020-10-19T08:06:04.730+00:00", "LastUpdatedBy": "CVBUYER01", "DatatypeCode": "FILE", "FileName": "REST Attachment.txt", "DmFolderPath": null, "DmDocumentId": "UCMFA00024862", "DmVersionNumber": "24865", "Url": null, "CategoryName": "TO_SUPPLIER", "UserName": "To Supplier", "Uri": null, "FileUrl": "/content/conn/FusionAppsContentRepository/uuid/dDocID%3a24865?XFND_SCHEME_ID=1&XFND_CERT_FP;=0A3C9E5F872EB24E37333CB5F528CEEFA1491781&XFND_RANDOM;=2297969761824975565&XFND_EXPIRES;=1603095542583&XFND_SIGNATURE;=O6xnOiSL1ODP9vGJry9ITFlWPmMs4OWpcbkziFXKmee6PvxS~hTLB9bEKHssByieEri1KopjlBSbTwIjS5uEFcxIPVAMv86ecNCK5Oh29NpQISWx5bpL3iOuj4zeOVMn3N6VypXXnMXend1eCbRBvc5-R0l8rR7M2176iEH-tGpwOwjciMqYbIHUfnAExBMRA0EwC4tJ3RhQKhn42TONWPqYrvodK65htkmmOuv2KWcFdISbZmTfnvZsVPpyr6POnwWCBw7O0hWIAa2e4wOfoIYp~KHE2UdzXHuPs6SjaLG2qDBr0zYHDBxBMbSJ0kT7vRgkkxCjflTEAgTND7X-6w__&Id;=24865&download;", "UploadedText": null, "UploadedFileContentType": "text/plain", "UploadedFileLength": 7, "UploadedFileName": null, "ContentRepositoryFileShared": "false", "Title": "REST Attachment.txt", "Description": "Updated attachment description", "ErrorStatusCode": null, "ErrorStatusMessage": null, "CreatedBy": "BUYER01", "CreationDate": "2020-10-19T08:06:03+00:00", "ExpirationDate": null, "LastUpdatedByUserName": "Clare Jones", "CreatedByUserName": "Clare Jones", "AsyncTrackerId": null, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/draftPurchaseOrders/558749/child/lines/702504/child/attachments/00020000000EACED00057708000110F085B5BEFA0000000EACED00057708000110F085B5BEF9", "name": "attachments", "kind": "item" }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/draftPurchaseOrders/558749/child/lines/702504/child/attachments/00020000000EACED00057708000110F085B5BEFA0000000EACED00057708000110F085B5BEF9", "name": "attachments", "kind": "item" }, { "rel": "parent", "href": "https://servername/fscmRestApi/resources/version/draftPurchaseOrders/558749/child/lines/702504", "name": "lines", "kind": "item" }, { "rel": "enclosure", "href": "https://servername/fscmRestApi/resources/version/draftPurchaseOrders/558749/child/lines/702504/child/attachments/00020000000EACED00057708000110F085B5BEFA0000000EACED00057708000110F085B5BEF9/enclosure/FileContents", "name": "FileContents", "kind": "other" } ] }