Update an attachment for a registered public user account
patch
/fscmRestApi/resources/11.13.18.05/publicSectorWebformAttachments/{DocumentKey}
Request
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Path Parameters
-
DocumentKey: integer
The unique identifier for the attached document.
The following table describes the body parameters in the request for this task.
Root Schema : publicSectorWebformAttachments-item
Type:
object
Discriminator:
Show Source
AttachmentType
-
AgencyId(optional):
integer(int32)
Title:
Agency ID
The unique identifier of the agency associated with the web form attached document. -
AttachmentEntityName(optional):
string
Maximum Length:
255
The unique name given to a web form attachment that is used by the attachment component. -
AttachmentId(optional):
integer(int64)
The attachment ID from the common attachment table.
-
AttachmentIdXref(optional):
integer(int64)
The cross-reference transaction's attachment identifier.
-
AttachmentType:
string
Maximum Length:
15
The attachment type. The value is WRF, which is used for web form attachments. -
AttachmentTypeXref(optional):
string
Maximum Length:
15
The cross-reference transaction's attachment type. -
CreatedBy(optional):
string
Title:
Uploaded By
Maximum Length:64
The user who created the attachment. -
CreationDate(optional):
string(date-time)
Title:
Uploaded On
The data and time when the attachment was created. -
Description(optional):
string
Title:
Description
Maximum Length:100
The description of the attached file. -
DocumentKey(optional):
integer(int64)
The unique identifier for the attached document.
-
FileName(optional):
string
Title:
File Name
Maximum Length:255
The name of the attached file. -
FileSize(optional):
integer(int64)
Title:
File Size
The size of the attached file. -
FileType(optional):
string
Maximum Length:
100
The type of the attached file. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated Date
The data and time when the attachment was last modified. -
LastUpdatedBy(optional):
string
Title:
Last Updated By
Maximum Length:64
The user who last modified the attachment. -
links(optional):
array Items
Title:
Items
Link Relations -
LogMessageId(optional):
integer(int64)
The unique identifier to store the log message ID information. This ID is automatically generated by the application.
-
Version(optional):
integer(int32)
The attachment revision number.
-
WebformAttachmentId(optional):
integer(int64)
The attachment ID from the common attachment table.
-
WebformId(optional):
integer(int64)
The web form details applied to the file attachment.
Nested Schema : link
Type:
Show Source
object
-
href(optional):
string
Title:
hyperlink reference
The URI to the related resource. -
rel(optional):
string
Title:
relation
The 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 : publicSectorWebformAttachments-item
Type:
object
Discriminator:
Show Source
AttachmentType
-
AgencyId(optional):
integer(int32)
Title:
Agency ID
The unique identifier of the agency associated with the web form attached document. -
AttachmentEntityName(optional):
string
Maximum Length:
255
The unique name given to a web form attachment that is used by the attachment component. -
AttachmentId(optional):
integer(int64)
The attachment ID from the common attachment table.
-
AttachmentIdXref(optional):
integer(int64)
The cross-reference transaction's attachment identifier.
-
AttachmentType:
string
Maximum Length:
15
The attachment type. The value is WRF, which is used for web form attachments. -
AttachmentTypeXref(optional):
string
Maximum Length:
15
The cross-reference transaction's attachment type. -
CreatedBy(optional):
string
Title:
Uploaded By
Maximum Length:64
The user who created the attachment. -
CreationDate(optional):
string(date-time)
Title:
Uploaded On
The data and time when the attachment was created. -
Description(optional):
string
Title:
Description
Maximum Length:100
The description of the attached file. -
DocumentKey(optional):
integer(int64)
The unique identifier for the attached document.
-
FileName(optional):
string
Title:
File Name
Maximum Length:255
The name of the attached file. -
FileSize(optional):
integer(int64)
Title:
File Size
The size of the attached file. -
FileType(optional):
string
Maximum Length:
100
The type of the attached file. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated Date
The data and time when the attachment was last modified. -
LastUpdatedBy(optional):
string
Title:
Last Updated By
Maximum Length:64
The user who last modified the attachment. -
links(optional):
array Items
Title:
Items
Link Relations -
LogMessageId(optional):
integer(int64)
The unique identifier to store the log message ID information. This ID is automatically generated by the application.
-
Version(optional):
integer(int32)
The attachment revision number.
-
WebformAttachmentId(optional):
integer(int64)
The attachment ID from the common attachment table.
-
WebformId(optional):
integer(int64)
The web form details applied to the file attachment.
Nested Schema : link
Type:
Show Source
object
-
href(optional):
string
Title:
hyperlink reference
The URI to the related resource. -
rel(optional):
string
Title:
relation
The name of the relation to the resource instance. Example: self.