Get all permit plan review attachment communication items
get
/fscmRestApi/resources/11.13.18.05/publicSectorPermitPlanReviewAttachmentCommunications
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 permit plan review attachment communication item using the specified permit plan review attachment identifiers. Finder Variables:
- AttachmentId; integer; The unique identifier of the permit plan review attachment communication.
- LnpRecordKey; integer; The unique identifier of the application to which the permit plan review attachment communication belongs.
- PrimaryKey: Finds a permit plan review attachment communication item using the specified permit plan review attachment 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 : publicSectorPermitPlanReviewAttachmentCommunications
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 : publicSectorPermitPlanReviewAttachmentCommunications-item
Type:
Show Source
object
-
Address1(optional):
string
Title:
Address Line 1
Maximum Length:240
The first or main address. -
Address2(optional):
string
Title:
Address Line 2
Maximum Length:240
The second address, if present. -
ApplicantId(optional):
integer(int64)
The party ID of the person applying for a permit.
-
ApplicantName(optional):
string
Title:
Applicant Name
Maximum Length:450
The name of the applicant. -
AttachmentId(optional):
integer(int64)
The unique identifer for a permit attachment.
-
City(optional):
string
Title:
City
Maximum Length:60
The city in the parcel address. -
Country(optional):
string
Title:
Country
Maximum Length:3
The country in the address. -
County(optional):
string
Title:
County
Maximum Length:60
The county in the parcel address. -
CreationDate(optional):
string(date-time)
Title:
Uploaded On
The date and time when the attachment was created. -
CycleCount(optional):
integer(int32)
The numbering for each plan review cycle.
-
CycleDays(optional):
integer(int32)
Title:
Plan Review Cycle Days
The number of days that the plan review cycle was open or in progress. -
DocCategory(optional):
string
Title:
Document Category
Maximum Length:30
The value that will be displayed for the document category related to an attachment. -
DocCategoryCode(optional):
string
Maximum Length:
30
The unique identifier for the document category. -
DocSubcategory(optional):
string
Title:
Document Subcategory
Maximum Length:30
The value that will be displayed for document subcategory related to an attachment. -
DocSubcategoryCode(optional):
string
Maximum Length:
30
The unique identifier for the document subcategory. -
ElectronicPlanReview(optional):
string
Maximum Length:
1
Indicates whether the plan review has been performed for a document attachment. The default value is N for no. -
FileDescription(optional):
string
Title:
File Description
Maximum Length:100
The description of the attachment. -
FileName(optional):
string
Title:
File Name
Maximum Length:255
The name of the attached file. -
FileSize(optional):
integer(int64)
Title:
File Size
The size of the attached file. -
FileType(optional):
string
Title:
File Type
Maximum Length:100
The file type of attachment, such as PDF or text. -
links(optional):
array Items
Title:
Items
Link Relations -
LnpRecordId(optional):
string
Title:
Permit
Maximum Length:50
The permit record identifier. -
LnpRecordKey(optional):
integer(int64)
The unique identifer for a permit.
-
PermitDescription(optional):
string
Title:
Permit Description
Maximum Length:1000
The permit description. -
PermitStatus(optional):
string
Title:
Permit Status
Maximum Length:15
The permit status. -
PermitStatusCode(optional):
string
Maximum Length:
15
The permit status code. -
PlanReviewDecision(optional):
string
Title:
Plan Review Cycle Decision
Maximum Length:35
The decision status for the plan review cycle. -
PlanReviewDecisionCode(optional):
string
Maximum Length:
15
The decision status code for the plan review cycle. -
PlanReviewerEmailList(optional):
string
Title:
Plan Reviewer Email List
The list of plan reviewer email addresses for which an email communication can be sent. -
PlanReviewerUserIdList(optional):
string
Title:
Plan Reviewer User ID List
The list of plan reviewer user ids for which an in-product notification communication can be sent. -
PlanReviewId(optional):
string
Maximum Length:
12
The plan review cycle record identifier. For example, a plan review ID with a value such as PLNR-1. -
PlanReviewName(optional):
string
Maximum Length:
100
The name of the plan review. -
PlanReviewStatus(optional):
string
Maximum Length:
30
The review status for the plan review cycle. -
PlanReviewStatusCode(optional):
string
Maximum Length:
15
The review status code for the plan review cycle. -
PlanReviewType(optional):
string
Title:
Plan Review Type
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. -
PostalCode(optional):
string
Title:
Postal Code
Maximum Length:60
The postal code in the parcel address. -
Province(optional):
string
Title:
Province
Maximum Length:60
The province in the parcel address. -
RecordType(optional):
string
Title:
Permit Type
Maximum Length:100
The user-friendly name for the permit type. -
ReviewClosedBy(optional):
integer(int64)
The user who closed the plan review cycle.
-
ReviewClosedDttm(optional):
string(date-time)
Title:
Plan Review Closed Date
The date when the plan review cycle was closed. -
ReviewDueDate(optional):
string(date-time)
Title:
Plan Review Cycle Due Date
The date by which the plan review must be completed. -
ReviewOpenBy(optional):
integer(int64)
The user who opened the plan review cycle.
-
ReviewOpenDttm(optional):
string(date-time)
Title:
Plan Review Open Date
The date when the plan review cycle was opened. -
State(optional):
string
Title:
State
Maximum Length:60
The state in the parcel address.
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.