Create an inspection comment
post
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionComments
Request
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
AgencyId: integer
(int32)
Title:
Agency ID
Default Value:1
The unique identifier for the public sector agency associated with the inspection comment. -
ChecklistId: string
Title:
Checklist
Maximum Length:15
The identifier of an inspection checklist associated with the comment. -
ChecklistItemId: string
Title:
Checklist Item
Maximum Length:15
The identifier of an inspection checklist item associated with the comment. -
CommentId: integer
(int64)
The unique identifier of a comment in the PSC_COM_COMMENT table.
-
CommentText: string
(byte)
Title:
Comments
The comments in HTML or plain text. -
InsCommentPuid: string
Maximum Length:
480
The public unique identifier for an inspection comment. -
InspectionAgencyId: integer
Title:
Agency ID
Default Value:1
The unique identifier for the public sector agency associated with the inspection comment. -
InspectionChklistPuid: string
Maximum Length:
480
The public unique identifier for an inspection checklist comment. -
InspectionClItemPuid: string
Maximum Length:
480
The public unique identifier for an inspection checklist item comment. -
InspectionCommentId: integer
(int64)
Title:
Comment
The unique identifier of a comment in the PSC_COM_COMMENT table. -
InspectionCommentKey: integer
Title:
Comment
The unique identifier of an inspection comment in the PSC_INS_COMMENT table. -
InspectionCommentType: string
Title:
Comment Type
Maximum Length:15
The comment type, such as CL for Checklist, INSP for Inspection, and CLITEM for Checklist item comments. -
InspectionId: string
Title:
Inspection
Maximum Length:50
The identifier of an inspection associated with the comment. -
InspectionPuid: string
Maximum Length:
480
The public unique identifier for an inspection. -
OriginalCreatedBy: string
The name of the user who created the comment.
-
Visibility: string
Title:
Hide from Public
Maximum Length:1
Default Value:Y
The flag for indicating that the comment will not be visible to public users. The value is Y or N.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
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.
Root Schema : publicSectorInspectionComments-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Title:
Agency ID
Default Value:1
The unique identifier for the public sector agency associated with the inspection comment. -
ChecklistId: string
Title:
Checklist
Maximum Length:15
The identifier of an inspection checklist associated with the comment. -
ChecklistItemId: string
Title:
Checklist Item
Maximum Length:15
The identifier of an inspection checklist item associated with the comment. -
CommentId: integer
(int64)
The unique identifier of a comment in the PSC_COM_COMMENT table.
-
CommentPreview: string
Title:
Comment Preview
Read Only:true
The flag for the comments summary section to enable preview of comments. The value is Y or N. -
CommentText: string
(byte)
Title:
Comments
The comments in HTML or plain text. -
CreatedByName: string
Title:
Created By
Read Only:true
The name of the user who created the comments. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the comments were created. -
InsCommentPuid: string
Maximum Length:
480
The public unique identifier for an inspection comment. -
InspectionAgencyId: integer
Title:
Agency ID
Default Value:1
The unique identifier for the public sector agency associated with the inspection comment. -
InspectionChklistPuid: string
Maximum Length:
480
The public unique identifier for an inspection checklist comment. -
InspectionClItemPuid: string
Maximum Length:
480
The public unique identifier for an inspection checklist item comment. -
InspectionCommentId: integer
(int64)
Title:
Comment
The unique identifier of a comment in the PSC_COM_COMMENT table. -
InspectionCommentKey: integer
Title:
Comment
The unique identifier of an inspection comment in the PSC_INS_COMMENT table. -
InspectionCommentType: string
Title:
Comment Type
Maximum Length:15
The comment type, such as CL for Checklist, INSP for Inspection, and CLITEM for Checklist item comments. -
InspectionId: string
Title:
Inspection
Maximum Length:50
The identifier of an inspection associated with the comment. -
InspectionPuid: string
Maximum Length:
480
The public unique identifier for an inspection. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the comments were last updated. -
LastUpdatedByName: string
Title:
Last Updated By
Read Only:true
The name of the user who last updated the comments. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OriginalCreatedBy: string
The name of the user who created the comment.
-
Visibility: string
Title:
Hide from Public
Maximum Length:1
Default Value:Y
The flag for indicating that the comment will not be visible to public users. The value is Y or 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.