Measurement Markers - Access object to measurement markers¶

Provides access API to measurement marker resources. A measurement marker is a tag that is attached to the measurement at a specific time or a specific section.

Request Methods¶

Warning

Be sure to create the access object using measurement_markers on client.

client = intdash.Client(...)
client.measurement_markers.get(marker_uuid='704be0f0-11d2-4c0b-aeaa-251bad85e067')

class MeasurementMarkers(...)[source]¶

Access object to the measurement marker resources.

create(measurement_uuid, type, detail, name=None, description=None, tag=None)[source]¶

Creates a measurement marker on the server.

Parameters

measurement_uuid (str) – Measurement UUID
type (MeasurementMarkerType) – Measurement marker type (point or range)
detail (MeasurementMarkerDetail) – Details of a measurement marker
name (str) – Measurement marker name
description (str) – Description
tag (dict) – Tag information

Returns

Measurement marker object

Return type

MeasurementMarker

Note

To detail, assign the following objects according to the specified type.

If type is point, assign intdash.MeasurementMarkerDetailPoint.
If type is range, assign intdash.MeasurementMarkerDetailRange.

Note

Only a Key(string) and Value(string) pair can be registered as a tag.

// NG
{
    "tagkey" : {
        "nestKey": "not allowed"
    }
}

// OK
{
    "tagkey1" : "ok"
    "tagkey2" : "ok"
}

delete(marker_uuid, measurement_uuid=None)[source]¶

Delete the measurement marker from the server.

Parameters

marker_uuid (str) – UUID of the marker to be deleted
measurement_uuid (str) – UUID of the measurement that is associated with the measurement marker to be deleted

Note

An error will occur if the measurement marker specified by marker_uuid is not associated with the measurement specified by measurement_uuid.

get(marker_uuid)[source]¶

Retrieves the measurement marker.

Parameters: marker_uuid (str) – UUID of the measurement marker to be retrieved
Returns: Measurement marker object
Return type: MeasurementMarker

list(measurement_uuid)[source]¶

Retrieve all measurement markers associated with the measurement UUID.

Parameters: measurement_uuid (str) – Measurement UUID
Returns: List of measurement marker objects
Return type: list[MeasurementMarker]

update(marker_uuid, measurement_uuid=None, name=None, description=None, type=None, detail=None, tag=None)[source]¶

Updates the measurement marker.

Parameters

marker_uuid (str) – UUID of the measurement marker to be updated
measurement_uuid (str) – UUID of the measurement associated with the measurement marker to be updated
type (MeasurementMarkerType) – Measurement marker type (point or range)
detail (MeasurementMarkerDetail) – Details of a measurement marker
name (str) – Measurement marker name
description (str) – Description
tag (dict) – Tag information

Returns

Measurement marker object

Return type

MeasurementMarker

Note

To detail, assign the following objects according to the specified type. If type is point, assign MeasurementMarkerDetailPoint. If type is range, assign MeasurementMarkerDetailRange.

Note

The measurement marker with the marker_uuid will not be updated if it is not associated with the measurement specified by measurement_uuid.

Request Params¶

class MeasurementMarkerType(...)[source]¶

A constant that represents the type of a measurement marker.

point = 'point'¶

range = 'range'¶

class MeasurementMarkerDetail(...)[source]¶: Base class for a detailed request of a measurement marker.

class MeasurementMarkerDetailPoint(...)[source]¶

Object for a detailed request of a point-type measurement marker.

occurred_elapsed_time¶

Elapsed time from the measurement start time to the measurement marker start time

Type: pandas.Timedelta

class MeasurementMarkerDetailRange(...)[source]¶

Object for a detailed request of a range-type measurement marker.

start_elapsed_time¶

Elapsed time from the measurement start time to the measurement marker start time

Type: pandas.Timedelta

end_elapsed_time¶

Elapsed time from the measurement start time to the measurement marker end time

Type: pandas.Timedelta

Response¶

class MeasurementMarker(...)[source]¶

Object that represents a measurement marker.

uuid¶

UUID

Type: str

name¶

Measurement marker name

Type: str

description¶

Description of a measurement marker

Type: str

type¶

Type of measurement marker

Type: MeasurementMarkerType

detail¶

Details of a measurement marker

Type: MeasurementMarkerDetail

tag¶

Measurement marker tag

Type: dict

created_at¶

Created time

Type: pandas.Timestamp

created_by¶

Creator

Type: str

updated_at¶

Updated time

Type: pandas.Timestamp

updated_by¶

Updater

Type: str