Jump to

• Request
• Response

Update an inspection comment

patch

/fscmRestApi/resources/11.13.18.05/publicSectorInspectionComments/{publicSectorInspectionCommentsUniqID}

Request

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Path Parameters

• publicSectorInspectionCommentsUniqID: integer
  This is the hash key of the attributes which make up the composite key--- InspectionAgencyId and InspectionCommentKey ---for the Inspection Comments resource and used to uniquely identify an instance of Inspection Comments. The client should not generate the hash key value. Instead, the client should query on the Inspection Comments collection resource with a filter on the primary key values in order to navigate to a specific instance of Inspection Comments.
  
  For example: publicSectorInspectionComments?q=InspectionAgencyId=<value1>;InspectionCommentKey=<value2>

Body ()

The following table describes the body parameters in the request for this task.

Root Schema : publicSectorInspectionComments-item

Type: object

Show Source

• 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.
• CreatedByName(optional): string
  Title: Created By

  The name of 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.
• LastUpdatedByName(optional): string
  Title: Last Updated By

  The name of 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.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The unique identifier for the public sector agency associated with the inspection comment.",
            "title":"Agency ID"
        },
        "ChecklistId":{
            "maxLength":15,
            "type":"string",
            "description":"The identifier of an inspection checklist associated with the comment.",
            "title":"Checklist"
        },
        "ChecklistItemId":{
            "maxLength":15,
            "type":"string",
            "description":"The identifier of an inspection checklist item associated with the comment.",
            "title":"Checklist Item"
        },
        "CommentId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of a comment in the PSC_COM_COMMENT table."
        },
        "CommentPreview":{
            "type":"string",
            "description":"The flag for the comments summary section to enable preview of comments. The value is Y or N.",
            "title":"Comment Preview"
        },
        "CommentText":{
            "type":"string",
            "description":"The comments in HTML or plain text.",
            "title":"Comments"
        },
        "CreatedByName":{
            "type":"string",
            "description":"The name of the user who created the comments.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the comments were created.",
            "title":"Creation Date"
        },
        "InspectionAgencyId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for the public sector agency associated with the inspection comment.",
            "title":"Agency ID"
        },
        "InspectionCommentId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of a comment in the PSC_COM_COMMENT table.",
            "title":"Comment"
        },
        "InspectionCommentKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of an inspection comment in the PSC_INS_COMMENT table.",
            "title":"Comment"
        },
        "InspectionCommentType":{
            "maxLength":15,
            "type":"string",
            "description":"The comment type, such as CL for Checklist, INSP for Inspection, and CLITEM for Checklist item comments.",
            "title":"Comment Type"
        },
        "InspectionId":{
            "maxLength":50,
            "type":"string",
            "description":"The identifier of an inspection associated with the comment.",
            "title":"Inspection"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the comments were last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedByName":{
            "type":"string",
            "description":"The name of the user who last updated the comments.",
            "title":"Last Updated By"
        },
        "Visibility":{
            "maxLength":1,
            "type":"string",
            "description":"The flag for indicating that the comment will not be visible to public users. The value is Y or N.",
            "title":"Hide from Public"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top

Response

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : publicSectorInspectionComments-item

Type: object

Show Source

• 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.
• CreatedByName(optional): string
  Title: Created By

  The name of 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.
• LastUpdatedByName(optional): string
  Title: Last Updated By

  The name of 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.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The unique identifier for the public sector agency associated with the inspection comment.",
            "title":"Agency ID"
        },
        "ChecklistId":{
            "maxLength":15,
            "type":"string",
            "description":"The identifier of an inspection checklist associated with the comment.",
            "title":"Checklist"
        },
        "ChecklistItemId":{
            "maxLength":15,
            "type":"string",
            "description":"The identifier of an inspection checklist item associated with the comment.",
            "title":"Checklist Item"
        },
        "CommentId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of a comment in the PSC_COM_COMMENT table."
        },
        "CommentPreview":{
            "type":"string",
            "description":"The flag for the comments summary section to enable preview of comments. The value is Y or N.",
            "title":"Comment Preview"
        },
        "CommentText":{
            "type":"string",
            "description":"The comments in HTML or plain text.",
            "title":"Comments"
        },
        "CreatedByName":{
            "type":"string",
            "description":"The name of the user who created the comments.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the comments were created.",
            "title":"Creation Date"
        },
        "InspectionAgencyId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for the public sector agency associated with the inspection comment.",
            "title":"Agency ID"
        },
        "InspectionCommentId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of a comment in the PSC_COM_COMMENT table.",
            "title":"Comment"
        },
        "InspectionCommentKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of an inspection comment in the PSC_INS_COMMENT table.",
            "title":"Comment"
        },
        "InspectionCommentType":{
            "maxLength":15,
            "type":"string",
            "description":"The comment type, such as CL for Checklist, INSP for Inspection, and CLITEM for Checklist item comments.",
            "title":"Comment Type"
        },
        "InspectionId":{
            "maxLength":50,
            "type":"string",
            "description":"The identifier of an inspection associated with the comment.",
            "title":"Inspection"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the comments were last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedByName":{
            "type":"string",
            "description":"The name of the user who last updated the comments.",
            "title":"Last Updated By"
        },
        "Visibility":{
            "maxLength":1,
            "type":"string",
            "description":"The flag for indicating that the comment will not be visible to public users. The value is Y or N.",
            "title":"Hide from Public"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top