Cloudera Documentation

mlapiv2/api.proto

CMLService

cMLServiceAddProjectCollaborator

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.cMLServiceAddProjectCollaborator(body, projectId, username);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceAddProjectCollaborator");
            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.cMLServiceAddProjectCollaborator(body, projectId, username);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceAddProjectCollaborator");
            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 cMLServiceAddProjectCollaboratorWith: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.cMLServiceAddProjectCollaborator(bodyprojectIdusername, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class cMLServiceAddProjectCollaboratorExample
    {
        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.cMLServiceAddProjectCollaborator(body, projectId, username);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceAddProjectCollaborator: " + 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->cMLServiceAddProjectCollaborator($body, $projectId, $username);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->cMLServiceAddProjectCollaborator: ', $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->cMLServiceAddProjectCollaborator(body => $body, projectId => $projectId, username => $username);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceAddProjectCollaborator: $@\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.c_ml_service_add_project_collaborator(body, projectId, username)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceAddProjectCollaborator: %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


cMLServiceBatchListProjects

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.cMLServiceBatchListProjects(projectIds);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceBatchListProjects");
            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.cMLServiceBatchListProjects(projectIds);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceBatchListProjects");
            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 cMLServiceBatchListProjectsWith: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.cMLServiceBatchListProjects(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class cMLServiceBatchListProjectsExample
    {
        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.cMLServiceBatchListProjects(projectIds);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceBatchListProjects: " + 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->cMLServiceBatchListProjects($projectIds);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->cMLServiceBatchListProjects: ', $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->cMLServiceBatchListProjects(projectIds => $projectIds);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceBatchListProjects: $@\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.c_ml_service_batch_list_projects(projectIds=projectIds)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceBatchListProjects: %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


cMLServiceCreateApplication

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.cMLServiceCreateApplication(body, projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceCreateApplication");
            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.cMLServiceCreateApplication(body, projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceCreateApplication");
            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 cMLServiceCreateApplicationWith: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.cMLServiceCreateApplication(bodyprojectId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class cMLServiceCreateApplicationExample
    {
        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.cMLServiceCreateApplication(body, projectId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceCreateApplication: " + 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->cMLServiceCreateApplication($body, $projectId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->cMLServiceCreateApplication: ', $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->cMLServiceCreateApplication(body => $body, projectId => $projectId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceCreateApplication: $@\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.c_ml_service_create_application(body, projectId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceCreateApplication: %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


cMLServiceCreateCopilotModel

Create a Copilot model.


/api/v2/copilot/models

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//api/v2/copilot/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();
        CreateCopilotModelRequest body = ; // CreateCopilotModelRequest | 
        try {
            CopilotModel result = apiInstance.cMLServiceCreateCopilotModel(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceCreateCopilotModel");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

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

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

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

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

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

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

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

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

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

try {
    $result = $api_instance->cMLServiceCreateCopilotModel($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->cMLServiceCreateCopilotModel: ', $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::CreateCopilotModelRequest->new(); # CreateCopilotModelRequest | 

eval { 
    my $result = $api_instance->cMLServiceCreateCopilotModel(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceCreateCopilotModel: $@\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 =  # CreateCopilotModelRequest | 

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

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - A successful response.

Status: default - An unexpected error response


cMLServiceCreateExperiment

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.cMLServiceCreateExperiment(body, projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceCreateExperiment");
            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.cMLServiceCreateExperiment(body, projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceCreateExperiment");
            e.printStackTrace();
        }
    }
}
CreateExperimentRequest *body = ; // 
String *projectId = projectId_example; // 

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

// Create an experiment.
[apiInstance cMLServiceCreateExperimentWith: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.cMLServiceCreateExperiment(bodyprojectId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

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

            try
            {
                // Create an experiment.
                Experiment result = apiInstance.cMLServiceCreateExperiment(body, projectId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceCreateExperiment: " + 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->cMLServiceCreateExperiment($body, $projectId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->cMLServiceCreateExperiment: ', $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->cMLServiceCreateExperiment(body => $body, projectId => $projectId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceCreateExperiment: $@\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.c_ml_service_create_experiment(body, projectId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceCreateExperiment: %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


cMLServiceCreateExperimentRun

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.cMLServiceCreateExperimentRun(body, projectId, experimentId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceCreateExperimentRun");
            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.cMLServiceCreateExperimentRun(body, projectId, experimentId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceCreateExperimentRun");
            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 cMLServiceCreateExperimentRunWith: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.cMLServiceCreateExperimentRun(bodyprojectIdexperimentId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class cMLServiceCreateExperimentRunExample
    {
        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.cMLServiceCreateExperimentRun(body, projectId, experimentId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceCreateExperimentRun: " + 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->cMLServiceCreateExperimentRun($body, $projectId, $experimentId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->cMLServiceCreateExperimentRun: ', $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->cMLServiceCreateExperimentRun(body => $body, projectId => $projectId, experimentId => $experimentId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceCreateExperimentRun: $@\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.c_ml_service_create_experiment_run(body, projectId, experimentId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceCreateExperimentRun: %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


cMLServiceCreateJob

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.cMLServiceCreateJob(body, projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceCreateJob");
            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.cMLServiceCreateJob(body, projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceCreateJob");
            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 cMLServiceCreateJobWith: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.cMLServiceCreateJob(bodyprojectId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class cMLServiceCreateJobExample
    {
        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.cMLServiceCreateJob(body, projectId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceCreateJob: " + 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->cMLServiceCreateJob($body, $projectId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->cMLServiceCreateJob: ', $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->cMLServiceCreateJob(body => $body, projectId => $projectId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceCreateJob: $@\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.c_ml_service_create_job(body, projectId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceCreateJob: %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


cMLServiceCreateJobRun

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.cMLServiceCreateJobRun(body, projectId, jobId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceCreateJobRun");
            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.cMLServiceCreateJobRun(body, projectId, jobId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceCreateJobRun");
            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 cMLServiceCreateJobRunWith: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.cMLServiceCreateJobRun(bodyprojectIdjobId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class cMLServiceCreateJobRunExample
    {
        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.cMLServiceCreateJobRun(body, projectId, jobId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceCreateJobRun: " + 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->cMLServiceCreateJobRun($body, $projectId, $jobId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->cMLServiceCreateJobRun: ', $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->cMLServiceCreateJobRun(body => $body, projectId => $projectId, jobId => $jobId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceCreateJobRun: $@\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.c_ml_service_create_job_run(body, projectId, jobId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceCreateJobRun: %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


cMLServiceCreateModel

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.cMLServiceCreateModel(body, projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceCreateModel");
            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.cMLServiceCreateModel(body, projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceCreateModel");
            e.printStackTrace();
        }
    }
}
CreateModelRequest *body = ; // 
String *projectId = projectId_example; // ID of the project containing the model.

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

// Create a model.
[apiInstance cMLServiceCreateModelWith: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.cMLServiceCreateModel(bodyprojectId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class cMLServiceCreateModelExample
    {
        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.cMLServiceCreateModel(body, projectId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceCreateModel: " + 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->cMLServiceCreateModel($body, $projectId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->cMLServiceCreateModel: ', $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->cMLServiceCreateModel(body => $body, projectId => $projectId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceCreateModel: $@\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.c_ml_service_create_model(body, projectId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceCreateModel: %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


cMLServiceCreateModelBuild

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.cMLServiceCreateModelBuild(body, projectId, modelId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceCreateModelBuild");
            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.cMLServiceCreateModelBuild(body, projectId, modelId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceCreateModelBuild");
            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 cMLServiceCreateModelBuildWith: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.cMLServiceCreateModelBuild(bodyprojectIdmodelId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class cMLServiceCreateModelBuildExample
    {
        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.cMLServiceCreateModelBuild(body, projectId, modelId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceCreateModelBuild: " + 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->cMLServiceCreateModelBuild($body, $projectId, $modelId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->cMLServiceCreateModelBuild: ', $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->cMLServiceCreateModelBuild(body => $body, projectId => $projectId, modelId => $modelId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceCreateModelBuild: $@\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.c_ml_service_create_model_build(body, projectId, modelId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceCreateModelBuild: %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


cMLServiceCreateModelDeployment

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.cMLServiceCreateModelDeployment(body, projectId, modelId, buildId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceCreateModelDeployment");
            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.cMLServiceCreateModelDeployment(body, projectId, modelId, buildId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceCreateModelDeployment");
            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 cMLServiceCreateModelDeploymentWith: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.cMLServiceCreateModelDeployment(bodyprojectIdmodelIdbuildId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class cMLServiceCreateModelDeploymentExample
    {
        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.cMLServiceCreateModelDeployment(body, projectId, modelId, buildId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceCreateModelDeployment: " + 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->cMLServiceCreateModelDeployment($body, $projectId, $modelId, $buildId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->cMLServiceCreateModelDeployment: ', $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->cMLServiceCreateModelDeployment(body => $body, projectId => $projectId, modelId => $modelId, buildId => $buildId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceCreateModelDeployment: $@\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.c_ml_service_create_model_deployment(body, projectId, modelId, buildId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceCreateModelDeployment: %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


cMLServiceCreateProject

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.cMLServiceCreateProject(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceCreateProject");
            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.cMLServiceCreateProject(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceCreateProject");
            e.printStackTrace();
        }
    }
}
CreateProjectRequest *body = ; // 

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

// Create a new project.
[apiInstance cMLServiceCreateProjectWith: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.cMLServiceCreateProject(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

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

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

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

try {
    $result = $api_instance->cMLServiceCreateProject($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->cMLServiceCreateProject: ', $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->cMLServiceCreateProject(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceCreateProject: $@\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.c_ml_service_create_project(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceCreateProject: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - A successful response.

Status: default - An unexpected error response


cMLServiceCreateRegisteredModel

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.cMLServiceCreateRegisteredModel(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceCreateRegisteredModel");
            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.cMLServiceCreateRegisteredModel(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceCreateRegisteredModel");
            e.printStackTrace();
        }
    }
}
CreateRegisteredModelRequest *body = ; // 

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

// Register a model.
[apiInstance cMLServiceCreateRegisteredModelWith: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.cMLServiceCreateRegisteredModel(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

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

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

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

try {
    $result = $api_instance->cMLServiceCreateRegisteredModel($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->cMLServiceCreateRegisteredModel: ', $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->cMLServiceCreateRegisteredModel(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceCreateRegisteredModel: $@\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.c_ml_service_create_registered_model(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceCreateRegisteredModel: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - A successful response.

Status: default - An unexpected error response


cMLServiceCreateRuntimeRepo

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.cMLServiceCreateRuntimeRepo(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceCreateRuntimeRepo");
            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.cMLServiceCreateRuntimeRepo(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceCreateRuntimeRepo");
            e.printStackTrace();
        }
    }
}
CreateRuntimeRepoRequest *body = ; // 

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

// Create a  Runtime repo.
[apiInstance cMLServiceCreateRuntimeRepoWith: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.cMLServiceCreateRuntimeRepo(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

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

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

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

try {
    $result = $api_instance->cMLServiceCreateRuntimeRepo($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->cMLServiceCreateRuntimeRepo: ', $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->cMLServiceCreateRuntimeRepo(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceCreateRuntimeRepo: $@\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.c_ml_service_create_runtime_repo(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceCreateRuntimeRepo: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - A successful response.

Status: default - An unexpected error response


cMLServiceCreateTeam

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.cMLServiceCreateTeam(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceCreateTeam");
            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.cMLServiceCreateTeam(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceCreateTeam");
            e.printStackTrace();
        }
    }
}
CreateTeamRequest *body = ; // 

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

// Create a team.
[apiInstance cMLServiceCreateTeamWith: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.cMLServiceCreateTeam(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

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

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

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

try {
    $result = $api_instance->cMLServiceCreateTeam($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->cMLServiceCreateTeam: ', $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->cMLServiceCreateTeam(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceCreateTeam: $@\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.c_ml_service_create_team(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceCreateTeam: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - A successful response.

Status: default - An unexpected error response


cMLServiceCreateV2Key

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.cMLServiceCreateV2Key(body, username);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceCreateV2Key");
            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.cMLServiceCreateV2Key(body, username);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceCreateV2Key");
            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 cMLServiceCreateV2KeyWith: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.cMLServiceCreateV2Key(bodyusername, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class cMLServiceCreateV2KeyExample
    {
        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.cMLServiceCreateV2Key(body, username);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceCreateV2Key: " + 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->cMLServiceCreateV2Key($body, $username);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->cMLServiceCreateV2Key: ', $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->cMLServiceCreateV2Key(body => $body, username => $username);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceCreateV2Key: $@\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.c_ml_service_create_v2_key(body, username)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceCreateV2Key: %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


cMLServiceDeleteApplication

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.cMLServiceDeleteApplication(projectId, applicationId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceDeleteApplication");
            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.cMLServiceDeleteApplication(projectId, applicationId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceDeleteApplication");
            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 cMLServiceDeleteApplicationWith: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.cMLServiceDeleteApplication(projectId, applicationId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class cMLServiceDeleteApplicationExample
    {
        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.cMLServiceDeleteApplication(projectId, applicationId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceDeleteApplication: " + 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->cMLServiceDeleteApplication($projectId, $applicationId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->cMLServiceDeleteApplication: ', $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->cMLServiceDeleteApplication(projectId => $projectId, applicationId => $applicationId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceDeleteApplication: $@\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.c_ml_service_delete_application(projectId, applicationId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceDeleteApplication: %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


cMLServiceDeleteCopilotModel

Delete a Copilot model.


/api/v2/copilot/models/{copilot_model_id}

Usage and SDK Samples

curl -X DELETE\
-H "Accept: application/json"\
"//api/v2/copilot/models/{copilot_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 copilotModelId = copilotModelId_example; // String | 
        try {
            DeleteCopilotModelResponse result = apiInstance.cMLServiceDeleteCopilotModel(copilotModelId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceDeleteCopilotModel");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

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

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

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

var api = new Mlapiv2apiproto.CMLServiceApi()
var copilotModelId = copilotModelId_example; // {{String}} 

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

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

            var apiInstance = new CMLServiceApi();
            var copilotModelId = copilotModelId_example;  // String | 

            try
            {
                // Delete a Copilot model.
                DeleteCopilotModelResponse result = apiInstance.cMLServiceDeleteCopilotModel(copilotModelId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceDeleteCopilotModel: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$copilotModelId = copilotModelId_example; // String | 

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

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $copilotModelId = copilotModelId_example; # String | 

eval { 
    my $result = $api_instance->cMLServiceDeleteCopilotModel(copilotModelId => $copilotModelId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceDeleteCopilotModel: $@\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()
copilotModelId = copilotModelId_example # String | 

try: 
    # Delete a Copilot model.
    api_response = api_instance.c_ml_service_delete_copilot_model(copilotModelId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceDeleteCopilotModel: %s\n" % e)

Parameters

Path parameters
Name Description
copilot_model_id*
String
Required

Responses

Status: 200 - A successful response.

Status: default - An unexpected error response


cMLServiceDeleteExperiment

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.cMLServiceDeleteExperiment(projectId, experimentId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceDeleteExperiment");
            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.cMLServiceDeleteExperiment(projectId, experimentId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceDeleteExperiment");
            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 cMLServiceDeleteExperimentWith: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.cMLServiceDeleteExperiment(projectId, experimentId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class cMLServiceDeleteExperimentExample
    {
        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.cMLServiceDeleteExperiment(projectId, experimentId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceDeleteExperiment: " + 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->cMLServiceDeleteExperiment($projectId, $experimentId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->cMLServiceDeleteExperiment: ', $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->cMLServiceDeleteExperiment(projectId => $projectId, experimentId => $experimentId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceDeleteExperiment: $@\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.c_ml_service_delete_experiment(projectId, experimentId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceDeleteExperiment: %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


cMLServiceDeleteExperimentRun

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.cMLServiceDeleteExperimentRun(projectId, experimentId, runId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceDeleteExperimentRun");
            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.cMLServiceDeleteExperimentRun(projectId, experimentId, runId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceDeleteExperimentRun");
            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 cMLServiceDeleteExperimentRunWith: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.cMLServiceDeleteExperimentRun(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 cMLServiceDeleteExperimentRunExample
    {
        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.cMLServiceDeleteExperimentRun(projectId, experimentId, runId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceDeleteExperimentRun: " + 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->cMLServiceDeleteExperimentRun($projectId, $experimentId, $runId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->cMLServiceDeleteExperimentRun: ', $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->cMLServiceDeleteExperimentRun(projectId => $projectId, experimentId => $experimentId, runId => $runId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceDeleteExperimentRun: $@\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.c_ml_service_delete_experiment_run(projectId, experimentId, runId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceDeleteExperimentRun: %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


cMLServiceDeleteExperimentRunBatch

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.cMLServiceDeleteExperimentRunBatch(body, projectId, experimentId, runId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceDeleteExperimentRunBatch");
            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.cMLServiceDeleteExperimentRunBatch(body, projectId, experimentId, runId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceDeleteExperimentRunBatch");
            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 cMLServiceDeleteExperimentRunBatchWith: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.cMLServiceDeleteExperimentRunBatch(bodyprojectIdexperimentIdrunId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class cMLServiceDeleteExperimentRunBatchExample
    {
        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.cMLServiceDeleteExperimentRunBatch(body, projectId, experimentId, runId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceDeleteExperimentRunBatch: " + 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->cMLServiceDeleteExperimentRunBatch($body, $projectId, $experimentId, $runId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->cMLServiceDeleteExperimentRunBatch: ', $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->cMLServiceDeleteExperimentRunBatch(body => $body, projectId => $projectId, experimentId => $experimentId, runId => $runId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceDeleteExperimentRunBatch: $@\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.c_ml_service_delete_experiment_run_batch(body, projectId, experimentId, runId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceDeleteExperimentRunBatch: %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


cMLServiceDeleteJob

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.cMLServiceDeleteJob(projectId, jobId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceDeleteJob");
            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.cMLServiceDeleteJob(projectId, jobId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceDeleteJob");
            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 cMLServiceDeleteJobWith: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.cMLServiceDeleteJob(projectId, jobId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class cMLServiceDeleteJobExample
    {
        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.cMLServiceDeleteJob(projectId, jobId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceDeleteJob: " + 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->cMLServiceDeleteJob($projectId, $jobId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->cMLServiceDeleteJob: ', $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->cMLServiceDeleteJob(projectId => $projectId, jobId => $jobId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceDeleteJob: $@\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.c_ml_service_delete_job(projectId, jobId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceDeleteJob: %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


cMLServiceDeleteModel

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.cMLServiceDeleteModel(projectId, modelId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceDeleteModel");
            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.cMLServiceDeleteModel(projectId, modelId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceDeleteModel");
            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 cMLServiceDeleteModelWith: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.cMLServiceDeleteModel(projectId, modelId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class cMLServiceDeleteModelExample
    {
        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.cMLServiceDeleteModel(projectId, modelId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceDeleteModel: " + 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->cMLServiceDeleteModel($projectId, $modelId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->cMLServiceDeleteModel: ', $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->cMLServiceDeleteModel(projectId => $projectId, modelId => $modelId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceDeleteModel: $@\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.c_ml_service_delete_model(projectId, modelId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceDeleteModel: %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


cMLServiceDeleteModelBuild

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.cMLServiceDeleteModelBuild(projectId, modelId, buildId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceDeleteModelBuild");
            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.cMLServiceDeleteModelBuild(projectId, modelId, buildId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceDeleteModelBuild");
            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 cMLServiceDeleteModelBuildWith: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.cMLServiceDeleteModelBuild(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 cMLServiceDeleteModelBuildExample
    {
        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.cMLServiceDeleteModelBuild(projectId, modelId, buildId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceDeleteModelBuild: " + 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->cMLServiceDeleteModelBuild($projectId, $modelId, $buildId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->cMLServiceDeleteModelBuild: ', $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->cMLServiceDeleteModelBuild(projectId => $projectId, modelId => $modelId, buildId => $buildId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceDeleteModelBuild: $@\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.c_ml_service_delete_model_build(projectId, modelId, buildId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceDeleteModelBuild: %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


cMLServiceDeleteProject

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.cMLServiceDeleteProject(projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceDeleteProject");
            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.cMLServiceDeleteProject(projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceDeleteProject");
            e.printStackTrace();
        }
    }
}
String *projectId = projectId_example; // The project's identifier

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

// Delete a project.
[apiInstance cMLServiceDeleteProjectWith: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.cMLServiceDeleteProject(projectId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

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

            try
            {
                // Delete a project.
                DeleteProjectResponse result = apiInstance.cMLServiceDeleteProject(projectId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceDeleteProject: " + 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->cMLServiceDeleteProject($projectId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->cMLServiceDeleteProject: ', $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->cMLServiceDeleteProject(projectId => $projectId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceDeleteProject: $@\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.c_ml_service_delete_project(projectId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceDeleteProject: %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


cMLServiceDeleteProjectCollaborator

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.cMLServiceDeleteProjectCollaborator(projectId, username);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceDeleteProjectCollaborator");
            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.cMLServiceDeleteProjectCollaborator(projectId, username);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceDeleteProjectCollaborator");
            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 cMLServiceDeleteProjectCollaboratorWith: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.cMLServiceDeleteProjectCollaborator(projectId, username, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class cMLServiceDeleteProjectCollaboratorExample
    {
        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.cMLServiceDeleteProjectCollaborator(projectId, username);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceDeleteProjectCollaborator: " + 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->cMLServiceDeleteProjectCollaborator($projectId, $username);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->cMLServiceDeleteProjectCollaborator: ', $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->cMLServiceDeleteProjectCollaborator(projectId => $projectId, username => $username);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceDeleteProjectCollaborator: $@\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.c_ml_service_delete_project_collaborator(projectId, username)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceDeleteProjectCollaborator: %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


cMLServiceDeleteProjectFile

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.cMLServiceDeleteProjectFile(projectId, path);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceDeleteProjectFile");
            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.cMLServiceDeleteProjectFile(projectId, path);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceDeleteProjectFile");
            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 cMLServiceDeleteProjectFileWith: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.cMLServiceDeleteProjectFile(projectId, path, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class cMLServiceDeleteProjectFileExample
    {
        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.cMLServiceDeleteProjectFile(projectId, path);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceDeleteProjectFile: " + 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->cMLServiceDeleteProjectFile($projectId, $path);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->cMLServiceDeleteProjectFile: ', $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->cMLServiceDeleteProjectFile(projectId => $projectId, path => $path);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceDeleteProjectFile: $@\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.c_ml_service_delete_project_file(projectId, path)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceDeleteProjectFile: %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


cMLServiceDeleteRegisteredModel

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.cMLServiceDeleteRegisteredModel(modelId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceDeleteRegisteredModel");
            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.cMLServiceDeleteRegisteredModel(modelId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceDeleteRegisteredModel");
            e.printStackTrace();
        }
    }
}
String *modelId = modelId_example; // Model ID.

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

// Unregister a model deletes a model.
[apiInstance cMLServiceDeleteRegisteredModelWith: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.cMLServiceDeleteRegisteredModel(modelId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

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

            try
            {
                // Unregister a model deletes a model.
                DeleteRegisteredModelResponse result = apiInstance.cMLServiceDeleteRegisteredModel(modelId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceDeleteRegisteredModel: " + 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->cMLServiceDeleteRegisteredModel($modelId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->cMLServiceDeleteRegisteredModel: ', $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->cMLServiceDeleteRegisteredModel(modelId => $modelId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceDeleteRegisteredModel: $@\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.c_ml_service_delete_registered_model(modelId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceDeleteRegisteredModel: %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


cMLServiceDeleteRegisteredModelVersion

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.cMLServiceDeleteRegisteredModelVersion(modelId, versionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceDeleteRegisteredModelVersion");
            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.cMLServiceDeleteRegisteredModelVersion(modelId, versionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceDeleteRegisteredModelVersion");
            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 cMLServiceDeleteRegisteredModelVersionWith: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.cMLServiceDeleteRegisteredModelVersion(modelId, versionId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class cMLServiceDeleteRegisteredModelVersionExample
    {
        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.cMLServiceDeleteRegisteredModelVersion(modelId, versionId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceDeleteRegisteredModelVersion: " + 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->cMLServiceDeleteRegisteredModelVersion($modelId, $versionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->cMLServiceDeleteRegisteredModelVersion: ', $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->cMLServiceDeleteRegisteredModelVersion(modelId => $modelId, versionId => $versionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceDeleteRegisteredModelVersion: $@\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.c_ml_service_delete_registered_model_version(modelId, versionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceDeleteRegisteredModelVersion: %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


cMLServiceDeleteRuntimeRepo

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.cMLServiceDeleteRuntimeRepo(runtimeRepoId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceDeleteRuntimeRepo");
            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.cMLServiceDeleteRuntimeRepo(runtimeRepoId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceDeleteRuntimeRepo");
            e.printStackTrace();
        }
    }
}
Integer *runtimeRepoId = 56; // the id of the Runtime Repo to delete

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

// Delete a Runtime repo.
[apiInstance cMLServiceDeleteRuntimeRepoWith: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.cMLServiceDeleteRuntimeRepo(runtimeRepoId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class cMLServiceDeleteRuntimeRepoExample
    {
        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.cMLServiceDeleteRuntimeRepo(runtimeRepoId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceDeleteRuntimeRepo: " + 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->cMLServiceDeleteRuntimeRepo($runtimeRepoId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->cMLServiceDeleteRuntimeRepo: ', $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->cMLServiceDeleteRuntimeRepo(runtimeRepoId => $runtimeRepoId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceDeleteRuntimeRepo: $@\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.c_ml_service_delete_runtime_repo(runtimeRepoId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceDeleteRuntimeRepo: %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


cMLServiceDeleteTeam

Delete a team.


/api/v2/teams/{team_name}

Usage and SDK Samples

curl -X DELETE\
-H "Accept: application/json"\
"//api/v2/teams/{team_name}"
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 teamName = teamName_example; // String | name of the team you want to delete
        try {
            DeleteTeamResponse result = apiInstance.cMLServiceDeleteTeam(teamName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceDeleteTeam");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String teamName = teamName_example; // String | name of the team you want to delete
        try {
            DeleteTeamResponse result = apiInstance.cMLServiceDeleteTeam(teamName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceDeleteTeam");
            e.printStackTrace();
        }
    }
}
String *teamName = teamName_example; // name of the team you want to delete

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

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

var api = new Mlapiv2apiproto.CMLServiceApi()
var teamName = teamName_example; // {{String}} name of the team 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.cMLServiceDeleteTeam(teamName, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new CMLServiceApi();
            var teamName = teamName_example;  // String | name of the team you want to delete

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

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$teamName = teamName_example; // String | name of the team you want to delete

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

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $teamName = teamName_example; # String | name of the team you want to delete

eval { 
    my $result = $api_instance->cMLServiceDeleteTeam(teamName => $teamName);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceDeleteTeam: $@\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()
teamName = teamName_example # String | name of the team you want to delete

try: 
    # Delete a team.
    api_response = api_instance.c_ml_service_delete_team(teamName)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceDeleteTeam: %s\n" % e)

Parameters

Path parameters
Name Description
team_name*
String
name of the team you want to delete
Required

Responses

Status: 200 - A successful response.

Status: default - An unexpected error response


cMLServiceDeleteV2Key

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.cMLServiceDeleteV2Key(username, keyId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceDeleteV2Key");
            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.cMLServiceDeleteV2Key(username, keyId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceDeleteV2Key");
            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 cMLServiceDeleteV2KeyWith: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.cMLServiceDeleteV2Key(username, keyId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class cMLServiceDeleteV2KeyExample
    {
        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.cMLServiceDeleteV2Key(username, keyId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceDeleteV2Key: " + 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->cMLServiceDeleteV2Key($username, $keyId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->cMLServiceDeleteV2Key: ', $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->cMLServiceDeleteV2Key(username => $username, keyId => $keyId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceDeleteV2Key: $@\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.c_ml_service_delete_v2_key(username, keyId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceDeleteV2Key: %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


cMLServiceDeleteV2Keys

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.cMLServiceDeleteV2Keys(username);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceDeleteV2Keys");
            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.cMLServiceDeleteV2Keys(username);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceDeleteV2Keys");
            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 cMLServiceDeleteV2KeysWith: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.cMLServiceDeleteV2Keys(username, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class cMLServiceDeleteV2KeysExample
    {
        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.cMLServiceDeleteV2Keys(username);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceDeleteV2Keys: " + 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->cMLServiceDeleteV2Keys($username);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->cMLServiceDeleteV2Keys: ', $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->cMLServiceDeleteV2Keys(username => $username);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceDeleteV2Keys: $@\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.c_ml_service_delete_v2_keys(username)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceDeleteV2Keys: %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


cMLServiceDisableEngines

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.cMLServiceDisableEngines(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceDisableEngines");
            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.cMLServiceDisableEngines(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceDisableEngines");
            e.printStackTrace();
        }
    }
}
DisableEnginesRequest *body = ; // 

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

// Disable engines
[apiInstance cMLServiceDisableEnginesWith: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.cMLServiceDisableEngines(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

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

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

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

try {
    $result = $api_instance->cMLServiceDisableEngines($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->cMLServiceDisableEngines: ', $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->cMLServiceDisableEngines(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceDisableEngines: $@\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.c_ml_service_disable_engines(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceDisableEngines: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - A successful response.

Status: default - An unexpected error response


cMLServiceGetApplication

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.cMLServiceGetApplication(projectId, applicationId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceGetApplication");
            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.cMLServiceGetApplication(projectId, applicationId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceGetApplication");
            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 cMLServiceGetApplicationWith: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.cMLServiceGetApplication(projectId, applicationId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class cMLServiceGetApplicationExample
    {
        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.cMLServiceGetApplication(projectId, applicationId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceGetApplication: " + 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->cMLServiceGetApplication($projectId, $applicationId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->cMLServiceGetApplication: ', $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->cMLServiceGetApplication(projectId => $projectId, applicationId => $applicationId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceGetApplication: $@\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.c_ml_service_get_application(projectId, applicationId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceGetApplication: %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


cMLServiceGetCopilotModel

Get a Copilot model.


/api/v2/copilot/model/{copilot_model_id}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/copilot/model/{copilot_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 copilotModelId = copilotModelId_example; // String | The Copilot model's ID.
        try {
            CopilotModel result = apiInstance.cMLServiceGetCopilotModel(copilotModelId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceGetCopilotModel");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String copilotModelId = copilotModelId_example; // String | The Copilot model's ID.
        try {
            CopilotModel result = apiInstance.cMLServiceGetCopilotModel(copilotModelId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceGetCopilotModel");
            e.printStackTrace();
        }
    }
}
String *copilotModelId = copilotModelId_example; // The Copilot model's ID.

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

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

var api = new Mlapiv2apiproto.CMLServiceApi()
var copilotModelId = copilotModelId_example; // {{String}} The Copilot model's ID.

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

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

            var apiInstance = new CMLServiceApi();
            var copilotModelId = copilotModelId_example;  // String | The Copilot model's ID.

            try
            {
                // Get a Copilot model.
                CopilotModel result = apiInstance.cMLServiceGetCopilotModel(copilotModelId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceGetCopilotModel: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$copilotModelId = copilotModelId_example; // String | The Copilot model's ID.

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

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $copilotModelId = copilotModelId_example; # String | The Copilot model's ID.

eval { 
    my $result = $api_instance->cMLServiceGetCopilotModel(copilotModelId => $copilotModelId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceGetCopilotModel: $@\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()
copilotModelId = copilotModelId_example # String | The Copilot model's ID.

try: 
    # Get a Copilot model.
    api_response = api_instance.c_ml_service_get_copilot_model(copilotModelId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceGetCopilotModel: %s\n" % e)

Parameters

Path parameters
Name Description
copilot_model_id*
String
The Copilot model's ID.
Required

Responses

Status: 200 - A successful response.

Status: default - An unexpected error response


cMLServiceGetExperiment

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.cMLServiceGetExperiment(projectId, experimentId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceGetExperiment");
            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.cMLServiceGetExperiment(projectId, experimentId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceGetExperiment");
            e.printStackTrace();
        }
    }
}
String *projectId = projectId_example; // 
String *experimentId = experimentId_example; // ID of the associated experiment.

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

// Return one experiment.
[apiInstance cMLServiceGetExperimentWith: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.cMLServiceGetExperiment(projectId, experimentId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class cMLServiceGetExperimentExample
    {
        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.cMLServiceGetExperiment(projectId, experimentId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceGetExperiment: " + 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->cMLServiceGetExperiment($projectId, $experimentId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->cMLServiceGetExperiment: ', $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->cMLServiceGetExperiment(projectId => $projectId, experimentId => $experimentId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceGetExperiment: $@\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.c_ml_service_get_experiment(projectId, experimentId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceGetExperiment: %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


cMLServiceGetExperimentRun

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.cMLServiceGetExperimentRun(projectId, experimentId, runId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceGetExperimentRun");
            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.cMLServiceGetExperimentRun(projectId, experimentId, runId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceGetExperimentRun");
            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 cMLServiceGetExperimentRunWith: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.cMLServiceGetExperimentRun(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 cMLServiceGetExperimentRunExample
    {
        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.cMLServiceGetExperimentRun(projectId, experimentId, runId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceGetExperimentRun: " + 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->cMLServiceGetExperimentRun($projectId, $experimentId, $runId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->cMLServiceGetExperimentRun: ', $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->cMLServiceGetExperimentRun(projectId => $projectId, experimentId => $experimentId, runId => $runId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceGetExperimentRun: $@\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.c_ml_service_get_experiment_run(projectId, experimentId, runId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceGetExperimentRun: %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


cMLServiceGetExperimentRunMetrics

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.cMLServiceGetExperimentRunMetrics(projectId, experimentId, runId, metricKey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceGetExperimentRunMetrics");
            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.cMLServiceGetExperimentRunMetrics(projectId, experimentId, runId, metricKey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceGetExperimentRunMetrics");
            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 cMLServiceGetExperimentRunMetricsWith: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.cMLServiceGetExperimentRunMetrics(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 cMLServiceGetExperimentRunMetricsExample
    {
        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.cMLServiceGetExperimentRunMetrics(projectId, experimentId, runId, metricKey);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceGetExperimentRunMetrics: " + 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->cMLServiceGetExperimentRunMetrics($projectId, $experimentId, $runId, $metricKey);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->cMLServiceGetExperimentRunMetrics: ', $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->cMLServiceGetExperimentRunMetrics(projectId => $projectId, experimentId => $experimentId, runId => $runId, metricKey => $metricKey);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceGetExperimentRunMetrics: $@\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.c_ml_service_get_experiment_run_metrics(projectId, experimentId, runId, metricKey)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceGetExperimentRunMetrics: %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


cMLServiceGetJob

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.cMLServiceGetJob(projectId, jobId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceGetJob");
            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.cMLServiceGetJob(projectId, jobId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceGetJob");
            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 cMLServiceGetJobWith: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.cMLServiceGetJob(projectId, jobId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class cMLServiceGetJobExample
    {
        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.cMLServiceGetJob(projectId, jobId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceGetJob: " + 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->cMLServiceGetJob($projectId, $jobId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->cMLServiceGetJob: ', $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->cMLServiceGetJob(projectId => $projectId, jobId => $jobId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceGetJob: $@\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.c_ml_service_get_job(projectId, jobId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceGetJob: %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


cMLServiceGetJobRun

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.cMLServiceGetJobRun(projectId, jobId, runId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceGetJobRun");
            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.cMLServiceGetJobRun(projectId, jobId, runId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceGetJobRun");
            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 cMLServiceGetJobRunWith: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.cMLServiceGetJobRun(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 cMLServiceGetJobRunExample
    {
        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.cMLServiceGetJobRun(projectId, jobId, runId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceGetJobRun: " + 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->cMLServiceGetJobRun($projectId, $jobId, $runId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->cMLServiceGetJobRun: ', $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->cMLServiceGetJobRun(projectId => $projectId, jobId => $jobId, runId => $runId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceGetJobRun: $@\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.c_ml_service_get_job_run(projectId, jobId, runId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceGetJobRun: %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


cMLServiceGetModel

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.cMLServiceGetModel(projectId, modelId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceGetModel");
            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.cMLServiceGetModel(projectId, modelId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceGetModel");
            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 cMLServiceGetModelWith: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.cMLServiceGetModel(projectId, modelId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class cMLServiceGetModelExample
    {
        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.cMLServiceGetModel(projectId, modelId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceGetModel: " + 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->cMLServiceGetModel($projectId, $modelId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->cMLServiceGetModel: ', $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->cMLServiceGetModel(projectId => $projectId, modelId => $modelId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceGetModel: $@\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.c_ml_service_get_model(projectId, modelId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceGetModel: %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


cMLServiceGetModelBuild

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.cMLServiceGetModelBuild(projectId, modelId, buildId, registeredModelVersionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceGetModelBuild");
            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.cMLServiceGetModelBuild(projectId, modelId, buildId, registeredModelVersionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceGetModelBuild");
            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 cMLServiceGetModelBuildWith: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.cMLServiceGetModelBuild(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 cMLServiceGetModelBuildExample
    {
        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.cMLServiceGetModelBuild(projectId, modelId, buildId, registeredModelVersionId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceGetModelBuild: " + 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->cMLServiceGetModelBuild($projectId, $modelId, $buildId, $registeredModelVersionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->cMLServiceGetModelBuild: ', $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->cMLServiceGetModelBuild(projectId => $projectId, modelId => $modelId, buildId => $buildId, registeredModelVersionId => $registeredModelVersionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceGetModelBuild: $@\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.c_ml_service_get_model_build(projectId, modelId, buildId, registeredModelVersionId=registeredModelVersionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceGetModelBuild: %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


cMLServiceGetModelDeployment

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.cMLServiceGetModelDeployment(projectId, modelId, buildId, deploymentId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceGetModelDeployment");
            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.cMLServiceGetModelDeployment(projectId, modelId, buildId, deploymentId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceGetModelDeployment");
            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 cMLServiceGetModelDeploymentWith: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.cMLServiceGetModelDeployment(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 cMLServiceGetModelDeploymentExample
    {
        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.cMLServiceGetModelDeployment(projectId, modelId, buildId, deploymentId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceGetModelDeployment: " + 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->cMLServiceGetModelDeployment($projectId, $modelId, $buildId, $deploymentId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->cMLServiceGetModelDeployment: ', $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->cMLServiceGetModelDeployment(projectId => $projectId, modelId => $modelId, buildId => $buildId, deploymentId => $deploymentId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceGetModelDeployment: $@\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.c_ml_service_get_model_deployment(projectId, modelId, buildId, deploymentId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceGetModelDeployment: %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


cMLServiceGetProject

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.cMLServiceGetProject(projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceGetProject");
            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.cMLServiceGetProject(projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceGetProject");
            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 cMLServiceGetProjectWith: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.cMLServiceGetProject(projectId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class cMLServiceGetProjectExample
    {
        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.cMLServiceGetProject(projectId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceGetProject: " + 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->cMLServiceGetProject($projectId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->cMLServiceGetProject: ', $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->cMLServiceGetProject(projectId => $projectId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceGetProject: $@\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.c_ml_service_get_project(projectId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceGetProject: %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


cMLServiceGetRegisteredModel

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.cMLServiceGetRegisteredModel(modelId, searchFilter, sort, pageSize, pageToken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceGetRegisteredModel");
            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.cMLServiceGetRegisteredModel(modelId, searchFilter, sort, pageSize, pageToken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceGetRegisteredModel");
            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 cMLServiceGetRegisteredModelWith: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.cMLServiceGetRegisteredModel(modelId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class cMLServiceGetRegisteredModelExample
    {
        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.cMLServiceGetRegisteredModel(modelId, searchFilter, sort, pageSize, pageToken);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceGetRegisteredModel: " + 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->cMLServiceGetRegisteredModel($modelId, $searchFilter, $sort, $pageSize, $pageToken);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->cMLServiceGetRegisteredModel: ', $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->cMLServiceGetRegisteredModel(modelId => $modelId, searchFilter => $searchFilter, sort => $sort, pageSize => $pageSize, pageToken => $pageToken);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceGetRegisteredModel: $@\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.c_ml_service_get_registered_model(modelId, searchFilter=searchFilter, sort=sort, pageSize=pageSize, pageToken=pageToken)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceGetRegisteredModel: %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


cMLServiceGetRegisteredModelVersion

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.cMLServiceGetRegisteredModelVersion(modelId, versionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceGetRegisteredModelVersion");
            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.cMLServiceGetRegisteredModelVersion(modelId, versionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceGetRegisteredModelVersion");
            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 cMLServiceGetRegisteredModelVersionWith: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.cMLServiceGetRegisteredModelVersion(modelId, versionId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class cMLServiceGetRegisteredModelVersionExample
    {
        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.cMLServiceGetRegisteredModelVersion(modelId, versionId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceGetRegisteredModelVersion: " + 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->cMLServiceGetRegisteredModelVersion($modelId, $versionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->cMLServiceGetRegisteredModelVersion: ', $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->cMLServiceGetRegisteredModelVersion(modelId => $modelId, versionId => $versionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceGetRegisteredModelVersion: $@\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.c_ml_service_get_registered_model_version(modelId, versionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceGetRegisteredModelVersion: %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


cMLServiceGetShortUserByID


/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.cMLServiceGetShortUserByID(userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceGetShortUserByID");
            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.cMLServiceGetShortUserByID(userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceGetShortUserByID");
            e.printStackTrace();
        }
    }
}
Integer *userId = 56; // 

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

[apiInstance cMLServiceGetShortUserByIDWith: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.cMLServiceGetShortUserByID(userId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new CMLServiceApi();
            var userId = 56;  // Integer | 

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

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$userId = 56; // Integer | 

try {
    $result = $api_instance->cMLServiceGetShortUserByID($userId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->cMLServiceGetShortUserByID: ', $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->cMLServiceGetShortUserByID(userId => $userId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceGetShortUserByID: $@\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.c_ml_service_get_short_user_by_id(userId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceGetShortUserByID: %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


cMLServiceGetTimeSeries

Return the time series data for the requested resource or property.


/api/v2/ts_data

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/ts_data?search_filter=&page_token=&multi_column_search_filter=&time_range_search_filter=&series_type="
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: [name creator group project_name workload_type status].
For example:
  search_filter={"name":"My Session","workload_type":"session"}.
        String pageToken = pageToken_example; // String | page token for specifying which page to return.
        String multiColumnSearchFilter = multiColumnSearchFilter_example; // String | Multi column search filter is an optional HTTP parameter to filter multiple columns.
Supported Multi column search filter keys are: [project_or_workload_name].
For example:
  multi_column_search_filter={"project_or_workload_name":"name"}.
        String timeRangeSearchFilter = timeRangeSearchFilter_example; // String | Time range search filter is an optional HTTP parameter to filter based on the time.
Supported Time range search filters are: [created_time].
For example:
  time_range_search_filter={"created_time":{"min":"2023-12-11 21:06:51","max":"2023-12-11 21:08:51"}}.
        String seriesType = seriesType_example; // String | Type of the time series.
Supported values are [cpu, memory, gpu].
        try {
            TimeSeriesResponse result = apiInstance.cMLServiceGetTimeSeries(searchFilter, pageToken, multiColumnSearchFilter, timeRangeSearchFilter, seriesType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceGetTimeSeries");
            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: [name creator group project_name workload_type status].
For example:
  search_filter={"name":"My Session","workload_type":"session"}.
        String pageToken = pageToken_example; // String | page token for specifying which page to return.
        String multiColumnSearchFilter = multiColumnSearchFilter_example; // String | Multi column search filter is an optional HTTP parameter to filter multiple columns.
Supported Multi column search filter keys are: [project_or_workload_name].
For example:
  multi_column_search_filter={"project_or_workload_name":"name"}.
        String timeRangeSearchFilter = timeRangeSearchFilter_example; // String | Time range search filter is an optional HTTP parameter to filter based on the time.
Supported Time range search filters are: [created_time].
For example:
  time_range_search_filter={"created_time":{"min":"2023-12-11 21:06:51","max":"2023-12-11 21:08:51"}}.
        String seriesType = seriesType_example; // String | Type of the time series.
Supported values are [cpu, memory, gpu].
        try {
            TimeSeriesResponse result = apiInstance.cMLServiceGetTimeSeries(searchFilter, pageToken, multiColumnSearchFilter, timeRangeSearchFilter, seriesType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceGetTimeSeries");
            e.printStackTrace();
        }
    }
}
String *searchFilter = searchFilter_example; // Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [name creator group project_name workload_type status].
For example:
  search_filter={"name":"My Session","workload_type":"session"}. (optional)
String *pageToken = pageToken_example; // page token for specifying which page to return. (optional)
String *multiColumnSearchFilter = multiColumnSearchFilter_example; // Multi column search filter is an optional HTTP parameter to filter multiple columns.
Supported Multi column search filter keys are: [project_or_workload_name].
For example:
  multi_column_search_filter={"project_or_workload_name":"name"}. (optional)
String *timeRangeSearchFilter = timeRangeSearchFilter_example; // Time range search filter is an optional HTTP parameter to filter based on the time.
Supported Time range search filters are: [created_time].
For example:
  time_range_search_filter={"created_time":{"min":"2023-12-11 21:06:51","max":"2023-12-11 21:08:51"}}. (optional)
String *seriesType = seriesType_example; // Type of the time series.
Supported values are [cpu, memory, gpu]. (optional)

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

// Return the time series data for the requested resource or property.
[apiInstance cMLServiceGetTimeSeriesWith:searchFilter
    pageToken:pageToken
    multiColumnSearchFilter:multiColumnSearchFilter
    timeRangeSearchFilter:timeRangeSearchFilter
    seriesType:seriesType
              completionHandler: ^(TimeSeriesResponse 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: [name creator group project_name workload_type status].
For example:
  search_filter={"name":"My Session","workload_type":"session"}.
  'pageToken': pageToken_example, // {{String}} page token for specifying which page to return.
  'multiColumnSearchFilter': multiColumnSearchFilter_example, // {{String}} Multi column search filter is an optional HTTP parameter to filter multiple columns.
Supported Multi column search filter keys are: [project_or_workload_name].
For example:
  multi_column_search_filter={"project_or_workload_name":"name"}.
  'timeRangeSearchFilter': timeRangeSearchFilter_example, // {{String}} Time range search filter is an optional HTTP parameter to filter based on the time.
Supported Time range search filters are: [created_time].
For example:
  time_range_search_filter={"created_time":{"min":"2023-12-11 21:06:51","max":"2023-12-11 21:08:51"}}.
  'seriesType': seriesType_example // {{String}} Type of the time series.
Supported values are [cpu, memory, gpu].
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.cMLServiceGetTimeSeries(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class cMLServiceGetTimeSeriesExample
    {
        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: [name creator group project_name workload_type status].
For example:
  search_filter={"name":"My Session","workload_type":"session"}. (optional) 
            var pageToken = pageToken_example;  // String | page token for specifying which page to return. (optional) 
            var multiColumnSearchFilter = multiColumnSearchFilter_example;  // String | Multi column search filter is an optional HTTP parameter to filter multiple columns.
Supported Multi column search filter keys are: [project_or_workload_name].
For example:
  multi_column_search_filter={"project_or_workload_name":"name"}. (optional) 
            var timeRangeSearchFilter = timeRangeSearchFilter_example;  // String | Time range search filter is an optional HTTP parameter to filter based on the time.
Supported Time range search filters are: [created_time].
For example:
  time_range_search_filter={"created_time":{"min":"2023-12-11 21:06:51","max":"2023-12-11 21:08:51"}}. (optional) 
            var seriesType = seriesType_example;  // String | Type of the time series.
Supported values are [cpu, memory, gpu]. (optional) 

            try
            {
                // Return the time series data for the requested resource or property.
                TimeSeriesResponse result = apiInstance.cMLServiceGetTimeSeries(searchFilter, pageToken, multiColumnSearchFilter, timeRangeSearchFilter, seriesType);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceGetTimeSeries: " + 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: [name creator group project_name workload_type status].
For example:
  search_filter={"name":"My Session","workload_type":"session"}.
$pageToken = pageToken_example; // String | page token for specifying which page to return.
$multiColumnSearchFilter = multiColumnSearchFilter_example; // String | Multi column search filter is an optional HTTP parameter to filter multiple columns.
Supported Multi column search filter keys are: [project_or_workload_name].
For example:
  multi_column_search_filter={"project_or_workload_name":"name"}.
$timeRangeSearchFilter = timeRangeSearchFilter_example; // String | Time range search filter is an optional HTTP parameter to filter based on the time.
Supported Time range search filters are: [created_time].
For example:
  time_range_search_filter={"created_time":{"min":"2023-12-11 21:06:51","max":"2023-12-11 21:08:51"}}.
$seriesType = seriesType_example; // String | Type of the time series.
Supported values are [cpu, memory, gpu].

try {
    $result = $api_instance->cMLServiceGetTimeSeries($searchFilter, $pageToken, $multiColumnSearchFilter, $timeRangeSearchFilter, $seriesType);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->cMLServiceGetTimeSeries: ', $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: [name creator group project_name workload_type status].
For example:
  search_filter={"name":"My Session","workload_type":"session"}.
my $pageToken = pageToken_example; # String | page token for specifying which page to return.
my $multiColumnSearchFilter = multiColumnSearchFilter_example; # String | Multi column search filter is an optional HTTP parameter to filter multiple columns.
Supported Multi column search filter keys are: [project_or_workload_name].
For example:
  multi_column_search_filter={"project_or_workload_name":"name"}.
my $timeRangeSearchFilter = timeRangeSearchFilter_example; # String | Time range search filter is an optional HTTP parameter to filter based on the time.
Supported Time range search filters are: [created_time].
For example:
  time_range_search_filter={"created_time":{"min":"2023-12-11 21:06:51","max":"2023-12-11 21:08:51"}}.
my $seriesType = seriesType_example; # String | Type of the time series.
Supported values are [cpu, memory, gpu].

eval { 
    my $result = $api_instance->cMLServiceGetTimeSeries(searchFilter => $searchFilter, pageToken => $pageToken, multiColumnSearchFilter => $multiColumnSearchFilter, timeRangeSearchFilter => $timeRangeSearchFilter, seriesType => $seriesType);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceGetTimeSeries: $@\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: [name creator group project_name workload_type status].
For example:
  search_filter={"name":"My Session","workload_type":"session"}. (optional)
pageToken = pageToken_example # String | page token for specifying which page to return. (optional)
multiColumnSearchFilter = multiColumnSearchFilter_example # String | Multi column search filter is an optional HTTP parameter to filter multiple columns.
Supported Multi column search filter keys are: [project_or_workload_name].
For example:
  multi_column_search_filter={"project_or_workload_name":"name"}. (optional)
timeRangeSearchFilter = timeRangeSearchFilter_example # String | Time range search filter is an optional HTTP parameter to filter based on the time.
Supported Time range search filters are: [created_time].
For example:
  time_range_search_filter={"created_time":{"min":"2023-12-11 21:06:51","max":"2023-12-11 21:08:51"}}. (optional)
seriesType = seriesType_example # String | Type of the time series.
Supported values are [cpu, memory, gpu]. (optional)

try: 
    # Return the time series data for the requested resource or property.
    api_response = api_instance.c_ml_service_get_time_series(searchFilter=searchFilter, pageToken=pageToken, multiColumnSearchFilter=multiColumnSearchFilter, timeRangeSearchFilter=timeRangeSearchFilter, seriesType=seriesType)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceGetTimeSeries: %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: [name creator group project_name workload_type status]. For example: search_filter={"name":"My Session","workload_type":"session"}.
page_token
String
page token for specifying which page to return.
multi_column_search_filter
String
Multi column search filter is an optional HTTP parameter to filter multiple columns. Supported Multi column search filter keys are: [project_or_workload_name]. For example: multi_column_search_filter={"project_or_workload_name":"name"}.
time_range_search_filter
String
Time range search filter is an optional HTTP parameter to filter based on the time. Supported Time range search filters are: [created_time]. For example: time_range_search_filter={"created_time":{"min":"2023-12-11 21:06:51","max":"2023-12-11 21:08:51"}}.
series_type
String
Type of the time series. Supported values are [cpu, memory, gpu].

Responses

Status: 200 - A successful response.

Status: default - An unexpected error response


cMLServiceListAllAcceleratorNodeLabels

List all Accelerator Node Label


/api/v2/nodelabels

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/nodelabels?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 label_key].
        String sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [id label_key].
  sort=id.
        Integer pageSize = 56; // Integer | page size of the response accelerator node labels list.
        String pageToken = pageToken_example; // String | page token for specifying which page to return.
        try {
            ListAllAcceleratorsNodeLabelsResponse result = apiInstance.cMLServiceListAllAcceleratorNodeLabels(searchFilter, sort, pageSize, pageToken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceListAllAcceleratorNodeLabels");
            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 label_key].
        String sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [id label_key].
  sort=id.
        Integer pageSize = 56; // Integer | page size of the response accelerator node labels list.
        String pageToken = pageToken_example; // String | page token for specifying which page to return.
        try {
            ListAllAcceleratorsNodeLabelsResponse result = apiInstance.cMLServiceListAllAcceleratorNodeLabels(searchFilter, sort, pageSize, pageToken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceListAllAcceleratorNodeLabels");
            e.printStackTrace();
        }
    }
}
String *searchFilter = searchFilter_example; // Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [id label_key]. (optional)
String *sort = sort_example; // Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [id label_key].
  sort=id. (optional)
Integer *pageSize = 56; // page size of the response accelerator node labels list. (optional)
String *pageToken = pageToken_example; // page token for specifying which page to return. (optional)

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

// List all Accelerator Node Label
[apiInstance cMLServiceListAllAcceleratorNodeLabelsWith:searchFilter
    sort:sort
    pageSize:pageSize
    pageToken:pageToken
              completionHandler: ^(ListAllAcceleratorsNodeLabelsResponse 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 label_key].
  'sort': sort_example, // {{String}} Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [id label_key].
  sort=id.
  'pageSize': 56, // {{Integer}} page size of the response accelerator node labels 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.cMLServiceListAllAcceleratorNodeLabels(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class cMLServiceListAllAcceleratorNodeLabelsExample
    {
        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 label_key]. (optional) 
            var sort = sort_example;  // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [id label_key].
  sort=id. (optional) 
            var pageSize = 56;  // Integer | page size of the response accelerator node labels list. (optional) 
            var pageToken = pageToken_example;  // String | page token for specifying which page to return. (optional) 

            try
            {
                // List all Accelerator Node Label
                ListAllAcceleratorsNodeLabelsResponse result = apiInstance.cMLServiceListAllAcceleratorNodeLabels(searchFilter, sort, pageSize, pageToken);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceListAllAcceleratorNodeLabels: " + 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 label_key].
$sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [id label_key].
  sort=id.
$pageSize = 56; // Integer | page size of the response accelerator node labels list.
$pageToken = pageToken_example; // String | page token for specifying which page to return.

try {
    $result = $api_instance->cMLServiceListAllAcceleratorNodeLabels($searchFilter, $sort, $pageSize, $pageToken);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->cMLServiceListAllAcceleratorNodeLabels: ', $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 label_key].
my $sort = sort_example; # String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [id label_key].
  sort=id.
my $pageSize = 56; # Integer | page size of the response accelerator node labels list.
my $pageToken = pageToken_example; # String | page token for specifying which page to return.

eval { 
    my $result = $api_instance->cMLServiceListAllAcceleratorNodeLabels(searchFilter => $searchFilter, sort => $sort, pageSize => $pageSize, pageToken => $pageToken);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceListAllAcceleratorNodeLabels: $@\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 label_key]. (optional)
sort = sort_example # String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [id label_key].
  sort=id. (optional)
pageSize = 56 # Integer | page size of the response accelerator node labels list. (optional)
pageToken = pageToken_example # String | page token for specifying which page to return. (optional)

try: 
    # List all Accelerator Node Label
    api_response = api_instance.c_ml_service_list_all_accelerator_node_labels(searchFilter=searchFilter, sort=sort, pageSize=pageSize, pageToken=pageToken)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceListAllAcceleratorNodeLabels: %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 label_key].
sort
String
Sort is an optional HTTP parameter to sort results by. Supported sort keys are: [id label_key]. sort=id.
page_size
Integer (int32)
page size of the response accelerator node labels list.
page_token
String
page token for specifying which page to return.

Responses

Status: 200 - A successful response.

Status: default - An unexpected error response


cMLServiceListAllExperiments

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.cMLServiceListAllExperiments(searchFilter, pageSize, pageToken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceListAllExperiments");
            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.cMLServiceListAllExperiments(searchFilter, pageSize, pageToken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceListAllExperiments");
            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 cMLServiceListAllExperimentsWith: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.cMLServiceListAllExperiments(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class cMLServiceListAllExperimentsExample
    {
        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.cMLServiceListAllExperiments(searchFilter, pageSize, pageToken);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceListAllExperiments: " + 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->cMLServiceListAllExperiments($searchFilter, $pageSize, $pageToken);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->cMLServiceListAllExperiments: ', $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->cMLServiceListAllExperiments(searchFilter => $searchFilter, pageSize => $pageSize, pageToken => $pageToken);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceListAllExperiments: $@\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.c_ml_service_list_all_experiments(searchFilter=searchFilter, pageSize=pageSize, pageToken=pageToken)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceListAllExperiments: %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


cMLServiceListAllJobs

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.cMLServiceListAllJobs(searchFilter, pageSize, pageToken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceListAllJobs");
            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.cMLServiceListAllJobs(searchFilter, pageSize, pageToken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceListAllJobs");
            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 cMLServiceListAllJobsWith: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.cMLServiceListAllJobs(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class cMLServiceListAllJobsExample
    {
        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.cMLServiceListAllJobs(searchFilter, pageSize, pageToken);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceListAllJobs: " + 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->cMLServiceListAllJobs($searchFilter, $pageSize, $pageToken);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->cMLServiceListAllJobs: ', $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->cMLServiceListAllJobs(searchFilter => $searchFilter, pageSize => $pageSize, pageToken => $pageToken);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceListAllJobs: $@\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.c_ml_service_list_all_jobs(searchFilter=searchFilter, pageSize=pageSize, pageToken=pageToken)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceListAllJobs: %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


cMLServiceListAllModels

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.cMLServiceListAllModels(searchFilter, pageSize, pageToken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceListAllModels");
            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.cMLServiceListAllModels(searchFilter, pageSize, pageToken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceListAllModels");
            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 cMLServiceListAllModelsWith: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.cMLServiceListAllModels(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class cMLServiceListAllModelsExample
    {
        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.cMLServiceListAllModels(searchFilter, pageSize, pageToken);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceListAllModels: " + 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->cMLServiceListAllModels($searchFilter, $pageSize, $pageToken);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->cMLServiceListAllModels: ', $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->cMLServiceListAllModels(searchFilter => $searchFilter, pageSize => $pageSize, pageToken => $pageToken);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceListAllModels: $@\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.c_ml_service_list_all_models(searchFilter=searchFilter, pageSize=pageSize, pageToken=pageToken)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceListAllModels: %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


cMLServiceListAllRunAsMachineUserCollaborators


/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.cMLServiceListAllRunAsMachineUserCollaborators(projectId, searchFilter, pageSize, pageToken, sort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceListAllRunAsMachineUserCollaborators");
            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.cMLServiceListAllRunAsMachineUserCollaborators(projectId, searchFilter, pageSize, pageToken, sort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceListAllRunAsMachineUserCollaborators");
            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 cMLServiceListAllRunAsMachineUserCollaboratorsWith: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.cMLServiceListAllRunAsMachineUserCollaborators(projectId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class cMLServiceListAllRunAsMachineUserCollaboratorsExample
    {
        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.cMLServiceListAllRunAsMachineUserCollaborators(projectId, searchFilter, pageSize, pageToken, sort);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceListAllRunAsMachineUserCollaborators: " + 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->cMLServiceListAllRunAsMachineUserCollaborators($projectId, $searchFilter, $pageSize, $pageToken, $sort);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->cMLServiceListAllRunAsMachineUserCollaborators: ', $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->cMLServiceListAllRunAsMachineUserCollaborators(projectId => $projectId, searchFilter => $searchFilter, pageSize => $pageSize, pageToken => $pageToken, sort => $sort);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceListAllRunAsMachineUserCollaborators: $@\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.c_ml_service_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->cMLServiceListAllRunAsMachineUserCollaborators: %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


cMLServiceListApplications

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.cMLServiceListApplications(projectId, searchFilter, sort, pageSize, pageToken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceListApplications");
            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.cMLServiceListApplications(projectId, searchFilter, sort, pageSize, pageToken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceListApplications");
            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 cMLServiceListApplicationsWith: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.cMLServiceListApplications(projectId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class cMLServiceListApplicationsExample
    {
        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.cMLServiceListApplications(projectId, searchFilter, sort, pageSize, pageToken);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceListApplications: " + 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->cMLServiceListApplications($projectId, $searchFilter, $sort, $pageSize, $pageToken);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->cMLServiceListApplications: ', $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->cMLServiceListApplications(projectId => $projectId, searchFilter => $searchFilter, sort => $sort, pageSize => $pageSize, pageToken => $pageToken);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceListApplications: $@\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.c_ml_service_list_applications(projectId, searchFilter=searchFilter, sort=sort, pageSize=pageSize, pageToken=pageToken)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceListApplications: %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


cMLServiceListCopilotModels

List Copilot models, optionally filtered, sorted, and paginated.


/api/v2/copilot/models

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/copilot/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 keys are:
    [provider name endpoint enabled default].
For example:
  search_filter={"provider":"Amazon Bedrock","enabled":"t"}.
        String sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [provider name endpoint enabled default].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=provider.
        Integer pageSize = 56; // Integer | Page size of the response Copilot model list.
        String pageToken = pageToken_example; // String | Page token for specifying which page to return.
        try {
            ListCopilotModelsResponse result = apiInstance.cMLServiceListCopilotModels(searchFilter, sort, pageSize, pageToken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceListCopilotModels");
            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:
    [provider name endpoint enabled default].
For example:
  search_filter={"provider":"Amazon Bedrock","enabled":"t"}.
        String sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [provider name endpoint enabled default].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=provider.
        Integer pageSize = 56; // Integer | Page size of the response Copilot model list.
        String pageToken = pageToken_example; // String | Page token for specifying which page to return.
        try {
            ListCopilotModelsResponse result = apiInstance.cMLServiceListCopilotModels(searchFilter, sort, pageSize, pageToken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceListCopilotModels");
            e.printStackTrace();
        }
    }
}
String *searchFilter = searchFilter_example; // Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are:
    [provider name endpoint enabled default].
For example:
  search_filter={"provider":"Amazon Bedrock","enabled":"t"}. (optional)
String *sort = sort_example; // Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [provider name endpoint enabled default].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=provider. (optional)
Integer *pageSize = 56; // Page size of the response Copilot model list. (optional)
String *pageToken = pageToken_example; // Page token for specifying which page to return. (optional)

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

// List Copilot models, optionally filtered, sorted, and paginated.
[apiInstance cMLServiceListCopilotModelsWith:searchFilter
    sort:sort
    pageSize:pageSize
    pageToken:pageToken
              completionHandler: ^(ListCopilotModelsResponse 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:
    [provider name endpoint enabled default].
For example:
  search_filter={"provider":"Amazon Bedrock","enabled":"t"}.
  'sort': sort_example, // {{String}} Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [provider name endpoint enabled default].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=provider.
  'pageSize': 56, // {{Integer}} Page size of the response Copilot model 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.cMLServiceListCopilotModels(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class cMLServiceListCopilotModelsExample
    {
        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:
    [provider name endpoint enabled default].
For example:
  search_filter={"provider":"Amazon Bedrock","enabled":"t"}. (optional) 
            var sort = sort_example;  // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [provider name endpoint enabled default].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=provider. (optional) 
            var pageSize = 56;  // Integer | Page size of the response Copilot model list. (optional) 
            var pageToken = pageToken_example;  // String | Page token for specifying which page to return. (optional) 

            try
            {
                // List Copilot models, optionally filtered, sorted, and paginated.
                ListCopilotModelsResponse result = apiInstance.cMLServiceListCopilotModels(searchFilter, sort, pageSize, pageToken);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceListCopilotModels: " + 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:
    [provider name endpoint enabled default].
For example:
  search_filter={"provider":"Amazon Bedrock","enabled":"t"}.
$sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [provider name endpoint enabled default].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=provider.
$pageSize = 56; // Integer | Page size of the response Copilot model list.
$pageToken = pageToken_example; // String | Page token for specifying which page to return.

try {
    $result = $api_instance->cMLServiceListCopilotModels($searchFilter, $sort, $pageSize, $pageToken);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->cMLServiceListCopilotModels: ', $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:
    [provider name endpoint enabled default].
For example:
  search_filter={"provider":"Amazon Bedrock","enabled":"t"}.
my $sort = sort_example; # String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [provider name endpoint enabled default].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=provider.
my $pageSize = 56; # Integer | Page size of the response Copilot model list.
my $pageToken = pageToken_example; # String | Page token for specifying which page to return.

eval { 
    my $result = $api_instance->cMLServiceListCopilotModels(searchFilter => $searchFilter, sort => $sort, pageSize => $pageSize, pageToken => $pageToken);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceListCopilotModels: $@\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:
    [provider name endpoint enabled default].
For example:
  search_filter={"provider":"Amazon Bedrock","enabled":"t"}. (optional)
sort = sort_example # String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [provider name endpoint enabled default].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=provider. (optional)
pageSize = 56 # Integer | Page size of the response Copilot model list. (optional)
pageToken = pageToken_example # String | Page token for specifying which page to return. (optional)

try: 
    # List Copilot models, optionally filtered, sorted, and paginated.
    api_response = api_instance.c_ml_service_list_copilot_models(searchFilter=searchFilter, sort=sort, pageSize=pageSize, pageToken=pageToken)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceListCopilotModels: %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: [provider name endpoint enabled default]. For example: search_filter={"provider":"Amazon Bedrock","enabled":"t"}.
sort
String
Sort is an optional HTTP parameter to sort results by. Supported sort keys are: [provider name endpoint enabled default]. where "+" means sort by ascending order, and "-" means sort by descending order. For example: sort=provider.
page_size
Integer (int32)
Page size of the response Copilot model list.
page_token
String
Page token for specifying which page to return.

Responses

Status: 200 - A successful response.

Status: default - An unexpected error response


cMLServiceListExperimentRuns

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.cMLServiceListExperimentRuns(projectId, experimentId, searchFilter, pageSize, pageToken, sort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceListExperimentRuns");
            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.cMLServiceListExperimentRuns(projectId, experimentId, searchFilter, pageSize, pageToken, sort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceListExperimentRuns");
            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 cMLServiceListExperimentRunsWith: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.cMLServiceListExperimentRuns(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 cMLServiceListExperimentRunsExample
    {
        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.cMLServiceListExperimentRuns(projectId, experimentId, searchFilter, pageSize, pageToken, sort);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceListExperimentRuns: " + 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->cMLServiceListExperimentRuns($projectId, $experimentId, $searchFilter, $pageSize, $pageToken, $sort);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->cMLServiceListExperimentRuns: ', $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->cMLServiceListExperimentRuns(projectId => $projectId, experimentId => $experimentId, searchFilter => $searchFilter, pageSize => $pageSize, pageToken => $pageToken, sort => $sort);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceListExperimentRuns: $@\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.c_ml_service_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->cMLServiceListExperimentRuns: %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


cMLServiceListExperiments

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.cMLServiceListExperiments(projectId, searchFilter, pageSize, pageToken, sort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceListExperiments");
            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.cMLServiceListExperiments(projectId, searchFilter, pageSize, pageToken, sort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceListExperiments");
            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 cMLServiceListExperimentsWith: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.cMLServiceListExperiments(projectId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class cMLServiceListExperimentsExample
    {
        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.cMLServiceListExperiments(projectId, searchFilter, pageSize, pageToken, sort);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceListExperiments: " + 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->cMLServiceListExperiments($projectId, $searchFilter, $pageSize, $pageToken, $sort);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->cMLServiceListExperiments: ', $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->cMLServiceListExperiments(projectId => $projectId, searchFilter => $searchFilter, pageSize => $pageSize, pageToken => $pageToken, sort => $sort);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceListExperiments: $@\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.c_ml_service_list_experiments(projectId, searchFilter=searchFilter, pageSize=pageSize, pageToken=pageToken, sort=sort)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceListExperiments: %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


cMLServiceListGroupsQuota

Return all the groups and its quotas based on the context. Admin gets all the groups details.


/api/v2/groupsquota

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/groupsquota?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: [banned deactivated].
For example:
  search_filter={"deactivated":"false","banned":"false"}.
        String sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [username].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=username.
        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 {
            ListGroupsQuotaResponse result = apiInstance.cMLServiceListGroupsQuota(searchFilter, sort, pageSize, pageToken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceListGroupsQuota");
            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: [banned deactivated].
For example:
  search_filter={"deactivated":"false","banned":"false"}.
        String sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [username].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=username.
        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 {
            ListGroupsQuotaResponse result = apiInstance.cMLServiceListGroupsQuota(searchFilter, sort, pageSize, pageToken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceListGroupsQuota");
            e.printStackTrace();
        }
    }
}
String *searchFilter = searchFilter_example; // Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [banned deactivated].
For example:
  search_filter={"deactivated":"false","banned":"false"}. (optional)
String *sort = sort_example; // Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [username].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=username. (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];

// Return all the groups and its quotas based on the context. Admin gets all the groups details.
[apiInstance cMLServiceListGroupsQuotaWith:searchFilter
    sort:sort
    pageSize:pageSize
    pageToken:pageToken
              completionHandler: ^(ListGroupsQuotaResponse 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: [banned deactivated].
For example:
  search_filter={"deactivated":"false","banned":"false"}.
  'sort': sort_example, // {{String}} Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [username].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=username.
  '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.cMLServiceListGroupsQuota(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class cMLServiceListGroupsQuotaExample
    {
        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: [banned deactivated].
For example:
  search_filter={"deactivated":"false","banned":"false"}. (optional) 
            var sort = sort_example;  // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [username].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=username. (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
            {
                // Return all the groups and its quotas based on the context. Admin gets all the groups details.
                ListGroupsQuotaResponse result = apiInstance.cMLServiceListGroupsQuota(searchFilter, sort, pageSize, pageToken);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceListGroupsQuota: " + 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: [banned deactivated].
For example:
  search_filter={"deactivated":"false","banned":"false"}.
$sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [username].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=username.
$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->cMLServiceListGroupsQuota($searchFilter, $sort, $pageSize, $pageToken);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->cMLServiceListGroupsQuota: ', $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: [banned deactivated].
For example:
  search_filter={"deactivated":"false","banned":"false"}.
my $sort = sort_example; # String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [username].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=username.
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->cMLServiceListGroupsQuota(searchFilter => $searchFilter, sort => $sort, pageSize => $pageSize, pageToken => $pageToken);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceListGroupsQuota: $@\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: [banned deactivated].
For example:
  search_filter={"deactivated":"false","banned":"false"}. (optional)
sort = sort_example # String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [username].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=username. (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: 
    # Return all the groups and its quotas based on the context. Admin gets all the groups details.
    api_response = api_instance.c_ml_service_list_groups_quota(searchFilter=searchFilter, sort=sort, pageSize=pageSize, pageToken=pageToken)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceListGroupsQuota: %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: [banned deactivated]. For example: search_filter={"deactivated":"false","banned":"false"}.
sort
String
Sort is an optional HTTP parameter to sort results by. Supported sort keys are: [username]. where "+" means sort by ascending order, and "-" means sort by descending order. For example: sort=username.
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


cMLServiceListJobRuns

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.cMLServiceListJobRuns(projectId, jobId, searchFilter, sort, pageSize, pageToken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceListJobRuns");
            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.cMLServiceListJobRuns(projectId, jobId, searchFilter, sort, pageSize, pageToken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceListJobRuns");
            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 cMLServiceListJobRunsWith: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.cMLServiceListJobRuns(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 cMLServiceListJobRunsExample
    {
        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.cMLServiceListJobRuns(projectId, jobId, searchFilter, sort, pageSize, pageToken);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceListJobRuns: " + 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->cMLServiceListJobRuns($projectId, $jobId, $searchFilter, $sort, $pageSize, $pageToken);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->cMLServiceListJobRuns: ', $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->cMLServiceListJobRuns(projectId => $projectId, jobId => $jobId, searchFilter => $searchFilter, sort => $sort, pageSize => $pageSize, pageToken => $pageToken);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceListJobRuns: $@\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.c_ml_service_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->cMLServiceListJobRuns: %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


cMLServiceListJobs

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.cMLServiceListJobs(projectId, searchFilter, sort, pageSize, pageToken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceListJobs");
            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.cMLServiceListJobs(projectId, searchFilter, sort, pageSize, pageToken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceListJobs");
            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 cMLServiceListJobsWith: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.cMLServiceListJobs(projectId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class cMLServiceListJobsExample
    {
        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.cMLServiceListJobs(projectId, searchFilter, sort, pageSize, pageToken);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceListJobs: " + 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->cMLServiceListJobs($projectId, $searchFilter, $sort, $pageSize, $pageToken);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->cMLServiceListJobs: ', $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->cMLServiceListJobs(projectId => $projectId, searchFilter => $searchFilter, sort => $sort, pageSize => $pageSize, pageToken => $pageToken);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceListJobs: $@\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.c_ml_service_list_jobs(projectId, searchFilter=searchFilter, sort=sort, pageSize=pageSize, pageToken=pageToken)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceListJobs: %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


cMLServiceListModelBuilds

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.cMLServiceListModelBuilds(projectId, modelId, searchFilter, sort, pageSize, pageToken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceListModelBuilds");
            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.cMLServiceListModelBuilds(projectId, modelId, searchFilter, sort, pageSize, pageToken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceListModelBuilds");
            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 cMLServiceListModelBuildsWith: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.cMLServiceListModelBuilds(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 cMLServiceListModelBuildsExample
    {
        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.cMLServiceListModelBuilds(projectId, modelId, searchFilter, sort, pageSize, pageToken);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceListModelBuilds: " + 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->cMLServiceListModelBuilds($projectId, $modelId, $searchFilter, $sort, $pageSize, $pageToken);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->cMLServiceListModelBuilds: ', $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->cMLServiceListModelBuilds(projectId => $projectId, modelId => $modelId, searchFilter => $searchFilter, sort => $sort, pageSize => $pageSize, pageToken => $pageToken);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceListModelBuilds: $@\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.c_ml_service_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->cMLServiceListModelBuilds: %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


cMLServiceListModelDeployments

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.cMLServiceListModelDeployments(projectId, modelId, buildId, searchFilter, pageSize, pageToken, sort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceListModelDeployments");
            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.cMLServiceListModelDeployments(projectId, modelId, buildId, searchFilter, pageSize, pageToken, sort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceListModelDeployments");
            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 cMLServiceListModelDeploymentsWith: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.cMLServiceListModelDeployments(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 cMLServiceListModelDeploymentsExample
    {
        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.cMLServiceListModelDeployments(projectId, modelId, buildId, searchFilter, pageSize, pageToken, sort);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceListModelDeployments: " + 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->cMLServiceListModelDeployments($projectId, $modelId, $buildId, $searchFilter, $pageSize, $pageToken, $sort);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->cMLServiceListModelDeployments: ', $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->cMLServiceListModelDeployments(projectId => $projectId, modelId => $modelId, buildId => $buildId, searchFilter => $searchFilter, pageSize => $pageSize, pageToken => $pageToken, sort => $sort);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceListModelDeployments: $@\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.c_ml_service_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->cMLServiceListModelDeployments: %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


cMLServiceListModels

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.cMLServiceListModels(projectId, searchFilter, sort, pageSize, pageToken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceListModels");
            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.cMLServiceListModels(projectId, searchFilter, sort, pageSize, pageToken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceListModels");
            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 cMLServiceListModelsWith: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.cMLServiceListModels(projectId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class cMLServiceListModelsExample
    {
        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.cMLServiceListModels(projectId, searchFilter, sort, pageSize, pageToken);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceListModels: " + 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->cMLServiceListModels($projectId, $searchFilter, $sort, $pageSize, $pageToken);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->cMLServiceListModels: ', $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->cMLServiceListModels(projectId => $projectId, searchFilter => $searchFilter, sort => $sort, pageSize => $pageSize, pageToken => $pageToken);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceListModels: $@\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.c_ml_service_list_models(projectId, searchFilter=searchFilter, sort=sort, pageSize=pageSize, pageToken=pageToken)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceListModels: %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


cMLServiceListNewsFeeds

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.cMLServiceListNewsFeeds(category, pageSize, pageToken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceListNewsFeeds");
            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.cMLServiceListNewsFeeds(category, pageSize, pageToken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceListNewsFeeds");
            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 cMLServiceListNewsFeedsWith: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.cMLServiceListNewsFeeds(category, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class cMLServiceListNewsFeedsExample
    {
        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.cMLServiceListNewsFeeds(category, pageSize, pageToken);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceListNewsFeeds: " + 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->cMLServiceListNewsFeeds($category, $pageSize, $pageToken);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->cMLServiceListNewsFeeds: ', $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->cMLServiceListNewsFeeds(category => $category, pageSize => $pageSize, pageToken => $pageToken);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceListNewsFeeds: $@\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.c_ml_service_list_news_feeds(category, pageSize=pageSize, pageToken=pageToken)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceListNewsFeeds: %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


cMLServiceListProjectCollaborators

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.cMLServiceListProjectCollaborators(projectId, searchFilter, sort, pageSize, pageToken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceListProjectCollaborators");
            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.cMLServiceListProjectCollaborators(projectId, searchFilter, sort, pageSize, pageToken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceListProjectCollaborators");
            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 cMLServiceListProjectCollaboratorsWith: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.cMLServiceListProjectCollaborators(projectId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class cMLServiceListProjectCollaboratorsExample
    {
        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.cMLServiceListProjectCollaborators(projectId, searchFilter, sort, pageSize, pageToken);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceListProjectCollaborators: " + 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->cMLServiceListProjectCollaborators($projectId, $searchFilter, $sort, $pageSize, $pageToken);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->cMLServiceListProjectCollaborators: ', $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->cMLServiceListProjectCollaborators(projectId => $projectId, searchFilter => $searchFilter, sort => $sort, pageSize => $pageSize, pageToken => $pageToken);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceListProjectCollaborators: $@\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.c_ml_service_list_project_collaborators(projectId, searchFilter=searchFilter, sort=sort, pageSize=pageSize, pageToken=pageToken)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceListProjectCollaborators: %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


cMLServiceListProjectFiles

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.cMLServiceListProjectFiles(projectId, path);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceListProjectFiles");
            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.cMLServiceListProjectFiles(projectId, path);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceListProjectFiles");
            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 cMLServiceListProjectFilesWith: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.cMLServiceListProjectFiles(projectId, path, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class cMLServiceListProjectFilesExample
    {
        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.cMLServiceListProjectFiles(projectId, path);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceListProjectFiles: " + 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->cMLServiceListProjectFiles($projectId, $path);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->cMLServiceListProjectFiles: ', $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->cMLServiceListProjectFiles(projectId => $projectId, path => $path);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceListProjectFiles: $@\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.c_ml_service_list_project_files(projectId, path)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceListProjectFiles: %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


cMLServiceListProjectNames

Return all the project names the user has access to, optionally filtered, sorted, and paginated.


/api/v2/projectnames

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/projectnames?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: [name].
For example:
  search_filter={"name":"project name"}.
        String sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [name].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
	sort=name.
        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 {
            ListProjectNamesResponse result = apiInstance.cMLServiceListProjectNames(searchFilter, sort, pageSize, pageToken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceListProjectNames");
            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: [name].
For example:
  search_filter={"name":"project name"}.
        String sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [name].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
	sort=name.
        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 {
            ListProjectNamesResponse result = apiInstance.cMLServiceListProjectNames(searchFilter, sort, pageSize, pageToken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceListProjectNames");
            e.printStackTrace();
        }
    }
}
String *searchFilter = searchFilter_example; // Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [name].
For example:
  search_filter={"name":"project name"}. (optional)
String *sort = sort_example; // Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [name].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
	sort=name. (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];

// Return all the project names the user has access to, optionally filtered, sorted, and paginated.
[apiInstance cMLServiceListProjectNamesWith:searchFilter
    sort:sort
    pageSize:pageSize
    pageToken:pageToken
              completionHandler: ^(ListProjectNamesResponse 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: [name].
For example:
  search_filter={"name":"project name"}.
  'sort': sort_example, // {{String}} Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [name].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
	sort=name.
  '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.cMLServiceListProjectNames(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class cMLServiceListProjectNamesExample
    {
        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: [name].
For example:
  search_filter={"name":"project name"}. (optional) 
            var sort = sort_example;  // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [name].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
	sort=name. (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
            {
                // Return all the project names the user has access to, optionally filtered, sorted, and paginated.
                ListProjectNamesResponse result = apiInstance.cMLServiceListProjectNames(searchFilter, sort, pageSize, pageToken);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceListProjectNames: " + 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: [name].
For example:
  search_filter={"name":"project name"}.
$sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [name].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
	sort=name.
$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->cMLServiceListProjectNames($searchFilter, $sort, $pageSize, $pageToken);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->cMLServiceListProjectNames: ', $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: [name].
For example:
  search_filter={"name":"project name"}.
my $sort = sort_example; # String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [name].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
	sort=name.
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->cMLServiceListProjectNames(searchFilter => $searchFilter, sort => $sort, pageSize => $pageSize, pageToken => $pageToken);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceListProjectNames: $@\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: [name].
For example:
  search_filter={"name":"project name"}. (optional)
sort = sort_example # String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [name].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
	sort=name. (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: 
    # Return all the project names the user has access to, optionally filtered, sorted, and paginated.
    api_response = api_instance.c_ml_service_list_project_names(searchFilter=searchFilter, sort=sort, pageSize=pageSize, pageToken=pageToken)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceListProjectNames: %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: [name]. For example: search_filter={"name":"project name"}.
sort
String
Sort is an optional HTTP parameter to sort results by. Supported sort keys are: [name]. where "+" means sort by ascending order, and "-" means sort by descending order. For example: sort=name.
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


cMLServiceListProjects

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.cMLServiceListProjects(searchFilter, sort, pageSize, pageToken, includePublicProjects, includeAllProjects);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceListProjects");
            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.cMLServiceListProjects(searchFilter, sort, pageSize, pageToken, includePublicProjects, includeAllProjects);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceListProjects");
            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 cMLServiceListProjectsWith: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.cMLServiceListProjects(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class cMLServiceListProjectsExample
    {
        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.cMLServiceListProjects(searchFilter, sort, pageSize, pageToken, includePublicProjects, includeAllProjects);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceListProjects: " + 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->cMLServiceListProjects($searchFilter, $sort, $pageSize, $pageToken, $includePublicProjects, $includeAllProjects);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->cMLServiceListProjects: ', $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->cMLServiceListProjects(searchFilter => $searchFilter, sort => $sort, pageSize => $pageSize, pageToken => $pageToken, includePublicProjects => $includePublicProjects, includeAllProjects => $includeAllProjects);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceListProjects: $@\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.c_ml_service_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->cMLServiceListProjects: %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


cMLServiceListRegisteredModels

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.cMLServiceListRegisteredModels(searchFilter, sort, pageSize, pageToken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceListRegisteredModels");
            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.cMLServiceListRegisteredModels(searchFilter, sort, pageSize, pageToken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceListRegisteredModels");
            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 cMLServiceListRegisteredModelsWith: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.cMLServiceListRegisteredModels(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class cMLServiceListRegisteredModelsExample
    {
        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.cMLServiceListRegisteredModels(searchFilter, sort, pageSize, pageToken);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceListRegisteredModels: " + 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->cMLServiceListRegisteredModels($searchFilter, $sort, $pageSize, $pageToken);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->cMLServiceListRegisteredModels: ', $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->cMLServiceListRegisteredModels(searchFilter => $searchFilter, sort => $sort, pageSize => $pageSize, pageToken => $pageToken);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceListRegisteredModels: $@\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.c_ml_service_list_registered_models(searchFilter=searchFilter, sort=sort, pageSize=pageSize, pageToken=pageToken)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceListRegisteredModels: %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


cMLServiceListRuntimeAddons

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.cMLServiceListRuntimeAddons(searchFilter, pageSize, pageToken, sort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceListRuntimeAddons");
            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.cMLServiceListRuntimeAddons(searchFilter, pageSize, pageToken, sort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceListRuntimeAddons");
            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 cMLServiceListRuntimeAddonsWith: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.cMLServiceListRuntimeAddons(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class cMLServiceListRuntimeAddonsExample
    {
        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.cMLServiceListRuntimeAddons(searchFilter, pageSize, pageToken, sort);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceListRuntimeAddons: " + 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->cMLServiceListRuntimeAddons($searchFilter, $pageSize, $pageToken, $sort);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->cMLServiceListRuntimeAddons: ', $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->cMLServiceListRuntimeAddons(searchFilter => $searchFilter, pageSize => $pageSize, pageToken => $pageToken, sort => $sort);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceListRuntimeAddons: $@\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.c_ml_service_list_runtime_addons(searchFilter=searchFilter, pageSize=pageSize, pageToken=pageToken, sort=sort)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceListRuntimeAddons: %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


cMLServiceListRuntimeRepos

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.cMLServiceListRuntimeRepos(searchFilter, sort, pageSize, pageToken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceListRuntimeRepos");
            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.cMLServiceListRuntimeRepos(searchFilter, sort, pageSize, pageToken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceListRuntimeRepos");
            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 cMLServiceListRuntimeReposWith: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.cMLServiceListRuntimeRepos(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class cMLServiceListRuntimeReposExample
    {
        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.cMLServiceListRuntimeRepos(searchFilter, sort, pageSize, pageToken);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceListRuntimeRepos: " + 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->cMLServiceListRuntimeRepos($searchFilter, $sort, $pageSize, $pageToken);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->cMLServiceListRuntimeRepos: ', $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->cMLServiceListRuntimeRepos(searchFilter => $searchFilter, sort => $sort, pageSize => $pageSize, pageToken => $pageToken);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceListRuntimeRepos: $@\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.c_ml_service_list_runtime_repos(searchFilter=searchFilter, sort=sort, pageSize=pageSize, pageToken=pageToken)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceListRuntimeRepos: %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


cMLServiceListRuntimes

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.cMLServiceListRuntimes(searchFilter, pageSize, pageToken, sort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceListRuntimes");
            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.cMLServiceListRuntimes(searchFilter, pageSize, pageToken, sort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceListRuntimes");
            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 cMLServiceListRuntimesWith: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.cMLServiceListRuntimes(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class cMLServiceListRuntimesExample
    {
        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.cMLServiceListRuntimes(searchFilter, pageSize, pageToken, sort);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceListRuntimes: " + 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->cMLServiceListRuntimes($searchFilter, $pageSize, $pageToken, $sort);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->cMLServiceListRuntimes: ', $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->cMLServiceListRuntimes(searchFilter => $searchFilter, pageSize => $pageSize, pageToken => $pageToken, sort => $sort);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceListRuntimes: $@\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.c_ml_service_list_runtimes(searchFilter=searchFilter, pageSize=pageSize, pageToken=pageToken, sort=sort)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceListRuntimes: %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


cMLServiceListUsage

Return the new usage view based on the caller context, optionally filtered, sorted, and paginated.


/api/v2/usage

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/usage?search_filter=&sort=&page_size=&page_token=&multi_column_search_filter=&time_range_search_filter="
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: [name creator group project_name workload_type status].
For example:
  search_filter={"name":"My Session","workload_type":"session"}.
        String sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [name creator group project_name cpu memory nvidia_gpu workload_type created_at status].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=name.
        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.
        String multiColumnSearchFilter = multiColumnSearchFilter_example; // String | Multi column search filter is an optional HTTP parameter to filter multiple columns.
Supported Multi column search filter keys are: [project_or_workload_name].
For example:
  multi_column_search_filter={"project_or_workload_name":"name"}.
        String timeRangeSearchFilter = timeRangeSearchFilter_example; // String | Time range search filter is an optional HTTP parameter to filter based on the time.
Supported Time range search filters are: [created_time].
For example:
  time_range_search_filter={"created_time":{"min":"2023-12-11 21:06:51","max":"2023-12-11 21:08:51"}}.
        try {
            ListUsageResponse result = apiInstance.cMLServiceListUsage(searchFilter, sort, pageSize, pageToken, multiColumnSearchFilter, timeRangeSearchFilter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceListUsage");
            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: [name creator group project_name workload_type status].
For example:
  search_filter={"name":"My Session","workload_type":"session"}.
        String sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [name creator group project_name cpu memory nvidia_gpu workload_type created_at status].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=name.
        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.
        String multiColumnSearchFilter = multiColumnSearchFilter_example; // String | Multi column search filter is an optional HTTP parameter to filter multiple columns.
Supported Multi column search filter keys are: [project_or_workload_name].
For example:
  multi_column_search_filter={"project_or_workload_name":"name"}.
        String timeRangeSearchFilter = timeRangeSearchFilter_example; // String | Time range search filter is an optional HTTP parameter to filter based on the time.
Supported Time range search filters are: [created_time].
For example:
  time_range_search_filter={"created_time":{"min":"2023-12-11 21:06:51","max":"2023-12-11 21:08:51"}}.
        try {
            ListUsageResponse result = apiInstance.cMLServiceListUsage(searchFilter, sort, pageSize, pageToken, multiColumnSearchFilter, timeRangeSearchFilter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceListUsage");
            e.printStackTrace();
        }
    }
}
String *searchFilter = searchFilter_example; // Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [name creator group project_name workload_type status].
For example:
  search_filter={"name":"My Session","workload_type":"session"}. (optional)
String *sort = sort_example; // Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [name creator group project_name cpu memory nvidia_gpu workload_type created_at status].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=name. (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)
String *multiColumnSearchFilter = multiColumnSearchFilter_example; // Multi column search filter is an optional HTTP parameter to filter multiple columns.
Supported Multi column search filter keys are: [project_or_workload_name].
For example:
  multi_column_search_filter={"project_or_workload_name":"name"}. (optional)
String *timeRangeSearchFilter = timeRangeSearchFilter_example; // Time range search filter is an optional HTTP parameter to filter based on the time.
Supported Time range search filters are: [created_time].
For example:
  time_range_search_filter={"created_time":{"min":"2023-12-11 21:06:51","max":"2023-12-11 21:08:51"}}. (optional)

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

// Return the new usage view based on the caller context, optionally filtered, sorted, and paginated.
[apiInstance cMLServiceListUsageWith:searchFilter
    sort:sort
    pageSize:pageSize
    pageToken:pageToken
    multiColumnSearchFilter:multiColumnSearchFilter
    timeRangeSearchFilter:timeRangeSearchFilter
              completionHandler: ^(ListUsageResponse 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: [name creator group project_name workload_type status].
For example:
  search_filter={"name":"My Session","workload_type":"session"}.
  'sort': sort_example, // {{String}} Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [name creator group project_name cpu memory nvidia_gpu workload_type created_at status].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=name.
  'pageSize': 56, // {{Integer}} page size of the response runtime repo list.
  'pageToken': pageToken_example, // {{String}} page token for specifying which page to return.
  'multiColumnSearchFilter': multiColumnSearchFilter_example, // {{String}} Multi column search filter is an optional HTTP parameter to filter multiple columns.
Supported Multi column search filter keys are: [project_or_workload_name].
For example:
  multi_column_search_filter={"project_or_workload_name":"name"}.
  'timeRangeSearchFilter': timeRangeSearchFilter_example // {{String}} Time range search filter is an optional HTTP parameter to filter based on the time.
Supported Time range search filters are: [created_time].
For example:
  time_range_search_filter={"created_time":{"min":"2023-12-11 21:06:51","max":"2023-12-11 21:08:51"}}.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.cMLServiceListUsage(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class cMLServiceListUsageExample
    {
        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: [name creator group project_name workload_type status].
For example:
  search_filter={"name":"My Session","workload_type":"session"}. (optional) 
            var sort = sort_example;  // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [name creator group project_name cpu memory nvidia_gpu workload_type created_at status].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=name. (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) 
            var multiColumnSearchFilter = multiColumnSearchFilter_example;  // String | Multi column search filter is an optional HTTP parameter to filter multiple columns.
Supported Multi column search filter keys are: [project_or_workload_name].
For example:
  multi_column_search_filter={"project_or_workload_name":"name"}. (optional) 
            var timeRangeSearchFilter = timeRangeSearchFilter_example;  // String | Time range search filter is an optional HTTP parameter to filter based on the time.
Supported Time range search filters are: [created_time].
For example:
  time_range_search_filter={"created_time":{"min":"2023-12-11 21:06:51","max":"2023-12-11 21:08:51"}}. (optional) 

            try
            {
                // Return the new usage view based on the caller context, optionally filtered, sorted, and paginated.
                ListUsageResponse result = apiInstance.cMLServiceListUsage(searchFilter, sort, pageSize, pageToken, multiColumnSearchFilter, timeRangeSearchFilter);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceListUsage: " + 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: [name creator group project_name workload_type status].
For example:
  search_filter={"name":"My Session","workload_type":"session"}.
$sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [name creator group project_name cpu memory nvidia_gpu workload_type created_at status].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=name.
$pageSize = 56; // Integer | page size of the response runtime repo list.
$pageToken = pageToken_example; // String | page token for specifying which page to return.
$multiColumnSearchFilter = multiColumnSearchFilter_example; // String | Multi column search filter is an optional HTTP parameter to filter multiple columns.
Supported Multi column search filter keys are: [project_or_workload_name].
For example:
  multi_column_search_filter={"project_or_workload_name":"name"}.
$timeRangeSearchFilter = timeRangeSearchFilter_example; // String | Time range search filter is an optional HTTP parameter to filter based on the time.
Supported Time range search filters are: [created_time].
For example:
  time_range_search_filter={"created_time":{"min":"2023-12-11 21:06:51","max":"2023-12-11 21:08:51"}}.

try {
    $result = $api_instance->cMLServiceListUsage($searchFilter, $sort, $pageSize, $pageToken, $multiColumnSearchFilter, $timeRangeSearchFilter);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->cMLServiceListUsage: ', $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: [name creator group project_name workload_type status].
For example:
  search_filter={"name":"My Session","workload_type":"session"}.
my $sort = sort_example; # String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [name creator group project_name cpu memory nvidia_gpu workload_type created_at status].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=name.
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.
my $multiColumnSearchFilter = multiColumnSearchFilter_example; # String | Multi column search filter is an optional HTTP parameter to filter multiple columns.
Supported Multi column search filter keys are: [project_or_workload_name].
For example:
  multi_column_search_filter={"project_or_workload_name":"name"}.
my $timeRangeSearchFilter = timeRangeSearchFilter_example; # String | Time range search filter is an optional HTTP parameter to filter based on the time.
Supported Time range search filters are: [created_time].
For example:
  time_range_search_filter={"created_time":{"min":"2023-12-11 21:06:51","max":"2023-12-11 21:08:51"}}.

eval { 
    my $result = $api_instance->cMLServiceListUsage(searchFilter => $searchFilter, sort => $sort, pageSize => $pageSize, pageToken => $pageToken, multiColumnSearchFilter => $multiColumnSearchFilter, timeRangeSearchFilter => $timeRangeSearchFilter);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceListUsage: $@\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: [name creator group project_name workload_type status].
For example:
  search_filter={"name":"My Session","workload_type":"session"}. (optional)
sort = sort_example # String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [name creator group project_name cpu memory nvidia_gpu workload_type created_at status].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=name. (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)
multiColumnSearchFilter = multiColumnSearchFilter_example # String | Multi column search filter is an optional HTTP parameter to filter multiple columns.
Supported Multi column search filter keys are: [project_or_workload_name].
For example:
  multi_column_search_filter={"project_or_workload_name":"name"}. (optional)
timeRangeSearchFilter = timeRangeSearchFilter_example # String | Time range search filter is an optional HTTP parameter to filter based on the time.
Supported Time range search filters are: [created_time].
For example:
  time_range_search_filter={"created_time":{"min":"2023-12-11 21:06:51","max":"2023-12-11 21:08:51"}}. (optional)

try: 
    # Return the new usage view based on the caller context, optionally filtered, sorted, and paginated.
    api_response = api_instance.c_ml_service_list_usage(searchFilter=searchFilter, sort=sort, pageSize=pageSize, pageToken=pageToken, multiColumnSearchFilter=multiColumnSearchFilter, timeRangeSearchFilter=timeRangeSearchFilter)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceListUsage: %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: [name creator group project_name workload_type status]. For example: search_filter={"name":"My Session","workload_type":"session"}.
sort
String
Sort is an optional HTTP parameter to sort results by. Supported sort keys are: [name creator group project_name cpu memory nvidia_gpu workload_type created_at status]. where "+" means sort by ascending order, and "-" means sort by descending order. For example: sort=name.
page_size
Integer (int32)
page size of the response runtime repo list.
page_token
String
page token for specifying which page to return.
multi_column_search_filter
String
Multi column search filter is an optional HTTP parameter to filter multiple columns. Supported Multi column search filter keys are: [project_or_workload_name]. For example: multi_column_search_filter={"project_or_workload_name":"name"}.
time_range_search_filter
String
Time range search filter is an optional HTTP parameter to filter based on the time. Supported Time range search filters are: [created_time]. For example: time_range_search_filter={"created_time":{"min":"2023-12-11 21:06:51","max":"2023-12-11 21:08:51"}}.

Responses

Status: 200 - A successful response.

Status: default - An unexpected error response


cMLServiceListUsersQuota

Return all the user names and quotas based on the context. Admin gets all the users details.


/api/v2/usersquota

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/usersquota?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: [banned deactivated].
For example:
  search_filter={"deactivated":"false","banned":"false"}.
        String sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [username].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=username.
        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 {
            ListUsersQuotaResponse result = apiInstance.cMLServiceListUsersQuota(searchFilter, sort, pageSize, pageToken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceListUsersQuota");
            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: [banned deactivated].
For example:
  search_filter={"deactivated":"false","banned":"false"}.
        String sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [username].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=username.
        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 {
            ListUsersQuotaResponse result = apiInstance.cMLServiceListUsersQuota(searchFilter, sort, pageSize, pageToken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceListUsersQuota");
            e.printStackTrace();
        }
    }
}
String *searchFilter = searchFilter_example; // Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [banned deactivated].
For example:
  search_filter={"deactivated":"false","banned":"false"}. (optional)
String *sort = sort_example; // Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [username].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=username. (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];

// Return all the user names and quotas based on the context. Admin gets all the users details.
[apiInstance cMLServiceListUsersQuotaWith:searchFilter
    sort:sort
    pageSize:pageSize
    pageToken:pageToken
              completionHandler: ^(ListUsersQuotaResponse 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: [banned deactivated].
For example:
  search_filter={"deactivated":"false","banned":"false"}.
  'sort': sort_example, // {{String}} Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [username].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=username.
  '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.cMLServiceListUsersQuota(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class cMLServiceListUsersQuotaExample
    {
        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: [banned deactivated].
For example:
  search_filter={"deactivated":"false","banned":"false"}. (optional) 
            var sort = sort_example;  // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [username].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=username. (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
            {
                // Return all the user names and quotas based on the context. Admin gets all the users details.
                ListUsersQuotaResponse result = apiInstance.cMLServiceListUsersQuota(searchFilter, sort, pageSize, pageToken);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceListUsersQuota: " + 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: [banned deactivated].
For example:
  search_filter={"deactivated":"false","banned":"false"}.
$sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [username].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=username.
$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->cMLServiceListUsersQuota($searchFilter, $sort, $pageSize, $pageToken);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->cMLServiceListUsersQuota: ', $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: [banned deactivated].
For example:
  search_filter={"deactivated":"false","banned":"false"}.
my $sort = sort_example; # String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [username].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=username.
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->cMLServiceListUsersQuota(searchFilter => $searchFilter, sort => $sort, pageSize => $pageSize, pageToken => $pageToken);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceListUsersQuota: $@\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: [banned deactivated].
For example:
  search_filter={"deactivated":"false","banned":"false"}. (optional)
sort = sort_example # String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [username].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=username. (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: 
    # Return all the user names and quotas based on the context. Admin gets all the users details.
    api_response = api_instance.c_ml_service_list_users_quota(searchFilter=searchFilter, sort=sort, pageSize=pageSize, pageToken=pageToken)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceListUsersQuota: %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: [banned deactivated]. For example: search_filter={"deactivated":"false","banned":"false"}.
sort
String
Sort is an optional HTTP parameter to sort results by. Supported sort keys are: [username]. where "+" means sort by ascending order, and "-" means sort by descending order. For example: sort=username.
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


cMLServiceListV2Keys

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.cMLServiceListV2Keys(username);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceListV2Keys");
            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.cMLServiceListV2Keys(username);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceListV2Keys");
            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 cMLServiceListV2KeysWith: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.cMLServiceListV2Keys(username, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class cMLServiceListV2KeysExample
    {
        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.cMLServiceListV2Keys(username);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceListV2Keys: " + 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->cMLServiceListV2Keys($username);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->cMLServiceListV2Keys: ', $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->cMLServiceListV2Keys(username => $username);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceListV2Keys: $@\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.c_ml_service_list_v2_keys(username)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceListV2Keys: %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


cMLServiceListWorkloadStatus

Return the workload statuses.


/api/v2/workloadstatus

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/workloadstatus"
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();
        try {
            ListWorkloadStatusResponse result = apiInstance.cMLServiceListWorkloadStatus();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceListWorkloadStatus");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        try {
            ListWorkloadStatusResponse result = apiInstance.cMLServiceListWorkloadStatus();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceListWorkloadStatus");
            e.printStackTrace();
        }
    }
}

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

// Return the workload statuses.
[apiInstance cMLServiceListWorkloadStatusWithCompletionHandler: 
              ^(ListWorkloadStatusResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

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

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

            var apiInstance = new CMLServiceApi();

            try
            {
                // Return the workload statuses.
                ListWorkloadStatusResponse result = apiInstance.cMLServiceListWorkloadStatus();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceListWorkloadStatus: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();

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

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();

eval { 
    my $result = $api_instance->cMLServiceListWorkloadStatus();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceListWorkloadStatus: $@\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()

try: 
    # Return the workload statuses.
    api_response = api_instance.c_ml_service_list_workload_status()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceListWorkloadStatus: %s\n" % e)

Parameters

Responses

Status: 200 - A successful response.

Status: default - An unexpected error response


cMLServiceListWorkloadTypes

Return the workload types.


/api/v2/workloadtypes

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/workloadtypes"
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();
        try {
            ListWorkloadTypesResponse result = apiInstance.cMLServiceListWorkloadTypes();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceListWorkloadTypes");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        try {
            ListWorkloadTypesResponse result = apiInstance.cMLServiceListWorkloadTypes();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceListWorkloadTypes");
            e.printStackTrace();
        }
    }
}

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

// Return the workload types.
[apiInstance cMLServiceListWorkloadTypesWithCompletionHandler: 
              ^(ListWorkloadTypesResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

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

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

            var apiInstance = new CMLServiceApi();

            try
            {
                // Return the workload types.
                ListWorkloadTypesResponse result = apiInstance.cMLServiceListWorkloadTypes();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceListWorkloadTypes: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();

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

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();

eval { 
    my $result = $api_instance->cMLServiceListWorkloadTypes();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceListWorkloadTypes: $@\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()

try: 
    # Return the workload types.
    api_response = api_instance.c_ml_service_list_workload_types()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceListWorkloadTypes: %s\n" % e)

Parameters

Responses

Status: 200 - A successful response.

Status: default - An unexpected error response


cMLServiceLogExperimentRunBatch

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.cMLServiceLogExperimentRunBatch(body, projectId, experimentId, runId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceLogExperimentRunBatch");
            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.cMLServiceLogExperimentRunBatch(body, projectId, experimentId, runId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceLogExperimentRunBatch");
            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 cMLServiceLogExperimentRunBatchWith: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.cMLServiceLogExperimentRunBatch(bodyprojectIdexperimentIdrunId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class cMLServiceLogExperimentRunBatchExample
    {
        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.cMLServiceLogExperimentRunBatch(body, projectId, experimentId, runId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceLogExperimentRunBatch: " + 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->cMLServiceLogExperimentRunBatch($body, $projectId, $experimentId, $runId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->cMLServiceLogExperimentRunBatch: ', $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->cMLServiceLogExperimentRunBatch(body => $body, projectId => $projectId, experimentId => $experimentId, runId => $runId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceLogExperimentRunBatch: $@\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.c_ml_service_log_experiment_run_batch(body, projectId, experimentId, runId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceLogExperimentRunBatch: %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


cMLServiceRegisterCustomRuntime

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.cMLServiceRegisterCustomRuntime(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceRegisterCustomRuntime");
            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.cMLServiceRegisterCustomRuntime(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceRegisterCustomRuntime");
            e.printStackTrace();
        }
    }
}
RegisterCustomRuntimeRequest *body = ; // 

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

// Register a runtime, given the URL to the image in the docker registry
[apiInstance cMLServiceRegisterCustomRuntimeWith: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.cMLServiceRegisterCustomRuntime(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class cMLServiceRegisterCustomRuntimeExample
    {
        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.cMLServiceRegisterCustomRuntime(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceRegisterCustomRuntime: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

try {
    $result = $api_instance->cMLServiceRegisterCustomRuntime($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->cMLServiceRegisterCustomRuntime: ', $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->cMLServiceRegisterCustomRuntime(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceRegisterCustomRuntime: $@\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.c_ml_service_register_custom_runtime(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceRegisterCustomRuntime: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - A successful response.

Status: default - An unexpected error response


cMLServiceRestartApplication

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.cMLServiceRestartApplication(projectId, applicationId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceRestartApplication");
            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.cMLServiceRestartApplication(projectId, applicationId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceRestartApplication");
            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 cMLServiceRestartApplicationWith: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.cMLServiceRestartApplication(projectId, applicationId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class cMLServiceRestartApplicationExample
    {
        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.cMLServiceRestartApplication(projectId, applicationId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceRestartApplication: " + 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->cMLServiceRestartApplication($projectId, $applicationId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->cMLServiceRestartApplication: ', $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->cMLServiceRestartApplication(projectId => $projectId, applicationId => $applicationId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceRestartApplication: $@\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.c_ml_service_restart_application(projectId, applicationId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceRestartApplication: %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


cMLServiceRestartModelDeployment

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.cMLServiceRestartModelDeployment(projectId, modelId, buildId, deploymentId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceRestartModelDeployment");
            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.cMLServiceRestartModelDeployment(projectId, modelId, buildId, deploymentId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceRestartModelDeployment");
            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 cMLServiceRestartModelDeploymentWith: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.cMLServiceRestartModelDeployment(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 cMLServiceRestartModelDeploymentExample
    {
        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.cMLServiceRestartModelDeployment(projectId, modelId, buildId, deploymentId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceRestartModelDeployment: " + 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->cMLServiceRestartModelDeployment($projectId, $modelId, $buildId, $deploymentId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->cMLServiceRestartModelDeployment: ', $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->cMLServiceRestartModelDeployment(projectId => $projectId, modelId => $modelId, buildId => $buildId, deploymentId => $deploymentId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceRestartModelDeployment: $@\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.c_ml_service_restart_model_deployment(projectId, modelId, buildId, deploymentId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceRestartModelDeployment: %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


cMLServiceRotateV1Key

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.cMLServiceRotateV1Key(body, username);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceRotateV1Key");
            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.cMLServiceRotateV1Key(body, username);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceRotateV1Key");
            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 cMLServiceRotateV1KeyWith: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.cMLServiceRotateV1Key(bodyusername, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class cMLServiceRotateV1KeyExample
    {
        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.cMLServiceRotateV1Key(body, username);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceRotateV1Key: " + 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->cMLServiceRotateV1Key($body, $username);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->cMLServiceRotateV1Key: ', $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->cMLServiceRotateV1Key(body => $body, username => $username);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceRotateV1Key: $@\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.c_ml_service_rotate_v1_key(body, username)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceRotateV1Key: %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


cMLServiceStopApplication

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.cMLServiceStopApplication(projectId, applicationId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceStopApplication");
            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.cMLServiceStopApplication(projectId, applicationId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceStopApplication");
            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 cMLServiceStopApplicationWith: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.cMLServiceStopApplication(projectId, applicationId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class cMLServiceStopApplicationExample
    {
        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.cMLServiceStopApplication(projectId, applicationId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceStopApplication: " + 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->cMLServiceStopApplication($projectId, $applicationId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->cMLServiceStopApplication: ', $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->cMLServiceStopApplication(projectId => $projectId, applicationId => $applicationId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceStopApplication: $@\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.c_ml_service_stop_application(projectId, applicationId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceStopApplication: %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


cMLServiceStopJobRun

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.cMLServiceStopJobRun(projectId, jobId, runId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceStopJobRun");
            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.cMLServiceStopJobRun(projectId, jobId, runId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceStopJobRun");
            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 cMLServiceStopJobRunWith: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.cMLServiceStopJobRun(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 cMLServiceStopJobRunExample
    {
        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.cMLServiceStopJobRun(projectId, jobId, runId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceStopJobRun: " + 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->cMLServiceStopJobRun($projectId, $jobId, $runId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->cMLServiceStopJobRun: ', $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->cMLServiceStopJobRun(projectId => $projectId, jobId => $jobId, runId => $runId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceStopJobRun: $@\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.c_ml_service_stop_job_run(projectId, jobId, runId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceStopJobRun: %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


cMLServiceStopModelDeployment

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.cMLServiceStopModelDeployment(projectId, modelId, buildId, deploymentId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceStopModelDeployment");
            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.cMLServiceStopModelDeployment(projectId, modelId, buildId, deploymentId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceStopModelDeployment");
            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 cMLServiceStopModelDeploymentWith: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.cMLServiceStopModelDeployment(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 cMLServiceStopModelDeploymentExample
    {
        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.cMLServiceStopModelDeployment(projectId, modelId, buildId, deploymentId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceStopModelDeployment: " + 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->cMLServiceStopModelDeployment($projectId, $modelId, $buildId, $deploymentId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->cMLServiceStopModelDeployment: ', $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->cMLServiceStopModelDeployment(projectId => $projectId, modelId => $modelId, buildId => $buildId, deploymentId => $deploymentId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceStopModelDeployment: $@\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.c_ml_service_stop_model_deployment(projectId, modelId, buildId, deploymentId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceStopModelDeployment: %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


cMLServiceUpdateAcceleratorLabelsAdminConfig

Update admin_config_max_per_workload in Node Labels


/api/v2/nodelabels/config

Usage and SDK Samples

curl -X PATCH\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//api/v2/nodelabels/config"
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();
        UpdateNodeLabelAdminConfigRequest body = ; // UpdateNodeLabelAdminConfigRequest | 
        try {
            UpdateNodeLabelAdminConfigResponse result = apiInstance.cMLServiceUpdateAcceleratorLabelsAdminConfig(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceUpdateAcceleratorLabelsAdminConfig");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

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

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

// Update admin_config_max_per_workload in Node Labels
[apiInstance cMLServiceUpdateAcceleratorLabelsAdminConfigWith:body
              completionHandler: ^(UpdateNodeLabelAdminConfigResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

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

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

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

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

            try
            {
                // Update admin_config_max_per_workload in Node Labels
                UpdateNodeLabelAdminConfigResponse result = apiInstance.cMLServiceUpdateAcceleratorLabelsAdminConfig(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceUpdateAcceleratorLabelsAdminConfig: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

try {
    $result = $api_instance->cMLServiceUpdateAcceleratorLabelsAdminConfig($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->cMLServiceUpdateAcceleratorLabelsAdminConfig: ', $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::UpdateNodeLabelAdminConfigRequest->new(); # UpdateNodeLabelAdminConfigRequest | 

eval { 
    my $result = $api_instance->cMLServiceUpdateAcceleratorLabelsAdminConfig(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceUpdateAcceleratorLabelsAdminConfig: $@\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 =  # UpdateNodeLabelAdminConfigRequest | 

try: 
    # Update admin_config_max_per_workload in Node Labels
    api_response = api_instance.c_ml_service_update_accelerator_labels_admin_config(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceUpdateAcceleratorLabelsAdminConfig: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - A successful response.

Status: default - An unexpected error response


cMLServiceUpdateApplication

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.cMLServiceUpdateApplication(body, projectId, application.id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceUpdateApplication");
            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.cMLServiceUpdateApplication(body, projectId, application.id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceUpdateApplication");
            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 cMLServiceUpdateApplicationWith: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.cMLServiceUpdateApplication(bodyprojectIdapplication.id, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class cMLServiceUpdateApplicationExample
    {
        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.cMLServiceUpdateApplication(body, projectId, application.id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceUpdateApplication: " + 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->cMLServiceUpdateApplication($body, $projectId, $application.id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->cMLServiceUpdateApplication: ', $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->cMLServiceUpdateApplication(body => $body, projectId => $projectId, application.id => $application.id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceUpdateApplication: $@\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.c_ml_service_update_application(body, projectId, application.id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceUpdateApplication: %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


cMLServiceUpdateCopilotModel

Update a Copilot model.


/api/v2/copilot/models/{copilot_model.id}

Usage and SDK Samples

curl -X PATCH\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//api/v2/copilot/models/{copilot_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();
        CopilotModel body = ; // CopilotModel | The model containing some number of fields to update.
        String copilotModel.id = copilotModel.id_example; // String | ID of the model. Must be unique.
        try {
            CopilotModel result = apiInstance.cMLServiceUpdateCopilotModel(body, copilotModel.id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceUpdateCopilotModel");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        CopilotModel body = ; // CopilotModel | The model containing some number of fields to update.
        String copilotModel.id = copilotModel.id_example; // String | ID of the model. Must be unique.
        try {
            CopilotModel result = apiInstance.cMLServiceUpdateCopilotModel(body, copilotModel.id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceUpdateCopilotModel");
            e.printStackTrace();
        }
    }
}
CopilotModel *body = ; // The model containing some number of fields to update.
String *copilotModel.id = copilotModel.id_example; // ID of the model. Must be unique.

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

// Update a Copilot model.
[apiInstance cMLServiceUpdateCopilotModelWith:body
    copilotModel.id:copilotModel.id
              completionHandler: ^(CopilotModel output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var body = ; // {{CopilotModel}} The model containing some number of fields to update.
var copilotModel.id = copilotModel.id_example; // {{String}} ID of the model. Must be unique.

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

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

            var apiInstance = new CMLServiceApi();
            var body = new CopilotModel(); // CopilotModel | The model containing some number of fields to update.
            var copilotModel.id = copilotModel.id_example;  // String | ID of the model. Must be unique.

            try
            {
                // Update a Copilot model.
                CopilotModel result = apiInstance.cMLServiceUpdateCopilotModel(body, copilotModel.id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceUpdateCopilotModel: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$body = ; // CopilotModel | The model containing some number of fields to update.
$copilotModel.id = copilotModel.id_example; // String | ID of the model. Must be unique.

try {
    $result = $api_instance->cMLServiceUpdateCopilotModel($body, $copilotModel.id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->cMLServiceUpdateCopilotModel: ', $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::CopilotModel->new(); # CopilotModel | The model containing some number of fields to update.
my $copilotModel.id = copilotModel.id_example; # String | ID of the model. Must be unique.

eval { 
    my $result = $api_instance->cMLServiceUpdateCopilotModel(body => $body, copilotModel.id => $copilotModel.id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceUpdateCopilotModel: $@\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 =  # CopilotModel | The model containing some number of fields to update.
copilotModel.id = copilotModel.id_example # String | ID of the model. Must be unique.

try: 
    # Update a Copilot model.
    api_response = api_instance.c_ml_service_update_copilot_model(body, copilotModel.id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceUpdateCopilotModel: %s\n" % e)

Parameters

Path parameters
Name Description
copilot_model.id*
String
ID of the model. Must be unique.
Required
Body parameters
Name Description
body *

Responses

Status: 200 - A successful response.

Status: default - An unexpected error response


cMLServiceUpdateExperiment

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.cMLServiceUpdateExperiment(body, experiment.projectId, experiment.id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceUpdateExperiment");
            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.cMLServiceUpdateExperiment(body, experiment.projectId, experiment.id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceUpdateExperiment");
            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 cMLServiceUpdateExperimentWith: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.cMLServiceUpdateExperiment(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 cMLServiceUpdateExperimentExample
    {
        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.cMLServiceUpdateExperiment(body, experiment.projectId, experiment.id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceUpdateExperiment: " + 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->cMLServiceUpdateExperiment($body, $experiment.projectId, $experiment.id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->cMLServiceUpdateExperiment: ', $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->cMLServiceUpdateExperiment(body => $body, experiment.projectId => $experiment.projectId, experiment.id => $experiment.id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceUpdateExperiment: $@\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.c_ml_service_update_experiment(body, experiment.projectId, experiment.id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceUpdateExperiment: %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


cMLServiceUpdateExperimentRun

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.cMLServiceUpdateExperimentRun(body, projectId, experimentId, run.id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceUpdateExperimentRun");
            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.cMLServiceUpdateExperimentRun(body, projectId, experimentId, run.id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceUpdateExperimentRun");
            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 cMLServiceUpdateExperimentRunWith: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.cMLServiceUpdateExperimentRun(bodyprojectIdexperimentIdrun.id, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class cMLServiceUpdateExperimentRunExample
    {
        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.cMLServiceUpdateExperimentRun(body, projectId, experimentId, run.id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceUpdateExperimentRun: " + 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->cMLServiceUpdateExperimentRun($body, $projectId, $experimentId, $run.id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->cMLServiceUpdateExperimentRun: ', $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->cMLServiceUpdateExperimentRun(body => $body, projectId => $projectId, experimentId => $experimentId, run.id => $run.id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceUpdateExperimentRun: $@\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.c_ml_service_update_experiment_run(body, projectId, experimentId, run.id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceUpdateExperimentRun: %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


cMLServiceUpdateJob

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.cMLServiceUpdateJob(body, projectId, job.id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceUpdateJob");
            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.cMLServiceUpdateJob(body, projectId, job.id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceUpdateJob");
            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 cMLServiceUpdateJobWith: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.cMLServiceUpdateJob(bodyprojectIdjob.id, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class cMLServiceUpdateJobExample
    {
        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.cMLServiceUpdateJob(body, projectId, job.id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceUpdateJob: " + 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->cMLServiceUpdateJob($body, $projectId, $job.id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->cMLServiceUpdateJob: ', $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->cMLServiceUpdateJob(body => $body, projectId => $projectId, job.id => $job.id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceUpdateJob: $@\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.c_ml_service_update_job(body, projectId, job.id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceUpdateJob: %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


cMLServiceUpdateModel

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.cMLServiceUpdateModel(body, projectId, model.id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceUpdateModel");
            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.cMLServiceUpdateModel(body, projectId, model.id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceUpdateModel");
            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 cMLServiceUpdateModelWith: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.cMLServiceUpdateModel(bodyprojectIdmodel.id, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class cMLServiceUpdateModelExample
    {
        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.cMLServiceUpdateModel(body, projectId, model.id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceUpdateModel: " + 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->cMLServiceUpdateModel($body, $projectId, $model.id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->cMLServiceUpdateModel: ', $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->cMLServiceUpdateModel(body => $body, projectId => $projectId, model.id => $model.id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceUpdateModel: $@\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.c_ml_service_update_model(body, projectId, model.id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceUpdateModel: %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


cMLServiceUpdateProject

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.cMLServiceUpdateProject(body, project.id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceUpdateProject");
            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.cMLServiceUpdateProject(body, project.id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceUpdateProject");
            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 cMLServiceUpdateProjectWith: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.cMLServiceUpdateProject(bodyproject.id, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class cMLServiceUpdateProjectExample
    {
        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.cMLServiceUpdateProject(body, project.id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceUpdateProject: " + 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->cMLServiceUpdateProject($body, $project.id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->cMLServiceUpdateProject: ', $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->cMLServiceUpdateProject(body => $body, project.id => $project.id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceUpdateProject: $@\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.c_ml_service_update_project(body, project.id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceUpdateProject: %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


cMLServiceUpdateProjectFileMetadata

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.cMLServiceUpdateProjectFileMetadata(body, projectId, path);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceUpdateProjectFileMetadata");
            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.cMLServiceUpdateProjectFileMetadata(body, projectId, path);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceUpdateProjectFileMetadata");
            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 cMLServiceUpdateProjectFileMetadataWith: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.cMLServiceUpdateProjectFileMetadata(bodyprojectIdpath, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class cMLServiceUpdateProjectFileMetadataExample
    {
        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.cMLServiceUpdateProjectFileMetadata(body, projectId, path);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceUpdateProjectFileMetadata: " + 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->cMLServiceUpdateProjectFileMetadata($body, $projectId, $path);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->cMLServiceUpdateProjectFileMetadata: ', $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->cMLServiceUpdateProjectFileMetadata(body => $body, projectId => $projectId, path => $path);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceUpdateProjectFileMetadata: $@\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.c_ml_service_update_project_file_metadata(body, projectId, path)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceUpdateProjectFileMetadata: %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


cMLServiceUpdateRegisteredModel

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.cMLServiceUpdateRegisteredModel(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceUpdateRegisteredModel");
            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.cMLServiceUpdateRegisteredModel(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceUpdateRegisteredModel");
            e.printStackTrace();
        }
    }
}
UpdateRegisteredModelRequest *body = ; // 

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

// Update a Registered model.
[apiInstance cMLServiceUpdateRegisteredModelWith: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.cMLServiceUpdateRegisteredModel(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

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

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

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

try {
    $result = $api_instance->cMLServiceUpdateRegisteredModel($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->cMLServiceUpdateRegisteredModel: ', $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->cMLServiceUpdateRegisteredModel(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceUpdateRegisteredModel: $@\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.c_ml_service_update_registered_model(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceUpdateRegisteredModel: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - A successful response.

Status: default - An unexpected error response


cMLServiceUpdateRegisteredModelVersion

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.cMLServiceUpdateRegisteredModelVersion(body, modelId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceUpdateRegisteredModelVersion");
            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.cMLServiceUpdateRegisteredModelVersion(body, modelId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceUpdateRegisteredModelVersion");
            e.printStackTrace();
        }
    }
}
UpdateRegisteredModelVersionRequest *body = ; // 
String *modelId = modelId_example; // Model ID.

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

// Update a Registered model version.
[apiInstance cMLServiceUpdateRegisteredModelVersionWith: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.cMLServiceUpdateRegisteredModelVersion(bodymodelId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class cMLServiceUpdateRegisteredModelVersionExample
    {
        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.cMLServiceUpdateRegisteredModelVersion(body, modelId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceUpdateRegisteredModelVersion: " + 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->cMLServiceUpdateRegisteredModelVersion($body, $modelId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->cMLServiceUpdateRegisteredModelVersion: ', $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->cMLServiceUpdateRegisteredModelVersion(body => $body, modelId => $modelId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceUpdateRegisteredModelVersion: $@\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.c_ml_service_update_registered_model_version(body, modelId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceUpdateRegisteredModelVersion: %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


cMLServiceUpdateRuntimeAddonStatus

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.cMLServiceUpdateRuntimeAddonStatus(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceUpdateRuntimeAddonStatus");
            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.cMLServiceUpdateRuntimeAddonStatus(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceUpdateRuntimeAddonStatus");
            e.printStackTrace();
        }
    }
}
UpdateRuntimeAddonStatusRequest *body = ; // 

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

// Update runtime addons
[apiInstance cMLServiceUpdateRuntimeAddonStatusWith: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.cMLServiceUpdateRuntimeAddonStatus(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

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

            try
            {
                // Update runtime addons
                UpdateRuntimeAddonStatusResponse result = apiInstance.cMLServiceUpdateRuntimeAddonStatus(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceUpdateRuntimeAddonStatus: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

try {
    $result = $api_instance->cMLServiceUpdateRuntimeAddonStatus($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->cMLServiceUpdateRuntimeAddonStatus: ', $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->cMLServiceUpdateRuntimeAddonStatus(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceUpdateRuntimeAddonStatus: $@\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.c_ml_service_update_runtime_addon_status(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceUpdateRuntimeAddonStatus: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - A successful response.

Status: default - An unexpected error response


cMLServiceUpdateRuntimeRepo

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.cMLServiceUpdateRuntimeRepo(body, runtimerepo.id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceUpdateRuntimeRepo");
            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.cMLServiceUpdateRuntimeRepo(body, runtimerepo.id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceUpdateRuntimeRepo");
            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 cMLServiceUpdateRuntimeRepoWith: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.cMLServiceUpdateRuntimeRepo(bodyruntimerepo.id, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class cMLServiceUpdateRuntimeRepoExample
    {
        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.cMLServiceUpdateRuntimeRepo(body, runtimerepo.id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceUpdateRuntimeRepo: " + 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->cMLServiceUpdateRuntimeRepo($body, $runtimerepo.id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->cMLServiceUpdateRuntimeRepo: ', $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->cMLServiceUpdateRuntimeRepo(body => $body, runtimerepo.id => $runtimerepo.id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceUpdateRuntimeRepo: $@\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.c_ml_service_update_runtime_repo(body, runtimerepo.id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceUpdateRuntimeRepo: %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


cMLServiceUpdateRuntimeStatus

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.cMLServiceUpdateRuntimeStatus(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceUpdateRuntimeStatus");
            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.cMLServiceUpdateRuntimeStatus(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceUpdateRuntimeStatus");
            e.printStackTrace();
        }
    }
}
UpdateRuntimeStatusRequest *body = ; // 

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

// Update the status of selected runtimes
[apiInstance cMLServiceUpdateRuntimeStatusWith: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.cMLServiceUpdateRuntimeStatus(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

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

            try
            {
                // Update the status of selected runtimes
                UpdateRuntimeStatusResponse result = apiInstance.cMLServiceUpdateRuntimeStatus(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceUpdateRuntimeStatus: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

try {
    $result = $api_instance->cMLServiceUpdateRuntimeStatus($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->cMLServiceUpdateRuntimeStatus: ', $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->cMLServiceUpdateRuntimeStatus(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceUpdateRuntimeStatus: $@\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.c_ml_service_update_runtime_status(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceUpdateRuntimeStatus: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - A successful response.

Status: default - An unexpected error response


cMLServiceValidateCustomRuntime

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.cMLServiceValidateCustomRuntime(url);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceValidateCustomRuntime");
            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.cMLServiceValidateCustomRuntime(url);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceValidateCustomRuntime");
            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 cMLServiceValidateCustomRuntimeWith: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.cMLServiceValidateCustomRuntime(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class cMLServiceValidateCustomRuntimeExample
    {
        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.cMLServiceValidateCustomRuntime(url);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceValidateCustomRuntime: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$url = url_example; // String | 

try {
    $result = $api_instance->cMLServiceValidateCustomRuntime($url);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->cMLServiceValidateCustomRuntime: ', $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->cMLServiceValidateCustomRuntime(url => $url);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceValidateCustomRuntime: $@\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.c_ml_service_validate_custom_runtime(url=url)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceValidateCustomRuntime: %s\n" % e)

Parameters

Query parameters
Name Description
url
String

Responses

Status: 200 - A successful response.

Status: default - An unexpected error response