Create attachments of the item revision
/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-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker IdAn identifier used for tracking the uploaded files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document IdUnique identifier for a document that's an attachment in the repository. -
AttachedDocumentsDFF: array
AttachedDocumentsDFF
The name of the attachment descriptive flexfield.
-
BaseDocumentId: integer
(int64)
Unique identifier of the document.
-
CategoryName: string
Title:
CategoryMaximum Length:30Represents a component of a catalog used for classification of items. -
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:FILEUnique identifier for the datatype of the attachment. -
DataTypeName: string
Name for the datatype of the attachment.
-
Description: string
Title:
DescriptionMaximum Length:255Value that represents the description of the attachment. -
DmDocumentId: string
Maximum Length:
255Unique identifier for a document in the repository. -
DmFolderPath: string
Title:
Dm Folder PathMaximum Length:1000Value that represents the repository folder path of the attachment. -
DmVersionNumber: string
Maximum Length:
255Value that represents the version number of attachment in repository. -
DocumentId: integer
(int64)
An unique identifier for document referenced in an attachment.
-
DownloadInfo: string
Title:
DownloadInfoValue that represents the download information of the attachment. -
EntityName(required): string
Title:
Entity NameMaximum Length:40Value that represents the entity of the attachment. -
ErrorStatusCode: string
Title:
Error Status CodeValue that represents the error status associated with the attachment creation. -
ErrorStatusMessage: string
Title:
Error Status MessageValue that represents the error details associated with the attachment creation. -
ExpirationDate: string
(date-time)
Title:
Expiration DateValue that represents the expiration date of the attachment associated with the item revision. -
FileContents: string
(byte)
Title:
File ContentsContents of the file attachment. -
FileName: string
Title:
File NameMaximum Length:2048Value the represents the name of a file of the attachment. -
FileUrl: string
Title:
File UrlValue that represents the URL of the attachment 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:
TitleValue that represents the title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content TypeValue that represents the content type of the file attachments associated with the item revision. -
UploadedFileLength: integer
Title:
File SizeValue that indicates the length of the file attachment associated with the item revision. -
UploadedFileName: string
Title:
Uploaded File NameValue that indicates the name of the file attachment associated with the item revision. -
UploadedText: string
Title:
Uploaded TextContents of the text file that's attached. -
Uri: string
Title:
UriMaximum Length:4000Value the represents the 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:4000Value that represents the URL for the attachment.
arrayobject-
__FLEX_Context: string
Title:
Context SegmentMaximum Length:150Context Segment -
__FLEX_Context_DisplayValue: string
Title:
Context SegmentContext Segment -
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-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker IdAn identifier used for tracking the uploaded files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document IdUnique identifier for a document that's an attachment in the repository. -
AttachedDocumentsDFF: array
AttachedDocumentsDFF
The name of the attachment descriptive flexfield.
-
BaseDocumentId: integer
(int64)
Unique identifier of the document.
-
CategoryName: string
Title:
CategoryMaximum Length:30Represents a component of a catalog used for classification of items. -
ContentRepositoryFileCheckedOutBy: string
Title:
Checked Out ByUser who checked out the file from the repository. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:255Name of the user who created the attachment associated with the item revision. -
CreatedByUserName: string
Title:
Created By User NameRead Only:trueUser name of the user who created the attachment associated with the item revision. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueDate on which the attachment with associated to the item revision. -
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:FILEUnique identifier for the datatype of the attachment. -
DataTypeName: string
Name for the datatype of the attachment.
-
Description: string
Title:
DescriptionMaximum Length:255Value that represents the description of the attachment. -
DmDocumentId: string
Maximum Length:
255Unique identifier for a document in the repository. -
DmFolderPath: string
Title:
Dm Folder PathMaximum Length:1000Value that represents the repository folder path of the attachment. -
DmVersionNumber: string
Maximum Length:
255Value that represents the version number of attachment in repository. -
DocumentId: integer
(int64)
An unique identifier for document referenced in an attachment.
-
DocumentPreviewURL: string
Read Only:
trueMaximum Length:255Value that represents the URL for preview of the attachment. -
DocumentURL: string
Read Only:
trueValue that represents the URL of the attachment. -
DownloadInfo: string
Title:
DownloadInfoValue that represents the download information of the attachment. -
EntityName: string
Title:
Entity NameMaximum Length:40Value that represents the entity of the attachment. -
ErrorStatusCode: string
Title:
Error Status CodeValue that represents the error status associated with the attachment creation. -
ErrorStatusMessage: string
Title:
Error Status MessageValue that represents the error details associated with the attachment creation. -
ExpirationDate: string
(date-time)
Title:
Expiration DateValue that represents the expiration date of the attachment associated with the item revision. -
FileContents: string
(byte)
Title:
File ContentsContents of the file attachment. -
FileName: string
Title:
File NameMaximum Length:2048Value the represents the name of a file of the attachment. -
FileUrl: string
Title:
File UrlValue that represents the URL of the attachment file. -
ItemId: string
Maximum Length:
150Value that uniquely represents the item associated with the attachment. -
LastUpdateDate: string
(date-time)
Title:
Last Update DateRead Only:trueIndicates the date and time of the last update of the attachment. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:255Indicates the last user who updated the attachment. -
LastUpdatedByUserName: string
Title:
Last Updated By UserRead Only:trueIndicates the user name of the user who updated 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:
TitleValue that represents the title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content TypeValue that represents the content type of the file attachments associated with the item revision. -
UploadedFileLength: integer
Title:
File SizeValue that indicates the length of the file attachment associated with the item revision. -
UploadedFileName: string
Title:
Uploaded File NameValue that indicates the name of the file attachment associated with the item revision. -
UploadedText: string
Title:
Uploaded TextContents of the text file that's attached. -
Uri: string
Title:
UriMaximum Length:4000Value the represents the 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:4000Value that represents the URL for the attachment. -
UserName: string
Title:
User NameRead Only:trueMaximum Length:255Value that represents the name of user who uploads the attachment.
arrayarrayLinksobject-
__FLEX_Context: string
Title:
Context SegmentMaximum Length:150Context Segment -
__FLEX_Context_DisplayValue: string
Title:
Context SegmentContext Segment -
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
- ItemAttachmentUniqID:
- cancelCheckOut
-
Parameters:
- ItemAttachmentUniqID:
$request.path.ItemAttachmentUniqID - itemsV2UniqID:
$request.path.itemsV2UniqID
Cancels the check out and makes the item attachment available to other users. - ItemAttachmentUniqID:
- checkIn
-
Parameters:
- ItemAttachmentUniqID:
$request.path.ItemAttachmentUniqID - itemsV2UniqID:
$request.path.itemsV2UniqID
Makes the attachment available to other users until the item attachment is checked out by another user. - ItemAttachmentUniqID:
- checkOut
-
Parameters:
- ItemAttachmentUniqID:
$request.path.ItemAttachmentUniqID - itemsV2UniqID:
$request.path.itemsV2UniqID
Marks the item attachment temporarily unavailable to other users, until the item attachment is checked in, or another user undo the check out. - ItemAttachmentUniqID:
- downloadAttachmentAudit
-
Parameters:
- ItemAttachmentUniqID:
$request.path.ItemAttachmentUniqID - itemsV2UniqID:
$request.path.itemsV2UniqID
Audits the downloads of the attachments. - ItemAttachmentUniqID:
- fetchVersions
-
Parameters:
- ItemAttachmentUniqID:
$request.path.ItemAttachmentUniqID - itemsV2UniqID:
$request.path.itemsV2UniqID
Fetches the versions of an attachment. - ItemAttachmentUniqID:
- previewAttachmentAudit
-
Parameters:
- ItemAttachmentUniqID:
$request.path.ItemAttachmentUniqID - itemsV2UniqID:
$request.path.itemsV2UniqID
Audits the previews of the attachments. - ItemAttachmentUniqID:
- updateActiveVersion
-
Parameters:
- ItemAttachmentUniqID:
$request.path.ItemAttachmentUniqID - itemsV2UniqID:
$request.path.itemsV2UniqID
Updates the active version of an attachment. - 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"
}
]
}