Update a code enforcement inspection attachment
patch
/fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementInspectionAttachments/{publicSectorCodeEnforcementInspectionAttachmentsUniqID}
Request
Path Parameters
-
publicSectorCodeEnforcementInspectionAttachmentsUniqID(required): string
This is the hash key of the attributes which make up the composite key--- AttachmentId and AttachmentKey ---for the Code Enforcement Inspection Attachments resource and used to uniquely identify an instance of Code Enforcement Inspection Attachments. The client should not generate the hash key value. Instead, the client should query on the Code Enforcement Inspection Attachments collection resource with a filter on the primary key values in order to navigate to a specific instance of Code Enforcement Inspection Attachments.
For example: publicSectorCodeEnforcementInspectionAttachments?q=AttachmentId=<value1>;AttachmentKey=<value2>
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_CEINS
The name of the inspection attachment that is used by the attachment component. -
AttachmentPuid: string
Maximum Length:
480
The legacy system attachment identifier for the migrated data. -
CreatedByName: string
Title:
Uploaded By
The name of the user who created the attachment. -
Description: string
Title:
Description
Maximum Length:100
The description for the attached file. -
DocCategory: string
Maximum Length:
30
The unique identifier of the document category. -
DocSubcategory: string
Maximum Length:
30
The unique identifier of the document subcategory. -
InspectionAttachmentViewAccessor: array
Code Enforcement Inspection Attachment Accessors
Title:
Code Enforcement Inspection Attachment Accessors
The code enforcement inspection attachment accessors resource is used to display file-related information such as the file name and the file URL. -
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.
-
TransactionPuid: string
Maximum Length:
480
The legacy system inspection transaction identifier for the migrated data. -
UpdatedByName: string
Title:
Last Updated By
The name of the user who last updated the attachment. -
Version: integer
(int32)
The version of the attachment.
Nested Schema : Code Enforcement Inspection Attachment Accessors
Type:
array
Title:
Code Enforcement Inspection Attachment Accessors
The code enforcement inspection attachment accessors resource is used to display file-related information such as the file name and the file URL.
Show Source
Nested Schema : schema
Type:
Show Source
object
-
AttachmentsRevision: array
Code Enforcement Inspection Attachment Revisions
Title:
Code Enforcement Inspection Attachment Revisions
The code enforcement inspection attachment revisions resource is used to display the historical information about an attachment. -
CategoryName: string
Title:
Category
Maximum Length:30
The category of the attachment. - ContentRepositoryFileShared: boolean
-
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
The data type code of the attachment. -
Description: string
Title:
Description
Maximum Length:255
The description of the attachment. -
DmDocumentId: string
Maximum Length:
255
The document ID from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255
The document version number from which the attachment is created. -
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 code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
The error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
The expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File Contents
The contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
The file name of the attachment. -
FileUrl: string
Title:
File Url
The URI of the file. -
Title: string
Title:
Title
The title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
The content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
The size of the attachment file. -
UploadedFileName: string
Title:
Uploaded File Name
The name to assign to a new attachment file. -
UploadedText: string
Title:
Uploaded Text
The text content for a new text attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
The URI of a Topology Manager type attachment. -
Url: string
Title:
Url
Maximum Length:4000
The URL of a web page type attachment.
Nested Schema : Code Enforcement Inspection Attachment Revisions
Type:
array
Title:
Code Enforcement Inspection Attachment Revisions
The code enforcement inspection attachment revisions resource is used to display the historical information about an attachment.
Show Source
Nested Schema : schema
Type:
Show Source
object
-
ContentId: string
Maximum Length:
80
The contents of the attachment revision. -
ErrorStatusCode: string
The error code, if any, for the attachment revision.
-
ErrorStatusMessage: string
The error message, if any, for the attachment revision.
-
FileUrl: string
The file name of the 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(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 : publicSectorCodeEnforcementInspectionAttachments-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Title:
Agency ID
Default Value:1
The unique identifier of the public sector agency. -
AttachmentEntityName: string
Maximum Length:
255
Default Value:PSC_DOC_CEINS
The name of the inspection attachment that is used by the attachment component. -
AttachmentId: integer
(int64)
The unique identifier of the attachment from the common attachment table.
-
AttachmentKey: integer
(int64)
The unique identifier of the inspection attachment row.
-
AttachmentPuid: string
Maximum Length:
480
The legacy system attachment identifier for the migrated data. -
AttachmentType: string
Maximum Length:
15
Default Value:CE
The identifier of the type of attachment. -
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 attachment was created. -
Description: string
Title:
Description
Maximum Length:100
The description for the attached file. -
DocCategory: string
Maximum Length:
30
The unique identifier of the document category. -
DocSubcategory: string
Maximum Length:
30
The unique identifier of the document subcategory. -
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 file attached such as, Text, Image, and so on. -
InspectionAttachmentId: integer
(int64)
The unique identifier of the attachment from the common attachment table.
-
InspectionAttachmentViewAccessor: array
Code Enforcement Inspection Attachment Accessors
Title:
Code Enforcement Inspection Attachment Accessors
The code enforcement inspection attachment accessors resource is used to display file-related information such as the file name and the file URL. -
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. -
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.
-
TransactionKey: integer
(int64)
The unique identifier of the inspection.
-
TransactionPuid: string
Maximum Length:
480
The legacy system inspection transaction identifier for the migrated data. -
UpdatedByName: string
Title:
Last Updated By
The name of the user who last updated the attachment. -
Version: integer
(int32)
The version of the attachment.
Nested Schema : Code Enforcement Inspection Attachment Accessors
Type:
array
Title:
Code Enforcement Inspection Attachment Accessors
The code enforcement inspection attachment accessors resource is used to display file-related information such as the file name and the file URL.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorCodeEnforcementInspectionAttachments-InspectionAttachmentViewAccessor-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 attached document. -
AttachmentsRevision: array
Code Enforcement Inspection Attachment Revisions
Title:
Code Enforcement Inspection Attachment Revisions
The code enforcement inspection attachment revisions resource is used to display the historical information about an attachment. -
CategoryName: string
Title:
Category
Maximum Length:30
The category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
The user who created the record. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
The user name who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the record was created. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
The data type code of the attachment. -
Description: string
Title:
Description
Maximum Length:255
The description of the attachment. -
DmDocumentId: string
Maximum Length:
255
The document ID from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255
The document version number from which the attachment is created. -
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 code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
The error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
The expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File Contents
The contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
The file name of the attachment. -
FileUrl: string
Title:
File Url
The URI of the 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 name of the user who last updated the attachment. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
The user name who last updated the record. -
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. -
UploadedFileLength: integer
Title:
File Size
The size of the attachment file. -
UploadedFileName: string
Title:
Uploaded File Name
The name to assign to a new attachment file. -
UploadedText: string
Title:
Uploaded Text
The text content for a new text attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
The URI of a Topology Manager type attachment. -
Url: string
Title:
Url
Maximum Length:4000
The URL of a web page type attachment. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
The login credentials of the user who created the attachment.
Nested Schema : Code Enforcement Inspection Attachment Revisions
Type:
array
Title:
Code Enforcement Inspection Attachment Revisions
The code enforcement inspection attachment revisions resource is used to display the historical information about an attachment.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorCodeEnforcementInspectionAttachments-InspectionAttachmentViewAccessor-AttachmentsRevision-item-response
Type:
Show Source
object
-
AttachedDocumentId: string
Read Only:
true
The unique identifier of the attached document for this revision. -
ContentId: string
Maximum Length:
80
The contents of the attachment revision. -
ErrorStatusCode: string
The error code, if any, for the attachment revision.
-
ErrorStatusMessage: string
The error message, if any, for the attachment revision.
-
FileUrl: string
The file name of the 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
- InspectionAttachmentViewAccessor
-
Parameters:
- publicSectorCodeEnforcementInspectionAttachmentsUniqID:
$request.path.publicSectorCodeEnforcementInspectionAttachmentsUniqID
The code enforcement inspection attachment accessors resource is used to display file-related information such as the file name and the file URL. - publicSectorCodeEnforcementInspectionAttachmentsUniqID: