Update an attachment for an external transaction
/fscmRestApi/resources/11.13.18.05/cashExternalTransactions/{ExternalTransactionId}/child/attachments/{attachmentsUniqID}
Request
-
ExternalTransactionId(required): integer(int64)
The unique identifier of the external transaction.
-
attachmentsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Attachments resource and used to uniquely identify an instance of Attachments. The client should not generate the hash key value. Instead, the client should query on the Attachments collection resource in order to navigate to a specific instance of Attachments to get the hash key.
-
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.
- application/json
object
-
CategoryName: string
Title:
Category
Maximum Length:30
The category of the attachment. - ContentRepositoryFileShared: boolean
-
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
The type of the attachment. -
Description: string
Title:
Description
Maximum Length:255
The description for the attachment. -
DmDocumentId: string
Maximum Length:
255
The unique identifier of the attachment. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
The folder path of the attachment. -
DmVersionNumber: string
Maximum Length:
255
The version number of the attachment. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
The error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
The error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
The expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File Contents
The contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
The file name of the attachment. -
FileUrl: string
Title:
File Url
The URL of the attachment. -
PostProcessingAction: string
Title:
PostProcessingAction
The name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
Title
The title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
The content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
The length of the attachment file. -
UploadedFileName: string
Title:
Uploaded File Name
The name of the attachment file. -
UploadedText: string
Title:
Uploaded Text
The text of the attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
The URI of the attachment. -
Url: string
Title:
Url
Maximum Length:4000
The URL of the attachment.
Response
- application/json
Default Response
-
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.
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
The unique identifier of the attached document. -
CategoryName: string
Title:
Category
Maximum Length:30
The category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
The user who created the record. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
The user who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the record was created. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
The type of the attachment. -
Description: string
Title:
Description
Maximum Length:255
The description for the attachment. -
DmDocumentId: string
Maximum Length:
255
The unique identifier of the attachment. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
The folder path of the attachment. -
DmVersionNumber: string
Maximum Length:
255
The version number of the attachment. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
The error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
The error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
The expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File Contents
The contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
The file name of the attachment. -
FileUrl: string
Title:
File Url
The URL of the attachment. -
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
The date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
The user who last updated the record. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
The user who last updated the record. -
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
The title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
The content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
The length of the attachment file. -
UploadedFileName: string
Title:
Uploaded File Name
The name of the attachment file. -
UploadedText: string
Title:
Uploaded Text
The text of the attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
The URI of the attachment. -
Url: string
Title:
Url
Maximum Length:4000
The URL of the attachment. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
The user who created the attachment.
array
Links
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.
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Examples
The following example shows how to retrieve and update an attachment for an external transaction.
Get all the attachments of an external transaction and use the self URI of the specific attachment. Then, submit a PATCH request on the REST resource using cURL.
Here's the cURL command to retrieve all the attachments:
curl -i -u "<username>:<password>" -H "Content-Type: application/json" -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/cashExternalTransactions/300100173517340/child/attachments
Example Request Payload
The following example shows the contents of the request body in JSON format:
{
"items" : [
{
"AttachedDocumentId" : 300100173394136,
"LastUpdateDate" : "2019-02-06T21:32:19.318+00:00",
"LastUpdatedBy" : "CASH_MANAGER",
"DatatypeCode" : "FILE",
...
"links" : [
{
"rel" : "self",
"href" : "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/cashExternalTransactions/300100173517340/child/attachments/00020000000EACED00057708000110F0843B70D80000000EACED00057708000110F0843B70D7",
"name" : "attachments",
"kind" : "item"
},
{
"rel" : "canonical",
"href" : "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/cashExternalTransactions/300100173517340/child/attachments/00020000000EACED00057708000110F0843B70D80000000EACED00057708000110F0843B70D7",
"name" : "attachments",
"kind" : "item"
},
...
]
},
...
],
"count" : 200,
"hasMore" : false,
"limit" : 500,
"offset" : 0,
"links" : [
{
"rel" : "self",
"href" : "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/cashExternalTransactions/300100173517340/child/attachments",
"name" : "attachments",
"kind" : "collection"
}
]
}
A
hash key of ExternalTransactionId
and AttachedDocumentId
identifies an attachment.
Here's the cURL command that uses the hash key in the self URI to retrieve the attachment:
curl -i -u "<username>:<password>" -H "Content-Type: application/json" -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/cashExternalTransactions/300100173517340/child/attachments/00020000000EACED00057708000110F0843B70D80000000EACED00057708000110F0843B70D7
Here's the cURL command that uses the hash key in the self URI to update the attachment:
curl -i -u "<username>:<password>" -H "Content-Type: application/json" -X PATCH -d <payload> https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/invoices/300100173325416/child/cashExternalTransactions/300100173517340/child/attachments/00020000000EACED00057708000110F0843B70D80000000EACED00057708000110F0843B70D7
Example Request Payload
The following example shows the contents of the request body in JSON format:
{ "FileName" : "REST External Transaction Attachment File Updated.txt", "Title" : "REST External Transaction File Updated Title", "Description" : "REST External Transaction file updated description" }
Example Response Body
The following example shows the contents of the response body in JSON format:
{ "AttachedDocumentId" : 300100173394136, "FileName" : "REST External Transaction Attachment File Updated.txt", "Title" : "REST External Transaction File Updated Title", "Description" : "REST External Transaction file updated description" ... "links" : [ { "rel" : "self", "href" : "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/cashExternalTransactions/300100173517340/child/attachments/00020000000EACED00057708000110F0843B70D80000000EACED00057708000110F0843B70D7", "name" : "attachments", "kind" : "item" }, { "rel" : "canonical", "href" : "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/cashExternalTransactions/300100173517340/child/attachments/00020000000EACED00057708000110F0843B70D80000000EACED00057708000110F0843B70D7", "name" : "attachments", "kind" : "item" }, ... ] }