Sign in
clinvarsub

Update Submissionthread

Update submission thread (current user must be owner).

:param id: Submission thread UUID. :return: Submission tread data.

put/api/v1/clinvarsub/submissionthreads/{submissionthread_id}

Request

  • The document declares no server URL.
  • Auth: one of:
    • OAuth 2 (password, token URL /api/v1/auth/login)
    • API key in cookie fastapiusersauth

Path parameters

submissionthread_idstring required

Request body

desired_presence'absent' | 'present' required

Status of a variant in ClinVar.

effective_presence'absent' | 'present'

Status of a variant in ClinVar.

effective_scvstring nullable
status'initial' | 'waiting' | 'in_progress' | 'success' | 'failed' required

Status of a :ref:SubmissionThread.

A thread starts out being in initial state while being edit by the user. It is then submitted into the work queue together with an initial activity where it is waiting to be processed. It is then worked on in the form of activities and ends up being complete or failed. If the latest activity runs into a timeout (e.g., worker death) then this is reflected on the thread as well.

Response

Successful Response

createdstring date-time required
desired_presence'absent' | 'present' required

Status of a variant in ClinVar.

effective_presence'absent' | 'present'

Status of a variant in ClinVar.

effective_scvstring nullable
idstring uuid required
primary_variant_descstring required
status'initial' | 'waiting' | 'in_progress' | 'success' | 'failed' required

Status of a :ref:SubmissionThread.

A thread starts out being in initial state while being edit by the user. It is then submitted into the work queue together with an initial activity where it is waiting to be processed. It is then worked on in the form of activities and ends up being complete or failed. If the latest activity runs into a timeout (e.g., worker death) then this is reflected on the thread as well.

submittingorg_idstring uuid required
updatedstring date-time required

Changes

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