Create a plan review file
post
/fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewFiles
Request
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
AgencyId: integer
(int32)
Default Value:
1
The agency identifier of the public sector entity to which this plan review file applies. -
Decision: string
Maximum Length:
15
The decision code for the plan review file of a plan review cycle. For example, the decision code could be APPROVED. -
DocumentFileId: integer
(int64)
The unique key associated with the file in the electronic document review application.
-
DocumentFileKey: integer
(int64)
The unique identifier for a plan review file.
-
DocumentFilePuid(required): string
Maximum Length:
480
The public unique identifier for a document attachment for electronic plan review. -
DocumentReviewedFlag: string
Maximum Length:
1
Default Value:N
Indicates whether the plan review file has been reviewed, marked up, and returned from the electronic document review application. -
DownloadStatus: string
Maximum Length:
1
Default Value:N
The status of downloading an attachment file from an electronic plan review cycle session. Example values are N (Not Downloaded), E (Error), and S (Success). -
LnpAttachmentKey: integer
(int64)
The unique key associated with the permit attachment.
-
LnpAttachmentPuid: string
Maximum Length:
2048
The public unique identifier for a permit attachment. -
OriginalFileKey: integer
(int64)
Title:
Original File Key
The plan review file key of the original file or a previous version of the file. -
OriginalFilePuid: string
Maximum Length:
480
The public unique identifier for an original file. -
PlanReviewFileUser: array
Plan Review File Users
Title:
Plan Review File Users
Use the plan review file users resource to view, update, create, and delete plan review file reviewers. -
PlanReviewKey(required): integer
(int64)
The unique identifier for a plan review cycle.
-
PlanReviewPuid(required): string
Maximum Length:
480
The public unique identifier for a plan review record. -
UploadStatus: string
Maximum Length:
1
Default Value:N
The status of uploading an attachment file for a plan review cycle. Example values are N (Not Uploaded), S (Success), E (Error), A (Archived), U (Archived file that had protection removed), P (Encrypted in some way; not Read/Open), and I (Read Protected).
Nested Schema : Plan Review File Users
Type:
array
Title:
Plan Review File Users
Use the plan review file users resource to view, update, create, and delete plan review file reviewers.
Show Source
Nested Schema : schema
Type:
Show Source
object
-
AgencyId: integer
(int32)
Default Value:
1
The agency identifier of the public sector entity to which this plan review file reviewer applies. -
Decision: 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. -
DepartmentId: string
Title:
Department
Maximum Length:30
The unique identifier for a plan reviewer department. This is a user-defined value. -
DocumentFileKey: integer
(int64)
Title:
Document File Key
The unique identifier for a plan review file. -
DocumentUserKey: integer
(int64)
The unique identifier for a plan review file reviewer.
-
OverrideDecision: 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. -
PlanReviewKey: integer
(int64)
Title:
Plan Review Key
The unique identifier for a plan review cycle. -
ReviewerDueDate: string
(date-time)
Title:
Due Date
The date by which the plan review is required to be reviewed by the file reviewer user. -
ReviewerId: integer
(int64)
The unique identifier for a plan review file reviewer user.
-
UploadStatus: string
Maximum Length:
1
Default Value:N
The status of uploading a plan review file reviewer to the electronic document review application. Example values are Not Attempted, Success, and Error.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version(required):
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : publicSectorPlanReviewFiles-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Default Value:
1
The agency identifier of the public sector entity to which this plan review file applies. -
CreationDate: string
(date-time)
Read Only:
true
The date and time when the plan review file record was created. -
Decision: string
Maximum Length:
15
The decision code for the plan review file of a plan review cycle. For example, the decision code could be APPROVED. -
DecisionDttm: string
(date-time)
Read Only:
true
The date when the decision was updated. -
DocumentFileId: integer
(int64)
The unique key associated with the file in the electronic document review application.
-
DocumentFileKey: integer
(int64)
The unique identifier for a plan review file.
-
DocumentFilePuid: string
Maximum Length:
480
The public unique identifier for a document attachment for electronic plan review. -
DocumentReviewedFlag: string
Maximum Length:
1
Default Value:N
Indicates whether the plan review file has been reviewed, marked up, and returned from the electronic document review application. -
DownloadStatus: string
Maximum Length:
1
Default Value:N
The status of downloading an attachment file from an electronic plan review cycle session. Example values are N (Not Downloaded), E (Error), and S (Success). -
LastUpdateDate: string
(date-time)
Read Only:
true
The date and time when the plan review file was last updated. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LnpAttachmentKey: integer
(int64)
The unique key associated with the permit attachment.
-
LnpAttachmentPuid: string
Maximum Length:
2048
The public unique identifier for a permit attachment. -
OriginalFileKey: integer
(int64)
Title:
Original File Key
The plan review file key of the original file or a previous version of the file. -
OriginalFilePuid: string
Maximum Length:
480
The public unique identifier for an original file. -
PlanReviewFileUser: array
Plan Review File Users
Title:
Plan Review File Users
Use the plan review file users resource to view, update, create, and delete plan review file reviewers. -
PlanReviewKey: integer
(int64)
The unique identifier for a plan review cycle.
-
PlanReviewPuid: string
Maximum Length:
480
The public unique identifier for a plan review record. -
ResubmitStatus: string
Read Only:
true
Maximum Length:1
Default Value:N
The status of resubmitting an attachment file for a plan review cycle. Example values are Not Attempted, Requires Resubmittal, Success, and Error. -
ReviewStatus: string
Read Only:
true
Maximum Length:15
Default Value:INPROGRESS
The review status code for the plan review file of a plan review cycle. For example, the initial review status is INPROGRESS. -
UploadStatus: string
Maximum Length:
1
Default Value:N
The status of uploading an attachment file for a plan review cycle. Example values are N (Not Uploaded), S (Success), E (Error), A (Archived), U (Archived file that had protection removed), P (Encrypted in some way; not Read/Open), and I (Read Protected). -
VisibleFlag: string
Read Only:
true
Maximum Length:1
Default Value:Y
Indicates whether the plan review file should be displayed in the user interface.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Plan Review File Users
Type:
array
Title:
Plan Review File Users
Use the plan review file users resource to view, update, create, and delete plan review file reviewers.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : publicSectorPlanReviewFiles-PlanReviewFileUser-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Default Value:
1
The agency identifier of the public sector entity to which this plan review file reviewer applies. -
AssignedBy: integer
(int64)
Read Only:
true
The user who assigned the plan review file reviewer to the plan review cycle. Usually this is the plan coordinator. -
AssignedDttm: string
(date-time)
Read Only:
true
The date when the plan review file reviewer was assigned to the plan review cycle. -
CreationDate: string
(date-time)
Read Only:
true
The date and time when the plan review file reviewer record was created. -
Decision: 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: string
(date-time)
Read Only:
true
The date when the decision was updated by the user. The user could be a plan reviewer or a plan coordinator. -
DepartmentId: string
Title:
Department
Maximum Length:30
The unique identifier for a plan reviewer department. This is a user-defined value. -
DocumentFileKey: integer
(int64)
Title:
Document File Key
The unique identifier for a plan review file. -
DocumentUserId: integer
(int64)
Read Only:
true
The unique identifier for a user in the electronic document review application. -
DocumentUserKey: integer
(int64)
The unique identifier for a plan review file reviewer.
-
EmailAddress: string
Read Only:
true
Maximum Length:320
The email address for the plan review file reviewer. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date and time that the plan review file reviewer was last updated. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Override: string
Read Only:
true
Maximum Length:1
Default Value:N
Indicates whether the plan review file reviewer decision was overridden. Usually this is done by the plan coordinator user. -
OverrideBy: integer
(int64)
Read Only:
true
The user that entered the override decision. Usually this is the plan coordinator. -
OverrideDecision: 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: string
(date-time)
Read Only:
true
The date and time that the plan review file reviewer decision was overridden. -
PartyId: integer
(int64)
Read Only:
true
Default Value:0
The person party ID for the plan review file reviewer. -
PlanReviewKey: integer
(int64)
Title:
Plan Review Key
The unique identifier for a plan review cycle. -
ReviewerDueDate: string
(date-time)
Title:
Due Date
The date by which the plan review is required to be reviewed by the file reviewer user. -
ReviewerId: integer
(int64)
The unique identifier for a plan review file reviewer user.
-
ReviewStatus: string
Read Only:
true
Maximum Length:15
Default Value:INPROGRESS
The review status code for a plan review file reviewer. For example, the initial review status is INPROGRESS. -
UploadStatus: string
Maximum Length:
1
Default Value:N
The status of uploading a plan review file reviewer to the electronic document review application. Example values are Not Attempted, Success, and Error. -
UserType: string
Read Only:
true
Maximum Length:8
Default Value:I
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 : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- PlanReviewFileUser
-
Parameters:
- DocumentFileKey:
$request.path.DocumentFileKey
Use the plan review file users resource to view, update, create, and delete plan review file reviewers. - DocumentFileKey: