Update a case notice attachment
patch
/fscmRestApi/resources/11.13.18.05/publicSectorCaseNoticeAttachments/{AttachmentKey}
Request
Path Parameters
-
AttachmentKey(required): integer(int64)
The unique identifier of the case notice attachment.
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
Default Value:
PSC_DOC_CASNT
The entity name of the case notice attachment. -
CaseNoticeAttachmentAccessor: array
Case Notice Attachment Contents
Title:
Case Notice Attachment Contents
The case notice attachment content resource is used to view, create, or modify the content of a case notice attachment. Case notice attachments are used in Code Enforcement cases. -
ConfidentialFlag: boolean
Maximum Length:
1
Default Value:false
Indicates whether the attachment is a confidential document. The default value is N for no. -
CreatedByName: string
Title:
Uploaded By
The name of the user who created the attachment. -
Description: string
Title:
Description
Maximum Length:100
The description of the case notice attachment. -
NoticeAttachType: string
Title:
Upload Type
Maximum Length:15
The type of case notice attachment. -
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.
-
RequiredFlag: boolean
Maximum Length:
1
Default Value:false
Indicates whether the attachment is a required document. The default value is N for no. -
UpdatedByName: string
Title:
Last Updated By
The name of the user who last updated the attachment. -
Version: integer
(int32)
The version of the case notice attachment.
Nested Schema : Case Notice Attachment Contents
Type:
array
Title:
Case Notice Attachment Contents
The case notice attachment content resource is used to view, create, or modify the content of a case notice attachment. Case notice attachments are used in Code Enforcement cases.
Show Source
Nested Schema : publicSectorCaseNoticeAttachments-CaseNoticeAttachmentAccessor-item-patch-request
Type:
Show Source
object
-
AttachmentsRevision: array
Case Notice Attachment Revisions
Title:
Case Notice Attachment Revisions
The case notice attachment revision resource is used to view, create, or modify a case notice attachment revision. Case notice attachments are used in Code Enforcement cases. -
CategoryName: string
Title:
Category
Maximum Length:30
The category name of the case notice attachment content. - ContentRepositoryFileShared: boolean
-
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
The date type identifier of the case notice attachment content. -
Description: string
Title:
Description
Maximum Length:255
The description of the case notice attachment content. -
DmDocumentId: string
Maximum Length:
255
The document identifier of the case notice attachment content. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
The folder path for the case notice attachment content. -
DmVersionNumber: string
Maximum Length:
255
The document version number of the case notice attachment content. -
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 error status code of the case notice attachment content. -
ErrorStatusMessage: string
Title:
Error Status Message
The error status message of the case notice attachment content. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
The expiration date of the case notice attachment content. -
FileContents: string
(byte)
Title:
File Contents
The file contents of the case notice attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
The file name of the case notice attachment content. -
FileUrl: string
Title:
File Url
The file URL of the case notice attachment content. -
PostProcessingAction: string
Title:
PostProcessingAction
The name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
Title
The title of the case notice attachment content. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
The type of the uploaded file content. -
UploadedFileLength: integer
Title:
File Size
The length of the file uploaded for the case notice attachment content. -
UploadedFileName: string
Title:
Uploaded File Name
The name of the uploaded file for the case notice attachment content. -
UploadedText: string
Title:
Uploaded Text
The text uploaded as part of the case notice attachment content. -
Uri: string
Title:
Uri
Maximum Length:4000
The URI of the case notice attachment content. -
Url: string
Title:
Url
Maximum Length:4000
The URL of the case notice attachment content.
Nested Schema : Case Notice Attachment Revisions
Type:
array
Title:
Case Notice Attachment Revisions
The case notice attachment revision resource is used to view, create, or modify a case notice attachment revision. Case notice attachments are used in Code Enforcement cases.
Show Source
Nested Schema : publicSectorCaseNoticeAttachments-CaseNoticeAttachmentAccessor-AttachmentsRevision-item-patch-request
Type:
Show Source
object
-
ContentId: string
Maximum Length:
80
The contents of the attachment revision. -
ErrorStatusCode: string
The error status code of the case notice attachment revision.
-
ErrorStatusMessage: string
The error status message of the case notice attachment revision.
-
FileUrl: string
The file URL of the case notice attachment revision.
-
Format: string
Maximum Length:
128
The format of the attachment revision. -
InDate: string
(date-time)
The date of the attachment revision.
-
RevLabel: string
Maximum Length:
80
The revision label of the attachment revision. -
UserRevisionId: integer
The user revision ID for the attachment revision.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
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.
Root Schema : publicSectorCaseNoticeAttachments-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Title:
Agency ID
Default Value:1
The agency identifier of the case notice attachment. -
AttachmentEntityName: string
Default Value:
PSC_DOC_CASNT
The entity name of the case notice attachment. -
AttachmentId: integer
(int64)
The unique identifier of the case notice attachment.
-
AttachmentKey: integer
(int64)
The unique identifier of the case notice attachment.
-
AttachmentPuid: string
Maximum Length:
480
The public unique identifier of the migrated case notice attachment record. -
CaseNoticeAttachmentAccessor: array
Case Notice Attachment Contents
Title:
Case Notice Attachment Contents
The case notice attachment content resource is used to view, create, or modify the content of a case notice attachment. Case notice attachments are used in Code Enforcement cases. -
CaseNoticeAttachmentId: integer
(int64)
The unique identifier of the case.
-
CaseNoticeKey: integer
(int64)
The unique identifier of the case notice attachment.
-
CaseNoticePuid: string
Maximum Length:
480
The public unique identifier of the migrated case notice record. -
ConfidentialFlag: boolean
Maximum Length:
1
Default Value:false
Indicates whether the attachment is a confidential document. The default value is N for no. -
CreatedByName: string
Title:
Uploaded By
The name of the user who created the attachment. -
CreationDate: string
(date-time)
Title:
Uploaded On
Read Only:true
The date and time when the row was created. -
Description: string
Title:
Description
Maximum Length:100
The description of the case notice attachment. -
FileName: string
Title:
File Name
Maximum Length:255
The file name of the case notice attachment. -
FileSize: integer
(int64)
Title:
File Size
The file size of the case notice attachment. -
FileType: string
Maximum Length:
100
The file type of the case notice attachment. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The name of the user who last updated the row. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NoticeAttachType: string
Title:
Upload Type
Maximum Length:15
The type of case notice attachment. -
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.
-
RequiredFlag: boolean
Maximum Length:
1
Default Value:false
Indicates whether the attachment is a required document. The default value is N for no. -
UpdatedByName: string
Title:
Last Updated By
The name of the user who last updated the attachment. -
Version: integer
(int32)
The version of the case notice attachment.
Nested Schema : Case Notice Attachment Contents
Type:
array
Title:
Case Notice Attachment Contents
The case notice attachment content resource is used to view, create, or modify the content of a case notice attachment. Case notice attachments are used in Code Enforcement cases.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorCaseNoticeAttachments-CaseNoticeAttachmentAccessor-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 case notice attachment content. -
AttachmentsRevision: array
Case Notice Attachment Revisions
Title:
Case Notice Attachment Revisions
The case notice attachment revision resource is used to view, create, or modify a case notice attachment revision. Case notice attachments are used in Code Enforcement cases. -
CategoryName: string
Title:
Category
Maximum Length:30
The category name of the case notice attachment content. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
The name of the user who created the row. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
The name of the user who created the row. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the row was created. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
The date type identifier of the case notice attachment content. -
Description: string
Title:
Description
Maximum Length:255
The description of the case notice attachment content. -
DmDocumentId: string
Maximum Length:
255
The document identifier of the case notice attachment content. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
The folder path for the case notice attachment content. -
DmVersionNumber: string
Maximum Length:
255
The document version number of the case notice attachment content. -
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 error status code of the case notice attachment content. -
ErrorStatusMessage: string
Title:
Error Status Message
The error status message of the case notice attachment content. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
The expiration date of the case notice attachment content. -
FileContents: string
(byte)
Title:
File Contents
The file contents of the case notice attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
The file name of the case notice attachment content. -
FileUrl: string
Title:
File Url
The file URL of the case notice attachment content. -
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 row was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
The name of the user who last updated the row. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
The name of the user who last updated the row. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingAction
The name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
Title
The title of the case notice attachment content. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
The type of the uploaded file content. -
UploadedFileLength: integer
Title:
File Size
The length of the file uploaded for the case notice attachment content. -
UploadedFileName: string
Title:
Uploaded File Name
The name of the uploaded file for the case notice attachment content. -
UploadedText: string
Title:
Uploaded Text
The text uploaded as part of the case notice attachment content. -
Uri: string
Title:
Uri
Maximum Length:4000
The URI of the case notice attachment content. -
Url: string
Title:
Url
Maximum Length:4000
The URL of the case notice attachment content. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
The username of the case notice attachment content.
Nested Schema : Case Notice Attachment Revisions
Type:
array
Title:
Case Notice Attachment Revisions
The case notice attachment revision resource is used to view, create, or modify a case notice attachment revision. Case notice attachments are used in Code Enforcement cases.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorCaseNoticeAttachments-CaseNoticeAttachmentAccessor-AttachmentsRevision-item-response
Type:
Show Source
object
-
AttachedDocumentId: string
Read Only:
true
The unique identifier of the case notice attachment content. -
ContentId: string
Maximum Length:
80
The contents of the attachment revision. -
ErrorStatusCode: string
The error status code of the case notice attachment revision.
-
ErrorStatusMessage: string
The error status message of the case notice attachment revision.
-
FileUrl: string
The file URL of the case notice attachment revision.
-
Format: string
Maximum Length:
128
The format of the attachment revision. -
InDate: string
(date-time)
The date of the attachment revision.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
RevisionId: string
Maximum Length:
80
The ID of the attachment revision. -
RevLabel: string
Maximum Length:
80
The revision label of the attachment revision. -
UserRevisionId: integer
The user revision ID for the 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
- CaseNoticeAttachmentAccessor
-
Parameters:
- AttachmentKey:
$request.path.AttachmentKey
The case notice attachment content resource is used to view, create, or modify the content of a case notice attachment. Case notice attachments are used in Code Enforcement cases. - AttachmentKey: