This page was automatically generated from tracezilla’s Swagger API documentation 2026-01-26

GET /tracker-records/{trackerRecordId}

Show tracker record

Description

Returns tracker record

Parameters (path)

Name Required Description Values
trackerRecordId required Target Tracker Record.  

Responses

200

successful operation

Response content JSON schema 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98

{
  "properties": {
    "properties": {
      "id": {
        "description": "Id of the record",
        "type": "string",
        "format": "uuid",
        "example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
      },
      "tracker_ref": {
        "description": "Reference code for the tracker",
        "type": "string",
        "format": "string",
        "example": "A string"
      },
      "record_ref": {
        "description": "Reference for the actual record within the tracker",
        "type": "string",
        "format": "string",
        "example": "A string"
      },
      "started_at": {
        "description": "For time based trackers. When the tracking was started",
        "type": "string",
        "format": "date-time",
        "example": "2019-01-01T13:25:32.312Z"
      },
      "finished_at": {
        "description": "For time based trackers. When the tracking was finished",
        "type": "string",
        "format": "date-time",
        "example": "2019-01-01T13:25:32.312Z"
      },
      "tracked_from": {
        "description": "For time based trackers. Start time for the actual tracking",
        "type": "string",
        "format": "date-time",
        "example": "2019-01-01T13:25:32.312Z"
      },
      "tracked_to": {
        "description": "For time based trackers. End time for the actual tracking",
        "type": "string",
        "format": "date-time",
        "example": "2019-01-01T13:25:32.312Z"
      },
      "free_double_1": {
        "description": "Free value field for numeric data type",
        "type": "number",
        "format": "double",
        "example": 1234.123
      },
      "free_double_2": {
        "description": "Free value field for numeric data type",
        "type": "number",
        "format": "double",
        "example": 1234.123
      },
      "free_int_1": {
        "description": "Free value field for integer data type",
        "type": "integer",
        "format": "int32",
        "example": 1234
      },
      "free_int_2": {
        "description": "Free value field for integer data type",
        "type": "integer",
        "format": "int32",
        "example": 564
      },
      "free_text_1": {
        "description": "Free value field for text data type",
        "type": "string",
        "format": "string",
        "example": "A string"
      },
      "free_text_2": {
        "description": "Free value field for text data type",
        "type": "string",
        "format": "string",
        "example": "A string"
      },
      "created_at": {
        "description": "The time when the record was created in UTC date & time (Iso8601 ZuluString)",
        "type": "string",
        "format": "date-time",
        "example": "2019-01-01T13:25:32.312Z"
      },
      "updated_at": {
        "description": "The time when the record was last updated in UTC date & time (Iso8601 ZuluString)",
        "type": "string",
        "format": "date-time",
        "example": "2020-01-01T13:25:32.312Z"
      }
    },
    "type": "object"
  },
  "type": "object"
}

406

not acceptable

500

internal server error

PUT /tracker-records/{trackerRecordId}

Update tracker record

Parameters (path)

Name Required Description Values
trackerRecordId required Target Tracker Record.  

Request body

Description

Target Tracker record.

Required

This parameter is required.

Request body JSON schema 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95

{
  "properties": {
    "id": {
      "description": "Id of the record",
      "type": "string",
      "format": "uuid",
      "example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
    },
    "tracker_ref": {
      "description": "Reference code for the tracker",
      "type": "string",
      "format": "string",
      "example": "A string"
    },
    "record_ref": {
      "description": "Reference for the actual record within the tracker",
      "type": "string",
      "format": "string",
      "example": "A string"
    },
    "started_at": {
      "description": "For time based trackers. When the tracking was started",
      "type": "string",
      "format": "date-time",
      "example": "2019-01-01T13:25:32.312Z"
    },
    "finished_at": {
      "description": "For time based trackers. When the tracking was finished",
      "type": "string",
      "format": "date-time",
      "example": "2019-01-01T13:25:32.312Z"
    },
    "tracked_from": {
      "description": "For time based trackers. Start time for the actual tracking",
      "type": "string",
      "format": "date-time",
      "example": "2019-01-01T13:25:32.312Z"
    },
    "tracked_to": {
      "description": "For time based trackers. End time for the actual tracking",
      "type": "string",
      "format": "date-time",
      "example": "2019-01-01T13:25:32.312Z"
    },
    "free_double_1": {
      "description": "Free value field for numeric data type",
      "type": "number",
      "format": "double",
      "example": 1234.123
    },
    "free_double_2": {
      "description": "Free value field for numeric data type",
      "type": "number",
      "format": "double",
      "example": 1234.123
    },
    "free_int_1": {
      "description": "Free value field for integer data type",
      "type": "integer",
      "format": "int32",
      "example": 1234
    },
    "free_int_2": {
      "description": "Free value field for integer data type",
      "type": "integer",
      "format": "int32",
      "example": 564
    },
    "free_text_1": {
      "description": "Free value field for text data type",
      "type": "string",
      "format": "string",
      "example": "A string"
    },
    "free_text_2": {
      "description": "Free value field for text data type",
      "type": "string",
      "format": "string",
      "example": "A string"
    },
    "created_at": {
      "description": "The time when the record was created in UTC date & time (Iso8601 ZuluString)",
      "type": "string",
      "format": "date-time",
      "example": "2019-01-01T13:25:32.312Z"
    },
    "updated_at": {
      "description": "The time when the record was last updated in UTC date & time (Iso8601 ZuluString)",
      "type": "string",
      "format": "date-time",
      "example": "2020-01-01T13:25:32.312Z"
    }
  },
  "type": "object"
}

Responses

200

successful operation

Response content JSON schema 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98

{
  "properties": {
    "properties": {
      "id": {
        "description": "Id of the record",
        "type": "string",
        "format": "uuid",
        "example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
      },
      "tracker_ref": {
        "description": "Reference code for the tracker",
        "type": "string",
        "format": "string",
        "example": "A string"
      },
      "record_ref": {
        "description": "Reference for the actual record within the tracker",
        "type": "string",
        "format": "string",
        "example": "A string"
      },
      "started_at": {
        "description": "For time based trackers. When the tracking was started",
        "type": "string",
        "format": "date-time",
        "example": "2019-01-01T13:25:32.312Z"
      },
      "finished_at": {
        "description": "For time based trackers. When the tracking was finished",
        "type": "string",
        "format": "date-time",
        "example": "2019-01-01T13:25:32.312Z"
      },
      "tracked_from": {
        "description": "For time based trackers. Start time for the actual tracking",
        "type": "string",
        "format": "date-time",
        "example": "2019-01-01T13:25:32.312Z"
      },
      "tracked_to": {
        "description": "For time based trackers. End time for the actual tracking",
        "type": "string",
        "format": "date-time",
        "example": "2019-01-01T13:25:32.312Z"
      },
      "free_double_1": {
        "description": "Free value field for numeric data type",
        "type": "number",
        "format": "double",
        "example": 1234.123
      },
      "free_double_2": {
        "description": "Free value field for numeric data type",
        "type": "number",
        "format": "double",
        "example": 1234.123
      },
      "free_int_1": {
        "description": "Free value field for integer data type",
        "type": "integer",
        "format": "int32",
        "example": 1234
      },
      "free_int_2": {
        "description": "Free value field for integer data type",
        "type": "integer",
        "format": "int32",
        "example": 564
      },
      "free_text_1": {
        "description": "Free value field for text data type",
        "type": "string",
        "format": "string",
        "example": "A string"
      },
      "free_text_2": {
        "description": "Free value field for text data type",
        "type": "string",
        "format": "string",
        "example": "A string"
      },
      "created_at": {
        "description": "The time when the record was created in UTC date & time (Iso8601 ZuluString)",
        "type": "string",
        "format": "date-time",
        "example": "2019-01-01T13:25:32.312Z"
      },
      "updated_at": {
        "description": "The time when the record was last updated in UTC date & time (Iso8601 ZuluString)",
        "type": "string",
        "format": "date-time",
        "example": "2020-01-01T13:25:32.312Z"
      }
    },
    "type": "object"
  },
  "type": "object"
}

403

Unauthorized request

406

not acceptable

500

Internal server error

DELETE /tracker-records/{trackerRecordId}

Delete tracker record

Parameters (path)

Name Required Description Values
trackerRecordId required Target Tracker Record.  

Responses

201

Tracker record was deleted

403

Unauthorized request

406

not acceptable

500

Internal server error