API Reference — subpackage_projects.subpackage_projects/assignments

naftiko: 1.0.0-alpha2
info:
  label: API Reference — subpackage_projects.subpackage_projects/assignments
  description: 'API Reference — subpackage_projects.subpackage_projects/assignments. 5 operations. Lead operation: ✨ Bulk
    assign users to tasks. Self-contained Naftiko capability covering one Label Studio business surface.'
  tags:
  - Label Studio
  - subpackage_projects.subpackage_projects/assignments
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    LABEL_STUDIO_API_KEY: LABEL_STUDIO_API_KEY
capability:
  consumes:
  - type: http
    namespace: label-studio-subpackage-projects-subpackage-projects-assignments
    baseUri: http://localhost:8000
    description: API Reference — subpackage_projects.subpackage_projects/assignments business capability. Self-contained,
      no shared references.
    resources:
    - name: api-projects-id-tasks-assignees
      path: /api/projects/{id}/tasks/assignees
      operations:
      - name: bulkassign
        method: POST
        description: ✨ Bulk assign users to tasks
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: integer
          required: true
        - name: Authorization
          in: header
          type: string
          description: 'The token (or API key) must be passed as a request header. You can find your user token on the User
            Account page in Label Studio. Example: <br><pre><code class='
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: api-projects-id-tasks-task_pk-assignees
      path: /api/projects/{id}/tasks/{task_pk}/assignees
      operations:
      - name: list
        method: GET
        description: ✨ Get assigned tasks and assignees
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: integer
          description: A unique integer value identifying this project.
          required: true
        - name: task_pk
          in: path
          type: integer
          description: A unique integer value identifying this task.
          required: true
        - name: Authorization
          in: header
          type: string
          description: 'The token (or API key) must be passed as a request header. You can find your user token on the User
            Account page in Label Studio. Example: <br><pre><code class='
          required: true
      - name: assign
        method: POST
        description: ✨ Create task assignee
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: integer
          description: A unique integer value identifying this project.
          required: true
        - name: task_pk
          in: path
          type: integer
          description: A unique integer value identifying this task.
          required: true
        - name: Authorization
          in: header
          type: string
          description: 'The token (or API key) must be passed as a request header. You can find your user token on the User
            Account page in Label Studio. Example: <br><pre><code class='
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: delete
        method: DELETE
        description: ✨ Delete task assignments
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: integer
          description: A unique integer value identifying this project.
          required: true
        - name: task_pk
          in: path
          type: integer
          description: A unique integer value identifying this task.
          required: true
        - name: type
          in: query
          type: string
          description: Assignment type to delete (optional). If omitted, deletes all assignments for the task.
        - name: users
          in: query
          type: string
          description: Comma separated list of user IDs to delete, as a string. If omitted, deletes all assignees for the
            given type.
        - name: Authorization
          in: header
          type: string
          description: 'The token (or API key) must be passed as a request header. You can find your user token on the User
            Account page in Label Studio. Example: <br><pre><code class='
          required: true
      - name: update
        method: PATCH
        description: ✨ Update task assignee
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: integer
          description: A unique integer value identifying this project.
          required: true
        - name: task_pk
          in: path
          type: integer
          description: A unique integer value identifying this task.
          required: true
        - name: Authorization
          in: header
          type: string
          description: 'The token (or API key) must be passed as a request header. You can find your user token on the User
            Account page in Label Studio. Example: <br><pre><code class='
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    authentication:
      type: apikey
      key: Authorization
      value: '{{env.LABEL_STUDIO_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: label-studio-subpackage-projects-subpackage-projects-assignments-rest
    port: 8080
    description: REST adapter for API Reference — subpackage_projects.subpackage_projects/assignments. One Spectral-compliant
      resource per consumed operation, prefixed with /v1.
    resources:
    - path: /v1/api/projects/{id}/tasks/assignees
      name: api-projects-id-tasks-assignees
      description: REST surface for api-projects-id-tasks-assignees.
      operations:
      - method: POST
        name: bulkassign
        description: ✨ Bulk assign users to tasks
        call: label-studio-subpackage-projects-subpackage-projects-assignments.bulkassign
        with:
          id: rest.id
          Authorization: rest.Authorization
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/projects/{id}/tasks/{task-pk}/assignees
      name: api-projects-id-tasks-task-pk-assignees
      description: REST surface for api-projects-id-tasks-task_pk-assignees.
      operations:
      - method: GET
        name: list
        description: ✨ Get assigned tasks and assignees
        call: label-studio-subpackage-projects-subpackage-projects-assignments.list
        with:
          id: rest.id
          task_pk: rest.task_pk
          Authorization: rest.Authorization
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: assign
        description: ✨ Create task assignee
        call: label-studio-subpackage-projects-subpackage-projects-assignments.assign
        with:
          id: rest.id
          task_pk: rest.task_pk
          Authorization: rest.Authorization
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: delete
        description: ✨ Delete task assignments
        call: label-studio-subpackage-projects-subpackage-projects-assignments.delete
        with:
          id: rest.id
          task_pk: rest.task_pk
          type: rest.type
          users: rest.users
          Authorization: rest.Authorization
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: update
        description: ✨ Update task assignee
        call: label-studio-subpackage-projects-subpackage-projects-assignments.update
        with:
          id: rest.id
          task_pk: rest.task_pk
          Authorization: rest.Authorization
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: label-studio-subpackage-projects-subpackage-projects-assignments-mcp
    port: 9090
    transport: http
    description: MCP adapter for API Reference — subpackage_projects.subpackage_projects/assignments. One tool per consumed
      operation, routed inline through this capability's consumes block.
    tools:
    - name: bulk-assign-users-tasks
      description: ✨ Bulk assign users to tasks
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: label-studio-subpackage-projects-subpackage-projects-assignments.bulkassign
      with:
        id: tools.id
        Authorization: tools.Authorization
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-assigned-tasks-and-assignees
      description: ✨ Get assigned tasks and assignees
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: label-studio-subpackage-projects-subpackage-projects-assignments.list
      with:
        id: tools.id
        task_pk: tools.task_pk
        Authorization: tools.Authorization
      outputParameters:
      - type: object
        mapping: $.
    - name: create-task-assignee
      description: ✨ Create task assignee
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: label-studio-subpackage-projects-subpackage-projects-assignments.assign
      with:
        id: tools.id
        task_pk: tools.task_pk
        Authorization: tools.Authorization
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-task-assignments
      description: ✨ Delete task assignments
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: label-studio-subpackage-projects-subpackage-projects-assignments.delete
      with:
        id: tools.id
        task_pk: tools.task_pk
        type: tools.type
        users: tools.users
        Authorization: tools.Authorization
      outputParameters:
      - type: object
        mapping: $.
    - name: update-task-assignee
      description: ✨ Update task assignee
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: label-studio-subpackage-projects-subpackage-projects-assignments.update
      with:
        id: tools.id
        task_pk: tools.task_pk
        Authorization: tools.Authorization
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.