Update a review summary comment
patch
/fscmRestApi/resources/11.13.18.05/publicSectorReviewSummaryComments/{publicSectorReviewSummaryCommentsUniqID}
Request
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Path Parameters
-
publicSectorReviewSummaryCommentsUniqID: integer
This is the hash key of the attributes which make up the composite key--- ReviewSummaryCommentId and LnpRecordKey ---for the Review Summary Comments resource and used to uniquely identify an instance of Review Summary Comments. The client should not generate the hash key value. Instead, the client should query on the Review Summary Comments collection resource with a filter on the primary key values in order to navigate to a specific instance of Review Summary Comments.
For example: publicSectorReviewSummaryComments?q=ReviewSummaryCommentId=<value1>;LnpRecordKey=<value2>
The following table describes the body parameters in the request for this task.
Root Schema : publicSectorReviewSummaryComments-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int32)
Title:
Agency ID
The identifier of the public sector agency. -
CommentId(optional):
integer(int64)
The unique identifier of the review summary comment.
-
CommentPreview(optional):
string
Title:
Comment Preview
The short description of the comment. -
CommentText(optional):
string
Title:
Comments
The attribute captures the actual comment text. -
CreatedBy(optional):
string
Title:
Created By
Maximum Length:64
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. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated Date
The date and time when the row was last updated. -
LastUpdatedBy(optional):
string
Title:
Last Updated By
Maximum Length:64
The name of the user who last updated the row. -
links(optional):
array Items
Title:
Items
Link Relations -
LnpRecordKey(optional):
integer(int64)
The unique identifier of the planning and zoning application.
-
ReviewSummaryCommentId(optional):
integer(int64)
The unique identifier of the review summary comment.
-
Visibility(optional):
string
Title:
Hide from Public
Maximum Length:1
The identifier to indicate if the comments are visible to 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 : publicSectorReviewSummaryComments-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int32)
Title:
Agency ID
The identifier of the public sector agency. -
CommentId(optional):
integer(int64)
The unique identifier of the review summary comment.
-
CommentPreview(optional):
string
Title:
Comment Preview
The short description of the comment. -
CommentText(optional):
string
Title:
Comments
The attribute captures the actual comment text. -
CreatedBy(optional):
string
Title:
Created By
Maximum Length:64
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. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated Date
The date and time when the row was last updated. -
LastUpdatedBy(optional):
string
Title:
Last Updated By
Maximum Length:64
The name of the user who last updated the row. -
links(optional):
array Items
Title:
Items
Link Relations -
LnpRecordKey(optional):
integer(int64)
The unique identifier of the planning and zoning application.
-
ReviewSummaryCommentId(optional):
integer(int64)
The unique identifier of the review summary comment.
-
Visibility(optional):
string
Title:
Hide from Public
Maximum Length:1
The identifier to indicate if the comments are visible to 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.