Create an inspection comment
post
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionComments
Request
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
The following table describes the body parameters in the request for this task.
Root Schema : publicSectorInspectionComments-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int32)
Title:
Agency ID
The unique identifier for the public sector agency associated with the inspection comment. -
ChecklistId(optional):
string
Title:
Checklist
Maximum Length:15
The identifier of an inspection checklist associated with the comment. -
ChecklistItemId(optional):
string
Title:
Checklist Item
Maximum Length:15
The identifier of an inspection checklist item associated with the comment. -
CommentId(optional):
integer(int64)
The unique identifier of a comment in the PSC_COM_COMMENT table.
-
CommentPreview(optional):
string
Title:
Comment Preview
The flag for the comments summary section to enable preview of comments. The value is Y or N. -
CommentText(optional):
string
Title:
Comments
The comments in HTML or plain text. -
CreatedBy(optional):
string
Title:
Created By
Maximum Length:64
The user who created the comments. -
CreationDate(optional):
string(date-time)
Title:
Creation Date
The date when the comments were created. -
InspectionAgencyId(optional):
integer(int64)
Title:
Agency ID
The unique identifier for the public sector agency associated with the inspection comment. -
InspectionCommentId(optional):
integer(int64)
Title:
Comment
The unique identifier of a comment in the PSC_COM_COMMENT table. -
InspectionCommentKey(optional):
integer(int64)
Title:
Comment
The unique identifier of an inspection comment in the PSC_INS_COMMENT table. -
InspectionCommentType(optional):
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(optional):
string
Title:
Inspection
Maximum Length:50
The identifier of an inspection associated with the comment. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated Date
The date when the comments were last updated. -
LastUpdatedBy(optional):
string
Title:
Last Updated By
Maximum Length:64
The user who last updated the comments. -
links(optional):
array Items
Title:
Items
Link Relations -
Visibility(optional):
string
Title:
Hide from Public
Maximum Length:1
The flag for indicating that the comment will not be visible to public users. The value is Y or N.
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 : publicSectorInspectionComments-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int32)
Title:
Agency ID
The unique identifier for the public sector agency associated with the inspection comment. -
ChecklistId(optional):
string
Title:
Checklist
Maximum Length:15
The identifier of an inspection checklist associated with the comment. -
ChecklistItemId(optional):
string
Title:
Checklist Item
Maximum Length:15
The identifier of an inspection checklist item associated with the comment. -
CommentId(optional):
integer(int64)
The unique identifier of a comment in the PSC_COM_COMMENT table.
-
CommentPreview(optional):
string
Title:
Comment Preview
The flag for the comments summary section to enable preview of comments. The value is Y or N. -
CommentText(optional):
string
Title:
Comments
The comments in HTML or plain text. -
CreatedBy(optional):
string
Title:
Created By
Maximum Length:64
The user who created the comments. -
CreationDate(optional):
string(date-time)
Title:
Creation Date
The date when the comments were created. -
InspectionAgencyId(optional):
integer(int64)
Title:
Agency ID
The unique identifier for the public sector agency associated with the inspection comment. -
InspectionCommentId(optional):
integer(int64)
Title:
Comment
The unique identifier of a comment in the PSC_COM_COMMENT table. -
InspectionCommentKey(optional):
integer(int64)
Title:
Comment
The unique identifier of an inspection comment in the PSC_INS_COMMENT table. -
InspectionCommentType(optional):
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(optional):
string
Title:
Inspection
Maximum Length:50
The identifier of an inspection associated with the comment. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated Date
The date when the comments were last updated. -
LastUpdatedBy(optional):
string
Title:
Last Updated By
Maximum Length:64
The user who last updated the comments. -
links(optional):
array Items
Title:
Items
Link Relations -
Visibility(optional):
string
Title:
Hide from Public
Maximum Length:1
The flag for indicating that the comment will not be visible to public users. The value is Y or N.
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.