Skip to content
Qualia Docs

Episodes_LocateEpisode

GET
/v1/accounts/{account}/datasets/{dataset}/episodes/{episode}:locate
 
curl --request GET \
  --url https://dev-api.qualiastudios.dev/v1/accounts/example/datasets/example/episodes/example:locate \
  --header 'X-API-Key: <X-API-Key>'

Where one episode sits in a filtered, ordered list of its dataset: its position and neighbours, for “12 / 340” and prev / next in the studio (QUA-1820). NOT_FOUND when the filter excludes it.

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.

episode
required
string

The episode id.

Query Parameters

Section titled “Query Parameters ”
filter
string

Same language as ListEpisodes.filter.

orderBy
string

Same values as ListEpisodes.order_by.

pageSize
integer format: int32

The page size the returned page_token is for; same rules as ListEpisodes.page_size. Pass the same value to ListEpisodes.

version
string

Locate it in the list as this version froze it (QUA-3539), the one ListEpisodes.version reads: that version’s episodes, in its order. Same values as ListEpisodes.version; pass the same value to ListEpisodes.

Responses

Section titled “ Responses ”

200

Section titled “200 ”

OK

Media type application/json

Response for Episodes.LocateEpisode.

object
position

Its index in the filtered order, from 0.

integer format: int32
totalSize

Episodes the filter leaves.

integer format: int32
previousEpisode

The episode before it; empty at the start.

string
nextEpisode

The episode after it; empty at the end.

string
pageToken

A ListEpisodes page_token that starts the page containing it.

string
Example generated
{
  "position": 1,
  "totalSize": 1,
  "previousEpisode": "example",
  "nextEpisode": "example",
  "pageToken": "example"
}

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"
    }
  ]
}