Get a plan review workflow task
get
/fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewWorkFlowTasks/{publicSectorPlanReviewWorkFlowTasksUniqID}
Request
Path Parameters
-
publicSectorPlanReviewWorkFlowTasksUniqID(required): string
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 fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields 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 fields 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 fields. 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 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 -
links: string
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
-
Metadata-Context:
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".
-
REST-Framework-Version:
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 TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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".
-
REST-Framework-Version(required):
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.
Root Schema : publicSectorPlanReviewWorkFlowTasks-item-response
Type:
Show Source
object
-
Address1: string
Read Only:
true
Maximum Length:240
The first or main address of the permit applicant. -
Address2: string
Read Only:
true
Maximum Length:240
The second address of the permit applicant, if present. -
AssignedBy: integer
(int64)
Read Only:
true
The user who assigned the plan review cycle. -
AssignedDttm: string
(date-time)
Read Only:
true
The date when the plan review cycle was assigned. -
City: string
Read Only:
true
Maximum Length:60
The city in the address of the permit applicant. -
ContactPref: string
Read Only:
true
Maximum Length:1
The contact preference of the permit applicant. -
CoordinateX: number
Read Only:
true
The x-axis coordinate for the record parcel. -
CoordinateY: number
Read Only:
true
The y-axis coordinate for the record parcel. -
County: string
Read Only:
true
Maximum Length:60
The county in the parcel address. -
CycleCount: integer
(int32)
Read Only:
true
The numbering for each plan review cycle. -
CycleCountString: string
Read Only:
true
Maximum Length:40
The numbering for each plan review cycle converted to a string. -
DecisionDttm: string
(date-time)
Read Only:
true
The date when the decision was made on the plan review cycle. -
Description: string
Read Only:
true
Maximum Length:1000
The permit record description. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the record was last updated. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LnpRecordId: string
Read Only:
true
Maximum Length:50
The unique identifier for a permit. This identifier is automatically generated based on the rules configured for the record type. -
LnpRecordKey: integer
(int64)
Read Only:
true
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
Read Only:
true
Maximum Length:450
The name of the person who completed the application process. -
PhoneNumber: string
Read Only:
true
Maximum Length:60
The phone number of the permit applicant. -
PlanReviewKey: integer
(int64)
Read Only:
true
The unique identifier for a plan review cycle. -
PlanReviewName: string
Read Only:
true
Maximum Length:255
The name of the plan review. -
PlanReviewType: string
Read Only:
true
Maximum Length:11
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
(int64)
Read Only:
true
The unique identifier for a plan review cycle reviewer. -
PostalCode: string
Read Only:
true
Maximum Length:60
The postal code in the parcel address. -
PostalPlus4Code: string
Read Only:
true
Maximum Length:10
The extended postal code in the parcel address. -
Province: string
Read Only:
true
Maximum Length:60
The province in the parcel address. -
RecordType: string
Read Only:
true
Maximum Length:100
The user-friendly name for the permit type. For example, a residential addition. -
ReviewerDueDate: string
(date-time)
Read Only:
true
The date by which a plan reviewer must complete a plan review. -
ReviewerId: integer
(int64)
Read Only:
true
The person ID of the reviewer for the plan review cycle. -
ReviewStatusHdr: string
Read Only:
true
Maximum Length:30
The review status description for the plan review cycle. -
ReviewStatusReviewer: string
Read Only:
true
Maximum Length:30
The review status description for the plan reviewer. -
State: string
Read Only:
true
Maximum Length:60
The state in the parcel address. -
Status: string
Read Only:
true
Maximum Length:15
The record status. -
StreetDirection: string
Read Only:
true
Maximum Length:10
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
Read Only:
true
Maximum Length:240
The street name in the parcel address used during a search. -
StreetNameConcat: string
Read Only:
true
Maximum Length:350
The concatenated value of Street Direction, Street Name, Street Type, and Street Suffix. -
StreetNumber: string
Read Only:
true
Maximum Length:20
The street number in the parcel address. -
StreetNumberAlpha: string
Read Only:
true
Maximum Length:20
The street number in the parcel address used for sort when the content is alphanumeric. -
StreetNumberNumeric: integer
(int64)
Read Only:
true
The street number in the parcel address used for sort when the content is numeric. -
StreetSuffix: string
Read Only:
true
Maximum Length:20
The street suffix that further describes that street, For example Drive, Avenue and so on. -
StreetType: string
Read Only:
true
Maximum Length:20
The street type designation used during a search. For example, alley, boulevard, avenue, lane, street, loop, and so on. -
SystemStatus: string
Read Only:
true
Maximum Length:15
The predefined system status to which the record status maps. -
SystemStatusHdr: string
Read Only:
true
Maximum Length:15
The review status for the plan review cycle. -
SystemStatusReviewer: string
Read Only:
true
Maximum Length:15
The review status for the plan reviewer. -
UnitNumber: string
Read Only:
true
Maximum Length:30
The exact unit in a building used in an address search. For example, Apartment 208A or Suite 300.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.