Get all plan review workflow communication items
get
/fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewCommunications
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:- PrimaryKey: Finds a plan review communication item using the specified plan review identifiers. Finder Variables:
- LnpRecordKey; integer; The unique identifier of the permit to which the plan review belongs.
- PlanReviewKey; integer; The unique identifier of the plan review cycle.
- PrimaryKey: Finds a plan review communication item using the specified plan review identifiers. 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 : publicSectorPlanReviewCommunications
Type:
Show Source
object
-
count(optional):
integer
Title:
Count
The number of resource instances returned in the current range. -
hasMore(optional):
boolean
Title:
HasMore
Indicates 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:
Items
The items in the collection. -
limit(optional):
integer
Title:
Limit
The actual paging size used by the server. -
links(optional):
array Items
Title:
Items
The link relations associated with the resource instance. -
offset(optional):
integer
Title:
Offset
The offset value used in the current page.
Nested Schema : Items
Type:
array
Title:
Items
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorPlanReviewCommunications-item
Type:
Show Source
object
-
AgencyName(optional):
string
Maximum Length:
100
The agency name of the public sector entity to which this plan review communication applies. -
Applicant(optional):
integer(int64)
The unique identifer for an applicant.
-
ApplicantUsername(optional):
string
The user ID for an applicant.
-
CreatedBy(optional):
string
Maximum Length:
64
The user who created the plan review cycle. -
CycleCount(optional):
integer(int32)
The number specifying each plan review cycle.
-
Decision(optional):
string
Maximum Length:
15
The decision status for the plan review cycle. -
EmailAddress1(optional):
string
Maximum Length:
320
The email address for the applicant. -
links(optional):
array Items
Title:
Items
Link Relations -
LnpRecordId(optional):
string
Title:
Permit
Maximum Length:255
The permit record identifier. -
LnpRecordKey(optional):
integer(int64)
The unique identifer for a permit record.
-
PccEmail(optional):
string
The email address for the plan coordinator.
-
PccName(optional):
string
The name of the plan coordinator.
-
PersonName(optional):
string
Maximum Length:
450
The name of the applicant. -
PlanReviewKey(optional):
integer(int64)
The unique identifer for a plan review cycle.
-
PlanReviewName(optional):
string
Maximum Length:
100
The name of the plan review. -
RecordType(optional):
string
Title:
Permit Type
Maximum Length:100
The type of permit. For example, a residential addition. -
ReviewClosedDttm(optional):
string(date-time)
The date when the plan review cycle was closed.
-
ReviewOpenBy(optional):
integer(int64)
The user who opened the plan review cycle.
-
ReviewStatus(optional):
string
Maximum Length:
15
The review status for the plan review cycle.
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.