3Play Media: Docs

Glossaries

Create, update and view glossaries for your videos at 3Play Media

Object Representation

Unless otherwise specified, all routes return the following data structure in the data key.

Name Type Description
id Integer Your glossary ID
resource_id Integer The resource ID that the glossary belongs to. For example, a Project, Batch, or MediaFile ID.
resource_type String The resource type that the glossary belongs to. Possible values are: Project, Batch, and MediaFile
word_list String The word list associated with this glossary.

Actions

  • List glossaries in your project

    GET https://api.3playmedia.com/v3/glossaries

    Parameter Type Description Required Default
    resource_type String Filter by resource types. Possible values: 'Project', 'Batch', 'MediaFile'. Yes Project
    resource_id String Filter by resource ID. No no default
  • Show your Glossary

    GET https://api.3playmedia.com/v3/glossaries/:id

  • Create a Glossary

    POST https://api.3playmedia.com/v3/glossaries

    Parameter Type Description Required Default
    resource_id Integer The resource ID that the glossary belongs to. For example, a Project, Batch, or MediaFile ID.
    resource_type String Select which resource type to connect your glossary to. Possible values: 'Project', 'Batch', 'MediaFile'. Yes Project
    word_list String A string of comma separated words for the glossary's content. Yes no default
  • Update an existing glossary

    PUT https://api.3playmedia.com/v3/glossaries/:id

    Parameter Type Description Required Default
    word_list String A string of comma separated words for the glossary's content. No no default