Create a plan reviewer's comments for a permit plan review
post
/fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewerComments
Request
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
The following table describes the body parameters in the request for this task.
Root Schema : publicSectorPlanReviewerComments-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int32)
Title:
Agency ID
The agency identifier of the public sector entity to which this plan reviewer comment applies. -
CommentId(optional):
integer(int64)
The comment identifier in the comment record.
-
CommentPreview(optional):
string
Title:
Comment Preview
The preview text of the plan reviewer comment. -
CommentText(optional):
string
Title:
Comments
The text of the plan reviewer comment. -
CreatedBy(optional):
string
Title:
Created By
Maximum Length:64
The user who created the plan reviewer comment. -
CreationDate(optional):
string(date-time)
Title:
Creation Date
The date and time when the plan reviewer comment was created. -
DocumentFileKey(optional):
integer(int64)
The unique identifier for an electronic plan review file.
-
DocumentUserKey(optional):
integer(int64)
The unique identifier for an electronic plan review file reviewer.
-
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated Date
The date and time when the plan reviewer comment was last updated. -
LastUpdatedBy(optional):
string
Title:
Last Updated By
Maximum Length:64
The user who last updated the plan reviewer comment. -
links(optional):
array Items
Title:
Items
Link Relations -
PlanReviewAgencyId(optional):
integer(int32)
The agency identifier of the public sector entity to which this plan reviewer comment applies.
-
PlanReviewCommentId(optional):
integer(int64)
The comment ID of the plan reviewer comment.
-
PlanReviewCommentType(optional):
string
Maximum Length:
5
The comment type for the plan reviewer comment. For example, REVWR and CYCLE. -
PlanReviewKey(optional):
integer(int64)
The unique identifier for a plan review cycle.
-
PlanReviewUserKey(optional):
integer(int64)
The unique identifier for a plan reviewer.
-
PrCommentKey(optional):
integer(int64)
The unique identifier for a plan reviewer comment.
-
Visibility(optional):
string
Title:
Hide from Public
Maximum Length:1
The plan reviewer comment is 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 : publicSectorPlanReviewerComments-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int32)
Title:
Agency ID
The agency identifier of the public sector entity to which this plan reviewer comment applies. -
CommentId(optional):
integer(int64)
The comment identifier in the comment record.
-
CommentPreview(optional):
string
Title:
Comment Preview
The preview text of the plan reviewer comment. -
CommentText(optional):
string
Title:
Comments
The text of the plan reviewer comment. -
CreatedBy(optional):
string
Title:
Created By
Maximum Length:64
The user who created the plan reviewer comment. -
CreationDate(optional):
string(date-time)
Title:
Creation Date
The date and time when the plan reviewer comment was created. -
DocumentFileKey(optional):
integer(int64)
The unique identifier for an electronic plan review file.
-
DocumentUserKey(optional):
integer(int64)
The unique identifier for an electronic plan review file reviewer.
-
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated Date
The date and time when the plan reviewer comment was last updated. -
LastUpdatedBy(optional):
string
Title:
Last Updated By
Maximum Length:64
The user who last updated the plan reviewer comment. -
links(optional):
array Items
Title:
Items
Link Relations -
PlanReviewAgencyId(optional):
integer(int32)
The agency identifier of the public sector entity to which this plan reviewer comment applies.
-
PlanReviewCommentId(optional):
integer(int64)
The comment ID of the plan reviewer comment.
-
PlanReviewCommentType(optional):
string
Maximum Length:
5
The comment type for the plan reviewer comment. For example, REVWR and CYCLE. -
PlanReviewKey(optional):
integer(int64)
The unique identifier for a plan review cycle.
-
PlanReviewUserKey(optional):
integer(int64)
The unique identifier for a plan reviewer.
-
PrCommentKey(optional):
integer(int64)
The unique identifier for a plan reviewer comment.
-
Visibility(optional):
string
Title:
Hide from Public
Maximum Length:1
The plan reviewer comment is 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.