Create a plan review cycle
post
/fscmRestApi/resources/11.13.18.05/publicSectorPlanReviews
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
Root Schema : schema
Type:
Show Source
object
-
AgencyId: integer
Default Value:
1
The agency identifier of the public sector entity to which this plan review cycle applies. -
BluebeamSessions: array
Markup Sessions
Title:
Markup Sessions
The markup sessions resource is used to view, update, create, and delete a markup session. -
CopyDocuments: string
The indicator that determines whether to copy the plan review documents from the previous cycle when creating a new plan review cycle.
-
CopyReviewer: string
Default Value:
N
The indicator used when creating a new plan review cycle. Used to determine whether to copy the plan reviewers from the previous cycle. -
CycleCount: integer
(int32)
Title:
Cycle
The numbering for each plan review cycle. -
CycleDays: integer
(int32)
Title:
Cycle Days
The number of days that the plan review cycle was open or in progress. -
Decision: string
Title:
Decision
Maximum Length:15
The decision status for the plan review cycle. -
ElectronicPlanReview: string
Title:
Electronic Review
Maximum Length:1
Indicates whether the plan review has been performed for a document attachment. The default value is N for no. -
FinalizeStatus: string
Maximum Length:
1
Indicates the status of finalizing the markup session. Possible values are R, F, and S for Ready, Finalizing, and Success. -
LnpRecordKey(required): integer
(int64)
The unique identifier for a record. The record is for a permit, business license, or planning and zoning, and is determined by the classification.
-
PlanReviewKey: integer
(int64)
The unique identifier for a plan review cycle.
-
PlanReviewName: string
Title:
Name
Maximum Length:100
The name of the plan review. -
PlanReviewPuid(required): string
Maximum Length:
480
The public unique identifier for a plan review record. -
RecordNumber(required): string
Maximum Length:
64
The public unique identifier for a permit record. -
ReviewClosedBy: string
Maximum Length:
18
The user who closed the plan review cycle. -
ReviewClosedByPuid: string
The public unique identifier for the person ID that closed the plan review.
-
ReviewClosedDttm: string
(date-time)
The date when the plan review cycle was closed.
-
ReviewDueDate: string
(date-time)
Title:
Due Date
The date by which the plan review must be completed. -
ReviewOpenBy: string
Maximum Length:
18
The user who opened the plan review cycle. -
ReviewOpenByPuid: string
The public unique identifier for the person ID that opened the plan review.
-
ReviewOpenDttm: string
(date-time)
Title:
Open Date
The date when the plan review cycle was opened. -
ReviewStatus: string
Title:
Status
Maximum Length:15
Default Value:INPROGRESS
The review status for the plan review cycle.
Nested Schema : Markup Sessions
Type:
array
Title:
Markup Sessions
The markup sessions resource is used to view, update, create, and delete a markup session.
Show Source
Nested Schema : schema
Type:
Show Source
object
-
AccessToken: string
The access token for a markup session.
-
SessionAction: string
The type of action to take within the electronic document review application.
-
SessionActivities: string
Used for sending batch requests to the electronic document review application.
-
SessionEndDate: string
(date-time)
Title:
Session End Date
The ending date for the document review markup session. -
SessionFileId: integer
The unique identifier for a markup session file.
-
SessionFileName: string
The name of the markup session file.
-
SessionFiles: string
The list used sending multiple files to the electronic document review application.
-
SessionFileSource: string
The unique identifier for the document in the Oracle Permitting and Licensing application.
-
SessionId: string
Title:
Session ID
Maximum Length:1000
Default Value:0
The unique identifier for a markup session. -
SessionInviteURL: string
The URL included in an email notification to users to access a markup session.
-
SessionName: string
Title:
Session Name
The name of the markup session. -
SessionStatus: string
Title:
Session Status
The status of the markup session. -
SessionType: string
Maximum Length:
15
Default Value:PLR
The source of the markup session request. Defaults to PLR for plan review. -
SessionUserEmail: string
Title:
Session User Email
The email address of the markup session user. -
SessionUserId: string
The user ID of the markup session user.
-
SessionUserMessage: string
Title:
Session User Message
The message included in an email notification to users to access a markup session. -
SessionUsers: string
The list used for registering multiple users to the electronic document review application.
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.
Root Schema : publicSectorPlanReviews-item-response
Type:
Show Source
object
-
AgencyId: integer
Default Value:
1
The agency identifier of the public sector entity to which this plan review cycle applies. -
BluebeamSessionKey: integer
(int64)
Read Only:
true
The unique identifier for a plan review markup session in the PSCR application. -
BluebeamSessions: array
Markup Sessions
Title:
Markup Sessions
The markup sessions resource is used to view, update, create, and delete a markup session. -
CopyDocuments: string
The indicator that determines whether to copy the plan review documents from the previous cycle when creating a new plan review cycle.
-
CopyReviewer: string
Default Value:
N
The indicator used when creating a new plan review cycle. Used to determine whether to copy the plan reviewers from the previous cycle. -
CycleCount: integer
(int32)
Title:
Cycle
The numbering for each plan review cycle. -
CycleDays: integer
(int32)
Title:
Cycle Days
The number of days that the plan review cycle was open or in progress. -
Decision: string
Title:
Decision
Maximum Length:15
The decision status for the plan review cycle. -
ElectronicPlanReview: string
Title:
Electronic Review
Maximum Length:1
Indicates whether the plan review has been performed for a document attachment. The default value is N for no. -
FinalizeStatus: string
Maximum Length:
1
Indicates the status of finalizing the markup session. Possible values are R, F, and S for Ready, Finalizing, and Success. -
InviteUrl: string
Read Only:
true
Maximum Length:150
The URL to access the electronic document review application review session. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LnpRecordKey: integer
(int64)
The unique identifier for a record. The record is for a permit, business license, or planning and zoning, and is determined by the classification.
-
OriginalPlanReviewKey: integer
(int64)
Read Only:
true
The plan review key of the initial or original plan review cycle. -
PlanReviewId: string
Read Only:
true
Maximum Length:12
The plan review cycle record identifier. For example, a plan review ID with a value such as PLNR-1. -
PlanReviewKey: integer
(int64)
The unique identifier for a plan review cycle.
-
PlanReviewName: string
Title:
Name
Maximum Length:100
The name of the plan review. -
PlanReviewPuid: string
Maximum Length:
480
The public unique identifier for a plan review record. -
PlanReviewType: string
Read Only:
true
Maximum Length:11
The type of plan review. For example, a plan review type for the first cycle is O for original or R for resubmittal. -
RecordNumber: string
Maximum Length:
64
The public unique identifier for a permit record. -
ReviewClosedBy: string
Maximum Length:
18
The user who closed the plan review cycle. -
ReviewClosedByPuid: string
The public unique identifier for the person ID that closed the plan review.
-
ReviewClosedDttm: string
(date-time)
The date when the plan review cycle was closed.
-
ReviewDueDate: string
(date-time)
Title:
Due Date
The date by which the plan review must be completed. -
ReviewOpenBy: string
Maximum Length:
18
The user who opened the plan review cycle. -
ReviewOpenByPuid: string
The public unique identifier for the person ID that opened the plan review.
-
ReviewOpenDttm: string
(date-time)
Title:
Open Date
The date when the plan review cycle was opened. -
ReviewStatus: string
Title:
Status
Maximum Length:15
Default Value:INPROGRESS
The review status for the plan review cycle. -
SessionId: string
Read Only:
true
Maximum Length:1000
The unique identifier for a markup session in the electronic document review application.
Nested Schema : Markup Sessions
Type:
array
Title:
Markup Sessions
The markup sessions resource is used to view, update, create, and delete a markup session.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorPlanReviews-BluebeamSessions-item-response
Type:
Show Source
object
-
AccessToken: string
The access token for a markup session.
-
BluebeamSessionKey: integer
(int64)
Read Only:
true
The unique identifier for a plan review markup session in the Oracle Permitting and Licensing application. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the markup session. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the markup session was created. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the markup session was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the markup session. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login for the user who last updated the markup session. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
SessionAction: string
The type of action to take within the electronic document review application.
-
SessionActivities: string
Used for sending batch requests to the electronic document review application.
-
SessionEndDate: string
(date-time)
Title:
Session End Date
The ending date for the document review markup session. -
SessionFileId: integer
The unique identifier for a markup session file.
-
SessionFileName: string
The name of the markup session file.
-
SessionFiles: string
The list used sending multiple files to the electronic document review application.
-
SessionFileSource: string
The unique identifier for the document in the Oracle Permitting and Licensing application.
-
SessionId: string
Title:
Session ID
Maximum Length:1000
Default Value:0
The unique identifier for a markup session. -
SessionInviteURL: string
The URL included in an email notification to users to access a markup session.
-
SessionName: string
Title:
Session Name
The name of the markup session. -
SessionStatus: string
Title:
Session Status
The status of the markup session. -
SessionType: string
Maximum Length:
15
Default Value:PLR
The source of the markup session request. Defaults to PLR for plan review. -
SessionUserEmail: string
Title:
Session User Email
The email address of the markup session user. -
SessionUserId: string
The user ID of the markup session user.
-
SessionUserMessage: string
Title:
Session User Message
The message included in an email notification to users to access a markup session. -
SessionUsers: string
The list used for registering multiple users to the electronic document review application.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Links
- BluebeamSessions
-
Operation: /fscmRestApi/resources/11.13.18.05/publicSectorPlanReviews/{PlanReviewKey}/child/BluebeamSessionsParameters:
- PlanReviewKey:
$request.path.PlanReviewKey
The markup sessions resource is used to view, update, create, and delete a markup session. - PlanReviewKey: