Skip to content
Qualia Docs

Episodes_RejectEpisodes

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

Rejects episodes in the parent’s scope. In a mixture the reject is the mixture’s; episodes not KEPT upstream are skipped.

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.RejectEpisodes.

object
parent
required

Accounts/{account}/datasets/{dataset}: the scope the reject is made in.

string
selection
required

Which episodes.

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
reason

Optional words for the record.

string
Example generated
{
  "parent": "example",
  "selection": {
    "names": {
      "names": [
        "example"
      ]
    },
    "filter": "example"
  },
  "reason": "example"
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

OK

Media type application/json

Response for Episodes.RejectEpisodes.

object
result

What happened.

object
changedCount

Episodes whose standing changed.

integer format: int32
unchangedCount

Episodes already standing that way.

integer format: int32
skippedCount

Episodes skipped: through a mixture, those not KEPT upstream (rejected or unreviewed in their upload or a mixture in between); anywhere, a Restore on an episode that is not a validation reject, and a Keep on a validation reject (RestoreEpisodes puts those back, with a reason).

integer format: int32
dismissedIssueCount

Open issues dismissed with a keep.

integer format: int32
lockedCount

Episodes the call would have changed but left as they were, because another person holds their edit lease. Not counted in skipped_count.

integer format: int32
locked

The first 100 of them, with their holders.

Array<object>

An episode a write left alone, or refused, because another person holds its edit lease (Episodes.AcquireEpisodeLease). Bulk responses list at most 100 of these beside a count of all of them.

object
episode

Accounts/{account}/datasets/{dataset}/episodes/{episode}, in the scope the write was made in.

string
holderName

The holder’s display name; empty when they have none. (— api-linter: core::0122::name-suffix=disabled aip.dev/not-precedent: a person’s display name, as Episode.Lease calls it. —)

string
reopenedIssueCount

Blocking issues a reset reopened: the ones the withdrawn keep had closed.

integer format: int32
Example generated
{
  "result": {
    "changedCount": 1,
    "unchangedCount": 1,
    "skippedCount": 1,
    "dismissedIssueCount": 1,
    "lockedCount": 1,
    "locked": [
      {
        "episode": "example",
        "holderName": "example"
      }
    ],
    "reopenedIssueCount": 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"
    }
  ]
}