Sign in

v1

latestOpenAPI 3.0.32026-07-246304082.0 MB
data types

Update data_type by ID

patch/api/v3/projects/{project_id}/data_types/{id}

Path parameters

project_idstring uuid required

ID of the project this entity belongs to

idstring uuid required

ID of the entity

Headers

Fieldwire-Versionstring date required

Specifies the version of the API to talk to

Request body

last_editor_user_idinteger

ID of the user who most recently edited this entity

default_bigint_valueinteger nullable

Default big integer value if the kind is bigint

default_boolean_valueboolean nullable

Default boolean value if the kind is boolean

default_string_valuestring nullable

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

namestring

Name of the entity

placeholderstring nullable

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

unit'temperature' | 'currency' | 'hours' | 'length' | 'area' | 'volume' | 'mass' | 'null' nullable

The unit of the value this type carries

default_decimal_valuestring nullable

Default decimal value if the kind is decimal

default_text_valuestring nullable

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

device_updated_atstring date-time

Time when the device last updated the entity

hidden_atstring date-time nullable

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

fullboolean

Set to true if should use full serializer

Response

Successful response

idstring uuid required

ID of the entity

creator_user_idinteger required

ID of the user who created this entity

last_editor_user_idinteger required

ID of the user who most recently edited this entity

project_idstring uuid required

ID of the project this entity belongs to

default_bigint_valueinteger nullable

Default big integer value if the kind is bigint

default_boolean_valueboolean nullable

Default boolean value if the kind is boolean

is_strictboolean required

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

default_string_valuestring nullable

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

namestring required

Name of the entity

placeholderstring nullable

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

default_date_valuestring date nullable

Default date value if the kind is date

default_checkbox_value'empty' | 'yes' | 'no' | 'not_applicable' | 'null' nullable

Default checkbox value if the kind is checkbox

kind'bigint' | 'string' | 'text' | 'boolean' | 'decimal' | 'date' | 'datetime' | 'checkbox' required

Kind of the entity

unit'temperature' | 'currency' | 'hours' | 'length' | 'area' | 'volume' | 'mass' | 'null' nullable

The unit of the value this type carries

default_decimal_valuestring nullable

Default decimal value if the kind is decimal

default_text_valuestring nullable

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

created_atstring date-time required

Time when the server created the entity

default_datetime_valuestring date-time nullable

Default datetime value if the kind is datetime

deleted_atstring date-time nullable

Time the server deleted the entity

device_created_atstring date-time required

Time when the device created the entity

device_updated_atstring date-time required

Time when the device last updated the entity

hidden_atstring date-time nullable

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

resolved_conflictboolean required

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

updated_atstring date-time required

Time when the server last updated the entity