Sign in

v1

latestOpenAPI 3.0.02026-07-2480355389.7 KB
Items

List Item IDs

Returns list of Item IDs.

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

Path parameters

team_slugstring required

Team's sluggified name

Query parameters

CommonDatasetId[] required

List of dataset IDs

OR
'all' required

All dataset IDs.

OR
string required

[ DEPRECATED ] Comma seperated list of dataset IDs

[
  123
]
has_commentsboolean

Controls whether to include only items with/without comments

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

OR
string

[ DEPRECATED ] Comma separated list of Item's path

[
  "/some/path"
]
DatasetsV2FiltersItemPath[]

List of Item's path

OR
string

[ DEPRECATED ] Comma separated list of Item's path

[
  "/some/path"
]
DatasetsV2FiltersItemId[]

List of Item's UUID

OR
string

[ DEPRECATED ] Comma separated list of Item's UUID

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

List of Item's UUID

OR
string

[ DEPRECATED ] Comma separated list of Item's UUID

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

List of Item's name

OR
string

[ DEPRECATED ] Comma separated list of Item's name

[
  "my item"
]
DatasetsV2FiltersItemName[]

List of Item's name

OR
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.

OR
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.

OR
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

OR
string

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

[
  "image"
]
DatasetsV2FiltersFileType[]

List of Type of files within the item

OR
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.

OR
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[]

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.

OR
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:,
DatasetsV2FiltersAnnotationClassId[]

List of Item's class ID

OR
string

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

[
  123
]
DatasetsV2FiltersAnnotationClassId[]

List of Item's class ID

OR
string

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

[
  123
]
WorkflowsV2ItemAssigneeId[]

List of Item's assignee ID

OR
string

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

[
  123
]
WorkflowsV2ItemAssigneeId[]

List of Item's assignee ID

OR
string

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

[
  123
]
WorkflowsV2ItemAssigneeId[]

List of Item's assignee ID

OR
string

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

[
  123
]
WorkflowsV2ItemAssigneeId[]

List of Item's assignee ID

OR
string

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

[
  123
]
page[offset]integer

Defines how many items matching filters need to be skipped before returning result. Default value is 0.

Example:123
page[size]integer

Defines max number of items to return on single page. Default value is 500.

Example:500
page[to]string nullable

Page cursor on which to end the page. Page cursor consist of list of values that ends with UUID or integer

Example:2020-01-13 00:00:00,EB03745E-6A66-4BA0-802D-DE8785ABFFFE
page[from]string nullable

Page cursor from which to start the page. Page cursor consist of list of values that ends with UUID or integer

Example:2020-01-13 00:00:00,EB03745E-6A66-4BA0-802D-DE8785ABFFFE
sort[id]'asc' | 'desc'

Sort by ID. Default value is asc.

sort[name]'asc' | 'desc'

Sort by name. Default value is asc.

sort[priority]'asc' | 'desc'

Sort by priority. Default value is asc.

sort[byte_size]'asc' | 'desc'

Sort by overall size. Default value is asc.

sort[map]'asc' | 'desc'

Sort by mean average precision metric in an evaluation run. Default value is asc.

sort[updated_at]'asc' | 'desc'

Sort by recently updated. Default value is asc.

sort[accuracy]'asc' | 'desc'

Sort by accuracy metric in an evaluation run. Default value is asc.

Response

DatasetsV2.ItemManagement.ListItemIdsResponse

item_idsCommonUUID[] required

Example response

{
  "item_ids": [
    "e23ff3f3-8f77-4e78-9e81-fdb25abfb781"
  ],
  "page": {
    "count": 500,
    "next": "2020-01-13 00:00:00,EB03745E-6A66-4BA0-802D-DE8785ABFFFE",
    "previous": "2020-01-13 00:00:00,EB03745E-6A66-4BA0-802D-DE8785ABFFFE"
  }
}