Asset v1.0

Operations supporting organization,application assets, that are stored on the application (setup by the customer) storage.

info

You are viewing REST API documentation. This documentation is auto-generated from a swagger specification which itself is generated from annotations in the source code of the project. It is possible that this documentation includes bugs and that code samples are incomplete or wrong.

Authentication

• OAuth 2.0 Authorization. Authenticate using client credentials

  • Flow: clientCredentials

  • OAuth 2.0 Authorization URL = https://auvious.video/security/oauth/authorize

  • OAuth 2.0 Token URL = https://auvious.video/security/oauth/token

  • OAuth 2.0 Scope

    Scope	Scope Description
    any	this is the default

• HTTP Authentication, scheme: bearer jwt bearer token access

Assets

Asset Controller

Find assets by application id

GET https://auvious.video:443/rtc-api/assets?applicationId=string HTTP/1.1
Host: auvious.video:443
Accept: application/json

Parameters

Parameter	In	Type	Required	Description
applicationId	query	string	true	applicationId

Responses

Overview

Status	Meaning	Description	Schema
200	OK	OK	Iterable«AssetInfo»
401	Unauthorized	Unauthorized	None
403	Forbidden	Forbidden	None
404	Not Found	Not Found	None

Examples

200 Response

{}

caution

To perform this operation, you must be authenticated by means of one of the following methods: Client Credentials Flow ( Scopes: global ), Jwt ( Scopes: global ), None ( Scopes: global ), None ( Scopes: global ), None ( Scopes: global )

Code samples

Shell

curl -X GET https://auvious.video:443/rtc-api/assets?applicationId=string \
  -H 'Accept: application/json' \  -H 'Authorization: Bearer {access-token}'

Go

package main

import (
    "bytes"
    "net/http"
)

func main() {
    headers := map[string][]string{ 
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    var body []byte
    // body = ...

    req, err := http.NewRequest("GET", "https://auvious.video:443/rtc-api/assets", bytes.NewBuffer(body))
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Node

const fetch = require('node-fetch');

const headers = {
  'Accept': 'application/json',  'Authorization': 'Bearer {access-token}'
}

fetch('https://auvious.video:443/rtc-api/assets?applicationId=string', {
  method: 'GET',
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

Java

// This sample needs improvement.
URL obj = new URL("https://auvious.video:443/rtc-api/assets?applicationId=string");

HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");

int responseCode = con.getResponseCode();

BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream())
);

String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();

System.out.println(response.toString());

Python

import requests

headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get(
  'https://auvious.video:443/rtc-api/assets',
  params={
    'applicationId': 'string'},
  headers = headers)

print r.json()

Ruby

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://auvious.video:443/rtc-api/assets',
  params: {
    'applicationId' => 'string'}, headers: headers

p JSON.parse(result)

get a builtin signed url

GET https://auvious.video:443/rtc-api/assets/signed/{assetId}/{expiration}?signature=string HTTP/1.1
Host: auvious.video:443
Accept: */*

Parameters

Parameter	In	Type	Required	Description
assetId	path	string	true	assetId
expiration	path	integer(int64)	true	expiration
signature	query	string	true	signature

Responses

Overview

Status	Meaning	Description	Schema
200	OK	OK	Inline
401	Unauthorized	Unauthorized	None
403	Forbidden	Forbidden	None
404	Not Found	Not Found	None

Response Schema

Examples

200 Response

caution

To perform this operation, you must be authenticated by means of one of the following methods: Client Credentials Flow ( Scopes: global ), Jwt ( Scopes: global ), None ( Scopes: global ), None ( Scopes: global ), None ( Scopes: global )

Code samples

Shell

curl -X GET https://auvious.video:443/rtc-api/assets/signed/{assetId}/{expiration}?signature=string \
  -H 'Accept: */*' \  -H 'Authorization: Bearer {access-token}'

Go

package main

import (
    "bytes"
    "net/http"
)

func main() {
    headers := map[string][]string{ 
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    var body []byte
    // body = ...

    req, err := http.NewRequest("GET", "https://auvious.video:443/rtc-api/assets/signed/{assetId}/{expiration}", bytes.NewBuffer(body))
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Node

const fetch = require('node-fetch');

const headers = {
  'Accept': '*/*',  'Authorization': 'Bearer {access-token}'
}

fetch('https://auvious.video:443/rtc-api/assets/signed/{assetId}/{expiration}?signature=string', {
  method: 'GET',
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

Java

// This sample needs improvement.
URL obj = new URL("https://auvious.video:443/rtc-api/assets/signed/{assetId}/{expiration}?signature=string");

HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");

int responseCode = con.getResponseCode();

BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream())
);

String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();

System.out.println(response.toString());

Python

import requests

headers = {
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get(
  'https://auvious.video:443/rtc-api/assets/signed/{assetId}/{expiration}',
  params={
    'signature': 'string'},
  headers = headers)

print r.json()

Ruby

require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://auvious.video:443/rtc-api/assets/signed/{assetId}/{expiration}',
  params: {
    'signature' => 'string'}, headers: headers

p JSON.parse(result)

Upload an asset

POST https://auvious.video:443/rtc-api/assets/{assetId} HTTP/1.1
Host: auvious.video:443
Content-Type: multipart/form-data
X-Auvious-TransactionId: string

Request body

applicationId: string
category: string
file: string
filename: string
rolesAllowedAccess: string

Parameters

Parameter	In	Type	Required	Description
assetId	path	string	true	assetId
X-Auvious-TransactionId	header	string	false	used for detecting retries of the same request
body	body	object	false	none
» applicationId	body	string	true	applicationId
» category	body	string	true	category
» file	body	string(binary)	true	file
» filename	body	string	false	filename
» rolesAllowedAccess	body	string	true	comma separated list of roles allowed to access the asset, e.g.: admin,customer

Responses

Overview

Status	Meaning	Description	Schema
201	Created	Created	None
204	No Content	No Content	None
401	Unauthorized	Unauthorized	None
403	Forbidden	Forbidden	None
404	Not Found	Not Found	None

caution

To perform this operation, you must be authenticated by means of one of the following methods: Client Credentials Flow ( Scopes: global ), Jwt ( Scopes: global ), None ( Scopes: global ), None ( Scopes: global ), None ( Scopes: global )

Code samples

Shell

curl -X POST https://auvious.video:443/rtc-api/assets/{assetId} \
  -H 'Content-Type: multipart/form-data' \  -H 'X-Auvious-TransactionId: string' \  -H 'Authorization: Bearer {access-token}'

Go

package main

import (
    "bytes"
    "net/http"
)

func main() {
    headers := map[string][]string{ 
        "Content-Type": []string{"multipart/form-data"},
        "X-Auvious-TransactionId": []string{"string"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    var body []byte
    // body = ...

    req, err := http.NewRequest("POST", "https://auvious.video:443/rtc-api/assets/{assetId}", bytes.NewBuffer(body))
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Node

const fetch = require('node-fetch');
const input = '{
  "applicationId": "string",
  "category": "string",
  "file": "string",
  "filename": "string",
  "rolesAllowedAccess": "string"
}';
const headers = {
  'Content-Type': 'multipart/form-data',  'X-Auvious-TransactionId': 'string',  'Authorization': 'Bearer {access-token}'
}

fetch('https://auvious.video:443/rtc-api/assets/{assetId}', {
  method: 'POST',
  body: input,
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

Java

// This sample needs improvement.
URL obj = new URL("https://auvious.video:443/rtc-api/assets/{assetId}");

HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");

int responseCode = con.getResponseCode();

BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream())
);

String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();

System.out.println(response.toString());

Python

import requests

headers = {
  'Content-Type': 'multipart/form-data',
  'X-Auvious-TransactionId': 'string',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post(
  'https://auvious.video:443/rtc-api/assets/{assetId}',
  params={},
  headers = headers)

print r.json()

Ruby

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'multipart/form-data',
  'X-Auvious-TransactionId' => 'string',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://auvious.video:443/rtc-api/assets/{assetId}',
  params: {}, headers: headers

p JSON.parse(result)

Delete an asset

DELETE https://auvious.video:443/rtc-api/assets/{assetId} HTTP/1.1
Host: auvious.video:443
X-Auvious-TransactionId: string

Parameters

Parameter	In	Type	Required	Description
assetId	path	string	true	id of asset to delete
X-Auvious-TransactionId	header	string	false	Optional header used for detecting retries of the same request

Responses

Overview

Status	Meaning	Description	Schema
204	No Content	No Content	None
401	Unauthorized	Unauthorized	None
403	Forbidden	Forbidden	None

caution

To perform this operation, you must be authenticated by means of one of the following methods: Client Credentials Flow ( Scopes: global ), Jwt ( Scopes: global ), None ( Scopes: global ), None ( Scopes: global ), None ( Scopes: global )

Code samples

Shell

curl -X DELETE https://auvious.video:443/rtc-api/assets/{assetId} \
  -H 'X-Auvious-TransactionId: string' \  -H 'Authorization: Bearer {access-token}'

Go

package main

import (
    "bytes"
    "net/http"
)

func main() {
    headers := map[string][]string{ 
        "X-Auvious-TransactionId": []string{"string"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    var body []byte
    // body = ...

    req, err := http.NewRequest("DELETE", "https://auvious.video:443/rtc-api/assets/{assetId}", bytes.NewBuffer(body))
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Node

const fetch = require('node-fetch');

const headers = {
  'X-Auvious-TransactionId': 'string',  'Authorization': 'Bearer {access-token}'
}

fetch('https://auvious.video:443/rtc-api/assets/{assetId}', {
  method: 'DELETE',
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

Java

// This sample needs improvement.
URL obj = new URL("https://auvious.video:443/rtc-api/assets/{assetId}");

HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");

int responseCode = con.getResponseCode();

BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream())
);

String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();

System.out.println(response.toString());

Python

import requests

headers = {
  'X-Auvious-TransactionId': 'string',
  'Authorization': 'Bearer {access-token}'
}

r = requests.delete(
  'https://auvious.video:443/rtc-api/assets/{assetId}',
  params={},
  headers = headers)

print r.json()

Ruby

require 'rest-client'
require 'json'

headers = {
  'X-Auvious-TransactionId' => 'string',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.delete 'https://auvious.video:443/rtc-api/assets/{assetId}',
  params: {}, headers: headers

p JSON.parse(result)

create a signed url

POST https://auvious.video:443/rtc-api/assets/{assetId}/signedUrl HTTP/1.1
Host: auvious.video:443
Accept: application/json
X-Auvious-CreateInternalSignedUrl: true
Referer: string

Parameters

Parameter	In	Type	Required	Description
assetId	path	string	true	assetId
X-Auvious-CreateInternalSignedUrl	header	boolean	false	X-Auvious-CreateInternalSignedUrl
Referer	header	string	true	Referer

Responses

Overview

Status	Meaning	Description	Schema
200	OK	OK	SignedUrl
201	Created	Created	None
401	Unauthorized	Unauthorized	None
403	Forbidden	Forbidden	None
404	Not Found	Not Found	None

Examples

200 Response

{
  "url": "string",
  "validUntil": "2019-08-24T14:15:22Z"
}

caution

To perform this operation, you must be authenticated by means of one of the following methods: Client Credentials Flow ( Scopes: global ), Jwt ( Scopes: global ), None ( Scopes: global ), None ( Scopes: global ), None ( Scopes: global )

Code samples

Shell

curl -X POST https://auvious.video:443/rtc-api/assets/{assetId}/signedUrl \
  -H 'Accept: application/json' \  -H 'X-Auvious-CreateInternalSignedUrl: true' \  -H 'Referer: string' \  -H 'Authorization: Bearer {access-token}'

Go

package main

import (
    "bytes"
    "net/http"
)

func main() {
    headers := map[string][]string{ 
        "Accept": []string{"application/json"},
        "X-Auvious-CreateInternalSignedUrl": []string{"true"},
        "Referer": []string{"string"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    var body []byte
    // body = ...

    req, err := http.NewRequest("POST", "https://auvious.video:443/rtc-api/assets/{assetId}/signedUrl", bytes.NewBuffer(body))
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Node

const fetch = require('node-fetch');

const headers = {
  'Accept': 'application/json',  'X-Auvious-CreateInternalSignedUrl': 'true',  'Referer': 'string',  'Authorization': 'Bearer {access-token}'
}

fetch('https://auvious.video:443/rtc-api/assets/{assetId}/signedUrl', {
  method: 'POST',
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

Java

// This sample needs improvement.
URL obj = new URL("https://auvious.video:443/rtc-api/assets/{assetId}/signedUrl");

HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");

int responseCode = con.getResponseCode();

BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream())
);

String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();

System.out.println(response.toString());

Python

import requests

headers = {
  'Accept': 'application/json',
  'X-Auvious-CreateInternalSignedUrl': 'true',
  'Referer': 'string',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post(
  'https://auvious.video:443/rtc-api/assets/{assetId}/signedUrl',
  params={},
  headers = headers)

print r.json()

Ruby

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'X-Auvious-CreateInternalSignedUrl' => 'true',
  'Referer' => 'string',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://auvious.video:443/rtc-api/assets/{assetId}/signedUrl',
  params: {}, headers: headers

p JSON.parse(result)

Schemas

AssetInfo

{
  "assetId": "string",
  "category": "string",
  "filename": "string",
  "rolesAllowedAccess": [
    "ADMIN"
  ]
}

AssetInfo

Properties

Name	Type	Required	Restrictions	Description
assetId	string	false	none	none
category	string	false	none	none
filename	string	false	none	none
rolesAllowedAccess	[string]	false	none	none

Iterable«AssetInfo»

{}

Iterable«AssetInfo»

Properties

None

SignedUrl

{
  "url": "string",
  "validUntil": "2019-08-24T14:15:22Z"
}

SignedUrl

Properties

Name	Type	Required	Restrictions	Description
url	string(url)	false	none	none
validUntil	string(date-time)	false	none	none