--- updatedAt: 2025-08-03T18:10:57.000Z agentTools: projectIndex: https://developer.intellistack.com/llms.txt --- # Get data fields on an entity # OpenAPI definition ```json { "components": { "schemas": { "CaseSensitivityCapability": { "enum": [ "UNKNOWN", "CASE_SENSITIVE_ONLY", "CASE_INSENSITIVE_SLOW", "CASE_INSENSITIVE" ], "type": "string" }, "CollectionType": { "description": "Type of collection this field represents.\nNull for scalar (non-collection) fields.\n", "enum": [ "ORDERED_LIST", "UNORDERED_LIST" ], "nullable": true, "type": "string" }, "DataField": { "description": "Represents a field within a data entity", "properties": { "caseSensitivityCapability": { "$ref": "#/components/schemas/CaseSensitivityCapability" }, "collectionType": { "$ref": "#/components/schemas/CollectionType" }, "createable": { "description": "Field value can be provided on record creation", "type": "boolean" }, "createdAt": { "description": "Timestamp when this field was created", "format": "date-time", "type": "string" }, "dataClassCodeVersion": { "description": "Code version of the model used to classify the field", "type": "string" }, "dataClassId": { "description": "ID of the data class this field belongs to", "type": "string" }, "dataClassModelVersion": { "description": "Weights version of the model used to classify the field", "type": "string" }, "dataClassName": { "description": "Name of the data class this field belongs to", "type": "string" }, "defaultValue": { "$ref": "#/components/schemas/DefaultValue" }, "definitionId": { "description": "ID of the field definition", "type": "string" }, "definitionVersion": { "description": "Version of the field definition", "type": "string" }, "descriptor": { "description": "Human-readable description of the field", "type": "string" }, "discoveredValues": { "description": "Sample values found during discovery. These would be enums in SQL systems.", "items": { "format": "object" }, "type": "array" }, "entityId": { "description": "ID of the entity this field belongs to", "format": "uuid", "type": "string" }, "fieldMetadata": { "$ref": "#/components/schemas/FieldMetadata" }, "hidden": { "description": "Indicates if field is hidden", "type": "boolean" }, "id": { "description": "Unique identifier for the field", "format": "uuid", "type": "string" }, "isDataClassOverridden": { "description": "Indicates if the data class is overridden for this field", "type": "boolean" }, "isManaged": { "description": "Indicates if this field is managed by the system", "nullable": false, "type": "boolean" }, "isPrimaryKey": { "description": "Indicates if field is a part of the entitie's primary key", "type": "boolean" }, "label": { "description": "Display label for the field", "type": "string" }, "locator": { "description": "Expression used to locate this field in the source data", "type": "string" }, "nativeIdentifier": { "description": "Original identifier from the source system", "type": "string" }, "nullable": { "description": "Field can be null", "type": "boolean" }, "organizationId": { "description": "Organization that owns this field", "format": "uuid", "type": "string" }, "originalDataClassId": { "description": "Original data class ID before override", "type": "string" }, "required": { "description": "Indicates if field must be provided in insertion request", "type": "boolean" }, "scalarType": { "description": "Data type of the field", "type": "string" }, "searchable": { "description": "Indicates if this field can be searched", "type": "boolean" }, "sortable": { "description": "Existing field value can be sorted", "type": "boolean" }, "updateable": { "description": "Existing field value can be updated", "type": "boolean" } }, "type": "object" }, "DateTimeOffsetConfig": { "description": "Configuration for datetime field offset handling strategy", "properties": { "defaultOffset": { "description": "Default timezone offset in format +HH:MM or -HH:MM", "example": "+00:00", "pattern": "^[+-]\\d{2}:\\d{2}$", "type": "string" }, "storeStrategy": { "$ref": "#/components/schemas/DateTimeStoreStrategy" } }, "required": [ "storeStrategy", "defaultOffset" ], "type": "object" }, "DateTimeStoreStrategy": { "description": "Strategy for storing datetime values:\n- UTC_ONLY: Always store in UTC, ignore incoming offsets\n- DYNAMIC_OFFSET: Preserve offset from incoming data\n", "enum": [ "UTC_ONLY", "DYNAMIC_OFFSET" ], "example": "UTC_ONLY", "type": "string" }, "DefaultValue": { "description": "Information about default value of the field", "properties": { "defaultExpression": { "description": "Original expression which evaluates to default value", "type": "string" }, "type": { "description": "Type of the default value", "enum": [ "UNKNOWN", "LITERAL", "CURRENT_DATE", "CURRENT_TIMESTAMP", "RANDOM_UUID" ], "type": "string" }, "value": { "description": "Evaluated value in internal representation if static evaluation is possible", "type": "object" } }, "type": "object" }, "FieldMetadata": { "description": "Metadata for the current field", "properties": { "allowedDateTimeStrategies": { "description": "List of allowed datetime storage strategies for this field", "items": { "$ref": "#/components/schemas/DateTimeStoreStrategy" }, "type": "array" }, "dateTimeOffsetConfig": { "$ref": "#/components/schemas/DateTimeOffsetConfig" }, "labelsAndValuesConfig": { "$ref": "#/components/schemas/LabelsAndValuesConfig", "deprecated": true, "description": "Deprecated. The \"Labels and Values\" prototype (DS-1165/DS-1182); no longer populated\nfor new fields and the only UI consumer has been removed. Retained here solely so\nexisting `field_metadata` JSONB rows that still carry this key deserialize without\nerror. DO NOT remove this property from the schema unless a Flyway migration has\nfirst stripped `labelsAndValuesConfig` from every existing `data_fields.field_metadata`\nrow - otherwise Hibernate (FAIL_ON_UNKNOWN_PROPERTIES=true) will throw\nUnrecognizedPropertyException on data retrieval and return HTTP 500 on\nGET /data-fields. Removal deadline: Aug 5, 2026, gated on that migration.\n" } }, "type": "object" }, "LabelValueItem": { "description": "Deprecated. Represents a single label-value pair with translation options. Retained only for backward-compatible deserialization of existing field_metadata JSONB rows.", "properties": { "label": { "description": "The primary display label for the item (often in the default language).", "type": "string" }, "translations": { "additionalProperties": { "type": "string" }, "description": "A map of language codes (e.g., 'es', 'fr') to translated label strings.", "type": "object" }, "value": { "description": "The internal value associated with the label.", "type": "string" }, "valueManaged": { "description": "Indicates if the value is managed by the system.", "example": true, "type": "boolean" } }, "required": [ "label", "value", "valueManaged" ], "type": "object" }, "LabelsAndValuesConfig": { "description": "Deprecated. Configuration for a list of labels and their corresponding values, potentially with translations. Retained only for backward-compatible deserialization of existing field_metadata JSONB rows; not populated for new fields.", "properties": { "expandable": { "description": "Flag indicating whether the list can be expanded or modified by the user/system.", "example": false, "type": "boolean" }, "labelAndValues": { "description": "The list of label-value pairs.", "items": { "$ref": "#/components/schemas/LabelValueItem" }, "type": "array" } }, "required": [ "expandable", "labelAndValues" ], "type": "object" } }, "securitySchemes": { "bearerAuth": { "bearerFormat": "JWT", "scheme": "bearer", "type": "http" } } }, "info": { "title": "Data Catalog", "version": "0.0.0" }, "openapi": "3.1.0", "paths": { "/v1/data-catalog/entity/{entityId}/data-fields": { "get": { "operationId": "getEntityFieldsV2", "parameters": [ { "description": "Unique identifier of the entity to get fields for", "in": "path", "name": "entityId", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "description": "Include hidden fields in results", "in": "query", "name": "showHiddenFields", "required": false, "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/DataField" }, "type": "array" } } }, "description": "Successful operation" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get data fields on an entity", "tags": [ "Entity" ] } } }, "servers": [ { "description": "US Production Server", "url": "https://api-us.streamline.intellistack.ai" }, { "description": "Canada Production Server", "url": "https://api-ca.streamline.intellistack.ai" } ], "tags": [ { "description": "v2 Entity Endpoints", "name": "Entity" } ] } ```