Get a workflow comment
get
/fscmRestApi/resources/11.13.18.05/publicSectorPcsComments/{publicSectorPcsCommentsUniqID}
Request
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>
Query Parameters
-
dependency: string
This parameter specifies dependencies which are attributes that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The attributes 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 attributes 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 attributes. 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 attributes. Only the specified attributes are returned, which means that if no attributes are specified, no attributes 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 attributes. 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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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. -
CreatedBy(optional):
string
Title:
Created By
Maximum Length:64
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. -
LastUpdatedBy(optional):
string
Title:
Last Updated By
Maximum Length:64
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.