Create data field on entity

post

https://api-us.streamline.intellistack.ai/v1/data-catalog/entity/{entityId}/data-fields

Path Params

entityId

uuid

required

Unique identifier of the entity to add a field to

Body Params

caseSensitivityCapability

string

enum

Allowed:

collectionType

string | null

enum

Type of collection this field represents. Null for scalar (non-collection) fields.

Allowed:

createable

boolean

Field value can be provided on record creation

createdAt

date-time

Timestamp when this field was created

dataClassCodeVersion

string

Code version of the model used to classify the field

dataClassId

string

ID of the data class this field belongs to

dataClassModelVersion

string

Weights version of the model used to classify the field

dataClassName

string

Name of the data class this field belongs to

defaultValue

object

Information about default value of the field

definitionId

string

ID of the field definition

definitionVersion

string

Version of the field definition

descriptor

string

Human-readable description of the field

discoveredValues

array

Sample values found during discovery. These would be enums in SQL systems.

discoveredValues

entityId

uuid

ID of the entity this field belongs to

fieldMetadata

object

Metadata for the current field

hidden

boolean

Indicates if field is hidden

uuid

Unique identifier for the field

isDataClassOverridden

boolean

Indicates if the data class is overridden for this field

isManaged

boolean

Indicates if this field is managed by the system

isPrimaryKey

boolean

Indicates if field is a part of the entitie's primary key

label

string

Display label for the field

locator

string

Expression used to locate this field in the source data

nativeIdentifier

string

Original identifier from the source system

nullable

boolean

Field can be null

organizationId

uuid

Organization that owns this field

originalDataClassId

string

Original data class ID before override

required

boolean

Indicates if field must be provided in insertion request

scalarType

string

Data type of the field

searchable

boolean

Indicates if this field can be searched

sortable

boolean

Existing field value can be sorted

updateable

boolean

Existing field value can be updated

Response

200Successful operation