AWS solutions documentation change

Service: solutions · 2025-04-20 · Documentation low

File: solutions/latest/dea-api/cases-caseid-files-fileid-contents.md

Summary

Updated endpoint documentation with detailed request/response schemas, added authentication/authorization requirements, and file integrity checks through sha256Hash

Security assessment

Added explicit mention of authentication/authorization requirements and file integrity verification via sha256Hash. While these are security-related features, there's no indication of addressing a specific vulnerability.

Diff

diff --git a/solutions/latest/dea-api/cases-caseid-files-fileid-contents.md b/solutions/latest/dea-api/cases-caseid-files-fileid-contents.md
index 7192d0f61..eaf00d416 100644
--- a//solutions/latest/dea-api/cases-caseid-files-fileid-contents.md
+++ b//solutions/latest/dea-api/cases-caseid-files-fileid-contents.md
@@ -5 +5 @@
-URIHTTP methods
+URIHTTP methodsSchemasProperties
@@ -7 +7,3 @@ URIHTTP methods
-#  Cases caseId Files fileId Contents
+# Cases – File contents
+
+This endpoint provides a way to retrieve the contents of a file within a case in Digital Evidence Archive, allowing users to access and view the actual data stored in the file by providing a download URL. The API requires authentication and authorization to ensure that only authorized users can retrieve the contents of the file. 
@@ -22 +24,5 @@ Path parametersName| Type| Required| Description
-`fileId`| String| True| File ID to generate audit log for  
+`fileId`| String| True|   
+  
+ResponsesStatus code| Response model| Description  
+---|---|---  
+`200`| `Cases_response_200_5`| Success Response  
@@ -29 +35,71 @@ Path parametersName| Type| Required| Description
-`fileId`| String| True| File ID to generate audit log for  
+`fileId`| String| True|   
+  
+ResponsesStatus code| Response model| Description  
+---|---|---  
+`200`| `CompleteCaseFileUploadResponse`| Success Response  
+  
+## Schemas
+
+### Request bodies
+    
+    
+    {
+      "caseUlid": "string",
+      "ulid": "string",
+      "downloadReason": "string"
+    }
+    
+    
+    {
+      "caseUlid": "string",
+      "ulid": "string",
+      "uploadId": "string"
+    }
+
+### Response bodies
+    
+    
+    {
+      "isArchived": boolean,
+      "isRestoring": boolean,
+      "downloadUrl": "string",
+      "downloadReason": "string"
+    }
+    
+    
+    {
+      "fileName": "string",
+      "filePath": "string",
+      "caseUlid": "string",
+      "contentType": "string",
+      "createdBy": "string",
+      "fileSizeBytes": number,
+      "sha256Hash": "string",
+      "ulid": "string",
+      "status": enum,
+      "uploadId": "string",
+      "isFile": boolean,
+      "created": "string",
+      "updated": "string",
+      "details": "string",
+      "fileS3Key": "string",
+      "versionId": "string",
+      "dataVaultUlid": "string",
+      "executionId": "string",
+      "associationCreatedBy": "string",
+      "associationDate": "string",
+      "dataVaultUploadDate": "string",
+      "ttl": number,
+      "dataVaultName": "string",
+      "reason": "string"
+    }
+
+## Properties
+
+### CaseFileCompleteUpload
+
+Property| Type| Required| Description  
+---|---|---|---  
+`caseUlid`| string| True|   
+`ulid`| string| True|   
+`uploadId`| string| True|   
@@ -31 +107 @@ Path parametersName| Type| Required| Description
-### OPTIONS
+### CaseFileStatus
@@ -33 +109,16 @@ Path parametersName| Type| Required| Description
-Path parametersName| Type| Required| Description  
+  * `ACTIVE`
+
+  * `DELETING`
+
+  * `DELETE_FAILED`
+
+  * `DELETED`
+
+  * `PENDING`
+
+
+
+
+### Cases_response_200_5
+
+Property| Type| Required| Description  
@@ -35,2 +126,4 @@ Path parametersName| Type| Required| Description
-`caseId`| String| True|   
-`fileId`| String| True| File ID to generate audit log for  
+`downloadReason`| string| False|   
+`downloadUrl`| stringFormat: uri| False|   
+`isArchived`| boolean| False|   
+`isRestoring`| boolean| False|   
@@ -38,3 +131,36 @@ Path parametersName| Type| Required| Description
-ResponsesStatus code| Response model| Description  
----|---|---  
-`204`| None| 204 response  
+### CompleteCaseFileUploadResponse
+
+Property| Type| Required| Description  
+---|---|---|---  
+`associationCreatedBy`| string| False|   
+`associationDate`| string| False|   
+`caseUlid`| string| False|   
+`contentType`| string| False|   
+`created`| string| False|   
+`createdBy`| string| False|   
+`dataVaultName`| string| False|   
+`dataVaultUlid`| string| False|   
+`dataVaultUploadDate`| string| False|   
+`details`| string| False|   
+`executionId`| string| False|   
+`fileName`| string| False|   
+`filePath`| string| False|   
+`fileS3Key`| string| False|   
+`fileSizeBytes`| number| False|   
+`isFile`| boolean| False|   
+`reason`| string| False|   
+`sha256Hash`| string| False|   
+`status`| CaseFileStatus| False|   
+`ttl`| number| False|   
+`ulid`| string| False|   
+`updated`| string| False|   
+`uploadId`| string| False|   
+`versionId`| string| False|   
+  
+### body
+
+Property| Type| Required| Description  
+---|---|---|---  
+`caseUlid`| string| True|   
+`downloadReason`| string| True|   
+`ulid`| string| True|   
@@ -48 +174 @@ To use the Amazon Web Services Documentation, Javascript must be enabled. Please
-Cases caseId Files fileId Audit auditId Csv
+Cases – File audit by caseId and fileId
@@ -50 +176 @@ Cases caseId Files fileId Audit auditId Csv
-Cases caseId Files fileId Info
+Cases – Files by caseId