> For the complete documentation index, see [llms.txt](https://tsanet.gitbook.io/connect/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://tsanet.gitbook.io/connect/api-reference/case-attachments.md).

# Case Attachments

Attachment configuration and forwarding

## PUT /v1/collaboration-requests/{token}/attachments/config/https

> Update HTTPS attachment configuration details

```json
{"openapi":"3.0.1","info":{"title":"OpenAPI definition","version":"v0"},"tags":[{"name":"Case Attachments","description":"Attachment configuration and forwarding"}],"servers":[{"url":"http://connect2.tsanet.org","description":"Generated server url"}],"security":[{"bearerAuth":[]}],"paths":{"/v1/collaboration-requests/{token}/attachments/config/https":{"put":{"tags":["Case Attachments"],"summary":"Update HTTPS attachment configuration details","operationId":"createAttachmentConfig","parameters":[{"name":"token","in":"path","description":"The token provided by TSANet for the collaboration request","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NormalizedHttpsAttachmentConfigDTO"}}},"required":true},"responses":{"200":{"description":"Attachment configuration updated successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AttachmentConfigDTO"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/AttachmentConfigDTO"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}},"components":{"schemas":{"NormalizedHttpsAttachmentConfigDTO":{"required":["domain","expiration","httpsPath","httpsPort","password"],"type":"object","properties":{"domain":{"type":"string"},"password":{"type":"string"},"expiration":{"type":"string","format":"date-time"},"httpsPath":{"type":"string"},"httpsPort":{"type":"integer","format":"int32"}}},"AttachmentConfigDTO":{"type":"object","properties":{"submitter":{"$ref":"#/components/schemas/CompanyAttachmentConfigDTO"},"receiver":{"$ref":"#/components/schemas/CompanyAttachmentConfigDTO"}}},"CompanyAttachmentConfigDTO":{"type":"object","properties":{"companyId":{"type":"integer","format":"int64"},"parameters":{"type":"object","additionalProperties":{"type":"object"}}}},"ErrorResponse":{"type":"object","properties":{"message":{"type":"string"},"validationErrors":{"type":"array","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string"},"message":{"type":"string"}}}}}}
```

## POST /v1/collaboration-requests/{token}/attachments

> Forward attachments to collaboration partners

```json
{"openapi":"3.0.1","info":{"title":"OpenAPI definition","version":"v0"},"tags":[{"name":"Case Attachments","description":"Attachment configuration and forwarding"}],"servers":[{"url":"http://connect2.tsanet.org","description":"Generated server url"}],"security":[{"bearerAuth":[]}],"paths":{"/v1/collaboration-requests/{token}/attachments":{"post":{"tags":["Case Attachments"],"summary":"Forward attachments to collaboration partners","operationId":"forwardAttachment","parameters":[{"name":"token","in":"path","description":"The token provided by TSANet for the collaboration request","required":true,"schema":{"type":"string"}},{"name":"description","in":"query","description":"Description of the attachments","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"required":["files"],"type":"object","properties":{"files":{"type":"array","description":"Files to forward","items":{"type":"string","format":"binary"}}}}}}},"responses":{"200":{"description":"Attachments forwarded successfully","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AttachmentForwardResultDTO"}}},"application/problem+json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AttachmentForwardResultDTO"}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}},"components":{"schemas":{"AttachmentForwardResultDTO":{"type":"object","properties":{"fileName":{"type":"string"},"receiverStatus":{"type":"string","enum":["SUCCESS","CONFIG_MISSING","CONFIG_INVALID","FORWARD_FAILED","CONTENT_ERROR","UNKNOWN"]},"receiverMessage":{"type":"string"},"submitterStatus":{"type":"string","enum":["SUCCESS","CONFIG_MISSING","CONFIG_INVALID","FORWARD_FAILED","CONTENT_ERROR","UNKNOWN"]},"submitterMessage":{"type":"string"},"completeSuccess":{"type":"boolean"},"partialSuccess":{"type":"boolean"}}},"ErrorResponse":{"type":"object","properties":{"message":{"type":"string"},"validationErrors":{"type":"array","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string"},"message":{"type":"string"}}}}}}
```

## POST /v1/collaboration-requests/{token}/attachments/config/https/analyze

> Analyze arbitrary data and return a proposed attachment configuration without saving it

```json
{"openapi":"3.0.1","info":{"title":"OpenAPI definition","version":"v0"},"tags":[{"name":"Case Attachments","description":"Attachment configuration and forwarding"}],"servers":[{"url":"http://connect2.tsanet.org","description":"Generated server url"}],"security":[{"bearerAuth":[]}],"paths":{"/v1/collaboration-requests/{token}/attachments/config/https/analyze":{"post":{"tags":["Case Attachments"],"summary":"Analyze arbitrary data and return a proposed attachment configuration without saving it","operationId":"analyzeConfig","parameters":[{"name":"token","in":"path","description":"The token provided by TSANet for the collaboration request","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":{"type":"object"}}}},"required":true},"responses":{"200":{"description":"Proposed attachment configuration","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NormalizedHttpsAttachmentConfigDTO"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/NormalizedHttpsAttachmentConfigDTO"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}},"components":{"schemas":{"NormalizedHttpsAttachmentConfigDTO":{"required":["domain","expiration","httpsPath","httpsPort","password"],"type":"object","properties":{"domain":{"type":"string"},"password":{"type":"string"},"expiration":{"type":"string","format":"date-time"},"httpsPath":{"type":"string"},"httpsPort":{"type":"integer","format":"int32"}}},"ErrorResponse":{"type":"object","properties":{"message":{"type":"string"},"validationErrors":{"type":"array","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string"},"message":{"type":"string"}}}}}}
```

## GET /v1/collaboration-requests/{token}/attachments/config

> Get attachment configuration for a collaboration request

```json
{"openapi":"3.0.1","info":{"title":"OpenAPI definition","version":"v0"},"tags":[{"name":"Case Attachments","description":"Attachment configuration and forwarding"}],"servers":[{"url":"http://connect2.tsanet.org","description":"Generated server url"}],"security":[{"bearerAuth":[]}],"paths":{"/v1/collaboration-requests/{token}/attachments/config":{"get":{"tags":["Case Attachments"],"summary":"Get attachment configuration for a collaboration request","operationId":"getAttachmentConfig","parameters":[{"name":"token","in":"path","description":"The token provided by TSANet for the collaboration request","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Attachment configuration","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AttachmentConfigDTO"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/AttachmentConfigDTO"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}},"components":{"schemas":{"AttachmentConfigDTO":{"type":"object","properties":{"submitter":{"$ref":"#/components/schemas/CompanyAttachmentConfigDTO"},"receiver":{"$ref":"#/components/schemas/CompanyAttachmentConfigDTO"}}},"CompanyAttachmentConfigDTO":{"type":"object","properties":{"companyId":{"type":"integer","format":"int64"},"parameters":{"type":"object","additionalProperties":{"type":"object"}}}},"ErrorResponse":{"type":"object","properties":{"message":{"type":"string"},"validationErrors":{"type":"array","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string"},"message":{"type":"string"}}}}}}
```