Timeline REST API Documentation

This document contains the HTTP REST API documentation for the timeline app.

Timeline REST API Versioning

Media Type

application/vnd.bihealth.sodar-core.timeline+json

Current Version

1.0

Accepted Versions

1.0

Header Example

Accept: application/vnd.bihealth.sodar-core.timeline+json; version=x.y

Timeline REST API Views

class timeline.views_api.ProjectTimelineEventListAPIView(**kwargs)[source]

List TimelineEvent objects belonging in a category or project. Events are ordered from newest to oldest.

Supports optional pagination by providing the page query string. This will return results in the Django Rest Framework PageNumberPagination format.

URL: /timeline/api/list/{Project.sodar_uuid}

Methods: GET

Parameters:

  • page: Page number for paginated results (int, optional)

Returns: List or paginated dict of TimelineEvent objects (see TimelineEventRetrieveAPIView)

class timeline.views_api.SiteTimelineEventListAPIView(**kwargs)[source]

List site-wide TimelineEvent objects. Events are ordered from newest to oldest.

Supports optional pagination by providing the page query string. This will return results in the Django Rest Framework PageNumberPagination format.

URL: /timeline/api/list/site

Methods: GET

Parameters:

  • page: Page number for paginated results (int, optional)

Returns: List or paginated dict of TimelineEvent objects (see TimelineEventRetrieveAPIView)

class timeline.views_api.TimelineEventRetrieveAPIView(**kwargs)[source]

Retrieve TimelineEvent object.

Extra data is only returned for users with sufficient permissions (superusers, project owners and delegates).

URL: /timeline/api/retrieve/{TimelineEvent.sodar_uuid}

Methods: GET

Returns:

  • project: Project UUID (string or None)

  • app: App name (string)

  • user: UUID of user who created the event (string or None)

  • event_name: Event name (string)

  • description: Event description (string)

  • extra_data: Event extra data (JSON or None)

  • classified: Whether event is classified (boolean)

  • status_changes: List of TimelineEventStatus objects (JSON)

    • event: TimelineEvent UUID (string)

    • timestamp: Status datetime (YYYY-MM-DDThh:mm:ssZ)

    • status_type: Status type (string)

    • description: Status description (string)

    • extra_data: Status extra data (JSON or None)

    • sodar_uuid: Status UUID (string)

  • event_objects: List of TimelineEventObjectRef objects (JSON)

    • event: TimelineEvent UUID (string)

    • label: Object label as given in event description (string)

    • name: Name for identifying the object (string)

    • object_uuid: UUID of the referred object (string)

    • extra_data: Object reference extra data (JSON or None)

    • sodar_uuid: Object reference UUID (string)

  • sodar_uuid: TimelineEvent UUID (string)

Version Changes:

  • 2.0: Return user as UUID instead of SODARUserSerializer dict

Timeline REST API Version Changes

v2.0

  • TimelineEventRetrieveAPIView

    • Return user as UUID instead of SODARUserSerializer dict