Sign in
clinvarsub

Update Submissionactivity

Create a new submission activity in the given thread.

:param submissionthread_id: Submission thread UUID. :return: Created submission activity.

put/api/v1/clinvarsub/submissionactivities/{submissionactivity_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

submissionactivity_idstring required

Request body

kind'create' | 'retrieve' | 'update' | 'delete' required

Type of the :ref:SubmissionActivity.

request_timestampstring date-time nullable
response_timestampstring date-time nullable
status'initial' | 'waiting' | 'in_progress' | 'complete_success' | 'complete_failure' | 'complete_in_progress' | 'failed' | 'timeout' required

Status of a :ref:SubmissionActivity.

An activity starts out waiting in the queue to be picked up by the worker, goes on into being processed, and ends up being complete or failed. An activity can also end up being in a timeout state.

Response

Successful Response

createdstring date-time required
idstring uuid required
kind'create' | 'retrieve' | 'update' | 'delete' required

Type of the :ref:SubmissionActivity.

request_timestampstring date-time nullable
response_timestampstring date-time nullable
status'initial' | 'waiting' | 'in_progress' | 'complete_success' | 'complete_failure' | 'complete_in_progress' | 'failed' | 'timeout' required

Status of a :ref:SubmissionActivity.

An activity starts out waiting in the queue to be picked up by the worker, goes on into being processed, and ends up being complete or failed. An activity can also end up being in a timeout state.

submissionthread_idstring uuid required

Changes

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