Jump to

• Request
• Response

Update an inspection comment

patch

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

Request

Path Parameters

• publicSectorInspectionCommentsUniqID(required): string
  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>

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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "InsCommentPuid":{
            "maxLength":480,
            "type":"string",
            "description":"The public unique identifier for an inspection comment.",
            "nullable":false
        },
        "InspectionCommentType":{
            "title":"Comment Type",
            "maxLength":15,
            "type":"string",
            "description":"The comment type, such as CL for Checklist, INSP for Inspection, and CLITEM for Checklist item comments.",
            "nullable":false
        },
        "InspectionClItemPuid":{
            "maxLength":480,
            "type":"string",
            "description":"The public unique identifier for an inspection checklist item comment.",
            "nullable":true
        },
        "CommentText":{
            "title":"Comments",
            "type":"string",
            "description":"The comments in HTML or plain text.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "InspectionId":{
            "title":"Inspection",
            "maxLength":50,
            "type":"string",
            "description":"The identifier of an inspection associated with the comment.",
            "nullable":true
        },
        "InspectionPuid":{
            "maxLength":480,
            "type":"string",
            "description":"The public unique identifier for an inspection.",
            "nullable":true
        },
        "ChecklistId":{
            "title":"Checklist",
            "maxLength":15,
            "type":"string",
            "description":"The identifier of an inspection checklist associated with the comment.",
            "nullable":true
        },
        "InspectionChklistPuid":{
            "maxLength":480,
            "type":"string",
            "description":"The public unique identifier for an inspection checklist comment.",
            "nullable":true
        },
        "ChecklistItemId":{
            "title":"Checklist Item",
            "maxLength":15,
            "type":"string",
            "description":"The identifier of an inspection checklist item associated with the comment.",
            "nullable":true
        },
        "Visibility":{
            "title":"Hide from Public",
            "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.",
            "nullable":false,
            "default":"Y"
        },
        "InspectionAgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The unique identifier for the public sector agency associated with the inspection comment.",
            "nullable":false,
            "default":1
        }
    }
}

Back to Top

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.

Body ()

Root Schema : publicSectorInspectionComments-item-response

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "CreatedByName":{
            "title":"Created By",
            "type":"string",
            "description":"The name of the user who created the comments.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the comments were created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "InspectionCommentId":{
            "title":"Comment",
            "type":"integer",
            "description":"The unique identifier of a comment in the PSC_COM_COMMENT table.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CommentPreview":{
            "title":"Comment Preview",
            "type":"string",
            "description":"The flag for the comments summary section to enable preview of comments. The value is Y or N.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "OriginalCreatedBy":{
            "type":"string",
            "description":"The name of the user who created the comment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "InspectionCommentType":{
            "title":"Comment Type",
            "maxLength":15,
            "type":"string",
            "description":"The comment type, such as CL for Checklist, INSP for Inspection, and CLITEM for Checklist item comments.",
            "nullable":false,
            "x-queryable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The unique identifier for the public sector agency associated with the inspection comment.",
            "format":"int32",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":8
            },
            "x-queryable":true
        },
        "CommentText":{
            "title":"Comments",
            "type":"string",
            "description":"The comments in HTML or plain text.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "InspectionId":{
            "title":"Inspection",
            "maxLength":50,
            "type":"string",
            "description":"The identifier of an inspection associated with the comment.",
            "nullable":true,
            "x-queryable":true
        },
        "ChecklistId":{
            "title":"Checklist",
            "maxLength":15,
            "type":"string",
            "description":"The identifier of an inspection checklist associated with the comment.",
            "nullable":true,
            "x-queryable":true
        },
        "InspectionChklistPuid":{
            "maxLength":480,
            "type":"string",
            "description":"The public unique identifier for an inspection checklist comment.",
            "nullable":true,
            "x-queryable":true
        },
        "InspectionAgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The unique identifier for the public sector agency associated with the inspection comment.",
            "nullable":false,
            "default":1,
            "x-queryable":true
        },
        "CommentId":{
            "type":"integer",
            "description":"The unique identifier of a comment in the PSC_COM_COMMENT table.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "InsCommentPuid":{
            "maxLength":480,
            "type":"string",
            "description":"The public unique identifier for an inspection comment.",
            "nullable":false,
            "x-queryable":true
        },
        "InspectionClItemPuid":{
            "maxLength":480,
            "type":"string",
            "description":"The public unique identifier for an inspection checklist item comment.",
            "nullable":true,
            "x-queryable":true
        },
        "InspectionPuid":{
            "maxLength":480,
            "type":"string",
            "description":"The public unique identifier for an inspection.",
            "nullable":true,
            "x-queryable":true
        },
        "ChecklistItemId":{
            "title":"Checklist Item",
            "maxLength":15,
            "type":"string",
            "description":"The identifier of an inspection checklist item associated with the comment.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "InspectionCommentKey":{
            "title":"Comment",
            "type":"integer",
            "description":"The unique identifier of an inspection comment in the PSC_INS_COMMENT table.",
            "nullable":true,
            "x-hints":{
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "Visibility":{
            "title":"Hide from Public",
            "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.",
            "nullable":false,
            "default":"Y",
            "x-queryable":true
        },
        "LastUpdatedByName":{
            "title":"Last Updated By",
            "type":"string",
            "description":"The name of the user who last updated the comments.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the comments were last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top