Get a permit attachment communications item
get
/fscmRestApi/resources/11.13.18.05/publicSectorPermitAttachmentCommunications/{publicSectorPermitAttachmentCommunicationsUniqID}
Request
Path Parameters
-
publicSectorPermitAttachmentCommunicationsUniqID: integer
This is the hash key of the attributes which make up the composite key--- LnpRecordKey and AttachmentId ---for the Permit Attachment Communications resource and used to uniquely identify an instance of Permit Attachment Communications. The client should not generate the hash key value. Instead, the client should query on the Permit Attachment Communications collection resource with a filter on the primary key values in order to navigate to a specific instance of Permit Attachment Communications.
For example: publicSectorPermitAttachmentCommunications?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 : publicSectorPermitAttachmentCommunications-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. -
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. -
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 the 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. -
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. -
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.