Update a code enforcement inspection comment
patch
/fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementInspectionComments/{publicSectorCodeEnforcementInspectionCommentsUniqID}
Request
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Path Parameters
-
publicSectorCodeEnforcementInspectionCommentsUniqID: integer
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>
The following table describes the body parameters in the request for this task.
Root Schema : publicSectorCodeEnforcementInspectionComments-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int32)
Title:
Agency ID
The identifier of the public sector agency. -
CommentId(optional):
integer(int64)
The identifier of the comment.
-
CommentKey(optional):
integer(int64)
The unique identifier of the comment.
-
CommentPreview(optional):
string
Title:
Comment Preview
The identifier of the preview text of the comment. -
CommentPuid(optional):
string
Maximum Length:
480
The legacy system comment identifier for the migrated data. -
CommentText(optional):
string
Title:
Comments
The content of the comment. -
CreatedByName(optional):
string
Title:
Created By
The name of the user who created the row. -
CreationDate(optional):
string(date-time)
Title:
Creation Date
The date and time when the row was created. -
InspectionCommentId(optional):
integer(int64)
The unique identifier of the comment.
-
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated Date
The date and time when the row was last updated. -
LastUpdatedByName(optional):
string
Title:
Last Updated By
The name of the user who last updated the row. -
links(optional):
array Items
Title:
Items
Link Relations -
TransactionKey(optional):
integer(int64)
The unique identifier of the inspection for which the comment is being recorded.
-
TransactionPuid(optional):
string
Maximum Length:
480
The legacy system inspection transaction identifier for the migrated data. -
Visibility(optional):
string
Title:
Hide from Public
Maximum Length:1
The identifier that determines if the comment is visible to registered public users.
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 : publicSectorCodeEnforcementInspectionComments-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int32)
Title:
Agency ID
The identifier of the public sector agency. -
CommentId(optional):
integer(int64)
The identifier of the comment.
-
CommentKey(optional):
integer(int64)
The unique identifier of the comment.
-
CommentPreview(optional):
string
Title:
Comment Preview
The identifier of the preview text of the comment. -
CommentPuid(optional):
string
Maximum Length:
480
The legacy system comment identifier for the migrated data. -
CommentText(optional):
string
Title:
Comments
The content of the comment. -
CreatedByName(optional):
string
Title:
Created By
The name of the user who created the row. -
CreationDate(optional):
string(date-time)
Title:
Creation Date
The date and time when the row was created. -
InspectionCommentId(optional):
integer(int64)
The unique identifier of the comment.
-
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated Date
The date and time when the row was last updated. -
LastUpdatedByName(optional):
string
Title:
Last Updated By
The name of the user who last updated the row. -
links(optional):
array Items
Title:
Items
Link Relations -
TransactionKey(optional):
integer(int64)
The unique identifier of the inspection for which the comment is being recorded.
-
TransactionPuid(optional):
string
Maximum Length:
480
The legacy system inspection transaction identifier for the migrated data. -
Visibility(optional):
string
Title:
Hide from Public
Maximum Length:1
The identifier that determines if the comment is visible to registered public users.
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.