Create a workflow comment
post
/fscmRestApi/resources/11.13.18.05/publicSectorPcsComments
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 unique identifier of the agency. -
CommentId: integer
(int64)
The unique identifier of the workflow comment.
-
CommentText: string
(byte)
Title:
Comments
The comment that has been entered by the user. -
LnpRecordKey: integer
(int64)
The unique identifier for a record. The record can be for permits, business licenses, professional licenses, or planning and zoning, which is determined by the classification.
-
OriginalCreatedBy: string
The name of the user who created the comment.
-
PcsCommentId: integer
(int64)
The unique identifier of the workflow comment.
-
PcsCommentType: string
Maximum Length:
5
Default Value:PCS
The source application corresponding to the comment. It holds a code corresponding to the application. -
TaskId: string
Maximum Length:
100
The unique identifier of the workflow task. -
Visibility: string
Title:
Hide from Public
Maximum Length:1
Default Value:Y
The indicator that determines whether the comment should be hidden from public users or not.
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 : publicSectorPcsComments-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Title:
Agency ID
Default Value:1
The unique identifier of the agency. -
CommentId: integer
(int64)
The unique identifier of the workflow comment.
-
CommentPreview: string
Title:
Comment Preview
Read Only:true
This field is used to show the preview of the entered comments. It is usually the first 100-200 characters of the comment, which is a configurable number. -
CommentText: string
(byte)
Title:
Comments
The comment that has been entered by the user. -
CreatedByName: string
Title:
Created By
Read Only:true
The name of the user who has added the comment. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date on which the comment was added. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date on which the most recent update to the comment was made. -
LastUpdatedByName: string
Title:
Last Updated By
Read Only:true
The name of the user who has most recently updated the comment. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LnpRecordKey: integer
(int64)
The unique identifier for a record. The record can be for permits, business licenses, professional licenses, or planning and zoning, which is determined by the classification.
-
OriginalCreatedBy: string
The name of the user who created the comment.
-
PcsCommentId: integer
(int64)
The unique identifier of the workflow comment.
-
PcsCommentType: string
Maximum Length:
5
Default Value:PCS
The source application corresponding to the comment. It holds a code corresponding to the application. -
TaskId: string
Maximum Length:
100
The unique identifier of the workflow task. -
Visibility: string
Title:
Hide from Public
Maximum Length:1
Default Value:Y
The indicator that determines whether the comment should be hidden from public users or not.
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.