Create a plan review cycle
post
/fscmRestApi/resources/11.13.18.05/publicSectorPlanReviews
Request
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
The following table describes the body parameters in the request for this task.
Root Schema : publicSectorPlanReviews-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int64)
The agency identifier of the public sector entity to which this plan review cycle applies.
-
BluebeamSessionKey(optional):
integer(int64)
The unique identifier for a plan review markup session in the PSCR application.
-
BluebeamSessions(optional):
array Markup Sessions
Title:
Markup Sessions
Use the plan reviews resource to view, update, create, and delete a plan review cycle. -
CopyReviewer(optional):
string
The indicator used when creating a new plan review cycle. Used to determine whether to copy the plan reviewers from the previous cycle.
-
CycleCount(optional):
integer(int32)
The numbering for each plan review cycle.
-
CycleDays(optional):
integer(int32)
The number of days that the plan review cycle was open or in progress.
-
Decision(optional):
string
Maximum Length:
15
The decision status for the plan review cycle. -
ElectronicPlanReview(optional):
string
Maximum Length:
1
Indicates whether the plan review has been performed for a document attachment. The default value is N for no. -
FinalizeStatus(optional):
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(optional):
string
Maximum Length:
150
The URL to access the electronic document review application review session. -
links(optional):
array Items
Title:
Items
Link Relations -
LnpRecordKey(optional):
integer(int64)
The unique identifier for a record. The record is for a permit, business license, professional license, or planning and zoning, and is determined by the classification.
-
OriginalPlanReviewKey(optional):
integer(int64)
The plan review key of the initial or original plan review cycle.
-
PlanReviewId(optional):
string
Maximum Length:
12
The plan review cycle record identifier. For example, a plan review ID with a value such as PLNR-1. -
PlanReviewKey(optional):
integer(int64)
The unique identifier for a plan review cycle.
-
PlanReviewName(optional):
string
Maximum Length:
100
The name of the plan review. -
PlanReviewType(optional):
string
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. -
ReviewClosedBy(optional):
integer(int64)
The user who closed the plan review cycle.
-
ReviewClosedDttm(optional):
string(date-time)
The date when the plan review cycle was closed.
-
ReviewDueDate(optional):
string(date-time)
The date by which the plan review must be completed.
-
ReviewOpenBy(optional):
integer(int64)
The user who opened the plan review cycle.
-
ReviewOpenDttm(optional):
string(date-time)
The date when the plan review cycle was opened.
-
ReviewStatus(optional):
string
Maximum Length:
15
The review status for the plan review cycle. -
SessionId(optional):
string
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
Use the plan reviews resource to view, update, create, and delete a plan review cycle.
Show Source
-
Array of:
object publicSectorPlanReviews-BluebeamSessions-item
Discriminator:
SessionType
Nested Schema : publicSectorPlanReviews-BluebeamSessions-item
Type:
object
Discriminator:
Show Source
SessionType
-
AccessToken(optional):
string
Maximum Length:
255
The access token for a markup session. -
BluebeamSessionKey(optional):
integer(int64)
The unique identifier for a plan review markup session in the PSCR application.
-
CreatedBy(optional):
string
Title:
Created By
Maximum Length:64
The user who created the markup session. -
CreationDate(optional):
string(date-time)
Title:
Creation Date
The date and time when the markup session was created. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated Date
The date and time when the markup session was last updated. -
LastUpdatedBy(optional):
string
Title:
Last Updated By
Maximum Length:64
The user who last updated the markup session. -
LastUpdateLogin(optional):
string
Title:
Last Update Login
Maximum Length:32
The login for the user who last updated the markup session. -
links(optional):
array Items
Title:
Items
Link Relations -
SessionAction(optional):
string
The type of action to take within the electronic document review application.
-
SessionActivities(optional):
string
Used for sending batch requests to the electronic document review application.
-
SessionEndDate(optional):
string(date-time)
The ending date for the document review markup session.
-
SessionFileId(optional):
integer(int32)
The unique identifier for a markup session file.
-
SessionFileName(optional):
string
The name of the markup session file.
-
SessionFiles(optional):
string
Used for sending multiple files to the electronic document review application.
-
SessionFileSource(optional):
string
The unique identifier for the document in the PSCR application.
-
SessionId(optional):
string
Maximum Length:
1000
The unique identifier for a markup session. -
SessionInviteURL(optional):
string
The URL included in an email notification to users to access a markup session.
-
SessionName(optional):
string
The name of the markup session.
-
SessionStatus(optional):
string
The status of the markup session.
-
SessionType:
string
Maximum Length:
15
The source of the markup session request. Defaults to PLR for plan review. -
SessionUserEmail(optional):
string
The email address of the markup session user.
-
SessionUserId(optional):
integer(int32)
The user ID of the markup session user.
-
SessionUserMessage(optional):
string
The message included in an email notification to users to access a markup session.
-
SessionUsers(optional):
string
Used for registering multiple users to the electronic document review application.
Nested Schema : link
Type:
Show Source
object
-
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.
Response
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Default Response
The following table describes the default response for this task.
Root Schema : publicSectorPlanReviews-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int64)
The agency identifier of the public sector entity to which this plan review cycle applies.
-
BluebeamSessionKey(optional):
integer(int64)
The unique identifier for a plan review markup session in the PSCR application.
-
BluebeamSessions(optional):
array Markup Sessions
Title:
Markup Sessions
Use the plan reviews resource to view, update, create, and delete a plan review cycle. -
CopyReviewer(optional):
string
The indicator used when creating a new plan review cycle. Used to determine whether to copy the plan reviewers from the previous cycle.
-
CycleCount(optional):
integer(int32)
The numbering for each plan review cycle.
-
CycleDays(optional):
integer(int32)
The number of days that the plan review cycle was open or in progress.
-
Decision(optional):
string
Maximum Length:
15
The decision status for the plan review cycle. -
ElectronicPlanReview(optional):
string
Maximum Length:
1
Indicates whether the plan review has been performed for a document attachment. The default value is N for no. -
FinalizeStatus(optional):
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(optional):
string
Maximum Length:
150
The URL to access the electronic document review application review session. -
links(optional):
array Items
Title:
Items
Link Relations -
LnpRecordKey(optional):
integer(int64)
The unique identifier for a record. The record is for a permit, business license, professional license, or planning and zoning, and is determined by the classification.
-
OriginalPlanReviewKey(optional):
integer(int64)
The plan review key of the initial or original plan review cycle.
-
PlanReviewId(optional):
string
Maximum Length:
12
The plan review cycle record identifier. For example, a plan review ID with a value such as PLNR-1. -
PlanReviewKey(optional):
integer(int64)
The unique identifier for a plan review cycle.
-
PlanReviewName(optional):
string
Maximum Length:
100
The name of the plan review. -
PlanReviewType(optional):
string
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. -
ReviewClosedBy(optional):
integer(int64)
The user who closed the plan review cycle.
-
ReviewClosedDttm(optional):
string(date-time)
The date when the plan review cycle was closed.
-
ReviewDueDate(optional):
string(date-time)
The date by which the plan review must be completed.
-
ReviewOpenBy(optional):
integer(int64)
The user who opened the plan review cycle.
-
ReviewOpenDttm(optional):
string(date-time)
The date when the plan review cycle was opened.
-
ReviewStatus(optional):
string
Maximum Length:
15
The review status for the plan review cycle. -
SessionId(optional):
string
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
Use the plan reviews resource to view, update, create, and delete a plan review cycle.
Show Source
-
Array of:
object publicSectorPlanReviews-BluebeamSessions-item
Discriminator:
SessionType
Nested Schema : publicSectorPlanReviews-BluebeamSessions-item
Type:
object
Discriminator:
Show Source
SessionType
-
AccessToken(optional):
string
Maximum Length:
255
The access token for a markup session. -
BluebeamSessionKey(optional):
integer(int64)
The unique identifier for a plan review markup session in the PSCR application.
-
CreatedBy(optional):
string
Title:
Created By
Maximum Length:64
The user who created the markup session. -
CreationDate(optional):
string(date-time)
Title:
Creation Date
The date and time when the markup session was created. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated Date
The date and time when the markup session was last updated. -
LastUpdatedBy(optional):
string
Title:
Last Updated By
Maximum Length:64
The user who last updated the markup session. -
LastUpdateLogin(optional):
string
Title:
Last Update Login
Maximum Length:32
The login for the user who last updated the markup session. -
links(optional):
array Items
Title:
Items
Link Relations -
SessionAction(optional):
string
The type of action to take within the electronic document review application.
-
SessionActivities(optional):
string
Used for sending batch requests to the electronic document review application.
-
SessionEndDate(optional):
string(date-time)
The ending date for the document review markup session.
-
SessionFileId(optional):
integer(int32)
The unique identifier for a markup session file.
-
SessionFileName(optional):
string
The name of the markup session file.
-
SessionFiles(optional):
string
Used for sending multiple files to the electronic document review application.
-
SessionFileSource(optional):
string
The unique identifier for the document in the PSCR application.
-
SessionId(optional):
string
Maximum Length:
1000
The unique identifier for a markup session. -
SessionInviteURL(optional):
string
The URL included in an email notification to users to access a markup session.
-
SessionName(optional):
string
The name of the markup session.
-
SessionStatus(optional):
string
The status of the markup session.
-
SessionType:
string
Maximum Length:
15
The source of the markup session request. Defaults to PLR for plan review. -
SessionUserEmail(optional):
string
The email address of the markup session user.
-
SessionUserId(optional):
integer(int32)
The user ID of the markup session user.
-
SessionUserMessage(optional):
string
The message included in an email notification to users to access a markup session.
-
SessionUsers(optional):
string
Used for registering multiple users to the electronic document review application.
Nested Schema : link
Type:
Show Source
object
-
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.