PorticoDocs

Containers

Generated containers operations.

GET/v1/containers/{kind}/{id}/personal-stateRead a container watermark, revision, saved flags and visible-member countsread
Audience
Clients · Native API
Authorization
API key or personal access token with the read scope, or a signed-in session
OpenAPI operation ID
get_container_personal_state

Parameters

NameInTypeDescription
kindrequiredpathstring
idrequiredpathstring

Responses

200Successapplication/json

Example
{
  "favorite": true,
  "libraryId": "id_8h2k4q",
  "revision": 0,
  "unwatchedCount": 0,
  "watched": true,
  "watchedCount": 0,
  "watchlisted": true,
  "watermark": "string"
}
Schema
  • favoritebooleanrequired
  • libraryIdstringrequired
  • revisionintegerrequired
  • unwatchedCountintegerrequired
  • watchedbooleanrequired
  • watchedCountintegerrequired
  • watchlistedbooleanrequired
  • watermarkstringrequired

defaultRequest refused or unavailableapplication/json

Example
{
  "error": {
    "code": "string",
    "message": "string"
  }
}
Schema
  • errorobjectrequired
    • codestringrequired
    • messagestringrequired

Error codesinvalid_requestunauthorizednot_foundidempotency_key_reusedrevision_mismatchrate_limitedinternaltimeoutdatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/v1/containers/{kind}/{id}/personal-state" \
  -H "Authorization: Bearer $PORTICO_API_KEY"
PUT/v1/containers/{kind}/{id}/personal-stateSet a container watched watermark, or its Watchlist or Favorite flag, for this profileplayback
Audience
Clients · Native API
Authorization
API key or personal access token with the playback scope, or a signed-in session
OpenAPI operation ID
set_container_personal_state
Max body
2 KiB

Parameters

NameInTypeDescription
kindrequiredpathstring
idrequiredpathstring
Idempotency-Keyheaderstring
Portico-Mutation-Rootheaderstring

Request body application/json · required

Example
{
  "expectedRevision": 0,
  "favorite": true,
  "watched": true,
  "watchlisted": true
}
Schema
  • expectedRevisionintegerrequired
  • favoriteboolean
  • watchedboolean
  • watchlistedboolean

Responses

200Successapplication/json

Example
{
  "favorite": true,
  "revision": 0,
  "undoToken": "string",
  "undoUntil": "string",
  "watched": true,
  "watchlisted": true,
  "watermark": "string"
}
Schema
  • favoritebooleanrequired
  • revisionintegerrequired
  • undoTokenstring
  • undoUntilstring
  • watchedbooleanrequired
  • watchlistedbooleanrequired
  • watermarkstringrequired

defaultRequest refused or unavailableapplication/json

Example
{
  "error": {
    "code": "string",
    "message": "string"
  }
}
Schema
  • errorobjectrequired
    • codestringrequired
    • messagestringrequired

Error codesinvalid_requestunauthorizednot_foundidempotency_key_reusedrevision_mismatchrate_limitedinternaltimeoutrevision_requiredidempotency_conflictreceipt_expiredinvalid_mutation_keydatabase_busywriter_capacity

Example request

curl -X PUT "http://127.0.0.1:32500/v1/containers/{kind}/{id}/personal-state" \
  -H "Authorization: Bearer $PORTICO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"expectedRevision":0,"favorite":true,"watched":true,"watchlisted":true}'
POST/v1/containers/{kind}/{id}/personal-state/undoRestore watched and resume state before a recent container markplayback
Audience
Clients · Native API
Authorization
API key or personal access token with the playback scope, or a signed-in session
OpenAPI operation ID
undo_container_personal_state
Max body
2 KiB

Parameters

NameInTypeDescription
kindrequiredpathstring
idrequiredpathstring
Idempotency-Keyheaderstring
Portico-Mutation-Rootheaderstring

Request body application/json · required

Example
{
  "expectedRevision": 0,
  "undoToken": "string"
}
Schema
  • expectedRevisionintegerrequired
  • undoTokenstringrequired

Responses

200Successapplication/json

Example
{
  "favorite": true,
  "revision": 0,
  "undoToken": "string",
  "undoUntil": "string",
  "watched": true,
  "watchlisted": true,
  "watermark": "string"
}
Schema
  • favoritebooleanrequired
  • revisionintegerrequired
  • undoTokenstring
  • undoUntilstring
  • watchedbooleanrequired
  • watchlistedbooleanrequired
  • watermarkstringrequired

defaultRequest refused or unavailableapplication/json

Example
{
  "error": {
    "code": "string",
    "message": "string"
  }
}
Schema
  • errorobjectrequired
    • codestringrequired
    • messagestringrequired

Error codesinvalid_requestunauthorizednot_foundidempotency_key_reusedrevision_mismatchrate_limitedinternaloperation_expiredtimeoutidempotency_conflictreceipt_expiredinvalid_mutation_keydatabase_busywriter_capacity

Example request

curl -X POST "http://127.0.0.1:32500/v1/containers/{kind}/{id}/personal-state/undo" \
  -H "Authorization: Bearer $PORTICO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"expectedRevision":0,"undoToken":"string"}'