Jump to

• Request
• Response

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

post

/fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewerComments

Request

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.
• Upsert-Mode:
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AgencyId: integer (int32)
  Title: Agency ID

  Default Value: 1

  The agency identifier of the public sector entity to which this plan reviewer comment applies.
• CommentId: integer (int64)
  The comment identifier in the comment record.
• CommentText: string (byte)
  Title: Comments

  The text of the plan reviewer comment.
• DocumentFileKey: integer (int64)
  The unique identifier for an electronic plan review file.
• DocumentUserKey: integer (int64)
  The unique identifier for an electronic plan review file reviewer.
• OriginalCreatedBy: string
  The name of the user who created the plan reviewer comment.
• PlanReviewAgencyId: integer (int32)
  Default Value: 1

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

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

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

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

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

  Maximum Length: 1

  Default Value: Y

  The plan reviewer comment is visible to public users.

{
    "type":"object",
    "properties":{
        "OriginalCreatedBy":{
            "type":"string",
            "description":"The name of the user who created the plan reviewer comment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The agency identifier of the public sector entity to which this plan reviewer comment applies.",
            "format":"int32",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "precision":"8"
            }
        },
        "PrCommentKey":{
            "type":"integer",
            "description":"The unique identifier for a plan reviewer comment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "PlanReviewAgencyId":{
            "type":"integer",
            "description":"The agency identifier of the public sector entity to which this plan reviewer comment applies.",
            "format":"int32",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "precision":"8"
            }
        },
        "CommentText":{
            "title":"Comments",
            "type":"string",
            "description":"The text of the plan reviewer comment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "PrCommentPuid":{
            "maxLength":"480",
            "type":"string",
            "description":"The public unique identifier for a plan review or plan reviewer comment.",
            "nullable":false
        },
        "PlanReviewCommentType":{
            "maxLength":"5",
            "type":"string",
            "description":"The comment type for the plan reviewer comment. For example, REVWR and CYCLE.",
            "nullable":false
        },
        "PlanReviewCommentId":{
            "type":"integer",
            "description":"The comment ID of the plan reviewer comment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "CommentId":{
            "type":"integer",
            "description":"The comment identifier in the comment record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "PlanReviewKey":{
            "type":"integer",
            "description":"The unique identifier for a plan review cycle.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "DocumentFileKey":{
            "type":"integer",
            "description":"The unique identifier for an electronic plan review file.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "DocumentUserKey":{
            "type":"integer",
            "description":"The unique identifier for an electronic plan review file reviewer.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "PlanReviewPuid":{
            "maxLength":"480",
            "type":"string",
            "description":"The public unique identifier for a plan review.",
            "nullable":false
        },
        "PlanReviewUserPuid":{
            "maxLength":"480",
            "type":"string",
            "description":"The public unique identifier for a plan reviewer.",
            "nullable":true
        },
        "PlanReviewUserKey":{
            "type":"integer",
            "description":"The unique identifier for a plan reviewer.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "Visibility":{
            "title":"Hide from Public",
            "maxLength":"1",
            "type":"string",
            "description":"The plan reviewer comment is visible to public users.",
            "nullable":false,
            "default":"Y"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

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

Body ()

Root Schema : publicSectorPlanReviewerComments-item-response

Type: object

Show Source

• AgencyId: integer (int32)
  Title: Agency ID

  Default Value: 1

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

  Read Only: true

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

  The text of the plan reviewer comment.
• CreatedByName: string
  Title: Created By

  Read Only: true

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

  Read Only: true

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

  Read Only: true

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

  Read Only: true

  The name of the user who last updated the plan reviewer comment.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OriginalCreatedBy: string
  The name of the user who created the plan reviewer comment.
• PlanReviewAgencyId: integer (int32)
  Default Value: 1

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

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

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

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

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

  Maximum Length: 1

  Default Value: Y

  The plan reviewer comment is visible to public users.

{
    "type":"object",
    "properties":{
        "CreatedByName":{
            "title":"Created By",
            "type":"string",
            "description":"The name of the user who created the plan reviewer comment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the plan reviewer comment was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CommentPreview":{
            "title":"Comment Preview",
            "type":"string",
            "description":"The preview text of the plan reviewer comment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "OriginalCreatedBy":{
            "type":"string",
            "description":"The name of the user who created the plan reviewer comment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The agency identifier of the public sector entity to which this plan reviewer comment applies.",
            "format":"int32",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "PrCommentKey":{
            "type":"integer",
            "description":"The unique identifier for a plan reviewer comment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "PlanReviewAgencyId":{
            "type":"integer",
            "description":"The agency identifier of the public sector entity to which this plan reviewer comment applies.",
            "format":"int32",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "CommentText":{
            "title":"Comments",
            "type":"string",
            "description":"The text of the plan reviewer comment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "PrCommentPuid":{
            "maxLength":"480",
            "type":"string",
            "description":"The public unique identifier for a plan review or plan reviewer comment.",
            "nullable":false,
            "x-queryable":true
        },
        "PlanReviewCommentType":{
            "maxLength":"5",
            "type":"string",
            "description":"The comment type for the plan reviewer comment. For example, REVWR and CYCLE.",
            "nullable":false,
            "x-queryable":true
        },
        "PlanReviewCommentId":{
            "type":"integer",
            "description":"The comment ID of the plan reviewer comment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CommentId":{
            "type":"integer",
            "description":"The comment identifier in the comment record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "PlanReviewKey":{
            "type":"integer",
            "description":"The unique identifier for a plan review cycle.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "DocumentFileKey":{
            "type":"integer",
            "description":"The unique identifier for an electronic plan review file.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "DocumentUserKey":{
            "type":"integer",
            "description":"The unique identifier for an electronic plan review file reviewer.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PlanReviewPuid":{
            "maxLength":"480",
            "type":"string",
            "description":"The public unique identifier for a plan review.",
            "nullable":false,
            "x-queryable":true
        },
        "PlanReviewUserPuid":{
            "maxLength":"480",
            "type":"string",
            "description":"The public unique identifier for a plan reviewer.",
            "nullable":true,
            "x-queryable":true
        },
        "PlanReviewUserKey":{
            "type":"integer",
            "description":"The unique identifier for a plan reviewer.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Visibility":{
            "title":"Hide from Public",
            "maxLength":"1",
            "type":"string",
            "description":"The plan reviewer comment is visible to public users.",
            "nullable":false,
            "default":"Y",
            "x-queryable":true
        },
        "LastUpdatedByName":{
            "title":"Last Updated By",
            "type":"string",
            "description":"The name of the user who last updated the plan reviewer comment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the plan reviewer comment was 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