Get a plan review workflow task
get
/fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewWorkFlowTasks/{publicSectorPlanReviewWorkFlowTasksUniqID}
Request
Path Parameters
-
publicSectorPlanReviewWorkFlowTasksUniqID: integer
This is the hash key of the attributes which make up the composite key--- PlanReviewUserKey, PlanReviewKey and LnpRecordKey ---for the Plan Review Workflow Tasks resource and used to uniquely identify an instance of Plan Review Workflow Tasks. The client should not generate the hash key value. Instead, the client should query on the Plan Review Workflow Tasks collection resource with a filter on the primary key values in order to navigate to a specific instance of Plan Review Workflow Tasks.
For example: publicSectorPlanReviewWorkFlowTasks?q=PlanReviewUserKey=<value1>;PlanReviewKey=<value2>;LnpRecordKey=<value3>
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 : publicSectorPlanReviewWorkFlowTasks-item
Type:
Show Source
object
-
Address1(optional):
string
Maximum Length:
240
The first or main address of the permit applicant. -
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:
60
The city in the address of the permit applicant. -
ContactPref(optional):
string
Maximum Length:
1
The contact preference of the permit applicant. -
CycleCount(optional):
integer(int32)
The numbering for each plan review cycle.
-
DecisionDttm(optional):
string(date-time)
The date when the decision was made on the plan review cycle.
-
LastUpdateDate(optional):
string(date-time)
The date when the record was last updated.
-
links(optional):
array Items
Title:
Items
Link Relations -
LnpRecordId(optional):
string
Maximum Length:
50
The 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:
450
The name of the person who completed the application process. -
PhoneNumber(optional):
string
Maximum Length:
60
The phone number of the permit applicant. -
PlanReviewKey(optional):
integer(int64)
The unique identifier for a plan review cycle.
-
PlanReviewName(optional):
string
Maximum Length:
255
The name of the plan review. -
PlanReviewUserKey(optional):
integer(int64)
The unique identifier for a plan review cycle reviewer.
-
RecordType(optional):
string
Maximum Length:
100
The 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:
30
The review status description for the plan review cycle. -
ReviewStatusReviewer(optional):
string
Maximum Length:
30
The review status description for the plan reviewer. -
Status(optional):
string
Maximum Length:
15
The record status. -
SystemStatusHdr(optional):
string
Maximum Length:
15
The review status for the plan review cycle. -
SystemStatusReviewer(optional):
string
Maximum Length:
15
The review status for the plan reviewer.
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.