Update a permit plan review's most current cycle
patch
/fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewMaximumCycles/{PlanReviewKey}
Request
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Path Parameters
-
PlanReviewKey: integer
The unique identifier for a plan review cycle.
The following table describes the body parameters in the request for this task.
Root Schema : publicSectorPlanReviewMaximumCycles-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int32)
The agency identifier of the public sector entity to which this plan review cycle applies.
-
CreatedBy(optional):
string
Maximum Length:
64
The user who created the plan review cycle. -
CreationDate(optional):
string(date-time)
The date and time when the plan review cycle was created.
-
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.
-
DecisionCode(optional):
string
Maximum Length:
15
The decision status for the plan review cycle. -
DecisionDescription(optional):
string
Maximum Length:
100
The decision status description for the plan review cycle. -
DecisionStatus(optional):
string
Maximum Length:
30
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 Ready, Finalizing, and Success. -
InviteUrl(optional):
string
Maximum Length:
150
The URL to access the electronic document review application review session. -
LastUpdateDate(optional):
string(date-time)
The date and time when the plan review cycle was last updated.
-
LastUpdatedBy(optional):
string
Maximum Length:
64
The user who last updated the plan review cycle. -
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.
-
ReviewDescription(optional):
string
Maximum Length:
100
The review status description for the plan review cycle. -
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:
30
The review status for the plan review cycle. -
ReviewStatusCode(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.
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 : publicSectorPlanReviewMaximumCycles-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int32)
The agency identifier of the public sector entity to which this plan review cycle applies.
-
CreatedBy(optional):
string
Maximum Length:
64
The user who created the plan review cycle. -
CreationDate(optional):
string(date-time)
The date and time when the plan review cycle was created.
-
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.
-
DecisionCode(optional):
string
Maximum Length:
15
The decision status for the plan review cycle. -
DecisionDescription(optional):
string
Maximum Length:
100
The decision status description for the plan review cycle. -
DecisionStatus(optional):
string
Maximum Length:
30
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 Ready, Finalizing, and Success. -
InviteUrl(optional):
string
Maximum Length:
150
The URL to access the electronic document review application review session. -
LastUpdateDate(optional):
string(date-time)
The date and time when the plan review cycle was last updated.
-
LastUpdatedBy(optional):
string
Maximum Length:
64
The user who last updated the plan review cycle. -
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.
-
ReviewDescription(optional):
string
Maximum Length:
100
The review status description for the plan review cycle. -
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:
30
The review status for the plan review cycle. -
ReviewStatusCode(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.
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.