Get a permit plan review coordinator attachment communications item
get
/fscmRestApi/resources/11.13.18.05/publicSectorPermitPlanCoordinatorAttachmentCommunications/{publicSectorPermitPlanCoordinatorAttachmentCommunicationsUniqID}
Request
Path Parameters
-
publicSectorPermitPlanCoordinatorAttachmentCommunicationsUniqID: integer
This is the hash key of the attributes which make up the composite key--- LnpRecordKey and AttachmentId ---for the Permit Plan Review Coordinator Attachment Communications resource and used to uniquely identify an instance of Permit Plan Review Coordinator Attachment Communications. The client should not generate the hash key value. Instead, the client should query on the Permit Plan Review Coordinator Attachment Communications collection resource with a filter on the primary key values in order to navigate to a specific instance of Permit Plan Review Coordinator Attachment Communications.
For example: publicSectorPermitPlanCoordinatorAttachmentCommunications?q=LnpRecordKey=<value1>;AttachmentId=<value2>
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 : publicSectorPermitPlanCoordinatorAttachmentCommunications-item
Type:
Show Source
object-
Address1(optional):
string
Title:
Address Line 1Maximum Length:240The first or main address. -
Address2(optional):
string
Title:
Address Line 2Maximum Length:240The second address, if present. -
ApplicantId(optional):
integer(int64)
The party ID of the person applying for a permit.
-
ApplicantName(optional):
string
Title:
Applicant NameMaximum Length:450The name of the applicant. -
AttachmentId(optional):
integer(int64)
The unique identifer for a permit attachment.
-
City(optional):
string
Title:
CityMaximum Length:60The city in the parcel address. -
Country(optional):
string
Title:
CountryMaximum Length:3The country in the address. -
County(optional):
string
Title:
CountyMaximum Length:60The county in the parcel address. -
CreatedBy(optional):
string
Maximum Length:
64The user who created the plan review cycle. -
CreationDate(optional):
string(date-time)
Title:
Uploaded OnThe date and time when the attachment was created. -
CycleCount(optional):
integer(int32)
The numbering for each plan review cycle.
-
CycleDays(optional):
integer(int32)
The number of days that the plan review cycle was open or in progress.
-
DocCategory(optional):
string
Title:
Document CategoryMaximum Length:30The value that will be displayed for the document category related to an attachment. -
DocCategoryCode(optional):
string
Maximum Length:
30The unique identifier for the document category. -
DocSubcategory(optional):
string
Title:
Document SubcategoryMaximum Length:30The value that will be displayed for document subcategory related to an attachment. -
DocSubcategoryCode(optional):
string
Maximum Length:
30The unique identifier for the document subcategory. -
ElectronicPlanReview(optional):
string
Maximum Length:
1Indicates whether the plan review has been performed for a document attachment. The default value is N for no. -
FileDescription(optional):
string
Title:
File DescriptionMaximum Length:100The description of the attachment. -
FileName(optional):
string
Title:
File NameMaximum Length:255The name of the attached file. -
FileSize(optional):
integer(int64)
Title:
File SizeThe size of the attached file. -
FileType(optional):
string
Title:
File TypeMaximum Length:100The file type of attachment, such as PDF or text. -
links(optional):
array Items
Title:
ItemsLink Relations -
LnpRecordId(optional):
string
Title:
PermitMaximum Length:50The permit record identifier. -
LnpRecordKey(optional):
integer(int64)
The unique identifer for a permit.
-
PermitDescription(optional):
string
Title:
Permit DescriptionMaximum Length:1000The permit description. -
PermitStatus(optional):
string
Title:
Permit StatusMaximum Length:15The permit status. -
PermitStatusCode(optional):
string
Maximum Length:
15The permit status code. -
PlanCoordinatorDisplayName(optional):
string
The display name of plan coordinators as seen within the PSCR application.
-
PlanCoordinatorEmailAddress(optional):
string
The list of plan coordinator email addresses for which an email communication can be sent.
-
PlanCoordinatorUsername(optional):
string
The list of plan coordinator user ids for which an in-product notification communication can be sent.
-
PlanReviewDecision(optional):
string
Title:
Plan Review Cycle DecisionMaximum Length:35The decision status for the plan review cycle. -
PlanReviewDecisionCode(optional):
string
Maximum Length:
15The decision status code for the plan review cycle. -
PlanReviewId(optional):
string
Maximum Length:
12The plan review cycle record identifier. For example, a plan review ID with a value such as PLNR-1. -
PlanReviewName(optional):
string
Maximum Length:
100The name of the plan review. -
PlanReviewStatus(optional):
string
Maximum Length:
30The review status for the plan review cycle. -
PlanReviewStatusCode(optional):
string
Maximum Length:
15The review status code for the plan review cycle. -
PlanReviewType(optional):
string
Title:
Plan Review TypeMaximum Length:11The 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 CodeMaximum Length:60The postal code in the parcel address. -
Province(optional):
string
Title:
ProvinceMaximum Length:60The province in the parcel address. -
RecordType(optional):
string
Title:
Permit TypeMaximum Length:100The 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 DateThe date when the plan review cycle was closed. -
ReviewDueDate(optional):
string(date-time)
Title:
Plan Review Cycle Due DateThe 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 DateThe date when the plan review cycle was opened. -
State(optional):
string
Title:
StateMaximum Length:60The state in the parcel address.
Nested Schema : link
Type:
Show Source
object-
href(optional):
string
Title:
hyperlink referenceThe URI to the related resource. -
rel(optional):
string
Title:
relationThe name of the relation to the resource instance. Example: self.