Update a comment
patch
/fscmRestApi/resources/11.13.18.05/publicSectorIncidents/{IncidentKey}/child/IncidentComment/{CommentKey}
Request
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Path Parameters
-
CommentKey: integer
The comment key.
-
IncidentKey: integer
The unique identifier for an incident. This number is created using autonumbering.
The following table describes the body parameters in the request for this task.
Root Schema : publicSectorIncidents-IncidentComment-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int32)
Title:
Agency ID
The unique identifier for the agency. -
CommentId(optional):
integer(int64)
This comment ID.
-
CommentKey(optional):
integer(int64)
The comment key.
-
CommentPreview(optional):
string
Title:
Comment Preview
The text of the comment in plain text format. This is used to preview the comment. -
CommentText(optional):
string
Title:
Comments
The text of the comment in HTML format. -
CreatedBy(optional):
string
Title:
Created By
Maximum Length:64
The user who created the row. -
CreationDate(optional):
string(date-time)
Title:
Creation Date
The date and time that the row was created. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated Date
The date and time that the row was last updated. -
LastUpdatedBy(optional):
string
Title:
Last Updated By
Maximum Length:64
The user who last updated the row. -
links(optional):
array Items
Title:
Items
Link Relations -
TransactionKey(optional):
integer(int64)
The transaction key for the transaction that the comment is associated with.
-
TransactionType(optional):
string
Maximum Length:
10
The type of transaction that the comment is associated with. -
Visibility(optional):
string
Title:
Hide from Public
Maximum Length:1
Indicates whether the comment is visible.
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 : publicSectorIncidents-IncidentComment-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int32)
Title:
Agency ID
The unique identifier for the agency. -
CommentId(optional):
integer(int64)
This comment ID.
-
CommentKey(optional):
integer(int64)
The comment key.
-
CommentPreview(optional):
string
Title:
Comment Preview
The text of the comment in plain text format. This is used to preview the comment. -
CommentText(optional):
string
Title:
Comments
The text of the comment in HTML format. -
CreatedBy(optional):
string
Title:
Created By
Maximum Length:64
The user who created the row. -
CreationDate(optional):
string(date-time)
Title:
Creation Date
The date and time that the row was created. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated Date
The date and time that the row was last updated. -
LastUpdatedBy(optional):
string
Title:
Last Updated By
Maximum Length:64
The user who last updated the row. -
links(optional):
array Items
Title:
Items
Link Relations -
TransactionKey(optional):
integer(int64)
The transaction key for the transaction that the comment is associated with.
-
TransactionType(optional):
string
Maximum Length:
10
The type of transaction that the comment is associated with. -
Visibility(optional):
string
Title:
Hide from Public
Maximum Length:1
Indicates whether the comment is visible.
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.