Skip to content
This repository has been archived by the owner on Jul 24, 2023. It is now read-only.

Latest commit

 

History

History
1103 lines (733 loc) · 32.9 KB

PrivateAPI.md

File metadata and controls

1103 lines (733 loc) · 32.9 KB

PrivateAPI

All URIs are relative to https://elements.local

Method HTTP request Description
callGet GET /api/2/private/bootstrap
deleteStoredImage DELETE /api/2/image/{name}
deleteVeritoneTDO DELETE /api/2/veritone/connections/{id}/tdo/{tdo_id}
exportNonProxiedAssets GET /api/2/private/export/non-proxied/{root_id}
exportNonProxiedAssetsForPath GET /api/2/private/export/non-proxied/{root_id}/{path}
exportUpdates GET /api/2/private/export/updates/{root_id}
getAllVeritoneConnections GET /api/2/veritone/connections
getAllVeritoneMetadata GET /api/2/veritone/metadata
getClientSideURL POST /api/2/private/client-side-url
getHelpPage GET /api/2/help/{id}
getLocale GET /api/2/private/locale/{lang}
getProxyFSSize GET /api/2/private/media/proxyfs-size
getStoredImage GET /api/2/image/{name}
getVeritoneConnection GET /api/2/veritone/connections/{id}
getVeritoneEngines GET /api/2/veritone/connections/{id}/engines
getVeritoneJobs GET /api/2/veritone/connections/{id}/jobs
getVeritoneMetadata GET /api/2/veritone/metadata/{id}
installLicense POST /api/2/license/install
languageServerRequest POST /api/2/language-server/{language}
locateFile POST /api/2/private/locate
locateProxies POST /api/2/panel/locate-proxies
uploadStoredImage POST /api/2/private/images/upload
uploadToVeritone POST /api/2/veritone/connections/{id}/upload

callGet

    open class func callGet() -> Promise<BootstrapData>

Required permissions * <class 'rest_framework.permissions.AllowAny'>

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK


PrivateAPI.callGet().then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

This endpoint does not need any parameter.

Return type

BootstrapData

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deleteStoredImage

    open class func deleteStoredImage( name: String) -> Promise<Void>

Required permissions * <class 'rest_framework.permissions.AllowAny'>

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let name = "name_example" // String | 

PrivateAPI.deleteStoredImage(name: name).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
name String

Return type

Void (empty response body)

Authorization

Bearer

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deleteVeritoneTDO

    open class func deleteVeritoneTDO( id: Int,  tdoId: String) -> Promise<Void>

Required permissions * User account permission: media:access

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this Veritone connection.
let tdoId = "tdoId_example" // String | 

PrivateAPI.deleteVeritoneTDO(id: id, tdoId: tdoId).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id Int A unique integer value identifying this Veritone connection.
tdoId String

Return type

Void (empty response body)

Authorization

Bearer

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

exportNonProxiedAssets

    open class func exportNonProxiedAssets( rootId: String) -> Promise<Void>

Required permissions * User account permission: media:access

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let rootId = "rootId_example" // String | 

PrivateAPI.exportNonProxiedAssets(rootId: rootId).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
rootId String

Return type

Void (empty response body)

Authorization

Bearer

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

exportNonProxiedAssetsForPath

    open class func exportNonProxiedAssetsForPath( path: String,  rootId: String) -> Promise<Void>

Required permissions * User account permission: media:access

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let path = "path_example" // String | 
let rootId = "rootId_example" // String | 

PrivateAPI.exportNonProxiedAssetsForPath(path: path, rootId: rootId).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
path String
rootId String

Return type

Void (empty response body)

Authorization

Bearer

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

exportUpdates

    open class func exportUpdates( rootId: String) -> Promise<Void>

Required permissions * User account permission: media:access

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let rootId = "rootId_example" // String | 

PrivateAPI.exportUpdates(rootId: rootId).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
rootId String

Return type

Void (empty response body)

Authorization

Bearer

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getAllVeritoneConnections

    open class func getAllVeritoneConnections( ordering: String? = nil,  limit: Int? = nil,  offset: Int? = nil) -> Promise<[VeritoneConnection]>

Required permissions * User account permission: media:access

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let ordering = "ordering_example" // String | Which field to use when ordering the results. (optional)
let limit = 987 // Int | Number of results to return per page. (optional)
let offset = 987 // Int | The initial index from which to return the results. (optional)

PrivateAPI.getAllVeritoneConnections(ordering: ordering, limit: limit, offset: offset).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
ordering String Which field to use when ordering the results. [optional]
limit Int Number of results to return per page. [optional]
offset Int The initial index from which to return the results. [optional]

Return type

[VeritoneConnection]

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getAllVeritoneMetadata

    open class func getAllVeritoneMetadata( asset: Double? = nil,  isParsed: String? = nil,  ordering: String? = nil,  limit: Int? = nil,  offset: Int? = nil) -> Promise<[VeritoneMetadata]>

Required permissions * User account permission: media:access

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let asset = 987 // Double | Filter the returned list by `asset`. (optional)
let isParsed = "isParsed_example" // String | Filter the returned list by `is_parsed`. (optional)
let ordering = "ordering_example" // String | Which field to use when ordering the results. (optional)
let limit = 987 // Int | Number of results to return per page. (optional)
let offset = 987 // Int | The initial index from which to return the results. (optional)

PrivateAPI.getAllVeritoneMetadata(asset: asset, isParsed: isParsed, ordering: ordering, limit: limit, offset: offset).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
asset Double Filter the returned list by `asset`. [optional]
isParsed String Filter the returned list by `is_parsed`. [optional]
ordering String Which field to use when ordering the results. [optional]
limit Int Number of results to return per page. [optional]
offset Int The initial index from which to return the results. [optional]

Return type

[VeritoneMetadata]

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getClientSideURL

    open class func getClientSideURL( clientSidePathEndpointRequest: ClientSidePathEndpointRequest) -> Promise<ClientSidePathEndpointResponse>

Required permissions * User account permission: client:access

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let clientSidePathEndpointRequest = ClientSidePathEndpointRequest(serverSidePath: "serverSidePath_example", platform: "platform_example") // ClientSidePathEndpointRequest | 

PrivateAPI.getClientSideURL(clientSidePathEndpointRequest: clientSidePathEndpointRequest).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
clientSidePathEndpointRequest ClientSidePathEndpointRequest

Return type

ClientSidePathEndpointResponse

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getHelpPage

    open class func getHelpPage( id: String) -> Promise<HelpEndpointResponse>

Required permissions * Authenticated user

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = "id_example" // String | 

PrivateAPI.getHelpPage(id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id String

Return type

HelpEndpointResponse

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getLocale

    open class func getLocale( lang: String) -> Promise<LocaleEndpointResponse>

Required permissions * <class 'rest_framework.permissions.AllowAny'>

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let lang = "lang_example" // String | 

PrivateAPI.getLocale(lang: lang).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
lang String

Return type

LocaleEndpointResponse

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getProxyFSSize

    open class func getProxyFSSize() -> Promise<ProxyFSSizeEndpointResponse>

Required permissions * User account permission: media:access

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK


PrivateAPI.getProxyFSSize().then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

This endpoint does not need any parameter.

Return type

ProxyFSSizeEndpointResponse

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getStoredImage

    open class func getStoredImage( name: String) -> Promise<Void>

Required permissions * <class 'rest_framework.permissions.AllowAny'>

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let name = "name_example" // String | 

PrivateAPI.getStoredImage(name: name).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
name String

Return type

Void (empty response body)

Authorization

Bearer

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getVeritoneConnection

    open class func getVeritoneConnection( id: Int) -> Promise<VeritoneConnection>

Required permissions * User account permission: media:access

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this Veritone connection.

PrivateAPI.getVeritoneConnection(id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id Int A unique integer value identifying this Veritone connection.

Return type

VeritoneConnection

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getVeritoneEngines

    open class func getVeritoneEngines( id: Int) -> Promise<VeritoneEngineList>

Required permissions * User account permission: media:access

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this Veritone connection.

PrivateAPI.getVeritoneEngines(id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id Int A unique integer value identifying this Veritone connection.

Return type

VeritoneEngineList

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getVeritoneJobs

    open class func getVeritoneJobs( id: Int,  offset: Int? = nil,  limit: Int? = nil) -> Promise<VeritoneJobList>

Required permissions * User account permission: media:access

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this Veritone connection.
let offset = 987 // Int |  (optional)
let limit = 987 // Int |  (optional)

PrivateAPI.getVeritoneJobs(id: id, offset: offset, limit: limit).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id Int A unique integer value identifying this Veritone connection.
offset Int [optional]
limit Int [optional]

Return type

VeritoneJobList

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getVeritoneMetadata

    open class func getVeritoneMetadata( id: Int) -> Promise<VeritoneMetadata>

Required permissions * User account permission: media:access

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this Veritone metadata.

PrivateAPI.getVeritoneMetadata(id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id Int A unique integer value identifying this Veritone metadata.

Return type

VeritoneMetadata

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

installLicense

    open class func installLicense( installLicenseEndpointRequest: InstallLicenseEndpointRequest) -> Promise<Void>

Required permissions * User account permission: system:admin-access

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let installLicenseEndpointRequest = InstallLicenseEndpointRequest(license: "license_example", signature: "signature_example") // InstallLicenseEndpointRequest | 

PrivateAPI.installLicense(installLicenseEndpointRequest: installLicenseEndpointRequest).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
installLicenseEndpointRequest InstallLicenseEndpointRequest

Return type

Void (empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

languageServerRequest

    open class func languageServerRequest( language: String) -> Promise<[String: AnyCodable]>

Required permissions * User account permission: system:admin-access

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let language = "language_example" // String | 

PrivateAPI.languageServerRequest(language: language).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
language String

Return type

[String: AnyCodable]

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

locateFile

    open class func locateFile( locateEndpointRequest: LocateEndpointRequest) -> Promise<LocateResult>

Required permissions * Authenticated user

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let locateEndpointRequest = LocateEndpointRequest(path: "path_example", asset: 123) // LocateEndpointRequest | 

PrivateAPI.locateFile(locateEndpointRequest: locateEndpointRequest).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
locateEndpointRequest LocateEndpointRequest

Return type

LocateResult

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

locateProxies

    open class func locateProxies( locateProxiesEndpointRequest: LocateProxiesEndpointRequest) -> Promise<[LocateProxiesEndpointResponse]>

Required permissions * User account permission: media:access

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let locateProxiesEndpointRequest = LocateProxiesEndpointRequest(paths: ["paths_example"]) // LocateProxiesEndpointRequest | 

PrivateAPI.locateProxies(locateProxiesEndpointRequest: locateProxiesEndpointRequest).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
locateProxiesEndpointRequest LocateProxiesEndpointRequest

Return type

[LocateProxiesEndpointResponse]

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

uploadStoredImage

    open class func uploadStoredImage( uploadImageEndpointRequest: UploadImageEndpointRequest) -> Promise<Void>

Required permissions * <class 'rest_framework.permissions.AllowAny'>

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let uploadImageEndpointRequest = UploadImageEndpointRequest(name: "name_example", data: "data_example") // UploadImageEndpointRequest | 

PrivateAPI.uploadStoredImage(uploadImageEndpointRequest: uploadImageEndpointRequest).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
uploadImageEndpointRequest UploadImageEndpointRequest

Return type

Void (empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

uploadToVeritone

    open class func uploadToVeritone( id: Int,  veritoneUploadRequest: VeritoneUploadRequest) -> Promise<Void>

Required permissions * User account permission: media:access

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this Veritone connection.
let veritoneUploadRequest = VeritoneUploadRequest(root: 123, file: 123, bundle: 123) // VeritoneUploadRequest | 

PrivateAPI.uploadToVeritone(id: id, veritoneUploadRequest: veritoneUploadRequest).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id Int A unique integer value identifying this Veritone connection.
veritoneUploadRequest VeritoneUploadRequest

Return type

Void (empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]