home api list

Hexostore API Documentation

studygeneratedreport

/api/studygeneratedreport/

List methods: post, get

Detail methods: options, post, get, put, patch, delete

Fields

id: IntegerField

This field is readonly.

resource_uri: RelatedUrlField

A reference to the resource. Maybe specified by URI or ID

This field is readonly.

study: RelatedUrlField

A reference to the resource. Maybe specified by URI or ID

This field will default to: '' (empty string)

subject: RelatedUrlField

A reference to the resource. Maybe specified by URI or ID

This field may be blank

This field will default to: '' (empty string)

owner: RelatedUrlField

A reference to the resource. Maybe specified by URI or ID

This field will default to: '' (empty string)

report: RelatedUrlField

A reference to the resource. Maybe specified by URI or ID

This field will default to: '' (empty string)

status: ChoiceField

This field may be blank

Choices : [(0, 'Pending'), (1, 'In Progress'), (2, 'Ready')]

This field will default to: '' (empty string)

created_at: DateTimeField

This field may be blank

This field will default to: '' (empty string)

data: JSONField

All the info of the generated report

This field may be blank

This field will default to: '' (empty string)

parameters: JSONField

All parameters to generate the report

This field may be blank

This field will default to: '' (empty string)

is_empty: BooleanField

True if data is empty or None

This field may be blank

This field will default to: '' (empty string)

Filtering Options

id: exact, in, gt, gte, lt, lte, range

is_empty: exact

status: exact

study: exact, in, isnull

subject: exact, in, isnull

Sorting Options

No sorting supported

© 2024 by CarrĂ© Technologies Inc.