Create an attachment
post
/fscmRestApi/resources/11.13.18.05/draftPurchaseOrders/{draftPurchaseOrdersUniqID}/child/lines/{POLineId}/child/attachments
Request
Path Parameters
-
POLineId(required): integer(int64)
Value that uniquely identifies the purchase order line.
-
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.
-
Upsert-Mode:
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
- application/json
Root Schema : schema
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 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:
CategoryMaximum Length:30Category of the attached document. - ContentRepositoryFileShared: boolean
-
DatatypeCode: string
Title:
TypeMaximum Length:30Default Value:FILEAbbreviation that identifies the data type. -
Description: string
Title:
DescriptionMaximum Length:255Description of the attached document. -
DmDocumentId: string
Maximum Length:
255Value that uniquely identifies the attached document. -
DmFolderPath: string
Title:
Dm Folder PathMaximum Length:1000Folder path of the attached document. -
DmVersionNumber: string
Maximum Length:
255Number that identifies the version of the attached document. -
DownloadInfo: string
Title:
DownloadInfoJSON-formatted string that contains information required to programmatically retrieve a large file attachment. -
ErrorStatusCode: string
Title:
Error Status CodeAbbreviation that identifies the error code, if any, for the attached document. -
ErrorStatusMessage: string
Title:
Error Status MessageText of the error message, if any, for the attached document. -
ExpirationDate: string
(date-time)
Title:
Expiration DateDate when the content in the attached document expires. -
FileContents: string
(byte)
Title:
File ContentsContents of the attached document. -
FileName: string
Title:
File NameMaximum Length:2048File name of the attached document. -
FileUrl: string
Title:
File UrlURL (Uniform Resource Locator) of the attached document. -
PostProcessingAction: string
Title:
PostProcessingActionThe name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
TitleTitle of the attached document. -
UploadedFileContentType: string
Title:
Uploaded File Content TypeContent type of the attached document. -
UploadedFileLength: integer
Title:
File SizeLength of the attached document. -
UploadedFileName: string
Title:
Uploaded File NameName of the attached document. -
UploadedText: string
Title:
Uploaded TextText of the attached document. -
Uri: string
Title:
UriMaximum Length:4000URI (Uniform Resource Identifier) that identifies the attached document. -
Url: string
Title:
UrlMaximum Length:4000URI (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 IdAn identifier used for tracking the uploaded files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document IdValue 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:
CategoryMaximum Length:30Category of the attached document. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:255User who created the attached document. -
CreatedByUserName: string
Title:
Created By User NameRead Only:trueLogin that the user used when creating the document that is attached to the purchase order. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueDate when the user created the attached document. -
DatatypeCode: string
Title:
TypeMaximum Length:30Default Value:FILEAbbreviation that identifies the data type. -
Description: string
Title:
DescriptionMaximum Length:255Description of the attached document. -
DmDocumentId: string
Maximum Length:
255Value that uniquely identifies the attached document. -
DmFolderPath: string
Title:
Dm Folder PathMaximum Length:1000Folder path of the attached document. -
DmVersionNumber: string
Maximum Length:
255Number that identifies the version of the attached document. -
DownloadInfo: string
Title:
DownloadInfoJSON-formatted string that contains information required to programmatically retrieve a large file attachment. -
ErrorStatusCode: string
Title:
Error Status CodeAbbreviation that identifies the error code, if any, for the attached document. -
ErrorStatusMessage: string
Title:
Error Status MessageText of the error message, if any, for the attached document. -
ExpirationDate: string
(date-time)
Title:
Expiration DateDate when the content in the attached document expires. -
FileContents: string
(byte)
Title:
File ContentsContents of the attached document. -
FileName: string
Title:
File NameMaximum Length:2048File name of the attached document. -
FileUrl: string
Title:
File UrlURL (Uniform Resource Locator) of the attached document. -
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 most recently updated the document that is attached to the purchase order. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:255User who most recently updated the document that is attached to the purchase order. -
LastUpdatedByUserName: string
Title:
Last Updated By UserRead Only:trueLogin that the user used when updating the document that is attached to the purchase order. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingActionThe name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
TitleTitle of the attached document. -
UploadedFileContentType: string
Title:
Uploaded File Content TypeContent type of the attached document. -
UploadedFileLength: integer
Title:
File SizeLength of the attached document. -
UploadedFileName: string
Title:
Uploaded File NameName of the attached document. -
UploadedText: string
Title:
Uploaded TextText of the attached document. -
Uri: string
Title:
UriMaximum Length:4000URI (Uniform Resource Identifier) that identifies the attached document. -
Url: string
Title:
UrlMaximum Length:4000URI (Uniform Resource Identifier) that identifies the attached document. -
UserName: string
Title:
User NameRead Only:trueMaximum Length:255Login that the user used when adding or modifying the attached document.
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 upload an 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/draftPurchaseOrders/draftPurchaseOrdersUniqI}/child/lines/POLineId}/child/attachments"
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 creates.
{
"DatatypeCode": "FILE",
"FileName": "REST Attachment.txt",
"CategoryName": "TO_SUPPLIER",
"UploadedFileContentType": "text/plain",
"ContentRepositoryFileShared": "false",
"Title": "REST Attachment.txt",
"Description": "description",
"FileContents": "UmFnaGF2YQ=="
}
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": "BUYER01",
"DatatypeCode": "FILE",
"FileName": "REST Attachment.txt",
"DmFolderPath": null,
"DmDocumentId": "UCMFA00024862",
"DmVersionNumber": "24865",
"Url": null,
"CategoryName": "TO_SUPPLIER",
"UserName": null,
"Uri": null,
"FileUrl": "/content/conn/FusionAppsContentRepository/uuid/dDocID%3a24865?XFND_SCHEME_ID=1&XFND_CERT_FP;=0A3C9E5F872EB24E37333CB5F528CEEFA1491781&XFND_RANDOM;=7726844333609262495&XFND_EXPIRES;=1603095365152&XFND_SIGNATURE;=HxME6yI6USW9-j8TO9avAnXSwgwenF2OdKV3ryJeqO1iCdB-Q-N0vykqSf2UQr1BrxoWNDb60E3MpxhOMNwBJcVNMhWlQcklGmkl0CayNINVDX8BTCaYY43GloUB8yMvdu6nLKJST6D20QcbswaviUU~oCkrcLKUhP2GcJ2oRmIIW7gCEV4wNUcwN7LN91MMVqA2tuWcdR6OXV8ZqOROmU77DswnR8VLzX0SXWI~NnUUGCqSNp4rdU5WkOYVloZqZL2qQZPmUUK8WnS-WF4I6jcU8lavltHSL8SaWmBbRia0DdxpMxunaNNT~nXfx-Qwh6~9ZQDeLibh~ecIj~r7QQ__&Id;=24865&download;",
"UploadedText": null,
"UploadedFileContentType": "text/plain",
"UploadedFileLength": 7,
"UploadedFileName": "REST Attachment.txt",
"ContentRepositoryFileShared": "false",
"Title": "REST Attachment.txt",
"Description": "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"
}
]
}