Get all attachments for a permit
get
/fscmRestApi/resources/11.13.18.05/publicSectorRecordAttachments
Request
Query Parameters
-
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 fields. Only the specified fields are returned, which means that if no fields are specified, no fields 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 fields. 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:- AltKey: The public unique identifier for a permit attachment.
Finder Variables:- LnpAttachmentPuid; string.
- PrimaryKey: Finds the record attachment that matches the primary key criteria specified.
Finder Variables:- AttachmentId; integer.
- LnpAttachmentKey; integer; The unique identifier of the permit attachment.
- simpleSearchFinder: Finds the permit attachment that matches the search criteria specified.
Finder Variables:- attachmentIdValue; integer; The search value used to find a record attachment for a given attachment ID.
- attachmentKeyValue; integer; The search value used to find a record attachment for a given attachment key.
- fileTypeValue; string; The search value used to find a record attachment for a given file type.
- lnpRecordKeyValue; integer; The search value used to find a record attachment for a given record key.
- value; string; The search value used to find a specific record attachment.
- AltKey: The public unique identifier for a permit attachment.
-
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.
-
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
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 fields. 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
You can use these queryable attributes to filter this collection resource using the q query parameter:- AgencyId; integer; The agency identifier of the public sector entity to which this attachment applies.
- AttachmentEntityName; string; The entity name of the attachment.
- AttachmentId; integer; The unique identifier for a permit attachment.
- AttachmentType; string; The type of attachment, such as for plan reviews, inspections, or permits.
- CreatedByName; string; The user who created the attachment.
- CreationDate; string; The date and time when the attachment was created.
- Description; string; The description of the attachment.
- DigitalSignatureFlag; boolean; Indicates whether the attachment requires a digital signature. If the value is Y, then a digital signature is required. The default value is N.
- DocumentCategory; string; The category used for dividing the attached document into a logical group.
- DocumentGroupId; string; The document group specified on the permit type when the attachment was uploaded.
- DocumentReviewedFlag; boolean; Indicates whether the attachment was reviewed and returned by the electronic document review application. The default value is N.
- DocumentSubcategory; string; The subcategory used for dividing the attached document into a logical group along with the category.
- FileName; string; The name of the attached file.
- FileSize; integer; The size of the attached file.
- FileType; string; The file type of attachment, such as PDF or text.
- FinalDocumentFlag; boolean; Indicates whether the attachment is the final document for a permit, business license, or planning application. The default value is N for no.
- LastUpdateDate; string; The date and time when the attachment was last updated.
- LnpAttachmentKey; integer; The unique key associated with the permit attachment.
- LnpAttachmentPuid; string; The public unique identifier for a permit attachment.
- LnpRecordKey; integer; 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.
- PlanReviewFlag; boolean; 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.
- PreviewHeight; number; This column indicates the height of a stored thumbnail.
- PreviewWidth; number; This column indicates the width of a stored thumbnail.
- ProtectionLevel; string; Indicates whether the attachment has some level of protection and what type of protection. The default value is N for None.
- RecordAgencyId; integer; The agency identifier of the public sector entity to which this attachment applies.
- RecordAttachmentId; integer; The unique identifier for an attachment.
- RecordNumber; string; The public unique identifier for a permit record.
- RevisedDocUploadedFlag; boolean; Indicates whether the attachment was uploaded during a rejected or approved plan review cycle. Default value is N for no.
- SubjectId; string; The subject of the attachment.
- UpdatedByName; string; The user who last updated the attachment.
- Version; integer; The version of the attachment.
- WriteProtectedFlag; boolean; Indicates whether the attachment is write-protected. The default value is N for no.
-
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".
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version(required):
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : publicSectorRecordAttachments
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
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: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorRecordAttachments-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Title:
Agency ID
Default Value:1
The agency identifier of the public sector entity to which this attachment applies. -
AttachmentEntityName: string
Maximum Length:
255
Default Value:PSC_DOC_LNP
The entity name of the attachment. -
AttachmentId: integer
(int64)
The unique identifier for a permit attachment.
-
AttachmentType: string
Maximum Length:
15
Default Value:LNP
The type of attachment, such as for plan reviews, inspections, or permits. -
CopyByReferenceFlag: string
Indicates that the attachment is being created as a copy from an existing attachment. The default value is N for No.
-
CreatedByName: string
Title:
Uploaded By
The user who created the attachment. -
CreationDate: string
(date-time)
Title:
Uploaded On
Read Only:true
The date and time when the attachment was created. -
Description: string
Title:
Description
Maximum Length:100
The description of the attachment. -
DigitalSignatureFlag: boolean
Maximum Length:
1
Default Value:false
Indicates whether the attachment requires a digital signature. If the value is Y, then a digital signature is required. The default value is N. -
DocumentCategory: string
Title:
Category
Maximum Length:30
The category used for dividing the attached document into a logical group. -
DocumentGroupId: string
Maximum Length:
30
The document group specified on the permit type when the attachment was uploaded. -
DocumentReviewedFlag: boolean
Maximum Length:
1
Default Value:false
Indicates whether the attachment was reviewed and returned by the electronic document review application. The default value is N. -
DocumentSubcategory: string
Title:
Subcategory
Maximum Length:30
The subcategory used for dividing the attached document into a logical group along with the category. -
FileName: string
Title:
File Name
Maximum Length:255
The name of the attached file. -
FileSize: integer
(int64)
Title:
File Size
The size of the attached file. -
FileType: string
Maximum Length:
100
The file type of attachment, such as PDF or text. -
FinalDocumentFlag: boolean
Title:
Final
Maximum Length:1
Default Value:false
Indicates whether the attachment is the final document for a permit, business license, or planning application. The default value is N for no. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the attachment was last updated. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LnpAttachmentAccessor: array
Record Attachment Accessors
Title:
Record Attachment Accessors
The record attachment accessors resource is used for displaying permit attachment file-related information such as file name and file URL. -
LnpAttachmentKey: integer
(int64)
The unique key associated with the permit attachment.
-
LnpAttachmentPuid: string
Maximum Length:
480
The public unique identifier for a permit attachment. -
LnpRecordKey: 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.
-
PlanReviewFlag: boolean
Maximum Length:
1
Default Value:false
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. -
Preview: string
(byte)
This column contains the thumbnail of an attached file.
-
PreviewHeight: number
This column indicates the height of a stored thumbnail.
-
PreviewWidth: number
This column indicates the width of a stored thumbnail.
-
ProtectionLevel: string
Maximum Length:
1
Default Value:N
Indicates whether the attachment has some level of protection and what type of protection. The default value is N for None. -
RecordAgencyId: integer
(int32)
The agency identifier of the public sector entity to which this attachment applies.
-
RecordAttachmentId: integer
(int64)
The unique identifier for an attachment.
-
RecordNumber: string
Maximum Length:
64
The public unique identifier for a permit record. -
RevisedDocUploadedFlag: boolean
Maximum Length:
1
Default Value:false
Indicates whether the attachment was uploaded during a rejected or approved plan review cycle. Default value is N for no. -
SourceAttachmentId: integer
The unique identifier of the source attachment, if the attachment is being created as a copy.
-
SourceEntityName: string
The attachment type of the source attachment, if the attachment is being created as a copy.
-
SubjectId: string
Maximum Length:
30
The subject of the attachment. -
UpdatedByName: string
Title:
Last Updated By
The user who last updated the attachment. -
Version: integer
(int32)
The version of the attachment.
-
WriteProtectedFlag: boolean
Maximum Length:
1
Default Value:false
Indicates whether the attachment is write-protected. The default value is N for no.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Record Attachment Accessors
Type:
array
Title:
Record Attachment Accessors
The record attachment accessors resource is used for displaying permit attachment file-related information such as file name and file URL.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : publicSectorRecordAttachments-LnpAttachmentAccessor-item-response
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
The attribute provided for exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
The unique identifier for an attachment. -
AttachmentsRevision: array
Record Attachment Revisions
Title:
Record Attachment Revisions
The record attachments revisions resource is used for displaying the historical information for a permit attachment. -
CategoryName: 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: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
The user who created the attachment. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
The user who created the attachment. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the attachment was created. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
The datatype code of the attachment. -
Description: string
Title:
Description
Maximum Length:255
The description of the attachment. -
DmDocumentId: string
Maximum Length:
255
The document ID from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
The folder path of the attachment file. -
DmVersionNumber: string
Maximum Length:
255
The document version number from which the attachment is created. -
DownloadInfo: string
Title:
DownloadInfo
The JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
The code that indicates the error status of the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
The message that describes the error status of the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
The date of expiration of the attachment. -
FileContents: string
(byte)
Title:
File Contents
The file contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
The name of the attached file. -
FileUrl: string
Title:
File Url
The URL or web address of the attached file. -
FileWebImage: string
(byte)
Title:
File Web Image
Read Only:true
The base64 encoded image of the file displayed in PNG format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date and time when the attachment was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
The user who last updated the attachment. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
The user who last updated the attachment. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Title: string
Title:
Title
The title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
The content type of the attachment such as plain text or comma-separated value format. -
UploadedFileLength: integer
Title:
File Size
The file length of the attachment in bytes. -
UploadedFileName: string
Title:
Uploaded File Name
The name of the attached file. -
UploadedText: string
Title:
Uploaded Text
The text that is entered along with the attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
The type of universal resource identifier (URI) associated with the attachment. For example, URL. -
Url: string
Title:
Url
Maximum Length:4000
The URL associated with an attachment. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
The user's unique user name for logging into the system.
Nested Schema : Record Attachment Revisions
Type:
array
Title:
Record Attachment Revisions
The record attachments revisions resource is used for displaying the historical information for a permit attachment.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorRecordAttachments-LnpAttachmentAccessor-AttachmentsRevision-item-response
Type:
Show Source
object
-
AttachedDocumentId: string
Read Only:
true
The unique identifier of an attached document. -
ContentId: string
Maximum Length:
80
The unique identifier of the attachment content. -
ErrorStatusCode: string
The code that indicates the error status of the attachment.
-
ErrorStatusMessage: string
The message that describes the error status of the attachment.
-
FileUrl: string
The web address for an attached file.
-
Format: string
Maximum Length:
128
The format of the attachment. -
InDate: string
(date-time)
The date when the file was attached.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
RevisionId: string
Maximum Length:
80
The unique identifier of the attachment revision. -
RevLabel: string
Maximum Length:
80
The label for an attachment revision. -
UserRevisionId: integer
The unique identifier for an attachment revision.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source