This page was automatically generated from tracezilla’s Swagger API documentation 2026-07-17

GET /extracts/{extractId}/fields/{extractFieldId}

Get extract field

Description

Returns field resource of field in extract

Parameters (path)

Name Required Description Values
extractId required Target extract.  
extractFieldId required Target extract field.  

Responses

200

successful operation

406

not acceptable

500

internal server error

PUT /extracts/{extractId}/fields/{extractFieldId}

Update existing extract field

Parameters (path)

Name Required Description Values
extractId required Target extract.  
extractFieldId required Target extract field.  

Request body

Description

Data to store.

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

{
  "required": [
    "name"
  ],
  "properties": {
    "id": {
      "description": "Id of the record",
      "type": "string",
      "format": "uuid",
      "example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
    },
    "aggr_function": {
      "description": "No description is available",
      "type": "string",
      "format": "string",
      "example": "A string"
    },
    "alias": {
      "description": "No description is available",
      "type": "string",
      "format": "string",
      "example": "A string"
    },
    "allow_ext_filter": {
      "description": "No description is available",
      "type": "boolean",
      "format": "boolean",
      "example": true
    },
    "exclude": {
      "description": "No description is available",
      "type": "boolean",
      "format": "boolean",
      "example": true
    },
    "hide_from_output": {
      "description": "No description is available",
      "type": "boolean",
      "format": "boolean",
      "example": true
    },
    "extract_id": {
      "description": "No description is available",
      "type": "string",
      "format": "uuid",
      "example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
    },
    "field_name": {
      "description": "No description is available",
      "type": "string",
      "format": "string",
      "example": "A string"
    },
    "filter": {
      "description": "No description is available",
      "type": "string",
      "format": "string",
      "example": "A string"
    },
    "relation_path": {
      "description": "No description is available",
      "type": "string",
      "format": "string",
      "example": "A string"
    },
    "template": {
      "description": "No description is available",
      "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

403

Unauthorized request

406

not acceptable

500

Internal server error