Update a plan review file reviewer
patch
/fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewFiles/{DocumentFileKey}/child/PlanReviewFileUser/{DocumentUserKey}
Request
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Path Parameters
-
DocumentFileKey: integer
The unique identifier for a plan review file.
-
DocumentUserKey: integer
The unique identifier for a plan review file reviewer.
The following table describes the body parameters in the request for this task.
Root Schema : publicSectorPlanReviewFiles-PlanReviewFileUser-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int32)
The agency identifier of the public sector entity to which this plan review file reviewer applies.
-
AssignedBy(optional):
integer(int64)
The user who assigned the plan review file reviewer to the plan review cycle. Usually this is the plan coordinator.
-
AssignedDttm(optional):
string(date-time)
The date when the plan review file reviewer was assigned to the plan review cycle.
-
CreationDate(optional):
string(date-time)
The date and time when the plan review file reviewer record was created.
-
Decision(optional):
string
Maximum Length:
15
The decision code for the plan review file 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 a plan coordinator.
-
DepartmentId(optional):
string
Title:
Department
Maximum Length:30
The unique identifier for a plan reviewer department. This is a user-defined value. -
DocumentFileKey(optional):
integer(int64)
The unique identifier for a plan review file.
-
DocumentUserId(optional):
integer(int64)
The unique identifier for a user in the electronic document review application.
-
DocumentUserKey(optional):
integer(int64)
The unique identifier for a plan review file reviewer.
-
EmailAddress(optional):
string
Maximum Length:
320
The email address for the plan review file reviewer. -
LastUpdateDate(optional):
string(date-time)
The date and time that the plan review file reviewer was last updated.
-
links(optional):
array Items
Title:
Items
Link Relations -
Override(optional):
string
Maximum Length:
1
Indicates whether the plan review file reviewer decision was overridden. Usually this is done by the plan coordinator user. -
OverrideBy(optional):
integer(int64)
The user that entered the override decision. Usually this is the plan coordinator.
-
OverrideDecision(optional):
string
Maximum Length:
15
The decision code when the plan review file reviewer decision was overridden. Usually this is entered by the plan coordinator user. -
OverrideDttm(optional):
string(date-time)
The date and time that the plan review file reviewer decision was overridden.
-
PartyId(optional):
integer(int64)
The person party ID for the plan review file reviewer.
-
PlanReviewKey(optional):
integer(int64)
The unique identifier for a plan review cycle.
-
ReviewerDueDate(optional):
string(date-time)
The date by which the plan review is required to be reviewed by the file reviewer user.
-
ReviewerId(optional):
integer(int64)
The unique identifier for a plan review file reviewer user.
-
ReviewStatus(optional):
string
Maximum Length:
15
The review status code for a plan review file reviewer. For example, the intial review status is INPROGRESS. -
UploadStatus(optional):
string
Maximum Length:
1
The status of uploading a plan review file reviewer to the electronic document review application. Example values are Not Attempted, Success, and Error. -
UserType(optional):
string
Maximum Length:
8
The user type for a plan review file 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 : publicSectorPlanReviewFiles-PlanReviewFileUser-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int32)
The agency identifier of the public sector entity to which this plan review file reviewer applies.
-
AssignedBy(optional):
integer(int64)
The user who assigned the plan review file reviewer to the plan review cycle. Usually this is the plan coordinator.
-
AssignedDttm(optional):
string(date-time)
The date when the plan review file reviewer was assigned to the plan review cycle.
-
CreationDate(optional):
string(date-time)
The date and time when the plan review file reviewer record was created.
-
Decision(optional):
string
Maximum Length:
15
The decision code for the plan review file 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 a plan coordinator.
-
DepartmentId(optional):
string
Title:
Department
Maximum Length:30
The unique identifier for a plan reviewer department. This is a user-defined value. -
DocumentFileKey(optional):
integer(int64)
The unique identifier for a plan review file.
-
DocumentUserId(optional):
integer(int64)
The unique identifier for a user in the electronic document review application.
-
DocumentUserKey(optional):
integer(int64)
The unique identifier for a plan review file reviewer.
-
EmailAddress(optional):
string
Maximum Length:
320
The email address for the plan review file reviewer. -
LastUpdateDate(optional):
string(date-time)
The date and time that the plan review file reviewer was last updated.
-
links(optional):
array Items
Title:
Items
Link Relations -
Override(optional):
string
Maximum Length:
1
Indicates whether the plan review file reviewer decision was overridden. Usually this is done by the plan coordinator user. -
OverrideBy(optional):
integer(int64)
The user that entered the override decision. Usually this is the plan coordinator.
-
OverrideDecision(optional):
string
Maximum Length:
15
The decision code when the plan review file reviewer decision was overridden. Usually this is entered by the plan coordinator user. -
OverrideDttm(optional):
string(date-time)
The date and time that the plan review file reviewer decision was overridden.
-
PartyId(optional):
integer(int64)
The person party ID for the plan review file reviewer.
-
PlanReviewKey(optional):
integer(int64)
The unique identifier for a plan review cycle.
-
ReviewerDueDate(optional):
string(date-time)
The date by which the plan review is required to be reviewed by the file reviewer user.
-
ReviewerId(optional):
integer(int64)
The unique identifier for a plan review file reviewer user.
-
ReviewStatus(optional):
string
Maximum Length:
15
The review status code for a plan review file reviewer. For example, the intial review status is INPROGRESS. -
UploadStatus(optional):
string
Maximum Length:
1
The status of uploading a plan review file reviewer to the electronic document review application. Example values are Not Attempted, Success, and Error. -
UserType(optional):
string
Maximum Length:
8
The user type for a plan review file 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.