Upload an attachment
/fscmRestApi/resources/11.13.18.05/itemsV2/{itemsV2UniqID}/child/ItemAttachment
Request
-
itemsV2UniqID(required): string
This is the hash key of the attributes which make up the composite key for the Items Version 2 resource and used to uniquely identify an instance of Items Version 2. The client should not generate the hash key value. Instead, the client should query on the Items Version 2 collection resource in order to navigate to a specific instance of Items Version 2 to get the hash key.
-
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.
-
Upsert-Mode: string
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.
- application/json
object-
AttachedDocumentId: integer
(int64)
Title:
Attached Document IdAn unique identifier for document that is an attachment in the repository. -
AttachedDocumentsDFF: array
Flexfields for Item Attachments
Title:
Flexfields for Item AttachmentsThe Flexfields for Item Attachments resource manages the descriptive flexfields for item attachments. -
CategoryName: string
Title:
CategoryMaximum Length:30Name of the item attachment category. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Attachment Categories task. -
ContentRepositoryFileCheckedOutBy: string
Title:
Checked Out ByUser who checked out the file from the repository. - ContentRepositoryFileShared: boolean
-
DatabaseDescription: string
Title:
DescriptionMaximum Length:255Description of the file. -
DatabaseTitle: string
Title:
TitleMaximum Length:80Name of the file. -
DatatypeCode: string
Title:
TypeMaximum Length:30Default Value:FILEAbbreviation that indicates the type of data. Valid values include WEB_PAGE, TEXT, or FILE. -
DataTypeName: string
Name for the datatype of the attachment.
-
Description: string
Title:
DescriptionMaximum Length:255Description of the item attachment. -
DmDocumentId: string
Maximum Length:
255Value that uniquely identifies the document in repository. -
DmFolderPath: string
Title:
Dm Folder PathMaximum Length:1000Path to the folder in which the attachment file is uploaded. -
DmVersionNumber: string
Maximum Length:
255Version number that identifies the attachment in repository. -
DownloadInfo: string
Title:
DownloadInfoJSON object represented as a string containing information used to programmatically retrieve a file attachment. -
EntityName(required): string
Title:
Entity NameMaximum Length:40Value that represents the entity of the attachment. -
ErrorStatusCode: string
Title:
Error Status CodeAbbreviation that identifies the error code, 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 of the attachment are no longer valid. -
FileContents: string
(byte)
Title:
File ContentsContents of the attachment. The file content must be in the base64 format. This attribute is hidden when base64 format is not present.. -
FileName: string
Title:
File NameMaximum Length:2048Name of the file attached to the item. -
FileUrl: string
Title:
File UrlPath of the document file. -
ItemId: string
Maximum Length:
150Value that uniquely represents the item associated with the attachment. -
OrganizationId: string
Maximum Length:
150Represents the organization associated with the item attachment. -
PrimaryCategoryFlag: string
Title:
PrimaryMaximum Length:1Value that indicates whether the attachment is the primary attachment associated with the item revision. -
RevisionId: string
Maximum Length:
150Value that indicates the revision ID associated with the attachment. -
Title: string
Title:
TitleTitle of the item attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content TypeContent type of the attached file. -
UploadedFileLength: integer
Title:
File SizeLength of the attached file. -
UploadedFileName: string
Title:
Uploaded File NameName of the attached file. -
UploadedText: string
Title:
Uploaded TextContents of text file that is attached. -
Uri: string
Title:
UriMaximum Length:4000URI (Uniform Resource Identifier) appended to the base URI derived from the endpoint associated with application identified by the MODULE_ID. -
Url: string
Title:
UrlMaximum Length:4000Uniform resource locator of the attachment.
arrayFlexfields for Item Attachmentsobject-
__FLEX_Context: string
Title:
Context SegmentMaximum Length:150Descriptive flexfield context name for item attachments. -
__FLEX_Context_DisplayValue: string
Title:
Context SegmentDescriptive flexfield context display value for item attachments. -
AttachedDocumentId: integer
(int64)
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-
AttachedDocumentId: integer
(int64)
Title:
Attached Document IdAn unique identifier for document that is an attachment in the repository. -
AttachedDocumentsDFF: array
Flexfields for Item Attachments
Title:
Flexfields for Item AttachmentsThe Flexfields for Item Attachments resource manages the descriptive flexfields for item attachments. -
CategoryName: string
Title:
CategoryMaximum Length:30Name of the item attachment category. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Attachment Categories task. -
ContentRepositoryFileCheckedOutBy: string
Title:
Checked Out ByUser who checked out the file from the repository. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:255User who created the attachment. -
CreatedByUserName: string
Title:
Created By User NameRead Only:trueLogin that the user used when creating the attachment. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueDate and time when the user created the attachment. -
DatabaseDescription: string
Title:
DescriptionMaximum Length:255Description of the file. -
DatabaseTitle: string
Title:
TitleMaximum Length:80Name of the file. -
DatatypeCode: string
Title:
TypeMaximum Length:30Default Value:FILEAbbreviation that indicates the type of data. Valid values include WEB_PAGE, TEXT, or FILE. -
DataTypeName: string
Name for the datatype of the attachment.
-
Description: string
Title:
DescriptionMaximum Length:255Description of the item attachment. -
DmDocumentId: string
Maximum Length:
255Value that uniquely identifies the document in repository. -
DmFolderPath: string
Title:
Dm Folder PathMaximum Length:1000Path to the folder in which the attachment file is uploaded. -
DmVersionNumber: string
Maximum Length:
255Version number that identifies the attachment in repository. -
DocumentPreviewURL: string
Read Only:
trueMaximum Length:255Value that represents the URL for preview of the attachment. -
DocumentURL: string
Read Only:
trueComplete URL (Uniform Resource Locator) of the item attachment uploaded to web center. -
DownloadInfo: string
Title:
DownloadInfoJSON object represented as a string containing information used to programmatically retrieve a file attachment. -
EntityName: string
Title:
Entity NameMaximum Length:40Value that represents the entity of the attachment. -
ErrorStatusCode: string
Title:
Error Status CodeAbbreviation that identifies the error code, 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 of the attachment are no longer valid. -
FileContents: string
(byte)
Title:
File ContentsContents of the attachment. The file content must be in the base64 format. This attribute is hidden when base64 format is not present.. -
FileName: string
Title:
File NameMaximum Length:2048Name of the file attached to the item. -
FileUrl: string
Title:
File UrlPath of the document file. -
ItemId: string
Maximum Length:
150Value that uniquely represents the item associated with the attachment. -
LastUpdateDate: string
(date-time)
Title:
Last Update DateRead Only:trueDate and time when the item was most recently updated. For a list of attribute value interdependencies, refer to Interdependent Item Attributes: Explained at: https://www.oracle.com/pls/topic/lookup?ctx=cloud&id=FAPIM287169. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:255User who most recently updated the attachment. -
LastUpdatedByUserName: string
Title:
Last Updated By UserRead Only:trueLogin that the user used when updating the attachment. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
OrganizationId: string
Maximum Length:
150Represents the organization associated with the item attachment. -
PrimaryCategoryFlag: string
Title:
PrimaryMaximum Length:1Value that indicates whether the attachment is the primary attachment associated with the item revision. -
RevisionId: string
Maximum Length:
150Value that indicates the revision ID associated with the attachment. -
Title: string
Title:
TitleTitle of the item attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content TypeContent type of the attached file. -
UploadedFileLength: integer
Title:
File SizeLength of the attached file. -
UploadedFileName: string
Title:
Uploaded File NameName of the attached file. -
UploadedText: string
Title:
Uploaded TextContents of text file that is attached. -
Uri: string
Title:
UriMaximum Length:4000URI (Uniform Resource Identifier) appended to the base URI derived from the endpoint associated with application identified by the MODULE_ID. -
Url: string
Title:
UrlMaximum Length:4000Uniform resource locator of the attachment. -
UserName: string
Title:
User NameRead Only:trueMaximum Length:255Display name of the attachment category. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage attachment categories task.
arrayFlexfields for Item AttachmentsarrayLinksobject-
__FLEX_Context: string
Title:
Context SegmentMaximum Length:150Descriptive flexfield context name for item attachments. -
__FLEX_Context_DisplayValue: string
Title:
Context SegmentDescriptive flexfield context display value for item attachments. -
AttachedDocumentId: integer
(int64)
-
links: array
Links
Title:
LinksThe link relations associated with the resource instance.
arrayLinksobject-
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.
object-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
- AttachedDocumentsDFF
-
Parameters:
- ItemAttachmentUniqID:
$request.path.ItemAttachmentUniqID - itemsV2UniqID:
$request.path.itemsV2UniqID
The Flexfields for Item Attachments resource manages the descriptive flexfields for item attachments. - ItemAttachmentUniqID:
Examples
This example describes how to add an attachment to an existing item.
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/itemsV2/itemsV2UniqID/child/ItemAttachment"
Example Request Body
The following example includes the contents of the request body in JSON format to add an attachment to an existing item.
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",
"DmDocumentId":"UCMFA00533425",
"DmVersionNumber":"533449",
"CategoryName": "MISC"
}
Example Response Body
The following example includes the contents of the response body in JSON format:
{
"AttachedDocumentId": 300100635470291,
"LastUpdateDate": "2024-02-22T11:13:17.471+00:00",
"LastUpdatedBy": "PIMQA",
"DatatypeCode": "FILE",
"FileName": "Structures.json",
"DmFolderPath": null,
"DmDocumentId": "UCMFA00533425",
"DmVersionNumber": "533449",
"Url": null,
"CategoryName": "MISC",
"UserName": null,
"Uri": null,
"FileUrl": "/content/conn/FusionAppsContentRepository/uuid/dDocID:533449?download&XFND_SCHEME_ID=1&XFND_CERT_FP=3D81D59DF29739B02CC8E384E7479EB8C51279F4&XFND_RANDOM=-8558612953089208810&XFND_EXPIRES=1708600997838&XFND_SIGNATURE=JykEP-wnqCsYROEfjS0ytoS-NgynnjRpT3nMUTzWNF-7dex6NRA~W-LcDKboj-QjjMTQ19Odrf-ohvPutGefU~Pc76fOVR6jTaqT4VZGhF~1fXkrpLvTfdv1k9WF2TkjRSS~ELG18yORhehJQ09whGdJiiTvl9ibT3g4~zNR5i5wjZPH4quGAr000KIMoJ~SRkhCz0kpsuPgoYkioSr0H06onBSEX5SBkBVP61cvFyx2ehyiMsnmr~BSt4hq1QHprBrnpBEocjoi6Ni0m4PjTebNCupkScYwBLanYtZgJsjRSRW-W9dm1ZBMLXfuEf3Lj7iuhOMDvNNCB4cUowthXQ__&Id=533449",
"UploadedText": null,
"UploadedFileContentType": "Application/json",
"UploadedFileLength": 8425,
"UploadedFileName": null,
"ContentRepositoryFileShared": "false",
"Title": "Structures.json",
"Description": "",
"ErrorStatusCode": null,
"ErrorStatusMessage": null,
"CreatedBy": "PIMQA",
"CreationDate": "2024-02-22T11:13:17+00:00",
"ExpirationDate": null,
"LastUpdatedByUserName": "PIMQA",
"CreatedByUserName": "PIMQA",
"DownloadInfo": "{\"XFND_EXPIRES\":\"1708600997841\",\"XFND_SCHEME_ID\":\"1\",\"XFND_CERT_FP\":\"3D81D59DF29739B02CC8E384E7479EB8C51279F4\",\"XFND_SIGNATURE\":\"TlPHG~YSyXd-Sgbmm5hhlcfPyS7e1SXAWYHFbO3f-vRuEYO5xR6oVGTctqKJuSEzrC0WR4ueb7gedLrS5N3j-qzC2hPKErza6nVx9cnxcI58a0wZnDsgsfZQhdWw3MtWW6WpCRTWlCmIPGfgiegKhBr6~kyxq1JqYj1lNNzAEJuMvDK9Xb~otyDmj~9qzjmYMVtvR6ObXx2uMVqAcNRqQiA-FDio1kayDHCWqHnGL42xYfoTh-QZ~f72~LvZudcLI6J-3TMyr~JmnKWkwFLWG9-3dGpI4RKwvEzFkq7-R7wOqnuX~8KZhRAydc5ke48lABTl38p3Ftj1esQGVqsXrg__\",\"XFND_RANDOM\":\"4045208130649729672\"}",
"DocumentURL": "https://servername/fscmUI/content/conn/FusionAppsContentRepository/uuid/dDocID:533449?download&XFND_SCHEME_ID=1&XFND_CERT_FP=3D81D59DF29739B02CC8E384E7479EB8C51279F4&XFND_RANDOM=-8558612953089208810&XFND_EXPIRES=1708600997838&XFND_SIGNATURE=JykEP-wnqCsYROEfjS0ytoS-NgynnjRpT3nMUTzWNF-7dex6NRA~W-LcDKboj-QjjMTQ19Odrf-ohvPutGefU~Pc76fOVR6jTaqT4VZGhF~1fXkrpLvTfdv1k9WF2TkjRSS~ELG18yORhehJQ09whGdJiiTvl9ibT3g4~zNR5i5wjZPH4quGAr000KIMoJ~SRkhCz0kpsuPgoYkioSr0H06onBSEX5SBkBVP61cvFyx2ehyiMsnmr~BSt4hq1QHprBrnpBEocjoi6Ni0m4PjTebNCupkScYwBLanYtZgJsjRSRW-W9dm1ZBMLXfuEf3Lj7iuhOMDvNNCB4cUowthXQ__&Id=533449",
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/itemsV2/00040000000EACED0005770800000000000001BA0000000EACED0005770800000000000000CC0000000EACED0005770800000000000001BA0000000EACED0005770800000000000000CC/child/ItemAttachment/00020000000EACED00057708000110F09FC629D30000000EACED00057708000110F09FC629D2",
"name": "ItemAttachment",
"kind": "item"
},
{
"rel": "canonical",
"href": "https://servername/fscmRestApi/resources/version/itemsV2/00040000000EACED0005770800000000000001BA0000000EACED0005770800000000000000CC0000000EACED0005770800000000000001BA0000000EACED0005770800000000000000CC/child/ItemAttachment/00020000000EACED00057708000110F09FC629D30000000EACED00057708000110F09FC629D2",
"name": "ItemAttachment",
"kind": "item"
},
{
"rel": "parent",
"href": "https://servername/fscmRestApi/resources/version/itemsV2/00040000000EACED0005770800000000000001BA0000000EACED0005770800000000000000CC0000000EACED0005770800000000000001BA0000000EACED0005770800000000000000CC",
"name": "itemsV2",
"kind": "item"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/itemsV2/00040000000EACED0005770800000000000001BA0000000EACED0005770800000000000000CC0000000EACED0005770800000000000001BA0000000EACED0005770800000000000000CC/child/ItemAttachment/00020000000EACED00057708000110F09FC629D30000000EACED00057708000110F09FC629D2/child/AttachedDocumentsDFF",
"name": "AttachedDocumentsDFF",
"kind": "collection"
},
{
"rel": "enclosure",
"href": "https://servername/fscmRestApi/resources/version/itemsV2/00040000000EACED0005770800000000000001BA0000000EACED0005770800000000000000CC0000000EACED0005770800000000000001BA0000000EACED0005770800000000000000CC/child/ItemAttachment/00020000000EACED00057708000110F09FC629D30000000EACED00057708000110F09FC629D2/enclosure/FileContents",
"name": "FileContents",
"kind": "other"
}
]
}