Update data_type by ID

patch https://client-api.{region}.fieldwire.com/api/v3/projects/{project_id}/data_types/{id}

Path Params

project_id

uuid

required

ID of the project this entity belongs to

uuid

required

ID of the entity

Body Params

last_editor_user_id

int32

ID of the user who most recently edited this entity

default_bigint_value

int64 | null

Default big integer value if the kind is bigint

default_boolean_value

boolean | null

Default boolean value if the kind is boolean

default_string_value

string | null

Default string value if the kind is string (suitable for short form text)

name

string

Name of the entity

placeholder

string | null

Placeholder name to use for this data type to be shown in the UI

unit

string | null

The unit of the value this type carries

default_decimal_value

string | null

Default decimal value if the kind is decimal

default_text_value

string | null

Default text value if the kind is text (suitable for long form text)

device_updated_at

date-time

Time when the device last updated the entity

hidden_at

date-time | null

Time when this type was marked as hidden (can be only done if this is marked as strict)

full

boolean

Set to true if should use full serializer

Headers

Fieldwire-Version

date

required

Specifies the version of the API to talk to

Response

Response body

object

uuid

required

ID of the entity

creator_user_id

int32

required

ID of the user who created this entity

last_editor_user_id

int32

required

ID of the user who most recently edited this entity

project_id

uuid

required

ID of the project this entity belongs to

default_bigint_value

int64 | null

Default big integer value if the kind is bigint

default_boolean_value

boolean | null

Default boolean value if the kind is boolean

is_strict

boolean

required

Whether this is strict which means only values from the pre-approved list can be used (denoted by DataTypeValues)

default_string_value

string | null

Default string value if the kind is string (suitable for short form text)

name

string

required

Name of the entity

placeholder

string | null

Placeholder name to use for this data type to be shown in the UI

default_date_value

date | null

Default date value if the kind is date

default_checkbox_value

string | null

Default checkbox value if the kind is checkbox

empty yes no not_applicable

kind

string

required

Kind of the entity

bigint string text boolean decimal date datetime checkbox

unit

string | null

The unit of the value this type carries

temperature currency hours length area volume mass

default_decimal_value

string | null

Default decimal value if the kind is decimal

default_text_value

string | null

Default text value if the kind is text (suitable for long form text)

created_at

date-time

required

Time when the server created the entity

default_datetime_value

date-time | null

Default datetime value if the kind is datetime

deleted_at

date-time | null

Time the server deleted the entity

device_created_at

date-time

required

Time when the device created the entity

device_updated_at

date-time

required

Time when the device last updated the entity

hidden_at

date-time | null

Time when this type was marked as hidden (can be only done if this is marked as strict)

resolved_conflict

boolean

required

Specifies if PUT/PATCH request was rejected - do not store this field!

updated_at

date-time

required

Time when the server last updated the entity

Headers

object

X-Current-User-Id

integer

Current user's id

Language

Credentials

Bearer

JWT

URL


xxxxxxxxxx
1
curl --request PATCH \
2
     --url https://client-api.us.fieldwire.com/api/v3/projects/project_id/data_types/id \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Successful response