Update a code enforcement inspection comment
patch
/fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementInspectionComments/{publicSectorCodeEnforcementInspectionCommentsUniqID}
Request
Path Parameters
-
publicSectorCodeEnforcementInspectionCommentsUniqID(required): string
This is the hash key of the attributes which make up the composite key--- CommentId and CommentKey ---for the Code Enforcement Inspection Comments resource and used to uniquely identify an instance of Code Enforcement Inspection Comments. The client should not generate the hash key value. Instead, the client should query on the Code Enforcement Inspection Comments collection resource with a filter on the primary key values in order to navigate to a specific instance of Code Enforcement Inspection Comments.
For example: publicSectorCodeEnforcementInspectionComments?q=CommentId=<value1>;CommentKey=<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
-
CommentPuid: string
Maximum Length:
480
The legacy system comment identifier for the migrated data. -
CommentText: string
(byte)
Title:
Comments
The content of the comment. -
TransactionPuid: string
Maximum Length:
480
The legacy system inspection transaction identifier for the migrated data. -
Visibility: string
Title:
Hide from Public
Maximum Length:1
Default Value:Y
The identifier that determines if the comment is visible to registered public users.
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 : publicSectorCodeEnforcementInspectionComments-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Title:
Agency ID
Default Value:1
The identifier of the public sector agency. -
CommentId: integer
(int64)
The identifier of the comment.
-
CommentKey: integer
(int64)
The unique identifier of the comment.
-
CommentPreview: string
Title:
Comment Preview
Read Only:true
The identifier of the preview text of the comment. -
CommentPuid: string
Maximum Length:
480
The legacy system comment identifier for the migrated data. -
CommentText: string
(byte)
Title:
Comments
The content of the comment. -
CreatedByName: string
Title:
Created By
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. -
InspectionCommentId: integer
(int64)
The unique identifier of the comment.
-
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the row was last updated. -
LastUpdatedByName: string
Title:
Last Updated By
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. -
OriginalCreatedBy: string
The name of the user who created the comment.
-
TransactionKey: integer
(int64)
The unique identifier of the inspection for which the comment is being recorded.
-
TransactionPuid: string
Maximum Length:
480
The legacy system inspection transaction identifier for the migrated data. -
Visibility: string
Title:
Hide from Public
Maximum Length:1
Default Value:Y
The identifier that determines if the comment is visible to registered public users.
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.