Update custom schema | Candid

1 import uuid 2 3 from candid import CandidApiClient 4 from candid.resources.commons import Primitive 5 from candid.resources.custom_schemas.resources.v_1 import SchemaField 6 7 client = CandidApiClient( 8 client_id="YOUR_CLIENT_ID", 9 client_secret="YOUR_CLIENT_SECRET", 10 ) 11 client.custom_schemas.v_1.update( 12 schema_id=uuid.UUID( 13 "ec096b13-f80a-471d-aaeb-54b021c9d582", 14 ), 15 name="General Medicine and Health", 16 description="Values collected during all visits", 17 fields_to_add=[ 18 SchemaField( 19 key="visit_type", 20 type=Primitive.STRING, 21 ) 22 ], 23 )

1 { 2 "id": "ec096b13-f80a-471d-aaeb-54b021c9d582", 3 "name": "General Medicine and Health", 4 "fields": [ 5 { 6 "key": "provider_category", 7 "type": "STRING" 8 }, 9 { 10 "key": "is_urgent_care", 11 "type": "BOOLEAN" 12 }, 13 { 14 "key": "bmi", 15 "type": "DOUBLE" 16 }, 17 { 18 "key": "age", 19 "type": "INTEGER" 20 }, 21 { 22 "key": "visit_type", 23 "type": "STRING" 24 } 25 ], 26 "description": "Values collected during all visits" 27 }

Update the name, description, or keys on a preexisting schema.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

schema_idUUIDRequired

Request

This endpoint expects an object.

namestringOptional

descriptionstringOptional

fields_to_addlist of objectsOptional

A list of typed entries to add to schema. Only additive modifications are permitted.

Response

This endpoint returns an object.

idUUID

namestring

fieldslist of objects

descriptionstring or null

Authentication

Path parameters

Request

Response

Errors