Update data schema

PATCH

https://api.hi.umnai.com/data-schemas/:dataSchemaId

PATCH

/data-schemas/:dataSchemaId

$ curl -X PATCH https://api.hi.umnai.com/data-schemas/dataSchemaId \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "operations": [
>     {
>       "op": "sample_op",
>       "path": "/sample/path",
>       "value": {
>         "data_schema_field_id": null,
>         "friendly_name_id": null
>       }
>     }
>   ]
> }'

1 {
2   "id": "22f2c353201d472fbfc7c856eaecaccd",
3   "account": {
4     "id": "cf5b093e7f65480e98107feb78649222",
5     "name": "Sample Account"
6   },
7   "name": "Sample Schema",
8   "fields": [
9     {
10       "created_at": "2026-04-02T08:36:14.974937Z",
11       "data_type": {
12         "data_type": "NUMBER",
13         "format": "INT64"
14       },
15       "designation": "FEATURE",
16       "id": "37fd2c48429440ae981cb9831c66464b",
17       "name": "age",
18       "created_by": {
19         "id": "eca422469dc3270625bf646df3472a45",
20         "name": "Sample User"
21       },
22       "dimension": null,
23       "encoding_type": null,
24       "semantic_type": "CONTINUOUS",
25       "unit": null,
26       "updated_at": null,
27       "vector": false
28     },
29     {
30       "created_at": "2026-04-02T08:36:14.982037Z",
31       "data_type": {
32         "data_type": "STRING",
33         "format": null
34       },
35       "designation": "FEATURE",
36       "id": "95dc4f2aab9242e491b1f109778b0d10",
37       "name": "occuptation",
38       "created_by": {
39         "id": "eca422469dc3270625bf646df3472a45",
40         "name": "Sample User"
41       },
42       "dimension": null,
43       "encoding_type": null,
44       "semantic_type": "CATEGORICAL",
45       "unit": null,
46       "updated_at": null,
47       "vector": false
48     },
49     {
50       "created_at": "2026-04-02T08:36:15.063293Z",
51       "data_type": {
52         "data_type": "NUMBER",
53         "format": "INT64"
54       },
55       "designation": "TARGET",
56       "id": "058383ab0f6c4ce9a078b5f842ace676",
57       "name": "income",
58       "created_by": {
59         "id": "eca422469dc3270625bf646df3472a45",
60         "name": "Sample User"
61       },
62       "dimension": null,
63       "encoding_type": null,
64       "semantic_type": "CATEGORICAL",
65       "unit": null,
66       "updated_at": null,
67       "vector": false
68     }
69   ],
70   "friendly_names": [],
71   "category_friendly_names": [],
72   "data_anchors": [],
73   "data_protections": [],
74   "created_at": "2026-04-02T08:36:14.968725Z",
75   "created_by": {
76     "id": "eca422469dc3270625bf646df3472a45",
77     "name": "Sample User"
78   },
79   "updated_at": null
80 }

Update an existing data schema.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

dataSchemaIdstringRequired

Request

Data schema details to update.

operationslist of objectsOptional

Operations to apply to update the data schema.

Response

Data schema successfully updated.

idstring

Unique ID of the data schema.

accountobject

namestring3-50 characters

Name of the data schema.

fieldslist of objects

The fields of the schema.

friendly_nameslist of objects

The friendly names of the schema.

category_friendly_nameslist of objects

The category friendly names of the schema.

data_anchorslist of objects

The data anchors of the schema.

data_protectionslist of objects

The data protections of the schema.

created_atdatetime

Timestamp when the data schema was created.

created_byobject or null

Reference of the user who created the data schema, if known.

updated_atdatetime

Timestamp when the data schema was last updated.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

409

Conflict Error

500

Internal Server Error