Update a mapping attachment's file-related information
patch
/fscmRestApi/resources/11.13.18.05/publicSectorMappingAttachments/{MappingAttachmentKey}/child/MappingAttachmentAccessor/{AttachedDocumentId}
Request
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Path Parameters
-
AttachedDocumentId: integer
The unique identifier of the attachment document.
-
MappingAttachmentKey: integer
The unique identifier associated with the Data Format Exchange mapping attachment.
The following table describes the body parameters in the request for this task.
Root Schema : publicSectorMappingAttachments-MappingAttachmentAccessor-item
Type:
Show Source
object-
AsyncTrackerId(optional):
string
Title:
Asynchronous Upload Tracker IdAttribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId(optional):
integer(int64)
Title:
Attached Document IdThe unique identifier of the attachment document. -
AttachmentsRevision(optional):
array Mapping Attachment Revisions
Title:
Mapping Attachment RevisionsThe mapping attachment revisions resource is used to store Data Format Exchange historical information for mapping attachments. -
CategoryName(optional):
string
Title:
CategoryMaximum Length:30The unique name given to the mapping attachment file-related information, which makes the attachment functionality work in conjunction with the entity name. - ContentRepositoryFileShared(optional): boolean
-
CreatedBy(optional):
string
Title:
Created ByMaximum Length:255The user who created the attachment. -
CreatedByUserName(optional):
string
Title:
Created By User NameThe user who created the attachment. -
CreationDate(optional):
string(date-time)
Title:
Creation DateThe date and time when the attachment was created. -
DatatypeCode(optional):
string
Title:
TypeMaximum Length:30The datatype code of the attachment. -
Description(optional):
string
Title:
DescriptionMaximum Length:255The description of the attachment. -
DmDocumentId(optional):
string
Maximum Length:
255The document ID from which the attachment is created. -
DmFolderPath(optional):
string
Title:
Dm Folder PathMaximum Length:1000The folder path of the attached file. -
DmVersionNumber(optional):
string
Maximum Length:
255The document version number from which the attachment is created. -
ErrorStatusCode(optional):
string
Title:
Error Status CodeThe code that indicates the error status of the attachment. -
ErrorStatusMessage(optional):
string
Title:
Error Status MessageThe message that describes the error status of the attachment. -
ExpirationDate(optional):
string(date-time)
Title:
Expiration DateThe date of expiration of the attachment. -
FileContents(optional):
string(binary)
Title:
File ContentsThe file contents of the attachment. -
FileName(optional):
string
Title:
File NameMaximum Length:2048The name of the attached file. -
FileUrl(optional):
string
Title:
File UrlThe URL or web address of the attached file. -
FileWebImage(optional):
string(binary)
Title:
File Web ImageThe base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Update DateThe date and time when the attachment was last updated. -
LastUpdatedBy(optional):
string
Title:
Last Updated ByMaximum Length:255The user who last updated the attachment. -
LastUpdatedByUserName(optional):
string
Title:
Last Updated By UserThe user who last updated the attachment. -
links(optional):
array Items
Title:
ItemsLink Relations -
Title(optional):
string
Title:
TitleThe title of the attachment. -
UploadedFileContentType(optional):
string
Title:
Uploaded File Content TypeThe content type of the attachment such as plain text or comma-separated value format. -
UploadedFileLength(optional):
integer(int64)
Title:
File SizeThe file length of the attachment in bytes. -
UploadedFileName(optional):
string
Title:
Uploaded File NameThe name of the attached file. -
UploadedText(optional):
string
Title:
Uploaded TextThe text that is entered along with the attachment. -
Uri(optional):
string
Title:
UriMaximum Length:4000The type of universal resource identifier (URI) associated with the attachment. For example, URL. -
Url(optional):
string
Title:
UrlMaximum Length:4000The URL associated with an attachment. -
UserName(optional):
string
Title:
User NameMaximum Length:255The user's unique user name for logging into the system.
Nested Schema : Mapping Attachment Revisions
Type:
arrayTitle:
Mapping Attachment RevisionsThe mapping attachment revisions resource is used to store Data Format Exchange historical information for mapping attachments.
Show Source
Nested Schema : publicSectorMappingAttachments-MappingAttachmentAccessor-AttachmentsRevision-item
Type:
Show Source
object-
AttachedDocumentId(optional):
integer(int64)
The unique identifier of an attached document.
-
ContentId(optional):
string
Maximum Length:
80The unique identifier of the attachment content. -
ErrorStatusCode(optional):
string
The code that indicates the error status of the attachment.
-
ErrorStatusMessage(optional):
string
The message that describes the error status of the attachment.
-
FileUrl(optional):
string
The web address for an attached file.
-
Format(optional):
string
Maximum Length:
128The format of the attachment. -
InDate(optional):
string(date-time)
Indicates the date when the file was attached.
-
links(optional):
array Items
Title:
ItemsLink Relations -
RevisionId(optional):
string
Maximum Length:
80The unique identifier of the attachment revision. -
RevLabel(optional):
string
Maximum Length:
80The label for an attachment revision. -
UserRevisionId(optional):
integer(int64)
The unique identifier for an attachment revision.
Nested Schema : link
Type:
Show Source
object-
href(optional):
string
Title:
hyperlink referenceThe URI to the related resource. -
rel(optional):
string
Title:
relationThe name of the relation to the resource instance. Example: self.
Response
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Default Response
The following table describes the default response for this task.
Root Schema : publicSectorMappingAttachments-MappingAttachmentAccessor-item
Type:
Show Source
object-
AsyncTrackerId(optional):
string
Title:
Asynchronous Upload Tracker IdAttribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId(optional):
integer(int64)
Title:
Attached Document IdThe unique identifier of the attachment document. -
AttachmentsRevision(optional):
array Mapping Attachment Revisions
Title:
Mapping Attachment RevisionsThe mapping attachment revisions resource is used to store Data Format Exchange historical information for mapping attachments. -
CategoryName(optional):
string
Title:
CategoryMaximum Length:30The unique name given to the mapping attachment file-related information, which makes the attachment functionality work in conjunction with the entity name. - ContentRepositoryFileShared(optional): boolean
-
CreatedBy(optional):
string
Title:
Created ByMaximum Length:255The user who created the attachment. -
CreatedByUserName(optional):
string
Title:
Created By User NameThe user who created the attachment. -
CreationDate(optional):
string(date-time)
Title:
Creation DateThe date and time when the attachment was created. -
DatatypeCode(optional):
string
Title:
TypeMaximum Length:30The datatype code of the attachment. -
Description(optional):
string
Title:
DescriptionMaximum Length:255The description of the attachment. -
DmDocumentId(optional):
string
Maximum Length:
255The document ID from which the attachment is created. -
DmFolderPath(optional):
string
Title:
Dm Folder PathMaximum Length:1000The folder path of the attached file. -
DmVersionNumber(optional):
string
Maximum Length:
255The document version number from which the attachment is created. -
ErrorStatusCode(optional):
string
Title:
Error Status CodeThe code that indicates the error status of the attachment. -
ErrorStatusMessage(optional):
string
Title:
Error Status MessageThe message that describes the error status of the attachment. -
ExpirationDate(optional):
string(date-time)
Title:
Expiration DateThe date of expiration of the attachment. -
FileContents(optional):
string(binary)
Title:
File ContentsThe file contents of the attachment. -
FileName(optional):
string
Title:
File NameMaximum Length:2048The name of the attached file. -
FileUrl(optional):
string
Title:
File UrlThe URL or web address of the attached file. -
FileWebImage(optional):
string(binary)
Title:
File Web ImageThe base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Update DateThe date and time when the attachment was last updated. -
LastUpdatedBy(optional):
string
Title:
Last Updated ByMaximum Length:255The user who last updated the attachment. -
LastUpdatedByUserName(optional):
string
Title:
Last Updated By UserThe user who last updated the attachment. -
links(optional):
array Items
Title:
ItemsLink Relations -
Title(optional):
string
Title:
TitleThe title of the attachment. -
UploadedFileContentType(optional):
string
Title:
Uploaded File Content TypeThe content type of the attachment such as plain text or comma-separated value format. -
UploadedFileLength(optional):
integer(int64)
Title:
File SizeThe file length of the attachment in bytes. -
UploadedFileName(optional):
string
Title:
Uploaded File NameThe name of the attached file. -
UploadedText(optional):
string
Title:
Uploaded TextThe text that is entered along with the attachment. -
Uri(optional):
string
Title:
UriMaximum Length:4000The type of universal resource identifier (URI) associated with the attachment. For example, URL. -
Url(optional):
string
Title:
UrlMaximum Length:4000The URL associated with an attachment. -
UserName(optional):
string
Title:
User NameMaximum Length:255The user's unique user name for logging into the system.
Nested Schema : Mapping Attachment Revisions
Type:
arrayTitle:
Mapping Attachment RevisionsThe mapping attachment revisions resource is used to store Data Format Exchange historical information for mapping attachments.
Show Source
Nested Schema : publicSectorMappingAttachments-MappingAttachmentAccessor-AttachmentsRevision-item
Type:
Show Source
object-
AttachedDocumentId(optional):
integer(int64)
The unique identifier of an attached document.
-
ContentId(optional):
string
Maximum Length:
80The unique identifier of the attachment content. -
ErrorStatusCode(optional):
string
The code that indicates the error status of the attachment.
-
ErrorStatusMessage(optional):
string
The message that describes the error status of the attachment.
-
FileUrl(optional):
string
The web address for an attached file.
-
Format(optional):
string
Maximum Length:
128The format of the attachment. -
InDate(optional):
string(date-time)
Indicates the date when the file was attached.
-
links(optional):
array Items
Title:
ItemsLink Relations -
RevisionId(optional):
string
Maximum Length:
80The unique identifier of the attachment revision. -
RevLabel(optional):
string
Maximum Length:
80The label for an attachment revision. -
UserRevisionId(optional):
integer(int64)
The unique identifier for an attachment revision.
Nested Schema : link
Type:
Show Source
object-
href(optional):
string
Title:
hyperlink referenceThe URI to the related resource. -
rel(optional):
string
Title:
relationThe name of the relation to the resource instance. Example: self.