Create a new data_type

post

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

Path Params

project_id

uuid

required

ID of the project this entity belongs to

Body Params

uuid

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

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

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

kind

string

enum

Kind of the entity

unit

string | null

enum

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_created_at

date-time

Time when the device created the entity

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

Language

Credentials

Bearer

JWT

URL

Response

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

application/json

201Successful response