Update one attachment
patch
/fscmRestApi/resources/11.13.18.05/supplierNegotiations/{supplierNegotiationsUniqID}/child/attachments/{attachmentsUniqID}
Request
Path Parameters
-
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.
-
supplierNegotiationsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Supplier Negotiations resource and used to uniquely identify an instance of Supplier Negotiations. The client should not generate the hash key value. Instead, the client should query on the Supplier Negotiations collection resource in order to navigate to a specific instance of Supplier Negotiations to get the hash key.
Header Parameters
-
Metadata-Context: string
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: string
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:
CategoryMaximum Length:30Category of the attachment. - ContentRepositoryFileShared: boolean
-
DatatypeCode: string
Title:
TypeMaximum Length:30Default Value:FILEAbbreviation that identifies the data type. Possible values include FILE, FOLDER, TEXT, or WEB_PAGE. -
Description: string
Title:
DescriptionMaximum Length:255Description of the attachment. -
DmDocumentId: string
Maximum Length:
255Value that uniquely identifies the attached document. -
DmFolderPath: string
Title:
Dm Folder PathMaximum Length:1000Folder path of the attachment. -
DmVersionNumber: string
Maximum Length:
255Number that identifies the version of the attached document. -
DownloadInfo: string
Title:
DownloadInfoJSON object, represented as a string, containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status CodeAbbreviation that identifies the error, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status MessageText of the error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration DateDate when the contents in the attachment expires. -
FileContents: string
(byte)
Title:
File ContentsContents of the attachment. -
FileName: string
Title:
File NameMaximum Length:2048File name of the attachment. -
FileUrl: string
Title:
File UrlURL (Uniform Resource Locator) of the attachment. -
PostProcessingAction: string
Title:
PostProcessingActionName of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
TitleTitle of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content TypeContent type of the attachment. -
UploadedFileLength: integer
Title:
File SizeLength of the attached file. -
UploadedFileName: string
Title:
Uploaded File NameName of the attached file. -
UploadedText: string
Title:
Uploaded TextText of the attachment. -
Uri: string
Title:
UriMaximum Length:4000URI (Uniform Resource Identifier) that identifies the attachment. -
Url: string
Title:
UrlMaximum Length:4000URI (Uniform Resource Identifier) that identifies the attachment.
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 : supplierNegotiations-attachments-item-response
Type:
Show Source
object-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker IdAn identifier used for tracking the uploaded files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document IdValue that uniquely identifies the attachment. It is a primary key generated by the application when the user attaches a document. -
CategoryName: string
Title:
CategoryMaximum Length:30Category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:255User who created the attachment. -
CreatedByUserName: string
Title:
Created By User NameRead Only:trueLogin used by the user when creating the attachment for the negotiation. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueDate when the user created the attachment record. -
DatatypeCode: string
Title:
TypeMaximum Length:30Default Value:FILEAbbreviation that identifies the data type. Possible values include FILE, FOLDER, TEXT, or WEB_PAGE. -
Description: string
Title:
DescriptionMaximum Length:255Description of the attachment. -
DmDocumentId: string
Maximum Length:
255Value that uniquely identifies the attached document. -
DmFolderPath: string
Title:
Dm Folder PathMaximum Length:1000Folder path of the attachment. -
DmVersionNumber: string
Maximum Length:
255Number that identifies the version of the attached document. -
DownloadInfo: string
Title:
DownloadInfoJSON object, represented as a string, containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status CodeAbbreviation that identifies the error, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status MessageText of the error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration DateDate when the contents in the attachment expires. -
FileContents: string
(byte)
Title:
File ContentsContents of the attachment. -
FileName: string
Title:
File NameMaximum Length:2048File name of the attachment. -
FileUrl: string
Title:
File UrlURL (Uniform Resource Locator) of the attachment. -
FileWebImage: string
(byte)
Title:
File Web ImageRead Only:trueThe Base64-encoded image of the file, displayed in .png format, if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update DateRead Only:trueDate and time when the user last updated the attachment. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:255User who last updated the attachment. -
LastUpdatedByUserName: string
Title:
Last Updated By UserRead Only:trueLogin used by the user when updating the attachment for the negotiation. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingActionName of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
TitleTitle of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content TypeContent type of the attachment. -
UploadedFileLength: integer
Title:
File SizeLength of the attached file. -
UploadedFileName: string
Title:
Uploaded File NameName of the attached file. -
UploadedText: string
Title:
Uploaded TextText of the attachment. -
Uri: string
Title:
UriMaximum Length:4000URI (Uniform Resource Identifier) that identifies the attachment. -
Url: string
Title:
UrlMaximum Length:4000URI (Uniform Resource Identifier) that identifies the attachment. -
UserName: string
Title:
User NameRead Only:trueMaximum Length:255Sign-in details used by the user when adding or modifying the attachment.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed 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/supplierNegotiations/supplierNegotiationsUniqID/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.
{
"Title": "Configuration File",
"Description": "Assembly details for the configured item"
}
Example Response Body
The following example includes the contents of the response body in JSON format:
{
"AttachedDocumentId": 300100195271402,
"LastUpdateDate": "2020-08-25T17:37:26.418+00:00",
"LastUpdatedBy": "CVBUYER01",
"DatatypeCode": "FILE",
"FileName": "REST Attachment.txt",
"DmFolderPath": null,
"DmDocumentId": "UCMFA00014540",
"DmVersionNumber": "14540",
"Url": null,
"CategoryName": "TO_SUPPLIER",
"UserName": "To Supplier",
"Uri": null,
"FileUrl": "/content/conn/FusionAppsContentRepository/uuid/dDocID%3a14540?XFND_SCHEME_ID=1 &XFND_CERT_FP=176F8D3A734FFD359562250BB87D88D7B936BC99 &XFND_RANDOM=655074106485624605 &XFND_EXPIRES=1598379365283 &XFND_SIGNATUREyha1F7nJ3Sv3jar21Hdjjt1JAzfO-oHxres8D434t1rjNMrTUWSPsGJrWSkE-UcPGA7KA7lG2bXzIB4BSjYrJFuc5kN9BS8tYSK7va31DGsLhCPAFURqOhQlkAkFzy-GWLwnb6CTkiTGONTygLEeLrHtj2SNEhVq0lR-btgGMFyzvKUKcGm5U9br5E16ZaQxmTo1LppDRfvtYebrUpWZhO9fe2eVkosvPSkEYgA~YY9SONpSm7VdFzQtEpckPWmMJ3bQ9wgn-glaxxMTVFt5NO0iA41aWJV1zxTwaNwxHFw7fsNgT6ZXbGNkrHMkHz8~IugbKNH28lUkqo8HmEKB7Q__ &Id=14540 &download",
"UploadedText": null,
"UploadedFileContentType": "text/plain",
"UploadedFileLength": 44,
"UploadedFileName": null,
"ContentRepositoryFileShared": "false",
"Title": "Configuration File",
"Description": "Assembly details for the configured item",
"ErrorStatusCode": null,
"ErrorStatusMessage": null,
"CreatedBy": "CVBUYER01",
"CreationDate": "2020-08-25T17:37:26+00:00",
"ExpirationDate": null,
"LastUpdatedByUserName": "Clare Jones",
"CreatedByUserName": "Clare Jones",
"AsyncTrackerId": null,
"@context": {
"key": "00020000000EACED00057708000110F0858942EA0000000EACED00057708000110F0858942E9",
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/supplierNegotiations/300100195210619/child/attachments/00020000000EACED00057708000110F0858942EA0000000EACED00057708000110F0858942E9",
"name": "attachments",
"kind": "item"
},
{
"rel": "canonical",
"href": "https://servername/fscmRestApi/resources/version/supplierNegotiations/300100195210619/child/attachments/00020000000EACED00057708000110F0858942EA0000000EACED00057708000110F0858942E9",
"name": "attachments",
"kind": "item"
},
{
"rel": "parent",
"href": "https://servername/fscmRestApi/resources/version/supplierNegotiations/300100195210619",
"name": "supplierNegotiations",
"kind": "item"
},
{
"rel": "enclosure",
"href": "https://servername/fscmRestApi/resources/version/supplierNegotiations/300100195210619/child/attachments/00020000000EACED00057708000110F0858942EA0000000EACED00057708000110F0858942E9/enclosure/FileContents",
"name": "FileContents",
"kind": "other"
}
]
}
}