---
title: "Set layout"
method: POST
path: "/api/v2/teams/{team_slug}/items/layout"
tags: ["Items"]
---

# Set layout

`POST /api/v2/teams/{team_slug}/items/layout`

Sets layout of items selected by provided filter.

## Path parameters

- `team_slug` string, required

## Request body

- DatasetsV2ItemManagementSetLayoutRequest — Request to set items layout.
  - `filters` DatasetsV2ItemManagementAllFilters, required — Operation filters.
    - `annotation_class_ids` union
      - DatasetsV2FiltersAnnotationClassId[] — List of Item's class ID
      - string — [ DEPRECATED ] Comma separated list of Item's class ID
    - `assignees` union
      - WorkflowsV2ItemAssigneeId[] — List of Item's assignee ID
      - string — [ DEPRECATED ] Comma separated list of Item's assignee ID
    - `current_assignees` union
      - WorkflowsV2ItemAssigneeId[] — List of Item's assignee ID
      - string — [ DEPRECATED ] Comma separated list of Item's assignee ID
    - `dataset_ids` union, required
      - CommonDatasetId[] — List of dataset IDs
      - 'all' — All dataset IDs.
      - string — [ DEPRECATED ] Comma seperated list of dataset IDs
    - `has_comments` boolean — Controls whether to include only items with/without comments
    - `item_ids` union
      - DatasetsV2FiltersItemId[] — List of Item's UUID
      - string — [ DEPRECATED ] Comma separated list of Item's UUID
    - `item_name_contains` string — Partial item's name
    - `item_name_prefix` string — Prefix of item's name
    - `item_names` union
      - DatasetsV2FiltersItemName[] — List of Item's name
      - string — [ DEPRECATED ] Comma separated list of Item's name
    - `item_path_prefix` string — Item's path prefix to match. This filter only matches on full path segments, it's not possible to match on e.g. '/some_path' with '/some' filter.
    - `item_paths` union
      - DatasetsV2FiltersItemPath[] — List of Item's path
      - string — [ DEPRECATED ] Comma separated list of Item's path
    - `not_annotation_class_ids` union
      - DatasetsV2FiltersAnnotationClassId[] — List of Item's class ID
      - string — [ DEPRECATED ] Comma separated list of Item's class ID
    - `not_assignees` union
      - WorkflowsV2ItemAssigneeId[] — List of Item's assignee ID
      - string — [ DEPRECATED ] Comma separated list of Item's assignee ID
    - `not_current_assignees` union
      - WorkflowsV2ItemAssigneeId[] — List of Item's assignee ID
      - string — [ DEPRECATED ] Comma separated list of Item's assignee ID
    - `not_item_ids` union
      - DatasetsV2FiltersItemId[] — List of Item's UUID
      - string — [ DEPRECATED ] Comma separated list of Item's UUID
    - `not_item_name_contains` string — Partial item's name
    - `not_item_name_prefix` string — Prefix of item's name
    - `not_item_names` union
      - DatasetsV2FiltersItemName[] — List of Item's name
      - string — [ DEPRECATED ] Comma separated list of Item's name
    - `not_item_path_prefix` string — Item's path prefix to match. This filter only matches on full path segments, it's not possible to match on e.g. '/some_path' with '/some' filter.
    - `not_item_paths` union
      - DatasetsV2FiltersItemPath[] — List of Item's path
      - string — [ DEPRECATED ] Comma separated list of Item's path
    - `not_statuses` union
      - DatasetsV2CommonGeneralStatus[] — List of General status of the Upload/Item. It considers processing status as well as workflow status and Item being archived/non-archived. Can be used instead of 'processing_status' and 'workflow_status' for simplicity. Item will be marked as 'complete' only if both workflow and processing is done.
      - string — [ DEPRECATED ] Comma separated list of General status of the Upload/Item. It considers processing status as well as workflow status and Item being archived/non-archived. Can be used instead of 'processing_status' and 'workflow_status' for simplicity. Item will be marked as 'complete' only if both workflow and processing is done.
    - `not_types` union
      - DatasetsV2FiltersFileType[] — List of Type of files within the item
      - string — [ DEPRECATED ] Comma separated list of Type of files within the item
    - `not_workflow_stage_ids` union
      - DatasetsV2FiltersWorkflowStageId[] — List of Item's current workflow stage ID.
      - string — [ DEPRECATED ] Comma separated list of Item's current workflow stage ID.
    - `select_all` boolean — For batch operation this filter has to be set to true if no other optional filter is provided.
    - `statuses` union
      - DatasetsV2CommonGeneralStatus[] — List of General status of the Upload/Item. It considers processing status as well as workflow status and Item being archived/non-archived. Can be used instead of 'processing_status' and 'workflow_status' for simplicity. Item will be marked as 'complete' only if both workflow and processing is done.
      - string — [ DEPRECATED ] Comma separated list of General status of the Upload/Item. It considers processing status as well as workflow status and Item being archived/non-archived. Can be used instead of 'processing_status' and 'workflow_status' for simplicity. Item will be marked as 'complete' only if both workflow and processing is done.
    - `types` union
      - DatasetsV2FiltersFileType[] — List of Type of files within the item
      - string — [ DEPRECATED ] Comma separated list of Type of files within the item
    - `workflow_stage_ids` union
      - DatasetsV2FiltersWorkflowStageId[] — List of Item's current workflow stage ID.
      - string — [ DEPRECATED ] Comma separated list of Item's current workflow stage ID.
  - `layout` union, required
    - object — Object describing Item's layout. Version 3.
      - `slots_grid` array[], required — 3D grid of slots. Max dimensions are 4x4x128.
        - DatasetsV2CommonSlotsGridCell[] — Grid's row.
          - union
            - string — 'ID' of the Slot to identify it within the Item. It's recommended to use numeric values satarting with 1.
            - DatasetsV2CommonSlotName[] — Stack of slots representing different layers of the same media file.
      - `version` 3, required — Layout version.
    - object — Object describing Item's layout. Version 2.
      - `layout_shape` integer[]
      - `slots` DatasetsV2CommonSlotName[], required
      - `type` 'grid' | 'horizontal' | 'vertical' | 'simple', required — View type.
      - `version` 2, required — Layout version.
    - object — Object describing Item's layout. Version 1.
      - `slots` DatasetsV2CommonSlotName[], required
      - `type` 'grid' | 'horizontal' | 'vertical' | 'simple', required — View type.
      - `version` 1, required — Layout version.

## Response `200`

DatasetsV2.ItemManagement.BatchOperationResponse

- DatasetsV2ItemManagementBatchOperationResponse — Standard response from batch operation. Includes information about affected items count.
  - `affected_item_count` integer, required

## Other responses

- `401` — Common.APIError
- `404` — Common.APIError
- `422` — Unprocessible Entity

---

[API](https://skmtc.net/v7labs/apis/darwin.md) · [All operations](https://skmtc.net/v7labs/apis/darwin/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/v7labs/darwin/versions/526a5b6b4cdc/schema)