Get a plan review file
get
/fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewFiles/{DocumentFileKey}
Request
Path Parameters
-
DocumentFileKey: integer
The unique identifier for a plan review file.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are attributes that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The attributes specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the attributes will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency attributes. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource attributes. Only the specified attributes are returned, which means that if no attributes are specified, no attributes are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource attributes. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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:
64
The 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:
15
The 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:
1
Indicates 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:
64
The user who last updated the plan review file record. -
links(optional):
array Items
Title:
Items
Link 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 Reviewers
Use 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:
1
The 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:
15
The 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:
1
The status of uploading an attachment file for a plan review cycle. Example values are Not Attempted, Success, and Error. -
VisibleFlag(optional):
string
Maximum Length:
1
Indicates whether the plan review file should be displayed in the user interface.
Nested Schema : Plan Review File Reviewers
Type:
array
Title:
Plan Review File Reviewers
Use 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 reference
The URI to the related resource. -
rel(optional):
string
Title:
relation
The 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:
64
The 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:
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.
-
LastUpdatedBy(optional):
string
Maximum Length:
64
The user who last updated the plan review file reviewer record. -
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.
-
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.