Update a comment for the conditions of approval
patch
/fscmRestApi/resources/11.13.18.05/publicSectorConditionOfApprovalComments/{CommentKey}
Request
Path Parameters
-
CommentKey(required): integer(int64)
The unique identifier of the comment.
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
-
CoaPuid: string
Maximum Length:
480
The public unique identifier of the migrated condition of approval. -
CommentPuid: string
Maximum Length:
480
The public unique identifier of the migrated comment. -
CommentText: string
(byte)
Title:
Comments
The actual text of the comment. -
MigratedDataFlag: string
Maximum Length:
3
Indicates whether the transaction was created online or migrated from a legacy system. -
Visibility: string
Title:
Hide from Public
Maximum Length:1
Default Value:Y
Indicates if the comment is visible to the anonymous user.
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 : publicSectorConditionOfApprovalComments-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Title:
Agency ID
Default Value:1
The unique identifier of the agency. -
COACommentId: integer
(int64)
The unique identifier of the comment.
-
CoaKey: integer
(int64)
The unique identifier of the conditions of approval.
-
CoaPuid: string
Maximum Length:
480
The public unique identifier of the migrated condition of approval. -
CommentId: integer
(int64)
The unique identifier of the comment.
-
CommentKey: integer
(int64)
The unique identifier of the comment.
-
CommentPreview: string
Title:
Comment Preview
Read Only:true
The preview of the comment text. -
CommentPuid: string
Maximum Length:
480
The public unique identifier of the migrated comment. -
CommentText: string
(byte)
Title:
Comments
The actual text of the comment. -
CreatedByName: string
Title:
Created By
Read Only:true
The name of the person who created the comment. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date on which the comment was created. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date on which the comment was updated. -
LastUpdatedByName: string
Title:
Last Updated By
Read Only:true
The name of the person who updated the comment. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MigratedDataFlag: string
Maximum Length:
3
Indicates whether the transaction was created online or migrated from a legacy system. -
OriginalCreatedBy: string
The name of the user who created the comment.
-
Visibility: string
Title:
Hide from Public
Maximum Length:1
Default Value:Y
Indicates if the comment is visible to the anonymous user.
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.