---
updatedAt: 2026-08-25T23:06:23.000Z
agentTools:
  projectIndex: https://developer.intellistack.com/llms.txt
---

# Find dataset fields grouped by entity ID.

# OpenAPI definition

```json
{
  "components": {
    "schemas": {
      "CaseSensitivityCapability": {
        "enum": [
          "UNKNOWN",
          "CASE_SENSITIVE_ONLY",
          "CASE_INSENSITIVE_SLOW",
          "CASE_INSENSITIVE"
        ],
        "type": "string"
      },
      "CollectionType": {
        "enum": [
          "ORDERED_LIST",
          "UNORDERED_LIST"
        ],
        "nullable": true,
        "type": "string"
      },
      "DataSetFieldMetadata": {
        "properties": {
          "caseSensitivityCapability": {
            "$ref": "#/components/schemas/CaseSensitivityCapability"
          },
          "collectionType": {
            "$ref": "#/components/schemas/CollectionType"
          },
          "createable": {
            "type": "boolean"
          },
          "dataClassCodeVersion": {
            "type": "string"
          },
          "dataClassId": {
            "type": "string"
          },
          "dataClassModelVersion": {
            "type": "string"
          },
          "dataClassName": {
            "type": "string"
          },
          "defaultValue": {
            "additionalProperties": {
              "type": "object"
            },
            "type": "object"
          },
          "definitionId": {
            "type": "string"
          },
          "definitionVersion": {
            "type": "string"
          },
          "descriptor": {
            "type": "string"
          },
          "discoveredValues": {
            "items": {
              "type": "object"
            },
            "type": "array"
          },
          "entityId": {
            "format": "uuid",
            "type": "string"
          },
          "fieldMetadata": {
            "additionalProperties": {
              "type": "object"
            },
            "type": "object"
          },
          "hidden": {
            "type": "boolean"
          },
          "id": {
            "format": "uuid",
            "type": "string"
          },
          "isDataClassOverridden": {
            "type": "boolean"
          },
          "isManaged": {
            "type": "boolean"
          },
          "isPrimaryKey": {
            "type": "boolean"
          },
          "label": {
            "type": "string"
          },
          "locator": {
            "type": "string"
          },
          "nativeIdentifier": {
            "type": "string"
          },
          "nativeProperties": {
            "additionalProperties": {
              "type": "object"
            },
            "type": "object"
          },
          "nullable": {
            "type": "boolean"
          },
          "organizationId": {
            "format": "uuid",
            "type": "string"
          },
          "originalDataClassId": {
            "type": "string"
          },
          "required": {
            "type": "boolean"
          },
          "scalarType": {
            "description": "Catalog scalar type in lowercase (for example string, number, date). Omitted on DELETED_AT_SOURCE placeholders so consumers do not treat a fabricated type as live catalog metadata.",
            "type": "string"
          },
          "searchable": {
            "type": "boolean"
          },
          "sortable": {
            "type": "boolean"
          },
          "unavailableReason": {
            "description": "Present when this field is not currently live and selected. DELETED_AT_SOURCE means the catalog field is gone but still selected on the dataset. DESELECTED and UNKNOWN are reserved for consumers that grandfather referenced fields when they can or cannot tell why the field is missing; this endpoint never emits DESELECTED or UNKNOWN.",
            "enum": [
              "DELETED_AT_SOURCE",
              "DESELECTED",
              "UNKNOWN"
            ],
            "type": "string"
          },
          "updateable": {
            "type": "boolean"
          }
        },
        "type": "object"
      },
      "EntityIdBatchRequest": {
        "items": {
          "format": "uuid",
          "type": "string"
        },
        "maxItems": 100,
        "minItems": 1,
        "type": "array"
      },
      "ErrorDetails": {
        "description": "Details of an error",
        "properties": {
          "code": {
            "description": "Internal error code",
            "type": "string"
          },
          "detail": {
            "description": "Error details",
            "type": "string"
          },
          "sourceError": {
            "$ref": "#/components/schemas/ErrorDetails"
          },
          "title": {
            "description": "Error title",
            "type": "string"
          }
        },
        "type": "object"
      },
      "ErrorEnvelope": {
        "description": "Contains a list of errors",
        "properties": {
          "errors": {
            "items": {
              "$ref": "#/components/schemas/ErrorDetails"
            },
            "type": "array"
          },
          "message": {
            "description": "Top level message to describe the error",
            "type": "string"
          },
          "traceId": {
            "description": "Internal traceId",
            "type": "string"
          }
        },
        "type": "object"
      }
    },
    "securitySchemes": {
      "bearerAuth": {
        "bearerFormat": "JWT",
        "scheme": "bearer",
        "type": "http"
      }
    }
  },
  "info": {
    "title": "Data Activation",
    "version": "0.0.0"
  },
  "openapi": "3.1.0",
  "paths": {
    "/v1/activation/dataset/{dataSetId}/fields/batch": {
      "post": {
        "operationId": "getDataSetFieldsBatchByEntityIdsV2",
        "parameters": [
          {
            "description": "The ID of the dataset",
            "in": "path",
            "name": "dataSetId",
            "required": true,
            "schema": {
              "format": "uuid",
              "type": "string"
            }
          },
          {
            "description": "When true (the default), datasets with explicit field selections return only selected fields. When false, every live catalog field is returned, collapsing original/substitute pairs that present as the same workflow field id to one row. File entities always return the full catalog field list. `id` is the persisted original when a FIELD substitution maps it, and `entityId` when an ENTITY substitution does; unmapped ids are returned as-is. Labels and types stay live either way.",
            "in": "query",
            "name": "applyFieldSelection",
            "required": false,
            "schema": {
              "default": true,
              "type": "boolean"
            }
          },
          {
            "description": "When true, selected field IDs that no longer exist in the catalog are still returned as placeholders with `unavailableReason: DELETED_AT_SOURCE` and retained labels. Defaults to false so callers that have not opted in receive the live selected-field list only. Has no effect when `applyFieldSelection` is false.",
            "in": "query",
            "name": "includeUnavailableFields",
            "required": false,
            "schema": {
              "default": false,
              "type": "boolean"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EntityIdBatchRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "additionalProperties": {
                    "items": {
                      "$ref": "#/components/schemas/DataSetFieldMetadata"
                    },
                    "type": "array"
                  },
                  "type": "object"
                }
              }
            },
            "description": "Map of entity ID to its dataset fields. Every requested entity ID is present as a key; an entity with no fields (or not found in the catalog) maps to an empty array. Datasets with no persisted field selections use legacy behavior and include all catalog fields for each requested entity. Datasets with explicit selections return only selected fields unless `applyFieldSelection` is false, in which case every live catalog field is returned (one row per presented workflow field id when substitutions collapse original/substitute catalog ids). File entities always return the full catalog field list. Requested IDs may be persisted originals or live substitutes. Catalog is read in live substitute space. Selected fields resolve to one catalog row per workflow original (substitute first, original fallback) in catalog order. Response map keys echo the request. `id` is the persisted original when a FIELD substitution maps it, and `entityId` when an ENTITY substitution does; unmapped ids are returned as-is. Labels and types stay live. When `includeUnavailableFields` is true, selected field IDs that no longer exist in the catalog are still returned as placeholders with `unavailableReason: DELETED_AT_SOURCE` and retained labels."
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorEnvelope"
                }
              }
            },
            "description": "Empty entity list or entity IDs outside the dataset entityAllowList."
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorEnvelope"
                }
              }
            },
            "description": "Caller lacks the READ_DATASETS permission."
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ],
        "summary": "Find dataset fields grouped by entity ID.",
        "tags": [
          "Dataset"
        ]
      }
    }
  },
  "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 Data set related endpoints",
      "name": "Dataset"
    }
  ]
}
```