{
  "opencollection": "1.0.0",
  "info": {
    "name": "API Reference subpackage_actions subpackage_dimensions API",
    "version": "1.0.0"
  },
  "items": [
    {
      "info": {
        "name": "subpackage_dimensions",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "✨ Trigger Agreement V2 backfill",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "http://localhost:8000/api/dimensions/backfill/",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "<Card href=\"https://humansignal.com/goenterprise\">\n        <img style=\"pointer-events: none; margin-left: 0px; margin-right: 0px;\" src=\"https://docs.humansignal.com/images/badge.svg\" alt=\"Label Studio Enterprise badge\"/>\n        <p style=\"margin-top: 10px; font-size: 14px;\">\n            This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n        </p>\n    </Card>\nTrigger an Agreement V2 backfill for the"
        },
        {
          "info": {
            "name": "✨ Cancel Agreement V2 backfill jobs",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "http://localhost:8000/api/dimensions/backfill/",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "job_id",
                "value": "",
                "type": "query",
                "description": "Optional specific job ID to cancel"
              },
              {
                "name": "project_id",
                "value": "",
                "type": "query",
                "description": "Optional project ID to cancel its active backfill jobs"
              }
            ]
          },
          "docs": "<Card href=\"https://humansignal.com/goenterprise\">\n        <img style=\"pointer-events: none; margin-left: 0px; margin-right: 0px;\" src=\"https://docs.humansignal.com/images/badge.svg\" alt=\"Label Studio Enterprise badge\"/>\n        <p style=\"margin-top: 10px; font-size: 14px;\">\n            This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n        </p>\n    </Card>\nCancel Agreement V2 backfill jobs for th"
        },
        {
          "info": {
            "name": "✨ List Agreement V2 backfill jobs",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://localhost:8000/api/dimensions/backfill/jobs/",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "status",
                "value": "",
                "type": "query",
                "description": "Filter by job status: PENDING, QUEUED, RUNNING, COMPLETED, or FAILED."
              }
            ]
          },
          "docs": "<Card href=\"https://humansignal.com/goenterprise\">\n        <img style=\"pointer-events: none; margin-left: 0px; margin-right: 0px;\" src=\"https://docs.humansignal.com/images/badge.svg\" alt=\"Label Studio Enterprise badge\"/>\n        <p style=\"margin-top: 10px; font-size: 14px;\">\n            This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n        </p>\n    </Card>\nRetrieve Agreement V2 backfill jobs for "
        },
        {
          "info": {
            "name": "✨ Get Agreement V2 backfill status",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://localhost:8000/api/dimensions/backfill/status/",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "job_id",
                "value": "",
                "type": "query",
                "description": "Optional job ID to retrieve specific job status"
              },
              {
                "name": "project_id",
                "value": "",
                "type": "query",
                "description": "Optional project ID to retrieve the latest backfill status for that project. If omitted, returns aggregated organization status."
              }
            ]
          },
          "docs": "<Card href=\"https://humansignal.com/goenterprise\">\n        <img style=\"pointer-events: none; margin-left: 0px; margin-right: 0px;\" src=\"https://docs.humansignal.com/images/badge.svg\" alt=\"Label Studio Enterprise badge\"/>\n        <p style=\"margin-top: 10px; font-size: 14px;\">\n            This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n        </p>\n    </Card>\nRetrieve the status of an Agreement V2 b"
        },
        {
          "info": {
            "name": "✨ List dimensions",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://localhost:8000/api/projects/:project_pk/dimensions/",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "project_pk",
                "value": "",
                "type": "path",
                "description": "Project ID"
              },
              {
                "name": "agreement_methodology",
                "value": "",
                "type": "query",
                "description": "Agreement methodology to use for computing allowed_metrics_with_params. If not provided, uses the methodology stored in the project settings. Valid values: \"pairwise\", \"consensus\". "
              },
              {
                "name": "is_active",
                "value": "",
                "type": "query",
                "description": "Filter by active status"
              },
              {
                "name": "ordering",
                "value": "",
                "type": "query",
                "description": "Which field to use when ordering the results."
              }
            ]
          },
          "docs": "<Card href=\"https://humansignal.com/goenterprise\">\n        <img style=\"pointer-events: none; margin-left: 0px; margin-right: 0px;\" src=\"https://docs.humansignal.com/images/badge.svg\" alt=\"Label Studio Enterprise badge\"/>\n        <p style=\"margin-top: 10px; font-size: 14px;\">\n            This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n        </p>\n    </Card>\nList all dimensions for a specific proje"
        },
        {
          "info": {
            "name": "✨ Get dimension",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://localhost:8000/api/projects/:project_pk/dimensions/:id/",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Dimension ID"
              },
              {
                "name": "project_pk",
                "value": "",
                "type": "path",
                "description": "Project ID"
              }
            ]
          },
          "docs": "<Card href=\"https://humansignal.com/goenterprise\">\n        <img style=\"pointer-events: none; margin-left: 0px; margin-right: 0px;\" src=\"https://docs.humansignal.com/images/badge.svg\" alt=\"Label Studio Enterprise badge\"/>\n        <p style=\"margin-top: 10px; font-size: 14px;\">\n            This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n        </p>\n    </Card>\nRetrieve a specific dimension by ID."
        }
      ]
    }
  ],
  "bundled": true
}