Skip to content

place.stream.vod.getDraft

Lexicon Version: 1

Type: query

Get a single draft VOD by its ats:// URI. Only accessible by the draft’s author.

Parameters:

NameTypeReq’dDescriptionConstraints
uristringThe ats:// URI of the draft record.

Output:

  • Encoding: application/json
  • Schema:

Schema Type: object

NameTypeReq’dDescriptionConstraints
draftplace.stream.vod.draftDefs#draftView

Possible Errors:

  • NotFound: No draft exists with the given URI for the authenticated user.

{
"lexicon": 1,
"id": "place.stream.vod.getDraft",
"defs": {
"main": {
"type": "query",
"description": "Get a single draft VOD by its ats:// URI. Only accessible by the draft's author.",
"parameters": {
"type": "params",
"required": ["uri"],
"properties": {
"uri": {
"type": "string",
"description": "The ats:// URI of the draft record."
}
}
},
"output": {
"encoding": "application/json",
"schema": {
"type": "object",
"required": ["draft"],
"properties": {
"draft": {
"type": "ref",
"ref": "place.stream.vod.draftDefs#draftView"
}
}
}
},
"errors": [
{
"name": "NotFound",
"description": "No draft exists with the given URI for the authenticated user."
}
]
}
}
}