Get a permit plan review comment
get
/fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewComments/{publicSectorPlanReviewCommentsUniqID}
Request
Path Parameters
-
publicSectorPlanReviewCommentsUniqID(required): string
This is the hash key of the attributes which make up the composite key--- PlanReviewAgencyId and PrCommentKey ---for the Plan Review Comments resource and used to uniquely identify an instance of Plan Review Comments. The client should not generate the hash key value. Instead, the client should query on the Plan Review Comments collection resource with a filter on the primary key values in order to navigate to a specific instance of Plan Review Comments.
For example: publicSectorPlanReviewComments?q=PlanReviewAgencyId=<value1>;PrCommentKey=<value2>
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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.
There's no request body for this operation.
Back to TopResponse
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 : publicSectorPlanReviewComments-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 review 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 review comment. -
CommentText: string
(byte)
Title:
Comments
The text of the plan review comment. -
CreatedByName: string
Title:
Created By
Read Only:true
The name of the user who created the plan review comment. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the plan review 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 review comment was last updated. -
LastUpdatedByName: string
Title:
Last Updated By
Read Only:true
The name of the user who last updated the plan review 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 review comment.
-
PlanReviewAgencyId: integer
(int32)
Default Value:
1
The agency identifier of the public sector entity to which this plan review comment applies. -
PlanReviewCommentId: integer
(int64)
The comment ID of the plan review comment.
-
PlanReviewCommentType: string
Maximum Length:
5
The comment type for the plan review 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 review 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
Indicates whether plan review comment is visible to public users. The default value is N.
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.