Jump to

• Request
• Response

Create a permit plan review comment

post

/fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewComments

Request

Supported Media Types

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

Body ()

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

Root Schema : publicSectorPlanReviewComments-item

Type: object

Show Source

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

  The agency identifier of the public sector entity to which this plan review 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 review comment.
• CommentText(optional): string
  Title: Comments

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

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

  The date and time when the plan review 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 review comment was last updated.
• LastUpdatedByName(optional): string
  Title: Last Updated By

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

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

  The comment type for the plan review comment. For example, REVWR and CYCLE.
• PlanReviewKey(optional): integer(int64)
  The unique identifier for a plan review cycle.
• PlanReviewPuid(optional): string
  Maximum Length: 480

  The public unique identifier for a plan review.
• PlanReviewUserKey(optional): integer(int64)
  The unique identifier for a plan reviewer.
• PlanReviewUserPuid(optional): string
  Maximum Length: 480

  The public unique identifier for a plan reviewer.
• PrCommentKey(optional): integer(int64)
  The unique identifier for a plan review comment.
• PrCommentPuid(optional): string
  Maximum Length: 480

  The public unique identifier for a plan review or plan reviewer comment.
• Visibility(optional): string
  Title: Hide from Public

  Maximum Length: 1

  Indicates whether plan review comment is visible to public users. The default value is N.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The agency identifier of the public sector entity to which this plan review 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 review comment.",
            "title":"Comment Preview"
        },
        "CommentText":{
            "type":"string",
            "description":"The text of the plan review comment.",
            "title":"Comments"
        },
        "CreatedByName":{
            "type":"string",
            "description":"The name of the user who created the plan review comment.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the plan review 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 review comment was last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedByName":{
            "type":"string",
            "description":"The name of the user who last updated the plan review comment.",
            "title":"Last Updated By"
        },
        "OriginalCreatedBy":{
            "type":"string",
            "description":"The name of the user who created the plan review comment."
        },
        "PlanReviewAgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The agency identifier of the public sector entity to which this plan review comment applies."
        },
        "PlanReviewCommentId":{
            "format":"int64",
            "type":"integer",
            "description":"The comment ID of the plan review comment."
        },
        "PlanReviewCommentType":{
            "maxLength":5,
            "type":"string",
            "description":"The comment type for the plan review comment. For example, REVWR and CYCLE."
        },
        "PlanReviewKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for a plan review cycle."
        },
        "PlanReviewPuid":{
            "maxLength":480,
            "type":"string",
            "description":"The public unique identifier for a plan review."
        },
        "PlanReviewUserKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for a plan reviewer."
        },
        "PlanReviewUserPuid":{
            "maxLength":480,
            "type":"string",
            "description":"The public unique identifier for a plan reviewer."
        },
        "PrCommentKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for a plan review comment."
        },
        "PrCommentPuid":{
            "maxLength":480,
            "type":"string",
            "description":"The public unique identifier for a plan review or plan reviewer comment."
        },
        "Visibility":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether plan review comment is visible to public users. The default value is 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 : publicSectorPlanReviewComments-item

Type: object

Show Source

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

  The agency identifier of the public sector entity to which this plan review 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 review comment.
• CommentText(optional): string
  Title: Comments

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

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

  The date and time when the plan review 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 review comment was last updated.
• LastUpdatedByName(optional): string
  Title: Last Updated By

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

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

  The comment type for the plan review comment. For example, REVWR and CYCLE.
• PlanReviewKey(optional): integer(int64)
  The unique identifier for a plan review cycle.
• PlanReviewPuid(optional): string
  Maximum Length: 480

  The public unique identifier for a plan review.
• PlanReviewUserKey(optional): integer(int64)
  The unique identifier for a plan reviewer.
• PlanReviewUserPuid(optional): string
  Maximum Length: 480

  The public unique identifier for a plan reviewer.
• PrCommentKey(optional): integer(int64)
  The unique identifier for a plan review comment.
• PrCommentPuid(optional): string
  Maximum Length: 480

  The public unique identifier for a plan review or plan reviewer comment.
• Visibility(optional): string
  Title: Hide from Public

  Maximum Length: 1

  Indicates whether plan review comment is visible to public users. The default value is N.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The agency identifier of the public sector entity to which this plan review 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 review comment.",
            "title":"Comment Preview"
        },
        "CommentText":{
            "type":"string",
            "description":"The text of the plan review comment.",
            "title":"Comments"
        },
        "CreatedByName":{
            "type":"string",
            "description":"The name of the user who created the plan review comment.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the plan review 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 review comment was last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedByName":{
            "type":"string",
            "description":"The name of the user who last updated the plan review comment.",
            "title":"Last Updated By"
        },
        "OriginalCreatedBy":{
            "type":"string",
            "description":"The name of the user who created the plan review comment."
        },
        "PlanReviewAgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The agency identifier of the public sector entity to which this plan review comment applies."
        },
        "PlanReviewCommentId":{
            "format":"int64",
            "type":"integer",
            "description":"The comment ID of the plan review comment."
        },
        "PlanReviewCommentType":{
            "maxLength":5,
            "type":"string",
            "description":"The comment type for the plan review comment. For example, REVWR and CYCLE."
        },
        "PlanReviewKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for a plan review cycle."
        },
        "PlanReviewPuid":{
            "maxLength":480,
            "type":"string",
            "description":"The public unique identifier for a plan review."
        },
        "PlanReviewUserKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for a plan reviewer."
        },
        "PlanReviewUserPuid":{
            "maxLength":480,
            "type":"string",
            "description":"The public unique identifier for a plan reviewer."
        },
        "PrCommentKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for a plan review comment."
        },
        "PrCommentPuid":{
            "maxLength":480,
            "type":"string",
            "description":"The public unique identifier for a plan review or plan reviewer comment."
        },
        "Visibility":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether plan review comment is visible to public users. The default value is 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