Update an attachment for a registered public user account
patch
/fscmRestApi/resources/11.13.18.05/publicSectorWebformAttachments/{DocumentKey}
Request
Path Parameters
-
DocumentKey(required): integer(int64)
The unique identifier for the attached document.
Header Parameters
-
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
AttachmentEntityName: string
Maximum Length:
255
Default Value:PSC_DOC_WRF
The unique name given to a web form attachment that is used by the attachment component. -
AttachmentIdXref: integer
(int64)
The cross-reference transaction's attachment identifier.
-
AttachmentTypeXref: string
Maximum Length:
15
The cross-reference transaction's attachment type. -
CommWebformAttachAccessor: array
Web Form Attachment Accessors
Title:
Web Form Attachment Accessors
The web form attachment accessors resource is used to display file-related information such as file name and file URL. -
CreatedByName: string
Title:
Uploaded By
The user who created the attachment. -
Description: string
Title:
Description
Maximum Length:100
The description of the attached file. -
DocumentKey: integer
(int64)
The unique identifier for the attached document.
-
IsAttachmentDeleted: string
Maximum Length:
255
Indicates if the cross-reference transaction's attachment is deleted or not. -
LogMessageId: integer
(int64)
The unique identifier to store the log message ID information. This ID is automatically generated by the application.
-
Preview: string
(byte)
This column contains the thumbnail of an attached file.
-
PreviewHeight: number
This column indicates the height of a stored thumbnail.
-
PreviewWidth: number
This column indicates the width of a stored thumbnail.
-
UpdatedByName: string
Title:
Last Updated By
The user who last updated the attachment. -
Version: integer
(int32)
The unique identifier of the attachment version.
-
WebformId: integer
(int64)
The web form details applied to the file attachment.
Nested Schema : Web Form Attachment Accessors
Type:
array
Title:
Web Form Attachment Accessors
The web form attachment accessors resource is used to display file-related information such as file name and file URL.
Show Source
Nested Schema : schema
Type:
Show Source
object
-
AttachmentsRevision: array
Web Form Attachment Revisions
Title:
Web Form Attachment Revisions
The web form attachment revisions resource is used to display the historical information for an attachment. -
CategoryName: string
Title:
Category
Maximum Length:30
The unique name given to the web form attachment accessors, which makes the attachment functionality work in conjunction with the entity name. - ContentRepositoryFileShared: boolean
-
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
The datatype code of the attachment. -
Description: string
Title:
Description
Maximum Length:255
The description of the attachment. -
DmDocumentId: string
Maximum Length:
255
The document ID of the attachment. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
The folder path of the attachment. -
DmVersionNumber: string
Maximum Length:
255
The document version number of the attachment. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
The code that indicates the error status of the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
The message that describes the error status of the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
The date of expiration of the attachment. -
FileContents: string
(byte)
Title:
File Contents
The file contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
The name of the attached file. -
FileUrl: string
Title:
File Url
The URL or web address of the attached file. -
Title: string
Title:
Title
The title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
The content type of the attachment such as text or plain text, or csv. -
UploadedFileLength: integer
Title:
File Size
The file length of the attachment in bytes. -
UploadedFileName: string
Title:
Uploaded File Name
The name of the attached file. -
UploadedText: string
Title:
Uploaded Text
The text that is entered along with the attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
The type of universal resource identifier (URI) associated with the attachment. For example, URL. -
Url: string
Title:
Url
Maximum Length:4000
The URL associated with an attachment.
Nested Schema : Web Form Attachment Revisions
Type:
array
Title:
Web Form Attachment Revisions
The web form attachment revisions resource is used to display the historical information for an attachment.
Show Source
Nested Schema : publicSectorWebformAttachments-CommWebformAttachAccessor-AttachmentsRevision-item-patch-request
Type:
Show Source
object
-
ContentId: string
Maximum Length:
80
The unique identifier of the attachment content. -
ErrorStatusCode: string
The code that indicates the error status of the attachment.
-
ErrorStatusMessage: string
The message that describes the error status of the attachment.
-
FileUrl: string
The web address for an attached file.
-
Format: string
Maximum Length:
128
The format of the attachment. -
InDate: string
(date-time)
Indicates the date when the file was attached.
-
RevLabel: string
Maximum Length:
80
The label for an attachment revision. -
UserRevisionId: integer
The unique identifier for an attachment revision.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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(required):
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.
Root Schema : publicSectorWebformAttachments-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Title:
Agency ID
Default Value:1
The unique identifier of the agency associated with the web form attached document. -
AttachmentEntityName: string
Maximum Length:
255
Default Value:PSC_DOC_WRF
The unique name given to a web form attachment that is used by the attachment component. -
AttachmentId: integer
(int64)
The attachment ID from the common attachment table.
-
AttachmentIdXref: integer
(int64)
The cross-reference transaction's attachment identifier.
-
AttachmentType: string
Maximum Length:
15
Default Value:WRF
The attachment type. The value is WRF, which is used for web form attachments. -
AttachmentTypeXref: string
Maximum Length:
15
The cross-reference transaction's attachment type. -
CommWebformAttachAccessor: array
Web Form Attachment Accessors
Title:
Web Form Attachment Accessors
The web form attachment accessors resource is used to display file-related information such as file name and file URL. -
CreatedByName: string
Title:
Uploaded By
The user who created the attachment. -
CreationDate: string
(date-time)
Title:
Uploaded On
Read Only:true
The date and time when the attachment was created. -
Description: string
Title:
Description
Maximum Length:100
The description of the attached file. -
DocumentKey: integer
(int64)
The unique identifier for the attached document.
-
FileName: string
Title:
File Name
Maximum Length:255
The name of the attached file. -
FileSize: integer
(int64)
Title:
File Size
The size of the attached file. -
FileType: string
Maximum Length:
100
The type of the attached file. -
IsAttachmentDeleted: string
Maximum Length:
255
Indicates if the cross-reference transaction's attachment is deleted or not. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the attachment was last updated. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LogMessageId: integer
(int64)
The unique identifier to store the log message ID information. This ID is automatically generated by the application.
-
Preview: string
(byte)
This column contains the thumbnail of an attached file.
-
PreviewHeight: number
This column indicates the height of a stored thumbnail.
-
PreviewWidth: number
This column indicates the width of a stored thumbnail.
-
UpdatedByName: string
Title:
Last Updated By
The user who last updated the attachment. -
Version: integer
(int32)
The unique identifier of the attachment version.
-
WebformAttachmentId: integer
(int64)
The attachment ID from the common attachment table.
-
WebformId: integer
(int64)
The web form details applied to the file attachment.
Nested Schema : Web Form Attachment Accessors
Type:
array
Title:
Web Form Attachment Accessors
The web form attachment accessors resource is used to display file-related information such as file name and file URL.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorWebformAttachments-CommWebformAttachAccessor-item-response
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
The unique identifier of the attachment document. -
AttachmentsRevision: array
Web Form Attachment Revisions
Title:
Web Form Attachment Revisions
The web form attachment revisions resource is used to display the historical information for an attachment. -
CategoryName: string
Title:
Category
Maximum Length:30
The unique name given to the web form attachment accessors, which makes the attachment functionality work in conjunction with the entity name. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
The user who created the attachment. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
The user who created the attachment. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the attachment was created. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
The datatype code of the attachment. -
Description: string
Title:
Description
Maximum Length:255
The description of the attachment. -
DmDocumentId: string
Maximum Length:
255
The document ID of the attachment. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
The folder path of the attachment. -
DmVersionNumber: string
Maximum Length:
255
The document version number of the attachment. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
The code that indicates the error status of the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
The message that describes the error status of the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
The date of expiration of the attachment. -
FileContents: string
(byte)
Title:
File Contents
The file contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
The name of the attached file. -
FileUrl: string
Title:
File Url
The URL or web address of the attached file. -
FileWebImage: string
(byte)
Title:
File Web Image
Read Only:true
The base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date and time when the attachment was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
The user who last updated the attachment. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
The user who last updated the attachment. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Title: string
Title:
Title
The title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
The content type of the attachment such as text or plain text, or csv. -
UploadedFileLength: integer
Title:
File Size
The file length of the attachment in bytes. -
UploadedFileName: string
Title:
Uploaded File Name
The name of the attached file. -
UploadedText: string
Title:
Uploaded Text
The text that is entered along with the attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
The type of universal resource identifier (URI) associated with the attachment. For example, URL. -
Url: string
Title:
Url
Maximum Length:4000
The URL associated with an attachment. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
The user's unique username for signing into the Fusion system.
Nested Schema : Web Form Attachment Revisions
Type:
array
Title:
Web Form Attachment Revisions
The web form attachment revisions resource is used to display the historical information for an attachment.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorWebformAttachments-CommWebformAttachAccessor-AttachmentsRevision-item-response
Type:
Show Source
object
-
AttachedDocumentId: string
Read Only:
true
The unique identifier of an attached document. -
ContentId: string
Maximum Length:
80
The unique identifier of the attachment content. -
ErrorStatusCode: string
The code that indicates the error status of the attachment.
-
ErrorStatusMessage: string
The message that describes the error status of the attachment.
-
FileUrl: string
The web address for an attached file.
-
Format: string
Maximum Length:
128
The format of the attachment. -
InDate: string
(date-time)
Indicates the date when the file was attached.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
RevisionId: string
Maximum Length:
80
The unique identifier of the attachment revision. -
RevLabel: string
Maximum Length:
80
The label for an attachment revision. -
UserRevisionId: integer
The unique identifier for an attachment revision.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Links
- CommWebformAttachAccessor
-
Parameters:
- DocumentKey:
$request.path.DocumentKey
The web form attachment accessors resource is used to display file-related information such as file name and file URL. - DocumentKey: