v1

latestOpenAPI 3.0.02026-07-2480355389.7 KB

Items

List folders

Returns list of all folders given provided filters.

get/api/v2/teams/{team_slug}/items/folders

Path parameters

team_slugstring required

Team's sluggified name

Query parameters

CommonDatasetId[] required

List of dataset IDs

'all' required

All dataset IDs.

string required

[ DEPRECATED ] Comma seperated list of dataset IDs

[
  123
]

has_commentsboolean

Controls whether to include only items with/without comments

select_allboolean

For batch operation this filter has to be set to true if no other optional filter is provided.

Example:true

For batch operation this filter has to be set to true if no other optional filter is provided.

item_path_prefixstring

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.

Example:/some/prefix

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_path_prefixstring

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.

Example:/some/prefix

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.

DatasetsV2FiltersItemPath[]

List of Item's path

string

[ DEPRECATED ] Comma separated list of Item's path

[
  "/some/path"
]

DatasetsV2FiltersItemPath[]

List of Item's path

string

[ DEPRECATED ] Comma separated list of Item's path

[
  "/some/path"
]

DatasetsV2FiltersItemId[]

List of Item's UUID

string

[ DEPRECATED ] Comma separated list of Item's UUID

[
  "e23ff3f3-8f77-4e78-9e81-fdb25abfb781"
]

DatasetsV2FiltersItemId[]

List of Item's UUID

string

[ DEPRECATED ] Comma separated list of Item's UUID

[
  "e23ff3f3-8f77-4e78-9e81-fdb25abfb781"
]

DatasetsV2FiltersItemName[]

List of Item's name

string

[ DEPRECATED ] Comma separated list of Item's name

[
  "my item"
]

DatasetsV2FiltersItemName[]

List of Item's name

string

[ DEPRECATED ] Comma separated list of Item's name

[
  "my item"
]

item_name_prefixstring

Prefix of item's name

Example:prefix_

Prefix of item's name

not_item_name_prefixstring

Prefix of item's name

Example:prefix_

Prefix of item's name

item_name_containsstring

Partial item's name

Example:item

Partial item's name

not_item_name_containsstring

Partial item's name

Example:item

Partial item's name

DatasetsV2FiltersWorkflowStageId[]

List of Item's current workflow stage ID.

string

[ DEPRECATED ] Comma separated list of Item's current workflow stage ID.

[
  "e23ff3f3-8f77-4e78-9e81-fdb25abfb781"
]

DatasetsV2FiltersWorkflowStageId[]

List of Item's current workflow stage ID.

string

[ DEPRECATED ] Comma separated list of Item's current workflow stage ID.

[
  "e23ff3f3-8f77-4e78-9e81-fdb25abfb781"
]

DatasetsV2FiltersFileType[]

List of Type of files within the item

string

[ DEPRECATED ] Comma separated list of Type of files within the item

[
  "image"
]

DatasetsV2FiltersFileType[]

List of Type of files within the item

string

[ DEPRECATED ] Comma separated list of Type of files within the item

[
  "image"
]

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.

Example:,

DatasetsV2CommonGeneralStatus[]

string

Example:,

DatasetsV2FiltersAnnotationClassId[]

List of Item's class ID

string

[ DEPRECATED ] Comma separated list of Item's class ID

[
  123
]

DatasetsV2FiltersAnnotationClassId[]

List of Item's class ID

string

[ DEPRECATED ] Comma separated list of Item's class ID

[
  123
]

WorkflowsV2ItemAssigneeId[]

List of Item's assignee ID

string

[ DEPRECATED ] Comma separated list of Item's assignee ID

[
  123
]

WorkflowsV2ItemAssigneeId[]

List of Item's assignee ID

string

[ DEPRECATED ] Comma separated list of Item's assignee ID

[
  123
]

WorkflowsV2ItemAssigneeId[]

List of Item's assignee ID

string

[ DEPRECATED ] Comma separated list of Item's assignee ID

[
  123
]

WorkflowsV2ItemAssigneeId[]

List of Item's assignee ID

string

[ DEPRECATED ] Comma separated list of Item's assignee ID

[
  123
]

current_pathstring

Filters folders that are not in given path

Example:/some/path

Filters folders that are not in given path

include_thumbnailsboolean

Set to 'true' if you need the response to come with thumbnail URLs for each item.

hide_emptyboolean

Set to 'true' if you don't want to receive empty folders.

Response

DatasetsV2.ItemManagement.ListFoldersResponse

Example response

{
  "folders": [
    {
      "dataset_id": 123,
      "thumbnail_url": "https://darwin-production-data.s3.eu-west-1.amazonaws.com/some-file.jpg?X-Amz-Signature=f0aa21e3d89ba4e7a7108eaf9873566ee5e0e3823bc5862fd3b0b9f1f44d15ac&X-Amz-Algorithm=AWS4-HMAC-SHA256",
      "thumbnails_urls": [
        "https://darwin-production-data.s3.eu-west-1.amazonaws.com/some-file.jpg?X-Amz-Signature=f0aa21e3d89ba4e7a7108eaf9873566ee5e0e3823bc5862fd3b0b9f1f44d15ac&X-Amz-Algorithm=AWS4-HMAC-SHA256"
      ]
    }
  ]
}