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

Get all cycle information for a permit plan review

get

/fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewCycles

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:

    • PrimaryKey: Finds the plan review cycle that matches the primary key criteria specified.
      Finder Variables:
      • PlanReviewKey; integer; The unique identifier of the plan review cycle.
  • 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 cycle applies.
    • CreationDate; string; The date and time when the plan review cycle was created.
    • CycleCount; integer; The numbering for each plan review cycle.
    • CycleDays; integer; The number of days that the plan review cycle was open or in progress.
    • DecisionCode; string; The decision status for the plan review cycle.
    • DecisionDescription; string; The decision status description for the plan review cycle.
    • DecisionStatus; string; The decision status for the plan review cycle.
    • ElectronicPlanReview; string; Indicates whether the plan review has been performed for a document attachment. The default value is N for no.
    • FinalizeStatus; string; Indicates the status of finalizing the markup session. Possible values are Ready, Finalizing, and Success.
    • InviteUrl; string; The URL to access the electronic document review application.
    • LastUpdateDate; string; The date and time when the plan review cycle was last updated.
    • LnpRecordKey; integer; The unique identifier for a record. The record is for a permit, business license, professional license, or planning and zoning, and is determined by the classification.
    • OriginalPlanReviewKey; integer; The plan review key of the initial or original plan review cycle.
    • PlanReviewId; string; The plan review cycle record identifier. For example, a plan review ID with a value such as PLNR-1.
    • PlanReviewKey; integer; The unique identifier for a plan review cycle.
    • PlanReviewName; string; The name of the plan review.
    • PlanReviewType; string; The type of plan review. For example, a plan review type for the first cycle is O for original or R for resubmittal.
    • ReviewClosedBy; integer; The user who closed the plan review cycle.
    • ReviewClosedDttm; string; The date when the plan review cycle was closed.
    • ReviewDescription; string; The review status description for the plan review cycle.
    • ReviewDueDate; string; The date by which the plan review must be completed.
    • ReviewOpenBy; integer; The user who opened the plan review cycle.
    • ReviewOpenDttm; string; The date when the plan review cycle was opened.
    • ReviewStatus; string; The review status for the plan review cycle.
    • ReviewStatusCode; string; The review status for the plan review cycle.
    • SessionId; string; The unique identifier for a markup session.
  • 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 : publicSectorPlanReviewCycles
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : publicSectorPlanReviewCycles-item-response
Type: object
Show Source
Back to Top