Skip to content

Latest commit

 

History

History
486 lines (309 loc) · 10.5 KB

WorkspaceApi.md

File metadata and controls

486 lines (309 loc) · 10.5 KB

algorithmhub.WorkspaceApi

All URIs are relative to http://localhost:10010/v2

Method HTTP request Description
cloneWorkspace POST /workspace/{wmid}/clone Clone the workspace
createWorkspace POST /workspace Creates new workspace
deleteWorkspace DELETE /workspace/{wmid} Delete an existing workspace
detailWorkspace GET /workspace/{wmid} Gets workspace metadata
listServices GET /workspace/{wmid}/model Get models associated
listServices_0 GET /workspace/{wmid}/service Get models associated
listWorkspaces GET /workspace Returns list of workspaces
publishWorkspace POST /workspace/{wmid}/publish Publish workspace to repo
shareWorkspace POST /workspace/{wmid}/share Share workspace with another user
turnOffWorkspace POST /workspace/{wmid}/off Turn off the workspace
turnOnWorkspace POST /workspace/{wmid}/on Turn on the workspace

cloneWorkspace

'String' cloneWorkspace(wmid)

Clone the workspace

Clone the given workspace

Example

var algorithmhub = require('algorithmhub');

var apiInstance = new algorithmhub.WorkspaceApi();

var wmid = "wmid_example"; // String | The workspace base type.

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

Parameters

Name Type Description Notes
wmid String The workspace base type.

Return type

'String'

Authorization

No authorization required

HTTP request headers

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

createWorkspace

'String' createWorkspace(body)

Creates new workspace

Creates a new workspace

Example

var algorithmhub = require('algorithmhub');

var apiInstance = new algorithmhub.WorkspaceApi();

var body = new algorithmhub.Body2(); // Body2 | The workspace type

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

Parameters

Name Type Description Notes
body Body2 The workspace type

Return type

'String'

Authorization

No authorization required

HTTP request headers

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

deleteWorkspace

'String' deleteWorkspace(wmid)

Delete an existing workspace

Delete an existing workspace

Example

var algorithmhub = require('algorithmhub');

var apiInstance = new algorithmhub.WorkspaceApi();

var wmid = "wmid_example"; // String | The workspace id

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

Parameters

Name Type Description Notes
wmid String The workspace id

Return type

'String'

Authorization

No authorization required

HTTP request headers

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

detailWorkspace

InlineResponse20010 detailWorkspace(wmid)

Gets workspace metadata

Gets workspace metadata

Example

var algorithmhub = require('algorithmhub');

var apiInstance = new algorithmhub.WorkspaceApi();

var wmid = "wmid_example"; // String | The workspace id

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

Parameters

Name Type Description Notes
wmid String The workspace id

Return type

InlineResponse20010

Authorization

No authorization required

HTTP request headers

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

listServices

[InlineResponse20011] listServices(wmid)

Get models associated

Get models associated with an exsisting workspace

Example

var algorithmhub = require('algorithmhub');

var apiInstance = new algorithmhub.WorkspaceApi();

var wmid = "wmid_example"; // String | The workspace base type.

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

Parameters

Name Type Description Notes
wmid String The workspace base type.

Return type

[InlineResponse20011]

Authorization

No authorization required

HTTP request headers

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

listServices_0

[InlineResponse20011] listServices_0(wmid)

Get models associated

Get models associated with an exsisting workspace

Example

var algorithmhub = require('algorithmhub');

var apiInstance = new algorithmhub.WorkspaceApi();

var wmid = "wmid_example"; // String | The workspace base type.

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

Parameters

Name Type Description Notes
wmid String The workspace base type.

Return type

[InlineResponse20011]

Authorization

No authorization required

HTTP request headers

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

listWorkspaces

[InlineResponse20010] listWorkspaces()

Returns list of workspaces

Returns a list of workspaces

Example

var algorithmhub = require('algorithmhub');

var apiInstance = new algorithmhub.WorkspaceApi();
apiInstance.listWorkspaces().then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

This endpoint does not need any parameter.

Return type

[InlineResponse20010]

Authorization

No authorization required

HTTP request headers

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

publishWorkspace

'String' publishWorkspace(wmid)

Publish workspace to repo

Publish current workspace to repo

Example

var algorithmhub = require('algorithmhub');

var apiInstance = new algorithmhub.WorkspaceApi();

var wmid = "wmid_example"; // String | The workspace base type.

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

Parameters

Name Type Description Notes
wmid String The workspace base type.

Return type

'String'

Authorization

No authorization required

HTTP request headers

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

shareWorkspace

'String' shareWorkspace(wmid)

Share workspace with another user

Share workspace with another user

Example

var algorithmhub = require('algorithmhub');

var apiInstance = new algorithmhub.WorkspaceApi();

var wmid = "wmid_example"; // String | The workspace base type.

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

Parameters

Name Type Description Notes
wmid String The workspace base type.

Return type

'String'

Authorization

No authorization required

HTTP request headers

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

turnOffWorkspace

'String' turnOffWorkspace(wmid)

Turn off the workspace

Turn off the workspace

Example

var algorithmhub = require('algorithmhub');

var apiInstance = new algorithmhub.WorkspaceApi();

var wmid = "wmid_example"; // String | The workspace base type.

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

Parameters

Name Type Description Notes
wmid String The workspace base type.

Return type

'String'

Authorization

No authorization required

HTTP request headers

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

turnOnWorkspace

'String' turnOnWorkspace(wmid)

Turn on the workspace

Turn on the workspace

Example

var algorithmhub = require('algorithmhub');

var apiInstance = new algorithmhub.WorkspaceApi();

var wmid = "wmid_example"; // String | The workspace base type.

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

Parameters

Name Type Description Notes
wmid String The workspace base type.

Return type

'String'

Authorization

No authorization required

HTTP request headers

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