Create an attachment for a permit
post
/fscmRestApi/resources/11.13.18.05/publicSectorRecordAttachments
Request
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
The following table describes the body parameters in the request for this task.
Root Schema : publicSectorRecordAttachments-item
Type:
object
Discriminator:
Show Source
AttachmentType
-
AgencyId(optional):
integer(int32)
Title:
Agency ID
The agency identifier of the public sector entity to which this attachment applies. -
AttachmentEntityName(optional):
string
Maximum Length:
255
The entity name of the attachment. -
AttachmentId(optional):
integer(int64)
The unique identifier for a permit attachment.
-
AttachmentType:
string
Maximum Length:
15
The type of attachment, such as for plan reviews, inspections, or permits. -
CreatedBy(optional):
string
Title:
Uploaded By
Maximum Length:64
The user who created the attachment. -
CreationDate(optional):
string(date-time)
Title:
Uploaded On
The date and time when the attachment was created. -
Description(optional):
string
Title:
Description
Maximum Length:100
The description of the attachment. -
DigitalSignatureFlag(optional):
string
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(optional):
string
Title:
Category
Maximum Length:30
The category used for dividing the attached document into a logical group. -
DocumentGroupId(optional):
string
Maximum Length:
30
The document group specified on the permit type when the attachment was uploaded. -
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. -
DocumentSubcategory(optional):
string
Title:
Subcategory
Maximum Length:30
The subcategory used for dividing the attached document into a logical group along with the category. -
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 type of attachment, such as PDF or text. -
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. -
links(optional):
array Items
Title:
Items
Link Relations -
LnpAttachmentAccessor(optional):
array Record Attachment Accessors
Title:
Record Attachment Accessors
The record attachments resource is used to view, create, delete, or modify attachments on permit records. -
LnpAttachmentKey(optional):
integer(int64)
The unique key associated with the permit attachment.
-
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.
-
PlanReviewFlag(optional):
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.
-
RecordAgencyId(optional):
integer(int32)
The agency identifier of the public sector entity to which this attachment applies.
-
RecordAttachmentId(optional):
integer(int64)
The unique identifier for an attachment.
-
SubjectId(optional):
string
Maximum Length:
30
The subject of the attachment. -
Version(optional):
integer(int32)
The version of the attachment.
Nested Schema : Record Attachment Accessors
Type:
array
Title:
Record Attachment Accessors
The record attachments resource is used to view, create, delete, or modify attachments on permit records.
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 : publicSectorRecordAttachments-LnpAttachmentAccessor-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 Record Attachment Revisions
Title:
Record Attachment Revisions
The record attachment accessors resource is used for displaying permit 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 document ID from which the attachment is created. -
DmFolderPath(optional):
string
Title:
Dm Folder Path
Maximum Length:1000
The folder path of the attachment file. -
DmVersionNumber(optional):
string
Maximum Length:
255
The document version number from which the attachment is created. -
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 : Record Attachment Revisions
Type:
array
Title:
Record Attachment Revisions
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 : publicSectorRecordAttachments-LnpAttachmentAccessor-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
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 : publicSectorRecordAttachments-item
Type:
object
Discriminator:
Show Source
AttachmentType
-
AgencyId(optional):
integer(int32)
Title:
Agency ID
The agency identifier of the public sector entity to which this attachment applies. -
AttachmentEntityName(optional):
string
Maximum Length:
255
The entity name of the attachment. -
AttachmentId(optional):
integer(int64)
The unique identifier for a permit attachment.
-
AttachmentType:
string
Maximum Length:
15
The type of attachment, such as for plan reviews, inspections, or permits. -
CreatedBy(optional):
string
Title:
Uploaded By
Maximum Length:64
The user who created the attachment. -
CreationDate(optional):
string(date-time)
Title:
Uploaded On
The date and time when the attachment was created. -
Description(optional):
string
Title:
Description
Maximum Length:100
The description of the attachment. -
DigitalSignatureFlag(optional):
string
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(optional):
string
Title:
Category
Maximum Length:30
The category used for dividing the attached document into a logical group. -
DocumentGroupId(optional):
string
Maximum Length:
30
The document group specified on the permit type when the attachment was uploaded. -
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. -
DocumentSubcategory(optional):
string
Title:
Subcategory
Maximum Length:30
The subcategory used for dividing the attached document into a logical group along with the category. -
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 type of attachment, such as PDF or text. -
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. -
links(optional):
array Items
Title:
Items
Link Relations -
LnpAttachmentAccessor(optional):
array Record Attachment Accessors
Title:
Record Attachment Accessors
The record attachments resource is used to view, create, delete, or modify attachments on permit records. -
LnpAttachmentKey(optional):
integer(int64)
The unique key associated with the permit attachment.
-
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.
-
PlanReviewFlag(optional):
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.
-
RecordAgencyId(optional):
integer(int32)
The agency identifier of the public sector entity to which this attachment applies.
-
RecordAttachmentId(optional):
integer(int64)
The unique identifier for an attachment.
-
SubjectId(optional):
string
Maximum Length:
30
The subject of the attachment. -
Version(optional):
integer(int32)
The version of the attachment.
Nested Schema : Record Attachment Accessors
Type:
array
Title:
Record Attachment Accessors
The record attachments resource is used to view, create, delete, or modify attachments on permit records.
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 : publicSectorRecordAttachments-LnpAttachmentAccessor-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 Record Attachment Revisions
Title:
Record Attachment Revisions
The record attachment accessors resource is used for displaying permit 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 document ID from which the attachment is created. -
DmFolderPath(optional):
string
Title:
Dm Folder Path
Maximum Length:1000
The folder path of the attachment file. -
DmVersionNumber(optional):
string
Maximum Length:
255
The document version number from which the attachment is created. -
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 : Record Attachment Revisions
Type:
array
Title:
Record Attachment Revisions
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 : publicSectorRecordAttachments-LnpAttachmentAccessor-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