Items

Returns an Item with the provided ID.

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

Request

  • Base URL
    https://darwin.v7labs.com
  • URL
    https://darwin.v7labs.com/api/v2/teams/{team_slug}/items/{item_id}
  • Auth
    • HTTP bearer
    • or API key in header Authorization

Path parameters

team_slugstring required

Team's sluggified name

item_idstring uuid required
Example:e23ff3f3-8f77-4e78-9e81-fdb25abfb781

Query parameters

include_thumbnailsboolean

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

include_dicom_jsonboolean

Set to 'true' if you need the response to come with a URL for the DICOM JSON of each slot

include_first_sectionsboolean

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

include_tagsboolean

Set to 'true' if you need the response to come with tags associated with Item's slots.

Response

DatasetsV2.ItemManagement.Item

archivedboolean required
cursorstring
dataset_idinteger required
idstring uuid required
inserted_atstring date-time required

Date and time when the item was inserted.

namestring required

Name of the Item.

pathstring required

Path under which Item should be added to on Darwin platform. Should always be absolute.

priorityinteger required
processing_status'cancelled' | 'error' | 'uploading' | 'upload_confirmed' | 'processing' | 'complete' required

Current processing status of the Upload/Item.

slot_typesDatasetsV2CommonSlotType[] required
status'error' | 'uploading' | 'processing' | 'archived' | 'new' | 'annotate' | 'review' | 'complete' required

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.

tagsDatasetsV2ItemManagementItemTagType[]
updated_atstring date-time required

Date and time when the item was recently updated.

workflow_status'new' | 'annotate' | 'review' | 'complete' nullable required

Current workflow status of the Upload/Item.

Example response

{
  "dataset_id": 123,
  "id": "e23ff3f3-8f77-4e78-9e81-fdb25abfb781",
  "layout": {
    "slots_grid": [
      [
        [
          "1",
          "2"
        ],
        "3"
      ],
      [
        "4"
      ]
    ],
    "version": 3
  },
  "name": "some-item",
  "priority": 1,
  "slots": [
    {
      "file_name": "my_image.jpg",
      "first_section_url": "https://darwin-production-data.s3.eu-west-1.amazonaws.com/some-file.jpg?X-Amz-Signature=f0aa21e3d89ba4e7a7108eaf9873566ee5e0e3823bc5862fd3b0b9f1f44d15ac&X-Amz-Algorithm=AWS4-HMAC-SHA256",
      "id": "e23ff3f3-8f77-4e78-9e81-fdb25abfb781",
      "metadata": {
        "some_key1": "some value 1",
        "some_key2": "some value 2"
      },
      "slot_name": "0",
      "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",
      "total_sections": 5,
      "upload_id": "e23ff3f3-8f77-4e78-9e81-fdb25abfb781"
    }
  ],
  "uploads": [
    {
      "file_name": "my_image.jpg",
      "processing_error": {
        "http_body": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<Error><Code>AccessDenied</Code><Message>Access Denied</Message><RequestId>Some_Request_Id</RequestId><HostId>Some_Host_Id</HostId></Error>",
        "http_status_code": 403,
        "message": "An error occurred while uploading a file.",
        "stage": "upload",
        "type": "http"
      },
      "slot_name": "0",
      "upload_id": "e23ff3f3-8f77-4e78-9e81-fdb25abfb781"
    }
  ],
  "workflow_data": {
    "current_stage_instances": [
      {
        "assignee_id": 123,
        "delete_annotations_snapshot_id": "e23ff3f3-8f77-4e78-9e81-fdb25abfb781",
        "exit_snapshot_id": "e23ff3f3-8f77-4e78-9e81-fdb25abfb781",
        "parent_stage_id": "e23ff3f3-8f77-4e78-9e81-fdb25abfb781",
        "stage_id": "e23ff3f3-8f77-4e78-9e81-fdb25abfb781"
      }
    ],
    "workflow_id": "e23ff3f3-8f77-4e78-9e81-fdb25abfb781"
  }
}

Changes

    • warning

      added the new DUPLICATE_REJECT_REASON enum value to the / response property for the response status

    • warning

      added the new DUPLICATE_REJECT_REASON enum value to the / response property for the response status

    • warning

      added the new DUPLICATE_REJECT_REASON enum value to the // response property for the response status

    • warning

      added the new EXTERNAL_STORAGE_ACCESS_FAILED enum value to the / response property for the response status

    • warning

      added the new EXTERNAL_STORAGE_ACCESS_FAILED enum value to the / response property for the response status

    • warning

      added the new EXTERNAL_STORAGE_ACCESS_FAILED enum value to the // response property for the response status

    • warning

      added the new INVALID_REJECT_REASON enum value to the / response property for the response status

    • warning

      added the new INVALID_REJECT_REASON enum value to the / response property for the response status

    • warning

      added the new INVALID_REJECT_REASON enum value to the // response property for the response status

    • warning

      added the new INVALID_REJECT_REASONS enum value to the / response property for the response status

    • warning

      added the new INVALID_REJECT_REASONS enum value to the / response property for the response status

    • warning

      added the new INVALID_REJECT_REASONS enum value to the // response property for the response status

    • warning

      added the new REJECT_REASON_REQUIRED enum value to the / response property for the response status

    • warning

      added the new REJECT_REASON_REQUIRED enum value to the / response property for the response status

    • warning

      added the new REJECT_REASON_REQUIRED enum value to the // response property for the response status

    • warning

      added the new REPORT_TOO_LARGE enum value to the / response property for the response status

    • warning

      added the new REPORT_TOO_LARGE enum value to the / response property for the response status

    • warning

      added the new REPORT_TOO_LARGE enum value to the // response property for the response status

    • warning

      added the new TOO_MANY_ACTIVE_REPORT_JOBS enum value to the / response property for the response status

    • warning

      added the new TOO_MANY_ACTIVE_REPORT_JOBS enum value to the / response property for the response status

    • warning

      added the new TOO_MANY_ACTIVE_REPORT_JOBS enum value to the // response property for the response status

    • warning

      added the new TOO_MANY_PENDING_AI_REVIEW_BLUEPRINTS enum value to the / response property for the response status

    • warning

      added the new TOO_MANY_PENDING_AI_REVIEW_BLUEPRINTS enum value to the / response property for the response status

    • warning

      added the new TOO_MANY_PENDING_AI_REVIEW_BLUEPRINTS enum value to the // response property for the response status

    • warning

      added the new TOO_MANY_PENDING_EXPORTS enum value to the / response property for the response status

    • warning

      added the new TOO_MANY_PENDING_EXPORTS enum value to the / response property for the response status

    • warning

      added the new TOO_MANY_PENDING_EXPORTS enum value to the // response property for the response status

    • warning

      added the new TOO_MANY_REJECT_REASONS enum value to the / response property for the response status

    • warning

      added the new TOO_MANY_REJECT_REASONS enum value to the / response property for the response status

    • warning

      added the new TOO_MANY_REJECT_REASONS enum value to the // response property for the response status