Skip to content
Qualia Docs

Episodes_LocateEpisode

GET
/v1/accounts/{account}/datasets/{dataset}/episodes/{episode}:locate
 
curl --request GET \
  --url https://junction-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. 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, 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
One of:
API error

A refusal from the API itself.

object
code
required

The gRPC code name in upper case, e.g. NOT_FOUND.

string
message
required
string
retryable
required

Whether the same call may succeed if retried.

boolean
details
required

Empty, except when a dataset copy or move is refused: then one google.rpc.ErrorInfo with the refusal’s reason code, its domain and, in metadata, the datasets it names.

Array<object>
object
Example generated
{
  "code": "example",
  "message": "example",
  "retryable": true,
  "details": [
    {}
  ]
}