---
title: "POST /flow/v1.0/flowexperiments/getIndexEntities"
method: POST
path: "/flow/v1.0/flowexperiments/getIndexEntities"
tags: ["ExperimentsProvider"]
---

# POST /flow/v1.0/flowexperiments/getIndexEntities

`POST /flow/v1.0/flowexperiments/getIndexEntities`

## Path parameters

- `subscriptionId` string, uuid, required
- `resourceGroupName` string, required
- `workspaceName` string, required

## Request body

- UnversionedEntityRequestDtoExperimentIndexEntityExperimentAnnotationsExperimentPropertiesExtensibleObject
  - `unversionedEntityIds` string[], nullable

## Response `200`

Success

- UnversionedEntityResponseDtoExperimentIndexEntityExperimentAnnotationsExperimentPropertiesExtensibleObject
  - `unversionedEntities` ExperimentIndexEntity[], nullable
    - `schemaId` string, nullable
    - `entityId` string, nullable
    - `kind` 'Invalid' | 'LineageRoot' | 'Versioned' | 'Unversioned'
    - `annotations` ExperimentAnnotations
      - `nodeRuns` object, nullable — This is a dictionary
      - `nodes` ExperimentNode[], nullable
        - `name` string, nullable
        - `type` 'Flow' | 'ChatGroup' | 'Command'
        - `max_turns` integer, nullable
        - `roles` ChatGroupRole[], nullable
          - `name` string, nullable
          - `role` string, nullable
          - `stop_signal` string, nullable
          - `path` string, nullable
          - `variant` string, nullable
          - `connections` object, nullable — This is a dictionary
          - `environment_variables` object, nullable — This is a dictionary
          - `display_name` string, nullable
          - `description` string, nullable
          - `tags` object, nullable — This is a dictionary
          - `properties` object, nullable — This is a dictionary
          - `resources` SessionRuntimeResources
            - `vmSize` string, nullable
            - `maxIdleTimeSeconds` integer, nullable
            - `identity` string, nullable
            - `computeName` string, nullable
            - `enableMultiContainer` boolean
          - `inputs` object, nullable
        - `command` string, nullable
        - `code` string, nullable
        - `environment` string, nullable
        - `outputs` object, nullable
        - `path` string, nullable
        - `variant` string, nullable
        - `connections` object, nullable — This is a dictionary
        - `environment_variables` object, nullable — This is a dictionary
        - `display_name` string, nullable
        - `description` string, nullable
        - `tags` object, nullable — This is a dictionary
        - `properties` object, nullable — This is a dictionary
        - `resources` SessionRuntimeResources
          - `vmSize` string, nullable
          - `maxIdleTimeSeconds` integer, nullable
          - `identity` string, nullable
          - `computeName` string, nullable
          - `enableMultiContainer` boolean
        - `inputs` object, nullable
      - `data` ExperimentData[], nullable
        - `name` string, nullable
        - `path` string, nullable
      - `createdDate` string, date-time, nullable
      - `lastModifiedDate` string, date-time, nullable
      - `owner` SchemaContractsCreatedBy
        - `userObjectId` string, nullable
        - `userTenantId` string, nullable
        - `userName` string, nullable
        - `userPrincipalName` string, nullable
      - `name` string, nullable
      - `description` string, nullable
      - `archived` boolean
      - `tags` object, nullable
    - `properties` ExperimentProperties
      - `id` string, nullable
      - `experimentTemplateId` string, nullable
      - `creationContext` CreationContext
        - `createdTime` string, date-time
        - `createdBy` SchemaContractsCreatedBy
          - `userObjectId` string, nullable
          - `userTenantId` string, nullable
          - `userName` string, nullable
          - `userPrincipalName` string, nullable
        - `creationSource` string, nullable
    - `internal` ExtensibleObject
    - `updateSequence` integer
    - `type` string, nullable
    - `version` string, nullable
    - `entityContainerId` string, nullable
    - `entityObjectId` string, nullable
    - `resourceType` string, nullable
    - `relationships` Relationship[], nullable
      - `relationType` string, nullable
      - `targetEntityId` string, nullable
      - `assetId` string, nullable
      - `entityType` string, nullable
      - `direction` string, nullable
      - `entityContainerId` string, nullable
    - `assetId` string, nullable
    - `usage` EntityUsage
      - `totalCount` integer, nullable
    - `isAFragment` boolean
    - `fragmentId` string, nullable
  - `unversionedEntityJsonSchema` unknown
  - `normalizedRequestCharge` number, double
  - `normalizedRequestChargePeriod` string, date-span

## Other responses

- `default` — Error response describing why the operation failed.

## Changes

- **2024-05-09** `011760d30356` — 1 warning, 4 info
  - added the new `Command` enum value to the `unversionedEntities/items/annotations/nodes/items/type` response property for the response status `200`
  - added the optional property `unversionedEntities/items/annotations/nodes/items/code` to the response with the `200` status
  - added the optional property `unversionedEntities/items/annotations/nodes/items/command` to the response with the `200` status
  - added the optional property `unversionedEntities/items/annotations/nodes/items/environment` to the response with the `200` status
  - …1 more
- **2024-04-07** `78f6d2f4e0a3` — 1 info
  - endpoint added
- **2024-03-28** `ee6564dabff6` — 1 breaking
  - api path removed without deprecation

[Change history](https://skmtc.dev/azure/apis/azure-machine-learning-designer-service-client/changes/flow/v1.0/flowexperiments/getIndexEntities/post.md)

---

[API](https://skmtc.dev/azure/apis/azure-machine-learning-designer-service-client.md) · [All operations](https://skmtc.dev/azure/apis/azure-machine-learning-designer-service-client/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/azure/azure-machine-learning-designer-service-client/revisions/bd913aa2cdd9/schema)