Update a plan reviewer for a permit plan review
patch
/fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewers/{PlanReviewUserKey}
Request
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Path Parameters
-
PlanReviewUserKey: integer
The unique identifier for a plan reviewer.
The following table describes the body parameters in the request for this task.
Root Schema : publicSectorPlanReviewers-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int64)
The agency identifier of the public sector entity to which this plan reviewer applies.
-
AssignedBy(optional):
integer(int64)
The user who assigned the plan reviewer to the plan review cycle. Usually this is the plan coordinator.
-
AssignedDttm(optional):
string(date-time)
The date when the plan reviewer was assigned to the plan review cycle.
-
Decision(optional):
string
Maximum Length:
15
The decision code for the plan reviewer of a plan review cycle. For example, the decision code could be APPROVED. -
DecisionDttm(optional):
string(date-time)
The date when the decision was updated by the user. The user could be a plan reviewer or plan coordinator.
-
DepartmentId(optional):
string
Title:
Department
Maximum Length:30
The unique identifier for a plan reviewer department. This is a user-defined value. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated Date
The date and time when the plan reviewer decision was last updated. -
LastUpdatedBy(optional):
string
Title:
Last Updated By
Maximum Length:64
The user who last modified the plan reviewer decision. -
links(optional):
array Items
Title:
Items
Link Relations -
Override(optional):
string
Maximum Length:
1
Indicates whether the plan reviewer decision was overridden by the plan coordinator user or not. The default value is no. -
OverrideBy(optional):
integer(int64)
The user who the entered the override decision. Usually this is the plan coordinator.
-
OverrideDecision(optional):
string
Maximum Length:
15
The decision code when the plan reviewer decision was overridden by the plan coordinator. -
OverrideDttm(optional):
string(date-time)
The date and time when the plan reviewer decision was overridden.
-
PartyId(optional):
integer(int64)
The person party ID for the plan reviewer.
-
PlanReviewKey(optional):
integer(int64)
The unique identifier for a plan review cycle.
-
PlanReviewUserKey(optional):
integer(int64)
The unique identifier for a plan reviewer.
-
ReviewerDueDate(optional):
string(date-time)
The date by which the plan review must be completed by the reviewer.
-
ReviewerEmailId(optional):
integer(int64)
The email address for the plan reviewer.
-
ReviewerId(optional):
integer(int64)
The unique identifier for a plan reviewer.
-
ReviewStatus(optional):
string
Maximum Length:
15
The review status code for the plan reviewer of a plan review cycle. For example, the initial review status is IN PROGRESS. -
UserType(optional):
string
Maximum Length:
8
The user type for a plan reviewer. For example, I for an internal user, and E for an external user. An example of an external user could be a contractor.
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 : publicSectorPlanReviewers-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int64)
The agency identifier of the public sector entity to which this plan reviewer applies.
-
AssignedBy(optional):
integer(int64)
The user who assigned the plan reviewer to the plan review cycle. Usually this is the plan coordinator.
-
AssignedDttm(optional):
string(date-time)
The date when the plan reviewer was assigned to the plan review cycle.
-
Decision(optional):
string
Maximum Length:
15
The decision code for the plan reviewer of a plan review cycle. For example, the decision code could be APPROVED. -
DecisionDttm(optional):
string(date-time)
The date when the decision was updated by the user. The user could be a plan reviewer or plan coordinator.
-
DepartmentId(optional):
string
Title:
Department
Maximum Length:30
The unique identifier for a plan reviewer department. This is a user-defined value. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated Date
The date and time when the plan reviewer decision was last updated. -
LastUpdatedBy(optional):
string
Title:
Last Updated By
Maximum Length:64
The user who last modified the plan reviewer decision. -
links(optional):
array Items
Title:
Items
Link Relations -
Override(optional):
string
Maximum Length:
1
Indicates whether the plan reviewer decision was overridden by the plan coordinator user or not. The default value is no. -
OverrideBy(optional):
integer(int64)
The user who the entered the override decision. Usually this is the plan coordinator.
-
OverrideDecision(optional):
string
Maximum Length:
15
The decision code when the plan reviewer decision was overridden by the plan coordinator. -
OverrideDttm(optional):
string(date-time)
The date and time when the plan reviewer decision was overridden.
-
PartyId(optional):
integer(int64)
The person party ID for the plan reviewer.
-
PlanReviewKey(optional):
integer(int64)
The unique identifier for a plan review cycle.
-
PlanReviewUserKey(optional):
integer(int64)
The unique identifier for a plan reviewer.
-
ReviewerDueDate(optional):
string(date-time)
The date by which the plan review must be completed by the reviewer.
-
ReviewerEmailId(optional):
integer(int64)
The email address for the plan reviewer.
-
ReviewerId(optional):
integer(int64)
The unique identifier for a plan reviewer.
-
ReviewStatus(optional):
string
Maximum Length:
15
The review status code for the plan reviewer of a plan review cycle. For example, the initial review status is IN PROGRESS. -
UserType(optional):
string
Maximum Length:
8
The user type for a plan reviewer. For example, I for an internal user, and E for an external user. An example of an external user could be a contractor.
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.