Update Field Definition

patch https://data.lucid.app/collections/{collectionId}/schema/{fieldDefinitionId}

This endpoint takes a Field Definition, which is used to update the specified field definition. The easiest way to accomplish this is to modify the values in the response from the GET field definition endpoint and send a PATCH request.

Valid Authentication Methods

OAuth 2.0 User Token Scopes:

data-service.admin

Path Params

collectionId

integer

required

ID of collection to update field definition for

fieldDefinitionId

integer

required

ID of field definition to update

Body Params

name

string

Name of the field

fieldType

string

Stores the type of the field. The type does not affect how the data is interpreted in the Data Service; it is for use on the client side. Valid values include BOOLEAN, STRING, NUMBER, and ANY.

collection

string

Link to the associated collection

isPrimary

boolean

Denotes whether the specified field is part of the primary key. The default value is false

order

string

Denotes a default ordering for the fields. This is currently used by the Lucid client to determine the order in which the fields are displayed, unless the context suggests a better ordering.

default

string

Default value for this field

label

string

Override name for field which is used when displaying to users

Response

Language

Credentials

OAuth2


xxxxxxxxxx
1
curl --request PATCH \
2
     --url https://data.lucid.app/collections/collectionId/schema/fieldDefinitionId \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'


xxxxxxxxxx
10
 
1
{
2
  "uri": "https://data.lucid.app/collections/2/schema/4",
3
  "name": "Co1B",
4
  "fieldType": "STRING",
5
  "collection": "https://data.lucid.app/collections/2",
6
  "isPrimary": false,
7
  "order": "1",
8
  "default": "5",
9
  "label": "User Friendly Field Name"
10
}

Valid Authentication Methods

OAuth 2.0 User Token Scopes:

200OK with Field Definition containing new or updated fields