Cloudera Documentation

mlapiv2/api.proto

CMLService

addProjectCollaborator

Add a project collaborator


/api/v2/projects/{project_id}/collaborators/{username}

Usage and SDK Samples

curl -X PUT\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//api/v2/projects/{project_id}/collaborators/{username}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        AddProjectCollaboratorRequest body = ; // AddProjectCollaboratorRequest | 
        String projectId = projectId_example; // String | The identifier of the project.
        String username = username_example; // String | The username of the collaborator to add.
        try {
            AddProjectCollaboratorResponse result = apiInstance.addProjectCollaborator(body, projectId, username);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#addProjectCollaborator");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        AddProjectCollaboratorRequest body = ; // AddProjectCollaboratorRequest | 
        String projectId = projectId_example; // String | The identifier of the project.
        String username = username_example; // String | The username of the collaborator to add.
        try {
            AddProjectCollaboratorResponse result = apiInstance.addProjectCollaborator(body, projectId, username);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#addProjectCollaborator");
            e.printStackTrace();
        }
    }
}
AddProjectCollaboratorRequest *body = ; // 
String *projectId = projectId_example; // The identifier of the project.
String *username = username_example; // The username of the collaborator to add.

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Add a project collaborator
[apiInstance addProjectCollaboratorWith:body
    projectId:projectId
    username:username
              completionHandler: ^(AddProjectCollaboratorResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var body = ; // {{AddProjectCollaboratorRequest}} 
var projectId = projectId_example; // {{String}} The identifier of the project.
var username = username_example; // {{String}} The username of the collaborator to add.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addProjectCollaborator(bodyprojectIdusername, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class addProjectCollaboratorExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var body = new AddProjectCollaboratorRequest(); // AddProjectCollaboratorRequest | 
            var projectId = projectId_example;  // String | The identifier of the project.
            var username = username_example;  // String | The username of the collaborator to add.

            try
            {
                // Add a project collaborator
                AddProjectCollaboratorResponse result = apiInstance.addProjectCollaborator(body, projectId, username);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.addProjectCollaborator: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$body = ; // AddProjectCollaboratorRequest | 
$projectId = projectId_example; // String | The identifier of the project.
$username = username_example; // String | The username of the collaborator to add.

try {
    $result = $api_instance->addProjectCollaborator($body, $projectId, $username);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->addProjectCollaborator: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $body = WWW::SwaggerClient::Object::AddProjectCollaboratorRequest->new(); # AddProjectCollaboratorRequest | 
my $projectId = projectId_example; # String | The identifier of the project.
my $username = username_example; # String | The username of the collaborator to add.

eval { 
    my $result = $api_instance->addProjectCollaborator(body => $body, projectId => $projectId, username => $username);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->addProjectCollaborator: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
body =  # AddProjectCollaboratorRequest | 
projectId = projectId_example # String | The identifier of the project.
username = username_example # String | The username of the collaborator to add.

try: 
    # Add a project collaborator
    api_response = api_instance.add_project_collaborator(body, projectId, username)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->addProjectCollaborator: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
The identifier of the project.
Required
username*
String
The username of the collaborator to add.
Required
Body parameters
Name Description
body *

Responses

Status: 200 - A successful response.

Status: default - An unexpected error response


batchListProjects

Return a list of projects given a list of project IDs. This method will only return projects that the calling user has access to, and can be used in situations where information about a subset of projects (like project names) is needed.


/api/v2/projects/batch

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/projects/batch?project_ids="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        array[String] projectIds = ; // array[String] | The list of project IDs to return projects for.
        try {
            BatchListProjectsResponse result = apiInstance.batchListProjects(projectIds);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#batchListProjects");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        array[String] projectIds = ; // array[String] | The list of project IDs to return projects for.
        try {
            BatchListProjectsResponse result = apiInstance.batchListProjects(projectIds);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#batchListProjects");
            e.printStackTrace();
        }
    }
}
array[String] *projectIds = ; // The list of project IDs to return projects for. (optional)

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Return a list of projects given a list of project IDs. This method will only return
projects that the calling user has access to, and can be used in situations where
information about a subset of projects (like project names) is needed.
[apiInstance batchListProjectsWith:projectIds
              completionHandler: ^(BatchListProjectsResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var opts = { 
  'projectIds':  // {{array[String]}} The list of project IDs to return projects for.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.batchListProjects(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class batchListProjectsExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var projectIds = new array[String](); // array[String] | The list of project IDs to return projects for. (optional) 

            try
            {
                // Return a list of projects given a list of project IDs. This method will only return
projects that the calling user has access to, and can be used in situations where
information about a subset of projects (like project names) is needed.
                BatchListProjectsResponse result = apiInstance.batchListProjects(projectIds);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.batchListProjects: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$projectIds = ; // array[String] | The list of project IDs to return projects for.

try {
    $result = $api_instance->batchListProjects($projectIds);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->batchListProjects: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $projectIds = []; # array[String] | The list of project IDs to return projects for.

eval { 
    my $result = $api_instance->batchListProjects(projectIds => $projectIds);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->batchListProjects: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
projectIds =  # array[String] | The list of project IDs to return projects for. (optional)

try: 
    # Return a list of projects given a list of project IDs. This method will only return
projects that the calling user has access to, and can be used in situations where
information about a subset of projects (like project names) is needed.
    api_response = api_instance.batch_list_projects(projectIds=projectIds)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->batchListProjects: %s\n" % e)

Parameters

Query parameters
Name Description
project_ids
array[String]
The list of project IDs to return projects for.

Responses

Status: 200 - A successful response.

Status: default - An unexpected error response


createApplication

Create an application and implicitly start it immediately.


/api/v2/projects/{project_id}/applications

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//api/v2/projects/{project_id}/applications"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        CreateApplicationRequest body = ; // CreateApplicationRequest | 
        String projectId = projectId_example; // String | The project's identifier
        try {
            Application result = apiInstance.createApplication(body, projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#createApplication");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        CreateApplicationRequest body = ; // CreateApplicationRequest | 
        String projectId = projectId_example; // String | The project's identifier
        try {
            Application result = apiInstance.createApplication(body, projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#createApplication");
            e.printStackTrace();
        }
    }
}
CreateApplicationRequest *body = ; // 
String *projectId = projectId_example; // The project's identifier

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Create an application and implicitly start it immediately.
[apiInstance createApplicationWith:body
    projectId:projectId
              completionHandler: ^(Application output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var body = ; // {{CreateApplicationRequest}} 
var projectId = projectId_example; // {{String}} The project's identifier

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createApplication(bodyprojectId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createApplicationExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var body = new CreateApplicationRequest(); // CreateApplicationRequest | 
            var projectId = projectId_example;  // String | The project's identifier

            try
            {
                // Create an application and implicitly start it immediately.
                Application result = apiInstance.createApplication(body, projectId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.createApplication: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$body = ; // CreateApplicationRequest | 
$projectId = projectId_example; // String | The project's identifier

try {
    $result = $api_instance->createApplication($body, $projectId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->createApplication: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $body = WWW::SwaggerClient::Object::CreateApplicationRequest->new(); # CreateApplicationRequest | 
my $projectId = projectId_example; # String | The project's identifier

eval { 
    my $result = $api_instance->createApplication(body => $body, projectId => $projectId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->createApplication: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
body =  # CreateApplicationRequest | 
projectId = projectId_example # String | The project's identifier

try: 
    # Create an application and implicitly start it immediately.
    api_response = api_instance.create_application(body, projectId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->createApplication: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
The project's identifier
Required
Body parameters
Name Description
body *

Responses

Status: 200 - A successful response.

Status: default - An unexpected error response


createExperiment

Create an experiment.


/api/v2/projects/{project_id}/experiments

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//api/v2/projects/{project_id}/experiments"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        CreateExperimentRequest body = ; // CreateExperimentRequest | 
        String projectId = projectId_example; // String | 
        try {
            Experiment result = apiInstance.createExperiment(body, projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#createExperiment");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        CreateExperimentRequest body = ; // CreateExperimentRequest | 
        String projectId = projectId_example; // String | 
        try {
            Experiment result = apiInstance.createExperiment(body, projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#createExperiment");
            e.printStackTrace();
        }
    }
}
CreateExperimentRequest *body = ; // 
String *projectId = projectId_example; // 

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Create an experiment.
[apiInstance createExperimentWith:body
    projectId:projectId
              completionHandler: ^(Experiment output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var body = ; // {{CreateExperimentRequest}} 
var projectId = projectId_example; // {{String}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createExperiment(bodyprojectId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createExperimentExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var body = new CreateExperimentRequest(); // CreateExperimentRequest | 
            var projectId = projectId_example;  // String | 

            try
            {
                // Create an experiment.
                Experiment result = apiInstance.createExperiment(body, projectId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.createExperiment: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$body = ; // CreateExperimentRequest | 
$projectId = projectId_example; // String | 

try {
    $result = $api_instance->createExperiment($body, $projectId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->createExperiment: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $body = WWW::SwaggerClient::Object::CreateExperimentRequest->new(); # CreateExperimentRequest | 
my $projectId = projectId_example; # String | 

eval { 
    my $result = $api_instance->createExperiment(body => $body, projectId => $projectId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->createExperiment: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
body =  # CreateExperimentRequest | 
projectId = projectId_example # String | 

try: 
    # Create an experiment.
    api_response = api_instance.create_experiment(body, projectId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->createExperiment: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
Required
Body parameters
Name Description
body *

Responses

Status: 200 - A successful response.

Status: default - An unexpected error response


createExperimentRun

Create a run for an experiment.


/api/v2/projects/{project_id}/experiments/{experiment_id}/runs

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//api/v2/projects/{project_id}/experiments/{experiment_id}/runs"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        CreateExperimentRunRequest body = ; // CreateExperimentRunRequest | 
        String projectId = projectId_example; // String | 
        String experimentId = experimentId_example; // String | ID of the associated experiment.
        try {
            ExperimentRun result = apiInstance.createExperimentRun(body, projectId, experimentId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#createExperimentRun");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        CreateExperimentRunRequest body = ; // CreateExperimentRunRequest | 
        String projectId = projectId_example; // String | 
        String experimentId = experimentId_example; // String | ID of the associated experiment.
        try {
            ExperimentRun result = apiInstance.createExperimentRun(body, projectId, experimentId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#createExperimentRun");
            e.printStackTrace();
        }
    }
}
CreateExperimentRunRequest *body = ; // 
String *projectId = projectId_example; // 
String *experimentId = experimentId_example; // ID of the associated experiment.

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Create a run for an experiment.
[apiInstance createExperimentRunWith:body
    projectId:projectId
    experimentId:experimentId
              completionHandler: ^(ExperimentRun output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var body = ; // {{CreateExperimentRunRequest}} 
var projectId = projectId_example; // {{String}} 
var experimentId = experimentId_example; // {{String}} ID of the associated experiment.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createExperimentRun(bodyprojectIdexperimentId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createExperimentRunExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var body = new CreateExperimentRunRequest(); // CreateExperimentRunRequest | 
            var projectId = projectId_example;  // String | 
            var experimentId = experimentId_example;  // String | ID of the associated experiment.

            try
            {
                // Create a run for an experiment.
                ExperimentRun result = apiInstance.createExperimentRun(body, projectId, experimentId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.createExperimentRun: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$body = ; // CreateExperimentRunRequest | 
$projectId = projectId_example; // String | 
$experimentId = experimentId_example; // String | ID of the associated experiment.

try {
    $result = $api_instance->createExperimentRun($body, $projectId, $experimentId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->createExperimentRun: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $body = WWW::SwaggerClient::Object::CreateExperimentRunRequest->new(); # CreateExperimentRunRequest | 
my $projectId = projectId_example; # String | 
my $experimentId = experimentId_example; # String | ID of the associated experiment.

eval { 
    my $result = $api_instance->createExperimentRun(body => $body, projectId => $projectId, experimentId => $experimentId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->createExperimentRun: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
body =  # CreateExperimentRunRequest | 
projectId = projectId_example # String | 
experimentId = experimentId_example # String | ID of the associated experiment.

try: 
    # Create a run for an experiment.
    api_response = api_instance.create_experiment_run(body, projectId, experimentId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->createExperimentRun: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
Required
experiment_id*
String
ID of the associated experiment.
Required
Body parameters
Name Description
body *

Responses

Status: 200 - A successful response.

Status: default - An unexpected error response


createJob

Create a new job.


/api/v2/projects/{project_id}/jobs

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//api/v2/projects/{project_id}/jobs"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        CreateJobRequest body = ; // CreateJobRequest | 
        String projectId = projectId_example; // String | ID of the project containing the job.
        try {
            Job result = apiInstance.createJob(body, projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#createJob");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        CreateJobRequest body = ; // CreateJobRequest | 
        String projectId = projectId_example; // String | ID of the project containing the job.
        try {
            Job result = apiInstance.createJob(body, projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#createJob");
            e.printStackTrace();
        }
    }
}
CreateJobRequest *body = ; // 
String *projectId = projectId_example; // ID of the project containing the job.

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Create a new job.
[apiInstance createJobWith:body
    projectId:projectId
              completionHandler: ^(Job output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var body = ; // {{CreateJobRequest}} 
var projectId = projectId_example; // {{String}} ID of the project containing the job.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createJob(bodyprojectId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createJobExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var body = new CreateJobRequest(); // CreateJobRequest | 
            var projectId = projectId_example;  // String | ID of the project containing the job.

            try
            {
                // Create a new job.
                Job result = apiInstance.createJob(body, projectId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.createJob: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$body = ; // CreateJobRequest | 
$projectId = projectId_example; // String | ID of the project containing the job.

try {
    $result = $api_instance->createJob($body, $projectId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->createJob: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $body = WWW::SwaggerClient::Object::CreateJobRequest->new(); # CreateJobRequest | 
my $projectId = projectId_example; # String | ID of the project containing the job.

eval { 
    my $result = $api_instance->createJob(body => $body, projectId => $projectId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->createJob: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
body =  # CreateJobRequest | 
projectId = projectId_example # String | ID of the project containing the job.

try: 
    # Create a new job.
    api_response = api_instance.create_job(body, projectId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->createJob: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
ID of the project containing the job.
Required
Body parameters
Name Description
body *

Responses

Status: 200 - A successful response.

Status: default - An unexpected error response


createJobRun

Create and start a new job run for a job.


/api/v2/projects/{project_id}/jobs/{job_id}/runs

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//api/v2/projects/{project_id}/jobs/{job_id}/runs"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        CreateJobRunRequest body = ; // CreateJobRunRequest | 
        String projectId = projectId_example; // String | ID of the project containing the job.
        String jobId = jobId_example; // String | The job ID to create a new job run for.
        try {
            JobRun result = apiInstance.createJobRun(body, projectId, jobId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#createJobRun");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        CreateJobRunRequest body = ; // CreateJobRunRequest | 
        String projectId = projectId_example; // String | ID of the project containing the job.
        String jobId = jobId_example; // String | The job ID to create a new job run for.
        try {
            JobRun result = apiInstance.createJobRun(body, projectId, jobId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#createJobRun");
            e.printStackTrace();
        }
    }
}
CreateJobRunRequest *body = ; // 
String *projectId = projectId_example; // ID of the project containing the job.
String *jobId = jobId_example; // The job ID to create a new job run for.

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Create and start a new job run for a job.
[apiInstance createJobRunWith:body
    projectId:projectId
    jobId:jobId
              completionHandler: ^(JobRun output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var body = ; // {{CreateJobRunRequest}} 
var projectId = projectId_example; // {{String}} ID of the project containing the job.
var jobId = jobId_example; // {{String}} The job ID to create a new job run for.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createJobRun(bodyprojectIdjobId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createJobRunExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var body = new CreateJobRunRequest(); // CreateJobRunRequest | 
            var projectId = projectId_example;  // String | ID of the project containing the job.
            var jobId = jobId_example;  // String | The job ID to create a new job run for.

            try
            {
                // Create and start a new job run for a job.
                JobRun result = apiInstance.createJobRun(body, projectId, jobId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.createJobRun: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$body = ; // CreateJobRunRequest | 
$projectId = projectId_example; // String | ID of the project containing the job.
$jobId = jobId_example; // String | The job ID to create a new job run for.

try {
    $result = $api_instance->createJobRun($body, $projectId, $jobId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->createJobRun: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $body = WWW::SwaggerClient::Object::CreateJobRunRequest->new(); # CreateJobRunRequest | 
my $projectId = projectId_example; # String | ID of the project containing the job.
my $jobId = jobId_example; # String | The job ID to create a new job run for.

eval { 
    my $result = $api_instance->createJobRun(body => $body, projectId => $projectId, jobId => $jobId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->createJobRun: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
body =  # CreateJobRunRequest | 
projectId = projectId_example # String | ID of the project containing the job.
jobId = jobId_example # String | The job ID to create a new job run for.

try: 
    # Create and start a new job run for a job.
    api_response = api_instance.create_job_run(body, projectId, jobId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->createJobRun: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
ID of the project containing the job.
Required
job_id*
String
The job ID to create a new job run for.
Required
Body parameters
Name Description
body *

Responses

Status: 200 - A successful response.

Status: default - An unexpected error response


createModel

Create a model.


/api/v2/projects/{project_id}/models

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//api/v2/projects/{project_id}/models"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        CreateModelRequest body = ; // CreateModelRequest | 
        String projectId = projectId_example; // String | ID of the project containing the model.
        try {
            Model result = apiInstance.createModel(body, projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#createModel");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        CreateModelRequest body = ; // CreateModelRequest | 
        String projectId = projectId_example; // String | ID of the project containing the model.
        try {
            Model result = apiInstance.createModel(body, projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#createModel");
            e.printStackTrace();
        }
    }
}
CreateModelRequest *body = ; // 
String *projectId = projectId_example; // ID of the project containing the model.

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Create a model.
[apiInstance createModelWith:body
    projectId:projectId
              completionHandler: ^(Model output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var body = ; // {{CreateModelRequest}} 
var projectId = projectId_example; // {{String}} ID of the project containing the model.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createModel(bodyprojectId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createModelExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var body = new CreateModelRequest(); // CreateModelRequest | 
            var projectId = projectId_example;  // String | ID of the project containing the model.

            try
            {
                // Create a model.
                Model result = apiInstance.createModel(body, projectId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.createModel: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$body = ; // CreateModelRequest | 
$projectId = projectId_example; // String | ID of the project containing the model.

try {
    $result = $api_instance->createModel($body, $projectId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->createModel: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $body = WWW::SwaggerClient::Object::CreateModelRequest->new(); # CreateModelRequest | 
my $projectId = projectId_example; # String | ID of the project containing the model.

eval { 
    my $result = $api_instance->createModel(body => $body, projectId => $projectId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->createModel: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
body =  # CreateModelRequest | 
projectId = projectId_example # String | ID of the project containing the model.

try: 
    # Create a model.
    api_response = api_instance.create_model(body, projectId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->createModel: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
ID of the project containing the model.
Required
Body parameters
Name Description
body *

Responses

Status: 200 - A successful response.

Status: default - An unexpected error response


createModelBuild

Create a model build.


/api/v2/projects/{project_id}/models/{model_id}/builds

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//api/v2/projects/{project_id}/models/{model_id}/builds"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        CreateModelBuildRequest body = ; // CreateModelBuildRequest | 
        String projectId = projectId_example; // String | ID of the project containing the model build.
        String modelId = modelId_example; // String | The ID of the model that will the build.
        try {
            ModelBuild result = apiInstance.createModelBuild(body, projectId, modelId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#createModelBuild");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        CreateModelBuildRequest body = ; // CreateModelBuildRequest | 
        String projectId = projectId_example; // String | ID of the project containing the model build.
        String modelId = modelId_example; // String | The ID of the model that will the build.
        try {
            ModelBuild result = apiInstance.createModelBuild(body, projectId, modelId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#createModelBuild");
            e.printStackTrace();
        }
    }
}
CreateModelBuildRequest *body = ; // 
String *projectId = projectId_example; // ID of the project containing the model build.
String *modelId = modelId_example; // The ID of the model that will the build.

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Create a model build.
[apiInstance createModelBuildWith:body
    projectId:projectId
    modelId:modelId
              completionHandler: ^(ModelBuild output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var body = ; // {{CreateModelBuildRequest}} 
var projectId = projectId_example; // {{String}} ID of the project containing the model build.
var modelId = modelId_example; // {{String}} The ID of the model that will the build.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createModelBuild(bodyprojectIdmodelId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createModelBuildExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var body = new CreateModelBuildRequest(); // CreateModelBuildRequest | 
            var projectId = projectId_example;  // String | ID of the project containing the model build.
            var modelId = modelId_example;  // String | The ID of the model that will the build.

            try
            {
                // Create a model build.
                ModelBuild result = apiInstance.createModelBuild(body, projectId, modelId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.createModelBuild: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$body = ; // CreateModelBuildRequest | 
$projectId = projectId_example; // String | ID of the project containing the model build.
$modelId = modelId_example; // String | The ID of the model that will the build.

try {
    $result = $api_instance->createModelBuild($body, $projectId, $modelId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->createModelBuild: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $body = WWW::SwaggerClient::Object::CreateModelBuildRequest->new(); # CreateModelBuildRequest | 
my $projectId = projectId_example; # String | ID of the project containing the model build.
my $modelId = modelId_example; # String | The ID of the model that will the build.

eval { 
    my $result = $api_instance->createModelBuild(body => $body, projectId => $projectId, modelId => $modelId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->createModelBuild: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
body =  # CreateModelBuildRequest | 
projectId = projectId_example # String | ID of the project containing the model build.
modelId = modelId_example # String | The ID of the model that will the build.

try: 
    # Create a model build.
    api_response = api_instance.create_model_build(body, projectId, modelId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->createModelBuild: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
ID of the project containing the model build.
Required
model_id*
String
The ID of the model that will the build.
Required
Body parameters
Name Description
body *

Responses

Status: 200 - A successful response.

Status: default - An unexpected error response


createModelDeployment

Create a model deployment.


/api/v2/projects/{project_id}/models/{model_id}/builds/{build_id}/deployments

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//api/v2/projects/{project_id}/models/{model_id}/builds/{build_id}/deployments"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        CreateModelDeploymentRequest body = ; // CreateModelDeploymentRequest | 
        String projectId = projectId_example; // String | ID of the project containing the model.
        String modelId = modelId_example; // String | ID of the model to deploy.
        String buildId = buildId_example; // String | ID of the model build to deploy.
        try {
            ModelDeployment result = apiInstance.createModelDeployment(body, projectId, modelId, buildId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#createModelDeployment");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        CreateModelDeploymentRequest body = ; // CreateModelDeploymentRequest | 
        String projectId = projectId_example; // String | ID of the project containing the model.
        String modelId = modelId_example; // String | ID of the model to deploy.
        String buildId = buildId_example; // String | ID of the model build to deploy.
        try {
            ModelDeployment result = apiInstance.createModelDeployment(body, projectId, modelId, buildId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#createModelDeployment");
            e.printStackTrace();
        }
    }
}
CreateModelDeploymentRequest *body = ; // 
String *projectId = projectId_example; // ID of the project containing the model.
String *modelId = modelId_example; // ID of the model to deploy.
String *buildId = buildId_example; // ID of the model build to deploy.

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Create a model deployment.
[apiInstance createModelDeploymentWith:body
    projectId:projectId
    modelId:modelId
    buildId:buildId
              completionHandler: ^(ModelDeployment output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var body = ; // {{CreateModelDeploymentRequest}} 
var projectId = projectId_example; // {{String}} ID of the project containing the model.
var modelId = modelId_example; // {{String}} ID of the model to deploy.
var buildId = buildId_example; // {{String}} ID of the model build to deploy.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createModelDeployment(bodyprojectIdmodelIdbuildId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createModelDeploymentExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var body = new CreateModelDeploymentRequest(); // CreateModelDeploymentRequest | 
            var projectId = projectId_example;  // String | ID of the project containing the model.
            var modelId = modelId_example;  // String | ID of the model to deploy.
            var buildId = buildId_example;  // String | ID of the model build to deploy.

            try
            {
                // Create a model deployment.
                ModelDeployment result = apiInstance.createModelDeployment(body, projectId, modelId, buildId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.createModelDeployment: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$body = ; // CreateModelDeploymentRequest | 
$projectId = projectId_example; // String | ID of the project containing the model.
$modelId = modelId_example; // String | ID of the model to deploy.
$buildId = buildId_example; // String | ID of the model build to deploy.

try {
    $result = $api_instance->createModelDeployment($body, $projectId, $modelId, $buildId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->createModelDeployment: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $body = WWW::SwaggerClient::Object::CreateModelDeploymentRequest->new(); # CreateModelDeploymentRequest | 
my $projectId = projectId_example; # String | ID of the project containing the model.
my $modelId = modelId_example; # String | ID of the model to deploy.
my $buildId = buildId_example; # String | ID of the model build to deploy.

eval { 
    my $result = $api_instance->createModelDeployment(body => $body, projectId => $projectId, modelId => $modelId, buildId => $buildId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->createModelDeployment: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
body =  # CreateModelDeploymentRequest | 
projectId = projectId_example # String | ID of the project containing the model.
modelId = modelId_example # String | ID of the model to deploy.
buildId = buildId_example # String | ID of the model build to deploy.

try: 
    # Create a model deployment.
    api_response = api_instance.create_model_deployment(body, projectId, modelId, buildId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->createModelDeployment: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
ID of the project containing the model.
Required
model_id*
String
ID of the model to deploy.
Required
build_id*
String
ID of the model build to deploy.
Required
Body parameters
Name Description
body *

Responses

Status: 200 - A successful response.

Status: default - An unexpected error response


createProject

Create a new project.


/api/v2/projects

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//api/v2/projects"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        CreateProjectRequest body = ; // CreateProjectRequest | 
        try {
            Project result = apiInstance.createProject(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#createProject");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        CreateProjectRequest body = ; // CreateProjectRequest | 
        try {
            Project result = apiInstance.createProject(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#createProject");
            e.printStackTrace();
        }
    }
}
CreateProjectRequest *body = ; // 

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Create a new project.
[apiInstance createProjectWith:body
              completionHandler: ^(Project output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var body = ; // {{CreateProjectRequest}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createProject(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createProjectExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var body = new CreateProjectRequest(); // CreateProjectRequest | 

            try
            {
                // Create a new project.
                Project result = apiInstance.createProject(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.createProject: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$body = ; // CreateProjectRequest | 

try {
    $result = $api_instance->createProject($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->createProject: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $body = WWW::SwaggerClient::Object::CreateProjectRequest->new(); # CreateProjectRequest | 

eval { 
    my $result = $api_instance->createProject(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->createProject: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
body =  # CreateProjectRequest | 

try: 
    # Create a new project.
    api_response = api_instance.create_project(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->createProject: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - A successful response.

Status: default - An unexpected error response


createRegisteredModel

Register a model.


/api/v2/registry/models

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//api/v2/registry/models"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        CreateRegisteredModelRequest body = ; // CreateRegisteredModelRequest | 
        try {
            RegisteredModel result = apiInstance.createRegisteredModel(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#createRegisteredModel");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        CreateRegisteredModelRequest body = ; // CreateRegisteredModelRequest | 
        try {
            RegisteredModel result = apiInstance.createRegisteredModel(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#createRegisteredModel");
            e.printStackTrace();
        }
    }
}
CreateRegisteredModelRequest *body = ; // 

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Register a model.
[apiInstance createRegisteredModelWith:body
              completionHandler: ^(RegisteredModel output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var body = ; // {{CreateRegisteredModelRequest}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createRegisteredModel(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createRegisteredModelExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var body = new CreateRegisteredModelRequest(); // CreateRegisteredModelRequest | 

            try
            {
                // Register a model.
                RegisteredModel result = apiInstance.createRegisteredModel(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.createRegisteredModel: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$body = ; // CreateRegisteredModelRequest | 

try {
    $result = $api_instance->createRegisteredModel($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->createRegisteredModel: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $body = WWW::SwaggerClient::Object::CreateRegisteredModelRequest->new(); # CreateRegisteredModelRequest | 

eval { 
    my $result = $api_instance->createRegisteredModel(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->createRegisteredModel: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
body =  # CreateRegisteredModelRequest | 

try: 
    # Register a model.
    api_response = api_instance.create_registered_model(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->createRegisteredModel: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - A successful response.

Status: default - An unexpected error response


createRuntimeRepo

Create a Runtime repo.


/api/v2/runtimerepos

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//api/v2/runtimerepos"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        CreateRuntimeRepoRequest body = ; // CreateRuntimeRepoRequest | 
        try {
            RuntimeRepo result = apiInstance.createRuntimeRepo(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#createRuntimeRepo");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        CreateRuntimeRepoRequest body = ; // CreateRuntimeRepoRequest | 
        try {
            RuntimeRepo result = apiInstance.createRuntimeRepo(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#createRuntimeRepo");
            e.printStackTrace();
        }
    }
}
CreateRuntimeRepoRequest *body = ; // 

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Create a  Runtime repo.
[apiInstance createRuntimeRepoWith:body
              completionHandler: ^(RuntimeRepo output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var body = ; // {{CreateRuntimeRepoRequest}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createRuntimeRepo(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createRuntimeRepoExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var body = new CreateRuntimeRepoRequest(); // CreateRuntimeRepoRequest | 

            try
            {
                // Create a  Runtime repo.
                RuntimeRepo result = apiInstance.createRuntimeRepo(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.createRuntimeRepo: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$body = ; // CreateRuntimeRepoRequest | 

try {
    $result = $api_instance->createRuntimeRepo($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->createRuntimeRepo: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $body = WWW::SwaggerClient::Object::CreateRuntimeRepoRequest->new(); # CreateRuntimeRepoRequest | 

eval { 
    my $result = $api_instance->createRuntimeRepo(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->createRuntimeRepo: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
body =  # CreateRuntimeRepoRequest | 

try: 
    # Create a  Runtime repo.
    api_response = api_instance.create_runtime_repo(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->createRuntimeRepo: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - A successful response.

Status: default - An unexpected error response


createTeam

Create a team.


/api/v2/site/teams

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//api/v2/site/teams"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        CreateTeamRequest body = ; // CreateTeamRequest | 
        try {
            Team result = apiInstance.createTeam(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#createTeam");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        CreateTeamRequest body = ; // CreateTeamRequest | 
        try {
            Team result = apiInstance.createTeam(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#createTeam");
            e.printStackTrace();
        }
    }
}
CreateTeamRequest *body = ; // 

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Create a team.
[apiInstance createTeamWith:body
              completionHandler: ^(Team output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var body = ; // {{CreateTeamRequest}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createTeam(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createTeamExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var body = new CreateTeamRequest(); // CreateTeamRequest | 

            try
            {
                // Create a team.
                Team result = apiInstance.createTeam(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.createTeam: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$body = ; // CreateTeamRequest | 

try {
    $result = $api_instance->createTeam($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->createTeam: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $body = WWW::SwaggerClient::Object::CreateTeamRequest->new(); # CreateTeamRequest | 

eval { 
    my $result = $api_instance->createTeam(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->createTeam: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
body =  # CreateTeamRequest | 

try: 
    # Create a team.
    api_response = api_instance.create_team(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->createTeam: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - A successful response.

Status: default - An unexpected error response


createV2Key

Create API V2 key


/api/v2/users/{username}/v2_keys

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//api/v2/users/{username}/v2_keys"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        CreateV2KeyRequest body = ; // CreateV2KeyRequest | 
        String username = username_example; // String | username of the user whose V2 key you want to create
        try {
            CreateV2KeyResponse result = apiInstance.createV2Key(body, username);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#createV2Key");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        CreateV2KeyRequest body = ; // CreateV2KeyRequest | 
        String username = username_example; // String | username of the user whose V2 key you want to create
        try {
            CreateV2KeyResponse result = apiInstance.createV2Key(body, username);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#createV2Key");
            e.printStackTrace();
        }
    }
}
CreateV2KeyRequest *body = ; // 
String *username = username_example; // username of the user whose V2 key you want to create

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Create API V2 key
[apiInstance createV2KeyWith:body
    username:username
              completionHandler: ^(CreateV2KeyResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var body = ; // {{CreateV2KeyRequest}} 
var username = username_example; // {{String}} username of the user whose V2 key you want to create

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createV2Key(bodyusername, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createV2KeyExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var body = new CreateV2KeyRequest(); // CreateV2KeyRequest | 
            var username = username_example;  // String | username of the user whose V2 key you want to create

            try
            {
                // Create API V2 key
                CreateV2KeyResponse result = apiInstance.createV2Key(body, username);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.createV2Key: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$body = ; // CreateV2KeyRequest | 
$username = username_example; // String | username of the user whose V2 key you want to create

try {
    $result = $api_instance->createV2Key($body, $username);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->createV2Key: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $body = WWW::SwaggerClient::Object::CreateV2KeyRequest->new(); # CreateV2KeyRequest | 
my $username = username_example; # String | username of the user whose V2 key you want to create

eval { 
    my $result = $api_instance->createV2Key(body => $body, username => $username);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->createV2Key: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
body =  # CreateV2KeyRequest | 
username = username_example # String | username of the user whose V2 key you want to create

try: 
    # Create API V2 key
    api_response = api_instance.create_v2_key(body, username)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->createV2Key: %s\n" % e)

Parameters

Path parameters
Name Description
username*
String
username of the user whose V2 key you want to create
Required
Body parameters
Name Description
body *

Responses

Status: 200 - A successful response.

Status: default - An unexpected error response


deleteApplication

Delete an application.


/api/v2/projects/{project_id}/applications/{application_id}

Usage and SDK Samples

curl -X DELETE\
-H "Accept: application/json"\
"//api/v2/projects/{project_id}/applications/{application_id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | The public project identifier
        String applicationId = applicationId_example; // String | The public application identifier
        try {
            DeleteApplicationResponse result = apiInstance.deleteApplication(projectId, applicationId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#deleteApplication");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | The public project identifier
        String applicationId = applicationId_example; // String | The public application identifier
        try {
            DeleteApplicationResponse result = apiInstance.deleteApplication(projectId, applicationId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#deleteApplication");
            e.printStackTrace();
        }
    }
}
String *projectId = projectId_example; // The public project identifier
String *applicationId = applicationId_example; // The public application identifier

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Delete an application.
[apiInstance deleteApplicationWith:projectId
    applicationId:applicationId
              completionHandler: ^(DeleteApplicationResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var projectId = projectId_example; // {{String}} The public project identifier
var applicationId = applicationId_example; // {{String}} The public application identifier

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteApplication(projectId, applicationId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteApplicationExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var projectId = projectId_example;  // String | The public project identifier
            var applicationId = applicationId_example;  // String | The public application identifier

            try
            {
                // Delete an application.
                DeleteApplicationResponse result = apiInstance.deleteApplication(projectId, applicationId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.deleteApplication: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$projectId = projectId_example; // String | The public project identifier
$applicationId = applicationId_example; // String | The public application identifier

try {
    $result = $api_instance->deleteApplication($projectId, $applicationId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->deleteApplication: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $projectId = projectId_example; # String | The public project identifier
my $applicationId = applicationId_example; # String | The public application identifier

eval { 
    my $result = $api_instance->deleteApplication(projectId => $projectId, applicationId => $applicationId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->deleteApplication: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
projectId = projectId_example # String | The public project identifier
applicationId = applicationId_example # String | The public application identifier

try: 
    # Delete an application.
    api_response = api_instance.delete_application(projectId, applicationId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->deleteApplication: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
The public project identifier
Required
application_id*
String
The public application identifier
Required

Responses

Status: 200 - A successful response.

Status: default - An unexpected error response


deleteExperiment

Delete an experiment that belongs to an experiment id.


/api/v2/projects/{project_id}/experiments/{experiment_id}

Usage and SDK Samples

curl -X DELETE\
-H "Accept: application/json"\
"//api/v2/projects/{project_id}/experiments/{experiment_id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | 
        String experimentId = experimentId_example; // String | 
        try {
            DeleteExperimentResponse result = apiInstance.deleteExperiment(projectId, experimentId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#deleteExperiment");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | 
        String experimentId = experimentId_example; // String | 
        try {
            DeleteExperimentResponse result = apiInstance.deleteExperiment(projectId, experimentId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#deleteExperiment");
            e.printStackTrace();
        }
    }
}
String *projectId = projectId_example; // 
String *experimentId = experimentId_example; // 

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Delete an experiment that belongs to an experiment id.
[apiInstance deleteExperimentWith:projectId
    experimentId:experimentId
              completionHandler: ^(DeleteExperimentResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var projectId = projectId_example; // {{String}} 
var experimentId = experimentId_example; // {{String}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteExperiment(projectId, experimentId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteExperimentExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var projectId = projectId_example;  // String | 
            var experimentId = experimentId_example;  // String | 

            try
            {
                // Delete an experiment that belongs to an experiment id.
                DeleteExperimentResponse result = apiInstance.deleteExperiment(projectId, experimentId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.deleteExperiment: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$projectId = projectId_example; // String | 
$experimentId = experimentId_example; // String | 

try {
    $result = $api_instance->deleteExperiment($projectId, $experimentId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->deleteExperiment: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $projectId = projectId_example; # String | 
my $experimentId = experimentId_example; # String | 

eval { 
    my $result = $api_instance->deleteExperiment(projectId => $projectId, experimentId => $experimentId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->deleteExperiment: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
projectId = projectId_example # String | 
experimentId = experimentId_example # String | 

try: 
    # Delete an experiment that belongs to an experiment id.
    api_response = api_instance.delete_experiment(projectId, experimentId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->deleteExperiment: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
Required
experiment_id*
String
Required

Responses

Status: 200 - A successful response.

Status: default - An unexpected error response


deleteExperimentRun

Delete an experiment run.


/api/v2/projects/{project_id}/experiments/{experiment_id}/runs/{run_id}

Usage and SDK Samples

curl -X DELETE\
-H "Accept: application/json"\
"//api/v2/projects/{project_id}/experiments/{experiment_id}/runs/{run_id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | The project the experiment run lives in.
        String experimentId = experimentId_example; // String | The experiment the run is a part of.
        String runId = runId_example; // String | The ID of the run to delete.
        try {
            DeleteExperimentRunResponse result = apiInstance.deleteExperimentRun(projectId, experimentId, runId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#deleteExperimentRun");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | The project the experiment run lives in.
        String experimentId = experimentId_example; // String | The experiment the run is a part of.
        String runId = runId_example; // String | The ID of the run to delete.
        try {
            DeleteExperimentRunResponse result = apiInstance.deleteExperimentRun(projectId, experimentId, runId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#deleteExperimentRun");
            e.printStackTrace();
        }
    }
}
String *projectId = projectId_example; // The project the experiment run lives in.
String *experimentId = experimentId_example; // The experiment the run is a part of.
String *runId = runId_example; // The ID of the run to delete.

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Delete an experiment run.
[apiInstance deleteExperimentRunWith:projectId
    experimentId:experimentId
    runId:runId
              completionHandler: ^(DeleteExperimentRunResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var projectId = projectId_example; // {{String}} The project the experiment run lives in.
var experimentId = experimentId_example; // {{String}} The experiment the run is a part of.
var runId = runId_example; // {{String}} The ID of the run to delete.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteExperimentRun(projectId, experimentId, runId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteExperimentRunExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var projectId = projectId_example;  // String | The project the experiment run lives in.
            var experimentId = experimentId_example;  // String | The experiment the run is a part of.
            var runId = runId_example;  // String | The ID of the run to delete.

            try
            {
                // Delete an experiment run.
                DeleteExperimentRunResponse result = apiInstance.deleteExperimentRun(projectId, experimentId, runId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.deleteExperimentRun: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$projectId = projectId_example; // String | The project the experiment run lives in.
$experimentId = experimentId_example; // String | The experiment the run is a part of.
$runId = runId_example; // String | The ID of the run to delete.

try {
    $result = $api_instance->deleteExperimentRun($projectId, $experimentId, $runId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->deleteExperimentRun: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $projectId = projectId_example; # String | The project the experiment run lives in.
my $experimentId = experimentId_example; # String | The experiment the run is a part of.
my $runId = runId_example; # String | The ID of the run to delete.

eval { 
    my $result = $api_instance->deleteExperimentRun(projectId => $projectId, experimentId => $experimentId, runId => $runId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->deleteExperimentRun: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
projectId = projectId_example # String | The project the experiment run lives in.
experimentId = experimentId_example # String | The experiment the run is a part of.
runId = runId_example # String | The ID of the run to delete.

try: 
    # Delete an experiment run.
    api_response = api_instance.delete_experiment_run(projectId, experimentId, runId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->deleteExperimentRun: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
The project the experiment run lives in.
Required
experiment_id*
String
The experiment the run is a part of.
Required
run_id*
String
The ID of the run to delete.
Required

Responses

Status: 200 - A successful response.

Status: default - An unexpected error response


deleteExperimentRunBatch

Bulk delete an experiment run details like metrics, params, tags in one request.


/api/v2/projects/{project_id}/experiments/{experiment_id}/runs/{run_id}:deletebatch

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//api/v2/projects/{project_id}/experiments/{experiment_id}/runs/{run_id}:deletebatch"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        DeleteExperimentRunBatchRequest body = ; // DeleteExperimentRunBatchRequest | 
        String projectId = projectId_example; // String | 
        String experimentId = experimentId_example; // String | 
        String runId = runId_example; // String | ID of the ExperimentRun to log under
        try {
            DeleteExperimentRunBatchResponse result = apiInstance.deleteExperimentRunBatch(body, projectId, experimentId, runId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#deleteExperimentRunBatch");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        DeleteExperimentRunBatchRequest body = ; // DeleteExperimentRunBatchRequest | 
        String projectId = projectId_example; // String | 
        String experimentId = experimentId_example; // String | 
        String runId = runId_example; // String | ID of the ExperimentRun to log under
        try {
            DeleteExperimentRunBatchResponse result = apiInstance.deleteExperimentRunBatch(body, projectId, experimentId, runId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#deleteExperimentRunBatch");
            e.printStackTrace();
        }
    }
}
DeleteExperimentRunBatchRequest *body = ; // 
String *projectId = projectId_example; // 
String *experimentId = experimentId_example; // 
String *runId = runId_example; // ID of the ExperimentRun to log under

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Bulk delete an experiment run details like metrics, params, tags in one request.
[apiInstance deleteExperimentRunBatchWith:body
    projectId:projectId
    experimentId:experimentId
    runId:runId
              completionHandler: ^(DeleteExperimentRunBatchResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var body = ; // {{DeleteExperimentRunBatchRequest}} 
var projectId = projectId_example; // {{String}} 
var experimentId = experimentId_example; // {{String}} 
var runId = runId_example; // {{String}} ID of the ExperimentRun to log under

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteExperimentRunBatch(bodyprojectIdexperimentIdrunId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteExperimentRunBatchExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var body = new DeleteExperimentRunBatchRequest(); // DeleteExperimentRunBatchRequest | 
            var projectId = projectId_example;  // String | 
            var experimentId = experimentId_example;  // String | 
            var runId = runId_example;  // String | ID of the ExperimentRun to log under

            try
            {
                // Bulk delete an experiment run details like metrics, params, tags in one request.
                DeleteExperimentRunBatchResponse result = apiInstance.deleteExperimentRunBatch(body, projectId, experimentId, runId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.deleteExperimentRunBatch: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$body = ; // DeleteExperimentRunBatchRequest | 
$projectId = projectId_example; // String | 
$experimentId = experimentId_example; // String | 
$runId = runId_example; // String | ID of the ExperimentRun to log under

try {
    $result = $api_instance->deleteExperimentRunBatch($body, $projectId, $experimentId, $runId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->deleteExperimentRunBatch: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $body = WWW::SwaggerClient::Object::DeleteExperimentRunBatchRequest->new(); # DeleteExperimentRunBatchRequest | 
my $projectId = projectId_example; # String | 
my $experimentId = experimentId_example; # String | 
my $runId = runId_example; # String | ID of the ExperimentRun to log under

eval { 
    my $result = $api_instance->deleteExperimentRunBatch(body => $body, projectId => $projectId, experimentId => $experimentId, runId => $runId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->deleteExperimentRunBatch: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
body =  # DeleteExperimentRunBatchRequest | 
projectId = projectId_example # String | 
experimentId = experimentId_example # String | 
runId = runId_example # String | ID of the ExperimentRun to log under

try: 
    # Bulk delete an experiment run details like metrics, params, tags in one request.
    api_response = api_instance.delete_experiment_run_batch(body, projectId, experimentId, runId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->deleteExperimentRunBatch: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
Required
experiment_id*
String
Required
run_id*
String
ID of the ExperimentRun to log under
Required
Body parameters
Name Description
body *

Responses

Status: 200 - A successful response.

Status: default - An unexpected error response


deleteJob

Deletes a job.


/api/v2/projects/{project_id}/jobs/{job_id}

Usage and SDK Samples

curl -X DELETE\
-H "Accept: application/json"\
"//api/v2/projects/{project_id}/jobs/{job_id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | the public project identifier
        String jobId = jobId_example; // String | The public job identifier
        try {
            DeleteJobResponse result = apiInstance.deleteJob(projectId, jobId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#deleteJob");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | the public project identifier
        String jobId = jobId_example; // String | The public job identifier
        try {
            DeleteJobResponse result = apiInstance.deleteJob(projectId, jobId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#deleteJob");
            e.printStackTrace();
        }
    }
}
String *projectId = projectId_example; // the public project identifier
String *jobId = jobId_example; // The public job identifier

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Deletes a job.
[apiInstance deleteJobWith:projectId
    jobId:jobId
              completionHandler: ^(DeleteJobResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var projectId = projectId_example; // {{String}} the public project identifier
var jobId = jobId_example; // {{String}} The public job identifier

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteJob(projectId, jobId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteJobExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var projectId = projectId_example;  // String | the public project identifier
            var jobId = jobId_example;  // String | The public job identifier

            try
            {
                // Deletes a job.
                DeleteJobResponse result = apiInstance.deleteJob(projectId, jobId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.deleteJob: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$projectId = projectId_example; // String | the public project identifier
$jobId = jobId_example; // String | The public job identifier

try {
    $result = $api_instance->deleteJob($projectId, $jobId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->deleteJob: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $projectId = projectId_example; # String | the public project identifier
my $jobId = jobId_example; # String | The public job identifier

eval { 
    my $result = $api_instance->deleteJob(projectId => $projectId, jobId => $jobId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->deleteJob: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
projectId = projectId_example # String | the public project identifier
jobId = jobId_example # String | The public job identifier

try: 
    # Deletes a job.
    api_response = api_instance.delete_job(projectId, jobId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->deleteJob: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
the public project identifier
Required
job_id*
String
The public job identifier
Required

Responses

Status: 200 - A successful response.

Status: default - An unexpected error response


deleteModel

Delete a model.


/api/v2/projects/{project_id}/models/{model_id}

Usage and SDK Samples

curl -X DELETE\
-H "Accept: application/json"\
"//api/v2/projects/{project_id}/models/{model_id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | ID of the project containing the model.
        String modelId = modelId_example; // String | ID of the model to delete.
        try {
            DeleteModelResponse result = apiInstance.deleteModel(projectId, modelId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#deleteModel");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | ID of the project containing the model.
        String modelId = modelId_example; // String | ID of the model to delete.
        try {
            DeleteModelResponse result = apiInstance.deleteModel(projectId, modelId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#deleteModel");
            e.printStackTrace();
        }
    }
}
String *projectId = projectId_example; // ID of the project containing the model.
String *modelId = modelId_example; // ID of the model to delete.

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Delete a model.
[apiInstance deleteModelWith:projectId
    modelId:modelId
              completionHandler: ^(DeleteModelResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var projectId = projectId_example; // {{String}} ID of the project containing the model.
var modelId = modelId_example; // {{String}} ID of the model to delete.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteModel(projectId, modelId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteModelExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var projectId = projectId_example;  // String | ID of the project containing the model.
            var modelId = modelId_example;  // String | ID of the model to delete.

            try
            {
                // Delete a model.
                DeleteModelResponse result = apiInstance.deleteModel(projectId, modelId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.deleteModel: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$projectId = projectId_example; // String | ID of the project containing the model.
$modelId = modelId_example; // String | ID of the model to delete.

try {
    $result = $api_instance->deleteModel($projectId, $modelId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->deleteModel: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $projectId = projectId_example; # String | ID of the project containing the model.
my $modelId = modelId_example; # String | ID of the model to delete.

eval { 
    my $result = $api_instance->deleteModel(projectId => $projectId, modelId => $modelId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->deleteModel: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
projectId = projectId_example # String | ID of the project containing the model.
modelId = modelId_example # String | ID of the model to delete.

try: 
    # Delete a model.
    api_response = api_instance.delete_model(projectId, modelId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->deleteModel: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
ID of the project containing the model.
Required
model_id*
String
ID of the model to delete.
Required

Responses

Status: 200 - A successful response.

Status: default - An unexpected error response


deleteModelBuild

Delete a model build.


/api/v2/projects/{project_id}/models/{model_id}/builds/{build_id}

Usage and SDK Samples

curl -X DELETE\
-H "Accept: application/json"\
"//api/v2/projects/{project_id}/models/{model_id}/builds/{build_id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | ID of the project containing the model.
        String modelId = modelId_example; // String | ID of the model containing the build.
        String buildId = buildId_example; // String | ID of the build to delete.
        try {
            DeleteModelBuildResponse result = apiInstance.deleteModelBuild(projectId, modelId, buildId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#deleteModelBuild");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | ID of the project containing the model.
        String modelId = modelId_example; // String | ID of the model containing the build.
        String buildId = buildId_example; // String | ID of the build to delete.
        try {
            DeleteModelBuildResponse result = apiInstance.deleteModelBuild(projectId, modelId, buildId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#deleteModelBuild");
            e.printStackTrace();
        }
    }
}
String *projectId = projectId_example; // ID of the project containing the model.
String *modelId = modelId_example; // ID of the model containing the build.
String *buildId = buildId_example; // ID of the build to delete.

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Delete a model build.
[apiInstance deleteModelBuildWith:projectId
    modelId:modelId
    buildId:buildId
              completionHandler: ^(DeleteModelBuildResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var projectId = projectId_example; // {{String}} ID of the project containing the model.
var modelId = modelId_example; // {{String}} ID of the model containing the build.
var buildId = buildId_example; // {{String}} ID of the build to delete.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteModelBuild(projectId, modelId, buildId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteModelBuildExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var projectId = projectId_example;  // String | ID of the project containing the model.
            var modelId = modelId_example;  // String | ID of the model containing the build.
            var buildId = buildId_example;  // String | ID of the build to delete.

            try
            {
                // Delete a model build.
                DeleteModelBuildResponse result = apiInstance.deleteModelBuild(projectId, modelId, buildId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.deleteModelBuild: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$projectId = projectId_example; // String | ID of the project containing the model.
$modelId = modelId_example; // String | ID of the model containing the build.
$buildId = buildId_example; // String | ID of the build to delete.

try {
    $result = $api_instance->deleteModelBuild($projectId, $modelId, $buildId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->deleteModelBuild: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $projectId = projectId_example; # String | ID of the project containing the model.
my $modelId = modelId_example; # String | ID of the model containing the build.
my $buildId = buildId_example; # String | ID of the build to delete.

eval { 
    my $result = $api_instance->deleteModelBuild(projectId => $projectId, modelId => $modelId, buildId => $buildId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->deleteModelBuild: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
projectId = projectId_example # String | ID of the project containing the model.
modelId = modelId_example # String | ID of the model containing the build.
buildId = buildId_example # String | ID of the build to delete.

try: 
    # Delete a model build.
    api_response = api_instance.delete_model_build(projectId, modelId, buildId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->deleteModelBuild: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
ID of the project containing the model.
Required
model_id*
String
ID of the model containing the build.
Required
build_id*
String
ID of the build to delete.
Required

Responses

Status: 200 - A successful response.

Status: default - An unexpected error response


deleteProject

Delete a project.


/api/v2/projects/{project_id}

Usage and SDK Samples

curl -X DELETE\
-H "Accept: application/json"\
"//api/v2/projects/{project_id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | The project's identifier
        try {
            DeleteProjectResponse result = apiInstance.deleteProject(projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#deleteProject");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | The project's identifier
        try {
            DeleteProjectResponse result = apiInstance.deleteProject(projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#deleteProject");
            e.printStackTrace();
        }
    }
}
String *projectId = projectId_example; // The project's identifier

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Delete a project.
[apiInstance deleteProjectWith:projectId
              completionHandler: ^(DeleteProjectResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var projectId = projectId_example; // {{String}} The project's identifier

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteProject(projectId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteProjectExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var projectId = projectId_example;  // String | The project's identifier

            try
            {
                // Delete a project.
                DeleteProjectResponse result = apiInstance.deleteProject(projectId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.deleteProject: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$projectId = projectId_example; // String | The project's identifier

try {
    $result = $api_instance->deleteProject($projectId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->deleteProject: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $projectId = projectId_example; # String | The project's identifier

eval { 
    my $result = $api_instance->deleteProject(projectId => $projectId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->deleteProject: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
projectId = projectId_example # String | The project's identifier

try: 
    # Delete a project.
    api_response = api_instance.delete_project(projectId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->deleteProject: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
The project's identifier
Required

Responses

Status: 200 - A successful response.

Status: default - An unexpected error response


deleteProjectCollaborator

Delete a project collaborator


/api/v2/projects/{project_id}/collaborators/{username}

Usage and SDK Samples

curl -X DELETE\
-H "Accept: application/json"\
"//api/v2/projects/{project_id}/collaborators/{username}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | The identifier of the project.
        String username = username_example; // String | The username of the collaborator to add.
        try {
            DeleteProjectCollaboratorResponse result = apiInstance.deleteProjectCollaborator(projectId, username);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#deleteProjectCollaborator");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | The identifier of the project.
        String username = username_example; // String | The username of the collaborator to add.
        try {
            DeleteProjectCollaboratorResponse result = apiInstance.deleteProjectCollaborator(projectId, username);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#deleteProjectCollaborator");
            e.printStackTrace();
        }
    }
}
String *projectId = projectId_example; // The identifier of the project.
String *username = username_example; // The username of the collaborator to add.

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Delete a project collaborator
[apiInstance deleteProjectCollaboratorWith:projectId
    username:username
              completionHandler: ^(DeleteProjectCollaboratorResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var projectId = projectId_example; // {{String}} The identifier of the project.
var username = username_example; // {{String}} The username of the collaborator to add.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteProjectCollaborator(projectId, username, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteProjectCollaboratorExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var projectId = projectId_example;  // String | The identifier of the project.
            var username = username_example;  // String | The username of the collaborator to add.

            try
            {
                // Delete a project collaborator
                DeleteProjectCollaboratorResponse result = apiInstance.deleteProjectCollaborator(projectId, username);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.deleteProjectCollaborator: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$projectId = projectId_example; // String | The identifier of the project.
$username = username_example; // String | The username of the collaborator to add.

try {
    $result = $api_instance->deleteProjectCollaborator($projectId, $username);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->deleteProjectCollaborator: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $projectId = projectId_example; # String | The identifier of the project.
my $username = username_example; # String | The username of the collaborator to add.

eval { 
    my $result = $api_instance->deleteProjectCollaborator(projectId => $projectId, username => $username);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->deleteProjectCollaborator: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
projectId = projectId_example # String | The identifier of the project.
username = username_example # String | The username of the collaborator to add.

try: 
    # Delete a project collaborator
    api_response = api_instance.delete_project_collaborator(projectId, username)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->deleteProjectCollaborator: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
The identifier of the project.
Required
username*
String
The username of the collaborator to add.
Required

Responses

Status: 200 - A successful response.

Status: default - An unexpected error response


deleteProjectFile

Delete a file or directory.


/api/v2/projects/{project_id}/files/{path}

Usage and SDK Samples

curl -X DELETE\
-H "Accept: application/json"\
"//api/v2/projects/{project_id}/files/{path}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | The identifier of the project that contains the file or directory.
        String path = path_example; // String | The path to the file or directory to delete.
        try {
            DeleteProjectFileResponse result = apiInstance.deleteProjectFile(projectId, path);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#deleteProjectFile");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | The identifier of the project that contains the file or directory.
        String path = path_example; // String | The path to the file or directory to delete.
        try {
            DeleteProjectFileResponse result = apiInstance.deleteProjectFile(projectId, path);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#deleteProjectFile");
            e.printStackTrace();
        }
    }
}
String *projectId = projectId_example; // The identifier of the project that contains the file or directory.
String *path = path_example; // The path to the file or directory to delete.

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Delete a file or directory.
[apiInstance deleteProjectFileWith:projectId
    path:path
              completionHandler: ^(DeleteProjectFileResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var projectId = projectId_example; // {{String}} The identifier of the project that contains the file or directory.
var path = path_example; // {{String}} The path to the file or directory to delete.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteProjectFile(projectId, path, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteProjectFileExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var projectId = projectId_example;  // String | The identifier of the project that contains the file or directory.
            var path = path_example;  // String | The path to the file or directory to delete.

            try
            {
                // Delete a file or directory.
                DeleteProjectFileResponse result = apiInstance.deleteProjectFile(projectId, path);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.deleteProjectFile: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$projectId = projectId_example; // String | The identifier of the project that contains the file or directory.
$path = path_example; // String | The path to the file or directory to delete.

try {
    $result = $api_instance->deleteProjectFile($projectId, $path);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->deleteProjectFile: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $projectId = projectId_example; # String | The identifier of the project that contains the file or directory.
my $path = path_example; # String | The path to the file or directory to delete.

eval { 
    my $result = $api_instance->deleteProjectFile(projectId => $projectId, path => $path);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->deleteProjectFile: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
projectId = projectId_example # String | The identifier of the project that contains the file or directory.
path = path_example # String | The path to the file or directory to delete.

try: 
    # Delete a file or directory.
    api_response = api_instance.delete_project_file(projectId, path)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->deleteProjectFile: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
The identifier of the project that contains the file or directory.
Required
path*
String
The path to the file or directory to delete.
Required

Responses

Status: 200 - A successful response.

Status: default - An unexpected error response


deleteRegisteredModel

Unregister a model deletes a model.


/api/v2/registry/models/{model_id}

Usage and SDK Samples

curl -X DELETE\
-H "Accept: application/json"\
"//api/v2/registry/models/{model_id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String modelId = modelId_example; // String | Model ID.
        try {
            DeleteRegisteredModelResponse result = apiInstance.deleteRegisteredModel(modelId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#deleteRegisteredModel");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String modelId = modelId_example; // String | Model ID.
        try {
            DeleteRegisteredModelResponse result = apiInstance.deleteRegisteredModel(modelId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#deleteRegisteredModel");
            e.printStackTrace();
        }
    }
}
String *modelId = modelId_example; // Model ID.

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Unregister a model deletes a model.
[apiInstance deleteRegisteredModelWith:modelId
              completionHandler: ^(DeleteRegisteredModelResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var modelId = modelId_example; // {{String}} Model ID.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteRegisteredModel(modelId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteRegisteredModelExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var modelId = modelId_example;  // String | Model ID.

            try
            {
                // Unregister a model deletes a model.
                DeleteRegisteredModelResponse result = apiInstance.deleteRegisteredModel(modelId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.deleteRegisteredModel: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$modelId = modelId_example; // String | Model ID.

try {
    $result = $api_instance->deleteRegisteredModel($modelId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->deleteRegisteredModel: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $modelId = modelId_example; # String | Model ID.

eval { 
    my $result = $api_instance->deleteRegisteredModel(modelId => $modelId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->deleteRegisteredModel: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
modelId = modelId_example # String | Model ID.

try: 
    # Unregister a model deletes a model.
    api_response = api_instance.delete_registered_model(modelId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->deleteRegisteredModel: %s\n" % e)

Parameters

Path parameters
Name Description
model_id*
String
Model ID.
Required

Responses

Status: 200 - A successful response.

Status: default - An unexpected error response


deleteRegisteredModelVersion

Unregister a model version.


/api/v2/registry/models/{model_id}/versions/{version_id}

Usage and SDK Samples

curl -X DELETE\
-H "Accept: application/json"\
"//api/v2/registry/models/{model_id}/versions/{version_id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String modelId = modelId_example; // String | Model ID.
        String versionId = versionId_example; // String | Model version ID.
        try {
            DeleteRegisteredModelVersionResponse result = apiInstance.deleteRegisteredModelVersion(modelId, versionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#deleteRegisteredModelVersion");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String modelId = modelId_example; // String | Model ID.
        String versionId = versionId_example; // String | Model version ID.
        try {
            DeleteRegisteredModelVersionResponse result = apiInstance.deleteRegisteredModelVersion(modelId, versionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#deleteRegisteredModelVersion");
            e.printStackTrace();
        }
    }
}
String *modelId = modelId_example; // Model ID.
String *versionId = versionId_example; // Model version ID.

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Unregister a model version.
[apiInstance deleteRegisteredModelVersionWith:modelId
    versionId:versionId
              completionHandler: ^(DeleteRegisteredModelVersionResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var modelId = modelId_example; // {{String}} Model ID.
var versionId = versionId_example; // {{String}} Model version ID.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteRegisteredModelVersion(modelId, versionId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteRegisteredModelVersionExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var modelId = modelId_example;  // String | Model ID.
            var versionId = versionId_example;  // String | Model version ID.

            try
            {
                // Unregister a model version.
                DeleteRegisteredModelVersionResponse result = apiInstance.deleteRegisteredModelVersion(modelId, versionId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.deleteRegisteredModelVersion: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$modelId = modelId_example; // String | Model ID.
$versionId = versionId_example; // String | Model version ID.

try {
    $result = $api_instance->deleteRegisteredModelVersion($modelId, $versionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->deleteRegisteredModelVersion: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $modelId = modelId_example; # String | Model ID.
my $versionId = versionId_example; # String | Model version ID.

eval { 
    my $result = $api_instance->deleteRegisteredModelVersion(modelId => $modelId, versionId => $versionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->deleteRegisteredModelVersion: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
modelId = modelId_example # String | Model ID.
versionId = versionId_example # String | Model version ID.

try: 
    # Unregister a model version.
    api_response = api_instance.delete_registered_model_version(modelId, versionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->deleteRegisteredModelVersion: %s\n" % e)

Parameters

Path parameters
Name Description
model_id*
String
Model ID.
Required
version_id*
String
Model version ID.
Required

Responses

Status: 200 - A successful response.

Status: default - An unexpected error response


deleteRuntimeRepo

Delete a Runtime repo.


/api/v2/runtimerepos/{runtime_repo_id}

Usage and SDK Samples

curl -X DELETE\
-H "Accept: application/json"\
"//api/v2/runtimerepos/{runtime_repo_id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        Integer runtimeRepoId = 56; // Integer | the id of the Runtime Repo to delete
        try {
            DeleteRuntimeRepoResponse result = apiInstance.deleteRuntimeRepo(runtimeRepoId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#deleteRuntimeRepo");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        Integer runtimeRepoId = 56; // Integer | the id of the Runtime Repo to delete
        try {
            DeleteRuntimeRepoResponse result = apiInstance.deleteRuntimeRepo(runtimeRepoId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#deleteRuntimeRepo");
            e.printStackTrace();
        }
    }
}
Integer *runtimeRepoId = 56; // the id of the Runtime Repo to delete

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Delete a Runtime repo.
[apiInstance deleteRuntimeRepoWith:runtimeRepoId
              completionHandler: ^(DeleteRuntimeRepoResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var runtimeRepoId = 56; // {{Integer}} the id of the Runtime Repo to delete

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteRuntimeRepo(runtimeRepoId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteRuntimeRepoExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var runtimeRepoId = 56;  // Integer | the id of the Runtime Repo to delete

            try
            {
                // Delete a Runtime repo.
                DeleteRuntimeRepoResponse result = apiInstance.deleteRuntimeRepo(runtimeRepoId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.deleteRuntimeRepo: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$runtimeRepoId = 56; // Integer | the id of the Runtime Repo to delete

try {
    $result = $api_instance->deleteRuntimeRepo($runtimeRepoId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->deleteRuntimeRepo: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $runtimeRepoId = 56; # Integer | the id of the Runtime Repo to delete

eval { 
    my $result = $api_instance->deleteRuntimeRepo(runtimeRepoId => $runtimeRepoId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->deleteRuntimeRepo: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
runtimeRepoId = 56 # Integer | the id of the Runtime Repo to delete

try: 
    # Delete a Runtime repo.
    api_response = api_instance.delete_runtime_repo(runtimeRepoId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->deleteRuntimeRepo: %s\n" % e)

Parameters

Path parameters
Name Description
runtime_repo_id*
Integer (int32)
the id of the Runtime Repo to delete
Required

Responses

Status: 200 - A successful response.

Status: default - An unexpected error response


deleteV2Key

Delete an API V2 key


/api/v2/users/{username}/v2_keys/{key_id}

Usage and SDK Samples

curl -X DELETE\
-H "Accept: application/json"\
"//api/v2/users/{username}/v2_keys/{key_id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String username = username_example; // String | username of the user whose V2 key you want to delete
        String keyId = keyId_example; // String | ID of the V2 key
        try {
            DeleteV2KeyResponse result = apiInstance.deleteV2Key(username, keyId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#deleteV2Key");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String username = username_example; // String | username of the user whose V2 key you want to delete
        String keyId = keyId_example; // String | ID of the V2 key
        try {
            DeleteV2KeyResponse result = apiInstance.deleteV2Key(username, keyId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#deleteV2Key");
            e.printStackTrace();
        }
    }
}
String *username = username_example; // username of the user whose V2 key you want to delete
String *keyId = keyId_example; // ID of the V2 key

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Delete an API V2 key
[apiInstance deleteV2KeyWith:username
    keyId:keyId
              completionHandler: ^(DeleteV2KeyResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var username = username_example; // {{String}} username of the user whose V2 key you want to delete
var keyId = keyId_example; // {{String}} ID of the V2 key

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteV2Key(username, keyId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteV2KeyExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var username = username_example;  // String | username of the user whose V2 key you want to delete
            var keyId = keyId_example;  // String | ID of the V2 key

            try
            {
                // Delete an API V2 key
                DeleteV2KeyResponse result = apiInstance.deleteV2Key(username, keyId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.deleteV2Key: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$username = username_example; // String | username of the user whose V2 key you want to delete
$keyId = keyId_example; // String | ID of the V2 key

try {
    $result = $api_instance->deleteV2Key($username, $keyId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->deleteV2Key: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $username = username_example; # String | username of the user whose V2 key you want to delete
my $keyId = keyId_example; # String | ID of the V2 key

eval { 
    my $result = $api_instance->deleteV2Key(username => $username, keyId => $keyId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->deleteV2Key: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
username = username_example # String | username of the user whose V2 key you want to delete
keyId = keyId_example # String | ID of the V2 key

try: 
    # Delete an API V2 key
    api_response = api_instance.delete_v2_key(username, keyId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->deleteV2Key: %s\n" % e)

Parameters

Path parameters
Name Description
username*
String
username of the user whose V2 key you want to delete
Required
key_id*
String
ID of the V2 key
Required

Responses

Status: 200 - A successful response.

Status: default - An unexpected error response


deleteV2Keys

Delete all API V2 keys


/api/v2/users/{username}/v2_keys

Usage and SDK Samples

curl -X DELETE\
-H "Accept: application/json"\
"//api/v2/users/{username}/v2_keys"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String username = username_example; // String | username of the user whose V2 keys you want to delete
        try {
            DeleteV2KeysResponse result = apiInstance.deleteV2Keys(username);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#deleteV2Keys");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String username = username_example; // String | username of the user whose V2 keys you want to delete
        try {
            DeleteV2KeysResponse result = apiInstance.deleteV2Keys(username);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#deleteV2Keys");
            e.printStackTrace();
        }
    }
}
String *username = username_example; // username of the user whose V2 keys you want to delete

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Delete all API V2 keys
[apiInstance deleteV2KeysWith:username
              completionHandler: ^(DeleteV2KeysResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var username = username_example; // {{String}} username of the user whose V2 keys you want to delete

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteV2Keys(username, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteV2KeysExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var username = username_example;  // String | username of the user whose V2 keys you want to delete

            try
            {
                // Delete all API V2 keys
                DeleteV2KeysResponse result = apiInstance.deleteV2Keys(username);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.deleteV2Keys: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$username = username_example; // String | username of the user whose V2 keys you want to delete

try {
    $result = $api_instance->deleteV2Keys($username);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->deleteV2Keys: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $username = username_example; # String | username of the user whose V2 keys you want to delete

eval { 
    my $result = $api_instance->deleteV2Keys(username => $username);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->deleteV2Keys: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
username = username_example # String | username of the user whose V2 keys you want to delete

try: 
    # Delete all API V2 keys
    api_response = api_instance.delete_v2_keys(username)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->deleteV2Keys: %s\n" % e)

Parameters

Path parameters
Name Description
username*
String
username of the user whose V2 keys you want to delete
Required

Responses

Status: 200 - A successful response.

Status: default - An unexpected error response


disableEngines

Disable engines


/api/v2/site/config:update

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//api/v2/site/config:update"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        DisableEnginesRequest body = ; // DisableEnginesRequest | 
        try {
            DisableEnginesResponse result = apiInstance.disableEngines(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#disableEngines");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        DisableEnginesRequest body = ; // DisableEnginesRequest | 
        try {
            DisableEnginesResponse result = apiInstance.disableEngines(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#disableEngines");
            e.printStackTrace();
        }
    }
}
DisableEnginesRequest *body = ; // 

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Disable engines
[apiInstance disableEnginesWith:body
              completionHandler: ^(DisableEnginesResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var body = ; // {{DisableEnginesRequest}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.disableEngines(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class disableEnginesExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var body = new DisableEnginesRequest(); // DisableEnginesRequest | 

            try
            {
                // Disable engines
                DisableEnginesResponse result = apiInstance.disableEngines(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.disableEngines: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$body = ; // DisableEnginesRequest | 

try {
    $result = $api_instance->disableEngines($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->disableEngines: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $body = WWW::SwaggerClient::Object::DisableEnginesRequest->new(); # DisableEnginesRequest | 

eval { 
    my $result = $api_instance->disableEngines(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->disableEngines: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
body =  # DisableEnginesRequest | 

try: 
    # Disable engines
    api_response = api_instance.disable_engines(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->disableEngines: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - A successful response.

Status: default - An unexpected error response


downloadProjectFile

download a project file


/api/v2/projects/{project_id}/files/{path}:download

Usage and SDK Samples

curl -X POST\
"//api/v2/projects/{project_id}/files/{path}:download"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | The project this model belongs to.
        String path = path_example; // String | The path of the file to download
        try {
            apiInstance.downloadProjectFile(projectId, path);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#downloadProjectFile");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | The project this model belongs to.
        String path = path_example; // String | The path of the file to download
        try {
            apiInstance.downloadProjectFile(projectId, path);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#downloadProjectFile");
            e.printStackTrace();
        }
    }
}
String *projectId = projectId_example; // The project this model belongs to.
String *path = path_example; // The path of the file to download

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// download a project file
[apiInstance downloadProjectFileWith:projectId
    path:path
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var projectId = projectId_example; // {{String}} The project this model belongs to.
var path = path_example; // {{String}} The path of the file to download

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.downloadProjectFile(projectId, path, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class downloadProjectFileExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var projectId = projectId_example;  // String | The project this model belongs to.
            var path = path_example;  // String | The path of the file to download

            try
            {
                // download a project file
                apiInstance.downloadProjectFile(projectId, path);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.downloadProjectFile: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$projectId = projectId_example; // String | The project this model belongs to.
$path = path_example; // String | The path of the file to download

try {
    $api_instance->downloadProjectFile($projectId, $path);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->downloadProjectFile: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $projectId = projectId_example; # String | The project this model belongs to.
my $path = path_example; # String | The path of the file to download

eval { 
    $api_instance->downloadProjectFile(projectId => $projectId, path => $path);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->downloadProjectFile: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
projectId = projectId_example # String | The project this model belongs to.
path = path_example # String | The path of the file to download

try: 
    # download a project file
    api_instance.download_project_file(projectId, path)
except ApiException as e:
    print("Exception when calling CMLServiceApi->downloadProjectFile: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
The project this model belongs to.
Required
path*
String
The path of the file to download
Required

Responses

Status: 200 - A successful response.

Status: default - An unexpected error response.


getApplication

Get an application.


/api/v2/projects/{project_id}/applications/{application_id}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/projects/{project_id}/applications/{application_id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | The public project identifier
        String applicationId = applicationId_example; // String | The public application identifier
        try {
            Application result = apiInstance.getApplication(projectId, applicationId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#getApplication");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | The public project identifier
        String applicationId = applicationId_example; // String | The public application identifier
        try {
            Application result = apiInstance.getApplication(projectId, applicationId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#getApplication");
            e.printStackTrace();
        }
    }
}
String *projectId = projectId_example; // The public project identifier
String *applicationId = applicationId_example; // The public application identifier

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Get an application.
[apiInstance getApplicationWith:projectId
    applicationId:applicationId
              completionHandler: ^(Application output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var projectId = projectId_example; // {{String}} The public project identifier
var applicationId = applicationId_example; // {{String}} The public application identifier

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getApplication(projectId, applicationId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getApplicationExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var projectId = projectId_example;  // String | The public project identifier
            var applicationId = applicationId_example;  // String | The public application identifier

            try
            {
                // Get an application.
                Application result = apiInstance.getApplication(projectId, applicationId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.getApplication: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$projectId = projectId_example; // String | The public project identifier
$applicationId = applicationId_example; // String | The public application identifier

try {
    $result = $api_instance->getApplication($projectId, $applicationId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->getApplication: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $projectId = projectId_example; # String | The public project identifier
my $applicationId = applicationId_example; # String | The public application identifier

eval { 
    my $result = $api_instance->getApplication(projectId => $projectId, applicationId => $applicationId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->getApplication: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
projectId = projectId_example # String | The public project identifier
applicationId = applicationId_example # String | The public application identifier

try: 
    # Get an application.
    api_response = api_instance.get_application(projectId, applicationId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->getApplication: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
The public project identifier
Required
application_id*
String
The public application identifier
Required

Responses

Status: 200 - A successful response.

Status: default - An unexpected error response


getExperiment

Return one experiment.


/api/v2/projects/{project_id}/experiments/{experiment_id}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/projects/{project_id}/experiments/{experiment_id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | 
        String experimentId = experimentId_example; // String | ID of the associated experiment.
        try {
            Experiment result = apiInstance.getExperiment(projectId, experimentId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#getExperiment");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | 
        String experimentId = experimentId_example; // String | ID of the associated experiment.
        try {
            Experiment result = apiInstance.getExperiment(projectId, experimentId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#getExperiment");
            e.printStackTrace();
        }
    }
}
String *projectId = projectId_example; // 
String *experimentId = experimentId_example; // ID of the associated experiment.

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Return one experiment.
[apiInstance getExperimentWith:projectId
    experimentId:experimentId
              completionHandler: ^(Experiment output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var projectId = projectId_example; // {{String}} 
var experimentId = experimentId_example; // {{String}} ID of the associated experiment.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getExperiment(projectId, experimentId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getExperimentExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var projectId = projectId_example;  // String | 
            var experimentId = experimentId_example;  // String | ID of the associated experiment.

            try
            {
                // Return one experiment.
                Experiment result = apiInstance.getExperiment(projectId, experimentId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.getExperiment: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$projectId = projectId_example; // String | 
$experimentId = experimentId_example; // String | ID of the associated experiment.

try {
    $result = $api_instance->getExperiment($projectId, $experimentId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->getExperiment: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $projectId = projectId_example; # String | 
my $experimentId = experimentId_example; # String | ID of the associated experiment.

eval { 
    my $result = $api_instance->getExperiment(projectId => $projectId, experimentId => $experimentId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->getExperiment: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
projectId = projectId_example # String | 
experimentId = experimentId_example # String | ID of the associated experiment.

try: 
    # Return one experiment.
    api_response = api_instance.get_experiment(projectId, experimentId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->getExperiment: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
Required
experiment_id*
String
ID of the associated experiment.
Required

Responses

Status: 200 - A successful response.

Status: default - An unexpected error response


getExperimentRun

Get metadata, metrics, params, tags and artifacts for a run. In the case where multiple metrics with the same key are logged for a run, return only the value with the latest timestamp. If there are multiple values with the latest timestamp, return the maximum of these values.


/api/v2/projects/{project_id}/experiments/{experiment_id}/runs/{run_id}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/projects/{project_id}/experiments/{experiment_id}/runs/{run_id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | 
        String experimentId = experimentId_example; // String | ID of the associated experiment.
        String runId = runId_example; // String | ID of the ExperimentRun to fetch. Must be provided.
        try {
            ExperimentRun result = apiInstance.getExperimentRun(projectId, experimentId, runId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#getExperimentRun");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | 
        String experimentId = experimentId_example; // String | ID of the associated experiment.
        String runId = runId_example; // String | ID of the ExperimentRun to fetch. Must be provided.
        try {
            ExperimentRun result = apiInstance.getExperimentRun(projectId, experimentId, runId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#getExperimentRun");
            e.printStackTrace();
        }
    }
}
String *projectId = projectId_example; // 
String *experimentId = experimentId_example; // ID of the associated experiment.
String *runId = runId_example; // ID of the ExperimentRun to fetch. Must be provided.

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Get metadata, metrics, params, tags and artifacts for a run. In the case where multiple metrics
with the same key are logged for a run, return only the value with the latest timestamp.
If there are multiple values with the latest timestamp, return the maximum of these values.
[apiInstance getExperimentRunWith:projectId
    experimentId:experimentId
    runId:runId
              completionHandler: ^(ExperimentRun output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var projectId = projectId_example; // {{String}} 
var experimentId = experimentId_example; // {{String}} ID of the associated experiment.
var runId = runId_example; // {{String}} ID of the ExperimentRun to fetch. Must be provided.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getExperimentRun(projectId, experimentId, runId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getExperimentRunExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var projectId = projectId_example;  // String | 
            var experimentId = experimentId_example;  // String | ID of the associated experiment.
            var runId = runId_example;  // String | ID of the ExperimentRun to fetch. Must be provided.

            try
            {
                // Get metadata, metrics, params, tags and artifacts for a run. In the case where multiple metrics
with the same key are logged for a run, return only the value with the latest timestamp.
If there are multiple values with the latest timestamp, return the maximum of these values.
                ExperimentRun result = apiInstance.getExperimentRun(projectId, experimentId, runId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.getExperimentRun: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$projectId = projectId_example; // String | 
$experimentId = experimentId_example; // String | ID of the associated experiment.
$runId = runId_example; // String | ID of the ExperimentRun to fetch. Must be provided.

try {
    $result = $api_instance->getExperimentRun($projectId, $experimentId, $runId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->getExperimentRun: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $projectId = projectId_example; # String | 
my $experimentId = experimentId_example; # String | ID of the associated experiment.
my $runId = runId_example; # String | ID of the ExperimentRun to fetch. Must be provided.

eval { 
    my $result = $api_instance->getExperimentRun(projectId => $projectId, experimentId => $experimentId, runId => $runId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->getExperimentRun: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
projectId = projectId_example # String | 
experimentId = experimentId_example # String | ID of the associated experiment.
runId = runId_example # String | ID of the ExperimentRun to fetch. Must be provided.

try: 
    # Get metadata, metrics, params, tags and artifacts for a run. In the case where multiple metrics
with the same key are logged for a run, return only the value with the latest timestamp.
If there are multiple values with the latest timestamp, return the maximum of these values.
    api_response = api_instance.get_experiment_run(projectId, experimentId, runId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->getExperimentRun: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
Required
experiment_id*
String
ID of the associated experiment.
Required
run_id*
String
ID of the ExperimentRun to fetch. Must be provided.
Required

Responses

Status: 200 - A successful response.

Status: default - An unexpected error response


getExperimentRunMetrics

Gets the all the recorded metrics for the key for a given run.


/api/v2/projects/{project_id}/experiments/{experiment_id}/runs/{run_id}/metrics/{metric_key}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/projects/{project_id}/experiments/{experiment_id}/runs/{run_id}/metrics/{metric_key}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | Project ID
        String experimentId = experimentId_example; // String | Experiment ID the run belongs to
        String runId = runId_example; // String | ID of the ExperimentRun
        String metricKey = metricKey_example; // String | metric key name.
        try {
            GetExperimentRunMetricsResponse result = apiInstance.getExperimentRunMetrics(projectId, experimentId, runId, metricKey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#getExperimentRunMetrics");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | Project ID
        String experimentId = experimentId_example; // String | Experiment ID the run belongs to
        String runId = runId_example; // String | ID of the ExperimentRun
        String metricKey = metricKey_example; // String | metric key name.
        try {
            GetExperimentRunMetricsResponse result = apiInstance.getExperimentRunMetrics(projectId, experimentId, runId, metricKey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#getExperimentRunMetrics");
            e.printStackTrace();
        }
    }
}
String *projectId = projectId_example; // Project ID
String *experimentId = experimentId_example; // Experiment ID the run belongs to
String *runId = runId_example; // ID of the ExperimentRun
String *metricKey = metricKey_example; // metric key name.

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Gets the all the recorded metrics for the key for a given run.
[apiInstance getExperimentRunMetricsWith:projectId
    experimentId:experimentId
    runId:runId
    metricKey:metricKey
              completionHandler: ^(GetExperimentRunMetricsResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var projectId = projectId_example; // {{String}} Project ID
var experimentId = experimentId_example; // {{String}} Experiment ID the run belongs to
var runId = runId_example; // {{String}} ID of the ExperimentRun
var metricKey = metricKey_example; // {{String}} metric key name.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getExperimentRunMetrics(projectId, experimentId, runId, metricKey, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getExperimentRunMetricsExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var projectId = projectId_example;  // String | Project ID
            var experimentId = experimentId_example;  // String | Experiment ID the run belongs to
            var runId = runId_example;  // String | ID of the ExperimentRun
            var metricKey = metricKey_example;  // String | metric key name.

            try
            {
                // Gets the all the recorded metrics for the key for a given run.
                GetExperimentRunMetricsResponse result = apiInstance.getExperimentRunMetrics(projectId, experimentId, runId, metricKey);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.getExperimentRunMetrics: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$projectId = projectId_example; // String | Project ID
$experimentId = experimentId_example; // String | Experiment ID the run belongs to
$runId = runId_example; // String | ID of the ExperimentRun
$metricKey = metricKey_example; // String | metric key name.

try {
    $result = $api_instance->getExperimentRunMetrics($projectId, $experimentId, $runId, $metricKey);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->getExperimentRunMetrics: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $projectId = projectId_example; # String | Project ID
my $experimentId = experimentId_example; # String | Experiment ID the run belongs to
my $runId = runId_example; # String | ID of the ExperimentRun
my $metricKey = metricKey_example; # String | metric key name.

eval { 
    my $result = $api_instance->getExperimentRunMetrics(projectId => $projectId, experimentId => $experimentId, runId => $runId, metricKey => $metricKey);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->getExperimentRunMetrics: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
projectId = projectId_example # String | Project ID
experimentId = experimentId_example # String | Experiment ID the run belongs to
runId = runId_example # String | ID of the ExperimentRun
metricKey = metricKey_example # String | metric key name.

try: 
    # Gets the all the recorded metrics for the key for a given run.
    api_response = api_instance.get_experiment_run_metrics(projectId, experimentId, runId, metricKey)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->getExperimentRunMetrics: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
Project ID
Required
experiment_id*
String
Experiment ID the run belongs to
Required
run_id*
String
ID of the ExperimentRun
Required
metric_key*
String
metric key name.
Required

Responses

Status: 200 - A successful response.

Status: default - An unexpected error response


getJob

Return one job.


/api/v2/projects/{project_id}/jobs/{job_id}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/projects/{project_id}/jobs/{job_id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | The public project identifier
        String jobId = jobId_example; // String | The public job identifier
        try {
            Job result = apiInstance.getJob(projectId, jobId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#getJob");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | The public project identifier
        String jobId = jobId_example; // String | The public job identifier
        try {
            Job result = apiInstance.getJob(projectId, jobId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#getJob");
            e.printStackTrace();
        }
    }
}
String *projectId = projectId_example; // The public project identifier
String *jobId = jobId_example; // The public job identifier

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Return one job.
[apiInstance getJobWith:projectId
    jobId:jobId
              completionHandler: ^(Job output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var projectId = projectId_example; // {{String}} The public project identifier
var jobId = jobId_example; // {{String}} The public job identifier

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getJob(projectId, jobId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getJobExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var projectId = projectId_example;  // String | The public project identifier
            var jobId = jobId_example;  // String | The public job identifier

            try
            {
                // Return one job.
                Job result = apiInstance.getJob(projectId, jobId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.getJob: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$projectId = projectId_example; // String | The public project identifier
$jobId = jobId_example; // String | The public job identifier

try {
    $result = $api_instance->getJob($projectId, $jobId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->getJob: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $projectId = projectId_example; # String | The public project identifier
my $jobId = jobId_example; # String | The public job identifier

eval { 
    my $result = $api_instance->getJob(projectId => $projectId, jobId => $jobId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->getJob: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
projectId = projectId_example # String | The public project identifier
jobId = jobId_example # String | The public job identifier

try: 
    # Return one job.
    api_response = api_instance.get_job(projectId, jobId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->getJob: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
The public project identifier
Required
job_id*
String
The public job identifier
Required

Responses

Status: 200 - A successful response.

Status: default - An unexpected error response


getJobRun

Gets a job run.


/api/v2/projects/{project_id}/jobs/{job_id}/runs/{run_id}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/projects/{project_id}/jobs/{job_id}/runs/{run_id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | ID of the project containing the job.
        String jobId = jobId_example; // String | ID of the job containing the job run.
        String runId = runId_example; // String | ID of the job run to get.
        try {
            JobRun result = apiInstance.getJobRun(projectId, jobId, runId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#getJobRun");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | ID of the project containing the job.
        String jobId = jobId_example; // String | ID of the job containing the job run.
        String runId = runId_example; // String | ID of the job run to get.
        try {
            JobRun result = apiInstance.getJobRun(projectId, jobId, runId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#getJobRun");
            e.printStackTrace();
        }
    }
}
String *projectId = projectId_example; // ID of the project containing the job.
String *jobId = jobId_example; // ID of the job containing the job run.
String *runId = runId_example; // ID of the job run to get.

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Gets a job run.
[apiInstance getJobRunWith:projectId
    jobId:jobId
    runId:runId
              completionHandler: ^(JobRun output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var projectId = projectId_example; // {{String}} ID of the project containing the job.
var jobId = jobId_example; // {{String}} ID of the job containing the job run.
var runId = runId_example; // {{String}} ID of the job run to get.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getJobRun(projectId, jobId, runId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getJobRunExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var projectId = projectId_example;  // String | ID of the project containing the job.
            var jobId = jobId_example;  // String | ID of the job containing the job run.
            var runId = runId_example;  // String | ID of the job run to get.

            try
            {
                // Gets a job run.
                JobRun result = apiInstance.getJobRun(projectId, jobId, runId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.getJobRun: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$projectId = projectId_example; // String | ID of the project containing the job.
$jobId = jobId_example; // String | ID of the job containing the job run.
$runId = runId_example; // String | ID of the job run to get.

try {
    $result = $api_instance->getJobRun($projectId, $jobId, $runId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->getJobRun: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $projectId = projectId_example; # String | ID of the project containing the job.
my $jobId = jobId_example; # String | ID of the job containing the job run.
my $runId = runId_example; # String | ID of the job run to get.

eval { 
    my $result = $api_instance->getJobRun(projectId => $projectId, jobId => $jobId, runId => $runId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->getJobRun: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
projectId = projectId_example # String | ID of the project containing the job.
jobId = jobId_example # String | ID of the job containing the job run.
runId = runId_example # String | ID of the job run to get.

try: 
    # Gets a job run.
    api_response = api_instance.get_job_run(projectId, jobId, runId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->getJobRun: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
ID of the project containing the job.
Required
job_id*
String
ID of the job containing the job run.
Required
run_id*
String
ID of the job run to get.
Required

Responses

Status: 200 - A successful response.

Status: default - An unexpected error response


getModel

Get a model.


/api/v2/projects/{project_id}/models/{model_id}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/projects/{project_id}/models/{model_id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | The project this model belongs to.
        String modelId = modelId_example; // String | The model's ID
        try {
            Model result = apiInstance.getModel(projectId, modelId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#getModel");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | The project this model belongs to.
        String modelId = modelId_example; // String | The model's ID
        try {
            Model result = apiInstance.getModel(projectId, modelId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#getModel");
            e.printStackTrace();
        }
    }
}
String *projectId = projectId_example; // The project this model belongs to.
String *modelId = modelId_example; // The model's ID

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Get a model.
[apiInstance getModelWith:projectId
    modelId:modelId
              completionHandler: ^(Model output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var projectId = projectId_example; // {{String}} The project this model belongs to.
var modelId = modelId_example; // {{String}} The model's ID

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getModel(projectId, modelId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getModelExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var projectId = projectId_example;  // String | The project this model belongs to.
            var modelId = modelId_example;  // String | The model's ID

            try
            {
                // Get a model.
                Model result = apiInstance.getModel(projectId, modelId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.getModel: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$projectId = projectId_example; // String | The project this model belongs to.
$modelId = modelId_example; // String | The model's ID

try {
    $result = $api_instance->getModel($projectId, $modelId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->getModel: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $projectId = projectId_example; # String | The project this model belongs to.
my $modelId = modelId_example; # String | The model's ID

eval { 
    my $result = $api_instance->getModel(projectId => $projectId, modelId => $modelId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->getModel: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
projectId = projectId_example # String | The project this model belongs to.
modelId = modelId_example # String | The model's ID

try: 
    # Get a model.
    api_response = api_instance.get_model(projectId, modelId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->getModel: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
The project this model belongs to.
Required
model_id*
String
The model's ID
Required

Responses

Status: 200 - A successful response.

Status: default - An unexpected error response


getModelBuild

Get a model build.


/api/v2/projects/{project_id}/models/{model_id}/builds/{build_id}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/projects/{project_id}/models/{model_id}/builds/{build_id}?registered_model_version_id="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | ID of the project containing the model.
        String modelId = modelId_example; // String | ID of the model containing the build.
        String buildId = buildId_example; // String | ID of the model build to get.
        String registeredModelVersionId = registeredModelVersionId_example; // String | ID of the registered model version.
        try {
            ModelBuild result = apiInstance.getModelBuild(projectId, modelId, buildId, registeredModelVersionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#getModelBuild");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | ID of the project containing the model.
        String modelId = modelId_example; // String | ID of the model containing the build.
        String buildId = buildId_example; // String | ID of the model build to get.
        String registeredModelVersionId = registeredModelVersionId_example; // String | ID of the registered model version.
        try {
            ModelBuild result = apiInstance.getModelBuild(projectId, modelId, buildId, registeredModelVersionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#getModelBuild");
            e.printStackTrace();
        }
    }
}
String *projectId = projectId_example; // ID of the project containing the model.
String *modelId = modelId_example; // ID of the model containing the build.
String *buildId = buildId_example; // ID of the model build to get.
String *registeredModelVersionId = registeredModelVersionId_example; // ID of the registered model version. (optional)

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Get a model build.
[apiInstance getModelBuildWith:projectId
    modelId:modelId
    buildId:buildId
    registeredModelVersionId:registeredModelVersionId
              completionHandler: ^(ModelBuild output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var projectId = projectId_example; // {{String}} ID of the project containing the model.
var modelId = modelId_example; // {{String}} ID of the model containing the build.
var buildId = buildId_example; // {{String}} ID of the model build to get.
var opts = { 
  'registeredModelVersionId': registeredModelVersionId_example // {{String}} ID of the registered model version.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getModelBuild(projectId, modelId, buildId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getModelBuildExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var projectId = projectId_example;  // String | ID of the project containing the model.
            var modelId = modelId_example;  // String | ID of the model containing the build.
            var buildId = buildId_example;  // String | ID of the model build to get.
            var registeredModelVersionId = registeredModelVersionId_example;  // String | ID of the registered model version. (optional) 

            try
            {
                // Get a model build.
                ModelBuild result = apiInstance.getModelBuild(projectId, modelId, buildId, registeredModelVersionId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.getModelBuild: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$projectId = projectId_example; // String | ID of the project containing the model.
$modelId = modelId_example; // String | ID of the model containing the build.
$buildId = buildId_example; // String | ID of the model build to get.
$registeredModelVersionId = registeredModelVersionId_example; // String | ID of the registered model version.

try {
    $result = $api_instance->getModelBuild($projectId, $modelId, $buildId, $registeredModelVersionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->getModelBuild: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $projectId = projectId_example; # String | ID of the project containing the model.
my $modelId = modelId_example; # String | ID of the model containing the build.
my $buildId = buildId_example; # String | ID of the model build to get.
my $registeredModelVersionId = registeredModelVersionId_example; # String | ID of the registered model version.

eval { 
    my $result = $api_instance->getModelBuild(projectId => $projectId, modelId => $modelId, buildId => $buildId, registeredModelVersionId => $registeredModelVersionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->getModelBuild: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
projectId = projectId_example # String | ID of the project containing the model.
modelId = modelId_example # String | ID of the model containing the build.
buildId = buildId_example # String | ID of the model build to get.
registeredModelVersionId = registeredModelVersionId_example # String | ID of the registered model version. (optional)

try: 
    # Get a model build.
    api_response = api_instance.get_model_build(projectId, modelId, buildId, registeredModelVersionId=registeredModelVersionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->getModelBuild: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
ID of the project containing the model.
Required
model_id*
String
ID of the model containing the build.
Required
build_id*
String
ID of the model build to get.
Required
Query parameters
Name Description
registered_model_version_id
String
ID of the registered model version.

Responses

Status: 200 - A successful response.

Status: default - An unexpected error response


getModelDeployment

Get a model deployment.


/api/v2/projects/{project_id}/models/{model_id}/builds/{build_id}/deployments/{deployment_id}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/projects/{project_id}/models/{model_id}/builds/{build_id}/deployments/{deployment_id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | ID of the project containing the model.
        String modelId = modelId_example; // String | ID of the model containing the deployment.
        String buildId = buildId_example; // String | ID of the model build containing the deployment.
        String deploymentId = deploymentId_example; // String | ID of the model deployment to get.
        try {
            ModelDeployment result = apiInstance.getModelDeployment(projectId, modelId, buildId, deploymentId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#getModelDeployment");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | ID of the project containing the model.
        String modelId = modelId_example; // String | ID of the model containing the deployment.
        String buildId = buildId_example; // String | ID of the model build containing the deployment.
        String deploymentId = deploymentId_example; // String | ID of the model deployment to get.
        try {
            ModelDeployment result = apiInstance.getModelDeployment(projectId, modelId, buildId, deploymentId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#getModelDeployment");
            e.printStackTrace();
        }
    }
}
String *projectId = projectId_example; // ID of the project containing the model.
String *modelId = modelId_example; // ID of the model containing the deployment.
String *buildId = buildId_example; // ID of the model build containing the deployment.
String *deploymentId = deploymentId_example; // ID of the model deployment to get.

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Get a model deployment.
[apiInstance getModelDeploymentWith:projectId
    modelId:modelId
    buildId:buildId
    deploymentId:deploymentId
              completionHandler: ^(ModelDeployment output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var projectId = projectId_example; // {{String}} ID of the project containing the model.
var modelId = modelId_example; // {{String}} ID of the model containing the deployment.
var buildId = buildId_example; // {{String}} ID of the model build containing the deployment.
var deploymentId = deploymentId_example; // {{String}} ID of the model deployment to get.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getModelDeployment(projectId, modelId, buildId, deploymentId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getModelDeploymentExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var projectId = projectId_example;  // String | ID of the project containing the model.
            var modelId = modelId_example;  // String | ID of the model containing the deployment.
            var buildId = buildId_example;  // String | ID of the model build containing the deployment.
            var deploymentId = deploymentId_example;  // String | ID of the model deployment to get.

            try
            {
                // Get a model deployment.
                ModelDeployment result = apiInstance.getModelDeployment(projectId, modelId, buildId, deploymentId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.getModelDeployment: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$projectId = projectId_example; // String | ID of the project containing the model.
$modelId = modelId_example; // String | ID of the model containing the deployment.
$buildId = buildId_example; // String | ID of the model build containing the deployment.
$deploymentId = deploymentId_example; // String | ID of the model deployment to get.

try {
    $result = $api_instance->getModelDeployment($projectId, $modelId, $buildId, $deploymentId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->getModelDeployment: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $projectId = projectId_example; # String | ID of the project containing the model.
my $modelId = modelId_example; # String | ID of the model containing the deployment.
my $buildId = buildId_example; # String | ID of the model build containing the deployment.
my $deploymentId = deploymentId_example; # String | ID of the model deployment to get.

eval { 
    my $result = $api_instance->getModelDeployment(projectId => $projectId, modelId => $modelId, buildId => $buildId, deploymentId => $deploymentId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->getModelDeployment: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
projectId = projectId_example # String | ID of the project containing the model.
modelId = modelId_example # String | ID of the model containing the deployment.
buildId = buildId_example # String | ID of the model build containing the deployment.
deploymentId = deploymentId_example # String | ID of the model deployment to get.

try: 
    # Get a model deployment.
    api_response = api_instance.get_model_deployment(projectId, modelId, buildId, deploymentId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->getModelDeployment: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
ID of the project containing the model.
Required
model_id*
String
ID of the model containing the deployment.
Required
build_id*
String
ID of the model build containing the deployment.
Required
deployment_id*
String
ID of the model deployment to get.
Required

Responses

Status: 200 - A successful response.

Status: default - An unexpected error response


getProject

Return one project.


/api/v2/projects/{project_id}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/projects/{project_id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | Identifier for a project, in the form of a 19 digit string.
Example: a1b2-c3d4-e5f6-g7h8
        try {
            Project result = apiInstance.getProject(projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#getProject");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | Identifier for a project, in the form of a 19 digit string.
Example: a1b2-c3d4-e5f6-g7h8
        try {
            Project result = apiInstance.getProject(projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#getProject");
            e.printStackTrace();
        }
    }
}
String *projectId = projectId_example; // Identifier for a project, in the form of a 19 digit string.
Example: a1b2-c3d4-e5f6-g7h8

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Return one project.
[apiInstance getProjectWith:projectId
              completionHandler: ^(Project output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var projectId = projectId_example; // {{String}} Identifier for a project, in the form of a 19 digit string.
Example: a1b2-c3d4-e5f6-g7h8

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getProject(projectId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getProjectExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var projectId = projectId_example;  // String | Identifier for a project, in the form of a 19 digit string.
Example: a1b2-c3d4-e5f6-g7h8

            try
            {
                // Return one project.
                Project result = apiInstance.getProject(projectId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.getProject: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$projectId = projectId_example; // String | Identifier for a project, in the form of a 19 digit string.
Example: a1b2-c3d4-e5f6-g7h8

try {
    $result = $api_instance->getProject($projectId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->getProject: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $projectId = projectId_example; # String | Identifier for a project, in the form of a 19 digit string.
Example: a1b2-c3d4-e5f6-g7h8

eval { 
    my $result = $api_instance->getProject(projectId => $projectId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->getProject: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
projectId = projectId_example # String | Identifier for a project, in the form of a 19 digit string.
Example: a1b2-c3d4-e5f6-g7h8

try: 
    # Return one project.
    api_response = api_instance.get_project(projectId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->getProject: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
Identifier for a project, in the form of a 19 digit string. Example: a1b2-c3d4-e5f6-g7h8
Required

Responses

Status: 200 - A successful response.

Status: default - An unexpected error response


getRegisteredModel

Get a registered model.


/api/v2/registry/models/{model_id}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/registry/models/{model_id}?search_filter=&sort=&page_size=&page_token="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String modelId = modelId_example; // String | Model ID.
        String searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filters:
earch_filter = {"version_number":"3"}
search_filter = {"creator_id":""} example: csso_mlengineer.
        String sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [created_at creator.email creator.name creator.username description kernel name script status updated_at].
where "+" means sort by ascending order, and "-" means sort by descending order.
:
supported sort=-created_at
supported sort=-versions.
        Integer pageSize = 56; // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
        String pageToken = pageToken_example; // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
        try {
            RegisteredModel result = apiInstance.getRegisteredModel(modelId, searchFilter, sort, pageSize, pageToken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#getRegisteredModel");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String modelId = modelId_example; // String | Model ID.
        String searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filters:
earch_filter = {"version_number":"3"}
search_filter = {"creator_id":""} example: csso_mlengineer.
        String sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [created_at creator.email creator.name creator.username description kernel name script status updated_at].
where "+" means sort by ascending order, and "-" means sort by descending order.
:
supported sort=-created_at
supported sort=-versions.
        Integer pageSize = 56; // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
        String pageToken = pageToken_example; // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
        try {
            RegisteredModel result = apiInstance.getRegisteredModel(modelId, searchFilter, sort, pageSize, pageToken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#getRegisteredModel");
            e.printStackTrace();
        }
    }
}
String *modelId = modelId_example; // Model ID.
String *searchFilter = searchFilter_example; // Search filter is an optional HTTP parameter to filter results by.
Supported search filters:
earch_filter = {"version_number":"3"}
search_filter = {"creator_id":""} example: csso_mlengineer. (optional)
String *sort = sort_example; // Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [created_at creator.email creator.name creator.username description kernel name script status updated_at].
where "+" means sort by ascending order, and "-" means sort by descending order.
:
supported sort=-created_at
supported sort=-versions. (optional)
Integer *pageSize = 56; // Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response. (optional)
String *pageToken = pageToken_example; // Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page. (optional)

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Get a registered model.
[apiInstance getRegisteredModelWith:modelId
    searchFilter:searchFilter
    sort:sort
    pageSize:pageSize
    pageToken:pageToken
              completionHandler: ^(RegisteredModel output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var modelId = modelId_example; // {{String}} Model ID.
var opts = { 
  'searchFilter': searchFilter_example, // {{String}} Search filter is an optional HTTP parameter to filter results by.
Supported search filters:
earch_filter = {"version_number":"3"}
search_filter = {"creator_id":""} example: csso_mlengineer.
  'sort': sort_example, // {{String}} Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [created_at creator.email creator.name creator.username description kernel name script status updated_at].
where "+" means sort by ascending order, and "-" means sort by descending order.
:
supported sort=-created_at
supported sort=-versions.
  'pageSize': 56, // {{Integer}} Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
  'pageToken': pageToken_example // {{String}} Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getRegisteredModel(modelId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getRegisteredModelExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var modelId = modelId_example;  // String | Model ID.
            var searchFilter = searchFilter_example;  // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filters:
earch_filter = {"version_number":"3"}
search_filter = {"creator_id":""} example: csso_mlengineer. (optional) 
            var sort = sort_example;  // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [created_at creator.email creator.name creator.username description kernel name script status updated_at].
where "+" means sort by ascending order, and "-" means sort by descending order.
:
supported sort=-created_at
supported sort=-versions. (optional) 
            var pageSize = 56;  // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response. (optional) 
            var pageToken = pageToken_example;  // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page. (optional) 

            try
            {
                // Get a registered model.
                RegisteredModel result = apiInstance.getRegisteredModel(modelId, searchFilter, sort, pageSize, pageToken);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.getRegisteredModel: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$modelId = modelId_example; // String | Model ID.
$searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filters:
earch_filter = {"version_number":"3"}
search_filter = {"creator_id":""} example: csso_mlengineer.
$sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [created_at creator.email creator.name creator.username description kernel name script status updated_at].
where "+" means sort by ascending order, and "-" means sort by descending order.
:
supported sort=-created_at
supported sort=-versions.
$pageSize = 56; // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
$pageToken = pageToken_example; // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.

try {
    $result = $api_instance->getRegisteredModel($modelId, $searchFilter, $sort, $pageSize, $pageToken);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->getRegisteredModel: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $modelId = modelId_example; # String | Model ID.
my $searchFilter = searchFilter_example; # String | Search filter is an optional HTTP parameter to filter results by.
Supported search filters:
earch_filter = {"version_number":"3"}
search_filter = {"creator_id":""} example: csso_mlengineer.
my $sort = sort_example; # String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [created_at creator.email creator.name creator.username description kernel name script status updated_at].
where "+" means sort by ascending order, and "-" means sort by descending order.
:
supported sort=-created_at
supported sort=-versions.
my $pageSize = 56; # Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
my $pageToken = pageToken_example; # String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.

eval { 
    my $result = $api_instance->getRegisteredModel(modelId => $modelId, searchFilter => $searchFilter, sort => $sort, pageSize => $pageSize, pageToken => $pageToken);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->getRegisteredModel: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
modelId = modelId_example # String | Model ID.
searchFilter = searchFilter_example # String | Search filter is an optional HTTP parameter to filter results by.
Supported search filters:
earch_filter = {"version_number":"3"}
search_filter = {"creator_id":""} example: csso_mlengineer. (optional)
sort = sort_example # String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [created_at creator.email creator.name creator.username description kernel name script status updated_at].
where "+" means sort by ascending order, and "-" means sort by descending order.
:
supported sort=-created_at
supported sort=-versions. (optional)
pageSize = 56 # Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response. (optional)
pageToken = pageToken_example # String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page. (optional)

try: 
    # Get a registered model.
    api_response = api_instance.get_registered_model(modelId, searchFilter=searchFilter, sort=sort, pageSize=pageSize, pageToken=pageToken)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->getRegisteredModel: %s\n" % e)

Parameters

Path parameters
Name Description
model_id*
String
Model ID.
Required
Query parameters
Name Description
search_filter
String
Search filter is an optional HTTP parameter to filter results by. Supported search filters: earch_filter = {"version_number":"3"} search_filter = {"creator_id":"<sso name or user name>"} example: csso_mlengineer.
sort
String
Sort is an optional HTTP parameter to sort results by. Supported sort keys are: [created_at creator.email creator.name creator.username description kernel name script status updated_at]. where "+" means sort by ascending order, and "-" means sort by descending order. : supported sort=-created_at supported sort=-versions.
page_size
Integer (int32)
Page size is an optional argument for number of entries to return in one page. If not specified, the server will determine a page size. If specified, must be respecified for further requests when using the provided next page token in the response.
page_token
String
Page token is an optional argument for specifying which page of results to get. If not specified, the first page will be returned, including a token for the next page. Will be empty if there is no next page.

Responses

Status: 200 - A successful response.

Status: default - An unexpected error response


getRegisteredModelVersion

Get a registered model version


/api/v2/registry/models/{model_id}/versions/{version_id}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/registry/models/{model_id}/versions/{version_id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String modelId = modelId_example; // String | Model ID.
        String versionId = versionId_example; // String | Model version ID.
        try {
            RegisteredModelVersion result = apiInstance.getRegisteredModelVersion(modelId, versionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#getRegisteredModelVersion");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String modelId = modelId_example; // String | Model ID.
        String versionId = versionId_example; // String | Model version ID.
        try {
            RegisteredModelVersion result = apiInstance.getRegisteredModelVersion(modelId, versionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#getRegisteredModelVersion");
            e.printStackTrace();
        }
    }
}
String *modelId = modelId_example; // Model ID.
String *versionId = versionId_example; // Model version ID.

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Get a registered model version
[apiInstance getRegisteredModelVersionWith:modelId
    versionId:versionId
              completionHandler: ^(RegisteredModelVersion output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var modelId = modelId_example; // {{String}} Model ID.
var versionId = versionId_example; // {{String}} Model version ID.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getRegisteredModelVersion(modelId, versionId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getRegisteredModelVersionExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var modelId = modelId_example;  // String | Model ID.
            var versionId = versionId_example;  // String | Model version ID.

            try
            {
                // Get a registered model version
                RegisteredModelVersion result = apiInstance.getRegisteredModelVersion(modelId, versionId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.getRegisteredModelVersion: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$modelId = modelId_example; // String | Model ID.
$versionId = versionId_example; // String | Model version ID.

try {
    $result = $api_instance->getRegisteredModelVersion($modelId, $versionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->getRegisteredModelVersion: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $modelId = modelId_example; # String | Model ID.
my $versionId = versionId_example; # String | Model version ID.

eval { 
    my $result = $api_instance->getRegisteredModelVersion(modelId => $modelId, versionId => $versionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->getRegisteredModelVersion: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
modelId = modelId_example # String | Model ID.
versionId = versionId_example # String | Model version ID.

try: 
    # Get a registered model version
    api_response = api_instance.get_registered_model_version(modelId, versionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->getRegisteredModelVersion: %s\n" % e)

Parameters

Path parameters
Name Description
model_id*
String
Model ID.
Required
version_id*
String
Model version ID.
Required

Responses

Status: 200 - A successful response.

Status: default - An unexpected error response


getShortUserByID


/api/v2/users/{user_id}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/users/{user_id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        Integer userId = 56; // Integer | 
        try {
            ShortUser result = apiInstance.getShortUserByID(userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#getShortUserByID");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        Integer userId = 56; // Integer | 
        try {
            ShortUser result = apiInstance.getShortUserByID(userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#getShortUserByID");
            e.printStackTrace();
        }
    }
}
Integer *userId = 56; // 

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

[apiInstance getShortUserByIDWith:userId
              completionHandler: ^(ShortUser output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var userId = 56; // {{Integer}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getShortUserByID(userId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getShortUserByIDExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var userId = 56;  // Integer | 

            try
            {
                ShortUser result = apiInstance.getShortUserByID(userId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.getShortUserByID: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$userId = 56; // Integer | 

try {
    $result = $api_instance->getShortUserByID($userId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->getShortUserByID: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $userId = 56; # Integer | 

eval { 
    my $result = $api_instance->getShortUserByID(userId => $userId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->getShortUserByID: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
userId = 56 # Integer | 

try: 
    api_response = api_instance.get_short_user_by_id(userId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->getShortUserByID: %s\n" % e)

Parameters

Path parameters
Name Description
user_id*
Integer (int32)
Required

Responses

Status: 200 - A successful response.

Status: default - An unexpected error response


handleCustomRuntimeUpload

Create a new Custom Runtime Addon from an uploaded tarball


/api/v2/runtimeaddons/custom

Usage and SDK Samples

curl -X POST\
-H "Content-Type: multipart/form-data"\
"//api/v2/runtimeaddons/custom"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        byte[] metadata = metadata_example; // byte[] | 
        byte[] tarball = tarball_example; // byte[] | 
        try {
            apiInstance.handleCustomRuntimeUpload(metadata, tarball);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#handleCustomRuntimeUpload");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        byte[] metadata = metadata_example; // byte[] | 
        byte[] tarball = tarball_example; // byte[] | 
        try {
            apiInstance.handleCustomRuntimeUpload(metadata, tarball);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#handleCustomRuntimeUpload");
            e.printStackTrace();
        }
    }
}
byte[] *metadata = metadata_example; // 
byte[] *tarball = tarball_example; // 

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Create a new Custom Runtime Addon from an uploaded tarball
[apiInstance handleCustomRuntimeUploadWith:metadata
    tarball:tarball
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var metadata = metadata_example; // {{byte[]}} 
var tarball = tarball_example; // {{byte[]}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.handleCustomRuntimeUpload(metadatatarball, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class handleCustomRuntimeUploadExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var metadata = metadata_example;  // byte[] | 
            var tarball = tarball_example;  // byte[] | 

            try
            {
                // Create a new Custom Runtime Addon from an uploaded tarball
                apiInstance.handleCustomRuntimeUpload(metadata, tarball);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.handleCustomRuntimeUpload: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$metadata = metadata_example; // byte[] | 
$tarball = tarball_example; // byte[] | 

try {
    $api_instance->handleCustomRuntimeUpload($metadata, $tarball);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->handleCustomRuntimeUpload: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $metadata = metadata_example; # byte[] | 
my $tarball = tarball_example; # byte[] | 

eval { 
    $api_instance->handleCustomRuntimeUpload(metadata => $metadata, tarball => $tarball);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->handleCustomRuntimeUpload: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
metadata = metadata_example # byte[] | 
tarball = tarball_example # byte[] | 

try: 
    # Create a new Custom Runtime Addon from an uploaded tarball
    api_instance.handle_custom_runtime_upload(metadata, tarball)
except ApiException as e:
    print("Exception when calling CMLServiceApi->handleCustomRuntimeUpload: %s\n" % e)

Parameters

Form parameters
Name Description
metadata*
byte[] (binary)
Required
tarball*
byte[] (binary)
Required

Responses

Status: 200 - A successful response.

Status: default - An unexpected error response.


listAllExperiments

Lists all experiments that belong to a user across all projects.


/api/v2/experiments

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/experiments?search_filter=&page_size=&page_token="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
        Integer pageSize = 56; // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
        String pageToken = pageToken_example; // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
        try {
            ListExperimentsResponse result = apiInstance.listAllExperiments(searchFilter, pageSize, pageToken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#listAllExperiments");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
        Integer pageSize = 56; // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
        String pageToken = pageToken_example; // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
        try {
            ListExperimentsResponse result = apiInstance.listAllExperiments(searchFilter, pageSize, pageToken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#listAllExperiments");
            e.printStackTrace();
        }
    }
}
String *searchFilter = searchFilter_example; // Search filter is an optional HTTP parameter to filter results by. (optional)
Integer *pageSize = 56; // Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response. (optional)
String *pageToken = pageToken_example; // Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page. (optional)

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Lists all experiments that belong to a user across all projects.
[apiInstance listAllExperimentsWith:searchFilter
    pageSize:pageSize
    pageToken:pageToken
              completionHandler: ^(ListExperimentsResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var opts = { 
  'searchFilter': searchFilter_example, // {{String}} Search filter is an optional HTTP parameter to filter results by.
  'pageSize': 56, // {{Integer}} Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
  'pageToken': pageToken_example // {{String}} Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listAllExperiments(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class listAllExperimentsExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var searchFilter = searchFilter_example;  // String | Search filter is an optional HTTP parameter to filter results by. (optional) 
            var pageSize = 56;  // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response. (optional) 
            var pageToken = pageToken_example;  // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page. (optional) 

            try
            {
                // Lists all experiments that belong to a user across all projects.
                ListExperimentsResponse result = apiInstance.listAllExperiments(searchFilter, pageSize, pageToken);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.listAllExperiments: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
$pageSize = 56; // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
$pageToken = pageToken_example; // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.

try {
    $result = $api_instance->listAllExperiments($searchFilter, $pageSize, $pageToken);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->listAllExperiments: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $searchFilter = searchFilter_example; # String | Search filter is an optional HTTP parameter to filter results by.
my $pageSize = 56; # Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
my $pageToken = pageToken_example; # String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.

eval { 
    my $result = $api_instance->listAllExperiments(searchFilter => $searchFilter, pageSize => $pageSize, pageToken => $pageToken);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->listAllExperiments: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
searchFilter = searchFilter_example # String | Search filter is an optional HTTP parameter to filter results by. (optional)
pageSize = 56 # Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response. (optional)
pageToken = pageToken_example # String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page. (optional)

try: 
    # Lists all experiments that belong to a user across all projects.
    api_response = api_instance.list_all_experiments(searchFilter=searchFilter, pageSize=pageSize, pageToken=pageToken)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->listAllExperiments: %s\n" % e)

Parameters

Query parameters
Name Description
search_filter
String
Search filter is an optional HTTP parameter to filter results by.
page_size
Integer (int32)
Page size is an optional argument for number of entries to return in one page. If not specified, the server will determine a page size. If specified, must be respecified for further requests when using the provided next page token in the response.
page_token
String
Page token is an optional argument for specifying which page of results to get. If not specified, the first page will be returned, including a token for the next page. Will be empty if there is no next page.

Responses

Status: 200 - A successful response.

Status: default - An unexpected error response


listAllJobs

Returns all jobs a user has access to.


/api/v2/jobs

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/jobs?search_filter=&page_size=&page_token="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [creator.email creator.name creator.username description kernel name paused script type].
For example:
  search_filter={"name":"foo","creator.name":"bar"},.
        Integer pageSize = 56; // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
        String pageToken = pageToken_example; // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
        try {
            ListJobsResponse result = apiInstance.listAllJobs(searchFilter, pageSize, pageToken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#listAllJobs");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [creator.email creator.name creator.username description kernel name paused script type].
For example:
  search_filter={"name":"foo","creator.name":"bar"},.
        Integer pageSize = 56; // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
        String pageToken = pageToken_example; // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
        try {
            ListJobsResponse result = apiInstance.listAllJobs(searchFilter, pageSize, pageToken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#listAllJobs");
            e.printStackTrace();
        }
    }
}
String *searchFilter = searchFilter_example; // Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [creator.email creator.name creator.username description kernel name paused script type].
For example:
  search_filter={"name":"foo","creator.name":"bar"},. (optional)
Integer *pageSize = 56; // Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response. (optional)
String *pageToken = pageToken_example; // Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page. (optional)

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Returns all jobs a user has access to.
[apiInstance listAllJobsWith:searchFilter
    pageSize:pageSize
    pageToken:pageToken
              completionHandler: ^(ListJobsResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var opts = { 
  'searchFilter': searchFilter_example, // {{String}} Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [creator.email creator.name creator.username description kernel name paused script type].
For example:
  search_filter={"name":"foo","creator.name":"bar"},.
  'pageSize': 56, // {{Integer}} Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
  'pageToken': pageToken_example // {{String}} Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listAllJobs(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class listAllJobsExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var searchFilter = searchFilter_example;  // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [creator.email creator.name creator.username description kernel name paused script type].
For example:
  search_filter={"name":"foo","creator.name":"bar"},. (optional) 
            var pageSize = 56;  // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response. (optional) 
            var pageToken = pageToken_example;  // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page. (optional) 

            try
            {
                // Returns all jobs a user has access to.
                ListJobsResponse result = apiInstance.listAllJobs(searchFilter, pageSize, pageToken);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.listAllJobs: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [creator.email creator.name creator.username description kernel name paused script type].
For example:
  search_filter={"name":"foo","creator.name":"bar"},.
$pageSize = 56; // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
$pageToken = pageToken_example; // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.

try {
    $result = $api_instance->listAllJobs($searchFilter, $pageSize, $pageToken);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->listAllJobs: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $searchFilter = searchFilter_example; # String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [creator.email creator.name creator.username description kernel name paused script type].
For example:
  search_filter={"name":"foo","creator.name":"bar"},.
my $pageSize = 56; # Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
my $pageToken = pageToken_example; # String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.

eval { 
    my $result = $api_instance->listAllJobs(searchFilter => $searchFilter, pageSize => $pageSize, pageToken => $pageToken);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->listAllJobs: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
searchFilter = searchFilter_example # String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [creator.email creator.name creator.username description kernel name paused script type].
For example:
  search_filter={"name":"foo","creator.name":"bar"},. (optional)
pageSize = 56 # Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response. (optional)
pageToken = pageToken_example # String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page. (optional)

try: 
    # Returns all jobs a user has access to.
    api_response = api_instance.list_all_jobs(searchFilter=searchFilter, pageSize=pageSize, pageToken=pageToken)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->listAllJobs: %s\n" % e)

Parameters

Query parameters
Name Description
search_filter
String
Search filter is an optional HTTP parameter to filter results by. Supported search filter keys are: [creator.email creator.name creator.username description kernel name paused script type]. For example: search_filter={"name":"foo","creator.name":"bar"},.
page_size
Integer (int32)
Page size is an optional argument for number of entries to return in one page. If not specified, the server will determine a page size. If specified, must be respecified for further requests when using the provided next page token in the response.
page_token
String
Page token is an optional argument for specifying which page of results to get. If not specified, the first page will be returned, including a token for the next page. Will be empty if there is no next page.

Responses

Status: 200 - A successful response.

Status: default - An unexpected error response


listAllModels

List all models that belong to a user across all projects.


/api/v2/models

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/models?search_filter=&page_size=&page_token="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String searchFilter = searchFilter_example; // String | 
        Integer pageSize = 56; // Integer | 
        String pageToken = pageToken_example; // String | 
        try {
            ListModelsResponse result = apiInstance.listAllModels(searchFilter, pageSize, pageToken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#listAllModels");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String searchFilter = searchFilter_example; // String | 
        Integer pageSize = 56; // Integer | 
        String pageToken = pageToken_example; // String | 
        try {
            ListModelsResponse result = apiInstance.listAllModels(searchFilter, pageSize, pageToken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#listAllModels");
            e.printStackTrace();
        }
    }
}
String *searchFilter = searchFilter_example; //  (optional)
Integer *pageSize = 56; //  (optional)
String *pageToken = pageToken_example; //  (optional)

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// List all models that belong to a user across all projects.
[apiInstance listAllModelsWith:searchFilter
    pageSize:pageSize
    pageToken:pageToken
              completionHandler: ^(ListModelsResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var opts = { 
  'searchFilter': searchFilter_example, // {{String}} 
  'pageSize': 56, // {{Integer}} 
  'pageToken': pageToken_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listAllModels(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class listAllModelsExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var searchFilter = searchFilter_example;  // String |  (optional) 
            var pageSize = 56;  // Integer |  (optional) 
            var pageToken = pageToken_example;  // String |  (optional) 

            try
            {
                // List all models that belong to a user across all projects.
                ListModelsResponse result = apiInstance.listAllModels(searchFilter, pageSize, pageToken);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.listAllModels: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$searchFilter = searchFilter_example; // String | 
$pageSize = 56; // Integer | 
$pageToken = pageToken_example; // String | 

try {
    $result = $api_instance->listAllModels($searchFilter, $pageSize, $pageToken);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->listAllModels: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $searchFilter = searchFilter_example; # String | 
my $pageSize = 56; # Integer | 
my $pageToken = pageToken_example; # String | 

eval { 
    my $result = $api_instance->listAllModels(searchFilter => $searchFilter, pageSize => $pageSize, pageToken => $pageToken);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->listAllModels: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
searchFilter = searchFilter_example # String |  (optional)
pageSize = 56 # Integer |  (optional)
pageToken = pageToken_example # String |  (optional)

try: 
    # List all models that belong to a user across all projects.
    api_response = api_instance.list_all_models(searchFilter=searchFilter, pageSize=pageSize, pageToken=pageToken)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->listAllModels: %s\n" % e)

Parameters

Query parameters
Name Description
search_filter
String
page_size
Integer (int32)
page_token
String

Responses

Status: 200 - A successful response.

Status: default - An unexpected error response


listAllRunAsMachineUserCollaborators


/api/v2/projects/{project_id}/machineusers

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/projects/{project_id}/machineusers?search_filter=&page_size=&page_token=&sort="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | 
        String searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
        Integer pageSize = 56; // Integer | page size of the response model build list.
        String pageToken = pageToken_example; // String | page token for specifying which page to return.
        String sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=.
        try {
            ListAllRunAsMachineUserCollaboratorsResponse result = apiInstance.listAllRunAsMachineUserCollaborators(projectId, searchFilter, pageSize, pageToken, sort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#listAllRunAsMachineUserCollaborators");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | 
        String searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
        Integer pageSize = 56; // Integer | page size of the response model build list.
        String pageToken = pageToken_example; // String | page token for specifying which page to return.
        String sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=.
        try {
            ListAllRunAsMachineUserCollaboratorsResponse result = apiInstance.listAllRunAsMachineUserCollaborators(projectId, searchFilter, pageSize, pageToken, sort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#listAllRunAsMachineUserCollaborators");
            e.printStackTrace();
        }
    }
}
String *projectId = projectId_example; // 
String *searchFilter = searchFilter_example; // Search filter is an optional HTTP parameter to filter results by. (optional)
Integer *pageSize = 56; // page size of the response model build list. (optional)
String *pageToken = pageToken_example; // page token for specifying which page to return. (optional)
String *sort = sort_example; // Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=. (optional)

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

[apiInstance listAllRunAsMachineUserCollaboratorsWith:projectId
    searchFilter:searchFilter
    pageSize:pageSize
    pageToken:pageToken
    sort:sort
              completionHandler: ^(ListAllRunAsMachineUserCollaboratorsResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var projectId = projectId_example; // {{String}} 
var opts = { 
  'searchFilter': searchFilter_example, // {{String}} Search filter is an optional HTTP parameter to filter results by.
  'pageSize': 56, // {{Integer}} page size of the response model build list.
  'pageToken': pageToken_example, // {{String}} page token for specifying which page to return.
  'sort': sort_example // {{String}} Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listAllRunAsMachineUserCollaborators(projectId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class listAllRunAsMachineUserCollaboratorsExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var projectId = projectId_example;  // String | 
            var searchFilter = searchFilter_example;  // String | Search filter is an optional HTTP parameter to filter results by. (optional) 
            var pageSize = 56;  // Integer | page size of the response model build list. (optional) 
            var pageToken = pageToken_example;  // String | page token for specifying which page to return. (optional) 
            var sort = sort_example;  // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=. (optional) 

            try
            {
                ListAllRunAsMachineUserCollaboratorsResponse result = apiInstance.listAllRunAsMachineUserCollaborators(projectId, searchFilter, pageSize, pageToken, sort);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.listAllRunAsMachineUserCollaborators: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$projectId = projectId_example; // String | 
$searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
$pageSize = 56; // Integer | page size of the response model build list.
$pageToken = pageToken_example; // String | page token for specifying which page to return.
$sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=.

try {
    $result = $api_instance->listAllRunAsMachineUserCollaborators($projectId, $searchFilter, $pageSize, $pageToken, $sort);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->listAllRunAsMachineUserCollaborators: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $projectId = projectId_example; # String | 
my $searchFilter = searchFilter_example; # String | Search filter is an optional HTTP parameter to filter results by.
my $pageSize = 56; # Integer | page size of the response model build list.
my $pageToken = pageToken_example; # String | page token for specifying which page to return.
my $sort = sort_example; # String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=.

eval { 
    my $result = $api_instance->listAllRunAsMachineUserCollaborators(projectId => $projectId, searchFilter => $searchFilter, pageSize => $pageSize, pageToken => $pageToken, sort => $sort);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->listAllRunAsMachineUserCollaborators: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
projectId = projectId_example # String | 
searchFilter = searchFilter_example # String | Search filter is an optional HTTP parameter to filter results by. (optional)
pageSize = 56 # Integer | page size of the response model build list. (optional)
pageToken = pageToken_example # String | page token for specifying which page to return. (optional)
sort = sort_example # String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=. (optional)

try: 
    api_response = api_instance.list_all_run_as_machine_user_collaborators(projectId, searchFilter=searchFilter, pageSize=pageSize, pageToken=pageToken, sort=sort)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->listAllRunAsMachineUserCollaborators: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
Required
Query parameters
Name Description
search_filter
String
Search filter is an optional HTTP parameter to filter results by.
page_size
Integer (int32)
page size of the response model build list.
page_token
String
page token for specifying which page to return.
sort
String
Sort is an optional HTTP parameter to sort results by. Supported sort keys are: []. where "+" means sort by ascending order, and "-" means sort by descending order. For example: sort=.

Responses

Status: 200 - A successful response.

Status: default - An unexpected error response


listApplications

List applications, optionally filtered, sorted, and paginated.


/api/v2/projects/{project_id}/applications

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/projects/{project_id}/applications?search_filter=&sort=&page_size=&page_token="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | The project's identifier
        String searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [bypass_authentication creator.email creator.name creator.username description kernel name script status subdomain]
where "status" can be one of the following: [running, stopping, stopped, starting, failed]
For example:
  search_filter = {"status":"running"}.
        String sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [created_at creator.email creator.name creator.username description kernel name script status updated_at].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=-updated_at,name.
        Integer pageSize = 56; // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
        String pageToken = pageToken_example; // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
        try {
            ListApplicationsResponse result = apiInstance.listApplications(projectId, searchFilter, sort, pageSize, pageToken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#listApplications");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | The project's identifier
        String searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [bypass_authentication creator.email creator.name creator.username description kernel name script status subdomain]
where "status" can be one of the following: [running, stopping, stopped, starting, failed]
For example:
  search_filter = {"status":"running"}.
        String sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [created_at creator.email creator.name creator.username description kernel name script status updated_at].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=-updated_at,name.
        Integer pageSize = 56; // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
        String pageToken = pageToken_example; // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
        try {
            ListApplicationsResponse result = apiInstance.listApplications(projectId, searchFilter, sort, pageSize, pageToken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#listApplications");
            e.printStackTrace();
        }
    }
}
String *projectId = projectId_example; // The project's identifier
String *searchFilter = searchFilter_example; // Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [bypass_authentication creator.email creator.name creator.username description kernel name script status subdomain]
where "status" can be one of the following: [running, stopping, stopped, starting, failed]
For example:
  search_filter = {"status":"running"}. (optional)
String *sort = sort_example; // Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [created_at creator.email creator.name creator.username description kernel name script status updated_at].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=-updated_at,name. (optional)
Integer *pageSize = 56; // Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response. (optional)
String *pageToken = pageToken_example; // Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page. (optional)

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// List applications, optionally filtered, sorted, and paginated.
[apiInstance listApplicationsWith:projectId
    searchFilter:searchFilter
    sort:sort
    pageSize:pageSize
    pageToken:pageToken
              completionHandler: ^(ListApplicationsResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var projectId = projectId_example; // {{String}} The project's identifier
var opts = { 
  'searchFilter': searchFilter_example, // {{String}} Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [bypass_authentication creator.email creator.name creator.username description kernel name script status subdomain]
where "status" can be one of the following: [running, stopping, stopped, starting, failed]
For example:
  search_filter = {"status":"running"}.
  'sort': sort_example, // {{String}} Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [created_at creator.email creator.name creator.username description kernel name script status updated_at].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=-updated_at,name.
  'pageSize': 56, // {{Integer}} Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
  'pageToken': pageToken_example // {{String}} Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listApplications(projectId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class listApplicationsExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var projectId = projectId_example;  // String | The project's identifier
            var searchFilter = searchFilter_example;  // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [bypass_authentication creator.email creator.name creator.username description kernel name script status subdomain]
where "status" can be one of the following: [running, stopping, stopped, starting, failed]
For example:
  search_filter = {"status":"running"}. (optional) 
            var sort = sort_example;  // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [created_at creator.email creator.name creator.username description kernel name script status updated_at].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=-updated_at,name. (optional) 
            var pageSize = 56;  // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response. (optional) 
            var pageToken = pageToken_example;  // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page. (optional) 

            try
            {
                // List applications, optionally filtered, sorted, and paginated.
                ListApplicationsResponse result = apiInstance.listApplications(projectId, searchFilter, sort, pageSize, pageToken);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.listApplications: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$projectId = projectId_example; // String | The project's identifier
$searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [bypass_authentication creator.email creator.name creator.username description kernel name script status subdomain]
where "status" can be one of the following: [running, stopping, stopped, starting, failed]
For example:
  search_filter = {"status":"running"}.
$sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [created_at creator.email creator.name creator.username description kernel name script status updated_at].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=-updated_at,name.
$pageSize = 56; // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
$pageToken = pageToken_example; // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.

try {
    $result = $api_instance->listApplications($projectId, $searchFilter, $sort, $pageSize, $pageToken);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->listApplications: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $projectId = projectId_example; # String | The project's identifier
my $searchFilter = searchFilter_example; # String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [bypass_authentication creator.email creator.name creator.username description kernel name script status subdomain]
where "status" can be one of the following: [running, stopping, stopped, starting, failed]
For example:
  search_filter = {"status":"running"}.
my $sort = sort_example; # String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [created_at creator.email creator.name creator.username description kernel name script status updated_at].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=-updated_at,name.
my $pageSize = 56; # Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
my $pageToken = pageToken_example; # String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.

eval { 
    my $result = $api_instance->listApplications(projectId => $projectId, searchFilter => $searchFilter, sort => $sort, pageSize => $pageSize, pageToken => $pageToken);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->listApplications: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
projectId = projectId_example # String | The project's identifier
searchFilter = searchFilter_example # String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [bypass_authentication creator.email creator.name creator.username description kernel name script status subdomain]
where "status" can be one of the following: [running, stopping, stopped, starting, failed]
For example:
  search_filter = {"status":"running"}. (optional)
sort = sort_example # String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [created_at creator.email creator.name creator.username description kernel name script status updated_at].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=-updated_at,name. (optional)
pageSize = 56 # Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response. (optional)
pageToken = pageToken_example # String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page. (optional)

try: 
    # List applications, optionally filtered, sorted, and paginated.
    api_response = api_instance.list_applications(projectId, searchFilter=searchFilter, sort=sort, pageSize=pageSize, pageToken=pageToken)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->listApplications: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
The project's identifier
Required
Query parameters
Name Description
search_filter
String
Search filter is an optional HTTP parameter to filter results by. Supported search filter keys are: [bypass_authentication creator.email creator.name creator.username description kernel name script status subdomain] where "status" can be one of the following: [running, stopping, stopped, starting, failed] For example: search_filter = {"status":"running"}.
sort
String
Sort is an optional HTTP parameter to sort results by. Supported sort keys are: [created_at creator.email creator.name creator.username description kernel name script status updated_at]. where "+" means sort by ascending order, and "-" means sort by descending order. For example: sort=-updated_at,name.
page_size
Integer (int32)
Page size is an optional argument for number of entries to return in one page. If not specified, the server will determine a page size. If specified, must be respecified for further requests when using the provided next page token in the response.
page_token
String
Page token is an optional argument for specifying which page of results to get. If not specified, the first page will be returned, including a token for the next page. Will be empty if there is no next page.

Responses

Status: 200 - A successful response.

Status: default - An unexpected error response


listExperimentRuns

Returns a list of Runs that belong to an experiment.


/api/v2/projects/{project_id}/experiments/{experiment_id}/runs

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/projects/{project_id}/experiments/{experiment_id}/runs?search_filter=&page_size=&page_token=&sort="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | The project to list experiment runs in.
        String experimentId = experimentId_example; // String | Experiment ID to search over.
        String searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [creator.email creator.name creator.username name status].
Dynamic search key words are supported for experiment runs.
Supported fields are [metrics tags params].
        Integer pageSize = 56; // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
        String pageToken = pageToken_example; // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
        String sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are:
[created_at creator.email creator.name creator.username name start_time].
It also supports dynamic sort for metrics, tags and params.
"+" means sort by ascending order, and "-" means sort by descending order.
        try {
            ListExperimentRunsResponse result = apiInstance.listExperimentRuns(projectId, experimentId, searchFilter, pageSize, pageToken, sort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#listExperimentRuns");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | The project to list experiment runs in.
        String experimentId = experimentId_example; // String | Experiment ID to search over.
        String searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [creator.email creator.name creator.username name status].
Dynamic search key words are supported for experiment runs.
Supported fields are [metrics tags params].
        Integer pageSize = 56; // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
        String pageToken = pageToken_example; // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
        String sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are:
[created_at creator.email creator.name creator.username name start_time].
It also supports dynamic sort for metrics, tags and params.
"+" means sort by ascending order, and "-" means sort by descending order.
        try {
            ListExperimentRunsResponse result = apiInstance.listExperimentRuns(projectId, experimentId, searchFilter, pageSize, pageToken, sort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#listExperimentRuns");
            e.printStackTrace();
        }
    }
}
String *projectId = projectId_example; // The project to list experiment runs in.
String *experimentId = experimentId_example; // Experiment ID to search over.
String *searchFilter = searchFilter_example; // Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [creator.email creator.name creator.username name status].
Dynamic search key words are supported for experiment runs.
Supported fields are [metrics tags params]. (optional)
Integer *pageSize = 56; // Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response. (optional)
String *pageToken = pageToken_example; // Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page. (optional)
String *sort = sort_example; // Sort is an optional HTTP parameter to sort results by.
Supported sort keys are:
[created_at creator.email creator.name creator.username name start_time].
It also supports dynamic sort for metrics, tags and params.
"+" means sort by ascending order, and "-" means sort by descending order. (optional)

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Returns a list of Runs that belong to an experiment.
[apiInstance listExperimentRunsWith:projectId
    experimentId:experimentId
    searchFilter:searchFilter
    pageSize:pageSize
    pageToken:pageToken
    sort:sort
              completionHandler: ^(ListExperimentRunsResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var projectId = projectId_example; // {{String}} The project to list experiment runs in.
var experimentId = experimentId_example; // {{String}} Experiment ID to search over.
var opts = { 
  'searchFilter': searchFilter_example, // {{String}} Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [creator.email creator.name creator.username name status].
Dynamic search key words are supported for experiment runs.
Supported fields are [metrics tags params].
  'pageSize': 56, // {{Integer}} Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
  'pageToken': pageToken_example, // {{String}} Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
  'sort': sort_example // {{String}} Sort is an optional HTTP parameter to sort results by.
Supported sort keys are:
[created_at creator.email creator.name creator.username name start_time].
It also supports dynamic sort for metrics, tags and params.
"+" means sort by ascending order, and "-" means sort by descending order.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listExperimentRuns(projectId, experimentId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class listExperimentRunsExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var projectId = projectId_example;  // String | The project to list experiment runs in.
            var experimentId = experimentId_example;  // String | Experiment ID to search over.
            var searchFilter = searchFilter_example;  // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [creator.email creator.name creator.username name status].
Dynamic search key words are supported for experiment runs.
Supported fields are [metrics tags params]. (optional) 
            var pageSize = 56;  // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response. (optional) 
            var pageToken = pageToken_example;  // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page. (optional) 
            var sort = sort_example;  // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are:
[created_at creator.email creator.name creator.username name start_time].
It also supports dynamic sort for metrics, tags and params.
"+" means sort by ascending order, and "-" means sort by descending order. (optional) 

            try
            {
                // Returns a list of Runs that belong to an experiment.
                ListExperimentRunsResponse result = apiInstance.listExperimentRuns(projectId, experimentId, searchFilter, pageSize, pageToken, sort);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.listExperimentRuns: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$projectId = projectId_example; // String | The project to list experiment runs in.
$experimentId = experimentId_example; // String | Experiment ID to search over.
$searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [creator.email creator.name creator.username name status].
Dynamic search key words are supported for experiment runs.
Supported fields are [metrics tags params].
$pageSize = 56; // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
$pageToken = pageToken_example; // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
$sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are:
[created_at creator.email creator.name creator.username name start_time].
It also supports dynamic sort for metrics, tags and params.
"+" means sort by ascending order, and "-" means sort by descending order.

try {
    $result = $api_instance->listExperimentRuns($projectId, $experimentId, $searchFilter, $pageSize, $pageToken, $sort);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->listExperimentRuns: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $projectId = projectId_example; # String | The project to list experiment runs in.
my $experimentId = experimentId_example; # String | Experiment ID to search over.
my $searchFilter = searchFilter_example; # String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [creator.email creator.name creator.username name status].
Dynamic search key words are supported for experiment runs.
Supported fields are [metrics tags params].
my $pageSize = 56; # Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
my $pageToken = pageToken_example; # String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
my $sort = sort_example; # String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are:
[created_at creator.email creator.name creator.username name start_time].
It also supports dynamic sort for metrics, tags and params.
"+" means sort by ascending order, and "-" means sort by descending order.

eval { 
    my $result = $api_instance->listExperimentRuns(projectId => $projectId, experimentId => $experimentId, searchFilter => $searchFilter, pageSize => $pageSize, pageToken => $pageToken, sort => $sort);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->listExperimentRuns: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
projectId = projectId_example # String | The project to list experiment runs in.
experimentId = experimentId_example # String | Experiment ID to search over.
searchFilter = searchFilter_example # String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [creator.email creator.name creator.username name status].
Dynamic search key words are supported for experiment runs.
Supported fields are [metrics tags params]. (optional)
pageSize = 56 # Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response. (optional)
pageToken = pageToken_example # String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page. (optional)
sort = sort_example # String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are:
[created_at creator.email creator.name creator.username name start_time].
It also supports dynamic sort for metrics, tags and params.
"+" means sort by ascending order, and "-" means sort by descending order. (optional)

try: 
    # Returns a list of Runs that belong to an experiment.
    api_response = api_instance.list_experiment_runs(projectId, experimentId, searchFilter=searchFilter, pageSize=pageSize, pageToken=pageToken, sort=sort)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->listExperimentRuns: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
The project to list experiment runs in.
Required
experiment_id*
String
Experiment ID to search over.
Required
Query parameters
Name Description
search_filter
String
Search filter is an optional HTTP parameter to filter results by. Supported search filter keys are: [creator.email creator.name creator.username name status]. Dynamic search key words are supported for experiment runs. Supported fields are [metrics tags params].
page_size
Integer (int32)
Page size is an optional argument for number of entries to return in one page. If not specified, the server will determine a page size. If specified, must be respecified for further requests when using the provided next page token in the response.
page_token
String
Page token is an optional argument for specifying which page of results to get. If not specified, the first page will be returned, including a token for the next page. Will be empty if there is no next page.
sort
String
Sort is an optional HTTP parameter to sort results by. Supported sort keys are: [created_at creator.email creator.name creator.username name start_time]. It also supports dynamic sort for metrics, tags and params. "+" means sort by ascending order, and "-" means sort by descending order.

Responses

Status: 200 - A successful response.

Status: default - An unexpected error response


listExperiments

List all experiments in a given project.


/api/v2/projects/{project_id}/experiments

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/projects/{project_id}/experiments?search_filter=&page_size=&page_token=&sort="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | 
        String searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
        Integer pageSize = 56; // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
        String pageToken = pageToken_example; // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
        String sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
        try {
            ListExperimentsResponse result = apiInstance.listExperiments(projectId, searchFilter, pageSize, pageToken, sort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#listExperiments");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | 
        String searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
        Integer pageSize = 56; // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
        String pageToken = pageToken_example; // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
        String sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
        try {
            ListExperimentsResponse result = apiInstance.listExperiments(projectId, searchFilter, pageSize, pageToken, sort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#listExperiments");
            e.printStackTrace();
        }
    }
}
String *projectId = projectId_example; // 
String *searchFilter = searchFilter_example; // Search filter is an optional HTTP parameter to filter results by. (optional)
Integer *pageSize = 56; // Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response. (optional)
String *pageToken = pageToken_example; // Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page. (optional)
String *sort = sort_example; // Sort is an optional HTTP parameter to sort results by. (optional)

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// List all experiments in a given project.
[apiInstance listExperimentsWith:projectId
    searchFilter:searchFilter
    pageSize:pageSize
    pageToken:pageToken
    sort:sort
              completionHandler: ^(ListExperimentsResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var projectId = projectId_example; // {{String}} 
var opts = { 
  'searchFilter': searchFilter_example, // {{String}} Search filter is an optional HTTP parameter to filter results by.
  'pageSize': 56, // {{Integer}} Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
  'pageToken': pageToken_example, // {{String}} Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
  'sort': sort_example // {{String}} Sort is an optional HTTP parameter to sort results by.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listExperiments(projectId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class listExperimentsExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var projectId = projectId_example;  // String | 
            var searchFilter = searchFilter_example;  // String | Search filter is an optional HTTP parameter to filter results by. (optional) 
            var pageSize = 56;  // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response. (optional) 
            var pageToken = pageToken_example;  // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page. (optional) 
            var sort = sort_example;  // String | Sort is an optional HTTP parameter to sort results by. (optional) 

            try
            {
                // List all experiments in a given project.
                ListExperimentsResponse result = apiInstance.listExperiments(projectId, searchFilter, pageSize, pageToken, sort);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.listExperiments: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$projectId = projectId_example; // String | 
$searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
$pageSize = 56; // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
$pageToken = pageToken_example; // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
$sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.

try {
    $result = $api_instance->listExperiments($projectId, $searchFilter, $pageSize, $pageToken, $sort);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->listExperiments: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $projectId = projectId_example; # String | 
my $searchFilter = searchFilter_example; # String | Search filter is an optional HTTP parameter to filter results by.
my $pageSize = 56; # Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
my $pageToken = pageToken_example; # String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
my $sort = sort_example; # String | Sort is an optional HTTP parameter to sort results by.

eval { 
    my $result = $api_instance->listExperiments(projectId => $projectId, searchFilter => $searchFilter, pageSize => $pageSize, pageToken => $pageToken, sort => $sort);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->listExperiments: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
projectId = projectId_example # String | 
searchFilter = searchFilter_example # String | Search filter is an optional HTTP parameter to filter results by. (optional)
pageSize = 56 # Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response. (optional)
pageToken = pageToken_example # String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page. (optional)
sort = sort_example # String | Sort is an optional HTTP parameter to sort results by. (optional)

try: 
    # List all experiments in a given project.
    api_response = api_instance.list_experiments(projectId, searchFilter=searchFilter, pageSize=pageSize, pageToken=pageToken, sort=sort)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->listExperiments: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
Required
Query parameters
Name Description
search_filter
String
Search filter is an optional HTTP parameter to filter results by.
page_size
Integer (int32)
Page size is an optional argument for number of entries to return in one page. If not specified, the server will determine a page size. If specified, must be respecified for further requests when using the provided next page token in the response.
page_token
String
Page token is an optional argument for specifying which page of results to get. If not specified, the first page will be returned, including a token for the next page. Will be empty if there is no next page.
sort
String
Sort is an optional HTTP parameter to sort results by.

Responses

Status: 200 - A successful response.

Status: default - An unexpected error response


listJobRuns

Lists job runs, optionally filtered, sorted, and paginated.


/api/v2/projects/{project_id}/jobs/{job_id}/runs

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/projects/{project_id}/jobs/{job_id}/runs?search_filter=&sort=&page_size=&page_token="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | ID of the project containing the job.
        String jobId = jobId_example; // String | ID of the job containing the job runs.
        String searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [creator.email creator.name creator.username description kernel name paused script type],
where "status" can be one of the following: [scheduling, running, stopping, stopped, succeeded, failed, timedout]
For example:
  search_filter={"status":"running","id": "1"}.
        String sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [created_at creator.email creator.name creator.username description kernel name paused script type updated_at]"
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=-updated_at,+name.
        Integer pageSize = 56; // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
        String pageToken = pageToken_example; // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
        try {
            ListJobRunsResponse result = apiInstance.listJobRuns(projectId, jobId, searchFilter, sort, pageSize, pageToken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#listJobRuns");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | ID of the project containing the job.
        String jobId = jobId_example; // String | ID of the job containing the job runs.
        String searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [creator.email creator.name creator.username description kernel name paused script type],
where "status" can be one of the following: [scheduling, running, stopping, stopped, succeeded, failed, timedout]
For example:
  search_filter={"status":"running","id": "1"}.
        String sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [created_at creator.email creator.name creator.username description kernel name paused script type updated_at]"
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=-updated_at,+name.
        Integer pageSize = 56; // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
        String pageToken = pageToken_example; // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
        try {
            ListJobRunsResponse result = apiInstance.listJobRuns(projectId, jobId, searchFilter, sort, pageSize, pageToken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#listJobRuns");
            e.printStackTrace();
        }
    }
}
String *projectId = projectId_example; // ID of the project containing the job.
String *jobId = jobId_example; // ID of the job containing the job runs.
String *searchFilter = searchFilter_example; // Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [creator.email creator.name creator.username description kernel name paused script type],
where "status" can be one of the following: [scheduling, running, stopping, stopped, succeeded, failed, timedout]
For example:
  search_filter={"status":"running","id": "1"}. (optional)
String *sort = sort_example; // Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [created_at creator.email creator.name creator.username description kernel name paused script type updated_at]"
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=-updated_at,+name. (optional)
Integer *pageSize = 56; // Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response. (optional)
String *pageToken = pageToken_example; // Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page. (optional)

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Lists job runs, optionally filtered, sorted, and paginated.
[apiInstance listJobRunsWith:projectId
    jobId:jobId
    searchFilter:searchFilter
    sort:sort
    pageSize:pageSize
    pageToken:pageToken
              completionHandler: ^(ListJobRunsResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var projectId = projectId_example; // {{String}} ID of the project containing the job.
var jobId = jobId_example; // {{String}} ID of the job containing the job runs.
var opts = { 
  'searchFilter': searchFilter_example, // {{String}} Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [creator.email creator.name creator.username description kernel name paused script type],
where "status" can be one of the following: [scheduling, running, stopping, stopped, succeeded, failed, timedout]
For example:
  search_filter={"status":"running","id": "1"}.
  'sort': sort_example, // {{String}} Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [created_at creator.email creator.name creator.username description kernel name paused script type updated_at]"
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=-updated_at,+name.
  'pageSize': 56, // {{Integer}} Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
  'pageToken': pageToken_example // {{String}} Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listJobRuns(projectId, jobId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class listJobRunsExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var projectId = projectId_example;  // String | ID of the project containing the job.
            var jobId = jobId_example;  // String | ID of the job containing the job runs.
            var searchFilter = searchFilter_example;  // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [creator.email creator.name creator.username description kernel name paused script type],
where "status" can be one of the following: [scheduling, running, stopping, stopped, succeeded, failed, timedout]
For example:
  search_filter={"status":"running","id": "1"}. (optional) 
            var sort = sort_example;  // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [created_at creator.email creator.name creator.username description kernel name paused script type updated_at]"
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=-updated_at,+name. (optional) 
            var pageSize = 56;  // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response. (optional) 
            var pageToken = pageToken_example;  // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page. (optional) 

            try
            {
                // Lists job runs, optionally filtered, sorted, and paginated.
                ListJobRunsResponse result = apiInstance.listJobRuns(projectId, jobId, searchFilter, sort, pageSize, pageToken);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.listJobRuns: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$projectId = projectId_example; // String | ID of the project containing the job.
$jobId = jobId_example; // String | ID of the job containing the job runs.
$searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [creator.email creator.name creator.username description kernel name paused script type],
where "status" can be one of the following: [scheduling, running, stopping, stopped, succeeded, failed, timedout]
For example:
  search_filter={"status":"running","id": "1"}.
$sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [created_at creator.email creator.name creator.username description kernel name paused script type updated_at]"
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=-updated_at,+name.
$pageSize = 56; // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
$pageToken = pageToken_example; // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.

try {
    $result = $api_instance->listJobRuns($projectId, $jobId, $searchFilter, $sort, $pageSize, $pageToken);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->listJobRuns: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $projectId = projectId_example; # String | ID of the project containing the job.
my $jobId = jobId_example; # String | ID of the job containing the job runs.
my $searchFilter = searchFilter_example; # String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [creator.email creator.name creator.username description kernel name paused script type],
where "status" can be one of the following: [scheduling, running, stopping, stopped, succeeded, failed, timedout]
For example:
  search_filter={"status":"running","id": "1"}.
my $sort = sort_example; # String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [created_at creator.email creator.name creator.username description kernel name paused script type updated_at]"
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=-updated_at,+name.
my $pageSize = 56; # Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
my $pageToken = pageToken_example; # String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.

eval { 
    my $result = $api_instance->listJobRuns(projectId => $projectId, jobId => $jobId, searchFilter => $searchFilter, sort => $sort, pageSize => $pageSize, pageToken => $pageToken);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->listJobRuns: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
projectId = projectId_example # String | ID of the project containing the job.
jobId = jobId_example # String | ID of the job containing the job runs.
searchFilter = searchFilter_example # String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [creator.email creator.name creator.username description kernel name paused script type],
where "status" can be one of the following: [scheduling, running, stopping, stopped, succeeded, failed, timedout]
For example:
  search_filter={"status":"running","id": "1"}. (optional)
sort = sort_example # String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [created_at creator.email creator.name creator.username description kernel name paused script type updated_at]"
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=-updated_at,+name. (optional)
pageSize = 56 # Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response. (optional)
pageToken = pageToken_example # String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page. (optional)

try: 
    # Lists job runs, optionally filtered, sorted, and paginated.
    api_response = api_instance.list_job_runs(projectId, jobId, searchFilter=searchFilter, sort=sort, pageSize=pageSize, pageToken=pageToken)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->listJobRuns: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
ID of the project containing the job.
Required
job_id*
String
ID of the job containing the job runs.
Required
Query parameters
Name Description
search_filter
String
Search filter is an optional HTTP parameter to filter results by. Supported search filter keys are: [creator.email creator.name creator.username description kernel name paused script type], where "status" can be one of the following: [scheduling, running, stopping, stopped, succeeded, failed, timedout] For example: search_filter={"status":"running","id": "1"}.
sort
String
Sort is an optional HTTP parameter to sort results by. Supported sort keys are: [created_at creator.email creator.name creator.username description kernel name paused script type updated_at]" where "+" means sort by ascending order, and "-" means sort by descending order. For example: sort=-updated_at,+name.
page_size
Integer (int32)
Page size is an optional argument for number of entries to return in one page. If not specified, the server will determine a page size. If specified, must be respecified for further requests when using the provided next page token in the response.
page_token
String
Page token is an optional argument for specifying which page of results to get. If not specified, the first page will be returned, including a token for the next page. Will be empty if there is no next page.

Responses

Status: 200 - A successful response.

Status: default - An unexpected error response


listJobs

Returns all jobs, optionally filtered, sorted, and paginated.


/api/v2/projects/{project_id}/jobs

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/projects/{project_id}/jobs?search_filter=&sort=&page_size=&page_token="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | The project's identifier
        String searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [creator.email creator.name creator.username description kernel name paused script type].
For example:
  search_filter={"name":"foo","creator.name":"bar"},.
        String sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [created_at creator.email creator.name creator.username description kernel name paused script type updated_at],
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=+name,-created_at.
        Integer pageSize = 56; // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
        String pageToken = pageToken_example; // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
        try {
            ListJobsResponse result = apiInstance.listJobs(projectId, searchFilter, sort, pageSize, pageToken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#listJobs");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | The project's identifier
        String searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [creator.email creator.name creator.username description kernel name paused script type].
For example:
  search_filter={"name":"foo","creator.name":"bar"},.
        String sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [created_at creator.email creator.name creator.username description kernel name paused script type updated_at],
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=+name,-created_at.
        Integer pageSize = 56; // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
        String pageToken = pageToken_example; // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
        try {
            ListJobsResponse result = apiInstance.listJobs(projectId, searchFilter, sort, pageSize, pageToken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#listJobs");
            e.printStackTrace();
        }
    }
}
String *projectId = projectId_example; // The project's identifier
String *searchFilter = searchFilter_example; // Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [creator.email creator.name creator.username description kernel name paused script type].
For example:
  search_filter={"name":"foo","creator.name":"bar"},. (optional)
String *sort = sort_example; // Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [created_at creator.email creator.name creator.username description kernel name paused script type updated_at],
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=+name,-created_at. (optional)
Integer *pageSize = 56; // Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response. (optional)
String *pageToken = pageToken_example; // Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page. (optional)

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Returns all jobs, optionally filtered, sorted, and paginated.
[apiInstance listJobsWith:projectId
    searchFilter:searchFilter
    sort:sort
    pageSize:pageSize
    pageToken:pageToken
              completionHandler: ^(ListJobsResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var projectId = projectId_example; // {{String}} The project's identifier
var opts = { 
  'searchFilter': searchFilter_example, // {{String}} Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [creator.email creator.name creator.username description kernel name paused script type].
For example:
  search_filter={"name":"foo","creator.name":"bar"},.
  'sort': sort_example, // {{String}} Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [created_at creator.email creator.name creator.username description kernel name paused script type updated_at],
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=+name,-created_at.
  'pageSize': 56, // {{Integer}} Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
  'pageToken': pageToken_example // {{String}} Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listJobs(projectId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class listJobsExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var projectId = projectId_example;  // String | The project's identifier
            var searchFilter = searchFilter_example;  // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [creator.email creator.name creator.username description kernel name paused script type].
For example:
  search_filter={"name":"foo","creator.name":"bar"},. (optional) 
            var sort = sort_example;  // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [created_at creator.email creator.name creator.username description kernel name paused script type updated_at],
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=+name,-created_at. (optional) 
            var pageSize = 56;  // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response. (optional) 
            var pageToken = pageToken_example;  // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page. (optional) 

            try
            {
                // Returns all jobs, optionally filtered, sorted, and paginated.
                ListJobsResponse result = apiInstance.listJobs(projectId, searchFilter, sort, pageSize, pageToken);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.listJobs: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$projectId = projectId_example; // String | The project's identifier
$searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [creator.email creator.name creator.username description kernel name paused script type].
For example:
  search_filter={"name":"foo","creator.name":"bar"},.
$sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [created_at creator.email creator.name creator.username description kernel name paused script type updated_at],
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=+name,-created_at.
$pageSize = 56; // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
$pageToken = pageToken_example; // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.

try {
    $result = $api_instance->listJobs($projectId, $searchFilter, $sort, $pageSize, $pageToken);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->listJobs: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $projectId = projectId_example; # String | The project's identifier
my $searchFilter = searchFilter_example; # String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [creator.email creator.name creator.username description kernel name paused script type].
For example:
  search_filter={"name":"foo","creator.name":"bar"},.
my $sort = sort_example; # String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [created_at creator.email creator.name creator.username description kernel name paused script type updated_at],
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=+name,-created_at.
my $pageSize = 56; # Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
my $pageToken = pageToken_example; # String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.

eval { 
    my $result = $api_instance->listJobs(projectId => $projectId, searchFilter => $searchFilter, sort => $sort, pageSize => $pageSize, pageToken => $pageToken);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->listJobs: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
projectId = projectId_example # String | The project's identifier
searchFilter = searchFilter_example # String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [creator.email creator.name creator.username description kernel name paused script type].
For example:
  search_filter={"name":"foo","creator.name":"bar"},. (optional)
sort = sort_example # String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [created_at creator.email creator.name creator.username description kernel name paused script type updated_at],
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=+name,-created_at. (optional)
pageSize = 56 # Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response. (optional)
pageToken = pageToken_example # String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page. (optional)

try: 
    # Returns all jobs, optionally filtered, sorted, and paginated.
    api_response = api_instance.list_jobs(projectId, searchFilter=searchFilter, sort=sort, pageSize=pageSize, pageToken=pageToken)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->listJobs: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
The project's identifier
Required
Query parameters
Name Description
search_filter
String
Search filter is an optional HTTP parameter to filter results by. Supported search filter keys are: [creator.email creator.name creator.username description kernel name paused script type]. For example: search_filter={"name":"foo","creator.name":"bar"},.
sort
String
Sort is an optional HTTP parameter to sort results by. Supported sort keys are: [created_at creator.email creator.name creator.username description kernel name paused script type updated_at], where "+" means sort by ascending order, and "-" means sort by descending order. For example: sort=+name,-created_at.
page_size
Integer (int32)
Page size is an optional argument for number of entries to return in one page. If not specified, the server will determine a page size. If specified, must be respecified for further requests when using the provided next page token in the response.
page_token
String
Page token is an optional argument for specifying which page of results to get. If not specified, the first page will be returned, including a token for the next page. Will be empty if there is no next page.

Responses

Status: 200 - A successful response.

Status: default - An unexpected error response


listModelBuilds

List model builds, optionally filtered, sorted, and paginated.


/api/v2/projects/{project_id}/models/{model_id}/builds

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/projects/{project_id}/models/{model_id}/builds?search_filter=&sort=&page_size=&page_token="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | ID of the project containing the model.
        String modelId = modelId_example; // String | ID of the model to get builds for.
        String searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [comment creator.email creator.name creator.username crn status],
where "status" can be one of [pending, succeeded, built, build failed, timedout, pushing, queued, unknown]
For example:
  search_filter={"comment":"foo","status":"pending"}.
        String sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [built_at comment created_at creator.email creator.name creator.username crn status updated_at].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=creator.email.
        Integer pageSize = 56; // Integer | page size of the response model build list.
        String pageToken = pageToken_example; // String | page token for specifying which page to return.
        try {
            ListModelBuildsResponse result = apiInstance.listModelBuilds(projectId, modelId, searchFilter, sort, pageSize, pageToken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#listModelBuilds");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | ID of the project containing the model.
        String modelId = modelId_example; // String | ID of the model to get builds for.
        String searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [comment creator.email creator.name creator.username crn status],
where "status" can be one of [pending, succeeded, built, build failed, timedout, pushing, queued, unknown]
For example:
  search_filter={"comment":"foo","status":"pending"}.
        String sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [built_at comment created_at creator.email creator.name creator.username crn status updated_at].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=creator.email.
        Integer pageSize = 56; // Integer | page size of the response model build list.
        String pageToken = pageToken_example; // String | page token for specifying which page to return.
        try {
            ListModelBuildsResponse result = apiInstance.listModelBuilds(projectId, modelId, searchFilter, sort, pageSize, pageToken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#listModelBuilds");
            e.printStackTrace();
        }
    }
}
String *projectId = projectId_example; // ID of the project containing the model.
String *modelId = modelId_example; // ID of the model to get builds for.
String *searchFilter = searchFilter_example; // Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [comment creator.email creator.name creator.username crn status],
where "status" can be one of [pending, succeeded, built, build failed, timedout, pushing, queued, unknown]
For example:
  search_filter={"comment":"foo","status":"pending"}. (optional)
String *sort = sort_example; // Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [built_at comment created_at creator.email creator.name creator.username crn status updated_at].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=creator.email. (optional)
Integer *pageSize = 56; // page size of the response model build list. (optional)
String *pageToken = pageToken_example; // page token for specifying which page to return. (optional)

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// List model builds, optionally filtered, sorted, and paginated.
[apiInstance listModelBuildsWith:projectId
    modelId:modelId
    searchFilter:searchFilter
    sort:sort
    pageSize:pageSize
    pageToken:pageToken
              completionHandler: ^(ListModelBuildsResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var projectId = projectId_example; // {{String}} ID of the project containing the model.
var modelId = modelId_example; // {{String}} ID of the model to get builds for.
var opts = { 
  'searchFilter': searchFilter_example, // {{String}} Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [comment creator.email creator.name creator.username crn status],
where "status" can be one of [pending, succeeded, built, build failed, timedout, pushing, queued, unknown]
For example:
  search_filter={"comment":"foo","status":"pending"}.
  'sort': sort_example, // {{String}} Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [built_at comment created_at creator.email creator.name creator.username crn status updated_at].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=creator.email.
  'pageSize': 56, // {{Integer}} page size of the response model build list.
  'pageToken': pageToken_example // {{String}} page token for specifying which page to return.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listModelBuilds(projectId, modelId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class listModelBuildsExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var projectId = projectId_example;  // String | ID of the project containing the model.
            var modelId = modelId_example;  // String | ID of the model to get builds for.
            var searchFilter = searchFilter_example;  // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [comment creator.email creator.name creator.username crn status],
where "status" can be one of [pending, succeeded, built, build failed, timedout, pushing, queued, unknown]
For example:
  search_filter={"comment":"foo","status":"pending"}. (optional) 
            var sort = sort_example;  // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [built_at comment created_at creator.email creator.name creator.username crn status updated_at].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=creator.email. (optional) 
            var pageSize = 56;  // Integer | page size of the response model build list. (optional) 
            var pageToken = pageToken_example;  // String | page token for specifying which page to return. (optional) 

            try
            {
                // List model builds, optionally filtered, sorted, and paginated.
                ListModelBuildsResponse result = apiInstance.listModelBuilds(projectId, modelId, searchFilter, sort, pageSize, pageToken);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.listModelBuilds: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$projectId = projectId_example; // String | ID of the project containing the model.
$modelId = modelId_example; // String | ID of the model to get builds for.
$searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [comment creator.email creator.name creator.username crn status],
where "status" can be one of [pending, succeeded, built, build failed, timedout, pushing, queued, unknown]
For example:
  search_filter={"comment":"foo","status":"pending"}.
$sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [built_at comment created_at creator.email creator.name creator.username crn status updated_at].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=creator.email.
$pageSize = 56; // Integer | page size of the response model build list.
$pageToken = pageToken_example; // String | page token for specifying which page to return.

try {
    $result = $api_instance->listModelBuilds($projectId, $modelId, $searchFilter, $sort, $pageSize, $pageToken);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->listModelBuilds: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $projectId = projectId_example; # String | ID of the project containing the model.
my $modelId = modelId_example; # String | ID of the model to get builds for.
my $searchFilter = searchFilter_example; # String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [comment creator.email creator.name creator.username crn status],
where "status" can be one of [pending, succeeded, built, build failed, timedout, pushing, queued, unknown]
For example:
  search_filter={"comment":"foo","status":"pending"}.
my $sort = sort_example; # String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [built_at comment created_at creator.email creator.name creator.username crn status updated_at].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=creator.email.
my $pageSize = 56; # Integer | page size of the response model build list.
my $pageToken = pageToken_example; # String | page token for specifying which page to return.

eval { 
    my $result = $api_instance->listModelBuilds(projectId => $projectId, modelId => $modelId, searchFilter => $searchFilter, sort => $sort, pageSize => $pageSize, pageToken => $pageToken);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->listModelBuilds: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
projectId = projectId_example # String | ID of the project containing the model.
modelId = modelId_example # String | ID of the model to get builds for.
searchFilter = searchFilter_example # String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [comment creator.email creator.name creator.username crn status],
where "status" can be one of [pending, succeeded, built, build failed, timedout, pushing, queued, unknown]
For example:
  search_filter={"comment":"foo","status":"pending"}. (optional)
sort = sort_example # String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [built_at comment created_at creator.email creator.name creator.username crn status updated_at].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=creator.email. (optional)
pageSize = 56 # Integer | page size of the response model build list. (optional)
pageToken = pageToken_example # String | page token for specifying which page to return. (optional)

try: 
    # List model builds, optionally filtered, sorted, and paginated.
    api_response = api_instance.list_model_builds(projectId, modelId, searchFilter=searchFilter, sort=sort, pageSize=pageSize, pageToken=pageToken)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->listModelBuilds: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
ID of the project containing the model.
Required
model_id*
String
ID of the model to get builds for.
Required
Query parameters
Name Description
search_filter
String
Search filter is an optional HTTP parameter to filter results by. Supported search filter keys are: [comment creator.email creator.name creator.username crn status], where "status" can be one of [pending, succeeded, built, build failed, timedout, pushing, queued, unknown] For example: search_filter={"comment":"foo","status":"pending"}.
sort
String
Sort is an optional HTTP parameter to sort results by. Supported sort keys are: [built_at comment created_at creator.email creator.name creator.username crn status updated_at]. where "+" means sort by ascending order, and "-" means sort by descending order. For example: sort=creator.email.
page_size
Integer (int32)
page size of the response model build list.
page_token
String
page token for specifying which page to return.

Responses

Status: 200 - A successful response.

Status: default - An unexpected error response


listModelDeployments

List model deployments, optionally filtered, sorted, and paginated.


/api/v2/projects/{project_id}/models/{model_id}/builds/{build_id}/deployments

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/projects/{project_id}/models/{model_id}/builds/{build_id}/deployments?search_filter=&page_size=&page_token=&sort="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | ID of the project containing the model.
        String modelId = modelId_example; // String | ID of the model to get deployments for.
        String buildId = buildId_example; // String | ID of the model build to get deployments for.
        String searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
        Integer pageSize = 56; // Integer | page size of the response model build list.
        String pageToken = pageToken_example; // String | page token for specifying which page to return.
        String sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=.
        try {
            ListModelDeploymentsResponse result = apiInstance.listModelDeployments(projectId, modelId, buildId, searchFilter, pageSize, pageToken, sort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#listModelDeployments");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | ID of the project containing the model.
        String modelId = modelId_example; // String | ID of the model to get deployments for.
        String buildId = buildId_example; // String | ID of the model build to get deployments for.
        String searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
        Integer pageSize = 56; // Integer | page size of the response model build list.
        String pageToken = pageToken_example; // String | page token for specifying which page to return.
        String sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=.
        try {
            ListModelDeploymentsResponse result = apiInstance.listModelDeployments(projectId, modelId, buildId, searchFilter, pageSize, pageToken, sort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#listModelDeployments");
            e.printStackTrace();
        }
    }
}
String *projectId = projectId_example; // ID of the project containing the model.
String *modelId = modelId_example; // ID of the model to get deployments for.
String *buildId = buildId_example; // ID of the model build to get deployments for.
String *searchFilter = searchFilter_example; // Search filter is an optional HTTP parameter to filter results by. (optional)
Integer *pageSize = 56; // page size of the response model build list. (optional)
String *pageToken = pageToken_example; // page token for specifying which page to return. (optional)
String *sort = sort_example; // Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=. (optional)

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// List model deployments, optionally filtered, sorted, and paginated.
[apiInstance listModelDeploymentsWith:projectId
    modelId:modelId
    buildId:buildId
    searchFilter:searchFilter
    pageSize:pageSize
    pageToken:pageToken
    sort:sort
              completionHandler: ^(ListModelDeploymentsResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var projectId = projectId_example; // {{String}} ID of the project containing the model.
var modelId = modelId_example; // {{String}} ID of the model to get deployments for.
var buildId = buildId_example; // {{String}} ID of the model build to get deployments for.
var opts = { 
  'searchFilter': searchFilter_example, // {{String}} Search filter is an optional HTTP parameter to filter results by.
  'pageSize': 56, // {{Integer}} page size of the response model build list.
  'pageToken': pageToken_example, // {{String}} page token for specifying which page to return.
  'sort': sort_example // {{String}} Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listModelDeployments(projectId, modelId, buildId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class listModelDeploymentsExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var projectId = projectId_example;  // String | ID of the project containing the model.
            var modelId = modelId_example;  // String | ID of the model to get deployments for.
            var buildId = buildId_example;  // String | ID of the model build to get deployments for.
            var searchFilter = searchFilter_example;  // String | Search filter is an optional HTTP parameter to filter results by. (optional) 
            var pageSize = 56;  // Integer | page size of the response model build list. (optional) 
            var pageToken = pageToken_example;  // String | page token for specifying which page to return. (optional) 
            var sort = sort_example;  // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=. (optional) 

            try
            {
                // List model deployments, optionally filtered, sorted, and paginated.
                ListModelDeploymentsResponse result = apiInstance.listModelDeployments(projectId, modelId, buildId, searchFilter, pageSize, pageToken, sort);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.listModelDeployments: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$projectId = projectId_example; // String | ID of the project containing the model.
$modelId = modelId_example; // String | ID of the model to get deployments for.
$buildId = buildId_example; // String | ID of the model build to get deployments for.
$searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
$pageSize = 56; // Integer | page size of the response model build list.
$pageToken = pageToken_example; // String | page token for specifying which page to return.
$sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=.

try {
    $result = $api_instance->listModelDeployments($projectId, $modelId, $buildId, $searchFilter, $pageSize, $pageToken, $sort);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->listModelDeployments: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $projectId = projectId_example; # String | ID of the project containing the model.
my $modelId = modelId_example; # String | ID of the model to get deployments for.
my $buildId = buildId_example; # String | ID of the model build to get deployments for.
my $searchFilter = searchFilter_example; # String | Search filter is an optional HTTP parameter to filter results by.
my $pageSize = 56; # Integer | page size of the response model build list.
my $pageToken = pageToken_example; # String | page token for specifying which page to return.
my $sort = sort_example; # String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=.

eval { 
    my $result = $api_instance->listModelDeployments(projectId => $projectId, modelId => $modelId, buildId => $buildId, searchFilter => $searchFilter, pageSize => $pageSize, pageToken => $pageToken, sort => $sort);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->listModelDeployments: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
projectId = projectId_example # String | ID of the project containing the model.
modelId = modelId_example # String | ID of the model to get deployments for.
buildId = buildId_example # String | ID of the model build to get deployments for.
searchFilter = searchFilter_example # String | Search filter is an optional HTTP parameter to filter results by. (optional)
pageSize = 56 # Integer | page size of the response model build list. (optional)
pageToken = pageToken_example # String | page token for specifying which page to return. (optional)
sort = sort_example # String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=. (optional)

try: 
    # List model deployments, optionally filtered, sorted, and paginated.
    api_response = api_instance.list_model_deployments(projectId, modelId, buildId, searchFilter=searchFilter, pageSize=pageSize, pageToken=pageToken, sort=sort)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->listModelDeployments: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
ID of the project containing the model.
Required
model_id*
String
ID of the model to get deployments for.
Required
build_id*
String
ID of the model build to get deployments for.
Required
Query parameters
Name Description
search_filter
String
Search filter is an optional HTTP parameter to filter results by.
page_size
Integer (int32)
page size of the response model build list.
page_token
String
page token for specifying which page to return.
sort
String
Sort is an optional HTTP parameter to sort results by. Supported sort keys are: []. where "+" means sort by ascending order, and "-" means sort by descending order. For example: sort=.

Responses

Status: 200 - A successful response.

Status: default - An unexpected error response


listModels

List models, optionally filtered, sorted, and paginated.


/api/v2/projects/{project_id}/models

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/projects/{project_id}/models?search_filter=&sort=&page_size=&page_token="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | The project to list models under.
        String searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [auth_enabled creator.email creator.name creator.username description name].
For example:
  search_filter={"name":"foo","auth_enabled":"f"}.
        String sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [auth_enabled created_at creator.email creator.name creator.username description name updated_at].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=created_at.
        Integer pageSize = 56; // Integer | page size of the response model build list.
        String pageToken = pageToken_example; // String | page token for specifying which page to return.
        try {
            ListModelsResponse result = apiInstance.listModels(projectId, searchFilter, sort, pageSize, pageToken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#listModels");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | The project to list models under.
        String searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [auth_enabled creator.email creator.name creator.username description name].
For example:
  search_filter={"name":"foo","auth_enabled":"f"}.
        String sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [auth_enabled created_at creator.email creator.name creator.username description name updated_at].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=created_at.
        Integer pageSize = 56; // Integer | page size of the response model build list.
        String pageToken = pageToken_example; // String | page token for specifying which page to return.
        try {
            ListModelsResponse result = apiInstance.listModels(projectId, searchFilter, sort, pageSize, pageToken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#listModels");
            e.printStackTrace();
        }
    }
}
String *projectId = projectId_example; // The project to list models under.
String *searchFilter = searchFilter_example; // Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [auth_enabled creator.email creator.name creator.username description name].
For example:
  search_filter={"name":"foo","auth_enabled":"f"}. (optional)
String *sort = sort_example; // Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [auth_enabled created_at creator.email creator.name creator.username description name updated_at].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=created_at. (optional)
Integer *pageSize = 56; // page size of the response model build list. (optional)
String *pageToken = pageToken_example; // page token for specifying which page to return. (optional)

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// List models, optionally filtered, sorted, and paginated.
[apiInstance listModelsWith:projectId
    searchFilter:searchFilter
    sort:sort
    pageSize:pageSize
    pageToken:pageToken
              completionHandler: ^(ListModelsResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var projectId = projectId_example; // {{String}} The project to list models under.
var opts = { 
  'searchFilter': searchFilter_example, // {{String}} Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [auth_enabled creator.email creator.name creator.username description name].
For example:
  search_filter={"name":"foo","auth_enabled":"f"}.
  'sort': sort_example, // {{String}} Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [auth_enabled created_at creator.email creator.name creator.username description name updated_at].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=created_at.
  'pageSize': 56, // {{Integer}} page size of the response model build list.
  'pageToken': pageToken_example // {{String}} page token for specifying which page to return.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listModels(projectId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class listModelsExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var projectId = projectId_example;  // String | The project to list models under.
            var searchFilter = searchFilter_example;  // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [auth_enabled creator.email creator.name creator.username description name].
For example:
  search_filter={"name":"foo","auth_enabled":"f"}. (optional) 
            var sort = sort_example;  // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [auth_enabled created_at creator.email creator.name creator.username description name updated_at].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=created_at. (optional) 
            var pageSize = 56;  // Integer | page size of the response model build list. (optional) 
            var pageToken = pageToken_example;  // String | page token for specifying which page to return. (optional) 

            try
            {
                // List models, optionally filtered, sorted, and paginated.
                ListModelsResponse result = apiInstance.listModels(projectId, searchFilter, sort, pageSize, pageToken);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.listModels: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$projectId = projectId_example; // String | The project to list models under.
$searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [auth_enabled creator.email creator.name creator.username description name].
For example:
  search_filter={"name":"foo","auth_enabled":"f"}.
$sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [auth_enabled created_at creator.email creator.name creator.username description name updated_at].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=created_at.
$pageSize = 56; // Integer | page size of the response model build list.
$pageToken = pageToken_example; // String | page token for specifying which page to return.

try {
    $result = $api_instance->listModels($projectId, $searchFilter, $sort, $pageSize, $pageToken);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->listModels: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $projectId = projectId_example; # String | The project to list models under.
my $searchFilter = searchFilter_example; # String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [auth_enabled creator.email creator.name creator.username description name].
For example:
  search_filter={"name":"foo","auth_enabled":"f"}.
my $sort = sort_example; # String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [auth_enabled created_at creator.email creator.name creator.username description name updated_at].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=created_at.
my $pageSize = 56; # Integer | page size of the response model build list.
my $pageToken = pageToken_example; # String | page token for specifying which page to return.

eval { 
    my $result = $api_instance->listModels(projectId => $projectId, searchFilter => $searchFilter, sort => $sort, pageSize => $pageSize, pageToken => $pageToken);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->listModels: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
projectId = projectId_example # String | The project to list models under.
searchFilter = searchFilter_example # String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [auth_enabled creator.email creator.name creator.username description name].
For example:
  search_filter={"name":"foo","auth_enabled":"f"}. (optional)
sort = sort_example # String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [auth_enabled created_at creator.email creator.name creator.username description name updated_at].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=created_at. (optional)
pageSize = 56 # Integer | page size of the response model build list. (optional)
pageToken = pageToken_example # String | page token for specifying which page to return. (optional)

try: 
    # List models, optionally filtered, sorted, and paginated.
    api_response = api_instance.list_models(projectId, searchFilter=searchFilter, sort=sort, pageSize=pageSize, pageToken=pageToken)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->listModels: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
The project to list models under.
Required
Query parameters
Name Description
search_filter
String
Search filter is an optional HTTP parameter to filter results by. Supported search filter keys are: [auth_enabled creator.email creator.name creator.username description name]. For example: search_filter={"name":"foo","auth_enabled":"f"}.
sort
String
Sort is an optional HTTP parameter to sort results by. Supported sort keys are: [auth_enabled created_at creator.email creator.name creator.username description name updated_at]. where "+" means sort by ascending order, and "-" means sort by descending order. For example: sort=created_at.
page_size
Integer (int32)
page size of the response model build list.
page_token
String
page token for specifying which page to return.

Responses

Status: 200 - A successful response.

Status: default - An unexpected error response


listNewsFeeds

List the newsfeeds, optionally filtered, sorted, and paginated.


/api/v2/newsfeeds/{category}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/newsfeeds/{category}?page_size=&page_token="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String category = category_example; // String | 
        Integer pageSize = 56; // Integer | 
        String pageToken = pageToken_example; // String | 
        try {
            ListNewsFeedsResponse result = apiInstance.listNewsFeeds(category, pageSize, pageToken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#listNewsFeeds");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String category = category_example; // String | 
        Integer pageSize = 56; // Integer | 
        String pageToken = pageToken_example; // String | 
        try {
            ListNewsFeedsResponse result = apiInstance.listNewsFeeds(category, pageSize, pageToken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#listNewsFeeds");
            e.printStackTrace();
        }
    }
}
String *category = category_example; // 
Integer *pageSize = 56; //  (optional)
String *pageToken = pageToken_example; //  (optional)

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// List the newsfeeds, optionally filtered, sorted, and paginated.
[apiInstance listNewsFeedsWith:category
    pageSize:pageSize
    pageToken:pageToken
              completionHandler: ^(ListNewsFeedsResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var category = category_example; // {{String}} 
var opts = { 
  'pageSize': 56, // {{Integer}} 
  'pageToken': pageToken_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listNewsFeeds(category, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class listNewsFeedsExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var category = category_example;  // String | 
            var pageSize = 56;  // Integer |  (optional) 
            var pageToken = pageToken_example;  // String |  (optional) 

            try
            {
                // List the newsfeeds, optionally filtered, sorted, and paginated.
                ListNewsFeedsResponse result = apiInstance.listNewsFeeds(category, pageSize, pageToken);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.listNewsFeeds: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$category = category_example; // String | 
$pageSize = 56; // Integer | 
$pageToken = pageToken_example; // String | 

try {
    $result = $api_instance->listNewsFeeds($category, $pageSize, $pageToken);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->listNewsFeeds: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $category = category_example; # String | 
my $pageSize = 56; # Integer | 
my $pageToken = pageToken_example; # String | 

eval { 
    my $result = $api_instance->listNewsFeeds(category => $category, pageSize => $pageSize, pageToken => $pageToken);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->listNewsFeeds: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
category = category_example # String | 
pageSize = 56 # Integer |  (optional)
pageToken = pageToken_example # String |  (optional)

try: 
    # List the newsfeeds, optionally filtered, sorted, and paginated.
    api_response = api_instance.list_news_feeds(category, pageSize=pageSize, pageToken=pageToken)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->listNewsFeeds: %s\n" % e)

Parameters

Path parameters
Name Description
category*
String
Required
Query parameters
Name Description
page_size
Integer (int32)
page_token
String

Responses

Status: 200 - A successful response.

Status: default - An unexpected error response


listProjectCollaborators

List project collaborators.


/api/v2/projects/{project_id}/collaborators

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/projects/{project_id}/collaborators?search_filter=&sort=&page_size=&page_token="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | The identifier of the project.
        String searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [username, permission].
For example:
  search_filter={"username":"foo", "permission": "read"},.
        String sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [username, permission].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=-username,+permission.
        Integer pageSize = 56; // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
        String pageToken = pageToken_example; // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
        try {
            ListProjectCollaboratorsResponse result = apiInstance.listProjectCollaborators(projectId, searchFilter, sort, pageSize, pageToken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#listProjectCollaborators");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | The identifier of the project.
        String searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [username, permission].
For example:
  search_filter={"username":"foo", "permission": "read"},.
        String sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [username, permission].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=-username,+permission.
        Integer pageSize = 56; // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
        String pageToken = pageToken_example; // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
        try {
            ListProjectCollaboratorsResponse result = apiInstance.listProjectCollaborators(projectId, searchFilter, sort, pageSize, pageToken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#listProjectCollaborators");
            e.printStackTrace();
        }
    }
}
String *projectId = projectId_example; // The identifier of the project.
String *searchFilter = searchFilter_example; // Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [username, permission].
For example:
  search_filter={"username":"foo", "permission": "read"},. (optional)
String *sort = sort_example; // Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [username, permission].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=-username,+permission. (optional)
Integer *pageSize = 56; // Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response. (optional)
String *pageToken = pageToken_example; // Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page. (optional)

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// List project collaborators.
[apiInstance listProjectCollaboratorsWith:projectId
    searchFilter:searchFilter
    sort:sort
    pageSize:pageSize
    pageToken:pageToken
              completionHandler: ^(ListProjectCollaboratorsResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var projectId = projectId_example; // {{String}} The identifier of the project.
var opts = { 
  'searchFilter': searchFilter_example, // {{String}} Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [username, permission].
For example:
  search_filter={"username":"foo", "permission": "read"},.
  'sort': sort_example, // {{String}} Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [username, permission].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=-username,+permission.
  'pageSize': 56, // {{Integer}} Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
  'pageToken': pageToken_example // {{String}} Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listProjectCollaborators(projectId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class listProjectCollaboratorsExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var projectId = projectId_example;  // String | The identifier of the project.
            var searchFilter = searchFilter_example;  // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [username, permission].
For example:
  search_filter={"username":"foo", "permission": "read"},. (optional) 
            var sort = sort_example;  // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [username, permission].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=-username,+permission. (optional) 
            var pageSize = 56;  // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response. (optional) 
            var pageToken = pageToken_example;  // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page. (optional) 

            try
            {
                // List project collaborators.
                ListProjectCollaboratorsResponse result = apiInstance.listProjectCollaborators(projectId, searchFilter, sort, pageSize, pageToken);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.listProjectCollaborators: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$projectId = projectId_example; // String | The identifier of the project.
$searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [username, permission].
For example:
  search_filter={"username":"foo", "permission": "read"},.
$sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [username, permission].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=-username,+permission.
$pageSize = 56; // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
$pageToken = pageToken_example; // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.

try {
    $result = $api_instance->listProjectCollaborators($projectId, $searchFilter, $sort, $pageSize, $pageToken);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->listProjectCollaborators: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $projectId = projectId_example; # String | The identifier of the project.
my $searchFilter = searchFilter_example; # String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [username, permission].
For example:
  search_filter={"username":"foo", "permission": "read"},.
my $sort = sort_example; # String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [username, permission].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=-username,+permission.
my $pageSize = 56; # Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
my $pageToken = pageToken_example; # String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.

eval { 
    my $result = $api_instance->listProjectCollaborators(projectId => $projectId, searchFilter => $searchFilter, sort => $sort, pageSize => $pageSize, pageToken => $pageToken);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->listProjectCollaborators: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
projectId = projectId_example # String | The identifier of the project.
searchFilter = searchFilter_example # String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [username, permission].
For example:
  search_filter={"username":"foo", "permission": "read"},. (optional)
sort = sort_example # String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [username, permission].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=-username,+permission. (optional)
pageSize = 56 # Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response. (optional)
pageToken = pageToken_example # String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page. (optional)

try: 
    # List project collaborators.
    api_response = api_instance.list_project_collaborators(projectId, searchFilter=searchFilter, sort=sort, pageSize=pageSize, pageToken=pageToken)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->listProjectCollaborators: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
The identifier of the project.
Required
Query parameters
Name Description
search_filter
String
Search filter is an optional HTTP parameter to filter results by. Supported search filter keys are: [username, permission]. For example: search_filter={"username":"foo", "permission": "read"},.
sort
String
Sort is an optional HTTP parameter to sort results by. Supported sort keys are: [username, permission]. where "+" means sort by ascending order, and "-" means sort by descending order. For example: sort=-username,+permission.
page_size
Integer (int32)
Page size is an optional argument for number of entries to return in one page. If not specified, the server will determine a page size. If specified, must be respecified for further requests when using the provided next page token in the response.
page_token
String
Page token is an optional argument for specifying which page of results to get. If not specified, the first page will be returned, including a token for the next page. Will be empty if there is no next page.

Responses

Status: 200 - A successful response.

Status: default - An unexpected error response


listProjectFiles

List files/subdirectories at a specified path


/api/v2/projects/{project_id}/files/{path}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/projects/{project_id}/files/{path}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | The identifier of the project that contains the files to list.
        String path = path_example; // String | Path to list, relative to project root (/home/cdsw)
        try {
            ListProjectFilesResponse result = apiInstance.listProjectFiles(projectId, path);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#listProjectFiles");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | The identifier of the project that contains the files to list.
        String path = path_example; // String | Path to list, relative to project root (/home/cdsw)
        try {
            ListProjectFilesResponse result = apiInstance.listProjectFiles(projectId, path);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#listProjectFiles");
            e.printStackTrace();
        }
    }
}
String *projectId = projectId_example; // The identifier of the project that contains the files to list.
String *path = path_example; // Path to list, relative to project root (/home/cdsw)

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// List files/subdirectories at a specified path
[apiInstance listProjectFilesWith:projectId
    path:path
              completionHandler: ^(ListProjectFilesResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var projectId = projectId_example; // {{String}} The identifier of the project that contains the files to list.
var path = path_example; // {{String}} Path to list, relative to project root (/home/cdsw)

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listProjectFiles(projectId, path, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class listProjectFilesExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var projectId = projectId_example;  // String | The identifier of the project that contains the files to list.
            var path = path_example;  // String | Path to list, relative to project root (/home/cdsw)

            try
            {
                // List files/subdirectories at a specified path
                ListProjectFilesResponse result = apiInstance.listProjectFiles(projectId, path);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.listProjectFiles: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$projectId = projectId_example; // String | The identifier of the project that contains the files to list.
$path = path_example; // String | Path to list, relative to project root (/home/cdsw)

try {
    $result = $api_instance->listProjectFiles($projectId, $path);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->listProjectFiles: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $projectId = projectId_example; # String | The identifier of the project that contains the files to list.
my $path = path_example; # String | Path to list, relative to project root (/home/cdsw)

eval { 
    my $result = $api_instance->listProjectFiles(projectId => $projectId, path => $path);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->listProjectFiles: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
projectId = projectId_example # String | The identifier of the project that contains the files to list.
path = path_example # String | Path to list, relative to project root (/home/cdsw)

try: 
    # List files/subdirectories at a specified path
    api_response = api_instance.list_project_files(projectId, path)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->listProjectFiles: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
The identifier of the project that contains the files to list.
Required
path*
String
Path to list, relative to project root (/home/cdsw)
Required

Responses

Status: 200 - A successful response.

Status: default - An unexpected error response


listProjects

Return all projects, optionally filtered, sorted, and paginated.


/api/v2/projects

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/projects?search_filter=&sort=&page_size=&page_token=&include_public_projects=&include_all_projects="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [creator.email creator.name creator.username description name owner.email owner.name owner.username].
For example:
  search_filter={"name":"foo","creator.name":"bar"},.
        String sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [created_at creator.email creator.name creator.username description name owner.email owner.name owner.username updated_at].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=-updated_at,+name.
        Integer pageSize = 56; // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
        String pageToken = pageToken_example; // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
        Boolean includePublicProjects = true; // Boolean | Default is false. If include_public_projects is set to true, then it will return
all projects user has access to, including public projects.
        Boolean includeAllProjects = true; // Boolean | Default is false. If include_all_projects is set to true, then it will return
all projects in the workspace if user is a site admin. If user is not a site admin,
then it will be equivalent to making use of flag include_public_projects and will return
all projects user has access to, including public projects.
        try {
            ListProjectsResponse result = apiInstance.listProjects(searchFilter, sort, pageSize, pageToken, includePublicProjects, includeAllProjects);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#listProjects");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [creator.email creator.name creator.username description name owner.email owner.name owner.username].
For example:
  search_filter={"name":"foo","creator.name":"bar"},.
        String sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [created_at creator.email creator.name creator.username description name owner.email owner.name owner.username updated_at].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=-updated_at,+name.
        Integer pageSize = 56; // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
        String pageToken = pageToken_example; // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
        Boolean includePublicProjects = true; // Boolean | Default is false. If include_public_projects is set to true, then it will return
all projects user has access to, including public projects.
        Boolean includeAllProjects = true; // Boolean | Default is false. If include_all_projects is set to true, then it will return
all projects in the workspace if user is a site admin. If user is not a site admin,
then it will be equivalent to making use of flag include_public_projects and will return
all projects user has access to, including public projects.
        try {
            ListProjectsResponse result = apiInstance.listProjects(searchFilter, sort, pageSize, pageToken, includePublicProjects, includeAllProjects);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#listProjects");
            e.printStackTrace();
        }
    }
}
String *searchFilter = searchFilter_example; // Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [creator.email creator.name creator.username description name owner.email owner.name owner.username].
For example:
  search_filter={"name":"foo","creator.name":"bar"},. (optional)
String *sort = sort_example; // Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [created_at creator.email creator.name creator.username description name owner.email owner.name owner.username updated_at].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=-updated_at,+name. (optional)
Integer *pageSize = 56; // Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response. (optional)
String *pageToken = pageToken_example; // Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page. (optional)
Boolean *includePublicProjects = true; // Default is false. If include_public_projects is set to true, then it will return
all projects user has access to, including public projects. (optional)
Boolean *includeAllProjects = true; // Default is false. If include_all_projects is set to true, then it will return
all projects in the workspace if user is a site admin. If user is not a site admin,
then it will be equivalent to making use of flag include_public_projects and will return
all projects user has access to, including public projects. (optional)

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Return all projects, optionally filtered, sorted, and paginated.
[apiInstance listProjectsWith:searchFilter
    sort:sort
    pageSize:pageSize
    pageToken:pageToken
    includePublicProjects:includePublicProjects
    includeAllProjects:includeAllProjects
              completionHandler: ^(ListProjectsResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var opts = { 
  'searchFilter': searchFilter_example, // {{String}} Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [creator.email creator.name creator.username description name owner.email owner.name owner.username].
For example:
  search_filter={"name":"foo","creator.name":"bar"},.
  'sort': sort_example, // {{String}} Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [created_at creator.email creator.name creator.username description name owner.email owner.name owner.username updated_at].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=-updated_at,+name.
  'pageSize': 56, // {{Integer}} Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
  'pageToken': pageToken_example, // {{String}} Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
  'includePublicProjects': true, // {{Boolean}} Default is false. If include_public_projects is set to true, then it will return
all projects user has access to, including public projects.
  'includeAllProjects': true // {{Boolean}} Default is false. If include_all_projects is set to true, then it will return
all projects in the workspace if user is a site admin. If user is not a site admin,
then it will be equivalent to making use of flag include_public_projects and will return
all projects user has access to, including public projects.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listProjects(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class listProjectsExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var searchFilter = searchFilter_example;  // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [creator.email creator.name creator.username description name owner.email owner.name owner.username].
For example:
  search_filter={"name":"foo","creator.name":"bar"},. (optional) 
            var sort = sort_example;  // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [created_at creator.email creator.name creator.username description name owner.email owner.name owner.username updated_at].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=-updated_at,+name. (optional) 
            var pageSize = 56;  // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response. (optional) 
            var pageToken = pageToken_example;  // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page. (optional) 
            var includePublicProjects = true;  // Boolean | Default is false. If include_public_projects is set to true, then it will return
all projects user has access to, including public projects. (optional) 
            var includeAllProjects = true;  // Boolean | Default is false. If include_all_projects is set to true, then it will return
all projects in the workspace if user is a site admin. If user is not a site admin,
then it will be equivalent to making use of flag include_public_projects and will return
all projects user has access to, including public projects. (optional) 

            try
            {
                // Return all projects, optionally filtered, sorted, and paginated.
                ListProjectsResponse result = apiInstance.listProjects(searchFilter, sort, pageSize, pageToken, includePublicProjects, includeAllProjects);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.listProjects: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [creator.email creator.name creator.username description name owner.email owner.name owner.username].
For example:
  search_filter={"name":"foo","creator.name":"bar"},.
$sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [created_at creator.email creator.name creator.username description name owner.email owner.name owner.username updated_at].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=-updated_at,+name.
$pageSize = 56; // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
$pageToken = pageToken_example; // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
$includePublicProjects = true; // Boolean | Default is false. If include_public_projects is set to true, then it will return
all projects user has access to, including public projects.
$includeAllProjects = true; // Boolean | Default is false. If include_all_projects is set to true, then it will return
all projects in the workspace if user is a site admin. If user is not a site admin,
then it will be equivalent to making use of flag include_public_projects and will return
all projects user has access to, including public projects.

try {
    $result = $api_instance->listProjects($searchFilter, $sort, $pageSize, $pageToken, $includePublicProjects, $includeAllProjects);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->listProjects: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $searchFilter = searchFilter_example; # String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [creator.email creator.name creator.username description name owner.email owner.name owner.username].
For example:
  search_filter={"name":"foo","creator.name":"bar"},.
my $sort = sort_example; # String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [created_at creator.email creator.name creator.username description name owner.email owner.name owner.username updated_at].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=-updated_at,+name.
my $pageSize = 56; # Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
my $pageToken = pageToken_example; # String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
my $includePublicProjects = true; # Boolean | Default is false. If include_public_projects is set to true, then it will return
all projects user has access to, including public projects.
my $includeAllProjects = true; # Boolean | Default is false. If include_all_projects is set to true, then it will return
all projects in the workspace if user is a site admin. If user is not a site admin,
then it will be equivalent to making use of flag include_public_projects and will return
all projects user has access to, including public projects.

eval { 
    my $result = $api_instance->listProjects(searchFilter => $searchFilter, sort => $sort, pageSize => $pageSize, pageToken => $pageToken, includePublicProjects => $includePublicProjects, includeAllProjects => $includeAllProjects);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->listProjects: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
searchFilter = searchFilter_example # String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [creator.email creator.name creator.username description name owner.email owner.name owner.username].
For example:
  search_filter={"name":"foo","creator.name":"bar"},. (optional)
sort = sort_example # String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [created_at creator.email creator.name creator.username description name owner.email owner.name owner.username updated_at].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=-updated_at,+name. (optional)
pageSize = 56 # Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response. (optional)
pageToken = pageToken_example # String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page. (optional)
includePublicProjects = true # Boolean | Default is false. If include_public_projects is set to true, then it will return
all projects user has access to, including public projects. (optional)
includeAllProjects = true # Boolean | Default is false. If include_all_projects is set to true, then it will return
all projects in the workspace if user is a site admin. If user is not a site admin,
then it will be equivalent to making use of flag include_public_projects and will return
all projects user has access to, including public projects. (optional)

try: 
    # Return all projects, optionally filtered, sorted, and paginated.
    api_response = api_instance.list_projects(searchFilter=searchFilter, sort=sort, pageSize=pageSize, pageToken=pageToken, includePublicProjects=includePublicProjects, includeAllProjects=includeAllProjects)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->listProjects: %s\n" % e)

Parameters

Query parameters
Name Description
search_filter
String
Search filter is an optional HTTP parameter to filter results by. Supported search filter keys are: [creator.email creator.name creator.username description name owner.email owner.name owner.username]. For example: search_filter={"name":"foo","creator.name":"bar"},.
sort
String
Sort is an optional HTTP parameter to sort results by. Supported sort keys are: [created_at creator.email creator.name creator.username description name owner.email owner.name owner.username updated_at]. where "+" means sort by ascending order, and "-" means sort by descending order. For example: sort=-updated_at,+name.
page_size
Integer (int32)
Page size is an optional argument for number of entries to return in one page. If not specified, the server will determine a page size. If specified, must be respecified for further requests when using the provided next page token in the response.
page_token
String
Page token is an optional argument for specifying which page of results to get. If not specified, the first page will be returned, including a token for the next page. Will be empty if there is no next page.
include_public_projects
Boolean (boolean)
Default is false. If include_public_projects is set to true, then it will return all projects user has access to, including public projects.
include_all_projects
Boolean (boolean)
Default is false. If include_all_projects is set to true, then it will return all projects in the workspace if user is a site admin. If user is not a site admin, then it will be equivalent to making use of flag include_public_projects and will return all projects user has access to, including public projects.

Responses

Status: 200 - A successful response.

Status: default - An unexpected error response


listRegisteredModels

List registered models.


/api/v2/registry/models

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/registry/models?search_filter=&sort=&page_size=&page_token="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search_filter = {"model_name": "model_name"}
 search_filter = {"creator_id": ""}.
        String sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [created_at creator.email creator.name creator.username description kernel name script status updated_at].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=-created_at.
        Integer pageSize = 56; // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
        String pageToken = pageToken_example; // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
        try {
            ListRegisteredModelsResponse result = apiInstance.listRegisteredModels(searchFilter, sort, pageSize, pageToken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#listRegisteredModels");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search_filter = {"model_name": "model_name"}
 search_filter = {"creator_id": ""}.
        String sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [created_at creator.email creator.name creator.username description kernel name script status updated_at].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=-created_at.
        Integer pageSize = 56; // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
        String pageToken = pageToken_example; // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
        try {
            ListRegisteredModelsResponse result = apiInstance.listRegisteredModels(searchFilter, sort, pageSize, pageToken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#listRegisteredModels");
            e.printStackTrace();
        }
    }
}
String *searchFilter = searchFilter_example; // Search filter is an optional HTTP parameter to filter results by.
Supported search_filter = {"model_name": "model_name"}
 search_filter = {"creator_id": ""}. (optional)
String *sort = sort_example; // Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [created_at creator.email creator.name creator.username description kernel name script status updated_at].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=-created_at. (optional)
Integer *pageSize = 56; // Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response. (optional)
String *pageToken = pageToken_example; // Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page. (optional)

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// List registered models.
[apiInstance listRegisteredModelsWith:searchFilter
    sort:sort
    pageSize:pageSize
    pageToken:pageToken
              completionHandler: ^(ListRegisteredModelsResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var opts = { 
  'searchFilter': searchFilter_example, // {{String}} Search filter is an optional HTTP parameter to filter results by.
Supported search_filter = {"model_name": "model_name"}
 search_filter = {"creator_id": ""}.
  'sort': sort_example, // {{String}} Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [created_at creator.email creator.name creator.username description kernel name script status updated_at].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=-created_at.
  'pageSize': 56, // {{Integer}} Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
  'pageToken': pageToken_example // {{String}} Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listRegisteredModels(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class listRegisteredModelsExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var searchFilter = searchFilter_example;  // String | Search filter is an optional HTTP parameter to filter results by.
Supported search_filter = {"model_name": "model_name"}
 search_filter = {"creator_id": ""}. (optional) 
            var sort = sort_example;  // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [created_at creator.email creator.name creator.username description kernel name script status updated_at].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=-created_at. (optional) 
            var pageSize = 56;  // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response. (optional) 
            var pageToken = pageToken_example;  // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page. (optional) 

            try
            {
                // List registered models.
                ListRegisteredModelsResponse result = apiInstance.listRegisteredModels(searchFilter, sort, pageSize, pageToken);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.listRegisteredModels: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search_filter = {"model_name": "model_name"}
 search_filter = {"creator_id": ""}.
$sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [created_at creator.email creator.name creator.username description kernel name script status updated_at].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=-created_at.
$pageSize = 56; // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
$pageToken = pageToken_example; // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.

try {
    $result = $api_instance->listRegisteredModels($searchFilter, $sort, $pageSize, $pageToken);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->listRegisteredModels: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $searchFilter = searchFilter_example; # String | Search filter is an optional HTTP parameter to filter results by.
Supported search_filter = {"model_name": "model_name"}
 search_filter = {"creator_id": ""}.
my $sort = sort_example; # String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [created_at creator.email creator.name creator.username description kernel name script status updated_at].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=-created_at.
my $pageSize = 56; # Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
my $pageToken = pageToken_example; # String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.

eval { 
    my $result = $api_instance->listRegisteredModels(searchFilter => $searchFilter, sort => $sort, pageSize => $pageSize, pageToken => $pageToken);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->listRegisteredModels: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
searchFilter = searchFilter_example # String | Search filter is an optional HTTP parameter to filter results by.
Supported search_filter = {"model_name": "model_name"}
 search_filter = {"creator_id": ""}. (optional)
sort = sort_example # String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [created_at creator.email creator.name creator.username description kernel name script status updated_at].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=-created_at. (optional)
pageSize = 56 # Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response. (optional)
pageToken = pageToken_example # String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page. (optional)

try: 
    # List registered models.
    api_response = api_instance.list_registered_models(searchFilter=searchFilter, sort=sort, pageSize=pageSize, pageToken=pageToken)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->listRegisteredModels: %s\n" % e)

Parameters

Query parameters
Name Description
search_filter
String
Search filter is an optional HTTP parameter to filter results by. Supported search_filter = {"model_name": "model_name"} search_filter = {"creator_id": "<sso name or user name>"}.
sort
String
Sort is an optional HTTP parameter to sort results by. Supported sort keys are: [created_at creator.email creator.name creator.username description kernel name script status updated_at]. where "+" means sort by ascending order, and "-" means sort by descending order. For example: sort=-created_at.
page_size
Integer (int32)
Page size is an optional argument for number of entries to return in one page. If not specified, the server will determine a page size. If specified, must be respecified for further requests when using the provided next page token in the response.
page_token
String
Page token is an optional argument for specifying which page of results to get. If not specified, the first page will be returned, including a token for the next page. Will be empty if there is no next page.

Responses

Status: 200 - A successful response.

Status: default - An unexpected error response


listRuntimeAddons

List the available runtime addons, optionally filtered, sorted, and paginated.


/api/v2/runtimeaddons

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/runtimeaddons?search_filter=&page_size=&page_token=&sort="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: ["identifier", "component", "display_name", "status"].
For example:
  search_filter = {"component": "Spark", "status": "AVAILABLE"},.
        Integer pageSize = 56; // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
        String pageToken = pageToken_example; // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
        String sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
        try {
            ListRuntimeAddonsResponse result = apiInstance.listRuntimeAddons(searchFilter, pageSize, pageToken, sort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#listRuntimeAddons");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: ["identifier", "component", "display_name", "status"].
For example:
  search_filter = {"component": "Spark", "status": "AVAILABLE"},.
        Integer pageSize = 56; // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
        String pageToken = pageToken_example; // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
        String sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
        try {
            ListRuntimeAddonsResponse result = apiInstance.listRuntimeAddons(searchFilter, pageSize, pageToken, sort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#listRuntimeAddons");
            e.printStackTrace();
        }
    }
}
String *searchFilter = searchFilter_example; // Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: ["identifier", "component", "display_name", "status"].
For example:
  search_filter = {"component": "Spark", "status": "AVAILABLE"},. (optional)
Integer *pageSize = 56; // Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response. (optional)
String *pageToken = pageToken_example; // Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page. (optional)
String *sort = sort_example; // Sort is an optional HTTP parameter to sort results by. (optional)

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// List the available runtime addons, optionally filtered, sorted, and paginated.
[apiInstance listRuntimeAddonsWith:searchFilter
    pageSize:pageSize
    pageToken:pageToken
    sort:sort
              completionHandler: ^(ListRuntimeAddonsResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var opts = { 
  'searchFilter': searchFilter_example, // {{String}} Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: ["identifier", "component", "display_name", "status"].
For example:
  search_filter = {"component": "Spark", "status": "AVAILABLE"},.
  'pageSize': 56, // {{Integer}} Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
  'pageToken': pageToken_example, // {{String}} Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
  'sort': sort_example // {{String}} Sort is an optional HTTP parameter to sort results by.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listRuntimeAddons(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class listRuntimeAddonsExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var searchFilter = searchFilter_example;  // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: ["identifier", "component", "display_name", "status"].
For example:
  search_filter = {"component": "Spark", "status": "AVAILABLE"},. (optional) 
            var pageSize = 56;  // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response. (optional) 
            var pageToken = pageToken_example;  // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page. (optional) 
            var sort = sort_example;  // String | Sort is an optional HTTP parameter to sort results by. (optional) 

            try
            {
                // List the available runtime addons, optionally filtered, sorted, and paginated.
                ListRuntimeAddonsResponse result = apiInstance.listRuntimeAddons(searchFilter, pageSize, pageToken, sort);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.listRuntimeAddons: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: ["identifier", "component", "display_name", "status"].
For example:
  search_filter = {"component": "Spark", "status": "AVAILABLE"},.
$pageSize = 56; // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
$pageToken = pageToken_example; // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
$sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.

try {
    $result = $api_instance->listRuntimeAddons($searchFilter, $pageSize, $pageToken, $sort);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->listRuntimeAddons: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $searchFilter = searchFilter_example; # String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: ["identifier", "component", "display_name", "status"].
For example:
  search_filter = {"component": "Spark", "status": "AVAILABLE"},.
my $pageSize = 56; # Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
my $pageToken = pageToken_example; # String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
my $sort = sort_example; # String | Sort is an optional HTTP parameter to sort results by.

eval { 
    my $result = $api_instance->listRuntimeAddons(searchFilter => $searchFilter, pageSize => $pageSize, pageToken => $pageToken, sort => $sort);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->listRuntimeAddons: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
searchFilter = searchFilter_example # String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: ["identifier", "component", "display_name", "status"].
For example:
  search_filter = {"component": "Spark", "status": "AVAILABLE"},. (optional)
pageSize = 56 # Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response. (optional)
pageToken = pageToken_example # String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page. (optional)
sort = sort_example # String | Sort is an optional HTTP parameter to sort results by. (optional)

try: 
    # List the available runtime addons, optionally filtered, sorted, and paginated.
    api_response = api_instance.list_runtime_addons(searchFilter=searchFilter, pageSize=pageSize, pageToken=pageToken, sort=sort)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->listRuntimeAddons: %s\n" % e)

Parameters

Query parameters
Name Description
search_filter
String
Search filter is an optional HTTP parameter to filter results by. Supported search filter keys are: ["identifier", "component", "display_name", "status"]. For example: search_filter = {"component": "Spark", "status": "AVAILABLE"},.
page_size
Integer (int32)
Page size is an optional argument for number of entries to return in one page. If not specified, the server will determine a page size. If specified, must be respecified for further requests when using the provided next page token in the response.
page_token
String
Page token is an optional argument for specifying which page of results to get. If not specified, the first page will be returned, including a token for the next page. Will be empty if there is no next page.
sort
String
Sort is an optional HTTP parameter to sort results by.

Responses

Status: 200 - A successful response.

Status: default - An unexpected error response


listRuntimeRepos

List Runtime repos.


/api/v2/runtimerepos

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/runtimerepos?search_filter=&sort=&page_size=&page_token="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [id name url].
For example:
  search_filter={"id":"1","name":"My Repo","url":"my.url"}.
        String sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [id name url].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=id.
        Integer pageSize = 56; // Integer | page size of the response runtime repo list.
        String pageToken = pageToken_example; // String | page token for specifying which page to return.
        try {
            ListRuntimeReposResponse result = apiInstance.listRuntimeRepos(searchFilter, sort, pageSize, pageToken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#listRuntimeRepos");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [id name url].
For example:
  search_filter={"id":"1","name":"My Repo","url":"my.url"}.
        String sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [id name url].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=id.
        Integer pageSize = 56; // Integer | page size of the response runtime repo list.
        String pageToken = pageToken_example; // String | page token for specifying which page to return.
        try {
            ListRuntimeReposResponse result = apiInstance.listRuntimeRepos(searchFilter, sort, pageSize, pageToken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#listRuntimeRepos");
            e.printStackTrace();
        }
    }
}
String *searchFilter = searchFilter_example; // Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [id name url].
For example:
  search_filter={"id":"1","name":"My Repo","url":"my.url"}. (optional)
String *sort = sort_example; // Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [id name url].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=id. (optional)
Integer *pageSize = 56; // page size of the response runtime repo list. (optional)
String *pageToken = pageToken_example; // page token for specifying which page to return. (optional)

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// List Runtime repos.
[apiInstance listRuntimeReposWith:searchFilter
    sort:sort
    pageSize:pageSize
    pageToken:pageToken
              completionHandler: ^(ListRuntimeReposResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var opts = { 
  'searchFilter': searchFilter_example, // {{String}} Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [id name url].
For example:
  search_filter={"id":"1","name":"My Repo","url":"my.url"}.
  'sort': sort_example, // {{String}} Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [id name url].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=id.
  'pageSize': 56, // {{Integer}} page size of the response runtime repo list.
  'pageToken': pageToken_example // {{String}} page token for specifying which page to return.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listRuntimeRepos(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class listRuntimeReposExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var searchFilter = searchFilter_example;  // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [id name url].
For example:
  search_filter={"id":"1","name":"My Repo","url":"my.url"}. (optional) 
            var sort = sort_example;  // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [id name url].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=id. (optional) 
            var pageSize = 56;  // Integer | page size of the response runtime repo list. (optional) 
            var pageToken = pageToken_example;  // String | page token for specifying which page to return. (optional) 

            try
            {
                // List Runtime repos.
                ListRuntimeReposResponse result = apiInstance.listRuntimeRepos(searchFilter, sort, pageSize, pageToken);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.listRuntimeRepos: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [id name url].
For example:
  search_filter={"id":"1","name":"My Repo","url":"my.url"}.
$sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [id name url].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=id.
$pageSize = 56; // Integer | page size of the response runtime repo list.
$pageToken = pageToken_example; // String | page token for specifying which page to return.

try {
    $result = $api_instance->listRuntimeRepos($searchFilter, $sort, $pageSize, $pageToken);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->listRuntimeRepos: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $searchFilter = searchFilter_example; # String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [id name url].
For example:
  search_filter={"id":"1","name":"My Repo","url":"my.url"}.
my $sort = sort_example; # String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [id name url].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=id.
my $pageSize = 56; # Integer | page size of the response runtime repo list.
my $pageToken = pageToken_example; # String | page token for specifying which page to return.

eval { 
    my $result = $api_instance->listRuntimeRepos(searchFilter => $searchFilter, sort => $sort, pageSize => $pageSize, pageToken => $pageToken);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->listRuntimeRepos: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
searchFilter = searchFilter_example # String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [id name url].
For example:
  search_filter={"id":"1","name":"My Repo","url":"my.url"}. (optional)
sort = sort_example # String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [id name url].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=id. (optional)
pageSize = 56 # Integer | page size of the response runtime repo list. (optional)
pageToken = pageToken_example # String | page token for specifying which page to return. (optional)

try: 
    # List Runtime repos.
    api_response = api_instance.list_runtime_repos(searchFilter=searchFilter, sort=sort, pageSize=pageSize, pageToken=pageToken)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->listRuntimeRepos: %s\n" % e)

Parameters

Query parameters
Name Description
search_filter
String
Search filter is an optional HTTP parameter to filter results by. Supported search filter keys are: [id name url]. For example: search_filter={"id":"1","name":"My Repo","url":"my.url"}.
sort
String
Sort is an optional HTTP parameter to sort results by. Supported sort keys are: [id name url]. where "+" means sort by ascending order, and "-" means sort by descending order. For example: sort=id.
page_size
Integer (int32)
page size of the response runtime repo list.
page_token
String
page token for specifying which page to return.

Responses

Status: 200 - A successful response.

Status: default - An unexpected error response


listRuntimes

List the available runtimes, optionally filtered, sorted, and paginated.


/api/v2/runtimes

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/runtimes?search_filter=&page_size=&page_token=&sort="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: ["image_identifier", "editor", "kernel", "edition", "description", "full_version"].
For example:
  search_filter = {"kernel":"Python 3.7","editor":"JupyterLab"},.
        Integer pageSize = 56; // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
        String pageToken = pageToken_example; // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
        String sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [image_identifier, editor, kernel, edition, description, full_version].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=-kernel,+editor.
        try {
            ListRuntimesResponse result = apiInstance.listRuntimes(searchFilter, pageSize, pageToken, sort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#listRuntimes");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: ["image_identifier", "editor", "kernel", "edition", "description", "full_version"].
For example:
  search_filter = {"kernel":"Python 3.7","editor":"JupyterLab"},.
        Integer pageSize = 56; // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
        String pageToken = pageToken_example; // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
        String sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [image_identifier, editor, kernel, edition, description, full_version].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=-kernel,+editor.
        try {
            ListRuntimesResponse result = apiInstance.listRuntimes(searchFilter, pageSize, pageToken, sort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#listRuntimes");
            e.printStackTrace();
        }
    }
}
String *searchFilter = searchFilter_example; // Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: ["image_identifier", "editor", "kernel", "edition", "description", "full_version"].
For example:
  search_filter = {"kernel":"Python 3.7","editor":"JupyterLab"},. (optional)
Integer *pageSize = 56; // Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response. (optional)
String *pageToken = pageToken_example; // Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page. (optional)
String *sort = sort_example; // Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [image_identifier, editor, kernel, edition, description, full_version].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=-kernel,+editor. (optional)

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// List the available runtimes, optionally filtered, sorted, and paginated.
[apiInstance listRuntimesWith:searchFilter
    pageSize:pageSize
    pageToken:pageToken
    sort:sort
              completionHandler: ^(ListRuntimesResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var opts = { 
  'searchFilter': searchFilter_example, // {{String}} Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: ["image_identifier", "editor", "kernel", "edition", "description", "full_version"].
For example:
  search_filter = {"kernel":"Python 3.7","editor":"JupyterLab"},.
  'pageSize': 56, // {{Integer}} Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
  'pageToken': pageToken_example, // {{String}} Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
  'sort': sort_example // {{String}} Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [image_identifier, editor, kernel, edition, description, full_version].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=-kernel,+editor.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listRuntimes(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class listRuntimesExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var searchFilter = searchFilter_example;  // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: ["image_identifier", "editor", "kernel", "edition", "description", "full_version"].
For example:
  search_filter = {"kernel":"Python 3.7","editor":"JupyterLab"},. (optional) 
            var pageSize = 56;  // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response. (optional) 
            var pageToken = pageToken_example;  // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page. (optional) 
            var sort = sort_example;  // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [image_identifier, editor, kernel, edition, description, full_version].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=-kernel,+editor. (optional) 

            try
            {
                // List the available runtimes, optionally filtered, sorted, and paginated.
                ListRuntimesResponse result = apiInstance.listRuntimes(searchFilter, pageSize, pageToken, sort);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.listRuntimes: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: ["image_identifier", "editor", "kernel", "edition", "description", "full_version"].
For example:
  search_filter = {"kernel":"Python 3.7","editor":"JupyterLab"},.
$pageSize = 56; // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
$pageToken = pageToken_example; // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
$sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [image_identifier, editor, kernel, edition, description, full_version].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=-kernel,+editor.

try {
    $result = $api_instance->listRuntimes($searchFilter, $pageSize, $pageToken, $sort);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->listRuntimes: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $searchFilter = searchFilter_example; # String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: ["image_identifier", "editor", "kernel", "edition", "description", "full_version"].
For example:
  search_filter = {"kernel":"Python 3.7","editor":"JupyterLab"},.
my $pageSize = 56; # Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
my $pageToken = pageToken_example; # String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
my $sort = sort_example; # String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [image_identifier, editor, kernel, edition, description, full_version].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=-kernel,+editor.

eval { 
    my $result = $api_instance->listRuntimes(searchFilter => $searchFilter, pageSize => $pageSize, pageToken => $pageToken, sort => $sort);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->listRuntimes: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
searchFilter = searchFilter_example # String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: ["image_identifier", "editor", "kernel", "edition", "description", "full_version"].
For example:
  search_filter = {"kernel":"Python 3.7","editor":"JupyterLab"},. (optional)
pageSize = 56 # Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response. (optional)
pageToken = pageToken_example # String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page. (optional)
sort = sort_example # String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [image_identifier, editor, kernel, edition, description, full_version].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=-kernel,+editor. (optional)

try: 
    # List the available runtimes, optionally filtered, sorted, and paginated.
    api_response = api_instance.list_runtimes(searchFilter=searchFilter, pageSize=pageSize, pageToken=pageToken, sort=sort)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->listRuntimes: %s\n" % e)

Parameters

Query parameters
Name Description
search_filter
String
Search filter is an optional HTTP parameter to filter results by. Supported search filter keys are: ["image_identifier", "editor", "kernel", "edition", "description", "full_version"]. For example: search_filter = {"kernel":"Python 3.7","editor":"JupyterLab"},.
page_size
Integer (int32)
Page size is an optional argument for number of entries to return in one page. If not specified, the server will determine a page size. If specified, must be respecified for further requests when using the provided next page token in the response.
page_token
String
Page token is an optional argument for specifying which page of results to get. If not specified, the first page will be returned, including a token for the next page. Will be empty if there is no next page.
sort
String
Sort is an optional HTTP parameter to sort results by. Supported sort keys are: [image_identifier, editor, kernel, edition, description, full_version]. where "+" means sort by ascending order, and "-" means sort by descending order. For example: sort=-kernel,+editor.

Responses

Status: 200 - A successful response.

Status: default - An unexpected error response


listV2Keys

Get all API V2 keys


/api/v2/users/{username}/v2_keys

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/users/{username}/v2_keys"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String username = username_example; // String | username of the user whose V2 keys you want to get
        try {
            ListV2KeysResponse result = apiInstance.listV2Keys(username);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#listV2Keys");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String username = username_example; // String | username of the user whose V2 keys you want to get
        try {
            ListV2KeysResponse result = apiInstance.listV2Keys(username);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#listV2Keys");
            e.printStackTrace();
        }
    }
}
String *username = username_example; // username of the user whose V2 keys you want to get

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Get all API V2 keys
[apiInstance listV2KeysWith:username
              completionHandler: ^(ListV2KeysResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var username = username_example; // {{String}} username of the user whose V2 keys you want to get

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listV2Keys(username, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class listV2KeysExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var username = username_example;  // String | username of the user whose V2 keys you want to get

            try
            {
                // Get all API V2 keys
                ListV2KeysResponse result = apiInstance.listV2Keys(username);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.listV2Keys: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$username = username_example; // String | username of the user whose V2 keys you want to get

try {
    $result = $api_instance->listV2Keys($username);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->listV2Keys: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $username = username_example; # String | username of the user whose V2 keys you want to get

eval { 
    my $result = $api_instance->listV2Keys(username => $username);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->listV2Keys: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
username = username_example # String | username of the user whose V2 keys you want to get

try: 
    # Get all API V2 keys
    api_response = api_instance.list_v2_keys(username)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->listV2Keys: %s\n" % e)

Parameters

Path parameters
Name Description
username*
String
username of the user whose V2 keys you want to get
Required

Responses

Status: 200 - A successful response.

Status: default - An unexpected error response


logExperimentRunBatch

Bulk update an experiment run details like metrics, params, tags in one request.


/api/v2/projects/{project_id}/experiments/{experiment_id}/runs/{run_id}:logbatch

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//api/v2/projects/{project_id}/experiments/{experiment_id}/runs/{run_id}:logbatch"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        LogExperimentRunBatchRequest body = ; // LogExperimentRunBatchRequest | 
        String projectId = projectId_example; // String | 
        String experimentId = experimentId_example; // String | 
        String runId = runId_example; // String | ID of the ExperimentRun to log under
        try {
            LogExperimentRunBatchResponse result = apiInstance.logExperimentRunBatch(body, projectId, experimentId, runId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#logExperimentRunBatch");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        LogExperimentRunBatchRequest body = ; // LogExperimentRunBatchRequest | 
        String projectId = projectId_example; // String | 
        String experimentId = experimentId_example; // String | 
        String runId = runId_example; // String | ID of the ExperimentRun to log under
        try {
            LogExperimentRunBatchResponse result = apiInstance.logExperimentRunBatch(body, projectId, experimentId, runId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#logExperimentRunBatch");
            e.printStackTrace();
        }
    }
}
LogExperimentRunBatchRequest *body = ; // 
String *projectId = projectId_example; // 
String *experimentId = experimentId_example; // 
String *runId = runId_example; // ID of the ExperimentRun to log under

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Bulk update an experiment run details like metrics, params, tags in one request.
[apiInstance logExperimentRunBatchWith:body
    projectId:projectId
    experimentId:experimentId
    runId:runId
              completionHandler: ^(LogExperimentRunBatchResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var body = ; // {{LogExperimentRunBatchRequest}} 
var projectId = projectId_example; // {{String}} 
var experimentId = experimentId_example; // {{String}} 
var runId = runId_example; // {{String}} ID of the ExperimentRun to log under

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.logExperimentRunBatch(bodyprojectIdexperimentIdrunId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class logExperimentRunBatchExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var body = new LogExperimentRunBatchRequest(); // LogExperimentRunBatchRequest | 
            var projectId = projectId_example;  // String | 
            var experimentId = experimentId_example;  // String | 
            var runId = runId_example;  // String | ID of the ExperimentRun to log under

            try
            {
                // Bulk update an experiment run details like metrics, params, tags in one request.
                LogExperimentRunBatchResponse result = apiInstance.logExperimentRunBatch(body, projectId, experimentId, runId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.logExperimentRunBatch: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$body = ; // LogExperimentRunBatchRequest | 
$projectId = projectId_example; // String | 
$experimentId = experimentId_example; // String | 
$runId = runId_example; // String | ID of the ExperimentRun to log under

try {
    $result = $api_instance->logExperimentRunBatch($body, $projectId, $experimentId, $runId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->logExperimentRunBatch: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $body = WWW::SwaggerClient::Object::LogExperimentRunBatchRequest->new(); # LogExperimentRunBatchRequest | 
my $projectId = projectId_example; # String | 
my $experimentId = experimentId_example; # String | 
my $runId = runId_example; # String | ID of the ExperimentRun to log under

eval { 
    my $result = $api_instance->logExperimentRunBatch(body => $body, projectId => $projectId, experimentId => $experimentId, runId => $runId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->logExperimentRunBatch: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
body =  # LogExperimentRunBatchRequest | 
projectId = projectId_example # String | 
experimentId = experimentId_example # String | 
runId = runId_example # String | ID of the ExperimentRun to log under

try: 
    # Bulk update an experiment run details like metrics, params, tags in one request.
    api_response = api_instance.log_experiment_run_batch(body, projectId, experimentId, runId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->logExperimentRunBatch: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
Required
experiment_id*
String
Required
run_id*
String
ID of the ExperimentRun to log under
Required
Body parameters
Name Description
body *

Responses

Status: 200 - A successful response.

Status: default - An unexpected error response


registerCustomRuntime

Register a runtime, given the URL to the image in the docker registry


/api/v2/runtimes

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//api/v2/runtimes"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        RegisterCustomRuntimeRequest body = ; // RegisterCustomRuntimeRequest | 
        try {
            RegisterCustomRuntimeResponse result = apiInstance.registerCustomRuntime(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#registerCustomRuntime");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        RegisterCustomRuntimeRequest body = ; // RegisterCustomRuntimeRequest | 
        try {
            RegisterCustomRuntimeResponse result = apiInstance.registerCustomRuntime(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#registerCustomRuntime");
            e.printStackTrace();
        }
    }
}
RegisterCustomRuntimeRequest *body = ; // 

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Register a runtime, given the URL to the image in the docker registry
[apiInstance registerCustomRuntimeWith:body
              completionHandler: ^(RegisterCustomRuntimeResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var body = ; // {{RegisterCustomRuntimeRequest}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.registerCustomRuntime(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class registerCustomRuntimeExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var body = new RegisterCustomRuntimeRequest(); // RegisterCustomRuntimeRequest | 

            try
            {
                // Register a runtime, given the URL to the image in the docker registry
                RegisterCustomRuntimeResponse result = apiInstance.registerCustomRuntime(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.registerCustomRuntime: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$body = ; // RegisterCustomRuntimeRequest | 

try {
    $result = $api_instance->registerCustomRuntime($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->registerCustomRuntime: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $body = WWW::SwaggerClient::Object::RegisterCustomRuntimeRequest->new(); # RegisterCustomRuntimeRequest | 

eval { 
    my $result = $api_instance->registerCustomRuntime(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->registerCustomRuntime: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
body =  # RegisterCustomRuntimeRequest | 

try: 
    # Register a runtime, given the URL to the image in the docker registry
    api_response = api_instance.register_custom_runtime(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->registerCustomRuntime: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - A successful response.

Status: default - An unexpected error response


restartApplication

Start an application.


/api/v2/projects/{project_id}/applications/{application_id}:restart

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
"//api/v2/projects/{project_id}/applications/{application_id}:restart"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | The public project identifier
        String applicationId = applicationId_example; // String | The public application identifier
        try {
            Application result = apiInstance.restartApplication(projectId, applicationId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#restartApplication");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | The public project identifier
        String applicationId = applicationId_example; // String | The public application identifier
        try {
            Application result = apiInstance.restartApplication(projectId, applicationId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#restartApplication");
            e.printStackTrace();
        }
    }
}
String *projectId = projectId_example; // The public project identifier
String *applicationId = applicationId_example; // The public application identifier

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Start an application.
[apiInstance restartApplicationWith:projectId
    applicationId:applicationId
              completionHandler: ^(Application output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var projectId = projectId_example; // {{String}} The public project identifier
var applicationId = applicationId_example; // {{String}} The public application identifier

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.restartApplication(projectId, applicationId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class restartApplicationExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var projectId = projectId_example;  // String | The public project identifier
            var applicationId = applicationId_example;  // String | The public application identifier

            try
            {
                // Start an application.
                Application result = apiInstance.restartApplication(projectId, applicationId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.restartApplication: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$projectId = projectId_example; // String | The public project identifier
$applicationId = applicationId_example; // String | The public application identifier

try {
    $result = $api_instance->restartApplication($projectId, $applicationId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->restartApplication: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $projectId = projectId_example; # String | The public project identifier
my $applicationId = applicationId_example; # String | The public application identifier

eval { 
    my $result = $api_instance->restartApplication(projectId => $projectId, applicationId => $applicationId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->restartApplication: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
projectId = projectId_example # String | The public project identifier
applicationId = applicationId_example # String | The public application identifier

try: 
    # Start an application.
    api_response = api_instance.restart_application(projectId, applicationId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->restartApplication: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
The public project identifier
Required
application_id*
String
The public application identifier
Required

Responses

Status: 200 - A successful response.

Status: default - An unexpected error response


restartModelDeployment

Restart a model deployment.


/api/v2/projects/{project_id}/models/{model_id}/builds/{build_id}/deployments/{deployment_id}:restart

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
"//api/v2/projects/{project_id}/models/{model_id}/builds/{build_id}/deployments/{deployment_id}:restart"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | ID of the project containing the model.
        String modelId = modelId_example; // String | ID of the model containing the deployment.
        String buildId = buildId_example; // String | ID of the build containing the deployment.
        String deploymentId = deploymentId_example; // String | ID of the deployment to restart.
        try {
            ModelDeployment result = apiInstance.restartModelDeployment(projectId, modelId, buildId, deploymentId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#restartModelDeployment");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | ID of the project containing the model.
        String modelId = modelId_example; // String | ID of the model containing the deployment.
        String buildId = buildId_example; // String | ID of the build containing the deployment.
        String deploymentId = deploymentId_example; // String | ID of the deployment to restart.
        try {
            ModelDeployment result = apiInstance.restartModelDeployment(projectId, modelId, buildId, deploymentId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#restartModelDeployment");
            e.printStackTrace();
        }
    }
}
String *projectId = projectId_example; // ID of the project containing the model.
String *modelId = modelId_example; // ID of the model containing the deployment.
String *buildId = buildId_example; // ID of the build containing the deployment.
String *deploymentId = deploymentId_example; // ID of the deployment to restart.

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Restart a model deployment.
[apiInstance restartModelDeploymentWith:projectId
    modelId:modelId
    buildId:buildId
    deploymentId:deploymentId
              completionHandler: ^(ModelDeployment output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var projectId = projectId_example; // {{String}} ID of the project containing the model.
var modelId = modelId_example; // {{String}} ID of the model containing the deployment.
var buildId = buildId_example; // {{String}} ID of the build containing the deployment.
var deploymentId = deploymentId_example; // {{String}} ID of the deployment to restart.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.restartModelDeployment(projectId, modelId, buildId, deploymentId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class restartModelDeploymentExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var projectId = projectId_example;  // String | ID of the project containing the model.
            var modelId = modelId_example;  // String | ID of the model containing the deployment.
            var buildId = buildId_example;  // String | ID of the build containing the deployment.
            var deploymentId = deploymentId_example;  // String | ID of the deployment to restart.

            try
            {
                // Restart a model deployment.
                ModelDeployment result = apiInstance.restartModelDeployment(projectId, modelId, buildId, deploymentId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.restartModelDeployment: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$projectId = projectId_example; // String | ID of the project containing the model.
$modelId = modelId_example; // String | ID of the model containing the deployment.
$buildId = buildId_example; // String | ID of the build containing the deployment.
$deploymentId = deploymentId_example; // String | ID of the deployment to restart.

try {
    $result = $api_instance->restartModelDeployment($projectId, $modelId, $buildId, $deploymentId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->restartModelDeployment: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $projectId = projectId_example; # String | ID of the project containing the model.
my $modelId = modelId_example; # String | ID of the model containing the deployment.
my $buildId = buildId_example; # String | ID of the build containing the deployment.
my $deploymentId = deploymentId_example; # String | ID of the deployment to restart.

eval { 
    my $result = $api_instance->restartModelDeployment(projectId => $projectId, modelId => $modelId, buildId => $buildId, deploymentId => $deploymentId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->restartModelDeployment: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
projectId = projectId_example # String | ID of the project containing the model.
modelId = modelId_example # String | ID of the model containing the deployment.
buildId = buildId_example # String | ID of the build containing the deployment.
deploymentId = deploymentId_example # String | ID of the deployment to restart.

try: 
    # Restart a model deployment.
    api_response = api_instance.restart_model_deployment(projectId, modelId, buildId, deploymentId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->restartModelDeployment: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
ID of the project containing the model.
Required
model_id*
String
ID of the model containing the deployment.
Required
build_id*
String
ID of the build containing the deployment.
Required
deployment_id*
String
ID of the deployment to restart.
Required

Responses

Status: 200 - A successful response.

Status: default - An unexpected error response


rotateV1Key

Rotate API V1 key


/api/v2/users/{username}/v1_key:rotate

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//api/v2/users/{username}/v1_key:rotate"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        RotateV1KeyRequest body = ; // RotateV1KeyRequest | 
        String username = username_example; // String | username of the user whose V1 key you want to rotate
        try {
            RotateV1KeyResponse result = apiInstance.rotateV1Key(body, username);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#rotateV1Key");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        RotateV1KeyRequest body = ; // RotateV1KeyRequest | 
        String username = username_example; // String | username of the user whose V1 key you want to rotate
        try {
            RotateV1KeyResponse result = apiInstance.rotateV1Key(body, username);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#rotateV1Key");
            e.printStackTrace();
        }
    }
}
RotateV1KeyRequest *body = ; // 
String *username = username_example; // username of the user whose V1 key you want to rotate

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Rotate API V1 key
[apiInstance rotateV1KeyWith:body
    username:username
              completionHandler: ^(RotateV1KeyResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var body = ; // {{RotateV1KeyRequest}} 
var username = username_example; // {{String}} username of the user whose V1 key you want to rotate

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.rotateV1Key(bodyusername, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class rotateV1KeyExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var body = new RotateV1KeyRequest(); // RotateV1KeyRequest | 
            var username = username_example;  // String | username of the user whose V1 key you want to rotate

            try
            {
                // Rotate API V1 key
                RotateV1KeyResponse result = apiInstance.rotateV1Key(body, username);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.rotateV1Key: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$body = ; // RotateV1KeyRequest | 
$username = username_example; // String | username of the user whose V1 key you want to rotate

try {
    $result = $api_instance->rotateV1Key($body, $username);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->rotateV1Key: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $body = WWW::SwaggerClient::Object::RotateV1KeyRequest->new(); # RotateV1KeyRequest | 
my $username = username_example; # String | username of the user whose V1 key you want to rotate

eval { 
    my $result = $api_instance->rotateV1Key(body => $body, username => $username);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->rotateV1Key: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
body =  # RotateV1KeyRequest | 
username = username_example # String | username of the user whose V1 key you want to rotate

try: 
    # Rotate API V1 key
    api_response = api_instance.rotate_v1_key(body, username)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->rotateV1Key: %s\n" % e)

Parameters

Path parameters
Name Description
username*
String
username of the user whose V1 key you want to rotate
Required
Body parameters
Name Description
body *

Responses

Status: 200 - A successful response.

Status: default - An unexpected error response


stopApplication

Stop an application.


/api/v2/projects/{project_id}/applications/{application_id}:stop

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
"//api/v2/projects/{project_id}/applications/{application_id}:stop"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | The public project identifier
        String applicationId = applicationId_example; // String | The public application identifier
        try {
            Application result = apiInstance.stopApplication(projectId, applicationId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#stopApplication");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | The public project identifier
        String applicationId = applicationId_example; // String | The public application identifier
        try {
            Application result = apiInstance.stopApplication(projectId, applicationId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#stopApplication");
            e.printStackTrace();
        }
    }
}
String *projectId = projectId_example; // The public project identifier
String *applicationId = applicationId_example; // The public application identifier

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Stop an application.
[apiInstance stopApplicationWith:projectId
    applicationId:applicationId
              completionHandler: ^(Application output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var projectId = projectId_example; // {{String}} The public project identifier
var applicationId = applicationId_example; // {{String}} The public application identifier

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.stopApplication(projectId, applicationId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class stopApplicationExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var projectId = projectId_example;  // String | The public project identifier
            var applicationId = applicationId_example;  // String | The public application identifier

            try
            {
                // Stop an application.
                Application result = apiInstance.stopApplication(projectId, applicationId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.stopApplication: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$projectId = projectId_example; // String | The public project identifier
$applicationId = applicationId_example; // String | The public application identifier

try {
    $result = $api_instance->stopApplication($projectId, $applicationId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->stopApplication: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $projectId = projectId_example; # String | The public project identifier
my $applicationId = applicationId_example; # String | The public application identifier

eval { 
    my $result = $api_instance->stopApplication(projectId => $projectId, applicationId => $applicationId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->stopApplication: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
projectId = projectId_example # String | The public project identifier
applicationId = applicationId_example # String | The public application identifier

try: 
    # Stop an application.
    api_response = api_instance.stop_application(projectId, applicationId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->stopApplication: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
The public project identifier
Required
application_id*
String
The public application identifier
Required

Responses

Status: 200 - A successful response.

Status: default - An unexpected error response


stopJobRun

Stops a job run. Encoded as a custom method.


/api/v2/projects/{project_id}/jobs/{job_id}/runs/{run_id}:stop

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
"//api/v2/projects/{project_id}/jobs/{job_id}/runs/{run_id}:stop"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | ID of the project containing the job
        String jobId = jobId_example; // String | ID of the job containing the job run.
        String runId = runId_example; // String | ID of the job run to delete.
        try {
            JobRun result = apiInstance.stopJobRun(projectId, jobId, runId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#stopJobRun");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | ID of the project containing the job
        String jobId = jobId_example; // String | ID of the job containing the job run.
        String runId = runId_example; // String | ID of the job run to delete.
        try {
            JobRun result = apiInstance.stopJobRun(projectId, jobId, runId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#stopJobRun");
            e.printStackTrace();
        }
    }
}
String *projectId = projectId_example; // ID of the project containing the job
String *jobId = jobId_example; // ID of the job containing the job run.
String *runId = runId_example; // ID of the job run to delete.

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Stops a job run. Encoded as a custom method.
[apiInstance stopJobRunWith:projectId
    jobId:jobId
    runId:runId
              completionHandler: ^(JobRun output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var projectId = projectId_example; // {{String}} ID of the project containing the job
var jobId = jobId_example; // {{String}} ID of the job containing the job run.
var runId = runId_example; // {{String}} ID of the job run to delete.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.stopJobRun(projectId, jobId, runId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class stopJobRunExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var projectId = projectId_example;  // String | ID of the project containing the job
            var jobId = jobId_example;  // String | ID of the job containing the job run.
            var runId = runId_example;  // String | ID of the job run to delete.

            try
            {
                // Stops a job run. Encoded as a custom method.
                JobRun result = apiInstance.stopJobRun(projectId, jobId, runId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.stopJobRun: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$projectId = projectId_example; // String | ID of the project containing the job
$jobId = jobId_example; // String | ID of the job containing the job run.
$runId = runId_example; // String | ID of the job run to delete.

try {
    $result = $api_instance->stopJobRun($projectId, $jobId, $runId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->stopJobRun: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $projectId = projectId_example; # String | ID of the project containing the job
my $jobId = jobId_example; # String | ID of the job containing the job run.
my $runId = runId_example; # String | ID of the job run to delete.

eval { 
    my $result = $api_instance->stopJobRun(projectId => $projectId, jobId => $jobId, runId => $runId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->stopJobRun: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
projectId = projectId_example # String | ID of the project containing the job
jobId = jobId_example # String | ID of the job containing the job run.
runId = runId_example # String | ID of the job run to delete.

try: 
    # Stops a job run. Encoded as a custom method.
    api_response = api_instance.stop_job_run(projectId, jobId, runId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->stopJobRun: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
ID of the project containing the job
Required
job_id*
String
ID of the job containing the job run.
Required
run_id*
String
ID of the job run to delete.
Required

Responses

Status: 200 - A successful response.

Status: default - An unexpected error response


stopModelDeployment

Stop a model deployment.


/api/v2/projects/{project_id}/models/{model_id}/builds/{build_id}/deployments/{deployment_id}:stop

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
"//api/v2/projects/{project_id}/models/{model_id}/builds/{build_id}/deployments/{deployment_id}:stop"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | ID of the project containing the model.
        String modelId = modelId_example; // String | ID of the model containing the deployment.
        String buildId = buildId_example; // String | ID of the build containing the deployment.
        String deploymentId = deploymentId_example; // String | ID of the deployment to stop.
        try {
            ModelDeployment result = apiInstance.stopModelDeployment(projectId, modelId, buildId, deploymentId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#stopModelDeployment");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | ID of the project containing the model.
        String modelId = modelId_example; // String | ID of the model containing the deployment.
        String buildId = buildId_example; // String | ID of the build containing the deployment.
        String deploymentId = deploymentId_example; // String | ID of the deployment to stop.
        try {
            ModelDeployment result = apiInstance.stopModelDeployment(projectId, modelId, buildId, deploymentId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#stopModelDeployment");
            e.printStackTrace();
        }
    }
}
String *projectId = projectId_example; // ID of the project containing the model.
String *modelId = modelId_example; // ID of the model containing the deployment.
String *buildId = buildId_example; // ID of the build containing the deployment.
String *deploymentId = deploymentId_example; // ID of the deployment to stop.

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Stop a model deployment.
[apiInstance stopModelDeploymentWith:projectId
    modelId:modelId
    buildId:buildId
    deploymentId:deploymentId
              completionHandler: ^(ModelDeployment output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var projectId = projectId_example; // {{String}} ID of the project containing the model.
var modelId = modelId_example; // {{String}} ID of the model containing the deployment.
var buildId = buildId_example; // {{String}} ID of the build containing the deployment.
var deploymentId = deploymentId_example; // {{String}} ID of the deployment to stop.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.stopModelDeployment(projectId, modelId, buildId, deploymentId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class stopModelDeploymentExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var projectId = projectId_example;  // String | ID of the project containing the model.
            var modelId = modelId_example;  // String | ID of the model containing the deployment.
            var buildId = buildId_example;  // String | ID of the build containing the deployment.
            var deploymentId = deploymentId_example;  // String | ID of the deployment to stop.

            try
            {
                // Stop a model deployment.
                ModelDeployment result = apiInstance.stopModelDeployment(projectId, modelId, buildId, deploymentId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.stopModelDeployment: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$projectId = projectId_example; // String | ID of the project containing the model.
$modelId = modelId_example; // String | ID of the model containing the deployment.
$buildId = buildId_example; // String | ID of the build containing the deployment.
$deploymentId = deploymentId_example; // String | ID of the deployment to stop.

try {
    $result = $api_instance->stopModelDeployment($projectId, $modelId, $buildId, $deploymentId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->stopModelDeployment: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $projectId = projectId_example; # String | ID of the project containing the model.
my $modelId = modelId_example; # String | ID of the model containing the deployment.
my $buildId = buildId_example; # String | ID of the build containing the deployment.
my $deploymentId = deploymentId_example; # String | ID of the deployment to stop.

eval { 
    my $result = $api_instance->stopModelDeployment(projectId => $projectId, modelId => $modelId, buildId => $buildId, deploymentId => $deploymentId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->stopModelDeployment: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
projectId = projectId_example # String | ID of the project containing the model.
modelId = modelId_example # String | ID of the model containing the deployment.
buildId = buildId_example # String | ID of the build containing the deployment.
deploymentId = deploymentId_example # String | ID of the deployment to stop.

try: 
    # Stop a model deployment.
    api_response = api_instance.stop_model_deployment(projectId, modelId, buildId, deploymentId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->stopModelDeployment: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
ID of the project containing the model.
Required
model_id*
String
ID of the model containing the deployment.
Required
build_id*
String
ID of the build containing the deployment.
Required
deployment_id*
String
ID of the deployment to stop.
Required

Responses

Status: 200 - A successful response.

Status: default - An unexpected error response


updateApplication

Update an application


/api/v2/projects/{project_id}/applications/{application.id}

Usage and SDK Samples

curl -X PATCH\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//api/v2/projects/{project_id}/applications/{application.id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        Application body = ; // Application | The application containing some number of fields to update.
        String projectId = projectId_example; // String | The public project identifier
        String application.id = application.id_example; // String | public identifier of the application.
        try {
            Application result = apiInstance.updateApplication(body, projectId, application.id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#updateApplication");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        Application body = ; // Application | The application containing some number of fields to update.
        String projectId = projectId_example; // String | The public project identifier
        String application.id = application.id_example; // String | public identifier of the application.
        try {
            Application result = apiInstance.updateApplication(body, projectId, application.id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#updateApplication");
            e.printStackTrace();
        }
    }
}
Application *body = ; // The application containing some number of fields to update.
String *projectId = projectId_example; // The public project identifier
String *application.id = application.id_example; // public identifier of the application.

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Update an application
[apiInstance updateApplicationWith:body
    projectId:projectId
    application.id:application.id
              completionHandler: ^(Application output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var body = ; // {{Application}} The application containing some number of fields to update.
var projectId = projectId_example; // {{String}} The public project identifier
var application.id = application.id_example; // {{String}} public identifier of the application.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateApplication(bodyprojectIdapplication.id, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateApplicationExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var body = new Application(); // Application | The application containing some number of fields to update.
            var projectId = projectId_example;  // String | The public project identifier
            var application.id = application.id_example;  // String | public identifier of the application.

            try
            {
                // Update an application
                Application result = apiInstance.updateApplication(body, projectId, application.id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.updateApplication: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$body = ; // Application | The application containing some number of fields to update.
$projectId = projectId_example; // String | The public project identifier
$application.id = application.id_example; // String | public identifier of the application.

try {
    $result = $api_instance->updateApplication($body, $projectId, $application.id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->updateApplication: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $body = WWW::SwaggerClient::Object::Application->new(); # Application | The application containing some number of fields to update.
my $projectId = projectId_example; # String | The public project identifier
my $application.id = application.id_example; # String | public identifier of the application.

eval { 
    my $result = $api_instance->updateApplication(body => $body, projectId => $projectId, application.id => $application.id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->updateApplication: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
body =  # Application | The application containing some number of fields to update.
projectId = projectId_example # String | The public project identifier
application.id = application.id_example # String | public identifier of the application.

try: 
    # Update an application
    api_response = api_instance.update_application(body, projectId, application.id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->updateApplication: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
The public project identifier
Required
application.id*
String
public identifier of the application.
Required
Body parameters
Name Description
body *

Responses

Status: 200 - A successful response.

Status: default - An unexpected error response


updateExperiment

Update an existing experiment.


/api/v2/projects/{experiment.project_id}/experiments/{experiment.id}

Usage and SDK Samples

curl -X PATCH\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//api/v2/projects/{experiment.project_id}/experiments/{experiment.id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        Experiment body = ; // Experiment | 
        String experiment.projectId = experiment.projectId_example; // String | Project ID
        String experiment.id = experiment.id_example; // String | Unique identifier for the experiment.
        try {
            Experiment result = apiInstance.updateExperiment(body, experiment.projectId, experiment.id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#updateExperiment");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        Experiment body = ; // Experiment | 
        String experiment.projectId = experiment.projectId_example; // String | Project ID
        String experiment.id = experiment.id_example; // String | Unique identifier for the experiment.
        try {
            Experiment result = apiInstance.updateExperiment(body, experiment.projectId, experiment.id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#updateExperiment");
            e.printStackTrace();
        }
    }
}
Experiment *body = ; // 
String *experiment.projectId = experiment.projectId_example; // Project ID
String *experiment.id = experiment.id_example; // Unique identifier for the experiment.

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Update an existing experiment.
[apiInstance updateExperimentWith:body
    experiment.projectId:experiment.projectId
    experiment.id:experiment.id
              completionHandler: ^(Experiment output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var body = ; // {{Experiment}} 
var experiment.projectId = experiment.projectId_example; // {{String}} Project ID
var experiment.id = experiment.id_example; // {{String}} Unique identifier for the experiment.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateExperiment(bodyexperiment.projectIdexperiment.id, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateExperimentExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var body = new Experiment(); // Experiment | 
            var experiment.projectId = experiment.projectId_example;  // String | Project ID
            var experiment.id = experiment.id_example;  // String | Unique identifier for the experiment.

            try
            {
                // Update an existing experiment.
                Experiment result = apiInstance.updateExperiment(body, experiment.projectId, experiment.id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.updateExperiment: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$body = ; // Experiment | 
$experiment.projectId = experiment.projectId_example; // String | Project ID
$experiment.id = experiment.id_example; // String | Unique identifier for the experiment.

try {
    $result = $api_instance->updateExperiment($body, $experiment.projectId, $experiment.id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->updateExperiment: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $body = WWW::SwaggerClient::Object::Experiment->new(); # Experiment | 
my $experiment.projectId = experiment.projectId_example; # String | Project ID
my $experiment.id = experiment.id_example; # String | Unique identifier for the experiment.

eval { 
    my $result = $api_instance->updateExperiment(body => $body, experiment.projectId => $experiment.projectId, experiment.id => $experiment.id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->updateExperiment: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
body =  # Experiment | 
experiment.projectId = experiment.projectId_example # String | Project ID
experiment.id = experiment.id_example # String | Unique identifier for the experiment.

try: 
    # Update an existing experiment.
    api_response = api_instance.update_experiment(body, experiment.projectId, experiment.id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->updateExperiment: %s\n" % e)

Parameters

Path parameters
Name Description
experiment.project_id*
String
Project ID
Required
experiment.id*
String
Unique identifier for the experiment.
Required
Body parameters
Name Description
body *

Responses

Status: 200 - A successful response.

Status: default - An unexpected error response


updateExperimentRun

Update an experiment run.


/api/v2/projects/{project_id}/experiments/{experiment_id}/runs/{run.id}

Usage and SDK Samples

curl -X PATCH\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//api/v2/projects/{project_id}/experiments/{experiment_id}/runs/{run.id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        ExperimentRun body = ; // ExperimentRun | 
        String projectId = projectId_example; // String | The project where the experiment run lives
        String experimentId = experimentId_example; // String | ID of the associated experiment.
        String run.id = run.id_example; // String | Unique identifier for the ExperimentRun.
        try {
            ExperimentRun result = apiInstance.updateExperimentRun(body, projectId, experimentId, run.id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#updateExperimentRun");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        ExperimentRun body = ; // ExperimentRun | 
        String projectId = projectId_example; // String | The project where the experiment run lives
        String experimentId = experimentId_example; // String | ID of the associated experiment.
        String run.id = run.id_example; // String | Unique identifier for the ExperimentRun.
        try {
            ExperimentRun result = apiInstance.updateExperimentRun(body, projectId, experimentId, run.id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#updateExperimentRun");
            e.printStackTrace();
        }
    }
}
ExperimentRun *body = ; // 
String *projectId = projectId_example; // The project where the experiment run lives
String *experimentId = experimentId_example; // ID of the associated experiment.
String *run.id = run.id_example; // Unique identifier for the ExperimentRun.

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Update an experiment run.
[apiInstance updateExperimentRunWith:body
    projectId:projectId
    experimentId:experimentId
    run.id:run.id
              completionHandler: ^(ExperimentRun output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var body = ; // {{ExperimentRun}} 
var projectId = projectId_example; // {{String}} The project where the experiment run lives
var experimentId = experimentId_example; // {{String}} ID of the associated experiment.
var run.id = run.id_example; // {{String}} Unique identifier for the ExperimentRun.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateExperimentRun(bodyprojectIdexperimentIdrun.id, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateExperimentRunExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var body = new ExperimentRun(); // ExperimentRun | 
            var projectId = projectId_example;  // String | The project where the experiment run lives
            var experimentId = experimentId_example;  // String | ID of the associated experiment.
            var run.id = run.id_example;  // String | Unique identifier for the ExperimentRun.

            try
            {
                // Update an experiment run.
                ExperimentRun result = apiInstance.updateExperimentRun(body, projectId, experimentId, run.id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.updateExperimentRun: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$body = ; // ExperimentRun | 
$projectId = projectId_example; // String | The project where the experiment run lives
$experimentId = experimentId_example; // String | ID of the associated experiment.
$run.id = run.id_example; // String | Unique identifier for the ExperimentRun.

try {
    $result = $api_instance->updateExperimentRun($body, $projectId, $experimentId, $run.id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->updateExperimentRun: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $body = WWW::SwaggerClient::Object::ExperimentRun->new(); # ExperimentRun | 
my $projectId = projectId_example; # String | The project where the experiment run lives
my $experimentId = experimentId_example; # String | ID of the associated experiment.
my $run.id = run.id_example; # String | Unique identifier for the ExperimentRun.

eval { 
    my $result = $api_instance->updateExperimentRun(body => $body, projectId => $projectId, experimentId => $experimentId, run.id => $run.id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->updateExperimentRun: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
body =  # ExperimentRun | 
projectId = projectId_example # String | The project where the experiment run lives
experimentId = experimentId_example # String | ID of the associated experiment.
run.id = run.id_example # String | Unique identifier for the ExperimentRun.

try: 
    # Update an experiment run.
    api_response = api_instance.update_experiment_run(body, projectId, experimentId, run.id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->updateExperimentRun: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
The project where the experiment run lives
Required
experiment_id*
String
ID of the associated experiment.
Required
run.id*
String
Unique identifier for the ExperimentRun.
Required
Body parameters
Name Description
body *

Responses

Status: 200 - A successful response.

Status: default - An unexpected error response


updateJob

Updates a job.


/api/v2/projects/{project_id}/jobs/{job.id}

Usage and SDK Samples

curl -X PATCH\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//api/v2/projects/{project_id}/jobs/{job.id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        Job body = ; // Job | The job containing some number of fields to update.
        String projectId = projectId_example; // String | The project containing the job.
        String job.id = job.id_example; // String | Public identifier of the job.
Output only.
        try {
            Job result = apiInstance.updateJob(body, projectId, job.id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#updateJob");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        Job body = ; // Job | The job containing some number of fields to update.
        String projectId = projectId_example; // String | The project containing the job.
        String job.id = job.id_example; // String | Public identifier of the job.
Output only.
        try {
            Job result = apiInstance.updateJob(body, projectId, job.id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#updateJob");
            e.printStackTrace();
        }
    }
}
Job *body = ; // The job containing some number of fields to update.
String *projectId = projectId_example; // The project containing the job.
String *job.id = job.id_example; // Public identifier of the job.
Output only.

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Updates a job.
[apiInstance updateJobWith:body
    projectId:projectId
    job.id:job.id
              completionHandler: ^(Job output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var body = ; // {{Job}} The job containing some number of fields to update.
var projectId = projectId_example; // {{String}} The project containing the job.
var job.id = job.id_example; // {{String}} Public identifier of the job.
Output only.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateJob(bodyprojectIdjob.id, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateJobExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var body = new Job(); // Job | The job containing some number of fields to update.
            var projectId = projectId_example;  // String | The project containing the job.
            var job.id = job.id_example;  // String | Public identifier of the job.
Output only.

            try
            {
                // Updates a job.
                Job result = apiInstance.updateJob(body, projectId, job.id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.updateJob: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$body = ; // Job | The job containing some number of fields to update.
$projectId = projectId_example; // String | The project containing the job.
$job.id = job.id_example; // String | Public identifier of the job.
Output only.

try {
    $result = $api_instance->updateJob($body, $projectId, $job.id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->updateJob: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $body = WWW::SwaggerClient::Object::Job->new(); # Job | The job containing some number of fields to update.
my $projectId = projectId_example; # String | The project containing the job.
my $job.id = job.id_example; # String | Public identifier of the job.
Output only.

eval { 
    my $result = $api_instance->updateJob(body => $body, projectId => $projectId, job.id => $job.id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->updateJob: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
body =  # Job | The job containing some number of fields to update.
projectId = projectId_example # String | The project containing the job.
job.id = job.id_example # String | Public identifier of the job.
Output only.

try: 
    # Updates a job.
    api_response = api_instance.update_job(body, projectId, job.id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->updateJob: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
The project containing the job.
Required
job.id*
String
Public identifier of the job. Output only.
Required
Body parameters
Name Description
body *

Responses

Status: 200 - A successful response.

Status: default - An unexpected error response


updateModel

Update a model.


/api/v2/projects/{project_id}/models/{model.id}

Usage and SDK Samples

curl -X PATCH\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//api/v2/projects/{project_id}/models/{model.id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        UpdateSingleModel body = ; // UpdateSingleModel | The model containing some number of fields to update.
        String projectId = projectId_example; // String | ID of the project containing the model.
        String model.id = model.id_example; // String | ID of the model.
A model CRN looks like /. The ID is the UUID portion of the CRN.
        try {
            Model result = apiInstance.updateModel(body, projectId, model.id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#updateModel");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        UpdateSingleModel body = ; // UpdateSingleModel | The model containing some number of fields to update.
        String projectId = projectId_example; // String | ID of the project containing the model.
        String model.id = model.id_example; // String | ID of the model.
A model CRN looks like /. The ID is the UUID portion of the CRN.
        try {
            Model result = apiInstance.updateModel(body, projectId, model.id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#updateModel");
            e.printStackTrace();
        }
    }
}
UpdateSingleModel *body = ; // The model containing some number of fields to update.
String *projectId = projectId_example; // ID of the project containing the model.
String *model.id = model.id_example; // ID of the model.
A model CRN looks like /. The ID is the UUID portion of the CRN.

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Update a model.
[apiInstance updateModelWith:body
    projectId:projectId
    model.id:model.id
              completionHandler: ^(Model output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var body = ; // {{UpdateSingleModel}} The model containing some number of fields to update.
var projectId = projectId_example; // {{String}} ID of the project containing the model.
var model.id = model.id_example; // {{String}} ID of the model.
A model CRN looks like /. The ID is the UUID portion of the CRN.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateModel(bodyprojectIdmodel.id, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateModelExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var body = new UpdateSingleModel(); // UpdateSingleModel | The model containing some number of fields to update.
            var projectId = projectId_example;  // String | ID of the project containing the model.
            var model.id = model.id_example;  // String | ID of the model.
A model CRN looks like /. The ID is the UUID portion of the CRN.

            try
            {
                // Update a model.
                Model result = apiInstance.updateModel(body, projectId, model.id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.updateModel: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$body = ; // UpdateSingleModel | The model containing some number of fields to update.
$projectId = projectId_example; // String | ID of the project containing the model.
$model.id = model.id_example; // String | ID of the model.
A model CRN looks like /. The ID is the UUID portion of the CRN.

try {
    $result = $api_instance->updateModel($body, $projectId, $model.id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->updateModel: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $body = WWW::SwaggerClient::Object::UpdateSingleModel->new(); # UpdateSingleModel | The model containing some number of fields to update.
my $projectId = projectId_example; # String | ID of the project containing the model.
my $model.id = model.id_example; # String | ID of the model.
A model CRN looks like /. The ID is the UUID portion of the CRN.

eval { 
    my $result = $api_instance->updateModel(body => $body, projectId => $projectId, model.id => $model.id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->updateModel: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
body =  # UpdateSingleModel | The model containing some number of fields to update.
projectId = projectId_example # String | ID of the project containing the model.
model.id = model.id_example # String | ID of the model.
A model CRN looks like /. The ID is the UUID portion of the CRN.

try: 
    # Update a model.
    api_response = api_instance.update_model(body, projectId, model.id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->updateModel: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
ID of the project containing the model.
Required
model.id*
String
ID of the model. A model CRN looks like <workspace CRN>/<UUID>. The ID is the UUID portion of the CRN.
Required
Body parameters
Name Description
body *

Responses

Status: 200 - A successful response.

Status: default - An unexpected error response


updateProject

Update an existing project.


/api/v2/projects/{project.id}

Usage and SDK Samples

curl -X PATCH\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//api/v2/projects/{project.id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        Project body = ; // Project | The project object containing some number of fields to update.
        String project.id = project.id_example; // String | An opaque public identifier for the project.
Output only.
        try {
            Project result = apiInstance.updateProject(body, project.id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#updateProject");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        Project body = ; // Project | The project object containing some number of fields to update.
        String project.id = project.id_example; // String | An opaque public identifier for the project.
Output only.
        try {
            Project result = apiInstance.updateProject(body, project.id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#updateProject");
            e.printStackTrace();
        }
    }
}
Project *body = ; // The project object containing some number of fields to update.
String *project.id = project.id_example; // An opaque public identifier for the project.
Output only.

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Update an existing project.
[apiInstance updateProjectWith:body
    project.id:project.id
              completionHandler: ^(Project output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var body = ; // {{Project}} The project object containing some number of fields to update.
var project.id = project.id_example; // {{String}} An opaque public identifier for the project.
Output only.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateProject(bodyproject.id, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateProjectExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var body = new Project(); // Project | The project object containing some number of fields to update.
            var project.id = project.id_example;  // String | An opaque public identifier for the project.
Output only.

            try
            {
                // Update an existing project.
                Project result = apiInstance.updateProject(body, project.id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.updateProject: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$body = ; // Project | The project object containing some number of fields to update.
$project.id = project.id_example; // String | An opaque public identifier for the project.
Output only.

try {
    $result = $api_instance->updateProject($body, $project.id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->updateProject: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $body = WWW::SwaggerClient::Object::Project->new(); # Project | The project object containing some number of fields to update.
my $project.id = project.id_example; # String | An opaque public identifier for the project.
Output only.

eval { 
    my $result = $api_instance->updateProject(body => $body, project.id => $project.id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->updateProject: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
body =  # Project | The project object containing some number of fields to update.
project.id = project.id_example # String | An opaque public identifier for the project.
Output only.

try: 
    # Update an existing project.
    api_response = api_instance.update_project(body, project.id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->updateProject: %s\n" % e)

Parameters

Path parameters
Name Description
project.id*
String
An opaque public identifier for the project. Output only.
Required
Body parameters
Name Description
body *

Responses

Status: 200 - A successful response.

Status: default - An unexpected error response


updateProjectFileMetadata

Update file metadata, such as renaming.


/api/v2/projects/{project_id}/files/{path}

Usage and SDK Samples

curl -X PATCH\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//api/v2/projects/{project_id}/files/{path}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        FileInfo body = ; // FileInfo | The FileInfo object representing the updated metadata for the file.
        String projectId = projectId_example; // String | The identifier of the project that contains the file or directory.
        String path = path_example; // String | The path to the file to update, relative to /home/cdsw
        try {
            FileInfo result = apiInstance.updateProjectFileMetadata(body, projectId, path);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#updateProjectFileMetadata");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        FileInfo body = ; // FileInfo | The FileInfo object representing the updated metadata for the file.
        String projectId = projectId_example; // String | The identifier of the project that contains the file or directory.
        String path = path_example; // String | The path to the file to update, relative to /home/cdsw
        try {
            FileInfo result = apiInstance.updateProjectFileMetadata(body, projectId, path);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#updateProjectFileMetadata");
            e.printStackTrace();
        }
    }
}
FileInfo *body = ; // The FileInfo object representing the updated metadata for the file.
String *projectId = projectId_example; // The identifier of the project that contains the file or directory.
String *path = path_example; // The path to the file to update, relative to /home/cdsw

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Update file metadata, such as renaming.
[apiInstance updateProjectFileMetadataWith:body
    projectId:projectId
    path:path
              completionHandler: ^(FileInfo output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var body = ; // {{FileInfo}} The FileInfo object representing the updated metadata for the file.
var projectId = projectId_example; // {{String}} The identifier of the project that contains the file or directory.
var path = path_example; // {{String}} The path to the file to update, relative to /home/cdsw

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateProjectFileMetadata(bodyprojectIdpath, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateProjectFileMetadataExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var body = new FileInfo(); // FileInfo | The FileInfo object representing the updated metadata for the file.
            var projectId = projectId_example;  // String | The identifier of the project that contains the file or directory.
            var path = path_example;  // String | The path to the file to update, relative to /home/cdsw

            try
            {
                // Update file metadata, such as renaming.
                FileInfo result = apiInstance.updateProjectFileMetadata(body, projectId, path);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.updateProjectFileMetadata: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$body = ; // FileInfo | The FileInfo object representing the updated metadata for the file.
$projectId = projectId_example; // String | The identifier of the project that contains the file or directory.
$path = path_example; // String | The path to the file to update, relative to /home/cdsw

try {
    $result = $api_instance->updateProjectFileMetadata($body, $projectId, $path);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->updateProjectFileMetadata: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $body = WWW::SwaggerClient::Object::FileInfo->new(); # FileInfo | The FileInfo object representing the updated metadata for the file.
my $projectId = projectId_example; # String | The identifier of the project that contains the file or directory.
my $path = path_example; # String | The path to the file to update, relative to /home/cdsw

eval { 
    my $result = $api_instance->updateProjectFileMetadata(body => $body, projectId => $projectId, path => $path);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->updateProjectFileMetadata: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
body =  # FileInfo | The FileInfo object representing the updated metadata for the file.
projectId = projectId_example # String | The identifier of the project that contains the file or directory.
path = path_example # String | The path to the file to update, relative to /home/cdsw

try: 
    # Update file metadata, such as renaming.
    api_response = api_instance.update_project_file_metadata(body, projectId, path)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->updateProjectFileMetadata: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
The identifier of the project that contains the file or directory.
Required
path*
String
The path to the file to update, relative to /home/cdsw
Required
Body parameters
Name Description
body *

Responses

Status: 200 - A successful response.

Status: default - An unexpected error response


updateRegisteredModel

Update a Registered model.


/api/v2/registry/models

Usage and SDK Samples

curl -X PATCH\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//api/v2/registry/models"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        UpdateRegisteredModelRequest body = ; // UpdateRegisteredModelRequest | 
        try {
            RegisteredModel result = apiInstance.updateRegisteredModel(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#updateRegisteredModel");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        UpdateRegisteredModelRequest body = ; // UpdateRegisteredModelRequest | 
        try {
            RegisteredModel result = apiInstance.updateRegisteredModel(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#updateRegisteredModel");
            e.printStackTrace();
        }
    }
}
UpdateRegisteredModelRequest *body = ; // 

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Update a Registered model.
[apiInstance updateRegisteredModelWith:body
              completionHandler: ^(RegisteredModel output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var body = ; // {{UpdateRegisteredModelRequest}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateRegisteredModel(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateRegisteredModelExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var body = new UpdateRegisteredModelRequest(); // UpdateRegisteredModelRequest | 

            try
            {
                // Update a Registered model.
                RegisteredModel result = apiInstance.updateRegisteredModel(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.updateRegisteredModel: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$body = ; // UpdateRegisteredModelRequest | 

try {
    $result = $api_instance->updateRegisteredModel($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->updateRegisteredModel: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $body = WWW::SwaggerClient::Object::UpdateRegisteredModelRequest->new(); # UpdateRegisteredModelRequest | 

eval { 
    my $result = $api_instance->updateRegisteredModel(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->updateRegisteredModel: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
body =  # UpdateRegisteredModelRequest | 

try: 
    # Update a Registered model.
    api_response = api_instance.update_registered_model(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->updateRegisteredModel: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - A successful response.

Status: default - An unexpected error response


updateRegisteredModelVersion

Update a Registered model version.


/api/v2/registry/models/{model_id}

Usage and SDK Samples

curl -X PATCH\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//api/v2/registry/models/{model_id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        UpdateRegisteredModelVersionRequest body = ; // UpdateRegisteredModelVersionRequest | 
        String modelId = modelId_example; // String | Model ID.
        try {
            RegisteredModelVersion result = apiInstance.updateRegisteredModelVersion(body, modelId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#updateRegisteredModelVersion");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        UpdateRegisteredModelVersionRequest body = ; // UpdateRegisteredModelVersionRequest | 
        String modelId = modelId_example; // String | Model ID.
        try {
            RegisteredModelVersion result = apiInstance.updateRegisteredModelVersion(body, modelId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#updateRegisteredModelVersion");
            e.printStackTrace();
        }
    }
}
UpdateRegisteredModelVersionRequest *body = ; // 
String *modelId = modelId_example; // Model ID.

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Update a Registered model version.
[apiInstance updateRegisteredModelVersionWith:body
    modelId:modelId
              completionHandler: ^(RegisteredModelVersion output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var body = ; // {{UpdateRegisteredModelVersionRequest}} 
var modelId = modelId_example; // {{String}} Model ID.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateRegisteredModelVersion(bodymodelId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateRegisteredModelVersionExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var body = new UpdateRegisteredModelVersionRequest(); // UpdateRegisteredModelVersionRequest | 
            var modelId = modelId_example;  // String | Model ID.

            try
            {
                // Update a Registered model version.
                RegisteredModelVersion result = apiInstance.updateRegisteredModelVersion(body, modelId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.updateRegisteredModelVersion: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$body = ; // UpdateRegisteredModelVersionRequest | 
$modelId = modelId_example; // String | Model ID.

try {
    $result = $api_instance->updateRegisteredModelVersion($body, $modelId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->updateRegisteredModelVersion: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $body = WWW::SwaggerClient::Object::UpdateRegisteredModelVersionRequest->new(); # UpdateRegisteredModelVersionRequest | 
my $modelId = modelId_example; # String | Model ID.

eval { 
    my $result = $api_instance->updateRegisteredModelVersion(body => $body, modelId => $modelId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->updateRegisteredModelVersion: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
body =  # UpdateRegisteredModelVersionRequest | 
modelId = modelId_example # String | Model ID.

try: 
    # Update a Registered model version.
    api_response = api_instance.update_registered_model_version(body, modelId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->updateRegisteredModelVersion: %s\n" % e)

Parameters

Path parameters
Name Description
model_id*
String
Model ID.
Required
Body parameters
Name Description
body *

Responses

Status: 200 - A successful response.

Status: default - An unexpected error response


updateRuntimeAddonStatus

Update runtime addons


/api/v2/runtimeaddons:updatestatus

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//api/v2/runtimeaddons:updatestatus"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        UpdateRuntimeAddonStatusRequest body = ; // UpdateRuntimeAddonStatusRequest | 
        try {
            UpdateRuntimeAddonStatusResponse result = apiInstance.updateRuntimeAddonStatus(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#updateRuntimeAddonStatus");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        UpdateRuntimeAddonStatusRequest body = ; // UpdateRuntimeAddonStatusRequest | 
        try {
            UpdateRuntimeAddonStatusResponse result = apiInstance.updateRuntimeAddonStatus(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#updateRuntimeAddonStatus");
            e.printStackTrace();
        }
    }
}
UpdateRuntimeAddonStatusRequest *body = ; // 

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Update runtime addons
[apiInstance updateRuntimeAddonStatusWith:body
              completionHandler: ^(UpdateRuntimeAddonStatusResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var body = ; // {{UpdateRuntimeAddonStatusRequest}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateRuntimeAddonStatus(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateRuntimeAddonStatusExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var body = new UpdateRuntimeAddonStatusRequest(); // UpdateRuntimeAddonStatusRequest | 

            try
            {
                // Update runtime addons
                UpdateRuntimeAddonStatusResponse result = apiInstance.updateRuntimeAddonStatus(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.updateRuntimeAddonStatus: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$body = ; // UpdateRuntimeAddonStatusRequest | 

try {
    $result = $api_instance->updateRuntimeAddonStatus($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->updateRuntimeAddonStatus: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $body = WWW::SwaggerClient::Object::UpdateRuntimeAddonStatusRequest->new(); # UpdateRuntimeAddonStatusRequest | 

eval { 
    my $result = $api_instance->updateRuntimeAddonStatus(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->updateRuntimeAddonStatus: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
body =  # UpdateRuntimeAddonStatusRequest | 

try: 
    # Update runtime addons
    api_response = api_instance.update_runtime_addon_status(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->updateRuntimeAddonStatus: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - A successful response.

Status: default - An unexpected error response


updateRuntimeRepo

Update a Runtime repo.


/api/v2/runtimerepos/{runtimerepo.id}

Usage and SDK Samples

curl -X PATCH\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//api/v2/runtimerepos/{runtimerepo.id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        RuntimeRepo body = ; // RuntimeRepo | The runtimerepo object containing some number of fields to update.
        Integer runtimerepo.id = 56; // Integer | The numeric identifier for this runtime repo
        try {
            RuntimeRepo result = apiInstance.updateRuntimeRepo(body, runtimerepo.id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#updateRuntimeRepo");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        RuntimeRepo body = ; // RuntimeRepo | The runtimerepo object containing some number of fields to update.
        Integer runtimerepo.id = 56; // Integer | The numeric identifier for this runtime repo
        try {
            RuntimeRepo result = apiInstance.updateRuntimeRepo(body, runtimerepo.id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#updateRuntimeRepo");
            e.printStackTrace();
        }
    }
}
RuntimeRepo *body = ; // The runtimerepo object containing some number of fields to update.
Integer *runtimerepo.id = 56; // The numeric identifier for this runtime repo

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Update a Runtime repo.
[apiInstance updateRuntimeRepoWith:body
    runtimerepo.id:runtimerepo.id
              completionHandler: ^(RuntimeRepo output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var body = ; // {{RuntimeRepo}} The runtimerepo object containing some number of fields to update.
var runtimerepo.id = 56; // {{Integer}} The numeric identifier for this runtime repo

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateRuntimeRepo(bodyruntimerepo.id, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateRuntimeRepoExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var body = new RuntimeRepo(); // RuntimeRepo | The runtimerepo object containing some number of fields to update.
            var runtimerepo.id = 56;  // Integer | The numeric identifier for this runtime repo

            try
            {
                // Update a Runtime repo.
                RuntimeRepo result = apiInstance.updateRuntimeRepo(body, runtimerepo.id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.updateRuntimeRepo: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$body = ; // RuntimeRepo | The runtimerepo object containing some number of fields to update.
$runtimerepo.id = 56; // Integer | The numeric identifier for this runtime repo

try {
    $result = $api_instance->updateRuntimeRepo($body, $runtimerepo.id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->updateRuntimeRepo: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $body = WWW::SwaggerClient::Object::RuntimeRepo->new(); # RuntimeRepo | The runtimerepo object containing some number of fields to update.
my $runtimerepo.id = 56; # Integer | The numeric identifier for this runtime repo

eval { 
    my $result = $api_instance->updateRuntimeRepo(body => $body, runtimerepo.id => $runtimerepo.id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->updateRuntimeRepo: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
body =  # RuntimeRepo | The runtimerepo object containing some number of fields to update.
runtimerepo.id = 56 # Integer | The numeric identifier for this runtime repo

try: 
    # Update a Runtime repo.
    api_response = api_instance.update_runtime_repo(body, runtimerepo.id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->updateRuntimeRepo: %s\n" % e)

Parameters

Path parameters
Name Description
runtimerepo.id*
Integer (int32)
The numeric identifier for this runtime repo
Required
Body parameters
Name Description
body *

Responses

Status: 200 - A successful response.

Status: default - An unexpected error response


updateRuntimeStatus

Update the status of selected runtimes


/api/v2/runtimes:update

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//api/v2/runtimes:update"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        UpdateRuntimeStatusRequest body = ; // UpdateRuntimeStatusRequest | 
        try {
            UpdateRuntimeStatusResponse result = apiInstance.updateRuntimeStatus(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#updateRuntimeStatus");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        UpdateRuntimeStatusRequest body = ; // UpdateRuntimeStatusRequest | 
        try {
            UpdateRuntimeStatusResponse result = apiInstance.updateRuntimeStatus(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#updateRuntimeStatus");
            e.printStackTrace();
        }
    }
}
UpdateRuntimeStatusRequest *body = ; // 

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Update the status of selected runtimes
[apiInstance updateRuntimeStatusWith:body
              completionHandler: ^(UpdateRuntimeStatusResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var body = ; // {{UpdateRuntimeStatusRequest}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateRuntimeStatus(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateRuntimeStatusExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var body = new UpdateRuntimeStatusRequest(); // UpdateRuntimeStatusRequest | 

            try
            {
                // Update the status of selected runtimes
                UpdateRuntimeStatusResponse result = apiInstance.updateRuntimeStatus(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.updateRuntimeStatus: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$body = ; // UpdateRuntimeStatusRequest | 

try {
    $result = $api_instance->updateRuntimeStatus($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->updateRuntimeStatus: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $body = WWW::SwaggerClient::Object::UpdateRuntimeStatusRequest->new(); # UpdateRuntimeStatusRequest | 

eval { 
    my $result = $api_instance->updateRuntimeStatus(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->updateRuntimeStatus: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
body =  # UpdateRuntimeStatusRequest | 

try: 
    # Update the status of selected runtimes
    api_response = api_instance.update_runtime_status(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->updateRuntimeStatus: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - A successful response.

Status: default - An unexpected error response


uploadFile

upload a file as a multi-part upload


/api/v2/projects/{project_id}/files

Usage and SDK Samples

curl -X POST\
-H "Content-Type: multipart/form-data"\
"//api/v2/projects/{project_id}/files"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | The project this model belongs to.
        byte[] file = file_example; // byte[] | 
        try {
            apiInstance.uploadFile(projectId, file);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#uploadFile");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | The project this model belongs to.
        byte[] file = file_example; // byte[] | 
        try {
            apiInstance.uploadFile(projectId, file);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#uploadFile");
            e.printStackTrace();
        }
    }
}
String *projectId = projectId_example; // The project this model belongs to.
byte[] *file = file_example; //  (optional)

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// upload a file as a multi-part upload
[apiInstance uploadFileWith:projectId
    file:file
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var projectId = projectId_example; // {{String}} The project this model belongs to.
var opts = { 
  'file': file_example // {{byte[]}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.uploadFile(projectId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class uploadFileExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var projectId = projectId_example;  // String | The project this model belongs to.
            var file = file_example;  // byte[] |  (optional) 

            try
            {
                // upload a file as a multi-part upload
                apiInstance.uploadFile(projectId, file);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.uploadFile: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$projectId = projectId_example; // String | The project this model belongs to.
$file = file_example; // byte[] | 

try {
    $api_instance->uploadFile($projectId, $file);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->uploadFile: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $projectId = projectId_example; # String | The project this model belongs to.
my $file = file_example; # byte[] | 

eval { 
    $api_instance->uploadFile(projectId => $projectId, file => $file);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->uploadFile: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
projectId = projectId_example # String | The project this model belongs to.
file = file_example # byte[] |  (optional)

try: 
    # upload a file as a multi-part upload
    api_instance.upload_file(projectId, file=file)
except ApiException as e:
    print("Exception when calling CMLServiceApi->uploadFile: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
The project this model belongs to.
Required
Form parameters
Name Description
file
byte[] (binary)

Responses

Status: 200 - A successful response.

Status: default - An unexpected error response.


validateCustomRuntime

Validate a runtime, given the URL to the image in the docker registry


/api/v2/runtimes:validate

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/runtimes:validate?url="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

import java.io.File;
import java.util.*;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String url = url_example; // String | 
        try {
            ValidateCustomRuntimeResponse result = apiInstance.validateCustomRuntime(url);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#validateCustomRuntime");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String url = url_example; // String | 
        try {
            ValidateCustomRuntimeResponse result = apiInstance.validateCustomRuntime(url);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#validateCustomRuntime");
            e.printStackTrace();
        }
    }
}
String *url = url_example; //  (optional)

CMLServiceApi *apiInstance = [[CMLServiceApi alloc] init];

// Validate a runtime, given the URL to the image in the docker registry
[apiInstance validateCustomRuntimeWith:url
              completionHandler: ^(ValidateCustomRuntimeResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var opts = { 
  'url': url_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.validateCustomRuntime(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class validateCustomRuntimeExample
    {
        public void main()
        {

            var apiInstance = new CMLServiceApi();
            var url = url_example;  // String |  (optional) 

            try
            {
                // Validate a runtime, given the URL to the image in the docker registry
                ValidateCustomRuntimeResponse result = apiInstance.validateCustomRuntime(url);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.validateCustomRuntime: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$url = url_example; // String | 

try {
    $result = $api_instance->validateCustomRuntime($url);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->validateCustomRuntime: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $url = url_example; # String | 

eval { 
    my $result = $api_instance->validateCustomRuntime(url => $url);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->validateCustomRuntime: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMLServiceApi()
url = url_example # String |  (optional)

try: 
    # Validate a runtime, given the URL to the image in the docker registry
    api_response = api_instance.validate_custom_runtime(url=url)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->validateCustomRuntime: %s\n" % e)

Parameters

Query parameters
Name Description
url
String

Responses

Status: 200 - A successful response.

Status: default - An unexpected error response