Get all plan review workflow task
get
/fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewWorkFlowTasks
Request
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 -
finder: string
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:- 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.
- 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:
-
limit: integer
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.
-
offset: integer
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.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified attributes. 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
-
q: string
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 -
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Response
Supported Media Types
- application/vnd.oracle.adf.resourcecollection+json
Default Response
The following table describes the default response for this task.
Root Schema : publicSectorPlanReviewWorkFlowTasks
Type:
Show Source
object-
count(optional):
integer
Title:
CountThe number of resource instances returned in the current range. -
hasMore(optional):
boolean
Title:
HasMoreIndicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false. -
items(optional):
array Items
Title:
ItemsThe items in the collection. -
limit(optional):
integer
Title:
LimitThe actual paging size used by the server. -
links(optional):
array Items
Title:
ItemsThe link relations associated with the resource instance. -
offset(optional):
integer
Title:
OffsetThe offset value used in the current page.
Nested Schema : Items
Type:
arrayTitle:
ItemsThe link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorPlanReviewWorkFlowTasks-item
Type:
Show Source
object-
Address1(optional):
string
Maximum Length:
240The first or main address of the permit applicant. -
Address2(optional):
string
Maximum Length:
240The second address of the permit applicant, if present. -
AssignedBy(optional):
integer(int64)
The user who assigned the plan review cycle.
-
AssignedDttm(optional):
string(date-time)
The date when the plan review cycle was assigned.
-
City(optional):
string
Maximum Length:
60The city in the address of the permit applicant. -
ContactPref(optional):
string
Maximum Length:
1The contact preference of the permit applicant. -
CoordinateX(optional):
number
The x-axis coordinate for the record parcel.
-
CoordinateY(optional):
number
The y-axis coordinate for the record parcel.
-
County(optional):
string
Maximum Length:
60The county in the parcel address. -
CycleCount(optional):
integer(int32)
The numbering for each plan review cycle.
-
CycleCountString(optional):
string
Maximum Length:
40The numbering for each plan review cycle converted to a string. -
DecisionDttm(optional):
string(date-time)
The date when the decision was made on the plan review cycle.
-
Description(optional):
string
Maximum Length:
1000The permit record description. -
LastUpdateDate(optional):
string(date-time)
The date when the record was last updated.
-
links(optional):
array Items
Title:
ItemsLink Relations -
LnpRecordId(optional):
string
Maximum Length:
50The unique identifier for a permit. This identifier is automatically generated based on the rules configured for the record type. -
LnpRecordKey(optional):
integer(int64)
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(optional):
string
Maximum Length:
450The name of the person who completed the application process. -
PhoneNumber(optional):
string
Maximum Length:
60The phone number of the permit applicant. -
PlanReviewKey(optional):
integer(int64)
The unique identifier for a plan review cycle.
-
PlanReviewName(optional):
string
Maximum Length:
255The name of the plan review. -
PlanReviewType(optional):
string
Maximum Length:
11The type of plan review. For example, a plan review type for the first cycle is O for original or R for resubmittal. -
PlanReviewUserKey(optional):
integer(int64)
The unique identifier for a plan review cycle reviewer.
-
PostalCode(optional):
string
Maximum Length:
60The postal code in the parcel address. -
PostalPlus4Code(optional):
string
Maximum Length:
10The extended postal code in the parcel address. -
Province(optional):
string
Maximum Length:
60The province in the parcel address. -
RecordType(optional):
string
Maximum Length:
100The user-friendly name for the permit type. For example, a residential addition. -
ReviewerDueDate(optional):
string(date-time)
The date by which a plan reviewer must complete a plan review.
-
ReviewerId(optional):
integer(int64)
The person ID of the reviewer for the plan review cycle.
-
ReviewStatusHdr(optional):
string
Maximum Length:
30The review status description for the plan review cycle. -
ReviewStatusReviewer(optional):
string
Maximum Length:
30The review status description for the plan reviewer. -
State(optional):
string
Maximum Length:
60The state in the parcel address. -
Status(optional):
string
Maximum Length:
15The record status. -
StreetDirection(optional):
string
Maximum Length:
10The 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(optional):
string
Maximum Length:
240The street name in the parcel address used during a search. -
StreetNameConcat(optional):
string
Maximum Length:
350The concatenated value of Street Direction, Street Name, Street Type, and Street Suffix. -
StreetNumber(optional):
string
Maximum Length:
20The street number in the parcel address. -
StreetNumberAlpha(optional):
string
Maximum Length:
20The street number in the parcel address used for sort when the content is alphanumeric. -
StreetNumberNumeric(optional):
integer(int64)
The street number in the parcel address used for sort when the content is numeric.
-
StreetSuffix(optional):
string
Maximum Length:
20The street suffix that further describes that street, For example Drive, Avenue and so on. -
StreetType(optional):
string
Maximum Length:
20The street type designation used during a search. For example, alley, boulevard, avenue, lane, street, loop, and so on. -
SystemStatus(optional):
string
Maximum Length:
15The predefined system status to which the record status maps. -
SystemStatusHdr(optional):
string
Maximum Length:
15The review status for the plan review cycle. -
SystemStatusReviewer(optional):
string
Maximum Length:
15The review status for the plan reviewer. -
UnitNumber(optional):
string
Maximum Length:
30The exact unit in a building used in an address search. For example, Apartment 208A or Suite 300.
Nested Schema : link
Type:
Show Source
object-
href(optional):
string
Title:
hyperlink referenceThe URI to the related resource. -
rel(optional):
string
Title:
relationThe name of the relation to the resource instance. Example: self.