Update a record comment
patch
/fscmRestApi/resources/11.13.18.05/publicSectorRecordComments/{publicSectorRecordCommentsUniqID}
Request
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Path Parameters
-
publicSectorRecordCommentsUniqID: string
Identifier to Record Comments
The following table describes the body parameters in the request for this task.
Root Schema : publicSectorRecordComments-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int32)
Title:
Agency ID
The unique identifier of the public sector agency. -
CommentId(optional):
integer(int64)
The unique identifier of the record comment.
-
CommentPreview(optional):
string
Title:
Comment Preview
The comment preview. -
CommentText(optional):
string
Title:
Comments
The comment text. -
CreatedBy(optional):
string
Title:
Created By
Maximum Length:64
The name of the user who created the comment. -
CreationDate(optional):
string(date-time)
Title:
Creation Date
The date when the comment was created. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated Date
The name of the user who last updated the comment. -
LastUpdatedBy(optional):
string
Title:
Last Updated By
Maximum Length:64
The date when the comment was last updated. -
links(optional):
array Items
Title:
Items
Link Relations -
LnpRecordId(optional):
string
Title:
Record ID
Maximum Length:50
The logical ID of the application record. This ID is generated based on the auto number rule configured for the record type. -
LnpRecordKey(optional):
integer(int64)
The unique identifier of the record.
-
SubjectId(optional):
string
Title:
Subject
Maximum Length:30
The unique identifier to determine the type of comment such as a record, workflow, or inspection. -
Visibility(optional):
string
Title:
Hide from Public
Maximum Length:1
The checkbox to indicate if the comment will be visible to others.
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 : publicSectorRecordComments-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int32)
Title:
Agency ID
The unique identifier of the public sector agency. -
CommentId(optional):
integer(int64)
The unique identifier of the record comment.
-
CommentPreview(optional):
string
Title:
Comment Preview
The comment preview. -
CommentText(optional):
string
Title:
Comments
The comment text. -
CreatedBy(optional):
string
Title:
Created By
Maximum Length:64
The name of the user who created the comment. -
CreationDate(optional):
string(date-time)
Title:
Creation Date
The date when the comment was created. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated Date
The name of the user who last updated the comment. -
LastUpdatedBy(optional):
string
Title:
Last Updated By
Maximum Length:64
The date when the comment was last updated. -
links(optional):
array Items
Title:
Items
Link Relations -
LnpRecordId(optional):
string
Title:
Record ID
Maximum Length:50
The logical ID of the application record. This ID is generated based on the auto number rule configured for the record type. -
LnpRecordKey(optional):
integer(int64)
The unique identifier of the record.
-
SubjectId(optional):
string
Title:
Subject
Maximum Length:30
The unique identifier to determine the type of comment such as a record, workflow, or inspection. -
Visibility(optional):
string
Title:
Hide from Public
Maximum Length:1
The checkbox to indicate if the comment will be visible to others.
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.