Update a workflow comment
patch
/fscmRestApi/resources/11.13.18.05/publicSectorPcsComments/{publicSectorPcsCommentsUniqID}
Request
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Path Parameters
-
publicSectorPcsCommentsUniqID: integer
This is the hash key of the attributes which make up the composite key--- PcsCommentId, TaskId and LnpRecordKey ---for the Workflow Comments resource and used to uniquely identify an instance of Workflow Comments. The client should not generate the hash key value. Instead, the client should query on the Workflow Comments collection resource with a filter on the primary key values in order to navigate to a specific instance of Workflow Comments.
For example: publicSectorPcsComments?q=PcsCommentId=<value1>;TaskId=<value2>;LnpRecordKey=<value3>
The following table describes the body parameters in the request for this task.
Root Schema : publicSectorPcsComments-item
Type:
object
Discriminator:
Show Source
PcsCommentType
-
AgencyId(optional):
integer(int32)
Title:
Agency ID
The unique identifier of the agency. -
CommentId(optional):
integer(int64)
The unique identifier of the workflow comment.
-
CommentPreview(optional):
string
Title:
Comment Preview
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(optional):
string
Title:
Comments
The comment that has been entered by the user. -
CreatedByName(optional):
string
Title:
Created By
The name of the user who has added the comment. -
CreationDate(optional):
string(date-time)
Title:
Creation Date
The date on which the comment was added. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated Date
The date on which the most recent update to the comment was made. -
LastUpdatedByName(optional):
string
Title:
Last Updated By
The name of the user who has most recently updated the comment. -
links(optional):
array Items
Title:
Items
Link Relations -
LnpRecordKey(optional):
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.
-
PcsCommentId(optional):
integer(int64)
The unique identifier of the workflow comment.
-
PcsCommentType:
string
Maximum Length:
5
The source application corresponding to the comment. It holds a code corresponding to the application. -
TaskId(optional):
string
Maximum Length:
50
The unique identifier of the workflow task. -
Visibility(optional):
string
Title:
Hide from Public
Maximum Length:1
The indicator that determines whether the comment should be hidden from public users or not.
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 : publicSectorPcsComments-item
Type:
object
Discriminator:
Show Source
PcsCommentType
-
AgencyId(optional):
integer(int32)
Title:
Agency ID
The unique identifier of the agency. -
CommentId(optional):
integer(int64)
The unique identifier of the workflow comment.
-
CommentPreview(optional):
string
Title:
Comment Preview
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(optional):
string
Title:
Comments
The comment that has been entered by the user. -
CreatedByName(optional):
string
Title:
Created By
The name of the user who has added the comment. -
CreationDate(optional):
string(date-time)
Title:
Creation Date
The date on which the comment was added. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated Date
The date on which the most recent update to the comment was made. -
LastUpdatedByName(optional):
string
Title:
Last Updated By
The name of the user who has most recently updated the comment. -
links(optional):
array Items
Title:
Items
Link Relations -
LnpRecordKey(optional):
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.
-
PcsCommentId(optional):
integer(int64)
The unique identifier of the workflow comment.
-
PcsCommentType:
string
Maximum Length:
5
The source application corresponding to the comment. It holds a code corresponding to the application. -
TaskId(optional):
string
Maximum Length:
50
The unique identifier of the workflow task. -
Visibility(optional):
string
Title:
Hide from Public
Maximum Length:1
The indicator that determines whether the comment should be hidden from public users or not.
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.