Get a case attachment
get
/fscmRestApi/resources/11.13.18.05/publicSectorCaseAttachments/{AttachmentKey}
Request
Path Parameters
-
AttachmentKey: integer
The unique identifier of the case attachment.
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 : publicSectorCaseAttachments-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int32)
Title:
Agency ID
The identifier of the agency for the case attachment. -
AttachmentEntityName(optional):
string
The entity name of the case attachment.
-
AttachmentId(optional):
integer(int64)
The unique identifier of the case attachment.
-
AttachmentKey(optional):
integer(int64)
The unique identifier of the case attachment.
-
CaseAttachmentAccessor(optional):
array Case Attachment Contents
Title:
Case Attachment Contents
The case attachment resource is used to view, create, or modify a case attachment. Case attachments are used in Code Enforcement cases. -
CaseAttachmentId(optional):
integer(int64)
The unique identifier of the case attachment.
-
CaseKey(optional):
integer(int64)
The unique identifier of the case.
-
CreatedBy(optional):
string
Title:
Uploaded By
Maximum Length:64
The name of the user who created the row. -
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 row was created. -
Description(optional):
string
Title:
Description
Maximum Length:100
The description of the case attachment. -
DocumentCategory(optional):
string
Maximum Length:
30
The document category of the case attachment. -
DocumentSubcategory(optional):
string
Maximum Length:
30
The document subcategory of the case attachment. -
FileName(optional):
string
Title:
File Name
Maximum Length:255
The name of the case attachment file. -
FileSize(optional):
integer(int64)
Title:
File Size
File size of the case attachment. -
FileType(optional):
string
Maximum Length:
100
File type of the case attachment. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated Date
The name of the user who last updated the row. -
LastUpdatedBy(optional):
string
Title:
Last Updated By
Maximum Length:64
The date and time when the row 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 case attachment.
Nested Schema : Case Attachment Contents
Type:
array
Title:
Case Attachment Contents
The case attachment resource is used to view, create, or modify a case attachment. Case attachments are used in Code Enforcement cases.
Show Source
Nested Schema : publicSectorCaseAttachments-CaseAttachmentAccessor-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 case attachment content. -
AttachmentsRevision(optional):
array Case Attachment Revisions
Title:
Case Attachment Revisions
The case attachment content resource is used to view, create, or modify the content of a case attachment. Case attachments are used in Code Enforcement cases. -
CategoryName(optional):
string
Title:
Category
Maximum Length:30
The category name of the case attachment content. - ContentRepositoryFileShared(optional): boolean
-
CreatedBy(optional):
string
Title:
Created By
Maximum Length:255
The name of the user who created the row. -
CreatedByUserName(optional):
string
Title:
Created By User Name
The name of the user who created the row. -
CreationDate(optional):
string(date-time)
Title:
Creation Date
The date and time when the row was created. -
DatatypeCode(optional):
string
Title:
Type
Maximum Length:30
The date type code of the case attachment content. -
Description(optional):
string
Title:
Description
Maximum Length:255
The description of the case attachment content. -
DmDocumentId(optional):
string
Maximum Length:
255
The document identifier of the case attachment content. -
DmFolderPath(optional):
string
Title:
Dm Folder Path
Maximum Length:1000
The path of the folder that contains the case attachment content. -
DmVersionNumber(optional):
string
Maximum Length:
255
The document version number for the case attachment content. -
ErrorStatusCode(optional):
string
Title:
Error Status Code
The error status code for the case attachment content. -
ErrorStatusMessage(optional):
string
Title:
Error Status Message
The error status message for the case attachment content. -
ExpirationDate(optional):
string(date-time)
Title:
Expiration Date
The expiration date of the case attachment content. -
FileContents(optional):
string(binary)
Title:
File Contents
The contents of the case attachment file. -
FileName(optional):
string
Title:
File Name
Maximum Length:2048
File name for the case attachment content. -
FileUrl(optional):
string
Title:
File Url
The URL of the file that contains the case attachment content. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Update Date
The date and time when the row was last updated. -
LastUpdatedBy(optional):
string
Title:
Last Updated By
Maximum Length:255
The name of the user who last updated the row. -
LastUpdatedByUserName(optional):
string
Title:
Last Updated By User
The name of the user who last updated the row. -
links(optional):
array Items
Title:
Items
Link Relations -
Title(optional):
string
Title:
Title
The title of the case attachment content. -
UploadedFileContentType(optional):
string
Title:
Uploaded File Content Type
The uploaded file content type of the case attachment content. -
UploadedFileLength(optional):
integer(int64)
Title:
File Size
The length of the file used for the uploaded case attachment content. -
UploadedFileName(optional):
string
Title:
Uploaded File Name
The name of the uploaded file that contains the case attachment content. -
UploadedText(optional):
string
Title:
Uploaded Text
The uploaded text in the case attachment content. -
Uri(optional):
string
Title:
Uri
Maximum Length:4000
The URI of the case attachment content. -
Url(optional):
string
Title:
Url
Maximum Length:4000
The URL of the case attachment content. -
UserName(optional):
string
Title:
User Name
Maximum Length:255
The username for the case attachment content.
Nested Schema : Case Attachment Revisions
Type:
array
Title:
Case Attachment Revisions
The case attachment content resource is used to view, create, or modify the content of a case attachment. Case attachments are used in Code Enforcement cases.
Show Source
Nested Schema : publicSectorCaseAttachments-CaseAttachmentAccessor-AttachmentsRevision-item
Type:
Show Source
object
-
AttachedDocumentId(optional):
integer(int64)
The unique identifier of the case attachment content.
-
ContentId(optional):
string
Maximum Length:
80
The contents of the attachment revision. -
ErrorStatusCode(optional):
string
The error status code of the case attachment revision.
-
ErrorStatusMessage(optional):
string
The error status message of the case attachment revision.
-
FileUrl(optional):
string
The file URL of the case 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 ID 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.