Attachments

Retrieve an attachment.

get

Retrieve an attachment by its ID.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstring · uuidRequired

Id of the retrieved attachment.

Query parameters

presignbooleanOptional

When set to "true", adds the "fileUrl" field to the response object. "fileUrl" enables you to download the uploaded file associated with this attachment. If the file has not been malware-scanned and identified as clean yet, it will ignore the "presign" query string parameter and not set the "fileUrl" field. Any other value than "true" will be ignored.

Example: true

Responses

200Success

application/json

idstringRequired

id of this entity

Example: 02c36247-1aad-41ba-aa49-f114ca4c263f

updatedAtstringRequired

ISO 8601

Example: 2023-07-28T09:13:37Z

createdAtstringRequired

ISO 8601

Example: 2023-07-28T09:13:37Z

fileUrlstringOptional

Absolute URL to download the file that this attachment is representing. Usage example: curl

Example: https://tradeaware.live-eo.com/api/biz-id-74b46f10-4d05-467d-bbfd-e2386772ff9b/atc-id-60bcd197-84d7-45e4-ae5f-827c8e739185.pdf

filenamestringRequired

Name of file, including extension

Example: testfile.txt

fileSizeKbnumberRequired

File size in kilobytes (KB)

Example: 1024

uploadedByUserIdstring · nullableRequired

The Auth0 user ID of the user who uploaded the file. Null if the attachment was uploaded by an M2M client.

Example: auth0|1234567890abcdef

400Error

401Error

403Error

404Error

501

501 Not Implemented when the feature is not enabled on this environment.

get

/attachments/{id}

HTTPcURLJavaScriptPython

GET /attachments/{id} HTTP/1.1
Host: api.tradeaware.live-eo.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "02c36247-1aad-41ba-aa49-f114ca4c263f",
  "updatedAt": "2023-07-28T09:13:37Z",
  "createdAt": "2023-07-28T09:13:37Z",
  "fileUrl": "https://tradeaware.live-eo.com/api/biz-id-74b46f10-4d05-467d-bbfd-e2386772ff9b/atc-id-60bcd197-84d7-45e4-ae5f-827c8e739185.pdf",
  "filename": "testfile.txt",
  "fileSizeKb": 1024,
  "uploadedByUserId": "auth0|1234567890abcdef"
}

Upload a file.

post

Create an attachment which represents the upload of an individual file.

Allowed file types are: pdf, doc, docx, xls, xlsx, jpeg, jpg, png, tif, tiff, heic, csv, txt, rtf.

Filenames must be less than 200 characters (including the file extension),and must no contain any of the following characters: % { } < > / \ " ` '

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

multipart/form-data

filestring · binaryRequired

File data

Responses

201Success

application/json

400Error

401Error

403Error

415Error

501

501 Not Implemented when the feature is not enabled on this environment.

post

/attachments

HTTPcURLJavaScriptPython

POST /attachments HTTP/1.1
Host: api.tradeaware.live-eo.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 17

{
  "file": "binary"
}

{
  "id": "02c36247-1aad-41ba-aa49-f114ca4c263f",
  "updatedAt": "2023-07-28T09:13:37Z",
  "createdAt": "2023-07-28T09:13:37Z",
  "fileUrl": "https://tradeaware.live-eo.com/api/biz-id-74b46f10-4d05-467d-bbfd-e2386772ff9b/atc-id-60bcd197-84d7-45e4-ae5f-827c8e739185.pdf",
  "filename": "testfile.txt",
  "fileSizeKb": 1024,
  "uploadedByUserId": "auth0|1234567890abcdef"
}