Update a standard comment
patch
/fscmRestApi/resources/11.13.18.05/publicSectorStandardComments/{publicSectorStandardCommentsUniqID}
Request
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Path Parameters
-
publicSectorStandardCommentsUniqID: string
Identifier to Standard Comments
The following table describes the body parameters in the request for this task.
Root Schema : publicSectorStandardComments-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int32)
Title:
Agency ID
The agency ID of the record. -
CategoryCd(optional):
string
Title:
Comment Category
Maximum Length:30
The comment category 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. -
CommentsPlain(optional):
string
The text of the standard comment without the use of rich text formatting.
-
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. -
EnabledFlag(optional):
string
Title:
Enabled
Maximum Length:1
Indicates that the standard comment is available to be used. The default value for the standard comment is set as Disabled. -
FavoriteComment(optional):
array Favorite Comments
Title:
Favorite Comments
The standard comments resource is used to view, create, or modify a standard comment. Standard comments are used to enter standard text while entering comments for a transaction such as permits, workflow, and inspection. -
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. -
SubcategoryCd(optional):
string
Title:
Comment Subcategory
Maximum Length:30
The comment subcategory ID of the record.
Nested Schema : Favorite Comments
Type:
array
Title:
Favorite Comments
The standard comments resource is used to view, create, or modify a standard comment. Standard comments are used to enter standard text while entering comments for a transaction such as permits, workflow, and inspection.
Show Source
Nested 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-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int32)
Title:
Agency ID
The agency ID of the record. -
CategoryCd(optional):
string
Title:
Comment Category
Maximum Length:30
The comment category 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. -
CommentsPlain(optional):
string
The text of the standard comment without the use of rich text formatting.
-
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. -
EnabledFlag(optional):
string
Title:
Enabled
Maximum Length:1
Indicates that the standard comment is available to be used. The default value for the standard comment is set as Disabled. -
FavoriteComment(optional):
array Favorite Comments
Title:
Favorite Comments
The standard comments resource is used to view, create, or modify a standard comment. Standard comments are used to enter standard text while entering comments for a transaction such as permits, workflow, and inspection. -
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. -
SubcategoryCd(optional):
string
Title:
Comment Subcategory
Maximum Length:30
The comment subcategory ID of the record.
Nested Schema : Favorite Comments
Type:
array
Title:
Favorite Comments
The standard comments resource is used to view, create, or modify a standard comment. Standard comments are used to enter standard text while entering comments for a transaction such as permits, workflow, and inspection.
Show Source
Nested 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.