Create a plan review file
post
/fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewFiles
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 : publicSectorPlanReviewFiles-item
Type:
Show Source
object-
AgencyId(optional):
integer(int32)
The agency identifier of the public sector entity to which this plan review file applies.
-
CreatedBy(optional):
string
Maximum Length:
64The user who created the plan review file record. -
CreationDate(optional):
string(date-time)
The date and time when the plan review file record was created.
-
Decision(optional):
string
Maximum Length:
15The decision code for the plan review file 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.
-
DocumentFileId(optional):
integer(int64)
The unique key associated with the file in the electronic document review application.
-
DocumentFileKey(optional):
integer(int64)
The unique identifier for a plan review file.
-
DocumentReviewedFlag(optional):
string
Maximum Length:
1Indicates whether the plan review file has been reviewed, marked up, and returned from the electronic document review application. -
LastUpdateDate(optional):
string(date-time)
The date and time that the plan review file was last updated.
-
LastUpdatedBy(optional):
string
Maximum Length:
64The user who last updated the plan review file record. -
links(optional):
array Items
Title:
ItemsLink Relations -
LnpAttachmentKey(optional):
integer(int64)
The unique key associated with the permit attachment.
-
OriginalFileKey(optional):
integer(int64)
The plan review file key of the original file or a previous version of the file.
-
PlanReviewFileUser(optional):
array Plan Review File Reviewers
Title:
Plan Review File ReviewersUse the plan review files resource to view, update, create, and delete plan review files. -
PlanReviewKey(optional):
integer(int64)
The unique identifier for a plan review cycle.
-
ResubmitStatus(optional):
string
Maximum Length:
1The status of resubmitting an attachment file for a plan review cycle. Example values are Not Attempted, Requires Resubmittal, Success, and Error. -
ReviewStatus(optional):
string
Maximum Length:
15The review status code for the plan review file of a plan review cycle. For example, the intial review status is INPROGRESS. -
UploadStatus(optional):
string
Maximum Length:
1The status of uploading an attachment file for a plan review cycle. Example values are Not Attempted, Success, and Error. -
VisibleFlag(optional):
string
Maximum Length:
1Indicates whether the plan review file should be displayed in the user interface.
Nested Schema : Plan Review File Reviewers
Type:
arrayTitle:
Plan Review File ReviewersUse the plan review files resource to view, update, create, and delete plan review files.
Show Source
Nested Schema : link
Type:
Show Source
object-
href(optional):
string
Title:
hyperlink referenceThe URI to the related resource. -
rel(optional):
string
Title:
relationThe name of the relation to the resource instance. Example: self.
Nested 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.
-
CreatedBy(optional):
string
Maximum Length:
64The user who created the plan review file reviewer record. -
CreationDate(optional):
string(date-time)
The date and time when the plan review file reviewer record was created.
-
Decision(optional):
string
Maximum Length:
15The 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:
DepartmentMaximum Length:30The 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:
320The 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.
-
LastUpdatedBy(optional):
string
Maximum Length:
64The user who last updated the plan review file reviewer record. -
links(optional):
array Items
Title:
ItemsLink Relations -
Override(optional):
string
Maximum Length:
1Indicates 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:
15The 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:
15The review status code for a plan review file reviewer. For example, the intial review status is INPROGRESS. -
UploadStatus(optional):
string
Maximum Length:
1The 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:
8The 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.
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-item
Type:
Show Source
object-
AgencyId(optional):
integer(int32)
The agency identifier of the public sector entity to which this plan review file applies.
-
CreatedBy(optional):
string
Maximum Length:
64The user who created the plan review file record. -
CreationDate(optional):
string(date-time)
The date and time when the plan review file record was created.
-
Decision(optional):
string
Maximum Length:
15The decision code for the plan review file 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.
-
DocumentFileId(optional):
integer(int64)
The unique key associated with the file in the electronic document review application.
-
DocumentFileKey(optional):
integer(int64)
The unique identifier for a plan review file.
-
DocumentReviewedFlag(optional):
string
Maximum Length:
1Indicates whether the plan review file has been reviewed, marked up, and returned from the electronic document review application. -
LastUpdateDate(optional):
string(date-time)
The date and time that the plan review file was last updated.
-
LastUpdatedBy(optional):
string
Maximum Length:
64The user who last updated the plan review file record. -
links(optional):
array Items
Title:
ItemsLink Relations -
LnpAttachmentKey(optional):
integer(int64)
The unique key associated with the permit attachment.
-
OriginalFileKey(optional):
integer(int64)
The plan review file key of the original file or a previous version of the file.
-
PlanReviewFileUser(optional):
array Plan Review File Reviewers
Title:
Plan Review File ReviewersUse the plan review files resource to view, update, create, and delete plan review files. -
PlanReviewKey(optional):
integer(int64)
The unique identifier for a plan review cycle.
-
ResubmitStatus(optional):
string
Maximum Length:
1The status of resubmitting an attachment file for a plan review cycle. Example values are Not Attempted, Requires Resubmittal, Success, and Error. -
ReviewStatus(optional):
string
Maximum Length:
15The review status code for the plan review file of a plan review cycle. For example, the intial review status is INPROGRESS. -
UploadStatus(optional):
string
Maximum Length:
1The status of uploading an attachment file for a plan review cycle. Example values are Not Attempted, Success, and Error. -
VisibleFlag(optional):
string
Maximum Length:
1Indicates whether the plan review file should be displayed in the user interface.
Nested Schema : Plan Review File Reviewers
Type:
arrayTitle:
Plan Review File ReviewersUse the plan review files resource to view, update, create, and delete plan review files.
Show Source
Nested Schema : link
Type:
Show Source
object-
href(optional):
string
Title:
hyperlink referenceThe URI to the related resource. -
rel(optional):
string
Title:
relationThe name of the relation to the resource instance. Example: self.
Nested 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.
-
CreatedBy(optional):
string
Maximum Length:
64The user who created the plan review file reviewer record. -
CreationDate(optional):
string(date-time)
The date and time when the plan review file reviewer record was created.
-
Decision(optional):
string
Maximum Length:
15The 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:
DepartmentMaximum Length:30The 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:
320The 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.
-
LastUpdatedBy(optional):
string
Maximum Length:
64The user who last updated the plan review file reviewer record. -
links(optional):
array Items
Title:
ItemsLink Relations -
Override(optional):
string
Maximum Length:
1Indicates 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:
15The 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:
15The review status code for a plan review file reviewer. For example, the intial review status is INPROGRESS. -
UploadStatus(optional):
string
Maximum Length:
1The 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:
8The 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.