--- updatedAt: 2026-05-27T10:25:03.000Z agentTools: projectIndex: https://docs.v7labs.com/llms.txt --- # List items Returns list of Items given provided filters. # OpenAPI definition ```json { "components": { "schemas": { "DatasetsV2.Filters.AnnotationClassIdsContainer": { "oneOf": [ { "$ref": "#/components/schemas/DatasetsV2.Filters.AnnotationClassIds" } ], "x-struct": null, "x-validate": null }, "DatasetsV2.Filters.ItemNameContains": { "description": "Partial item's name", "example": "item", "title": "DatasetsV2.Filters.ItemNameContains", "type": "string", "x-struct": "Elixir.GraphotateWeb.Schemas.DatasetsV2.Filters.ItemNameContains", "x-validate": null }, "DatasetsV2.Common.LayersStack": { "description": "Stack of slots representing different layers of the same media file.", "items": { "$ref": "#/components/schemas/DatasetsV2.Common.SlotName" }, "maxItems": 128, "minItems": 1, "title": "DatasetsV2.Common.LayersStack", "type": "array", "x-struct": "Elixir.GraphotateWeb.Schemas.DatasetsV2.Common.LayersStack", "x-validate": null }, "DatasetsV2.Common.SlotType": { "description": "When type is ommited, it's gonna be infered from the slot's extension if possible.", "enum": [ "image", "video", "pdf", "dicom" ], "title": "DatasetsV2.Common.SlotType", "type": "string", "x-struct": "Elixir.GraphotateWeb.Schemas.DatasetsV2.Common.SlotType", "x-validate": null }, "DatasetsV2.Filters.ItemPath": { "description": "Item's path", "example": "/some/path", "title": "DatasetsV2.Filters.ItemPath", "type": "string", "x-struct": "Elixir.GraphotateWeb.Schemas.DatasetsV2.Filters.ItemPath", "x-validate": null }, "DatasetsV2.ItemManagement.StreamQualityPreset": { "additionalProperties": false, "properties": { "bitrate": { "type": "integer", "x-struct": null, "x-validate": null }, "name": { "$ref": "#/components/schemas/DatasetsV2.ItemManagement.StreamQualityPresetName" } }, "required": [ "name" ], "title": "DatasetsV2.ItemManagement.StreamQualityPreset", "type": "object", "x-struct": "Elixir.GraphotateWeb.Schemas.DatasetsV2.ItemManagement.StreamQualityPreset", "x-validate": null }, "DatasetsV2.Common.PageOutput": { "additionalProperties": false, "description": "Paging information. With default sorting, cursors are always Item IDs.", "properties": { "count": { "description": "Element count on current page.", "example": 500, "type": "integer", "x-struct": null, "x-validate": null }, "next": { "description": "Use this to specify 'from' cursor of next page.", "example": "2020-01-13 00:00:00,EB03745E-6A66-4BA0-802D-DE8785ABFFFE", "nullable": true, "pattern": "^(.+,)*(([0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12})|([0-9]+))$", "type": "string", "x-struct": null, "x-validate": null }, "previous": { "description": "Use this to specify 'to' cursor of previous page.", "example": "2020-01-13 00:00:00,EB03745E-6A66-4BA0-802D-DE8785ABFFFE", "nullable": true, "pattern": "^(.+,)*(([0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12})|([0-9]+))$", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "count", "previous", "next" ], "title": "DatasetsV2.Common.PageOutput", "type": "object", "x-struct": "Elixir.GraphotateWeb.Schemas.DatasetsV2.Common.PageOutput", "x-validate": null }, "DatasetsV2.ItemManagement.DicomJsonUrl": { "description": "URL to the DICOM JSON for this Slot. In order to get this please use `include_dicom_json=true` in the request", "title": "DatasetsV2.ItemManagement.DicomJsonUrl", "type": "string", "x-struct": "Elixir.GraphotateWeb.Schemas.DatasetsV2.ItemManagement.DicomJsonUrl", "x-validate": null }, "DatasetsV2.Common.ItemLayoutV1": { "additionalProperties": false, "description": "Object describing Item's layout. Version 1.", "example": { "slots": [ "1", "2", "3" ], "type": "grid", "version": 1 }, "properties": { "slots": { "items": { "$ref": "#/components/schemas/DatasetsV2.Common.SlotName" }, "type": "array", "x-struct": null, "x-validate": null }, "type": { "$ref": "#/components/schemas/DatasetsV2.Common.ItemLayout.ViewType" }, "version": { "description": "Layout version.", "enum": [ 1 ], "type": "integer", "x-struct": null, "x-validate": null } }, "required": [ "version", "type", "slots" ], "title": "DatasetsV2.Common.ItemLayoutV1", "type": "object", "x-struct": "Elixir.GraphotateWeb.Schemas.DatasetsV2.Common.ItemLayoutV1", "x-validate": null }, "DatasetsV2.ItemManagement.IncludeWorkflowData": { "default": false, "description": "Set to 'true' if you need the response to come with additional workflow-related data. See 'WorkflowData' schema for more details.", "title": "DatasetsV2.ItemManagement.IncludeWorkflowData", "type": "boolean", "x-struct": "Elixir.GraphotateWeb.Schemas.DatasetsV2.ItemManagement.IncludeWorkflowData", "x-validate": null }, "DatasetsV2.Common.SlotAsFrames": { "default": false, "description": "When set, processes the video as individual frames creating Item for each frame.", "title": "DatasetsV2.Common.SlotAsFrames", "type": "boolean", "x-struct": "Elixir.GraphotateWeb.Schemas.DatasetsV2.Common.SlotAsFrames", "x-validate": null }, "DatasetsV2.ItemManagement.ItemTagType": { "description": "Class Id of all tags across slots in the item.", "title": "DatasetsV2.ItemManagement.ItemTagType", "type": "integer", "x-struct": "Elixir.GraphotateWeb.Schemas.DatasetsV2.ItemManagement.ItemTagType", "x-validate": null }, "DatasetsV2.Filters.AnnotationClassId": { "description": "Item's class ID", "example": 123, "title": "DatasetsV2.Filters.AnnotationClassId", "type": "integer", "x-struct": "Elixir.GraphotateWeb.Schemas.DatasetsV2.Filters.AnnotationClassId", "x-validate": null }, "DatasetsV2.Filters.WorkflowStageId": { "description": "Item's current workflow stage ID.", "example": "e23ff3f3-8f77-4e78-9e81-fdb25abfb781", "format": "uuid", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "title": "DatasetsV2.Filters.WorkflowStageId", "type": "string", "x-struct": "Elixir.GraphotateWeb.Schemas.DatasetsV2.Filters.WorkflowStageId", "x-validate": null }, "DatasetsV2.ItemManagement.IncludeTags": { "default": false, "description": "Set to 'true' if you need the response to come with tags associated with Item's slots.", "title": "DatasetsV2.ItemManagement.IncludeTags", "type": "boolean", "x-struct": "Elixir.GraphotateWeb.Schemas.DatasetsV2.ItemManagement.IncludeTags", "x-validate": null }, "DatasetsV2.Filters.ItemName": { "description": "Item's name", "example": "my item", "title": "DatasetsV2.Filters.ItemName", "type": "string", "x-struct": "Elixir.GraphotateWeb.Schemas.DatasetsV2.Filters.ItemName", "x-validate": null }, "DatasetsV2.Filters.SelectAll": { "description": "For batch operation this filter has to be set to true if no other optional filter is provided.", "example": true, "title": "DatasetsV2.Filters.SelectAll", "type": "boolean", "x-struct": "Elixir.GraphotateWeb.Schemas.DatasetsV2.Filters.SelectAll", "x-validate": null }, "DatasetsV2.Common.ItemLayout.ViewType": { "description": "View type.", "enum": [ "grid", "horizontal", "vertical", "simple" ], "title": "DatasetsV2.Common.ItemLayout.ViewType", "type": "string", "x-struct": "Elixir.GraphotateWeb.Schemas.DatasetsV2.Common.ItemLayout.ViewType", "x-validate": null }, "DatasetsV2.Common.ItemLayoutV2": { "additionalProperties": false, "description": "Object describing Item's layout. Version 2.", "example": { "layout_shape": [ 2, 2 ], "slots": [ "1", "2", "3" ], "type": "grid", "version": 2 }, "properties": { "layout_shape": { "items": { "minimum": 1, "type": "integer", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "slots": { "items": { "$ref": "#/components/schemas/DatasetsV2.Common.SlotName" }, "type": "array", "x-struct": null, "x-validate": null }, "type": { "$ref": "#/components/schemas/DatasetsV2.Common.ItemLayout.ViewType" }, "version": { "description": "Layout version.", "enum": [ 2 ], "type": "integer", "x-struct": null, "x-validate": null } }, "required": [ "version", "type", "slots" ], "title": "DatasetsV2.Common.ItemLayoutV2", "type": "object", "x-struct": "Elixir.GraphotateWeb.Schemas.DatasetsV2.Common.ItemLayoutV2", "x-validate": null }, "DatasetsV2.Common.GeneralStatus": { "description": "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.", "enum": [ "error", "uploading", "processing", "archived", "new", "annotate", "review", "complete" ], "title": "DatasetsV2.Common.GeneralStatus", "type": "string", "x-struct": "Elixir.GraphotateWeb.Schemas.DatasetsV2.Common.GeneralStatus", "x-validate": null }, "DatasetsV2.Common.CustomSlotFramerate": { "description": "Framerate which Darwin should extract frames at.", "title": "DatasetsV2.Common.CustomSlotFramerate", "type": "number", "x-struct": null, "x-validate": null }, "DatasetsV2.ItemManagement.IncludeFirstSections": { "default": false, "description": "Set to 'true' if you need the response to come with URLs to first section for each item.", "title": "DatasetsV2.ItemManagement.IncludeFirstSections", "type": "boolean", "x-struct": "Elixir.GraphotateWeb.Schemas.DatasetsV2.ItemManagement.IncludeFirstSections", "x-validate": null }, "DatasetsV2.Common.FileName": { "description": "Name of the File. This will be included in exports for easier Item tracking.", "example": "my_image.jpg", "pattern": "^[^/]+$", "title": "DatasetsV2.Common.FileName", "type": "string", "x-struct": "Elixir.GraphotateWeb.Schemas.DatasetsV2.Common.FileName", "x-validate": null }, "DatasetsV2.Filters.HasComments": { "description": "Controls whether to include only items with/without comments", "example": false, "title": "DatasetsV2.Filters.HasComments", "type": "boolean", "x-struct": "Elixir.GraphotateWeb.Schemas.DatasetsV2.Filters.HasComments", "x-validate": null }, "DatasetsV2.Filters.ItemNamePrefix": { "description": "Prefix of item's name", "example": "prefix_", "title": "DatasetsV2.Filters.ItemNamePrefix", "type": "string", "x-struct": "Elixir.GraphotateWeb.Schemas.DatasetsV2.Filters.ItemNamePrefix", "x-validate": null }, "DatasetsV2.ItemManagement.Slot": { "additionalProperties": false, "properties": { "available_quality_presets": { "description": "List of available quality presets for this slot. See `/api/v2/teams/:team_slug/:item_id/slots/:slot_name/stream/:quality/sign`.", "items": { "$ref": "#/components/schemas/DatasetsV2.ItemManagement.StreamQualityPreset" }, "type": "array", "x-struct": null, "x-validate": null }, "dicom_json_url": { "$ref": "#/components/schemas/DatasetsV2.ItemManagement.DicomJsonUrl" }, "file_name": { "$ref": "#/components/schemas/DatasetsV2.Common.FileName" }, "first_section_url": { "$ref": "#/components/schemas/DatasetsV2.ItemManagement.FirstSectionUrl" }, "fps": { "$ref": "#/components/schemas/DatasetsV2.Common.CustomSlotFramerate" }, "id": { "$ref": "#/components/schemas/Common.UUID" }, "is_external": { "description": "Whether the slot is on external storage or not.", "type": "boolean", "x-struct": null, "x-validate": null }, "metadata": { "$ref": "#/components/schemas/DatasetsV2.ItemManagement.Metadata" }, "sectionless": { "description": "A flag indicating if the slot has any real sections.", "type": "boolean", "x-struct": null, "x-validate": null }, "size_bytes": { "description": "Size of the slot in bytes.", "type": "integer", "x-struct": null, "x-validate": null }, "slot_name": { "$ref": "#/components/schemas/DatasetsV2.Common.SlotName" }, "streamable": { "description": "Whether slot can be streamed or not. See `/api/v2/teams/:team_slug/:item_id/slots/:slot_name/stream/sign`.", "type": "boolean", "x-struct": null, "x-validate": null }, "thumbnail_url": { "$ref": "#/components/schemas/DatasetsV2.ItemManagement.ThumbnailUrl" }, "total_sections": { "$ref": "#/components/schemas/DatasetsV2.ItemManagement.TotalSections" }, "type": { "$ref": "#/components/schemas/DatasetsV2.Common.SlotType" }, "upload_id": { "$ref": "#/components/schemas/Common.UUID" } }, "required": [ "id", "file_name", "slot_name", "type", "is_external", "upload_id", "total_sections" ], "title": "DatasetsV2.ItemManagement.Slot", "type": "object", "x-struct": "Elixir.GraphotateWeb.Schemas.DatasetsV2.ItemManagement.Slot", "x-validate": null }, "DatasetsV2.ItemManagement.ThumbnailUrl": { "description": "URL to thumbnail of the Slot. In order to get this please use `include_thumbnails=true` in the request.", "example": "https://darwin-production-data.s3.eu-west-1.amazonaws.com/some-file.jpg?X-Amz-Signature=f0aa21e3d89ba4e7a7108eaf9873566ee5e0e3823bc5862fd3b0b9f1f44d15ac&X-Amz-Algorithm=AWS4-HMAC-SHA256", "title": "DatasetsV2.ItemManagement.ThumbnailUrl", "type": "string", "x-struct": "Elixir.GraphotateWeb.Schemas.DatasetsV2.ItemManagement.ThumbnailUrl", "x-validate": null }, "DatasetsV2.Filters.ItemNames": { "oneOf": [ { "description": "List of Item's name", "items": { "$ref": "#/components/schemas/DatasetsV2.Filters.ItemName" }, "type": "array", "x-struct": null, "x-validate": null }, { "deprecated": true, "description": "[ DEPRECATED ] Comma separated list of Item's name", "example": "my item,my item", "type": "string", "x-struct": null, "x-validate": null } ], "title": "DatasetsV2.Filters.ItemNames", "x-struct": "Elixir.GraphotateWeb.Schemas.DatasetsV2.Filters.ItemNames", "x-validate": null }, "DatasetsV2.ItemManagement.TotalSections": { "description": "Number of all sections (frames/pages etc) of the Slot. In case of sectionless Slot, this number holds the 'virtual' number of total sections.", "example": 5, "title": "DatasetsV2.ItemManagement.TotalSections", "type": "integer", "x-struct": "Elixir.GraphotateWeb.Schemas.DatasetsV2.ItemManagement.TotalSections", "x-validate": null }, "DatasetsV2.Filters.ItemNamesContainer": { "oneOf": [ { "$ref": "#/components/schemas/DatasetsV2.Filters.ItemNames" } ], "x-struct": null, "x-validate": null }, "JsonErrorResponse": { "properties": { "errors": { "items": { "properties": { "detail": { "example": "null value where string expected", "type": "string", "x-struct": null, "x-validate": null }, "source": { "properties": { "pointer": { "example": "/data/attributes/petName", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "pointer" ], "type": "object", "x-struct": null, "x-validate": null }, "title": { "example": "Invalid value", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "title", "source", "detail" ], "type": "object", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null } }, "required": [ "errors" ], "title": "JsonErrorResponse", "type": "object", "x-struct": "Elixir.OpenApiSpex.JsonErrorResponse", "x-validate": null }, "DatasetsV2.Filters.ItemPathsContainer": { "oneOf": [ { "$ref": "#/components/schemas/DatasetsV2.Filters.ItemPaths" } ], "x-struct": null, "x-validate": null }, "DatasetsV2.ItemManagement.WorkflowData": { "additionalProperties": false, "nullable": true, "properties": { "current_stage_instances": { "description": "List of 'current' stage instances for this item. Each entry on that list will have status: 'current'.", "items": { "$ref": "#/components/schemas/DatasetsV2.ItemManagement.WorkflowData.StageInstance" }, "type": "array", "x-struct": null, "x-validate": null }, "workflow_id": { "$ref": "#/components/schemas/Common.NullableUUID" } }, "required": [ "current_stage_instances" ], "title": "DatasetsV2.ItemManagement.WorkflowData", "type": "object", "x-struct": "Elixir.GraphotateWeb.Schemas.DatasetsV2.ItemManagement.WorkflowData", "x-validate": null }, "DatasetsV2.Common.ItemLayout": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/DatasetsV2.Common.ItemLayoutV3" }, { "$ref": "#/components/schemas/DatasetsV2.Common.ItemLayoutV2" }, { "$ref": "#/components/schemas/DatasetsV2.Common.ItemLayoutV1" } ], "title": "DatasetsV2.Common.ItemLayout", "x-struct": "Elixir.GraphotateWeb.Schemas.DatasetsV2.Common.ItemLayout", "x-validate": null }, "DatasetsV2.Common.NativeSlotFramerate": { "description": "Instructs Darwin that it should extract frames at native framerate.", "enum": [ "native" ], "title": "DatasetsV2.Common.NativeSlotFramerate", "type": "string", "x-struct": null, "x-validate": null }, "DatasetsV2.Filters.ItemPaths": { "oneOf": [ { "description": "List of Item's path", "items": { "$ref": "#/components/schemas/DatasetsV2.Filters.ItemPath" }, "type": "array", "x-struct": null, "x-validate": null }, { "deprecated": true, "description": "[ DEPRECATED ] Comma separated list of Item's path", "example": "/some/path,/some/path", "type": "string", "x-struct": null, "x-validate": null } ], "title": "DatasetsV2.Filters.ItemPaths", "x-struct": "Elixir.GraphotateWeb.Schemas.DatasetsV2.Filters.ItemPaths", "x-validate": null }, "DatasetsV2.ItemManagement.IncludeDicomJson": { "default": false, "description": "Set to 'true' if you need the response to come with a URL for the DICOM JSON of each slot", "title": "DatasetsV2.ItemManagement.IncludeDicomJson", "type": "boolean", "x-struct": "Elixir.GraphotateWeb.Schemas.DatasetsV2.ItemManagement.IncludeDicomJson", "x-validate": null }, "DatasetsV2.Common.ProcessingStatus": { "description": "Current processing status of the Upload/Item.", "enum": [ "cancelled", "error", "uploading", "upload_confirmed", "processing", "complete" ], "title": "DatasetsV2.Common.ProcessingStatus", "type": "string", "x-struct": "Elixir.GraphotateWeb.Schemas.DatasetsV2.Common.ProcessingStatus", "x-validate": null }, "DatasetsV2.ItemManagement.StreamQualityPresetName": { "description": "Name of the quality preset.", "enum": [ "low", "medium", "high" ], "title": "DatasetsV2.ItemManagement.StreamQualityPresetName", "type": "string", "x-struct": "Elixir.GraphotateWeb.Schemas.DatasetsV2.ItemManagement.StreamQualityPresetName", "x-validate": null }, "Common.APIError": { "additionalProperties": false, "properties": { "errors": { "properties": { "code": { "enum": [ "OUT_OF_ANNOTATION_CREDITS", "NOT_ARCHIVED", "ASSIGN_WORKFLOW_TEMPLATE_UNAVAILABLE", "WORKFLOW_UPDATE_FAILURE", "GATED_FEATURE_SSO_AND_SAML", "UPLOAD_DISABLED", "ITEM_REGISTRATION_LIMIT_EXCEEDED", "SSO_REQUIRED", "TOO_MANY_PENDING_EXPORTS", "STORAGE_VALIDATION_FAILED", "INVALID_ITEM_LAYOUT", "WORKFLOW_ALREADY_COMPLETE", "SUBSCRIPTION_INCOMPLETE_EXPIRED", "UNIQUE_CONSTRAINT_VIOLATION", "ITEM_IS_NOT_READY_FOR_ANNOTATIONS_IMPORT", "NO_EXTERNAL_STORAGE_SET_FOR_TEAM", "NO_DEFAULT_WORKFLOW", "PLATFORM_TFA_ENFORCEMENT_LOCKED", "STORAGE_LIMIT_REACHED", "FEATURE_FLAG_DISABLED", "MISSING_FILE_TYPE", "DUPLICATED_FILE_SLOT", "NO_AVAILABLE_WORK", "MODIFYING_COMPLETE_STAGE", "ENFORCING_SSO_BLOCKS_REGULAR_MEMBERSHIPS", "INVALID_SAML_REQUEST", "MISSING_PARAMETERS", "INCORRECT_CLASS_USAGE", "GROUND_TRUTH_NAME_DUPLICATE", "NOT_AUTHENTICATED", "TOO_MANY_ACTIVE_REPORT_JOBS", "NOT_CURRENT_STAGE", "INVALID_2FA_TOKEN", "DATASET_IN_WORKFLOW", "INCOMPATIBLE_STAGE_TYPE", "TARGET_IN_DIFFERENT_DATASET", "ASSIGN_ASSIGNMENT_INVALID", "INVALID_ANNOTATION_DATA", "OUT_OF_SEATS", "STAGE_MISSING_ASSIGNEE", "NO_ANNOTATIONS_ON_SOURCE_ITEM", "REVIEW_STATUS_NOT_SET", "NOT_FOUND", "SUBSCRIPTION_PAST_DUE", "EXTERNAL_STORAGE_LIMIT_REACHED", "UNPROCESSED_VIDEO_REGISTRATION_DISABLED", "GATED_FEATURE_TFA_ENFORCEMENT", "NO_ACTIVE_WORKFLOW", "USER_NOT_FOUND_FOR_ACTOR", "GROUND_TRUTH_VERSIONING_NOT_SUPPORTED", "CLASSES_USED_IN_WORKFLOW", "DUPLICATED_OBJECT_REJECTED", "SUBSCRIPTION_UNPAID", "MULTIBITRATE_STREAM_NOT_AVAILABLE", "TIMEOUT", "TARGET_STAGE_NOT_CURRENT", "BAD_REQUEST", "MULTIPLE_SLOTS_IN_AS_FRAMES_MODE", "INCLUDES_RASTER_LAYER", "OUT_OF_SUBSCRIBED_STORAGE", "REPORT_JOB_NOT_FINISHED", "ASSIGN_ATTRIBUTES_INVALID", "NOT_AUTHORIZED", "SUBSCRIPTION_CANCELLED", "DATASET_ERROR", "STORAGE_NOT_FOUND", "NO_WORKSPACES_AVAILABLE", "TARGET_REVIEW_STAGE_READONLY", "TOO_MANY_ATTEMPTS", "OUT_OF_SUBSCRIBED_ANNOTATION_CREDITS", "SSO_SIGNUP_REQUIRED", "TOO_MANY_PENDING_AI_REVIEW_BLUEPRINTS", "NOTHING_TO_EXPORT", "TARGET_STAGE_TYPE_INVALID", "PAYMENT_NOT_SETUP", "AWS_MARKETPLACE_FULFILLMENT_INCOMPLETE", "MISSING_SELECT_ALL_FILTER", "DUPLICATED_ITEM_FULL_PATH", "UPLOAD_VIDEO_READONLY_STORAGE_MISSING_FRAME_SPECS", "PATH_ALREADY_TAKEN", "TARGET_ALREADY_ANNOTATED", "FILTER_VALIDATION_ERROR", "OPERATION_ALREADY_IN_PROGRESS", "DATASET_NOT_FOUND", "INVALID_URL", "ALREADY_IN_WORKFLOW", "ASSIGN_NOT_ALL_ITEMS_ASSIGNABLE", "INCOMPATIBLE_DATASET_VERSION", "ALREADY_HAS_ANNOTATIONS", "BILLING_ADDRESS_INFO_MISSING", "INVALID_REQUEST", "GATED_FEATURE_EXTERNAL_MODEL_REGISTRATION" ], "type": "string", "x-struct": null, "x-validate": null }, "detail": { "nullable": true, "type": "object", "x-struct": null, "x-validate": null }, "message": { "example": "Error message", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "status": { "example": 422, "nullable": false, "type": "integer", "x-struct": null, "x-validate": null } }, "required": [ "message" ], "type": "object", "x-struct": null, "x-validate": null } }, "required": [ "errors" ], "title": "Common.APIError", "type": "object", "x-struct": "Elixir.GraphotateWeb.Schemas.Common.APIError", "x-validate": null }, "DatasetsV2.Common.ItemLayoutV3": { "additionalProperties": false, "description": "Object describing Item's layout. Version 3.", "example": { "slots_grid": [ [ [ "1", "2" ], "3" ], [ "4" ] ], "version": 3 }, "properties": { "slots_grid": { "description": "3D grid of slots. Max dimensions are 4x4x128.", "items": { "description": "Grid's row.", "items": { "$ref": "#/components/schemas/DatasetsV2.Common.SlotsGridCell" }, "maxItems": 4, "minItems": 1, "type": "array", "x-struct": null, "x-validate": null }, "maxItems": 4, "minItems": 1, "type": "array", "x-struct": null, "x-validate": null }, "version": { "description": "Layout version.", "enum": [ 3 ], "type": "integer", "x-struct": null, "x-validate": null } }, "required": [ "version", "slots_grid" ], "title": "DatasetsV2.Common.ItemLayoutV3", "type": "object", "x-struct": "Elixir.GraphotateWeb.Schemas.DatasetsV2.Common.ItemLayoutV3", "x-validate": null }, "DatasetsV2.Common.SlotsGridCell": { "anyOf": [ { "$ref": "#/components/schemas/DatasetsV2.Common.SlotName" }, { "$ref": "#/components/schemas/DatasetsV2.Common.LayersStack" } ], "title": "DatasetsV2.Common.SlotsGridCell", "x-struct": "Elixir.GraphotateWeb.Schemas.DatasetsV2.Common.SlotsGridCell", "x-validate": null }, "DatasetsV2.Filters.ItemIdsContainer": { "oneOf": [ { "$ref": "#/components/schemas/DatasetsV2.Filters.ItemIds" } ], "x-struct": null, "x-validate": null }, "DatasetsV2.Filters.ItemPathPrefix": { "description": "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", "title": "DatasetsV2.Filters.ItemPathPrefix", "type": "string", "x-struct": "Elixir.GraphotateWeb.Schemas.DatasetsV2.Filters.ItemPathPrefix", "x-validate": null }, "DatasetsV2.Filters.AssigneesContainer": { "oneOf": [ { "$ref": "#/components/schemas/DatasetsV2.Filters.Assignees" } ], "x-struct": null, "x-validate": null }, "DatasetsV2.ItemManagement.Item": { "additionalProperties": false, "properties": { "archived": { "type": "boolean", "x-struct": null, "x-validate": null }, "cursor": { "type": "string", "x-struct": null, "x-validate": null }, "dataset_id": { "$ref": "#/components/schemas/Common.DatasetId" }, "id": { "$ref": "#/components/schemas/Common.UUID" }, "inserted_at": { "description": "Date and time when the item was inserted.", "format": "date-time", "type": "string", "x-struct": null, "x-validate": null }, "layout": { "$ref": "#/components/schemas/DatasetsV2.Common.ItemLayout" }, "name": { "$ref": "#/components/schemas/DatasetsV2.Common.ItemName" }, "path": { "$ref": "#/components/schemas/DatasetsV2.Common.ItemPath" }, "priority": { "$ref": "#/components/schemas/DatasetsV2.Common.Priority" }, "processing_status": { "$ref": "#/components/schemas/DatasetsV2.Common.ProcessingStatus" }, "slot_types": { "items": { "$ref": "#/components/schemas/DatasetsV2.Common.SlotType" }, "type": "array", "x-struct": null, "x-validate": null }, "slots": { "items": { "$ref": "#/components/schemas/DatasetsV2.ItemManagement.Slot" }, "type": "array", "x-struct": null, "x-validate": null }, "status": { "$ref": "#/components/schemas/DatasetsV2.Common.GeneralStatus" }, "tags": { "items": { "$ref": "#/components/schemas/DatasetsV2.ItemManagement.ItemTagType" }, "type": "array", "x-struct": null, "x-validate": null }, "updated_at": { "description": "Date and time when the item was recently updated.", "format": "date-time", "type": "string", "x-struct": null, "x-validate": null }, "uploads": { "items": { "$ref": "#/components/schemas/DatasetsV2.ItemManagement.Upload" }, "type": "array", "x-struct": null, "x-validate": null }, "workflow_data": { "$ref": "#/components/schemas/DatasetsV2.ItemManagement.WorkflowData" }, "workflow_status": { "$ref": "#/components/schemas/DatasetsV2.Common.WorkflowStatus" } }, "required": [ "id", "name", "path", "slots", "uploads", "slot_types", "dataset_id", "processing_status", "workflow_status", "archived", "inserted_at", "priority", "status", "updated_at" ], "title": "DatasetsV2.ItemManagement.Item", "type": "object", "x-struct": "Elixir.GraphotateWeb.Schemas.DatasetsV2.ItemManagement.Item", "x-validate": null }, "Common.DatasetId": { "example": 123, "title": "Common.DatasetId", "type": "integer", "x-struct": "Elixir.GraphotateWeb.Schemas.Common.DatasetId", "x-validate": null }, "DatasetsV2.Filters.StatusesContainer": { "oneOf": [ { "$ref": "#/components/schemas/DatasetsV2.Filters.Statuses" } ], "x-struct": null, "x-validate": null }, "DatasetsV2.Filters.Statuses": { "oneOf": [ { "description": "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.", "items": { "$ref": "#/components/schemas/DatasetsV2.Common.GeneralStatus" }, "type": "array", "x-struct": null, "x-validate": null }, { "deprecated": true, "description": "[ 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": ",", "type": "string", "x-struct": null, "x-validate": null } ], "title": "DatasetsV2.Filters.Statuses", "x-struct": "Elixir.GraphotateWeb.Schemas.DatasetsV2.Filters.Statuses", "x-validate": null }, "DatasetsV2.Filters.WorkflowStageIds": { "oneOf": [ { "description": "List of Item's current workflow stage ID.", "items": { "$ref": "#/components/schemas/DatasetsV2.Filters.WorkflowStageId" }, "type": "array", "x-struct": null, "x-validate": null }, { "deprecated": true, "description": "[ DEPRECATED ] Comma separated list of Item's current workflow stage ID.", "example": "e23ff3f3-8f77-4e78-9e81-fdb25abfb781,e23ff3f3-8f77-4e78-9e81-fdb25abfb781", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}(,[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})*$", "type": "string", "x-struct": null, "x-validate": null } ], "title": "DatasetsV2.Filters.WorkflowStageIds", "x-struct": "Elixir.GraphotateWeb.Schemas.DatasetsV2.Filters.WorkflowStageIds", "x-validate": null }, "DatasetsV2.Common.Priority": { "example": 1, "title": "DatasetsV2.Common.Priority", "type": "integer", "x-struct": "Elixir.GraphotateWeb.Schemas.DatasetsV2.Common.Priority", "x-validate": null }, "DatasetsV2.Filters.Assignees": { "oneOf": [ { "description": "List of Item's assignee ID", "items": { "$ref": "#/components/schemas/WorkflowsV2.Item.AssigneeId" }, "type": "array", "x-struct": null, "x-validate": null }, { "deprecated": true, "description": "[ DEPRECATED ] Comma separated list of Item's assignee ID", "example": "123,123", "type": "string", "x-struct": null, "x-validate": null } ], "title": "DatasetsV2.Filters.Assignees", "x-struct": "Elixir.GraphotateWeb.Schemas.DatasetsV2.Filters.Assignees", "x-validate": null }, "DatasetsV2.Common.ItemName": { "description": "Name of the Item.", "example": "some-item", "pattern": "^[^/]+$", "title": "DatasetsV2.Common.ItemName", "type": "string", "x-struct": "Elixir.GraphotateWeb.Schemas.DatasetsV2.Common.ItemName", "x-validate": null }, "DatasetsV2.ItemManagement.ListItemsResponse": { "additionalProperties": false, "description": "Presents list of items based on provided filters.", "properties": { "items": { "items": { "$ref": "#/components/schemas/DatasetsV2.ItemManagement.Item" }, "type": "array", "x-struct": null, "x-validate": null }, "page": { "$ref": "#/components/schemas/DatasetsV2.Common.PageOutput" } }, "required": [ "items", "page" ], "title": "DatasetsV2.ItemManagement.ListItemsResponse", "type": "object", "x-struct": "Elixir.GraphotateWeb.Schemas.DatasetsV2.ItemManagement.ListItemsResponse", "x-validate": null }, "DatasetsV2.Filters.ItemIds": { "oneOf": [ { "description": "List of Item's UUID", "items": { "$ref": "#/components/schemas/DatasetsV2.Filters.ItemId" }, "type": "array", "x-struct": null, "x-validate": null }, { "deprecated": true, "description": "[ DEPRECATED ] Comma separated list of Item's UUID", "example": "e23ff3f3-8f77-4e78-9e81-fdb25abfb781,e23ff3f3-8f77-4e78-9e81-fdb25abfb781", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}(,[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})*$", "type": "string", "x-struct": null, "x-validate": null } ], "title": "DatasetsV2.Filters.ItemIds", "x-struct": "Elixir.GraphotateWeb.Schemas.DatasetsV2.Filters.ItemIds", "x-validate": null }, "DatasetsV2.Common.WorkflowStatus": { "description": "Current workflow status of the Upload/Item.", "enum": [ "new", "annotate", "review", "complete" ], "nullable": true, "title": "DatasetsV2.Common.WorkflowStatus", "type": "string", "x-struct": "Elixir.GraphotateWeb.Schemas.DatasetsV2.Common.WorkflowStatus", "x-validate": null }, "DatasetsV2.Filters.AnnotationClassIds": { "oneOf": [ { "description": "List of Item's class ID", "items": { "$ref": "#/components/schemas/DatasetsV2.Filters.AnnotationClassId" }, "type": "array", "x-struct": null, "x-validate": null }, { "deprecated": true, "description": "[ DEPRECATED ] Comma separated list of Item's class ID", "example": "123,123", "type": "string", "x-struct": null, "x-validate": null } ], "title": "DatasetsV2.Filters.AnnotationClassIds", "x-struct": "Elixir.GraphotateWeb.Schemas.DatasetsV2.Filters.AnnotationClassIds", "x-validate": null }, "DatasetsV2.ItemManagement.Metadata": { "additionalProperties": true, "description": "Metadata associated with the Slot.", "example": { "some_key1": "some value 1", "some_key2": "some value 2" }, "title": "DatasetsV2.ItemManagement.Metadata", "type": "object", "x-struct": null, "x-validate": null }, "DatasetsV2.Filters.FileTypes": { "oneOf": [ { "description": "List of Type of files within the item", "items": { "$ref": "#/components/schemas/DatasetsV2.Filters.FileType" }, "type": "array", "x-struct": null, "x-validate": null }, { "deprecated": true, "description": "[ DEPRECATED ] Comma separated list of Type of files within the item", "example": "image,image", "type": "string", "x-struct": null, "x-validate": null } ], "title": "DatasetsV2.Filters.FileTypes", "x-struct": "Elixir.GraphotateWeb.Schemas.DatasetsV2.Filters.FileTypes", "x-validate": null }, "DatasetsV2.Filters.FileType": { "description": "Type of files within the item", "enum": [ "image", "video", "pdf", "dicom" ], "example": "image", "title": "DatasetsV2.Filters.FileType", "type": "string", "x-struct": "Elixir.GraphotateWeb.Schemas.DatasetsV2.Filters.FileType", "x-validate": null }, "DatasetsV2.ItemManagement.Upload": { "additionalProperties": false, "properties": { "as_frames": { "$ref": "#/components/schemas/DatasetsV2.Common.SlotAsFrames" }, "file_name": { "$ref": "#/components/schemas/DatasetsV2.Common.FileName" }, "fps": { "$ref": "#/components/schemas/DatasetsV2.Common.SlotFramerate" }, "processing_error": { "$ref": "#/components/schemas/DatasetsV2.Common.ProcessingError" }, "processing_status": { "$ref": "#/components/schemas/DatasetsV2.Common.ProcessingStatus" }, "slot_name": { "$ref": "#/components/schemas/DatasetsV2.Common.SlotName" }, "type": { "$ref": "#/components/schemas/DatasetsV2.Common.SlotType" }, "upload_id": { "$ref": "#/components/schemas/Common.UUID" } }, "required": [ "file_name", "slot_name", "type", "upload_id", "processing_status" ], "title": "DatasetsV2.ItemManagement.Upload", "type": "object", "x-struct": "Elixir.GraphotateWeb.Schemas.DatasetsV2.ItemManagement.Upload", "x-validate": null }, "DatasetsV2.Filters.FileTypesContainer": { "oneOf": [ { "$ref": "#/components/schemas/DatasetsV2.Filters.FileTypes" } ], "x-struct": null, "x-validate": null }, "DatasetsV2.Filters.WorkflowStageIdsContainer": { "oneOf": [ { "$ref": "#/components/schemas/DatasetsV2.Filters.WorkflowStageIds" } ], "x-struct": null, "x-validate": null }, "DatasetsV2.Filters.DatasetIds": { "oneOf": [ { "description": "List of dataset IDs", "items": { "$ref": "#/components/schemas/Common.DatasetId" }, "type": "array", "x-struct": null, "x-validate": null }, { "description": "All dataset IDs.", "enum": [ "all" ], "type": "string", "x-struct": null, "x-validate": null }, { "deprecated": true, "description": "[ DEPRECATED ] Comma seperated list of dataset IDs", "example": "1,2", "pattern": "^([0-9]+,)*([0-9]+|$)", "type": "string", "x-struct": null, "x-validate": null } ], "title": "DatasetsV2.Filters.DatasetIds", "x-struct": "Elixir.GraphotateWeb.Schemas.DatasetsV2.Filters.DatasetIds", "x-validate": null }, "DatasetsV2.ItemManagement.WorkflowData.Assignee": { "description": "Item's assignee ID (of current stage)", "example": 123, "nullable": true, "title": "DatasetsV2.ItemManagement.WorkflowData.Assignee", "type": "integer", "x-struct": "Elixir.GraphotateWeb.Schemas.DatasetsV2.ItemManagement.WorkflowData.Assignee", "x-validate": null }, "DatasetsV2.ItemManagement.WorkflowData.StageInstance": { "additionalProperties": false, "properties": { "active_edge": { "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "assignee_id": { "$ref": "#/components/schemas/DatasetsV2.ItemManagement.WorkflowData.Assignee" }, "delete_annotations_snapshot_id": { "$ref": "#/components/schemas/Common.NullableUUID" }, "exit_snapshot_id": { "$ref": "#/components/schemas/Common.NullableUUID" }, "parent_stage_id": { "$ref": "#/components/schemas/Common.NullableUUID" }, "skipped": { "type": "boolean", "x-struct": null, "x-validate": null }, "skipped_reason": { "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "stage_id": { "$ref": "#/components/schemas/Common.NullableUUID" }, "stage_type": { "$ref": "#/components/schemas/WorkflowsV2.Workflow.StageType" } }, "required": [ "assignee_id", "stage_id", "parent_stage_id", "stage_type", "active_edge", "skipped", "delete_annotations_snapshot_id", "exit_snapshot_id" ], "title": "DatasetsV2.ItemManagement.WorkflowData.StageInstance", "type": "object", "x-struct": "Elixir.GraphotateWeb.Schemas.DatasetsV2.ItemManagement.WorkflowData.StageInstance", "x-validate": null }, "DatasetsV2.Common.SlotFramerate": { "description": "Framerate which Darwin should extract frames at. Should be either positive number or string 'native'.", "oneOf": [ { "$ref": "#/components/schemas/DatasetsV2.Common.NativeSlotFramerate" }, { "$ref": "#/components/schemas/DatasetsV2.Common.CustomSlotFramerate" } ], "title": "DatasetsV2.Common.SlotFramerate", "x-struct": null, "x-validate": null }, "DatasetsV2.ItemManagement.FirstSectionUrl": { "description": "URL section of the Slot. In order to get this please use `include_first_sections=true` in the request.", "example": "https://darwin-production-data.s3.eu-west-1.amazonaws.com/some-file.jpg?X-Amz-Signature=f0aa21e3d89ba4e7a7108eaf9873566ee5e0e3823bc5862fd3b0b9f1f44d15ac&X-Amz-Algorithm=AWS4-HMAC-SHA256", "title": "DatasetsV2.ItemManagement.FirstSectionUrl", "type": "string", "x-struct": "Elixir.GraphotateWeb.Schemas.DatasetsV2.ItemManagement.FirstSectionUrl", "x-validate": null }, "DatasetsV2.ItemManagement.IncludeThumbnails": { "default": false, "description": "Set to 'true' if you need the response to come with thumbnail URLs for each item.", "title": "DatasetsV2.ItemManagement.IncludeThumbnails", "type": "boolean", "x-struct": "Elixir.GraphotateWeb.Schemas.DatasetsV2.ItemManagement.IncludeThumbnails", "x-validate": null }, "WorkflowsV2.Workflow.StageType": { "enum": [ "annotate", "complete", "consensus_entrypoint", "consensus_test", "dataset", "discard", "model", "review", "webhook", "archive", "logic", "sampling", "parallel_blind", "ai_review" ], "title": "WorkflowsV2.Workflow.StageType", "type": "string", "x-struct": null, "x-validate": null }, "DatasetsV2.Common.ItemPath": { "default": "/", "description": "Path under which Item should be added to on Darwin platform. Should always be absolute.", "title": "DatasetsV2.Common.ItemPath", "type": "string", "x-struct": "Elixir.GraphotateWeb.Schemas.DatasetsV2.Common.ItemPath", "x-validate": null }, "DatasetsV2.Filters.DatasetIdsContainer": { "oneOf": [ { "$ref": "#/components/schemas/DatasetsV2.Filters.DatasetIds" } ], "x-struct": null, "x-validate": null }, "DatasetsV2.Common.ProcessingError": { "additionalProperties": false, "description": "Description of the error that occurred while processing the Upload/Item.", "example": { "http_body": "\nAccessDeniedAccess DeniedSome_Request_IdSome_Host_Id", "http_status_code": 403, "message": "An error occurred while uploading a file.", "stage": "upload", "type": "http" }, "nullable": true, "properties": { "http_status_code": { "description": "The HTTP error code, if this error is of type 'http'.", "nullable": true, "type": "integer", "x-struct": null, "x-validate": null }, "message": { "description": "Human readable message of the error.", "type": "string", "x-struct": null, "x-validate": null }, "raw_error": { "description": "The raw body of the error.The format and contents of this field depend both the type of error that occurred and on the provider giving the external storage service.", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "stage": { "description": "The stage of processing at which this error occurred.", "enum": [ "download", "extract", "upload" ], "type": "string", "x-struct": null, "x-validate": null }, "storage_key": { "description": "Storage key (path) of the file that cause the error.", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "type": { "description": "The type of the error that occurred.", "enum": [ "http", "unknown", "timeout", "custom" ], "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "type", "stage", "message" ], "title": "DatasetsV2.Common.ProcessingError", "type": "object", "x-struct": "Elixir.GraphotateWeb.Schemas.DatasetsV2.Common.ProcessingError", "x-validate": null }, "DatasetsV2.Filters.ItemId": { "description": "Item's UUID", "example": "e23ff3f3-8f77-4e78-9e81-fdb25abfb781", "format": "uuid", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "title": "DatasetsV2.Filters.ItemId", "type": "string", "x-struct": "Elixir.GraphotateWeb.Schemas.DatasetsV2.Filters.ItemId", "x-validate": null }, "Common.NullableUUID": { "example": "e23ff3f3-8f77-4e78-9e81-fdb25abfb781", "format": "uuid", "nullable": true, "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "title": "Common.NullableUUID", "type": "string", "x-struct": "Elixir.GraphotateWeb.Schemas.Common.NullableUUID", "x-validate": null }, "Common.UUID": { "example": "e23ff3f3-8f77-4e78-9e81-fdb25abfb781", "format": "uuid", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "title": "Common.UUID", "type": "string", "x-struct": "Elixir.GraphotateWeb.Schemas.Common.UUID", "x-validate": null }, "WorkflowsV2.Item.AssigneeId": { "description": "Item's assignee ID", "example": 123, "title": "WorkflowsV2.Item.AssigneeId", "type": "integer", "x-struct": "Elixir.GraphotateWeb.Schemas.WorkflowsV2.Item.AssigneeId", "x-validate": null }, "DatasetsV2.Common.SlotName": { "description": "'ID' of the Slot to identify it within the Item. It's recommended to use numeric values satarting with 1.", "example": "0", "title": "DatasetsV2.Common.SlotName", "type": "string", "x-struct": "Elixir.GraphotateWeb.Schemas.DatasetsV2.Common.SlotName", "x-validate": null } }, "securitySchemes": { "ApiKeyAuth": { "description": "Prefix the value with 'ApiKey '.", "in": "header", "name": "Authorization", "type": "apiKey" }, "BearerAuth": { "scheme": "bearer", "type": "http" } } }, "info": { "title": "Darwin", "version": "1.0" }, "openapi": "3.0.0", "paths": { "/api/v2/teams/{team_slug}/items": { "get": { "callbacks": {}, "description": "Returns list of Items given provided filters.", "operationId": "items-list", "parameters": [ { "description": "Team's sluggified name", "example": "my-team", "in": "path", "name": "team_slug", "required": true, "schema": { "type": "string", "x-struct": null, "x-validate": null } }, { "description": "", "in": "query", "name": "dataset_ids[]", "required": true, "schema": { "oneOf": [ { "$ref": "#/components/schemas/DatasetsV2.Filters.DatasetIdsContainer" } ], "x-struct": null, "x-validate": null } }, { "description": "Controls whether to include only items with/without comments", "in": "query", "name": "has_comments", "required": false, "schema": { "$ref": "#/components/schemas/DatasetsV2.Filters.HasComments" } }, { "description": "For batch operation this filter has to be set to true if no other optional filter is provided.", "in": "query", "name": "select_all", "required": false, "schema": { "$ref": "#/components/schemas/DatasetsV2.Filters.SelectAll" } }, { "description": "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.", "in": "query", "name": "item_path_prefix", "required": false, "schema": { "$ref": "#/components/schemas/DatasetsV2.Filters.ItemPathPrefix" } }, { "description": "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.", "in": "query", "name": "not_item_path_prefix", "required": false, "schema": { "$ref": "#/components/schemas/DatasetsV2.Filters.ItemPathPrefix" } }, { "description": "", "in": "query", "name": "item_paths[]", "required": false, "schema": { "oneOf": [ { "$ref": "#/components/schemas/DatasetsV2.Filters.ItemPathsContainer" } ], "x-struct": null, "x-validate": null } }, { "description": "", "in": "query", "name": "not_item_paths[]", "required": false, "schema": { "oneOf": [ { "$ref": "#/components/schemas/DatasetsV2.Filters.ItemPathsContainer" } ], "x-struct": null, "x-validate": null } }, { "description": "", "in": "query", "name": "item_ids[]", "required": false, "schema": { "oneOf": [ { "$ref": "#/components/schemas/DatasetsV2.Filters.ItemIdsContainer" } ], "x-struct": null, "x-validate": null } }, { "description": "", "in": "query", "name": "not_item_ids[]", "required": false, "schema": { "oneOf": [ { "$ref": "#/components/schemas/DatasetsV2.Filters.ItemIdsContainer" } ], "x-struct": null, "x-validate": null } }, { "description": "", "in": "query", "name": "item_names[]", "required": false, "schema": { "oneOf": [ { "$ref": "#/components/schemas/DatasetsV2.Filters.ItemNamesContainer" } ], "x-struct": null, "x-validate": null } }, { "description": "", "in": "query", "name": "not_item_names[]", "required": false, "schema": { "oneOf": [ { "$ref": "#/components/schemas/DatasetsV2.Filters.ItemNamesContainer" } ], "x-struct": null, "x-validate": null } }, { "description": "Prefix of item's name", "in": "query", "name": "item_name_prefix", "required": false, "schema": { "$ref": "#/components/schemas/DatasetsV2.Filters.ItemNamePrefix" } }, { "description": "Prefix of item's name", "in": "query", "name": "not_item_name_prefix", "required": false, "schema": { "$ref": "#/components/schemas/DatasetsV2.Filters.ItemNamePrefix" } }, { "description": "Partial item's name", "in": "query", "name": "item_name_contains", "required": false, "schema": { "$ref": "#/components/schemas/DatasetsV2.Filters.ItemNameContains" } }, { "description": "Partial item's name", "in": "query", "name": "not_item_name_contains", "required": false, "schema": { "$ref": "#/components/schemas/DatasetsV2.Filters.ItemNameContains" } }, { "description": "", "in": "query", "name": "workflow_stage_ids[]", "required": false, "schema": { "oneOf": [ { "$ref": "#/components/schemas/DatasetsV2.Filters.WorkflowStageIdsContainer" } ], "x-struct": null, "x-validate": null } }, { "description": "", "in": "query", "name": "not_workflow_stage_ids[]", "required": false, "schema": { "oneOf": [ { "$ref": "#/components/schemas/DatasetsV2.Filters.WorkflowStageIdsContainer" } ], "x-struct": null, "x-validate": null } }, { "description": "", "in": "query", "name": "types[]", "required": false, "schema": { "oneOf": [ { "$ref": "#/components/schemas/DatasetsV2.Filters.FileTypesContainer" } ], "x-struct": null, "x-validate": null } }, { "description": "", "in": "query", "name": "not_types[]", "required": false, "schema": { "oneOf": [ { "$ref": "#/components/schemas/DatasetsV2.Filters.FileTypesContainer" } ], "x-struct": null, "x-validate": null } }, { "description": "", "in": "query", "name": "statuses[]", "required": false, "schema": { "oneOf": [ { "$ref": "#/components/schemas/DatasetsV2.Filters.StatusesContainer" } ], "x-struct": null, "x-validate": null } }, { "description": "", "in": "query", "name": "not_statuses[]", "required": false, "schema": { "oneOf": [ { "$ref": "#/components/schemas/DatasetsV2.Filters.StatusesContainer" } ], "x-struct": null, "x-validate": null } }, { "description": "", "in": "query", "name": "annotation_class_ids[]", "required": false, "schema": { "oneOf": [ { "$ref": "#/components/schemas/DatasetsV2.Filters.AnnotationClassIdsContainer" } ], "x-struct": null, "x-validate": null } }, { "description": "", "in": "query", "name": "not_annotation_class_ids[]", "required": false, "schema": { "oneOf": [ { "$ref": "#/components/schemas/DatasetsV2.Filters.AnnotationClassIdsContainer" } ], "x-struct": null, "x-validate": null } }, { "description": "", "in": "query", "name": "current_assignees[]", "required": false, "schema": { "oneOf": [ { "$ref": "#/components/schemas/DatasetsV2.Filters.AssigneesContainer" } ], "x-struct": null, "x-validate": null } }, { "description": "", "in": "query", "name": "not_current_assignees[]", "required": false, "schema": { "oneOf": [ { "$ref": "#/components/schemas/DatasetsV2.Filters.AssigneesContainer" } ], "x-struct": null, "x-validate": null } }, { "description": "", "in": "query", "name": "assignees[]", "required": false, "schema": { "oneOf": [ { "$ref": "#/components/schemas/DatasetsV2.Filters.AssigneesContainer" } ], "x-struct": null, "x-validate": null } }, { "description": "", "in": "query", "name": "not_assignees[]", "required": false, "schema": { "oneOf": [ { "$ref": "#/components/schemas/DatasetsV2.Filters.AssigneesContainer" } ], "x-struct": null, "x-validate": null } }, { "description": "Set to 'true' if you need the response to come with thumbnail URLs for each item.", "in": "query", "name": "include_thumbnails", "required": false, "schema": { "$ref": "#/components/schemas/DatasetsV2.ItemManagement.IncludeThumbnails" } }, { "description": "Set to 'true' if you need the response to come with a URL for the DICOM JSON of each slot", "in": "query", "name": "include_dicom_json", "required": false, "schema": { "$ref": "#/components/schemas/DatasetsV2.ItemManagement.IncludeDicomJson" } }, { "description": "Set to 'true' if you need the response to come with URLs to first section for each item.", "in": "query", "name": "include_first_sections", "required": false, "schema": { "$ref": "#/components/schemas/DatasetsV2.ItemManagement.IncludeFirstSections" } }, { "description": "Set to 'true' if you need the response to come with additional workflow-related data. See 'WorkflowData' schema for more details.", "in": "query", "name": "include_workflow_data", "required": false, "schema": { "$ref": "#/components/schemas/DatasetsV2.ItemManagement.IncludeWorkflowData" } }, { "description": "Set to 'true' if you need the response to come with tags associated with Item's slots.", "in": "query", "name": "include_tags", "required": false, "schema": { "$ref": "#/components/schemas/DatasetsV2.ItemManagement.IncludeTags" } }, { "in": "query", "name": "page[offset]", "required": false, "schema": { "description": "Defines how many items matching filters need to be skipped before returning result. Default value is 0.", "example": 123, "type": "integer", "x-struct": null, "x-validate": null } }, { "in": "query", "name": "page[size]", "required": false, "schema": { "description": "Defines max number of items to return on single page. Default value is 500.", "example": 500, "type": "integer", "x-struct": null, "x-validate": null } }, { "in": "query", "name": "page[to]", "required": false, "schema": { "description": "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", "nullable": true, "pattern": "^(.+,)*(([0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12})|([0-9]+))$", "type": "string", "x-struct": null, "x-validate": null } }, { "in": "query", "name": "page[from]", "required": false, "schema": { "description": "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", "nullable": true, "pattern": "^(.+,)*(([0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12})|([0-9]+))$", "type": "string", "x-struct": null, "x-validate": null } }, { "in": "query", "name": "sort[id]", "required": false, "schema": { "description": "Sort by ID. Default value is asc.", "enum": [ "asc", "desc" ], "type": "string", "x-struct": null, "x-validate": null } }, { "in": "query", "name": "sort[name]", "required": false, "schema": { "description": "Sort by name. Default value is asc.", "enum": [ "asc", "desc" ], "type": "string", "x-struct": null, "x-validate": null } }, { "in": "query", "name": "sort[priority]", "required": false, "schema": { "description": "Sort by priority. Default value is asc.", "enum": [ "asc", "desc" ], "type": "string", "x-struct": null, "x-validate": null } }, { "in": "query", "name": "sort[byte_size]", "required": false, "schema": { "description": "Sort by overall size. Default value is asc.", "enum": [ "asc", "desc" ], "type": "string", "x-struct": null, "x-validate": null } }, { "in": "query", "name": "sort[map]", "required": false, "schema": { "description": "Sort by mean average precision metric in an evaluation run. Default value is asc.", "enum": [ "asc", "desc" ], "type": "string", "x-struct": null, "x-validate": null } }, { "in": "query", "name": "sort[updated_at]", "required": false, "schema": { "description": "Sort by recently updated. Default value is asc.", "enum": [ "asc", "desc" ], "type": "string", "x-struct": null, "x-validate": null } }, { "in": "query", "name": "sort[accuracy]", "required": false, "schema": { "description": "Sort by accuracy metric in an evaluation run. Default value is asc.", "enum": [ "asc", "desc" ], "type": "string", "x-struct": null, "x-validate": null } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DatasetsV2.ItemManagement.ListItemsResponse" } } }, "description": "DatasetsV2.ItemManagement.ListItemsResponse" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common.APIError" } } }, "description": "Common.APIError" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Common.APIError" } } }, "description": "Common.APIError" }, "422": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/JsonErrorResponse" }, { "$ref": "#/components/schemas/Common.APIError" } ], "x-struct": null, "x-validate": null } } }, "description": "Unprocessible Entity" } }, "summary": "List items", "tags": [ "Items" ] } } }, "security": [ { "BearerAuth": [] }, { "ApiKeyAuth": [] } ], "servers": [ { "url": "https://darwin.v7labs.com", "variables": {} } ] } ```