Skip to content
Qualia Docs

Episodes_AssignTask

POST
/v1/accounts/{account}/datasets/{dataset}/episodes:assignTask
 
curl --request POST \
  --url https://dev-api.qualiastudios.dev/v1/accounts/example/datasets/example/episodes:assignTask \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <X-API-Key>' \
  --data '{ "parent": "example", "selection": { "names": { "names": [ "example" ] }, "filter": "example" }, "task": "example", "requestId": "example", "linkedTask": "example" }'

Sets one task label on every selected episode of an upload in a single publication (QUA-3023): all of them or none. Episodes whose task already reads that label are left as they are; the rest get one revision each and share one TASK_ASSIGNED event. Selection runs over the upload’s episodes, which do not include the children of a split: a split parent takes the label, and its children take it with it in the same publication. Through a merged dataset (QUA-3443) the selection is split by the upload that holds each episode: one such publication per upload.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
account
required
string

The account id.

dataset
required
string

The dataset id.

Request Body required

Section titled “Request Body required ”
Media type application/json

Request for Episodes.AssignTask.

object
parent
required

Accounts/{account}/datasets/{dataset}: must be the upload.

string
selection
required

Which episodes, at most 10000.

object
names

Episode names under the request’s parent.

object
names

Accounts/{account}/datasets/{dataset}/episodes/{episode}, at most 10000.

Array<string>
filter

A ListEpisodes filter over the parent (e.g. what the filter bar leaves).

string
task

The task label every selected episode should read. Required unless linked_task is set, when it defaults to that task’s display_name.

string
requestId

Optional UUID4 identifying this logical edit. Reusing it with the same caller and request returns the original result; different input conflicts. When absent, each call starts a new logical edit.

string
linkedTask

Accounts/{account}/tasks/{task}: link every selected episode to this task as well (QUA-3116). A task of the dataset’s account; NOT_FOUND otherwise. Empty leaves links as they are.

string
Example generated
{
  "parent": "example",
  "selection": {
    "names": {
      "names": [
        "example"
      ]
    },
    "filter": "example"
  },
  "task": "example",
  "requestId": "example",
  "linkedTask": "example"
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

OK

Media type application/json

Response for Episodes.AssignTask.

object
assignedCount

Episodes whose task changed to the label, or whose link changed.

integer format: int32
unchangedCount

Selected episodes that already read the label (and the link), left unchanged.

integer format: int32
childrenFollowedCount

Split children of the relabelled episodes that took the label with their parent. A child is never selected or counted on its own.

integer format: int32
Example generated
{
  "assignedCount": 1,
  "unchangedCount": 1,
  "childrenFollowedCount": 1
}

default

Section titled “default ”

Default error response

Media type application/json

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.

object
code

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

integer format: int32
message

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

string
details

A list of messages that carry the error details. There is a common set of message types for APIs to use.

Array<object>

Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.

object
@type

The type of the serialized message.

string
key
additional properties
any
Example generated
{
  "code": 1,
  "message": "example",
  "details": [
    {
      "@type": "example"
    }
  ]
}