Update a contractor license comment
patch
/fscmRestApi/resources/11.13.18.05/publicSectorContractorComments/{LicenseCommentKey}
Request
Path Parameters
-
LicenseCommentKey(required): integer(int64)
The unique identifier of the contractor license 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
-
CommentText: string
(byte)
Title:
Comments
The text of the comment in HTML format. -
LicenseKey: integer
(int64)
The unique identifier of the license.
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 : publicSectorContractorComments-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Title:
Agency ID
Default Value:1
The unique identifier for the agency. -
CommentId: integer
(int64)
The unique identifier of the comment from the common comment table.
-
CommentPreview: string
Title:
Comment Preview
Read Only:true
The text of the comment in plain text format. This is used to preview the comment. -
CommentText: string
(byte)
Title:
Comments
The text of the comment in HTML format. -
CreatedByName: string
Title:
Created By
Read Only:true
The user who created the comment. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the comment was created. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the comment was last updated. -
LastUpdatedByName: string
Title:
Last Updated By
Read Only:true
The user who last updated the comment. -
LicenseCommentKey: integer
(int64)
The unique identifier of the contractor license comment.
-
LicenseKey: integer
(int64)
The unique identifier of the license.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OriginalCreatedBy: string
The user who created the comment. This is used for data migration.
-
Visibility: string
Read Only:
true
Maximum Length:1
Default Value:N
Indicates whether the comment is visible. The value must be N.
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.