Skip to content

Latest commit

 

History

History
198 lines (126 loc) · 5.44 KB

MediaSourcesApi.md

File metadata and controls

198 lines (126 loc) · 5.44 KB

KinowJavascriptSdk.MediaSourcesApi

All URIs are relative to https://api.kinow.com/api

Method HTTP request Description
getMediaSource GET /media-sources/{source_id}
getMediaSourceFiles GET /media-sources/{source_id}/files
getMediaSources GET /media-sources
postMediaSourceFiles POST /media-sources/{source_id}/files

getMediaSource

MediaSource getMediaSource(sourceId)

Get media source

Example

var KinowJavascriptSdk = require('kinow-javascript-sdk');

var apiInstance = new KinowJavascriptSdk.MediaSourcesApi();

var sourceId = 789; // Integer | Media source ID to fetch

apiInstance.getMediaSource(sourceId).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
sourceId Integer Media source ID to fetch

Return type

MediaSource

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

getMediaSourceFiles

MediaFiles getMediaSourceFiles(sourceId, opts)

Get media source files

Example

var KinowJavascriptSdk = require('kinow-javascript-sdk');

var apiInstance = new KinowJavascriptSdk.MediaSourcesApi();

var sourceId = 789; // Integer | Media source ID to fetch

var opts = { 
  'page': 789, // Integer | 
  'perPage': 789, // Integer | 
  'filters': "filters_example" // String |       ```      name[value]=string&name[operator]=contains&date_add[value]=string&date_add[operator]=lt      _______________        {      \"name\": {      \"value\": \"string\",      \"operator\": \"contains\"      },      \"date_add\": {      \"value\": \"string\",      \"operator\": \"lt\"      }      } ```Operator can be strict, contains, gt or lt.
};
apiInstance.getMediaSourceFiles(sourceId, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
sourceId Integer Media source ID to fetch
page Integer [optional]
perPage Integer [optional]
filters String ``` name[value]=string&name[operator]=contains&date_add[value]=string&date_add[operator]=lt _______________ { "name": { "value": "string", "operator": "contains" }, "date_add": { "value": "string", "operator": "lt" } } ```Operator can be strict, contains, gt or lt. [optional]

Return type

MediaFiles

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

getMediaSources

MediaSources getMediaSources(opts)

Get media source list

Example

var KinowJavascriptSdk = require('kinow-javascript-sdk');

var apiInstance = new KinowJavascriptSdk.MediaSourcesApi();

var opts = { 
  'page': 789, // Integer | 
  'perPage': 789 // Integer | 
};
apiInstance.getMediaSources(opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
page Integer [optional]
perPage Integer [optional]

Return type

MediaSources

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

postMediaSourceFiles

MediaFile postMediaSourceFiles(sourceId, body)

Post media file

Example

var KinowJavascriptSdk = require('kinow-javascript-sdk');

var apiInstance = new KinowJavascriptSdk.MediaSourcesApi();

var sourceId = 789; // Integer | Media source ID to fetch

var body = new KinowJavascriptSdk.MediaFile(); // MediaFile | Create MediaFile object

apiInstance.postMediaSourceFiles(sourceId, body).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
sourceId Integer Media source ID to fetch
body MediaFile Create MediaFile object

Return type

MediaFile

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined