Get a case attachment
get
/fscmRestApi/resources/11.13.18.05/publicSectorCaseAttachments/{AttachmentKey}
Request
Path Parameters
-
AttachmentKey(required): integer(int64)
The unique identifier of the case attachment.
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 : publicSectorCaseAttachments-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Title:
Agency ID
Default Value:1
The identifier of the agency for the case attachment. -
AttachmentEntityName: string
Default Value:
PSC_DOC_CASE
The entity name of the case attachment. -
AttachmentId: integer
(int64)
The unique identifier of the case attachment.
-
AttachmentKey: integer
(int64)
The unique identifier of the case attachment.
-
AttachmentPuid: string
Maximum Length:
480
The public unique identifier of the migrated case record. -
CaseAttachmentAccessor: array
Case Attachment Contents
Title:
Case Attachment Contents
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. -
CaseAttachmentId: integer
(int64)
The unique identifier of the case attachment.
-
CaseKey: integer
(int64)
The unique identifier of the case.
-
CasePuid: string
Maximum Length:
480
The public unique identifier of the migrated case attachment record. -
ConfidentialFlag: boolean
Maximum Length:
1
Default Value:false
Indicates whether the attachment is a confidential document. The default value is N for no. -
CreatedByName: string
Title:
Uploaded By
The name of the user who created the attachment. -
CreatedByUserType: string
Maximum Length:
15
Default Value:ORA_A
The type of user who created the case attachment. -
CreationDate: string
(date-time)
Title:
Uploaded On
Read Only:true
The date and time when the row was created. -
Description: string
Title:
Description
Maximum Length:100
The description of the case attachment. -
DocumentCategory: string
Maximum Length:
30
The document category of the case attachment. -
DocumentSubcategory: string
Maximum Length:
30
The document subcategory of the case attachment. -
FileName: string
Title:
File Name
Maximum Length:255
The name of the case attachment file. -
FileSize: integer
(int64)
Title:
File Size
File size of the case attachment. -
FileType: string
Maximum Length:
100
File type of the case attachment. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The name of the user who last updated the row. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
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.
-
RequiredFlag: boolean
Maximum Length:
1
Default Value:false
Indicates whether the attachment is a required document. The default value is N for no. -
UpdatedByName: string
Title:
Last Updated By
The name of the user who last updated the attachment. -
Version: integer
(int32)
The version of the case attachment.
Nested Schema : Case Attachment Contents
Type:
array
Title:
Case Attachment Contents
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 : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorCaseAttachments-CaseAttachmentAccessor-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 case attachment content. -
AttachmentsRevision: array
Case Attachment Revisions
Title:
Case Attachment Revisions
The case attachment revision resource is used to view, create, or modify a case attachment revision. Case attachments are used in Code Enforcement cases. -
CategoryName: string
Title:
Category
Maximum Length:30
The category name of the case attachment content. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
The name of the user who created the row. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
The name of the user who created the row. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the row was created. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
The date type code of the case attachment content. -
Description: string
Title:
Description
Maximum Length:255
The description of the case attachment content. -
DmDocumentId: string
Maximum Length:
255
The document identifier of the case attachment content. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
The path of the folder that contains the case attachment content. -
DmVersionNumber: string
Maximum Length:
255
The document version number for the case attachment content. -
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 error status code for the case attachment content. -
ErrorStatusMessage: string
Title:
Error Status Message
The error status message for the case attachment content. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
The expiration date of the case attachment content. -
FileContents: string
(byte)
Title:
File Contents
The contents of the case attachment file. -
FileName: string
Title:
File Name
Maximum Length:2048
File name for the case attachment content. -
FileUrl: string
Title:
File Url
The URL of the file that contains the case attachment content. -
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 row was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
The name of the user who last updated the row. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
The name of the user who last updated the row. -
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 case attachment content. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
The uploaded file content type of the case attachment content. -
UploadedFileLength: integer
Title:
File Size
The length of the file used for the uploaded case attachment content. -
UploadedFileName: string
Title:
Uploaded File Name
The name of the uploaded file that contains the case attachment content. -
UploadedText: string
Title:
Uploaded Text
The uploaded text in the case attachment content. -
Uri: string
Title:
Uri
Maximum Length:4000
The URI of the case attachment content. -
Url: string
Title:
Url
Maximum Length:4000
The URL of the case attachment content. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
The username for the case attachment content.
Nested Schema : Case Attachment Revisions
Type:
array
Title:
Case Attachment Revisions
The case attachment revision resource is used to view, create, or modify a case attachment revision. Case attachments are used in Code Enforcement cases.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorCaseAttachments-CaseAttachmentAccessor-AttachmentsRevision-item-response
Type:
Show Source
object
-
AttachedDocumentId: string
Read Only:
true
The unique identifier of the case attachment content. -
ContentId: string
Maximum Length:
80
The contents of the attachment revision. -
ErrorStatusCode: string
The error status code of the case attachment revision.
-
ErrorStatusMessage: string
The error status message of the case attachment revision.
-
FileUrl: string
The file URL of the case 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
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.
Links
- CaseAttachmentAccessor
-
Parameters:
- AttachmentKey:
$request.path.AttachmentKey
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. - AttachmentKey: