Endpoints

Retrieve Screen Summary

Return summary data for a previously submitted screen.

Please refer to this <a href="#tag/Compliance-Reason-Codes"> list of compliance reason codes</a>.

get/v2/screens/{id}

Request

  • Base URL: https://api.aclid.bio (the document declares no server; this is the origin it was published from)
  • URL: https://api.aclid.bio/v2/screens/{id}
  • Auth: none declared

Path parameters

idstring required

Response

Successful Response

idstring required

Unique indentifier for this screen.

namestring nullable

User provided identifier for this screen.

userstring required

The ID of the user that initiated this screen.

verification_completed_atstring date-time nullable
verification_urlstring nullable
createdinteger required

Specifies the time this screen was created in epoch format.

updatedinteger nullable

Specifies the time this screen was updated in epoch format.

status'pending_upload' | 'queued' | 'running' | 'succeeded' | 'failed' | 'deleted' | 'archived' required
lengthinteger nullable

Cumulative length of all sequences in the screen.

match_countinteger nullable

Cumulative number of alignments to all sequences in the screen.

findingsobject nullable required

Map of regulatory concerns for the screen. See compliance reason codes above.

regulatory_status'controlled' | 'not_controlled' required
sequencesobject nullable

Sequences of the screen.

versionstring nullable

Version of our internal screening tool used to generate this report.

verification_status'submitted' | 'partially_submitted' | 'missing_verification' | 'not_required'
decision_status'awaiting' | 'approved' | 'rejected' | 'escalated'
material_summaryobject nullable

Summary of top materials in a screen

material_countinteger nullable

Number of unique controlled materials in a screen

request_frameworksstring[] nullable

List of frameworks requested in the screen.

Example response

{
  "id": "230408145715_yPSG4Ery",
  "user": "ash.braxton@reallygreatlab.com"
}

Changes

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