BEbenchling
Attachment

Get Attachment by ID

Get a single Attachment by ID.

get/api/v3/attachment/{attachment_id}

Request

  • Base URL
    https://{tenant_name}.benchling.com
  • Auth
    HTTP bearer

Path parameters

attachment_idstring required

ID of the Attachment.

Query parameters

returningstring[]

Comma-separated list of top-level fields to include in each returned item. Cannot overlap with omit.

omitstring[]

Comma-separated list of top-level fields to omit from each returned item. Cannot overlap with returning.

Response

OK

__typenamestring
createdAtstring datetime
downloadUrlstring nullable

A pre-signed download URL. The URL may be null if the file did not upload successfully.

idstring
mimeTypestring

The MIME type of the file, e.g. 'image/jpeg'

namestring
uploadStatus'SUCCEEDED' | 'FAILED_VALIDATION' | 'IN_PROGRESS' | 'NOT_UPLOADED'

Whether the attachment uploaded successfully, failed to upload or is still uploading.

Changes

No recorded changes to this operation across all 1 revision of this API.