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

Get all plan review workflow task

get

/fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewWorkFlowTasks

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 workflow task using the primary key criteria specified.
      Finder Variables:
      • LnpRecordKey; integer; The unique identifier of the workflow task. The workflow task is for a specific permit.
      • PlanReviewKey; integer; The unique identifier of the workflow task. The workflow task is for a specific plan review cycle.
      • PlanReviewUserKey; integer; The unique identifier of the workflow task. The workflow task is for a specific reviewer.
    • simpleSearchFinder: Finds the plan review worklist task using the specified keyword.
      Finder Variables:
      • value; string; The keyword used to find a plan review workflow task by matching with a description, record type, status, permit ID, and so on.
  • 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:
    • Address1; string; The first or main address of the permit applicant.
    • Address2; string; The second address of the permit applicant, if present.
    • AssignedBy; integer; The user who assigned the plan review cycle.
    • AssignedDttm; string; The date when the plan review cycle was assigned.
    • City; string; The city in the address of the permit applicant.
    • ContactPref; string; The contact preference of the permit applicant.
    • CoordinateX; number; The x-axis coordinate for the record parcel.
    • CoordinateY; number; The y-axis coordinate for the record parcel.
    • County; string; The county in the parcel address.
    • CycleCount; integer; The numbering for each plan review cycle.
    • CycleCountString; string; The numbering for each plan review cycle converted to a string.
    • DecisionDttm; string; The date when the decision was made on the plan review cycle.
    • Description; string; The permit record description.
    • LastUpdateDate; string; The date when the record was last updated.
    • LnpRecordId; string; The unique identifier for a permit. This identifier is automatically generated based on the rules configured for the record type.
    • 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.
    • PersonName; string; The name of the person who completed the application process.
    • PhoneNumber; string; The phone number of the permit applicant.
    • 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.
    • PlanReviewUserKey; integer; The unique identifier for a plan review cycle reviewer.
    • PostalCode; string; The postal code in the parcel address.
    • PostalPlus4Code; string; The extended postal code in the parcel address.
    • Province; string; The province in the parcel address.
    • RecordType; string; The user-friendly name for the permit type. For example, a residential addition.
    • ReviewStatusHdr; string; The review status description for the plan review cycle.
    • ReviewStatusReviewer; string; The review status description for the plan reviewer.
    • ReviewerDueDate; string; The date by which a plan reviewer must complete a plan review.
    • ReviewerId; integer; The person ID of the reviewer for the plan review cycle.
    • State; string; The state in the parcel address.
    • Status; string; The record status.
    • StreetDirection; string; The street direction in an address search. Values are compass directions, such as N, S, E, W, NW, SE, and so on. For example, they can be used to find all parcels with an address that is north of the city center.
    • StreetName; string; The street name in the parcel address used during a search.
    • StreetNameConcat; string; The concatenated value of Street Direction, Street Name, Street Type, and Street Suffix.
    • StreetNumber; string; The street number in the parcel address.
    • StreetNumberAlpha; string; The street number in the parcel address used for sort when the content is alphanumeric.
    • StreetNumberNumeric; integer; The street number in the parcel address used for sort when the content is numeric.
    • StreetSuffix; string; The street suffix that further describes that street, For example Drive, Avenue and so on.
    • StreetType; string; The street type designation used during a search. For example, alley, boulevard, avenue, lane, street, loop, and so on.
    • SystemStatus; string; The predefined system status to which the record status maps.
    • SystemStatusHdr; string; The review status for the plan review cycle.
    • SystemStatusReviewer; string; The review status for the plan reviewer.
    • UnitNumber; string; The exact unit in a building used in an address search. For example, Apartment 208A or Suite 300.
  • 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 : publicSectorPlanReviewWorkFlowTasks
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : publicSectorPlanReviewWorkFlowTasks-item-response
Type: object
Show Source
Back to Top