Jump to

• Request
• Response

Update a plan reviewer's comments for a permit plan review

patch

/fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewerComments/{publicSectorPlanReviewerCommentsUniqID}

Request

Supported Media Types

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

Path Parameters

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

Body ()

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

Root Schema : publicSectorPlanReviewerComments-item

Type: object

Show Source

• AgencyId(optional): integer(int32)
  Title: Agency ID

  The agency identifier of the public sector entity to which this plan reviewer comment applies.
• CommentId(optional): integer(int64)
  The comment identifier in the comment record.
• CommentPreview(optional): string
  Title: Comment Preview

  The preview text of the plan reviewer comment.
• CommentText(optional): string
  Title: Comments

  The text of the plan reviewer comment.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

  The user who created the plan reviewer comment.
• CreationDate(optional): string(date-time)
  Title: Creation Date

  The date and time when the plan reviewer comment was created.
• DocumentFileKey(optional): integer(int64)
  The unique identifier for an electronic plan review file.
• DocumentUserKey(optional): integer(int64)
  The unique identifier for an electronic plan review file reviewer.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

  The date and time when the plan reviewer comment was last updated.
• LastUpdatedBy(optional): string
  Title: Last Updated By

  Maximum Length: 64

  The user who last updated the plan reviewer comment.
• links(optional): array Items
  Title: Items

  Link Relations
• PlanReviewAgencyId(optional): integer(int32)
  The agency identifier of the public sector entity to which this plan reviewer comment applies.
• PlanReviewCommentId(optional): integer(int64)
  The comment ID of the plan reviewer comment.
• PlanReviewCommentType(optional): string
  Maximum Length: 5

  The comment type for the plan reviewer comment. For example, REVWR and CYCLE.
• PlanReviewKey(optional): integer(int64)
  The unique identifier for a plan review cycle.
• PlanReviewUserKey(optional): integer(int64)
  The unique identifier for a plan reviewer.
• PrCommentKey(optional): integer(int64)
  The unique identifier for a plan reviewer comment.
• Visibility(optional): string
  Title: Hide from Public

  Maximum Length: 1

  The plan reviewer comment is visible to public users.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The agency identifier of the public sector entity to which this plan reviewer comment applies.",
            "title":"Agency ID"
        },
        "CommentId":{
            "format":"int64",
            "type":"integer",
            "description":"The comment identifier in the comment record."
        },
        "CommentPreview":{
            "type":"string",
            "description":"The preview text of the plan reviewer comment.",
            "title":"Comment Preview"
        },
        "CommentText":{
            "type":"string",
            "description":"The text of the plan reviewer comment.",
            "title":"Comments"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the plan reviewer comment.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the plan reviewer comment was created.",
            "title":"Creation Date"
        },
        "DocumentFileKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for an electronic plan review file."
        },
        "DocumentUserKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for an electronic plan review file reviewer."
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the plan reviewer comment was last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the plan reviewer comment.",
            "title":"Last Updated By"
        },
        "PlanReviewAgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The agency identifier of the public sector entity to which this plan reviewer comment applies."
        },
        "PlanReviewCommentId":{
            "format":"int64",
            "type":"integer",
            "description":"The comment ID of the plan reviewer comment."
        },
        "PlanReviewCommentType":{
            "maxLength":5,
            "type":"string",
            "description":"The comment type for the plan reviewer comment. For example, REVWR and CYCLE."
        },
        "PlanReviewKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for a plan review cycle."
        },
        "PlanReviewUserKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for a plan reviewer."
        },
        "PrCommentKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for a plan reviewer comment."
        },
        "Visibility":{
            "maxLength":1,
            "type":"string",
            "description":"The plan reviewer comment is visible to public users.",
            "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 : publicSectorPlanReviewerComments-item

Type: object

Show Source

• AgencyId(optional): integer(int32)
  Title: Agency ID

  The agency identifier of the public sector entity to which this plan reviewer comment applies.
• CommentId(optional): integer(int64)
  The comment identifier in the comment record.
• CommentPreview(optional): string
  Title: Comment Preview

  The preview text of the plan reviewer comment.
• CommentText(optional): string
  Title: Comments

  The text of the plan reviewer comment.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

  The user who created the plan reviewer comment.
• CreationDate(optional): string(date-time)
  Title: Creation Date

  The date and time when the plan reviewer comment was created.
• DocumentFileKey(optional): integer(int64)
  The unique identifier for an electronic plan review file.
• DocumentUserKey(optional): integer(int64)
  The unique identifier for an electronic plan review file reviewer.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

  The date and time when the plan reviewer comment was last updated.
• LastUpdatedBy(optional): string
  Title: Last Updated By

  Maximum Length: 64

  The user who last updated the plan reviewer comment.
• links(optional): array Items
  Title: Items

  Link Relations
• PlanReviewAgencyId(optional): integer(int32)
  The agency identifier of the public sector entity to which this plan reviewer comment applies.
• PlanReviewCommentId(optional): integer(int64)
  The comment ID of the plan reviewer comment.
• PlanReviewCommentType(optional): string
  Maximum Length: 5

  The comment type for the plan reviewer comment. For example, REVWR and CYCLE.
• PlanReviewKey(optional): integer(int64)
  The unique identifier for a plan review cycle.
• PlanReviewUserKey(optional): integer(int64)
  The unique identifier for a plan reviewer.
• PrCommentKey(optional): integer(int64)
  The unique identifier for a plan reviewer comment.
• Visibility(optional): string
  Title: Hide from Public

  Maximum Length: 1

  The plan reviewer comment is visible to public users.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The agency identifier of the public sector entity to which this plan reviewer comment applies.",
            "title":"Agency ID"
        },
        "CommentId":{
            "format":"int64",
            "type":"integer",
            "description":"The comment identifier in the comment record."
        },
        "CommentPreview":{
            "type":"string",
            "description":"The preview text of the plan reviewer comment.",
            "title":"Comment Preview"
        },
        "CommentText":{
            "type":"string",
            "description":"The text of the plan reviewer comment.",
            "title":"Comments"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the plan reviewer comment.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the plan reviewer comment was created.",
            "title":"Creation Date"
        },
        "DocumentFileKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for an electronic plan review file."
        },
        "DocumentUserKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for an electronic plan review file reviewer."
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the plan reviewer comment was last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the plan reviewer comment.",
            "title":"Last Updated By"
        },
        "PlanReviewAgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The agency identifier of the public sector entity to which this plan reviewer comment applies."
        },
        "PlanReviewCommentId":{
            "format":"int64",
            "type":"integer",
            "description":"The comment ID of the plan reviewer comment."
        },
        "PlanReviewCommentType":{
            "maxLength":5,
            "type":"string",
            "description":"The comment type for the plan reviewer comment. For example, REVWR and CYCLE."
        },
        "PlanReviewKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for a plan review cycle."
        },
        "PlanReviewUserKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for a plan reviewer."
        },
        "PrCommentKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for a plan reviewer comment."
        },
        "Visibility":{
            "maxLength":1,
            "type":"string",
            "description":"The plan reviewer comment is visible to public users.",
            "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