Get an attachment for a business license
get
/fscmRestApi/resources/11.13.18.05/publicSectorBlActivityAttachments/{publicSectorBlActivityAttachmentsUniqID}
Request
Path Parameters
-
publicSectorBlActivityAttachmentsUniqID(required): string
This is the hash key of the attributes which make up the composite key--- AttachmentId and LnpAttachmentKey ---for the BL Activity Attachments resource and used to uniquely identify an instance of BL Activity Attachments. The client should not generate the hash key value. Instead, the client should query on the BL Activity Attachments collection resource with a filter on the primary key values in order to navigate to a specific instance of BL Activity Attachments.
For example: publicSectorBlActivityAttachments?q=AttachmentId=<value1>;LnpAttachmentKey=<value2>
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields 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 fields 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 fields. 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 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 -
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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:
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.
Root Schema : publicSectorBlActivityAttachments-item-response
Type:
Show Source
object
-
Address1: string
Title:
Address Line 1
Read Only:true
Maximum Length:240
The first or main address. -
Address2: string
Title:
Address Line 2
Read Only:true
Maximum Length:240
The second address, if present. -
AgencyId: integer
(int32)
Title:
Agency ID
Read Only:true
The agency identifier of the public sector entity to which this attachment applies. -
Attachmententityname: string
Read Only:
true
Maximum Length:11
The entity name of the attachment. -
AttachmentId: integer
Read Only:
true
The unique identifier for a business license attachment. -
AttachmentType: string
Read Only:
true
Maximum Length:15
The type of attachment. -
BlBusDbaBusinessName: string
Read Only:
true
Maximum Length:240
The doing business as name for the business from business location. -
BlLocationId: string
Read Only:
true
Maximum Length:50
The location identifier of the business location. -
BlLocationKey: integer
(int64)
Read Only:
true
The unique location identifier of the business location. -
BusBusinessLegalName: string
Read Only:
true
Maximum Length:240
A legal name of the business entity. -
BusDbaBusinessName: string
Read Only:
true
Maximum Length:100
The doing business as name for the business. -
BusinessEntityId: string
Read Only:
true
Maximum Length:50
Meaningful identifier for the business entity. -
BusinessEntityKey: integer
(int64)
Read Only:
true
The unique identifier for the business entity. -
City: string
Title:
City
Read Only:true
Maximum Length:60
The city portion of the business address. -
ConfidentialFlag: boolean
Read Only:
true
Maximum Length:1
Indicates whether the attachment is a confidential document. -
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
Read Only:true
Maximum Length:100
The description of the attachment. -
DigitalSignatureFlag: string
Read Only:
true
Maximum Length:1
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
Read Only:true
Maximum Length:30
The category used for dividing the attached document into a logical group. -
DocumentGroupId: string
Read Only:
true
Maximum Length:30
The document group specified on the permit type when the attachment was uploaded. -
DocumentReviewedFlag: string
Read Only:
true
Maximum Length:1
Indicates whether the attachment was reviewed and returned by the electronic document review application. The default value is N. -
DocumentSubcategory: string
Title:
Subcategory
Read Only:true
Maximum Length:30
The subcategory used for dividing the attached document into a logical group along with the category. -
FileName: string
Title:
File Name
Read Only:true
Maximum Length:255
The name of the attached file. -
FileSize: integer
(int64)
Title:
File Size
Read Only:true
The size of the attached file. -
FileType: string
Read Only:
true
Maximum Length:100
The file type of attachment, such as PDF or text. -
FinalDocumentFlag: string
Title:
Final
Read Only:true
Maximum Length:1
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. -
LicensePeriod: string
Read Only:
true
Maximum Length:100
The period that applies to the transaction. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LnpAttachmentAccessor: array
Attachments
Title:
Attachments
The attachment resource is used to view, create, and update attachments. -
LnpAttachmentKey: integer
(int64)
Read Only:
true
The unique key associated with the business license attachment. -
LnpAttachmentPuid: string
Read Only:
true
Maximum Length:480
The public unique identifier for a business license attachment. -
LnpRecordId: string
Title:
Record ID
Read Only:true
Maximum Length:50
The unique identifier for an application record. This identifier is automatically generated based on the rules configured for the record type. -
LnpRecordKey: integer
(int64)
Title:
Record
Read Only:true
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: string
Read Only:
true
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. -
PostalCode: string
Title:
Postal Code
Read Only:true
Maximum Length:60
The postal code portion of the business??? address. -
Preview: string
(byte)
Read Only:
true
This column contains the thumbnail of an attached file. -
PreviewHeight: number
Read Only:
true
This column indicates the height of a stored thumbnail. -
PreviewWidth: number
Read Only:
true
This column indicates the width of a stored thumbnail. -
ProtectionLevel: string
Read Only:
true
Maximum Length:1
Indicates whether the attachment has some level of protection and what type of protection. The default value is N for None. -
RecordAgencyId: integer
(int32)
Read Only:
true
The agency identifier of the public sector entity to which this attachment applies. -
RecordAttachmentId: integer
(int64)
Read Only:
true
The unique identifier for an attachment. -
RecordNumber: string
Read Only:
true
Maximum Length:64
The public unique identifier for a business license record. -
RecordType: string
Title:
Transaction Type
Read Only:true
Maximum Length:100
The user-friendly name for the record type. -
RecordTypeCode: string
Title:
Record Type Code
Read Only:true
Maximum Length:20
The unique alphanumeric code or short name for the record type. -
RecordTypeId: string
Title:
Record Type ID
Read Only:true
Maximum Length:30
The unique identifier for a record type. -
RevisedDocUploadedFlag: string
Read Only:
true
Maximum Length:1
Indicates whether the attachment was uploaded during a rejected or approved plan review cycle. Default value is N for no. -
State: string
Title:
State
Read Only:true
Maximum Length:60
The state portion of the business address. -
Status: string
Title:
Status
Read Only:true
Maximum Length:15
The record status. -
SubjectId: string
Read Only:
true
Maximum Length:30
The subject of the attachment. -
SystemStatus: string
Title:
System Status
Read Only:true
Maximum Length:15
The predefined system status to which the record status maps. -
UpdatedByName: string
Title:
Last Updated By
The user who last updated the attachment. -
Version: integer
(int32)
Read Only:
true
The version of the attachment. -
VersionType: string
Read Only:
true
Maximum Length:1
The version of the business license. Values are origination, amendment, and renewal. -
VersionTypeDesc: string
Title:
Activity and Period
Read Only:true
Maximum Length:80
The user-friendly value for the version type. -
WriteProtectedFlag: string
Read Only:
true
Maximum Length:1
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 : Attachments
Type:
array
Title:
Attachments
The attachment resource is used to view, create, and update attachments.
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 : publicSectorBlActivityAttachments-LnpAttachmentAccessor-item-response
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
The unique identifier of the attached document. -
AttachmentsRevision: array
Attachment Revisions
Title:
Attachment Revisions
The attachment revision resource is used to view attachment revisions. -
CategoryName: string
Title:
Category
Maximum Length:30
The category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
The user who created the record. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
The user name who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the record was created. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
A value that indicates the data type. -
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 from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255
The document version number from which the attachment is created. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
The error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
The error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
The expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File Contents
The contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
The file name of the attachment. -
FileUrl: string
Title:
File Url
The URI of the 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 when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
The user who last updated the record. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
The user name who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingAction
The name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
Title
The title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
The content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
The size of the attachment file. -
UploadedFileName: string
Title:
Uploaded File Name
The name to assign to a new attachment file. -
UploadedText: string
Title:
Uploaded Text
The text content for a new text attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
The URI of a Topology Manager type attachment. -
Url: string
Title:
Url
Maximum Length:4000
The URL of a web page type attachment. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
The login credentials of the user who created the attachment.
Nested Schema : Attachment Revisions
Type:
array
Title:
Attachment Revisions
The attachment revision resource is used to view attachment revisions.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorBlActivityAttachments-LnpAttachmentAccessor-AttachmentsRevision-item-response
Type:
Show Source
object
-
AttachedDocumentId: string
Read Only:
true
The unique identifier of the attached document for this revision. -
ContentId: string
Maximum Length:
80
The contents of the attachment revision. -
ErrorStatusCode: string
The error code, if any, for the attachment revision.
-
ErrorStatusMessage: string
The error message, if any, for the attachment revision.
-
FileUrl: string
The file name of the attachment revision.
-
Format: string
Maximum Length:
128
The format of the attachment revision. -
InDate: string
(date-time)
The date of the attachment revision.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
RevisionId: string
Maximum Length:
80
The ID of the attachment revision. -
RevLabel: string
Maximum Length:
80
The revision label of the attachment revision. -
UserRevisionId: integer
The user revision ID for the attachment revision.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- LnpAttachmentAccessor
-
Parameters:
- publicSectorBlActivityAttachmentsUniqID:
$request.path.publicSectorBlActivityAttachmentsUniqID
The attachment resource is used to view, create, and update attachments. - publicSectorBlActivityAttachmentsUniqID: