Create a plan reviewer's comments for a permit plan review
post
/fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewerComments
Request
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
AgencyId: integer
(int32)
Title:
Agency ID
Default Value:1
The agency identifier of the public sector entity to which this plan reviewer comment applies. -
CommentId: integer
(int64)
The comment identifier in the comment record.
-
CommentText: string
(byte)
Title:
Comments
The text of the plan reviewer comment. -
DocumentFileKey: integer
(int64)
The unique identifier for an electronic plan review file.
-
DocumentUserKey: integer
(int64)
The unique identifier for an electronic plan review file reviewer.
-
OriginalCreatedBy: string
The name of the user who created the plan reviewer comment.
-
PlanReviewAgencyId: integer
(int32)
Default Value:
1
The agency identifier of the public sector entity to which this plan reviewer comment applies. -
PlanReviewCommentId: integer
(int64)
The comment ID of the plan reviewer comment.
-
PlanReviewCommentType: string
Maximum Length:
5
The comment type for the plan reviewer comment. For example, REVWR and CYCLE. -
PlanReviewKey: integer
(int64)
The unique identifier for a plan review cycle.
-
PlanReviewPuid: string
Maximum Length:
480
The public unique identifier for a plan review. -
PlanReviewUserKey: integer
(int64)
The unique identifier for a plan reviewer.
-
PlanReviewUserPuid: string
Maximum Length:
480
The public unique identifier for a plan reviewer. -
PrCommentKey: integer
(int64)
The unique identifier for a plan reviewer comment.
-
PrCommentPuid: string
Maximum Length:
480
The public unique identifier for a plan review or plan reviewer comment. -
Visibility: string
Title:
Hide from Public
Maximum Length:1
Default Value:Y
The plan reviewer comment is visible to public users.
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 : publicSectorPlanReviewerComments-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Title:
Agency ID
Default Value:1
The agency identifier of the public sector entity to which this plan reviewer comment applies. -
CommentId: integer
(int64)
The comment identifier in the comment record.
-
CommentPreview: string
Title:
Comment Preview
Read Only:true
The preview text of the plan reviewer comment. -
CommentText: string
(byte)
Title:
Comments
The text of the plan reviewer comment. -
CreatedByName: string
Title:
Created By
Read Only:true
The name of the user who created the plan reviewer comment. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the plan reviewer comment was created. -
DocumentFileKey: integer
(int64)
The unique identifier for an electronic plan review file.
-
DocumentUserKey: integer
(int64)
The unique identifier for an electronic plan review file reviewer.
-
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the plan reviewer comment was last updated. -
LastUpdatedByName: string
Title:
Last Updated By
Read Only:true
The name of the user who last updated the plan reviewer comment. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OriginalCreatedBy: string
The name of the user who created the plan reviewer comment.
-
PlanReviewAgencyId: integer
(int32)
Default Value:
1
The agency identifier of the public sector entity to which this plan reviewer comment applies. -
PlanReviewCommentId: integer
(int64)
The comment ID of the plan reviewer comment.
-
PlanReviewCommentType: string
Maximum Length:
5
The comment type for the plan reviewer comment. For example, REVWR and CYCLE. -
PlanReviewKey: integer
(int64)
The unique identifier for a plan review cycle.
-
PlanReviewPuid: string
Maximum Length:
480
The public unique identifier for a plan review. -
PlanReviewUserKey: integer
(int64)
The unique identifier for a plan reviewer.
-
PlanReviewUserPuid: string
Maximum Length:
480
The public unique identifier for a plan reviewer. -
PrCommentKey: integer
(int64)
The unique identifier for a plan reviewer comment.
-
PrCommentPuid: string
Maximum Length:
480
The public unique identifier for a plan review or plan reviewer comment. -
Visibility: string
Title:
Hide from Public
Maximum Length:1
Default Value:Y
The plan reviewer comment is visible to 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.