Data download endpoint for outbound files

GET /api/v3.0/{engagementSid}/files/{outboundFileCategory}/{uniqueFileName}

Adra personal access token & client_credentials

Download a file from Integration Hub. This endpoint allows you to retrieve files that have been created by Adra.

Response Format

Returns file as binary stream
Content-Type matches the original file format
Headers include:
- Content-Length: File size in bytes
- Content-Type: File MIME type
- Last-Modified: Timestamp of last modification
- ETag: File version identifier

Common Use Cases

Downloading created reports
Retrieving journal entries

Error Handling

404: File not found or deleted
403: Insufficient permissions
401: Invalid or expired token

Best Practices

Cache files using ETag header
Implement retry logic with exponential backoff
Handle large files with streaming

Headers

If-Modified-Since string(date-time)

Browser cache instruction (optional)
If-None-Match string

Browser cache instruction (optional).
If-Unmodified-Since string(date-time)

Browser cache instruction (optional).
If-Match string

Browser cache instruction (optional).

Path parameters

engagementSid string Required

Short unique identifier for engagement
outboundFileCategory string Required

Value is MatcherReport.
uniqueFileName string Required

The name of the file

Responses

200 */*

Success: Response with file stream
Hide headers attributes Show headers attributes
- ETag string
  
  The file's ETag (hash)
- Last-Modified string(date-time)
  
  The file's modified date
304

Not modified
Hide headers attributes Show headers attributes
- ETag string
  
  The file's ETag (hash)
- Last-Modified string(date-time)
  
  The file's modified date
400 application/json

Bad Request: see problem details for more information
Hide response attributes Show response attributes object
- type string | null
- title string | null
- status integer(int32) | null
- detail string | null
- instance string | null
401 application/problem+json

Unauthorized: Missing an authorization header or the token
Hide response attributes Show response attributes object
- type string | null
- title string | null
- status integer(int32) | null
- detail string | null
- instance string | null
403 application/problem+json

Forbidden: You don't have access to the engagement, the engagement doesn't have IH or you don't have IH access on the engagement, or the client is trying to access an unauthorized tenant resource
Hide response attributes Show response attributes object
- type string | null
- title string | null
- status integer(int32) | null
- detail string | null
- instance string | null
404 application/problem+json

Not Found: The file does not exist
Hide response attributes Show response attributes object
- type string | null
- title string | null
- status integer(int32) | null
- detail string | null
- instance string | null
412 application/problem+json

Precondition Failed: Access control list (ACL) validation failed
Hide response attributes Show response attributes object
- type string | null
- title string | null
- status integer(int32) | null
- detail string | null
- instance string | null
500 application/problem+json

Server Error
Hide response attributes Show response attributes object
- type string | null
- title string | null
- status integer(int32) | null
- detail string | null
- instance string | null

GET /api/v3.0/{engagementSid}/files/{outboundFileCategory}/{uniqueFileName}

curl \
 -X GET https://integrationhub.adra.com/api/v3.0/{engagementSid}/files/{outboundFileCategory}/{uniqueFileName} \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "If-Modified-Since: 2024-05-04T09:42:00+00:00" \
 -H "If-None-Match: string" \
 -H "If-Unmodified-Since: 2024-05-04T09:42:00+00:00" \
 -H "If-Match: string"

Response examples (200)

# Headers
ETag: string
Last-Modified: 2024-05-04T09:42:00+00:00

# Payload
@file

Response examples (400)

[
  {
    "type": "string",
    "title": "string",
    "status": 42,
    "detail": "string",
    "instance": "string"
  }
]

Response examples (401)

{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}

Response examples (403)

{
  "type": "https://adra.com/errors/forbidden",
  "title": "Forbidden",
  "detail": "You don't have access to the engagement, the engagement doesn't have IH or you don't have IH access on the engagement",
  "status": 403
}

{
  "type": "https://adra.com/errors/forbidden",
  "title": "Forbidden",
  "detail": "The client is trying to access an unauthorized tenant resource",
  "status": 403
}

Response examples (404)

{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}

Response examples (412)

{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}

Response examples (500)

{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}