Get a permit attachment
get
/fscmRestApi/resources/11.13.18.05/publicSectorPermitAllAttachments/{publicSectorPermitAllAttachmentsUniqID}
Request
Path Parameters
-
publicSectorPermitAllAttachmentsUniqID: integer
This is the hash key of the attributes which make up the composite key--- AttachmentId and AttachmentKey ---for the All Permit Attachments resource and used to uniquely identify an instance of All Permit Attachments. The client should not generate the hash key value. Instead, the client should query on the All Permit Attachments collection resource with a filter on the primary key values in order to navigate to a specific instance of All Permit Attachments.
For example: publicSectorPermitAllAttachments?q=AttachmentId=<value1>;AttachmentKey=<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 : publicSectorPermitAllAttachments-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int64)
The agency identifier of the public sector entity to which this attachment applies.
-
Attachmententityname(optional):
string
Maximum Length:
11
The entity name of the attachment. -
AttachmentId(optional):
integer(int64)
The unique identifier for a permit attachment.
-
AttachmentKey(optional):
integer(int64)
The unique identifier for the attachment.
-
AttachmentType(optional):
string
Maximum Length:
15
The type of attachment, such as for plan reviews, inspections, workflow, or permits. -
ChecklistId(optional):
string
Maximum Length:
15
The name that uniquely identifies an inspection checklist. -
ChecklistItemId(optional):
string
Maximum Length:
15
The name that uniquely identifies an inspection checklist item. -
CreatedBy(optional):
string
Maximum Length:
64
The user who created the attachment. -
CreationDate(optional):
string(date-time)
The date and time when the attachment was created.
-
Description(optional):
string
Title:
Description
Maximum Length:100
The description of the attachment. -
DocCategory(optional):
string
Maximum Length:
30
The category used for dividing the attached document into a logical group. -
DocGroupId(optional):
string
Maximum Length:
30
The document group specified on the permit type when the attachment was uploaded. -
DocSubcategory(optional):
string
Maximum Length:
30
The subcategory used for dividing the attached document into a logical group along with the category. -
DocumentReviewedFlag(optional):
string
Maximum Length:
1
Indicates whether the attachment was reviewed and returned by the electronic document review application. The default value is N. -
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
Maximum Length:
100
The file format of the attachment, such as PDF or text. -
InsChecklistId(optional):
string
Maximum Length:
60
The unique identifier of the inspection checklist. -
InschklistDescription(optional):
string
Maximum Length:
400
The description of an inspection checklist. -
InsChklstAgencyId(optional):
integer(int64)
The unique identifier of the agency associated with the inspection checklist attachment.
-
InspectionId(optional):
string
Maximum Length:
50
The unique identifier of the inspection. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated Date
The date and time when the attachment was last updated. -
LastUpdatedBy(optional):
string
Title:
Last Updated By
Maximum Length:64
The user who last updated the attachment. -
LastUpdateLogin(optional):
string
Maximum Length:
32
The login name of the user who last updated the attachment. -
links(optional):
array Items
Title:
Items
Link Relations -
LnpAllAttachmentAccessor(optional):
array All Permit Attachment Accessors
Title:
All Permit Attachment Accessors
The all permit attachments resource is used to view all attachments associated with the permit. This includes all attachments associated with plan reviews, inspections, and workflow associated with the permit. -
LnpRecordKey(optional):
integer(int64)
The unique identifier for a record. The record is for a permit, business license, professional license, or planning and zoning, and is determined by the classification.
-
ObjAgencyId(optional):
integer(int64)
The agency identifier of the public sector entity to which this attachment applies.
-
ObjAttachmentId(optional):
integer(int64)
The unique identifier for the attachment.
-
ObjectVersionNumber(optional):
integer(int32)
The object version number for the attachment.
-
PlanReviewFlag(optional):
string
Maximum Length:
1
Indicates whether the attachment is associated with a plan review. If the value is Y, then the attachment is associated with a plan review. The default value is N. -
SubjectId(optional):
string
Maximum Length:
30
The subject of the attachment. -
Version(optional):
integer(int32)
The version of the attachment.
Nested Schema : All Permit Attachment Accessors
Type:
array
Title:
All Permit Attachment Accessors
The all permit attachments resource is used to view all attachments associated with the permit. This includes all attachments associated with plan reviews, inspections, and workflow associated with the permit.
Show Source
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.
Nested Schema : publicSectorPermitAllAttachments-LnpAllAttachmentAccessor-item
Type:
Show Source
object
-
AsyncTrackerId(optional):
string
Title:
Asynchronous Upload Tracker Id
Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId(optional):
integer(int64)
Title:
Attached Document Id
The unique identifier for an attachment. -
AttachmentsRevision(optional):
array All Permit Attachment Revisions
Title:
All Permit Attachment Revisions
The all permit attachment accessors resource is used for displaying attachment file-related information such as file name and file URL. -
CategoryName(optional):
string
Title:
Category
Maximum Length:30
The unique name given to the permit attachment file-related information, which makes the attachment functionality work in conjunction with the entity name. - ContentRepositoryFileShared(optional): boolean
-
CreatedBy(optional):
string
Title:
Created By
Maximum Length:255
The user who created the attachment. -
CreatedByUserName(optional):
string
Title:
Created By User Name
The user who created the attachment. -
CreationDate(optional):
string(date-time)
Title:
Creation Date
The date and time when the attachment was created. -
DatatypeCode(optional):
string
Title:
Type
Maximum Length:30
The datatype code of the attachment. -
Description(optional):
string
Title:
Description
Maximum Length:255
The description of the attachment. -
DmDocumentId(optional):
string
Maximum Length:
255
The unique identifier for an attachment. -
DmFolderPath(optional):
string
Title:
Dm Folder Path
Maximum Length:1000
The folder path of the attachment file. -
DmVersionNumber(optional):
string
Maximum Length:
255
The version for an attachment. -
ErrorStatusCode(optional):
string
Title:
Error Status Code
The code that indicates the error status of the attachment. -
ErrorStatusMessage(optional):
string
Title:
Error Status Message
The message that describes the error status of the attachment. -
ExpirationDate(optional):
string(date-time)
Title:
Expiration Date
The date of expiration of the attachment. -
FileContents(optional):
string(binary)
Title:
File Contents
The file contents of the attachment. -
FileName(optional):
string
Title:
File Name
Maximum Length:2048
The name of the attached file. -
FileUrl(optional):
string
Title:
File Url
The URL or web address of the attached file. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Update Date
The date and time when the attachment was last updated. -
LastUpdatedBy(optional):
string
Title:
Last Updated By
Maximum Length:255
The user who last updated the attachment. -
LastUpdatedByUserName(optional):
string
Title:
Last Updated By User
The user who last updated the attachment. -
links(optional):
array Items
Title:
Items
Link Relations -
Title(optional):
string
Title:
Title
The title of the attachment. -
UploadedFileContentType(optional):
string
Title:
Uploaded File Content Type
The content type of the attachment such as plain text or comma-separated value format. -
UploadedFileLength(optional):
integer(int64)
Title:
File Size
The file length of the attachment in bytes. -
UploadedFileName(optional):
string
Title:
Uploaded File Name
The name of the attached file. -
UploadedText(optional):
string
Title:
Uploaded Text
The text that is entered along with the attachment. -
Uri(optional):
string
Title:
Uri
Maximum Length:4000
The type of universal resource identifier (URI) associated with the attachment. For example, URL. -
Url(optional):
string
Title:
Url
Maximum Length:4000
The URL associated with an attachment. -
UserName(optional):
string
Title:
User Name
Maximum Length:255
The user's unique user name for logging into the system.
Nested Schema : All Permit Attachment Revisions
Type:
array
Title:
All Permit Attachment Revisions
The all permit attachment accessors resource is used for displaying attachment file-related information such as file name and file URL.
Show Source
Nested Schema : publicSectorPermitAllAttachments-LnpAllAttachmentAccessor-AttachmentsRevision-item
Type:
Show Source
object
-
AttachedDocumentId(optional):
integer(int64)
The unique identifier of an attached document.
-
ErrorStatusCode(optional):
string
The code that indicates the error status of the attachment.
-
ErrorStatusMessage(optional):
string
The message that describes the error status of the attachment.
-
FileUrl(optional):
string
The web address for an attached file.
-
links(optional):
array Items
Title:
Items
Link Relations