1. REST API for Oracle Public Sector Permitting and Licensing
  2. Tasks
  3. Shared Services
  4. Plan Review Files

Get all plan review files

get

/fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewFiles

Request

Query Parameters
  • 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).
  • This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields 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 fields. 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
  • Used as a predefined finder to search the collection.

    Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables:

    • AltKey: Finds the plan review file document that matches the alternate key criteria specified.
      Finder Variables:
      • DocumentFilePuid; string; The public unique identifier for a document attachment for electronic plan review.
    • PrimaryKey: Finds the plan review file that matches the primary key criteria specified.
      Finder Variables:
      • DocumentFileKey; integer; The unique identifier of the plan review file.
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>

    Example:
    self,canonical
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • AgencyId; integer; The agency identifier of the public sector entity to which this plan review file applies.
    • CreationDate; string; The date and time when the plan review file record was created.
    • Decision; string; The decision code for the plan review file of a plan review cycle. For example, the decision code could be APPROVED.
    • DecisionDttm; string; The date when the decision was updated.
    • DocumentFileId; integer; The unique key associated with the file in the electronic document review application.
    • DocumentFileKey; integer; The unique identifier for a plan review file.
    • DocumentFilePuid; string; The public unique identifier for a document attachment for electronic plan review.
    • DocumentReviewedFlag; string; Indicates whether the plan review file has been reviewed, marked up, and returned from the electronic document review application.
    • DownloadStatus; string; 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; The date and time when the plan review file was last updated.
    • LnpAttachmentKey; integer; The unique key associated with the permit attachment.
    • LnpAttachmentPuid; string; The public unique identifier for a permit attachment.
    • OriginalFileKey; integer; The plan review file key of the original file or a previous version of the file.
    • OriginalFilePuid; string; The public unique identifier for an original file.
    • PlanReviewKey; integer; The unique identifier for a plan review cycle.
    • PlanReviewPuid; string; The public unique identifier for a plan review record.
    • ResubmitStatus; string; The status of resubmitting an attachment file for a plan review cycle. Example values are Not Attempted, Requires Resubmittal, Success, and Error.
    • ReviewStatus; string; The review status code for the plan review file of a plan review cycle. For example, the initial review status is INPROGRESS.
    • UploadStatus; string; 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; Indicates whether the plan review file should be displayed in the user interface.
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
  • 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".
  • 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.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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.
Body ()
Root Schema : publicSectorPlanReviewFiles
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : publicSectorPlanReviewFiles-item-response
Type: object
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 : publicSectorPlanReviewFiles-PlanReviewFileUser-item-response
Type: object
Show Source
  • Default Value: 1
    The agency identifier of the public sector entity to which this plan review file reviewer applies.
  • Read Only: true
    The user who assigned the plan review file reviewer to the plan review cycle. Usually this is the plan coordinator.
  • Read Only: true
    The date when the plan review file reviewer was assigned to the plan review cycle.
  • Read Only: true
    The date and time when the plan review file reviewer record was created.
  • 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.
  • Read Only: true
    The date when the decision was updated by the user. The user could be a plan reviewer or a plan coordinator.
  • Title: Department
    Maximum Length: 30
    The unique identifier for a plan reviewer department. This is a user-defined value.
  • Title: Document File Key
    The unique identifier for a plan review file.
  • Read Only: true
    The unique identifier for a user in the electronic document review application.
  • The unique identifier for a plan review file reviewer.
  • Read Only: true
    Maximum Length: 320
    The email address for the plan review file reviewer.
  • Read Only: true
    The date and time that the plan review file reviewer was last updated.
  • Links
  • 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.
  • Read Only: true
    The user that entered the override decision. Usually this is the plan coordinator.
  • Maximum Length: 15
    The decision code when the plan review file reviewer decision was overridden. Usually this is entered by the plan coordinator user.
  • Read Only: true
    The date and time that the plan review file reviewer decision was overridden.
  • Read Only: true
    Default Value: 0
    The person party ID for the plan review file reviewer.
  • Title: Plan Review Key
    The unique identifier for a plan review cycle.
  • Title: Due Date
    The date by which the plan review is required to be reviewed by the file reviewer user.
  • The unique identifier for a plan review file reviewer user.
  • 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.
  • 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.
  • 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.
Back to Top