Taskflow Backend API

The REST API for taskflow backend operations is described in this document.

Versioning

Media Type

application/vnd.bihealth.sodar.taskflowbackend+json

Current Version

1.0

Accepted Versions

1.0

Header Example

Accept: application/vnd.bihealth.sodar.taskflowbackend+json; version=x.y

API Views

class taskflowbackend.views_api.ProjectLockStatusAPIView(**kwargs)[source]

Return project lock status. Returns True if project is currently locked for taskflow and iRODS operations, False if it is not.

Can only be called on projects, not categories.

URL: /taskflowbackend/api/lock/status/{Project.sodar_uuid}

Methods: GET

Returns:

  • is_locked: Lock status (boolean)