2.2. Captures

class backendapp.captures.schemas.CaptureSampleSchema(*args, **kwargs)

Schema for serialising a CaptureSample model instance.

The POSIX timestamp is excluded.

class Meta

model

alias of backendapp.captures.models.CaptureSample

class backendapp.captures.schemas.CaptureSchema(*args, **kwargs)

Schema for serialising a Capture read from the database.

This is intended for administrators. Links to other Admin API endpoints are included.

class Meta

model

alias of backendapp.captures.models.Capture

admin_capture_url(obj)

Produce an absolute URL for this capture in the Admin API.

admin_tag_url(obj)

Produce an absolute URL for the parent tag in the Admin API.

class backendapp.captures.schemas.CaptureStatusSchema(*args, **kwargs)

Schema for serialising a CaptureStatus model instance.

class Meta

model

alias of backendapp.captures.models.CaptureStatus

class backendapp.captures.schemas.ConsumerCaptureSchema(*args, **kwargs)

Schema for serialising a Capture, which excludes the ID of the parent tag.

Includes a link to download samples for this capture, which saves bandwidth.

class Meta

consumer_capture_url(obj)

Produce an absolute URL for this capture in the Consumer API.

consumer_capturesamples_url(obj)

Produce an absolute URL for the list of samples associated with this capture.

consumer_tag_url(obj)

Produce an absolute URL for the parent tag in the Consumer API.

class backendapp.captures.schemas.ConsumerCaptureSchemaWithSamples(*args, **kwargs)

Schema for serialising a Capture, including tag status information and a list of samples.

class Meta