Get a plan reviewer for a permit plan review
get
/fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewers/{PlanReviewUserKey}
Request
Path Parameters
-
PlanReviewUserKey: integer
The unique identifier for a plan reviewer.
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 : publicSectorPlanReviewers-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int64)
The agency identifier of the public sector entity to which this plan reviewer applies.
-
AssignedBy(optional):
integer(int64)
The user who assigned the plan reviewer to the plan review cycle. Usually this is the plan coordinator.
-
AssignedDttm(optional):
string(date-time)
The date when the plan reviewer was assigned to the plan review cycle.
-
Decision(optional):
string
Maximum Length:
15
The decision code for the plan reviewer of a plan review cycle. For example, the decision code could be APPROVED. -
DecisionDttm(optional):
string(date-time)
The date when the decision was updated by the user. The user could be a plan reviewer or plan coordinator.
-
DepartmentId(optional):
string
Title:
Department
Maximum Length:30
The unique identifier for a plan reviewer department. This is a user-defined value. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated Date
The date and time when the plan reviewer decision was last updated. -
LastUpdatedBy(optional):
string
Title:
Last Updated By
Maximum Length:64
The user who last modified the plan reviewer decision. -
links(optional):
array Items
Title:
Items
Link Relations -
Override(optional):
string
Maximum Length:
1
Indicates whether the plan reviewer decision was overridden by the plan coordinator user or not. The default value is no. -
OverrideBy(optional):
integer(int64)
The user who the entered the override decision. Usually this is the plan coordinator.
-
OverrideDecision(optional):
string
Maximum Length:
15
The decision code when the plan reviewer decision was overridden by the plan coordinator. -
OverrideDttm(optional):
string(date-time)
The date and time when the plan reviewer decision was overridden.
-
PartyId(optional):
integer(int64)
The person party ID for the plan reviewer.
-
PlanReviewKey(optional):
integer(int64)
The unique identifier for a plan review cycle.
-
PlanReviewUserKey(optional):
integer(int64)
The unique identifier for a plan reviewer.
-
ReviewerDueDate(optional):
string(date-time)
The date by which the plan review must be completed by the reviewer.
-
ReviewerEmailId(optional):
integer(int64)
The email address for the plan reviewer.
-
ReviewerId(optional):
integer(int64)
The unique identifier for a plan reviewer.
-
ReviewStatus(optional):
string
Maximum Length:
15
The review status code for the plan reviewer of a plan review cycle. For example, the initial review status is IN PROGRESS. -
UserType(optional):
string
Maximum Length:
8
The user type for a plan reviewer. For example, I for an internal user, and E for an external user. An example of an external user could be a contractor.
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.