Skip to content
Qualia Docs

Episodes_AcquireEpisodeLease

POST
/v1/accounts/{account}/datasets/{dataset}/episodes/{episode}:acquireEpisodeLease
 
curl --request POST \
  --url https://dev-api.qualiastudios.dev/v1/accounts/example/datasets/example/episodes/example:acquireEpisodeLease \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <X-API-Key>' \
  --data '{ "episode": "example", "tab": "example" }'

Takes the take’s edit lease for the caller and this tab (QUA-3467). A lease is per take: it holds through every dataset that reads it. One lease per person: when the caller already holds it, the tab joins it and it is renewed. It lapses 30 s after the last renewal. FAILED_PRECONDITION, “episode is being edited by until

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.

Request Body required

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

Request for Episodes.AcquireEpisodeLease.

object
episode
required

Accounts/{account}/datasets/{dataset}/episodes/{episode}: the take, in any dataset that reads it.

string
tab
required

The caller’s tab: a uuid the client makes on load.

string
Example generated
{
  "episode": "example",
  "tab": "example"
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

OK

Media type application/json

Response for Episodes.AcquireEpisodeLease.

object
lease

The caller’s lease.

object
holder

The holder’s user id (as Actor.user).

string
holderName

The holder’s display name at the time they took it; empty when they have none. (— api-linter: core::0122::name-suffix=disabled aip.dev/not-precedent: a person’s display name, not a resource name; events-api’s lease frames call it this. —)

string
expireTime

When it lapses unless renewed.

string format: date-time
Example generated
{
  "lease": {}
}

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