Upload attachments
/fscmRestApi/resources/11.13.18.05/itemsV2/{itemsV2UniqID}/child/ItemRevision/{ItemRevisionUniqID}/child/RevisionAttachment
Request
-
ItemRevisionUniqID(required): string
This is the hash key of the attributes which make up the composite key--- RevisionId, OrganizationId and InventoryItemId ---for the Item Revisions resource and used to uniquely identify an instance of Item Revisions. The client should not generate the hash key value. Instead, the client should query on the Item Revisions collection resource with a filter on the primary key values in order to navigate to a specific instance of Item Revisions.
For example: ItemRevision?q=RevisionId=<value1>;OrganizationId=<value2>;InventoryItemId=<value3> -
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:
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.
- application/json
object
-
AttachedDocumentId: integer
(int64)
An unique identifier for document that is an attachment in the repository.
-
CategoryName: string
Title:
Category
Maximum Length:30
Name 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. - ContentRepositoryFileShared: boolean
-
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
Not exposed in code. -
Description: string
Title:
Description
Maximum Length:255
Description of the item revision attachment. -
DmDocumentId: string
Maximum Length:
255
Value that uniquely identifies the document in repository. -
DmFolderPath: string
Maximum Length:
1000
Path to the folder in which the attachment file is uploaded. -
DmVersionNumber: string
Maximum Length:
255
Version number that identifies the attachment in repository. -
DownloadInfo: string
JSON object represented as a string containing information used to programmatically retrieve a file attachment.
-
ErrorStatusCode: string
Abbreviation that identifies the error code, if any, for the attachment.
-
ErrorStatusMessage: string
Text of the error message, if any, for the attachment.
-
ExpirationDate: string
(date-time)
Date when the contents of the attachment are no longer valid.
-
FileContents: string
(byte)
Not exposed in code.
-
FileName: string
Title:
File Name
Maximum Length:2048
Name of the file attached to the item. -
FileUrl: string
Path of the document file.
-
Title: string
Title:
Title
Title of the item revision attachment. -
UploadedFileContentType: string
Content type of the attached file.
-
UploadedFileLength: integer
Title:
File Size
Length of the attached file. -
UploadedFileName: string
Name of the attached file.
-
UploadedText: string
Contents of text file that is attached.
-
Uri: string
Maximum Length:
4000
URI (Uniform Resource Identifier) appended to the base URI derived from the endpoint associated with application identified by the MODULE_ID. -
Url: string
Maximum Length:
4000
Uniform resource locator 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
-
AttachedDocumentId: integer
(int64)
An unique identifier for document that is an attachment in the repository.
-
CategoryName: string
Title:
Category
Maximum Length:30
Name 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. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Read Only:
true
Maximum Length:255
User who created the attachment. -
CreatedByUserName: string
Read Only:
true
Login that the user used when creating the attachment. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the user created the attachment. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
Not exposed in code. -
Description: string
Title:
Description
Maximum Length:255
Description of the item revision attachment. -
DmDocumentId: string
Maximum Length:
255
Value that uniquely identifies the document in repository. -
DmFolderPath: string
Maximum Length:
1000
Path to the folder in which the attachment file is uploaded. -
DmVersionNumber: string
Maximum Length:
255
Version number that identifies the attachment in repository. -
DocumentURL: string
Read Only:
true
Complete URL (Uniform Resource Locator) of the item attachment uploaded to web center. -
DownloadInfo: string
JSON object represented as a string containing information used to programmatically retrieve a file attachment.
-
ErrorStatusCode: string
Abbreviation that identifies the error code, if any, for the attachment.
-
ErrorStatusMessage: string
Text of the error message, if any, for the attachment.
-
ExpirationDate: string
(date-time)
Date when the contents of the attachment are no longer valid.
-
FileContents: string
(byte)
Not exposed in code.
-
FileName: string
Title:
File Name
Maximum Length:2048
Name of the file attached to the item. -
FileUrl: string
Path of the document file.
-
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
Date and time when the user most recently updated the item revision attachment. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
User who most recently updated the attachment. -
LastUpdatedByUserName: string
Read Only:
true
Login that the user used when updating the attachment. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Title: string
Title:
Title
Title of the item revision attachment. -
UploadedFileContentType: string
Content type of the attached file.
-
UploadedFileLength: integer
Title:
File Size
Length of the attached file. -
UploadedFileName: string
Name of the attached file.
-
UploadedText: string
Contents of text file that is attached.
-
Uri: string
Maximum Length:
4000
URI (Uniform Resource Identifier) appended to the base URI derived from the endpoint associated with application identified by the MODULE_ID. -
Url: string
Maximum Length:
4000
Uniform resource locator of the attachment. -
UserName: string
Read Only:
true
Maximum Length:255
Display 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.
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
This example describes how to add an attachment to an existing item revision.
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/ItemRevision/ItemRevisionUniqID/child/RevisionAttachment"
Example Request Body
The following example includes the contents of the request body in JSON format to add an attachment to an existing item revision.
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":"UCMFA00533421", "DmVersionNumber":"533445", "CategoryName": "MISC" }
Example Response Body
The following example includes the contents of the response body in JSON format:
{ "AttachedDocumentId": 300100635480166, "LastUpdateDate": "2024-02-22T11:40:02.687+00:00", "LastUpdatedBy": "PIMQA", "DatatypeCode": "FILE", "FileName": "Example_DELETE_deleteGroups.docx", "DmFolderPath": null, "DmDocumentId": "UCMFA00533421", "DmVersionNumber": "533445", "Url": null, "CategoryName": "MISC", "UserName": null, "Uri": null, "FileUrl": "/content/conn/FusionAppsContentRepository/uuid/dDocID:533445?download&XFND_SCHEME_ID=1&XFND_CERT_FP=3D81D59DF29739B02CC8E384E7479EB8C51279F4&XFND_RANDOM=3030248922412345630&XFND_EXPIRES=1708602602712&XFND_SIGNATURE=qMKtDQ2fILVexltWB7L7SUDDIKum1dYaYtLfbrAWyPk-OxoUazRQjjCYXha65jG5PCgl-dyz-WWlN3AKCv9-TkmN6J87yUsBYSRyTvRM3OvPVAuTsQi95piuIyMVzICtaFFUstQFXXZh76KlGZhBx2bhQ0zFudclQOXaePrup05W0ldSyUGBuLDupS696DMEHY3dgv1s2zbo2lq8~e1ib25fdULbVOeNSIyswsbPtdUdljlX7CXAwH6iy1HNyJsp94YQFC8ECFjB0q1k3fi-ubveAI6WfNZjF1f6MZTb3ArMplNf5PS5PAq0DWrNgnIRYRTnAZKmd23451DNZl~tvw__&Id=533445", "UploadedText": null, "UploadedFileContentType": "application/vnd.openxmlformats-officedocument.wordprocessingml.document", "UploadedFileLength": 24986, "UploadedFileName": null, "ContentRepositoryFileShared": "false", "Title": "Example_DELETE_deleteGroups.do", "Description": "", "ErrorStatusCode": null, "ErrorStatusMessage": null, "CreatedBy": "PIMQA", "CreationDate": "2024-02-22T11:40:02+00:00", "ExpirationDate": null, "LastUpdatedByUserName": "PIMQA", "CreatedByUserName": "PIMQA", "DownloadInfo": "{\"XFND_EXPIRES\":\"1708602602717\",\"XFND_SCHEME_ID\":\"1\",\"XFND_CERT_FP\":\"3D81D59DF29739B02CC8E384E7479EB8C51279F4\",\"XFND_SIGNATURE\":\"0jo~Y7r2hyOSb9Qr2fKZHvNvDNFmdXIjIvGidNyHF5roYOdJnejnATcj7smlP9YoPdTxgj-MXUAUKN0gsB7JkBYz1tHBKlRJSJYSkxbN6AgiDq9g2mprnqAHuEMDYhhn0-BZ-c3e19PPoZOWOSloq6DmW1jyazjuu5Z3q176zysfavzO2hkaikTPiUPTLn~E~PmBIqZvK1ZBwU7ECxFSMeJ09-djmthRQ5RepPkQyqLa3PT4tuqcX8REWwJauWsyzR6EjSQPglFUNr4eHMnT7jrHc0GaPurRMFf9rk-BOT2FvrQ~E-EyYWa3n6ac-4Y-cGtS35GdYeV9E31EGuZA4g__\",\"XFND_RANDOM\":\"-2598406006396373810\"}", "DocumentURL": "https://servername/fscmUI/content/conn/FusionAppsContentRepository/uuid/dDocID:533445?download&XFND_SCHEME_ID=1&XFND_CERT_FP=3D81D59DF29739B02CC8E384E7479EB8C51279F4&XFND_RANDOM=3030248922412345630&XFND_EXPIRES=1708602602712&XFND_SIGNATURE=qMKtDQ2fILVexltWB7L7SUDDIKum1dYaYtLfbrAWyPk-OxoUazRQjjCYXha65jG5PCgl-dyz-WWlN3AKCv9-TkmN6J87yUsBYSRyTvRM3OvPVAuTsQi95piuIyMVzICtaFFUstQFXXZh76KlGZhBx2bhQ0zFudclQOXaePrup05W0ldSyUGBuLDupS696DMEHY3dgv1s2zbo2lq8~e1ib25fdULbVOeNSIyswsbPtdUdljlX7CXAwH6iy1HNyJsp94YQFC8ECFjB0q1k3fi-ubveAI6WfNZjF1f6MZTb3ArMplNf5PS5PAq0DWrNgnIRYRTnAZKmd23451DNZl~tvw__&Id=533445", "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/itemsV2/00040000000EACED0005770800000000000001BA0000000EACED0005770800000000000000CC0000000EACED0005770800000000000001BA0000000EACED0005770800000000000000CC/child/ItemRevision/00030000000EACED0005770800000000000015F40000000EACED0005770800000000000000CC0000000EACED0005770800000000000001BA/child/RevisionAttachment/00020000000EACED00057708000110F09FC650660000000EACED00057708000110F09FC65065", "name": "RevisionAttachment", "kind": "item" }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/itemsV2/00040000000EACED0005770800000000000001BA0000000EACED0005770800000000000000CC0000000EACED0005770800000000000001BA0000000EACED0005770800000000000000CC/child/ItemRevision/00030000000EACED0005770800000000000015F40000000EACED0005770800000000000000CC0000000EACED0005770800000000000001BA/child/RevisionAttachment/00020000000EACED00057708000110F09FC650660000000EACED00057708000110F09FC65065", "name": "RevisionAttachment", "kind": "item" }, { "rel": "parent", "href": "https://servername/fscmRestApi/resources/version/itemsV2/00040000000EACED0005770800000000000001BA0000000EACED0005770800000000000000CC0000000EACED0005770800000000000001BA0000000EACED0005770800000000000000CC/child/ItemRevision/00030000000EACED0005770800000000000015F40000000EACED0005770800000000000000CC0000000EACED0005770800000000000001BA", "name": "ItemRevision", "kind": "item" }, { "rel": "enclosure", "href": "https://servername/fscmRestApi/resources/version/itemsV2/00040000000EACED0005770800000000000001BA0000000EACED0005770800000000000000CC0000000EACED0005770800000000000001BA0000000EACED0005770800000000000000CC/child/ItemRevision/00030000000EACED0005770800000000000015F40000000EACED0005770800000000000000CC0000000EACED0005770800000000000001BA/child/RevisionAttachment/00020000000EACED00057708000110F09FC650660000000EACED00057708000110F09FC65065/enclosure/FileContents", "name": "FileContents", "kind": "other" } ] }