Update a hearing appeal attachment
patch
/fscmRestApi/resources/11.13.18.05/publicSectorHearingAppealAttachments/{AttachmentKey}
Request
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Path Parameters
-
AttachmentKey: integer
The unique identifier of the hearing appeal attachment.
The following table describes the body parameters in the request for this task.
Root Schema : publicSectorHearingAppealAttachments-item
Type:
object
Discriminator:
Show Source
AttachmentType
-
AgencyId(optional):
integer(int32)
Title:
Agency ID
The unique identifier of the agency associated with the attachment. -
AttachmentEntityName(optional):
string
The entity name of the attachment.
-
AttachmentId(optional):
integer(int64)
The unique identifier of the attachment.
-
AttachmentKey(optional):
integer(int64)
The unique identifier of the hearing appeal attachment.
-
AttachmentType:
string
Maximum Length:
15
The type of the attachment. -
CreatedBy(optional):
string
Title:
Uploaded By
Maximum Length:64
The name of the user who created the hearing. -
CreatedByName(optional):
string
Title:
Uploaded By
The name of the user who created the attachment. -
CreationDate(optional):
string(date-time)
Title:
Uploaded On
The date and time when the hearing was created. -
Description(optional):
string
Title:
Description
Maximum Length:100
The description of the hearing appeal attachment. -
FileName(optional):
string
Title:
File Name
Maximum Length:255
The file name of the hearing appeal attachment. -
FileSize(optional):
integer(int64)
Title:
File Size
The file size of the hearing appeal attachment. -
FileType(optional):
string
Maximum Length:
100
The file type of the hearing appeal attachment. -
HearingAppealAttachmentAccessor(optional):
array Appeal Attachments
Title:
Appeal Attachments
The hearing appeal attachments resource is used to view or create hearing appeal attachments. Hearing appeal attachments are documents used in planning and zoning applications. -
HearingAppealAttachmentId(optional):
integer(int64)
The unique identifier of the hearing appeal attachment.
-
HearingAppealKey(optional):
integer(int64)
The unique identifier of the hearing appeal record.
-
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated Date
The name of the user who last updated the hearing. -
LastUpdatedBy(optional):
string
Title:
Last Updated By
Maximum Length:64
The date and time when the hearing was last updated. -
links(optional):
array Items
Title:
Items
Link Relations -
UpdatedByName(optional):
string
Title:
Last Updated By
The name of the user who last updated the attachment. -
Version(optional):
integer(int32)
The version of the attachment.
Nested Schema : Appeal Attachments
Type:
array
Title:
Appeal Attachments
The hearing appeal attachments resource is used to view or create hearing appeal attachments. Hearing appeal attachments are documents used in planning and zoning applications.
Show Source
Nested Schema : publicSectorHearingAppealAttachments-HearingAppealAttachmentAccessor-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 of the attached document. -
AttachmentsRevision(optional):
array Appeal Attachment Revisions
Title:
Appeal Attachment Revisions
The appeal attachments resource is used to view, create, and update attachments. -
CategoryName(optional):
string
Title:
Category
Maximum Length:30
The category of the attachment. - ContentRepositoryFileShared(optional): boolean
-
CreatedBy(optional):
string
Title:
Created By
Maximum Length:255
The user who created the record. -
CreatedByUserName(optional):
string
Title:
Created By User Name
The user name who created the record. -
CreationDate(optional):
string(date-time)
Title:
Creation Date
The date when the record was created. -
DatatypeCode(optional):
string
Title:
Type
Maximum Length:30
A value that indicates the data type. -
Description(optional):
string
Title:
Description
Maximum Length:255
The description of the attachment. -
DmDocumentId(optional):
string
Maximum Length:
255
The document identifier for the attachment created. -
DmFolderPath(optional):
string
Title:
Dm Folder Path
Maximum Length:1000
The folder path from which the attachment is created. -
DmVersionNumber(optional):
string
Maximum Length:
255
The document version number from which the attachment is created. -
ErrorStatusCode(optional):
string
Title:
Error Status Code
The error code, if any, for the attachment. -
ErrorStatusMessage(optional):
string
Title:
Error Status Message
The error message, if any, for the attachment. -
ExpirationDate(optional):
string(date-time)
Title:
Expiration Date
The expiration date of the contents in the attachment. -
FileContents(optional):
string(binary)
Title:
File Contents
The contents of the attachment. -
FileName(optional):
string
Title:
File Name
Maximum Length:2048
The file name of the attachment. -
FileUrl(optional):
string
Title:
File Url
The URI of the file. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Update Date
The date when the record was last updated. -
LastUpdatedBy(optional):
string
Title:
Last Updated By
Maximum Length:255
The user who last updated the record. -
LastUpdatedByUserName(optional):
string
Title:
Last Updated By User
The user name who last updated the record. -
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. -
UploadedFileLength(optional):
integer(int64)
Title:
File Size
The size of the attachment file. -
UploadedFileName(optional):
string
Title:
Uploaded File Name
The name to assign to a new attachment file. -
UploadedText(optional):
string
Title:
Uploaded Text
The text content for a new text attachment. -
Uri(optional):
string
Title:
Uri
Maximum Length:4000
The URI of the Topology Manager type attachment. -
Url(optional):
string
Title:
Url
Maximum Length:4000
The URL of the web page type attachment. -
UserName(optional):
string
Title:
User Name
Maximum Length:255
The login credentials of the user who created the attachment.
Nested Schema : Appeal Attachment Revisions
Type:
array
Title:
Appeal Attachment Revisions
The appeal attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : publicSectorHearingAppealAttachments-HearingAppealAttachmentAccessor-AttachmentsRevision-item
Type:
Show Source
object
-
AttachedDocumentId(optional):
integer(int64)
The unique identifier of the attached document for this revision.
-
ContentId(optional):
string
Maximum Length:
80
The contents of the attachment revision. -
ErrorStatusCode(optional):
string
The error code, if any, for the attachment revision.
-
ErrorStatusMessage(optional):
string
The error message, if any, for the attachment revision.
-
FileUrl(optional):
string
The file name of the attachment revision.
-
Format(optional):
string
Maximum Length:
128
The format of the attachment revision. -
InDate(optional):
string(date-time)
The date of the attachment revision.
-
links(optional):
array Items
Title:
Items
Link Relations -
RevisionId(optional):
string
Maximum Length:
80
The ID of the attachment revision. -
RevLabel(optional):
string
Maximum Length:
80
The revision label of the attachment revision. -
UserRevisionId(optional):
integer(int64)
The user revision identifier for the attachment revision.
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.
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 : publicSectorHearingAppealAttachments-item
Type:
object
Discriminator:
Show Source
AttachmentType
-
AgencyId(optional):
integer(int32)
Title:
Agency ID
The unique identifier of the agency associated with the attachment. -
AttachmentEntityName(optional):
string
The entity name of the attachment.
-
AttachmentId(optional):
integer(int64)
The unique identifier of the attachment.
-
AttachmentKey(optional):
integer(int64)
The unique identifier of the hearing appeal attachment.
-
AttachmentType:
string
Maximum Length:
15
The type of the attachment. -
CreatedBy(optional):
string
Title:
Uploaded By
Maximum Length:64
The name of the user who created the hearing. -
CreatedByName(optional):
string
Title:
Uploaded By
The name of the user who created the attachment. -
CreationDate(optional):
string(date-time)
Title:
Uploaded On
The date and time when the hearing was created. -
Description(optional):
string
Title:
Description
Maximum Length:100
The description of the hearing appeal attachment. -
FileName(optional):
string
Title:
File Name
Maximum Length:255
The file name of the hearing appeal attachment. -
FileSize(optional):
integer(int64)
Title:
File Size
The file size of the hearing appeal attachment. -
FileType(optional):
string
Maximum Length:
100
The file type of the hearing appeal attachment. -
HearingAppealAttachmentAccessor(optional):
array Appeal Attachments
Title:
Appeal Attachments
The hearing appeal attachments resource is used to view or create hearing appeal attachments. Hearing appeal attachments are documents used in planning and zoning applications. -
HearingAppealAttachmentId(optional):
integer(int64)
The unique identifier of the hearing appeal attachment.
-
HearingAppealKey(optional):
integer(int64)
The unique identifier of the hearing appeal record.
-
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated Date
The name of the user who last updated the hearing. -
LastUpdatedBy(optional):
string
Title:
Last Updated By
Maximum Length:64
The date and time when the hearing was last updated. -
links(optional):
array Items
Title:
Items
Link Relations -
UpdatedByName(optional):
string
Title:
Last Updated By
The name of the user who last updated the attachment. -
Version(optional):
integer(int32)
The version of the attachment.
Nested Schema : Appeal Attachments
Type:
array
Title:
Appeal Attachments
The hearing appeal attachments resource is used to view or create hearing appeal attachments. Hearing appeal attachments are documents used in planning and zoning applications.
Show Source
Nested Schema : publicSectorHearingAppealAttachments-HearingAppealAttachmentAccessor-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 of the attached document. -
AttachmentsRevision(optional):
array Appeal Attachment Revisions
Title:
Appeal Attachment Revisions
The appeal attachments resource is used to view, create, and update attachments. -
CategoryName(optional):
string
Title:
Category
Maximum Length:30
The category of the attachment. - ContentRepositoryFileShared(optional): boolean
-
CreatedBy(optional):
string
Title:
Created By
Maximum Length:255
The user who created the record. -
CreatedByUserName(optional):
string
Title:
Created By User Name
The user name who created the record. -
CreationDate(optional):
string(date-time)
Title:
Creation Date
The date when the record was created. -
DatatypeCode(optional):
string
Title:
Type
Maximum Length:30
A value that indicates the data type. -
Description(optional):
string
Title:
Description
Maximum Length:255
The description of the attachment. -
DmDocumentId(optional):
string
Maximum Length:
255
The document identifier for the attachment created. -
DmFolderPath(optional):
string
Title:
Dm Folder Path
Maximum Length:1000
The folder path from which the attachment is created. -
DmVersionNumber(optional):
string
Maximum Length:
255
The document version number from which the attachment is created. -
ErrorStatusCode(optional):
string
Title:
Error Status Code
The error code, if any, for the attachment. -
ErrorStatusMessage(optional):
string
Title:
Error Status Message
The error message, if any, for the attachment. -
ExpirationDate(optional):
string(date-time)
Title:
Expiration Date
The expiration date of the contents in the attachment. -
FileContents(optional):
string(binary)
Title:
File Contents
The contents of the attachment. -
FileName(optional):
string
Title:
File Name
Maximum Length:2048
The file name of the attachment. -
FileUrl(optional):
string
Title:
File Url
The URI of the file. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Update Date
The date when the record was last updated. -
LastUpdatedBy(optional):
string
Title:
Last Updated By
Maximum Length:255
The user who last updated the record. -
LastUpdatedByUserName(optional):
string
Title:
Last Updated By User
The user name who last updated the record. -
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. -
UploadedFileLength(optional):
integer(int64)
Title:
File Size
The size of the attachment file. -
UploadedFileName(optional):
string
Title:
Uploaded File Name
The name to assign to a new attachment file. -
UploadedText(optional):
string
Title:
Uploaded Text
The text content for a new text attachment. -
Uri(optional):
string
Title:
Uri
Maximum Length:4000
The URI of the Topology Manager type attachment. -
Url(optional):
string
Title:
Url
Maximum Length:4000
The URL of the web page type attachment. -
UserName(optional):
string
Title:
User Name
Maximum Length:255
The login credentials of the user who created the attachment.
Nested Schema : Appeal Attachment Revisions
Type:
array
Title:
Appeal Attachment Revisions
The appeal attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : publicSectorHearingAppealAttachments-HearingAppealAttachmentAccessor-AttachmentsRevision-item
Type:
Show Source
object
-
AttachedDocumentId(optional):
integer(int64)
The unique identifier of the attached document for this revision.
-
ContentId(optional):
string
Maximum Length:
80
The contents of the attachment revision. -
ErrorStatusCode(optional):
string
The error code, if any, for the attachment revision.
-
ErrorStatusMessage(optional):
string
The error message, if any, for the attachment revision.
-
FileUrl(optional):
string
The file name of the attachment revision.
-
Format(optional):
string
Maximum Length:
128
The format of the attachment revision. -
InDate(optional):
string(date-time)
The date of the attachment revision.
-
links(optional):
array Items
Title:
Items
Link Relations -
RevisionId(optional):
string
Maximum Length:
80
The ID of the attachment revision. -
RevLabel(optional):
string
Maximum Length:
80
The revision label of the attachment revision. -
UserRevisionId(optional):
integer(int64)
The user revision identifier for the attachment revision.
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.