Update a standard comment
patch
/fscmRestApi/resources/11.13.18.05/publicSectorStandardComments/{publicSectorStandardCommentsUniqID}
Request
Path Parameters
-
publicSectorStandardCommentsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Standard Comments resource and used to uniquely identify an instance of Standard Comments. The client should not generate the hash key value. Instead, the client should query on the Standard Comments collection resource in order to navigate to a specific instance of Standard Comments to get the hash key.
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
CategoryCd: string
Title:
Comment Category
Maximum Length:30
The comment category ID of the record. -
Comments: string
(byte)
Title:
Comments
The text of the standard comment. -
EnabledFlag: boolean
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: array
Favorite Comments
Title:
Favorite Comments
The favorite comments resource is used to view, create, or modify a favorite comment. A favorite comment represents a standard comment. -
SubcategoryCd: string
Title:
Comment Subcategory
Maximum Length:30
The comment subcategory ID of the record.
Nested Schema : Favorite Comments
Type:
array
Title:
Favorite Comments
The favorite comments resource is used to view, create, or modify a favorite comment. A favorite comment represents a standard comment.
Show Source
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version(required):
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : publicSectorStandardComments-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Title:
Agency ID
Default Value:1
The agency ID of the record. -
CategoryCd: string
Title:
Comment Category
Maximum Length:30
The comment category ID of the record. -
CommentPreview: string
Title:
Comment Preview
Read Only:true
The preview text of the standard comment. -
Comments: string
(byte)
Title:
Comments
The text of the standard comment. -
CommentsPlain: string
(byte)
Read Only:
true
The text of the standard comment without the use of rich text formatting. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The name of the user who created the row. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the row was created. -
EnabledFlag: boolean
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: array
Favorite Comments
Title:
Favorite Comments
The favorite comments resource is used to view, create, or modify a favorite comment. A favorite comment represents a standard comment. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the row was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The name of the user who last updated the row. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
StandardCommentId: string
Title:
Comment Code
Maximum Length:200
The standard comment ID of the record. -
SubcategoryCd: string
Title:
Comment Subcategory
Maximum Length:30
The comment subcategory ID of the record.
Nested Schema : Favorite Comments
Type:
array
Title:
Favorite Comments
The favorite comments resource is used to view, create, or modify a favorite comment. A favorite comment represents a standard comment.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorStandardComments-FavoriteComment-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Title:
Agency ID
Default Value:1
The agency ID of the record. -
CommentPreview: string
Title:
Comment Preview
Read Only:true
The preview text of the standard comment. -
Comments: string
(byte)
Title:
Comments
Read Only:true
The text of the standard comment. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The name of the user who created the row. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the row was created. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the row was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The name of the user who last updated the row. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
StandardCommentId: string
Title:
Comment Code
Maximum Length:200
The standard comment ID of the record. -
UserName: string
Read Only:
true
Maximum Length:100
The name of the user who created the row.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Links
- FavoriteComment
-
Parameters:
- publicSectorStandardCommentsUniqID:
$request.path.publicSectorStandardCommentsUniqID
The favorite comments resource is used to view, create, or modify a favorite comment. A favorite comment represents a standard comment. - publicSectorStandardCommentsUniqID: