{
  "opencollection": "1.0.0",
  "info": {
    "name": "API Reference subpackage_actions subpackage_annotations API",
    "version": "1.0.0"
  },
  "items": [
    {
      "info": {
        "name": "subpackage_annotations",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Bulk delete annotations by IDs",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "http://localhost:8000/api/annotations/bulk-delete/",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Delete multiple annotations by their IDs. The deletion is processed synchronously. Returns the count of deleted annotations in the response."
        },
        {
          "info": {
            "name": "Bulk create annotations",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "http://localhost:8000/api/annotations/bulk/",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create multiple annotations at once"
        },
        {
          "info": {
            "name": "Get annotation by its ID",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://localhost:8000/api/annotations/:id/",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Retrieve a specific annotation for a task using the annotation result ID."
        },
        {
          "info": {
            "name": "Update annotation",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "http://localhost:8000/api/annotations/:id/",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update existing attributes on an annotation."
        },
        {
          "info": {
            "name": "Delete annotation",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "http://localhost:8000/api/annotations/:id/",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Delete an annotation. This action can't be undone!"
        },
        {
          "info": {
            "name": "Get all task annotations",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://localhost:8000/api/tasks/:id/annotations/",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Task ID"
              },
              {
                "name": "ordering",
                "value": "",
                "type": "query",
                "description": "Which field to use when ordering the results."
              }
            ]
          },
          "docs": "List all annotations for a task."
        },
        {
          "info": {
            "name": "Create annotation",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "http://localhost:8000/api/tasks/:id/annotations/",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Task ID"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "\n        Add annotations to a task like an annotator does. The content of the result field depends on your\n        labeling configuration. For example, send the following data as part of your POST\n        request to send an empty annotation with the ID of the user who completed the task:\n\n        ```json\n        {\n        \"result\": {},\n        \"was_cancelled\": true,\n        \"ground_truth\": true,\n        \"lead_time\": 0,\n        \"task\": 0\n        \"completed_by\": 123\n        }\n        ```\n        "
        }
      ]
    }
  ],
  "bundled": true
}