Update Field Definitions

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

This endpoint allows updating multiple field definitions at once. The easiest way to accomplish this is to modify the values in the response from the get all field definitions endpoint and send a PATCH request. Changing the values will update existing field definitions within the collection's schema. Any fields sent without a uri field will result in an addition to the schema if the name field is unique within the schema. Fields cannot be deleted with this endpoint.

Valid Authentication Methods

OAuth 2.0 User Token Scopes:

data-service.admin

Response

Language

Credentials

OAuth2


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


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

Valid Authentication Methods

OAuth 2.0 User Token Scopes:

200OK with Array[Field Definition] containing new or updated fields on the collection