Update a favorite comment
patch
/fscmRestApi/resources/11.13.18.05/publicSectorStandardComments/{publicSectorStandardCommentsUniqID}/child/FavoriteComment/{FavoriteCommentUniqID}
Request
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Path Parameters
-
FavoriteCommentUniqID: integer
This is the hash key of the attributes which make up the composite key--- UserName, AgencyId and StandardCommentId ---for the Favorite Comments resource and used to uniquely identify an instance of Favorite Comments. The client should not generate the hash key value. Instead, the client should query on the Favorite Comments collection resource with a filter on the primary key values in order to navigate to a specific instance of Favorite Comments.
For example: FavoriteComment?q=UserName=<value1>;AgencyId=<value2>;StandardCommentId=<value3> -
publicSectorStandardCommentsUniqID: string
Identifier to Standard Comments
The following table describes the body parameters in the request for this task.
Root Schema : publicSectorStandardComments-FavoriteComment-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int32)
Title:
Agency ID
The agency ID of the record. -
CommentPreview(optional):
string
Title:
Comment Preview
The preview text of the standard comment. -
Comments(optional):
string
Title:
Comments
The text of the standard comment. -
CreatedBy(optional):
string
Title:
Created By
Maximum Length:64
The name of the user who created the row. -
CreationDate(optional):
string(date-time)
Title:
Creation Date
The date and time when the row was created. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated Date
The date and time when the row was last updated. -
LastUpdatedBy(optional):
string
Title:
Last Updated By
Maximum Length:64
The name of the user who last updated the row. -
links(optional):
array Items
Title:
Items
Link Relations -
StandardCommentId(optional):
string
Title:
Comment Code
Maximum Length:200
The standard comment ID of the record. -
UserName(optional):
string
Maximum Length:
100
The name of the user who created the row.
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 : publicSectorStandardComments-FavoriteComment-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int32)
Title:
Agency ID
The agency ID of the record. -
CommentPreview(optional):
string
Title:
Comment Preview
The preview text of the standard comment. -
Comments(optional):
string
Title:
Comments
The text of the standard comment. -
CreatedBy(optional):
string
Title:
Created By
Maximum Length:64
The name of the user who created the row. -
CreationDate(optional):
string(date-time)
Title:
Creation Date
The date and time when the row was created. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated Date
The date and time when the row was last updated. -
LastUpdatedBy(optional):
string
Title:
Last Updated By
Maximum Length:64
The name of the user who last updated the row. -
links(optional):
array Items
Title:
Items
Link Relations -
StandardCommentId(optional):
string
Title:
Comment Code
Maximum Length:200
The standard comment ID of the record. -
UserName(optional):
string
Maximum Length:
100
The name of the user who created the row.
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.