| Open api | ||||||||
|---|---|---|---|---|---|---|---|---|
|
format: swagger
version: '2.0'
converter:
url: 'https://github.com/mermade/swagger2openapi'
version: 2.11.16
info:
description: >
This API provides information about playback streams which belong to a
Channel (one Channel has many Stream).
Please refer to
https://confluence.aminocom.com/display/BPLAT/Ubiquitous+Domain+Language#UbiquitousDomainLanguage-Stream
for the domain understanding of what a Stream is.
version: 1.0.0
title: Streams API
externalDocs:
description: Requirements documentation
url: >-
https://confluence.aminocom.com/display/BPLAT/C+More+subscription+for+Clients
tags:
- name: Stream
description: |
This API focuses on one relationship of the Channel Entity.
paths:
'/channels/{channel_id}/relationships/streams':
get:
tags:
- Stream
summary: Returns a collection of Stream entities
description: Available since March 2018 (BPLAT-4755)
operationId: getChannelStreams
parameters:
- in: path
name: channel_id
description: The id of the channel that you want to retrieve playback streams for
required: true
schema:
type: string
- in: query
name: restart_at_beginning
description: >-
The client can set this to true to indicate that it wants to start
playing at the beginning of the Program. The default value for this
parameter is `false`
required: false
schema:
type: boolean
responses:
'200':
description: A collection of Stream entities
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
type: object
required:
- id
- type
- attributes
properties:
id:
type: integer
example: 123
type:
type: string
example: Stream
attributes:
type: array
items: {}
'404':
description: Not found
content:
application/json:
schema:
type: object
properties:
errors: false
x-s2o-consumes: []
x-s2o-produces:
- application/json
servers:
- url: 'https://demo.aminocom.com/api/v1/media/'
x-s2o-consumes: []
x-s2o-produces: []
||||||||
Page Comparison
General
Content
Integrations