Cloudera Documentation

OpenAPI definition

APIKeyOperations

createApiKey

Creates a new api key in the specified project.


/api/v2/projects/{projectId}/api-keys

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost/api/v2/projects/{projectId}/api-keys" \
 -d '{
  "api_key" : "api_key",
  "name" : "name"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.APIKeyOperationsApi;

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

public class APIKeyOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        APIKeyOperationsApi apiInstance = new APIKeyOperationsApi();
        String projectId = projectId_example; // String | 
        ApiKeySyncDto apiKeySyncDto = ; // ApiKeySyncDto | 

        try {
            ApiKeyDto result = apiInstance.createApiKey(projectId, apiKeySyncDto);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling APIKeyOperationsApi#createApiKey");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String projectId = new String(); // String | 
final ApiKeySyncDto apiKeySyncDto = new ApiKeySyncDto(); // ApiKeySyncDto | 

try {
    final result = await api_instance.createApiKey(projectId, apiKeySyncDto);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->createApiKey: $e\n');
}

import org.openapitools.client.api.APIKeyOperationsApi;

public class APIKeyOperationsApiExample {
    public static void main(String[] args) {
        APIKeyOperationsApi apiInstance = new APIKeyOperationsApi();
        String projectId = projectId_example; // String | 
        ApiKeySyncDto apiKeySyncDto = ; // ApiKeySyncDto | 

        try {
            ApiKeyDto result = apiInstance.createApiKey(projectId, apiKeySyncDto);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling APIKeyOperationsApi#createApiKey");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
APIKeyOperationsApi *apiInstance = [[APIKeyOperationsApi alloc] init];
String *projectId = projectId_example; //  (default to null)
ApiKeySyncDto *apiKeySyncDto = ; // 

// Creates a new api key in the specified project.
[apiInstance createApiKeyWith:projectId
    apiKeySyncDto:apiKeySyncDto
              completionHandler: ^(ApiKeyDto output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.APIKeyOperationsApi()
var projectId = projectId_example; // {String} 
var apiKeySyncDto = ; // {ApiKeySyncDto} 

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

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

            // Create an instance of the API class
            var apiInstance = new APIKeyOperationsApi();
            var projectId = projectId_example;  // String |  (default to null)
            var apiKeySyncDto = new ApiKeySyncDto(); // ApiKeySyncDto | 

            try {
                // Creates a new api key in the specified project.
                ApiKeyDto result = apiInstance.createApiKey(projectId, apiKeySyncDto);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling APIKeyOperationsApi.createApiKey: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\APIKeyOperationsApi();
$projectId = projectId_example; // String | 
$apiKeySyncDto = ; // ApiKeySyncDto | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::APIKeyOperationsApi->new();
my $projectId = projectId_example; # String | 
my $apiKeySyncDto = WWW::OPenAPIClient::Object::ApiKeySyncDto->new(); # ApiKeySyncDto | 

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

# Create an instance of the API class
api_instance = openapi_client.APIKeyOperationsApi()
projectId = projectId_example # String |  (default to null)
apiKeySyncDto =  # ApiKeySyncDto | 

try:
    # Creates a new api key in the specified project.
    api_response = api_instance.create_api_key(projectId, apiKeySyncDto)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling APIKeyOperationsApi->createApiKey: %s\n" % e)
extern crate APIKeyOperationsApi;

pub fn main() {
    let projectId = projectId_example; // String
    let apiKeySyncDto = ; // ApiKeySyncDto

    let mut context = APIKeyOperationsApi::Context::default();
    let result = client.createApiKey(projectId, apiKeySyncDto, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
projectId*
String
Required
Body parameters
Name Description
apiKeySyncDto *

Responses


deleteApiKeyById

Deletes an api key from the specified project.


/api/v2/projects/{projectId}/api-keys/{id}

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: application/json" \
 "http://localhost/api/v2/projects/{projectId}/api-keys/{id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.APIKeyOperationsApi;

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

public class APIKeyOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        APIKeyOperationsApi apiInstance = new APIKeyOperationsApi();
        Integer id = 56; // Integer | 
        String projectId = projectId_example; // String | 

        try {
            apiInstance.deleteApiKeyById(id, projectId);
        } catch (ApiException e) {
            System.err.println("Exception when calling APIKeyOperationsApi#deleteApiKeyById");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 
final String projectId = new String(); // String | 

try {
    final result = await api_instance.deleteApiKeyById(id, projectId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteApiKeyById: $e\n');
}

import org.openapitools.client.api.APIKeyOperationsApi;

public class APIKeyOperationsApiExample {
    public static void main(String[] args) {
        APIKeyOperationsApi apiInstance = new APIKeyOperationsApi();
        Integer id = 56; // Integer | 
        String projectId = projectId_example; // String | 

        try {
            apiInstance.deleteApiKeyById(id, projectId);
        } catch (ApiException e) {
            System.err.println("Exception when calling APIKeyOperationsApi#deleteApiKeyById");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
APIKeyOperationsApi *apiInstance = [[APIKeyOperationsApi alloc] init];
Integer *id = 56; //  (default to null)
String *projectId = projectId_example; //  (default to null)

// Deletes an api key from the specified project.
[apiInstance deleteApiKeyByIdWith:id
    projectId:projectId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.APIKeyOperationsApi()
var id = 56; // {Integer} 
var projectId = projectId_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteApiKeyById(id, projectId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new APIKeyOperationsApi();
            var id = 56;  // Integer |  (default to null)
            var projectId = projectId_example;  // String |  (default to null)

            try {
                // Deletes an api key from the specified project.
                apiInstance.deleteApiKeyById(id, projectId);
            } catch (Exception e) {
                Debug.Print("Exception when calling APIKeyOperationsApi.deleteApiKeyById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\APIKeyOperationsApi();
$id = 56; // Integer | 
$projectId = projectId_example; // String | 

try {
    $api_instance->deleteApiKeyById($id, $projectId);
} catch (Exception $e) {
    echo 'Exception when calling APIKeyOperationsApi->deleteApiKeyById: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::APIKeyOperationsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::APIKeyOperationsApi->new();
my $id = 56; # Integer | 
my $projectId = projectId_example; # String | 

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

# Create an instance of the API class
api_instance = openapi_client.APIKeyOperationsApi()
id = 56 # Integer |  (default to null)
projectId = projectId_example # String |  (default to null)

try:
    # Deletes an api key from the specified project.
    api_instance.delete_api_key_by_id(id, projectId)
except ApiException as e:
    print("Exception when calling APIKeyOperationsApi->deleteApiKeyById: %s\n" % e)
extern crate APIKeyOperationsApi;

pub fn main() {
    let id = 56; // Integer
    let projectId = projectId_example; // String

    let mut context = APIKeyOperationsApi::Context::default();
    let result = client.deleteApiKeyById(id, projectId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required
projectId*
String
Required

Responses


getAllApiKeysInProject

Retrieves all api keys in the specified project.


/api/v2/projects/{projectId}/api-keys

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/api/v2/projects/{projectId}/api-keys"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.APIKeyOperationsApi;

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

public class APIKeyOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        APIKeyOperationsApi apiInstance = new APIKeyOperationsApi();
        String projectId = projectId_example; // String | 

        try {
            array[ApiKeyDto] result = apiInstance.getAllApiKeysInProject(projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling APIKeyOperationsApi#getAllApiKeysInProject");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String projectId = new String(); // String | 

try {
    final result = await api_instance.getAllApiKeysInProject(projectId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getAllApiKeysInProject: $e\n');
}

import org.openapitools.client.api.APIKeyOperationsApi;

public class APIKeyOperationsApiExample {
    public static void main(String[] args) {
        APIKeyOperationsApi apiInstance = new APIKeyOperationsApi();
        String projectId = projectId_example; // String | 

        try {
            array[ApiKeyDto] result = apiInstance.getAllApiKeysInProject(projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling APIKeyOperationsApi#getAllApiKeysInProject");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
APIKeyOperationsApi *apiInstance = [[APIKeyOperationsApi alloc] init];
String *projectId = projectId_example; //  (default to null)

// Retrieves all api keys in the specified project.
[apiInstance getAllApiKeysInProjectWith:projectId
              completionHandler: ^(array[ApiKeyDto] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.APIKeyOperationsApi()
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.getAllApiKeysInProject(projectId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new APIKeyOperationsApi();
            var projectId = projectId_example;  // String |  (default to null)

            try {
                // Retrieves all api keys in the specified project.
                array[ApiKeyDto] result = apiInstance.getAllApiKeysInProject(projectId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling APIKeyOperationsApi.getAllApiKeysInProject: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\APIKeyOperationsApi();
$projectId = projectId_example; // String | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::APIKeyOperationsApi->new();
my $projectId = projectId_example; # String | 

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

# Create an instance of the API class
api_instance = openapi_client.APIKeyOperationsApi()
projectId = projectId_example # String |  (default to null)

try:
    # Retrieves all api keys in the specified project.
    api_response = api_instance.get_all_api_keys_in_project(projectId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling APIKeyOperationsApi->getAllApiKeysInProject: %s\n" % e)
extern crate APIKeyOperationsApi;

pub fn main() {
    let projectId = projectId_example; // String

    let mut context = APIKeyOperationsApi::Context::default();
    let result = client.getAllApiKeysInProject(projectId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
projectId*
String
Required

Responses


getApiKeyById

Retrieves an api key from the specified project by its id.


/api/v2/projects/{projectId}/api-keys/{id}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/api/v2/projects/{projectId}/api-keys/{id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.APIKeyOperationsApi;

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

public class APIKeyOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        APIKeyOperationsApi apiInstance = new APIKeyOperationsApi();
        Integer id = 56; // Integer | 
        String projectId = projectId_example; // String | 

        try {
            ApiKeyDto result = apiInstance.getApiKeyById(id, projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling APIKeyOperationsApi#getApiKeyById");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 
final String projectId = new String(); // String | 

try {
    final result = await api_instance.getApiKeyById(id, projectId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getApiKeyById: $e\n');
}

import org.openapitools.client.api.APIKeyOperationsApi;

public class APIKeyOperationsApiExample {
    public static void main(String[] args) {
        APIKeyOperationsApi apiInstance = new APIKeyOperationsApi();
        Integer id = 56; // Integer | 
        String projectId = projectId_example; // String | 

        try {
            ApiKeyDto result = apiInstance.getApiKeyById(id, projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling APIKeyOperationsApi#getApiKeyById");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
APIKeyOperationsApi *apiInstance = [[APIKeyOperationsApi alloc] init];
Integer *id = 56; //  (default to null)
String *projectId = projectId_example; //  (default to null)

// Retrieves an api key from the specified project by its id.
[apiInstance getApiKeyByIdWith:id
    projectId:projectId
              completionHandler: ^(ApiKeyDto output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.APIKeyOperationsApi()
var id = 56; // {Integer} 
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.getApiKeyById(id, projectId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new APIKeyOperationsApi();
            var id = 56;  // Integer |  (default to null)
            var projectId = projectId_example;  // String |  (default to null)

            try {
                // Retrieves an api key from the specified project by its id.
                ApiKeyDto result = apiInstance.getApiKeyById(id, projectId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling APIKeyOperationsApi.getApiKeyById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\APIKeyOperationsApi();
$id = 56; // Integer | 
$projectId = projectId_example; // String | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::APIKeyOperationsApi->new();
my $id = 56; # Integer | 
my $projectId = projectId_example; # String | 

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

# Create an instance of the API class
api_instance = openapi_client.APIKeyOperationsApi()
id = 56 # Integer |  (default to null)
projectId = projectId_example # String |  (default to null)

try:
    # Retrieves an api key from the specified project by its id.
    api_response = api_instance.get_api_key_by_id(id, projectId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling APIKeyOperationsApi->getApiKeyById: %s\n" % e)
extern crate APIKeyOperationsApi;

pub fn main() {
    let id = 56; // Integer
    let projectId = projectId_example; // String

    let mut context = APIKeyOperationsApi::Context::default();
    let result = client.getApiKeyById(id, projectId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required
projectId*
String
Required

Responses


AdminOperations

generateKeytab1

Generates a keytab for the user with the given credentials.


/api/v2/admin/users/{userId}/keytab/generate

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost/api/v2/admin/users/{userId}/keytab/generate" \
 -d '{
  "principal" : "principal",
  "password" : "password"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AdminOperationsApi;

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

public class AdminOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        AdminOperationsApi apiInstance = new AdminOperationsApi();
        String userId = userId_example; // String | 
        GenerateKeytabRequest generateKeytabRequest = ; // GenerateKeytabRequest | 

        try {
            apiInstance.generateKeytab1(userId, generateKeytabRequest);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminOperationsApi#generateKeytab1");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String userId = new String(); // String | 
final GenerateKeytabRequest generateKeytabRequest = new GenerateKeytabRequest(); // GenerateKeytabRequest | 

try {
    final result = await api_instance.generateKeytab1(userId, generateKeytabRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->generateKeytab1: $e\n');
}

import org.openapitools.client.api.AdminOperationsApi;

public class AdminOperationsApiExample {
    public static void main(String[] args) {
        AdminOperationsApi apiInstance = new AdminOperationsApi();
        String userId = userId_example; // String | 
        GenerateKeytabRequest generateKeytabRequest = ; // GenerateKeytabRequest | 

        try {
            apiInstance.generateKeytab1(userId, generateKeytabRequest);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminOperationsApi#generateKeytab1");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
AdminOperationsApi *apiInstance = [[AdminOperationsApi alloc] init];
String *userId = userId_example; //  (default to null)
GenerateKeytabRequest *generateKeytabRequest = ; // 

// Generates a keytab for the user with the given credentials.
[apiInstance generateKeytab1With:userId
    generateKeytabRequest:generateKeytabRequest
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.AdminOperationsApi()
var userId = userId_example; // {String} 
var generateKeytabRequest = ; // {GenerateKeytabRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.generateKeytab1(userId, generateKeytabRequest, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new AdminOperationsApi();
            var userId = userId_example;  // String |  (default to null)
            var generateKeytabRequest = new GenerateKeytabRequest(); // GenerateKeytabRequest | 

            try {
                // Generates a keytab for the user with the given credentials.
                apiInstance.generateKeytab1(userId, generateKeytabRequest);
            } catch (Exception e) {
                Debug.Print("Exception when calling AdminOperationsApi.generateKeytab1: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AdminOperationsApi();
$userId = userId_example; // String | 
$generateKeytabRequest = ; // GenerateKeytabRequest | 

try {
    $api_instance->generateKeytab1($userId, $generateKeytabRequest);
} catch (Exception $e) {
    echo 'Exception when calling AdminOperationsApi->generateKeytab1: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AdminOperationsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AdminOperationsApi->new();
my $userId = userId_example; # String | 
my $generateKeytabRequest = WWW::OPenAPIClient::Object::GenerateKeytabRequest->new(); # GenerateKeytabRequest | 

eval {
    $api_instance->generateKeytab1(userId => $userId, generateKeytabRequest => $generateKeytabRequest);
};
if ($@) {
    warn "Exception when calling AdminOperationsApi->generateKeytab1: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.AdminOperationsApi()
userId = userId_example # String |  (default to null)
generateKeytabRequest =  # GenerateKeytabRequest | 

try:
    # Generates a keytab for the user with the given credentials.
    api_instance.generate_keytab1(userId, generateKeytabRequest)
except ApiException as e:
    print("Exception when calling AdminOperationsApi->generateKeytab1: %s\n" % e)
extern crate AdminOperationsApi;

pub fn main() {
    let userId = userId_example; // String
    let generateKeytabRequest = ; // GenerateKeytabRequest

    let mut context = AdminOperationsApi::Context::default();
    let result = client.generateKeytab1(userId, generateKeytabRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
userId*
String
Required
Body parameters
Name Description
generateKeytabRequest *

Responses


getDiagnostics


/api/v2/admin/diag

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/api/v2/admin/diag"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AdminOperationsApi;

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

public class AdminOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        AdminOperationsApi apiInstance = new AdminOperationsApi();

        try {
            CountersResponse result = apiInstance.getDiagnostics();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminOperationsApi#getDiagnostics");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();


try {
    final result = await api_instance.getDiagnostics();
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getDiagnostics: $e\n');
}

import org.openapitools.client.api.AdminOperationsApi;

public class AdminOperationsApiExample {
    public static void main(String[] args) {
        AdminOperationsApi apiInstance = new AdminOperationsApi();

        try {
            CountersResponse result = apiInstance.getDiagnostics();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminOperationsApi#getDiagnostics");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
AdminOperationsApi *apiInstance = [[AdminOperationsApi alloc] init];

[apiInstance getDiagnosticsWithCompletionHandler: 
              ^(CountersResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.AdminOperationsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDiagnostics(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new AdminOperationsApi();

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AdminOperationsApi();

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AdminOperationsApi->new();

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

# Create an instance of the API class
api_instance = openapi_client.AdminOperationsApi()

try:
    api_response = api_instance.get_diagnostics()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AdminOperationsApi->getDiagnostics: %s\n" % e)
extern crate AdminOperationsApi;

pub fn main() {

    let mut context = AdminOperationsApi::Context::default();
    let result = client.getDiagnostics(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


updateUserPassword1

Updates the password for the user.


/api/v2/admin/users/{userId}/password

Usage and SDK Samples

curl -X PATCH \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost/api/v2/admin/users/{userId}/password" \
 -d '{
  "new_password" : "new_password",
  "current_password" : "current_password"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AdminOperationsApi;

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

public class AdminOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        AdminOperationsApi apiInstance = new AdminOperationsApi();
        String userId = userId_example; // String | 
        UpdatePasswordRequest updatePasswordRequest = ; // UpdatePasswordRequest | 

        try {
            apiInstance.updateUserPassword1(userId, updatePasswordRequest);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminOperationsApi#updateUserPassword1");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String userId = new String(); // String | 
final UpdatePasswordRequest updatePasswordRequest = new UpdatePasswordRequest(); // UpdatePasswordRequest | 

try {
    final result = await api_instance.updateUserPassword1(userId, updatePasswordRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateUserPassword1: $e\n');
}

import org.openapitools.client.api.AdminOperationsApi;

public class AdminOperationsApiExample {
    public static void main(String[] args) {
        AdminOperationsApi apiInstance = new AdminOperationsApi();
        String userId = userId_example; // String | 
        UpdatePasswordRequest updatePasswordRequest = ; // UpdatePasswordRequest | 

        try {
            apiInstance.updateUserPassword1(userId, updatePasswordRequest);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminOperationsApi#updateUserPassword1");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
AdminOperationsApi *apiInstance = [[AdminOperationsApi alloc] init];
String *userId = userId_example; //  (default to null)
UpdatePasswordRequest *updatePasswordRequest = ; // 

// Updates the password for the user.
[apiInstance updateUserPassword1With:userId
    updatePasswordRequest:updatePasswordRequest
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.AdminOperationsApi()
var userId = userId_example; // {String} 
var updatePasswordRequest = ; // {UpdatePasswordRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.updateUserPassword1(userId, updatePasswordRequest, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new AdminOperationsApi();
            var userId = userId_example;  // String |  (default to null)
            var updatePasswordRequest = new UpdatePasswordRequest(); // UpdatePasswordRequest | 

            try {
                // Updates the password for the user.
                apiInstance.updateUserPassword1(userId, updatePasswordRequest);
            } catch (Exception e) {
                Debug.Print("Exception when calling AdminOperationsApi.updateUserPassword1: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AdminOperationsApi();
$userId = userId_example; // String | 
$updatePasswordRequest = ; // UpdatePasswordRequest | 

try {
    $api_instance->updateUserPassword1($userId, $updatePasswordRequest);
} catch (Exception $e) {
    echo 'Exception when calling AdminOperationsApi->updateUserPassword1: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AdminOperationsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AdminOperationsApi->new();
my $userId = userId_example; # String | 
my $updatePasswordRequest = WWW::OPenAPIClient::Object::UpdatePasswordRequest->new(); # UpdatePasswordRequest | 

eval {
    $api_instance->updateUserPassword1(userId => $userId, updatePasswordRequest => $updatePasswordRequest);
};
if ($@) {
    warn "Exception when calling AdminOperationsApi->updateUserPassword1: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.AdminOperationsApi()
userId = userId_example # String |  (default to null)
updatePasswordRequest =  # UpdatePasswordRequest | 

try:
    # Updates the password for the user.
    api_instance.update_user_password1(userId, updatePasswordRequest)
except ApiException as e:
    print("Exception when calling AdminOperationsApi->updateUserPassword1: %s\n" % e)
extern crate AdminOperationsApi;

pub fn main() {
    let userId = userId_example; // String
    let updatePasswordRequest = ; // UpdatePasswordRequest

    let mut context = AdminOperationsApi::Context::default();
    let result = client.updateUserPassword1(userId, updatePasswordRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
userId*
String
Required
Body parameters
Name Description
updatePasswordRequest *

Responses


uploadKeytab1

Uploads a keytab file for the user with the given credentials.


/api/v2/admin/users/{userId}/keytab/upload

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: multipart/form-data" \
 "http://localhost/api/v2/admin/users/{userId}/keytab/upload"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AdminOperationsApi;

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

public class AdminOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        AdminOperationsApi apiInstance = new AdminOperationsApi();
        String userId = userId_example; // String | 
        String principal = principal_example; // String | 
        File file = BINARY_DATA_HERE; // File | 

        try {
            apiInstance.uploadKeytab1(userId, principal, file);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminOperationsApi#uploadKeytab1");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String userId = new String(); // String | 
final String principal = new String(); // String | 
final File file = new File(); // File | 

try {
    final result = await api_instance.uploadKeytab1(userId, principal, file);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->uploadKeytab1: $e\n');
}

import org.openapitools.client.api.AdminOperationsApi;

public class AdminOperationsApiExample {
    public static void main(String[] args) {
        AdminOperationsApi apiInstance = new AdminOperationsApi();
        String userId = userId_example; // String | 
        String principal = principal_example; // String | 
        File file = BINARY_DATA_HERE; // File | 

        try {
            apiInstance.uploadKeytab1(userId, principal, file);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminOperationsApi#uploadKeytab1");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
AdminOperationsApi *apiInstance = [[AdminOperationsApi alloc] init];
String *userId = userId_example; //  (default to null)
String *principal = principal_example; //  (default to null)
File *file = BINARY_DATA_HERE; //  (default to null)

// Uploads a keytab file for the user with the given credentials.
[apiInstance uploadKeytab1With:userId
    principal:principal
    file:file
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.AdminOperationsApi()
var userId = userId_example; // {String} 
var principal = principal_example; // {String} 
var file = BINARY_DATA_HERE; // {File} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.uploadKeytab1(userId, principal, file, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new AdminOperationsApi();
            var userId = userId_example;  // String |  (default to null)
            var principal = principal_example;  // String |  (default to null)
            var file = BINARY_DATA_HERE;  // File |  (default to null)

            try {
                // Uploads a keytab file for the user with the given credentials.
                apiInstance.uploadKeytab1(userId, principal, file);
            } catch (Exception e) {
                Debug.Print("Exception when calling AdminOperationsApi.uploadKeytab1: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AdminOperationsApi();
$userId = userId_example; // String | 
$principal = principal_example; // String | 
$file = BINARY_DATA_HERE; // File | 

try {
    $api_instance->uploadKeytab1($userId, $principal, $file);
} catch (Exception $e) {
    echo 'Exception when calling AdminOperationsApi->uploadKeytab1: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AdminOperationsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AdminOperationsApi->new();
my $userId = userId_example; # String | 
my $principal = principal_example; # String | 
my $file = BINARY_DATA_HERE; # File | 

eval {
    $api_instance->uploadKeytab1(userId => $userId, principal => $principal, file => $file);
};
if ($@) {
    warn "Exception when calling AdminOperationsApi->uploadKeytab1: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.AdminOperationsApi()
userId = userId_example # String |  (default to null)
principal = principal_example # String |  (default to null)
file = BINARY_DATA_HERE # File |  (default to null)

try:
    # Uploads a keytab file for the user with the given credentials.
    api_instance.upload_keytab1(userId, principal, file)
except ApiException as e:
    print("Exception when calling AdminOperationsApi->uploadKeytab1: %s\n" % e)
extern crate AdminOperationsApi;

pub fn main() {
    let userId = userId_example; // String
    let principal = principal_example; // String
    let file = BINARY_DATA_HERE; // File

    let mut context = AdminOperationsApi::Context::default();
    let result = client.uploadKeytab1(userId, principal, file, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
userId*
String
Required
Form parameters
Name Description
principal*
String
Required
file*
File (binary)
Required

Responses


ArtifactOperations

deleteArtifactV2

Delete an artifact that is available to the user.


/api/v2/artifacts

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: application/json" \
 "http://localhost/api/v2/artifacts?name=name_example&scope=scope_example&projectId=projectId_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ArtifactOperationsApi;

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

public class ArtifactOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ArtifactOperationsApi apiInstance = new ArtifactOperationsApi();
        String name = name_example; // String | 
        String scope = scope_example; // String | 
        String projectId = projectId_example; // String | If scope is PROJECT, projectId has to be provided

        try {
            apiInstance.deleteArtifactV2(name, scope, projectId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ArtifactOperationsApi#deleteArtifactV2");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String name = new String(); // String | 
final String scope = new String(); // String | 
final String projectId = new String(); // String | If scope is PROJECT, projectId has to be provided

try {
    final result = await api_instance.deleteArtifactV2(name, scope, projectId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteArtifactV2: $e\n');
}

import org.openapitools.client.api.ArtifactOperationsApi;

public class ArtifactOperationsApiExample {
    public static void main(String[] args) {
        ArtifactOperationsApi apiInstance = new ArtifactOperationsApi();
        String name = name_example; // String | 
        String scope = scope_example; // String | 
        String projectId = projectId_example; // String | If scope is PROJECT, projectId has to be provided

        try {
            apiInstance.deleteArtifactV2(name, scope, projectId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ArtifactOperationsApi#deleteArtifactV2");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ArtifactOperationsApi *apiInstance = [[ArtifactOperationsApi alloc] init];
String *name = name_example; //  (default to null)
String *scope = scope_example; //  (optional) (default to USER)
String *projectId = projectId_example; // If scope is PROJECT, projectId has to be provided (optional) (default to null)

// Delete an artifact that is available to the user.
[apiInstance deleteArtifactV2With:name
    scope:scope
    projectId:projectId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.ArtifactOperationsApi()
var name = name_example; // {String} 
var opts = {
  'scope': scope_example, // {String} 
  'projectId': projectId_example // {String} If scope is PROJECT, projectId has to be provided
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteArtifactV2(name, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ArtifactOperationsApi();
            var name = name_example;  // String |  (default to null)
            var scope = scope_example;  // String |  (optional)  (default to USER)
            var projectId = projectId_example;  // String | If scope is PROJECT, projectId has to be provided (optional)  (default to null)

            try {
                // Delete an artifact that is available to the user.
                apiInstance.deleteArtifactV2(name, scope, projectId);
            } catch (Exception e) {
                Debug.Print("Exception when calling ArtifactOperationsApi.deleteArtifactV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ArtifactOperationsApi();
$name = name_example; // String | 
$scope = scope_example; // String | 
$projectId = projectId_example; // String | If scope is PROJECT, projectId has to be provided

try {
    $api_instance->deleteArtifactV2($name, $scope, $projectId);
} catch (Exception $e) {
    echo 'Exception when calling ArtifactOperationsApi->deleteArtifactV2: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ArtifactOperationsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ArtifactOperationsApi->new();
my $name = name_example; # String | 
my $scope = scope_example; # String | 
my $projectId = projectId_example; # String | If scope is PROJECT, projectId has to be provided

eval {
    $api_instance->deleteArtifactV2(name => $name, scope => $scope, projectId => $projectId);
};
if ($@) {
    warn "Exception when calling ArtifactOperationsApi->deleteArtifactV2: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ArtifactOperationsApi()
name = name_example # String |  (default to null)
scope = scope_example # String |  (optional) (default to USER)
projectId = projectId_example # String | If scope is PROJECT, projectId has to be provided (optional) (default to null)

try:
    # Delete an artifact that is available to the user.
    api_instance.delete_artifact_v2(name, scope=scope, projectId=projectId)
except ApiException as e:
    print("Exception when calling ArtifactOperationsApi->deleteArtifactV2: %s\n" % e)
extern crate ArtifactOperationsApi;

pub fn main() {
    let name = name_example; // String
    let scope = scope_example; // String
    let projectId = projectId_example; // String

    let mut context = ArtifactOperationsApi::Context::default();
    let result = client.deleteArtifactV2(name, scope, projectId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
name*
String
Required
scope
String
projectId
String
If scope is PROJECT, projectId has to be provided

Responses


getArtifactV2

Lists artifacts available to the user. They can be filtered by scope or name.


/api/v2/artifacts

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/api/v2/artifacts?name=name_example&scope=scope_example&projectId=projectId_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ArtifactOperationsApi;

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

public class ArtifactOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ArtifactOperationsApi apiInstance = new ArtifactOperationsApi();
        String name = name_example; // String | 
        String scope = scope_example; // String | 
        String projectId = projectId_example; // String | If scope is PROJECT, projectId has to be provided

        try {
            array[ArtifactDto] result = apiInstance.getArtifactV2(name, scope, projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ArtifactOperationsApi#getArtifactV2");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String name = new String(); // String | 
final String scope = new String(); // String | 
final String projectId = new String(); // String | If scope is PROJECT, projectId has to be provided

try {
    final result = await api_instance.getArtifactV2(name, scope, projectId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getArtifactV2: $e\n');
}

import org.openapitools.client.api.ArtifactOperationsApi;

public class ArtifactOperationsApiExample {
    public static void main(String[] args) {
        ArtifactOperationsApi apiInstance = new ArtifactOperationsApi();
        String name = name_example; // String | 
        String scope = scope_example; // String | 
        String projectId = projectId_example; // String | If scope is PROJECT, projectId has to be provided

        try {
            array[ArtifactDto] result = apiInstance.getArtifactV2(name, scope, projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ArtifactOperationsApi#getArtifactV2");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ArtifactOperationsApi *apiInstance = [[ArtifactOperationsApi alloc] init];
String *name = name_example; //  (optional) (default to null)
String *scope = scope_example; //  (optional) (default to USER)
String *projectId = projectId_example; // If scope is PROJECT, projectId has to be provided (optional) (default to null)

// Lists artifacts available to the user. They can be filtered by scope or name.
[apiInstance getArtifactV2With:name
    scope:scope
    projectId:projectId
              completionHandler: ^(array[ArtifactDto] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.ArtifactOperationsApi()
var opts = {
  'name': name_example, // {String} 
  'scope': scope_example, // {String} 
  'projectId': projectId_example // {String} If scope is PROJECT, projectId has to be provided
};

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

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

            // Create an instance of the API class
            var apiInstance = new ArtifactOperationsApi();
            var name = name_example;  // String |  (optional)  (default to null)
            var scope = scope_example;  // String |  (optional)  (default to USER)
            var projectId = projectId_example;  // String | If scope is PROJECT, projectId has to be provided (optional)  (default to null)

            try {
                // Lists artifacts available to the user. They can be filtered by scope or name.
                array[ArtifactDto] result = apiInstance.getArtifactV2(name, scope, projectId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ArtifactOperationsApi.getArtifactV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ArtifactOperationsApi();
$name = name_example; // String | 
$scope = scope_example; // String | 
$projectId = projectId_example; // String | If scope is PROJECT, projectId has to be provided

try {
    $result = $api_instance->getArtifactV2($name, $scope, $projectId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ArtifactOperationsApi->getArtifactV2: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ArtifactOperationsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ArtifactOperationsApi->new();
my $name = name_example; # String | 
my $scope = scope_example; # String | 
my $projectId = projectId_example; # String | If scope is PROJECT, projectId has to be provided

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

# Create an instance of the API class
api_instance = openapi_client.ArtifactOperationsApi()
name = name_example # String |  (optional) (default to null)
scope = scope_example # String |  (optional) (default to USER)
projectId = projectId_example # String | If scope is PROJECT, projectId has to be provided (optional) (default to null)

try:
    # Lists artifacts available to the user. They can be filtered by scope or name.
    api_response = api_instance.get_artifact_v2(name=name, scope=scope, projectId=projectId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ArtifactOperationsApi->getArtifactV2: %s\n" % e)
extern crate ArtifactOperationsApi;

pub fn main() {
    let name = name_example; // String
    let scope = scope_example; // String
    let projectId = projectId_example; // String

    let mut context = ArtifactOperationsApi::Context::default();
    let result = client.getArtifactV2(name, scope, projectId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
name
String
scope
String
projectId
String
If scope is PROJECT, projectId has to be provided

Responses


uploadArtifactV2

Upload an artifact file.


/api/v2/artifacts

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: multipart/form-data" \
 "http://localhost/api/v2/artifacts?name=name_example&scope=scope_example&projectId=projectId_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ArtifactOperationsApi;

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

public class ArtifactOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ArtifactOperationsApi apiInstance = new ArtifactOperationsApi();
        File file = BINARY_DATA_HERE; // File | 
        String name = name_example; // String | 
        String scope = scope_example; // String | 
        String projectId = projectId_example; // String | If scope is PROJECT, projectId has to be provided

        try {
            ArtifactDto result = apiInstance.uploadArtifactV2(file, name, scope, projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ArtifactOperationsApi#uploadArtifactV2");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final File file = new File(); // File | 
final String name = new String(); // String | 
final String scope = new String(); // String | 
final String projectId = new String(); // String | If scope is PROJECT, projectId has to be provided

try {
    final result = await api_instance.uploadArtifactV2(file, name, scope, projectId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->uploadArtifactV2: $e\n');
}

import org.openapitools.client.api.ArtifactOperationsApi;

public class ArtifactOperationsApiExample {
    public static void main(String[] args) {
        ArtifactOperationsApi apiInstance = new ArtifactOperationsApi();
        File file = BINARY_DATA_HERE; // File | 
        String name = name_example; // String | 
        String scope = scope_example; // String | 
        String projectId = projectId_example; // String | If scope is PROJECT, projectId has to be provided

        try {
            ArtifactDto result = apiInstance.uploadArtifactV2(file, name, scope, projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ArtifactOperationsApi#uploadArtifactV2");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ArtifactOperationsApi *apiInstance = [[ArtifactOperationsApi alloc] init];
File *file = BINARY_DATA_HERE; //  (default to null)
String *name = name_example; //  (optional) (default to null)
String *scope = scope_example; //  (optional) (default to USER)
String *projectId = projectId_example; // If scope is PROJECT, projectId has to be provided (optional) (default to null)

// Upload an artifact file.
[apiInstance uploadArtifactV2With:file
    name:name
    scope:scope
    projectId:projectId
              completionHandler: ^(ArtifactDto output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.ArtifactOperationsApi()
var file = BINARY_DATA_HERE; // {File} 
var opts = {
  'name': name_example, // {String} 
  'scope': scope_example, // {String} 
  'projectId': projectId_example // {String} If scope is PROJECT, projectId has to be provided
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.uploadArtifactV2(file, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ArtifactOperationsApi();
            var file = BINARY_DATA_HERE;  // File |  (default to null)
            var name = name_example;  // String |  (optional)  (default to null)
            var scope = scope_example;  // String |  (optional)  (default to USER)
            var projectId = projectId_example;  // String | If scope is PROJECT, projectId has to be provided (optional)  (default to null)

            try {
                // Upload an artifact file.
                ArtifactDto result = apiInstance.uploadArtifactV2(file, name, scope, projectId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ArtifactOperationsApi.uploadArtifactV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ArtifactOperationsApi();
$file = BINARY_DATA_HERE; // File | 
$name = name_example; // String | 
$scope = scope_example; // String | 
$projectId = projectId_example; // String | If scope is PROJECT, projectId has to be provided

try {
    $result = $api_instance->uploadArtifactV2($file, $name, $scope, $projectId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ArtifactOperationsApi->uploadArtifactV2: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ArtifactOperationsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ArtifactOperationsApi->new();
my $file = BINARY_DATA_HERE; # File | 
my $name = name_example; # String | 
my $scope = scope_example; # String | 
my $projectId = projectId_example; # String | If scope is PROJECT, projectId has to be provided

eval {
    my $result = $api_instance->uploadArtifactV2(file => $file, name => $name, scope => $scope, projectId => $projectId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ArtifactOperationsApi->uploadArtifactV2: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ArtifactOperationsApi()
file = BINARY_DATA_HERE # File |  (default to null)
name = name_example # String |  (optional) (default to null)
scope = scope_example # String |  (optional) (default to USER)
projectId = projectId_example # String | If scope is PROJECT, projectId has to be provided (optional) (default to null)

try:
    # Upload an artifact file.
    api_response = api_instance.upload_artifact_v2(file, name=name, scope=scope, projectId=projectId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ArtifactOperationsApi->uploadArtifactV2: %s\n" % e)
extern crate ArtifactOperationsApi;

pub fn main() {
    let file = BINARY_DATA_HERE; // File
    let name = name_example; // String
    let scope = scope_example; // String
    let projectId = projectId_example; // String

    let mut context = ArtifactOperationsApi::Context::default();
    let result = client.uploadArtifactV2(file, name, scope, projectId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Form parameters
Name Description
file*
File (binary)
Required
Query parameters
Name Description
name
String
scope
String
projectId
String
If scope is PROJECT, projectId has to be provided

Responses


ConnectorOperations

createConnector

Creates a Connector.


/api/v2/ddl/connectors

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: multipart/form-data" \
 "http://localhost/api/v2/ddl/connectors"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ConnectorOperationsApi;

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

public class ConnectorOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ConnectorOperationsApi apiInstance = new ConnectorOperationsApi();
        ConnectorDto data = ; // ConnectorDto | 
        File file = BINARY_DATA_HERE; // File | 

        try {
            ConnectorDto result = apiInstance.createConnector(data, file);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConnectorOperationsApi#createConnector");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final ConnectorDto data = new ConnectorDto(); // ConnectorDto | 
final File file = new File(); // File | 

try {
    final result = await api_instance.createConnector(data, file);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->createConnector: $e\n');
}

import org.openapitools.client.api.ConnectorOperationsApi;

public class ConnectorOperationsApiExample {
    public static void main(String[] args) {
        ConnectorOperationsApi apiInstance = new ConnectorOperationsApi();
        ConnectorDto data = ; // ConnectorDto | 
        File file = BINARY_DATA_HERE; // File | 

        try {
            ConnectorDto result = apiInstance.createConnector(data, file);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConnectorOperationsApi#createConnector");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ConnectorOperationsApi *apiInstance = [[ConnectorOperationsApi alloc] init];
ConnectorDto *data = ; //  (default to null)
File *file = BINARY_DATA_HERE; //  (optional) (default to null)

// Creates a Connector.
[apiInstance createConnectorWith:data
    file:file
              completionHandler: ^(ConnectorDto output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.ConnectorOperationsApi()
var data = ; // {ConnectorDto} 
var opts = {
  'file': BINARY_DATA_HERE // {File} 
};

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

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

            // Create an instance of the API class
            var apiInstance = new ConnectorOperationsApi();
            var data = new ConnectorDto(); // ConnectorDto |  (default to null)
            var file = BINARY_DATA_HERE;  // File |  (optional)  (default to null)

            try {
                // Creates a Connector.
                ConnectorDto result = apiInstance.createConnector(data, file);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ConnectorOperationsApi.createConnector: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ConnectorOperationsApi();
$data = ; // ConnectorDto | 
$file = BINARY_DATA_HERE; // File | 

try {
    $result = $api_instance->createConnector($data, $file);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConnectorOperationsApi->createConnector: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ConnectorOperationsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ConnectorOperationsApi->new();
my $data = ; # ConnectorDto | 
my $file = BINARY_DATA_HERE; # File | 

eval {
    my $result = $api_instance->createConnector(data => $data, file => $file);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ConnectorOperationsApi->createConnector: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ConnectorOperationsApi()
data =  # ConnectorDto |  (default to null)
file = BINARY_DATA_HERE # File |  (optional) (default to null)

try:
    # Creates a Connector.
    api_response = api_instance.create_connector(data, file=file)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConnectorOperationsApi->createConnector: %s\n" % e)
extern crate ConnectorOperationsApi;

pub fn main() {
    let data = ; // ConnectorDto
    let file = BINARY_DATA_HERE; // File

    let mut context = ConnectorOperationsApi::Context::default();
    let result = client.createConnector(data, file, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Form parameters
Name Description
data*
ConnectorDto
Required
file
File (binary)

Responses


deleteConnectorById

Deletes a Connector by ID.


/api/v2/ddl/connectors/{id}

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: application/json" \
 "http://localhost/api/v2/ddl/connectors/{id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ConnectorOperationsApi;

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

public class ConnectorOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ConnectorOperationsApi apiInstance = new ConnectorOperationsApi();
        Integer id = 56; // Integer | 

        try {
            apiInstance.deleteConnectorById(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConnectorOperationsApi#deleteConnectorById");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 

try {
    final result = await api_instance.deleteConnectorById(id);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteConnectorById: $e\n');
}

import org.openapitools.client.api.ConnectorOperationsApi;

public class ConnectorOperationsApiExample {
    public static void main(String[] args) {
        ConnectorOperationsApi apiInstance = new ConnectorOperationsApi();
        Integer id = 56; // Integer | 

        try {
            apiInstance.deleteConnectorById(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConnectorOperationsApi#deleteConnectorById");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ConnectorOperationsApi *apiInstance = [[ConnectorOperationsApi alloc] init];
Integer *id = 56; //  (default to null)

// Deletes a Connector by ID.
[apiInstance deleteConnectorByIdWith:id
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.ConnectorOperationsApi()
var id = 56; // {Integer} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteConnectorById(id, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ConnectorOperationsApi();
            var id = 56;  // Integer |  (default to null)

            try {
                // Deletes a Connector by ID.
                apiInstance.deleteConnectorById(id);
            } catch (Exception e) {
                Debug.Print("Exception when calling ConnectorOperationsApi.deleteConnectorById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ConnectorOperationsApi();
$id = 56; // Integer | 

try {
    $api_instance->deleteConnectorById($id);
} catch (Exception $e) {
    echo 'Exception when calling ConnectorOperationsApi->deleteConnectorById: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ConnectorOperationsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ConnectorOperationsApi->new();
my $id = 56; # Integer | 

eval {
    $api_instance->deleteConnectorById(id => $id);
};
if ($@) {
    warn "Exception when calling ConnectorOperationsApi->deleteConnectorById: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ConnectorOperationsApi()
id = 56 # Integer |  (default to null)

try:
    # Deletes a Connector by ID.
    api_instance.delete_connector_by_id(id)
except ApiException as e:
    print("Exception when calling ConnectorOperationsApi->deleteConnectorById: %s\n" % e)
extern crate ConnectorOperationsApi;

pub fn main() {
    let id = 56; // Integer

    let mut context = ConnectorOperationsApi::Context::default();
    let result = client.deleteConnectorById(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required

Responses


deleteConnectorByType

Deletes a Connector by type.


/api/v2/ddl/connectors/type/{type}

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: application/json" \
 "http://localhost/api/v2/ddl/connectors/type/{type}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ConnectorOperationsApi;

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

public class ConnectorOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ConnectorOperationsApi apiInstance = new ConnectorOperationsApi();
        String type = type_example; // String | 

        try {
            apiInstance.deleteConnectorByType(type);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConnectorOperationsApi#deleteConnectorByType");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String type = new String(); // String | 

try {
    final result = await api_instance.deleteConnectorByType(type);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteConnectorByType: $e\n');
}

import org.openapitools.client.api.ConnectorOperationsApi;

public class ConnectorOperationsApiExample {
    public static void main(String[] args) {
        ConnectorOperationsApi apiInstance = new ConnectorOperationsApi();
        String type = type_example; // String | 

        try {
            apiInstance.deleteConnectorByType(type);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConnectorOperationsApi#deleteConnectorByType");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ConnectorOperationsApi *apiInstance = [[ConnectorOperationsApi alloc] init];
String *type = type_example; //  (default to null)

// Deletes a Connector by type.
[apiInstance deleteConnectorByTypeWith:type
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.ConnectorOperationsApi()
var type = type_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteConnectorByType(type, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ConnectorOperationsApi();
            var type = type_example;  // String |  (default to null)

            try {
                // Deletes a Connector by type.
                apiInstance.deleteConnectorByType(type);
            } catch (Exception e) {
                Debug.Print("Exception when calling ConnectorOperationsApi.deleteConnectorByType: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ConnectorOperationsApi();
$type = type_example; // String | 

try {
    $api_instance->deleteConnectorByType($type);
} catch (Exception $e) {
    echo 'Exception when calling ConnectorOperationsApi->deleteConnectorByType: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ConnectorOperationsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ConnectorOperationsApi->new();
my $type = type_example; # String | 

eval {
    $api_instance->deleteConnectorByType(type => $type);
};
if ($@) {
    warn "Exception when calling ConnectorOperationsApi->deleteConnectorByType: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ConnectorOperationsApi()
type = type_example # String |  (default to null)

try:
    # Deletes a Connector by type.
    api_instance.delete_connector_by_type(type)
except ApiException as e:
    print("Exception when calling ConnectorOperationsApi->deleteConnectorByType: %s\n" % e)
extern crate ConnectorOperationsApi;

pub fn main() {
    let type = type_example; // String

    let mut context = ConnectorOperationsApi::Context::default();
    let result = client.deleteConnectorByType(type, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
type*
String
Required

Responses


getConnectorById

Retrieves a Connector by ID.


/api/v2/ddl/connectors/{id}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/api/v2/ddl/connectors/{id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ConnectorOperationsApi;

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

public class ConnectorOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ConnectorOperationsApi apiInstance = new ConnectorOperationsApi();
        Integer id = 56; // Integer | 

        try {
            ConnectorDto result = apiInstance.getConnectorById(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConnectorOperationsApi#getConnectorById");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 

try {
    final result = await api_instance.getConnectorById(id);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getConnectorById: $e\n');
}

import org.openapitools.client.api.ConnectorOperationsApi;

public class ConnectorOperationsApiExample {
    public static void main(String[] args) {
        ConnectorOperationsApi apiInstance = new ConnectorOperationsApi();
        Integer id = 56; // Integer | 

        try {
            ConnectorDto result = apiInstance.getConnectorById(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConnectorOperationsApi#getConnectorById");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ConnectorOperationsApi *apiInstance = [[ConnectorOperationsApi alloc] init];
Integer *id = 56; //  (default to null)

// Retrieves a Connector by ID.
[apiInstance getConnectorByIdWith:id
              completionHandler: ^(ConnectorDto output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.ConnectorOperationsApi()
var id = 56; // {Integer} 

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

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

            // Create an instance of the API class
            var apiInstance = new ConnectorOperationsApi();
            var id = 56;  // Integer |  (default to null)

            try {
                // Retrieves a Connector by ID.
                ConnectorDto result = apiInstance.getConnectorById(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ConnectorOperationsApi.getConnectorById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ConnectorOperationsApi();
$id = 56; // Integer | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ConnectorOperationsApi->new();
my $id = 56; # Integer | 

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

# Create an instance of the API class
api_instance = openapi_client.ConnectorOperationsApi()
id = 56 # Integer |  (default to null)

try:
    # Retrieves a Connector by ID.
    api_response = api_instance.get_connector_by_id(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConnectorOperationsApi->getConnectorById: %s\n" % e)
extern crate ConnectorOperationsApi;

pub fn main() {
    let id = 56; // Integer

    let mut context = ConnectorOperationsApi::Context::default();
    let result = client.getConnectorById(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required

Responses


getConnectorByType

Retrieves a Connector by type.


/api/v2/ddl/connectors/type/{type}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/api/v2/ddl/connectors/type/{type}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ConnectorOperationsApi;

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

public class ConnectorOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ConnectorOperationsApi apiInstance = new ConnectorOperationsApi();
        String type = type_example; // String | 

        try {
            ConnectorDto result = apiInstance.getConnectorByType(type);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConnectorOperationsApi#getConnectorByType");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String type = new String(); // String | 

try {
    final result = await api_instance.getConnectorByType(type);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getConnectorByType: $e\n');
}

import org.openapitools.client.api.ConnectorOperationsApi;

public class ConnectorOperationsApiExample {
    public static void main(String[] args) {
        ConnectorOperationsApi apiInstance = new ConnectorOperationsApi();
        String type = type_example; // String | 

        try {
            ConnectorDto result = apiInstance.getConnectorByType(type);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConnectorOperationsApi#getConnectorByType");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ConnectorOperationsApi *apiInstance = [[ConnectorOperationsApi alloc] init];
String *type = type_example; //  (default to null)

// Retrieves a Connector by type.
[apiInstance getConnectorByTypeWith:type
              completionHandler: ^(ConnectorDto output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.ConnectorOperationsApi()
var type = type_example; // {String} 

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

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

            // Create an instance of the API class
            var apiInstance = new ConnectorOperationsApi();
            var type = type_example;  // String |  (default to null)

            try {
                // Retrieves a Connector by type.
                ConnectorDto result = apiInstance.getConnectorByType(type);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ConnectorOperationsApi.getConnectorByType: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ConnectorOperationsApi();
$type = type_example; // String | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ConnectorOperationsApi->new();
my $type = type_example; # String | 

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

# Create an instance of the API class
api_instance = openapi_client.ConnectorOperationsApi()
type = type_example # String |  (default to null)

try:
    # Retrieves a Connector by type.
    api_response = api_instance.get_connector_by_type(type)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConnectorOperationsApi->getConnectorByType: %s\n" % e)
extern crate ConnectorOperationsApi;

pub fn main() {
    let type = type_example; // String

    let mut context = ConnectorOperationsApi::Context::default();
    let result = client.getConnectorByType(type, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
type*
String
Required

Responses


getConnectorJarFile

Retrieves a Connector JAR file. Connector type must be specified.


/api/v2/ddl/connectors/jar/{type}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/api/v2/ddl/connectors/jar/{type}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ConnectorOperationsApi;

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

public class ConnectorOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ConnectorOperationsApi apiInstance = new ConnectorOperationsApi();
        String type = type_example; // String | 

        try {
            apiInstance.getConnectorJarFile(type);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConnectorOperationsApi#getConnectorJarFile");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String type = new String(); // String | 

try {
    final result = await api_instance.getConnectorJarFile(type);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getConnectorJarFile: $e\n');
}

import org.openapitools.client.api.ConnectorOperationsApi;

public class ConnectorOperationsApiExample {
    public static void main(String[] args) {
        ConnectorOperationsApi apiInstance = new ConnectorOperationsApi();
        String type = type_example; // String | 

        try {
            apiInstance.getConnectorJarFile(type);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConnectorOperationsApi#getConnectorJarFile");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ConnectorOperationsApi *apiInstance = [[ConnectorOperationsApi alloc] init];
String *type = type_example; //  (default to null)

// Retrieves a Connector JAR file. Connector type must be specified.
[apiInstance getConnectorJarFileWith:type
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.ConnectorOperationsApi()
var type = type_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getConnectorJarFile(type, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ConnectorOperationsApi();
            var type = type_example;  // String |  (default to null)

            try {
                // Retrieves a Connector JAR file. Connector type must be specified.
                apiInstance.getConnectorJarFile(type);
            } catch (Exception e) {
                Debug.Print("Exception when calling ConnectorOperationsApi.getConnectorJarFile: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ConnectorOperationsApi();
$type = type_example; // String | 

try {
    $api_instance->getConnectorJarFile($type);
} catch (Exception $e) {
    echo 'Exception when calling ConnectorOperationsApi->getConnectorJarFile: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ConnectorOperationsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ConnectorOperationsApi->new();
my $type = type_example; # String | 

eval {
    $api_instance->getConnectorJarFile(type => $type);
};
if ($@) {
    warn "Exception when calling ConnectorOperationsApi->getConnectorJarFile: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ConnectorOperationsApi()
type = type_example # String |  (default to null)

try:
    # Retrieves a Connector JAR file. Connector type must be specified.
    api_instance.get_connector_jar_file(type)
except ApiException as e:
    print("Exception when calling ConnectorOperationsApi->getConnectorJarFile: %s\n" % e)
extern crate ConnectorOperationsApi;

pub fn main() {
    let type = type_example; // String

    let mut context = ConnectorOperationsApi::Context::default();
    let result = client.getConnectorJarFile(type, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
type*
String
Required

Responses


getConnectors

Retrieves all connectors.


/api/v2/ddl/connectors

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/api/v2/ddl/connectors"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ConnectorOperationsApi;

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

public class ConnectorOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ConnectorOperationsApi apiInstance = new ConnectorOperationsApi();

        try {
            array[ConnectorDto] result = apiInstance.getConnectors();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConnectorOperationsApi#getConnectors");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();


try {
    final result = await api_instance.getConnectors();
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getConnectors: $e\n');
}

import org.openapitools.client.api.ConnectorOperationsApi;

public class ConnectorOperationsApiExample {
    public static void main(String[] args) {
        ConnectorOperationsApi apiInstance = new ConnectorOperationsApi();

        try {
            array[ConnectorDto] result = apiInstance.getConnectors();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConnectorOperationsApi#getConnectors");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ConnectorOperationsApi *apiInstance = [[ConnectorOperationsApi alloc] init];

// Retrieves all connectors.
[apiInstance getConnectorsWithCompletionHandler: 
              ^(array[ConnectorDto] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.ConnectorOperationsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getConnectors(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ConnectorOperationsApi();

            try {
                // Retrieves all connectors.
                array[ConnectorDto] result = apiInstance.getConnectors();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ConnectorOperationsApi.getConnectors: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ConnectorOperationsApi();

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ConnectorOperationsApi->new();

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

# Create an instance of the API class
api_instance = openapi_client.ConnectorOperationsApi()

try:
    # Retrieves all connectors.
    api_response = api_instance.get_connectors()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConnectorOperationsApi->getConnectors: %s\n" % e)
extern crate ConnectorOperationsApi;

pub fn main() {

    let mut context = ConnectorOperationsApi::Context::default();
    let result = client.getConnectors(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


DDLTemplates

createTable


/internal/ddl/create-table

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost/internal/ddl/create-table" \
 -d '{
  "format_type" : "format_type",
  "connector_type" : "connector_type",
  "sql" : "sql"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DDLTemplatesApi;

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

public class DDLTemplatesApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        DDLTemplatesApi apiInstance = new DDLTemplatesApi();
        GenerateCreateTableRequest generateCreateTableRequest = ; // GenerateCreateTableRequest | 

        try {
            GenerateCreateTableResponse result = apiInstance.createTable(generateCreateTableRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DDLTemplatesApi#createTable");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final GenerateCreateTableRequest generateCreateTableRequest = new GenerateCreateTableRequest(); // GenerateCreateTableRequest | 

try {
    final result = await api_instance.createTable(generateCreateTableRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->createTable: $e\n');
}

import org.openapitools.client.api.DDLTemplatesApi;

public class DDLTemplatesApiExample {
    public static void main(String[] args) {
        DDLTemplatesApi apiInstance = new DDLTemplatesApi();
        GenerateCreateTableRequest generateCreateTableRequest = ; // GenerateCreateTableRequest | 

        try {
            GenerateCreateTableResponse result = apiInstance.createTable(generateCreateTableRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DDLTemplatesApi#createTable");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DDLTemplatesApi *apiInstance = [[DDLTemplatesApi alloc] init];
GenerateCreateTableRequest *generateCreateTableRequest = ; // 

[apiInstance createTableWith:generateCreateTableRequest
              completionHandler: ^(GenerateCreateTableResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.DDLTemplatesApi()
var generateCreateTableRequest = ; // {GenerateCreateTableRequest} 

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

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

            // Create an instance of the API class
            var apiInstance = new DDLTemplatesApi();
            var generateCreateTableRequest = new GenerateCreateTableRequest(); // GenerateCreateTableRequest | 

            try {
                GenerateCreateTableResponse result = apiInstance.createTable(generateCreateTableRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DDLTemplatesApi.createTable: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DDLTemplatesApi();
$generateCreateTableRequest = ; // GenerateCreateTableRequest | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DDLTemplatesApi->new();
my $generateCreateTableRequest = WWW::OPenAPIClient::Object::GenerateCreateTableRequest->new(); # GenerateCreateTableRequest | 

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

# Create an instance of the API class
api_instance = openapi_client.DDLTemplatesApi()
generateCreateTableRequest =  # GenerateCreateTableRequest | 

try:
    api_response = api_instance.create_table(generateCreateTableRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DDLTemplatesApi->createTable: %s\n" % e)
extern crate DDLTemplatesApi;

pub fn main() {
    let generateCreateTableRequest = ; // GenerateCreateTableRequest

    let mut context = DDLTemplatesApi::Context::default();
    let result = client.createTable(generateCreateTableRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
generateCreateTableRequest *

Responses


DataFormatOperations

createDataFormat

Creates a Data Format.


/api/v2/ddl/data-formats

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: multipart/form-data" \
 "http://localhost/api/v2/ddl/data-formats"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DataFormatOperationsApi;

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

public class DataFormatOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        DataFormatOperationsApi apiInstance = new DataFormatOperationsApi();
        DataFormatDto data = ; // DataFormatDto | 
        File file = BINARY_DATA_HERE; // File | 

        try {
            DataFormatDto result = apiInstance.createDataFormat(data, file);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataFormatOperationsApi#createDataFormat");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final DataFormatDto data = new DataFormatDto(); // DataFormatDto | 
final File file = new File(); // File | 

try {
    final result = await api_instance.createDataFormat(data, file);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->createDataFormat: $e\n');
}

import org.openapitools.client.api.DataFormatOperationsApi;

public class DataFormatOperationsApiExample {
    public static void main(String[] args) {
        DataFormatOperationsApi apiInstance = new DataFormatOperationsApi();
        DataFormatDto data = ; // DataFormatDto | 
        File file = BINARY_DATA_HERE; // File | 

        try {
            DataFormatDto result = apiInstance.createDataFormat(data, file);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataFormatOperationsApi#createDataFormat");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DataFormatOperationsApi *apiInstance = [[DataFormatOperationsApi alloc] init];
DataFormatDto *data = ; //  (default to null)
File *file = BINARY_DATA_HERE; //  (optional) (default to null)

// Creates a Data Format.
[apiInstance createDataFormatWith:data
    file:file
              completionHandler: ^(DataFormatDto output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.DataFormatOperationsApi()
var data = ; // {DataFormatDto} 
var opts = {
  'file': BINARY_DATA_HERE // {File} 
};

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

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

            // Create an instance of the API class
            var apiInstance = new DataFormatOperationsApi();
            var data = new DataFormatDto(); // DataFormatDto |  (default to null)
            var file = BINARY_DATA_HERE;  // File |  (optional)  (default to null)

            try {
                // Creates a Data Format.
                DataFormatDto result = apiInstance.createDataFormat(data, file);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DataFormatOperationsApi.createDataFormat: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DataFormatOperationsApi();
$data = ; // DataFormatDto | 
$file = BINARY_DATA_HERE; // File | 

try {
    $result = $api_instance->createDataFormat($data, $file);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataFormatOperationsApi->createDataFormat: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DataFormatOperationsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DataFormatOperationsApi->new();
my $data = ; # DataFormatDto | 
my $file = BINARY_DATA_HERE; # File | 

eval {
    my $result = $api_instance->createDataFormat(data => $data, file => $file);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DataFormatOperationsApi->createDataFormat: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.DataFormatOperationsApi()
data =  # DataFormatDto |  (default to null)
file = BINARY_DATA_HERE # File |  (optional) (default to null)

try:
    # Creates a Data Format.
    api_response = api_instance.create_data_format(data, file=file)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataFormatOperationsApi->createDataFormat: %s\n" % e)
extern crate DataFormatOperationsApi;

pub fn main() {
    let data = ; // DataFormatDto
    let file = BINARY_DATA_HERE; // File

    let mut context = DataFormatOperationsApi::Context::default();
    let result = client.createDataFormat(data, file, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Form parameters
Name Description
data*
DataFormatDto
Required
file
File (binary)

Responses


deleteDataFormatById

Deletes a Data Format by ID.


/api/v2/ddl/data-formats/{id}

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: application/json" \
 "http://localhost/api/v2/ddl/data-formats/{id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DataFormatOperationsApi;

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

public class DataFormatOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        DataFormatOperationsApi apiInstance = new DataFormatOperationsApi();
        Integer id = 56; // Integer | 

        try {
            apiInstance.deleteDataFormatById(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataFormatOperationsApi#deleteDataFormatById");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 

try {
    final result = await api_instance.deleteDataFormatById(id);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteDataFormatById: $e\n');
}

import org.openapitools.client.api.DataFormatOperationsApi;

public class DataFormatOperationsApiExample {
    public static void main(String[] args) {
        DataFormatOperationsApi apiInstance = new DataFormatOperationsApi();
        Integer id = 56; // Integer | 

        try {
            apiInstance.deleteDataFormatById(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataFormatOperationsApi#deleteDataFormatById");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DataFormatOperationsApi *apiInstance = [[DataFormatOperationsApi alloc] init];
Integer *id = 56; //  (default to null)

// Deletes a Data Format by ID.
[apiInstance deleteDataFormatByIdWith:id
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.DataFormatOperationsApi()
var id = 56; // {Integer} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteDataFormatById(id, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new DataFormatOperationsApi();
            var id = 56;  // Integer |  (default to null)

            try {
                // Deletes a Data Format by ID.
                apiInstance.deleteDataFormatById(id);
            } catch (Exception e) {
                Debug.Print("Exception when calling DataFormatOperationsApi.deleteDataFormatById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DataFormatOperationsApi();
$id = 56; // Integer | 

try {
    $api_instance->deleteDataFormatById($id);
} catch (Exception $e) {
    echo 'Exception when calling DataFormatOperationsApi->deleteDataFormatById: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DataFormatOperationsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DataFormatOperationsApi->new();
my $id = 56; # Integer | 

eval {
    $api_instance->deleteDataFormatById(id => $id);
};
if ($@) {
    warn "Exception when calling DataFormatOperationsApi->deleteDataFormatById: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.DataFormatOperationsApi()
id = 56 # Integer |  (default to null)

try:
    # Deletes a Data Format by ID.
    api_instance.delete_data_format_by_id(id)
except ApiException as e:
    print("Exception when calling DataFormatOperationsApi->deleteDataFormatById: %s\n" % e)
extern crate DataFormatOperationsApi;

pub fn main() {
    let id = 56; // Integer

    let mut context = DataFormatOperationsApi::Context::default();
    let result = client.deleteDataFormatById(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required

Responses


deleteDataFormatByType

Deletes a Data Format by type.


/api/v2/ddl/data-formats/type/{type}

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: application/json" \
 "http://localhost/api/v2/ddl/data-formats/type/{type}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DataFormatOperationsApi;

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

public class DataFormatOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        DataFormatOperationsApi apiInstance = new DataFormatOperationsApi();
        String type = type_example; // String | 

        try {
            apiInstance.deleteDataFormatByType(type);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataFormatOperationsApi#deleteDataFormatByType");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String type = new String(); // String | 

try {
    final result = await api_instance.deleteDataFormatByType(type);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteDataFormatByType: $e\n');
}

import org.openapitools.client.api.DataFormatOperationsApi;

public class DataFormatOperationsApiExample {
    public static void main(String[] args) {
        DataFormatOperationsApi apiInstance = new DataFormatOperationsApi();
        String type = type_example; // String | 

        try {
            apiInstance.deleteDataFormatByType(type);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataFormatOperationsApi#deleteDataFormatByType");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DataFormatOperationsApi *apiInstance = [[DataFormatOperationsApi alloc] init];
String *type = type_example; //  (default to null)

// Deletes a Data Format by type.
[apiInstance deleteDataFormatByTypeWith:type
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.DataFormatOperationsApi()
var type = type_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteDataFormatByType(type, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new DataFormatOperationsApi();
            var type = type_example;  // String |  (default to null)

            try {
                // Deletes a Data Format by type.
                apiInstance.deleteDataFormatByType(type);
            } catch (Exception e) {
                Debug.Print("Exception when calling DataFormatOperationsApi.deleteDataFormatByType: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DataFormatOperationsApi();
$type = type_example; // String | 

try {
    $api_instance->deleteDataFormatByType($type);
} catch (Exception $e) {
    echo 'Exception when calling DataFormatOperationsApi->deleteDataFormatByType: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DataFormatOperationsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DataFormatOperationsApi->new();
my $type = type_example; # String | 

eval {
    $api_instance->deleteDataFormatByType(type => $type);
};
if ($@) {
    warn "Exception when calling DataFormatOperationsApi->deleteDataFormatByType: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.DataFormatOperationsApi()
type = type_example # String |  (default to null)

try:
    # Deletes a Data Format by type.
    api_instance.delete_data_format_by_type(type)
except ApiException as e:
    print("Exception when calling DataFormatOperationsApi->deleteDataFormatByType: %s\n" % e)
extern crate DataFormatOperationsApi;

pub fn main() {
    let type = type_example; // String

    let mut context = DataFormatOperationsApi::Context::default();
    let result = client.deleteDataFormatByType(type, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
type*
String
Required

Responses


getDataFormatById

Retrieves a Data Format by ID.


/api/v2/ddl/data-formats/{id}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/api/v2/ddl/data-formats/{id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DataFormatOperationsApi;

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

public class DataFormatOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        DataFormatOperationsApi apiInstance = new DataFormatOperationsApi();
        Integer id = 56; // Integer | 

        try {
            DataFormatDto result = apiInstance.getDataFormatById(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataFormatOperationsApi#getDataFormatById");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 

try {
    final result = await api_instance.getDataFormatById(id);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getDataFormatById: $e\n');
}

import org.openapitools.client.api.DataFormatOperationsApi;

public class DataFormatOperationsApiExample {
    public static void main(String[] args) {
        DataFormatOperationsApi apiInstance = new DataFormatOperationsApi();
        Integer id = 56; // Integer | 

        try {
            DataFormatDto result = apiInstance.getDataFormatById(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataFormatOperationsApi#getDataFormatById");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DataFormatOperationsApi *apiInstance = [[DataFormatOperationsApi alloc] init];
Integer *id = 56; //  (default to null)

// Retrieves a Data Format by ID.
[apiInstance getDataFormatByIdWith:id
              completionHandler: ^(DataFormatDto output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.DataFormatOperationsApi()
var id = 56; // {Integer} 

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

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

            // Create an instance of the API class
            var apiInstance = new DataFormatOperationsApi();
            var id = 56;  // Integer |  (default to null)

            try {
                // Retrieves a Data Format by ID.
                DataFormatDto result = apiInstance.getDataFormatById(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DataFormatOperationsApi.getDataFormatById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DataFormatOperationsApi();
$id = 56; // Integer | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DataFormatOperationsApi->new();
my $id = 56; # Integer | 

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

# Create an instance of the API class
api_instance = openapi_client.DataFormatOperationsApi()
id = 56 # Integer |  (default to null)

try:
    # Retrieves a Data Format by ID.
    api_response = api_instance.get_data_format_by_id(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataFormatOperationsApi->getDataFormatById: %s\n" % e)
extern crate DataFormatOperationsApi;

pub fn main() {
    let id = 56; // Integer

    let mut context = DataFormatOperationsApi::Context::default();
    let result = client.getDataFormatById(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required

Responses


getDataFormatByType

Retrieves a Connector by type.


/api/v2/ddl/data-formats/type/{type}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/api/v2/ddl/data-formats/type/{type}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DataFormatOperationsApi;

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

public class DataFormatOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        DataFormatOperationsApi apiInstance = new DataFormatOperationsApi();
        String type = type_example; // String | 

        try {
            DataFormatDto result = apiInstance.getDataFormatByType(type);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataFormatOperationsApi#getDataFormatByType");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String type = new String(); // String | 

try {
    final result = await api_instance.getDataFormatByType(type);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getDataFormatByType: $e\n');
}

import org.openapitools.client.api.DataFormatOperationsApi;

public class DataFormatOperationsApiExample {
    public static void main(String[] args) {
        DataFormatOperationsApi apiInstance = new DataFormatOperationsApi();
        String type = type_example; // String | 

        try {
            DataFormatDto result = apiInstance.getDataFormatByType(type);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataFormatOperationsApi#getDataFormatByType");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DataFormatOperationsApi *apiInstance = [[DataFormatOperationsApi alloc] init];
String *type = type_example; //  (default to null)

// Retrieves a Connector by type.
[apiInstance getDataFormatByTypeWith:type
              completionHandler: ^(DataFormatDto output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.DataFormatOperationsApi()
var type = type_example; // {String} 

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

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

            // Create an instance of the API class
            var apiInstance = new DataFormatOperationsApi();
            var type = type_example;  // String |  (default to null)

            try {
                // Retrieves a Connector by type.
                DataFormatDto result = apiInstance.getDataFormatByType(type);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DataFormatOperationsApi.getDataFormatByType: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DataFormatOperationsApi();
$type = type_example; // String | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DataFormatOperationsApi->new();
my $type = type_example; # String | 

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

# Create an instance of the API class
api_instance = openapi_client.DataFormatOperationsApi()
type = type_example # String |  (default to null)

try:
    # Retrieves a Connector by type.
    api_response = api_instance.get_data_format_by_type(type)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataFormatOperationsApi->getDataFormatByType: %s\n" % e)
extern crate DataFormatOperationsApi;

pub fn main() {
    let type = type_example; // String

    let mut context = DataFormatOperationsApi::Context::default();
    let result = client.getDataFormatByType(type, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
type*
String
Required

Responses


getDataFormats

Retrieves all Data Formats.


/api/v2/ddl/data-formats

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/api/v2/ddl/data-formats"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DataFormatOperationsApi;

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

public class DataFormatOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        DataFormatOperationsApi apiInstance = new DataFormatOperationsApi();

        try {
            array[DataFormatDto] result = apiInstance.getDataFormats();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataFormatOperationsApi#getDataFormats");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();


try {
    final result = await api_instance.getDataFormats();
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getDataFormats: $e\n');
}

import org.openapitools.client.api.DataFormatOperationsApi;

public class DataFormatOperationsApiExample {
    public static void main(String[] args) {
        DataFormatOperationsApi apiInstance = new DataFormatOperationsApi();

        try {
            array[DataFormatDto] result = apiInstance.getDataFormats();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataFormatOperationsApi#getDataFormats");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DataFormatOperationsApi *apiInstance = [[DataFormatOperationsApi alloc] init];

// Retrieves all Data Formats.
[apiInstance getDataFormatsWithCompletionHandler: 
              ^(array[DataFormatDto] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.DataFormatOperationsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDataFormats(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new DataFormatOperationsApi();

            try {
                // Retrieves all Data Formats.
                array[DataFormatDto] result = apiInstance.getDataFormats();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DataFormatOperationsApi.getDataFormats: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DataFormatOperationsApi();

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DataFormatOperationsApi->new();

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

# Create an instance of the API class
api_instance = openapi_client.DataFormatOperationsApi()

try:
    # Retrieves all Data Formats.
    api_response = api_instance.get_data_formats()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataFormatOperationsApi->getDataFormats: %s\n" % e)
extern crate DataFormatOperationsApi;

pub fn main() {

    let mut context = DataFormatOperationsApi::Context::default();
    let result = client.getDataFormats(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


DataSourceOperations

copyDataSourceV2

Creates a copy of a data source in the specified project.


/api/v2/projects/{projectId}/data-sources/{id}/copy

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 "http://localhost/api/v2/projects/{projectId}/data-sources/{id}/copy"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DataSourceOperationsApi;

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

public class DataSourceOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        DataSourceOperationsApi apiInstance = new DataSourceOperationsApi();
        String id = id_example; // String | 
        String projectId = projectId_example; // String | 

        try {
            DataSourceDto result = apiInstance.copyDataSourceV2(id, projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataSourceOperationsApi#copyDataSourceV2");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String id = new String(); // String | 
final String projectId = new String(); // String | 

try {
    final result = await api_instance.copyDataSourceV2(id, projectId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->copyDataSourceV2: $e\n');
}

import org.openapitools.client.api.DataSourceOperationsApi;

public class DataSourceOperationsApiExample {
    public static void main(String[] args) {
        DataSourceOperationsApi apiInstance = new DataSourceOperationsApi();
        String id = id_example; // String | 
        String projectId = projectId_example; // String | 

        try {
            DataSourceDto result = apiInstance.copyDataSourceV2(id, projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataSourceOperationsApi#copyDataSourceV2");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DataSourceOperationsApi *apiInstance = [[DataSourceOperationsApi alloc] init];
String *id = id_example; //  (default to null)
String *projectId = projectId_example; //  (default to null)

// Creates a copy of a data source in the specified project.
[apiInstance copyDataSourceV2With:id
    projectId:projectId
              completionHandler: ^(DataSourceDto output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.DataSourceOperationsApi()
var id = id_example; // {String} 
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.copyDataSourceV2(id, projectId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new DataSourceOperationsApi();
            var id = id_example;  // String |  (default to null)
            var projectId = projectId_example;  // String |  (default to null)

            try {
                // Creates a copy of a data source in the specified project.
                DataSourceDto result = apiInstance.copyDataSourceV2(id, projectId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DataSourceOperationsApi.copyDataSourceV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DataSourceOperationsApi();
$id = id_example; // String | 
$projectId = projectId_example; // String | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DataSourceOperationsApi->new();
my $id = id_example; # String | 
my $projectId = projectId_example; # String | 

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

# Create an instance of the API class
api_instance = openapi_client.DataSourceOperationsApi()
id = id_example # String |  (default to null)
projectId = projectId_example # String |  (default to null)

try:
    # Creates a copy of a data source in the specified project.
    api_response = api_instance.copy_data_source_v2(id, projectId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataSourceOperationsApi->copyDataSourceV2: %s\n" % e)
extern crate DataSourceOperationsApi;

pub fn main() {
    let id = id_example; // String
    let projectId = projectId_example; // String

    let mut context = DataSourceOperationsApi::Context::default();
    let result = client.copyDataSourceV2(id, projectId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
String
Required
projectId*
String
Required

Responses


createDataSourceV2

Creates a data source in the specified project.


/api/v2/projects/{projectId}/data-sources

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost/api/v2/projects/{projectId}/data-sources" \
 -d '{
  "custom_truststore" : true,
  "name" : "name",
  "id" : "id",
  "type" : "type",
  "properties" : ""
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DataSourceOperationsApi;

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

public class DataSourceOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        DataSourceOperationsApi apiInstance = new DataSourceOperationsApi();
        String projectId = projectId_example; // String | 
        DataSourceSyncDto dataSourceSyncDto = ; // DataSourceSyncDto | 

        try {
            DataSourceDto result = apiInstance.createDataSourceV2(projectId, dataSourceSyncDto);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataSourceOperationsApi#createDataSourceV2");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String projectId = new String(); // String | 
final DataSourceSyncDto dataSourceSyncDto = new DataSourceSyncDto(); // DataSourceSyncDto | 

try {
    final result = await api_instance.createDataSourceV2(projectId, dataSourceSyncDto);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->createDataSourceV2: $e\n');
}

import org.openapitools.client.api.DataSourceOperationsApi;

public class DataSourceOperationsApiExample {
    public static void main(String[] args) {
        DataSourceOperationsApi apiInstance = new DataSourceOperationsApi();
        String projectId = projectId_example; // String | 
        DataSourceSyncDto dataSourceSyncDto = ; // DataSourceSyncDto | 

        try {
            DataSourceDto result = apiInstance.createDataSourceV2(projectId, dataSourceSyncDto);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataSourceOperationsApi#createDataSourceV2");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DataSourceOperationsApi *apiInstance = [[DataSourceOperationsApi alloc] init];
String *projectId = projectId_example; //  (default to null)
DataSourceSyncDto *dataSourceSyncDto = ; // 

// Creates a data source in the specified project.
[apiInstance createDataSourceV2With:projectId
    dataSourceSyncDto:dataSourceSyncDto
              completionHandler: ^(DataSourceDto output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.DataSourceOperationsApi()
var projectId = projectId_example; // {String} 
var dataSourceSyncDto = ; // {DataSourceSyncDto} 

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

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

            // Create an instance of the API class
            var apiInstance = new DataSourceOperationsApi();
            var projectId = projectId_example;  // String |  (default to null)
            var dataSourceSyncDto = new DataSourceSyncDto(); // DataSourceSyncDto | 

            try {
                // Creates a data source in the specified project.
                DataSourceDto result = apiInstance.createDataSourceV2(projectId, dataSourceSyncDto);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DataSourceOperationsApi.createDataSourceV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DataSourceOperationsApi();
$projectId = projectId_example; // String | 
$dataSourceSyncDto = ; // DataSourceSyncDto | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DataSourceOperationsApi->new();
my $projectId = projectId_example; # String | 
my $dataSourceSyncDto = WWW::OPenAPIClient::Object::DataSourceSyncDto->new(); # DataSourceSyncDto | 

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

# Create an instance of the API class
api_instance = openapi_client.DataSourceOperationsApi()
projectId = projectId_example # String |  (default to null)
dataSourceSyncDto =  # DataSourceSyncDto | 

try:
    # Creates a data source in the specified project.
    api_response = api_instance.create_data_source_v2(projectId, dataSourceSyncDto)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataSourceOperationsApi->createDataSourceV2: %s\n" % e)
extern crate DataSourceOperationsApi;

pub fn main() {
    let projectId = projectId_example; // String
    let dataSourceSyncDto = ; // DataSourceSyncDto

    let mut context = DataSourceOperationsApi::Context::default();
    let result = client.createDataSourceV2(projectId, dataSourceSyncDto, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
projectId*
String
Required
Body parameters
Name Description
dataSourceSyncDto *

Responses


deleteDataSourceV2

Deletes a data source from the specified project.


/api/v2/projects/{projectId}/data-sources/{id}

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: application/json" \
 "http://localhost/api/v2/projects/{projectId}/data-sources/{id}?delete_dependents=true"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DataSourceOperationsApi;

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

public class DataSourceOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        DataSourceOperationsApi apiInstance = new DataSourceOperationsApi();
        String id = id_example; // String | 
        String projectId = projectId_example; // String | 
        Boolean deleteDependents = true; // Boolean | 

        try {
            apiInstance.deleteDataSourceV2(id, projectId, deleteDependents);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataSourceOperationsApi#deleteDataSourceV2");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String id = new String(); // String | 
final String projectId = new String(); // String | 
final Boolean deleteDependents = new Boolean(); // Boolean | 

try {
    final result = await api_instance.deleteDataSourceV2(id, projectId, deleteDependents);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteDataSourceV2: $e\n');
}

import org.openapitools.client.api.DataSourceOperationsApi;

public class DataSourceOperationsApiExample {
    public static void main(String[] args) {
        DataSourceOperationsApi apiInstance = new DataSourceOperationsApi();
        String id = id_example; // String | 
        String projectId = projectId_example; // String | 
        Boolean deleteDependents = true; // Boolean | 

        try {
            apiInstance.deleteDataSourceV2(id, projectId, deleteDependents);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataSourceOperationsApi#deleteDataSourceV2");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DataSourceOperationsApi *apiInstance = [[DataSourceOperationsApi alloc] init];
String *id = id_example; //  (default to null)
String *projectId = projectId_example; //  (default to null)
Boolean *deleteDependents = true; //  (optional) (default to false)

// Deletes a data source from the specified project.
[apiInstance deleteDataSourceV2With:id
    projectId:projectId
    deleteDependents:deleteDependents
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.DataSourceOperationsApi()
var id = id_example; // {String} 
var projectId = projectId_example; // {String} 
var opts = {
  'deleteDependents': true // {Boolean} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteDataSourceV2(id, projectId, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new DataSourceOperationsApi();
            var id = id_example;  // String |  (default to null)
            var projectId = projectId_example;  // String |  (default to null)
            var deleteDependents = true;  // Boolean |  (optional)  (default to false)

            try {
                // Deletes a data source from the specified project.
                apiInstance.deleteDataSourceV2(id, projectId, deleteDependents);
            } catch (Exception e) {
                Debug.Print("Exception when calling DataSourceOperationsApi.deleteDataSourceV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DataSourceOperationsApi();
$id = id_example; // String | 
$projectId = projectId_example; // String | 
$deleteDependents = true; // Boolean | 

try {
    $api_instance->deleteDataSourceV2($id, $projectId, $deleteDependents);
} catch (Exception $e) {
    echo 'Exception when calling DataSourceOperationsApi->deleteDataSourceV2: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DataSourceOperationsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DataSourceOperationsApi->new();
my $id = id_example; # String | 
my $projectId = projectId_example; # String | 
my $deleteDependents = true; # Boolean | 

eval {
    $api_instance->deleteDataSourceV2(id => $id, projectId => $projectId, deleteDependents => $deleteDependents);
};
if ($@) {
    warn "Exception when calling DataSourceOperationsApi->deleteDataSourceV2: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.DataSourceOperationsApi()
id = id_example # String |  (default to null)
projectId = projectId_example # String |  (default to null)
deleteDependents = true # Boolean |  (optional) (default to false)

try:
    # Deletes a data source from the specified project.
    api_instance.delete_data_source_v2(id, projectId, deleteDependents=deleteDependents)
except ApiException as e:
    print("Exception when calling DataSourceOperationsApi->deleteDataSourceV2: %s\n" % e)
extern crate DataSourceOperationsApi;

pub fn main() {
    let id = id_example; // String
    let projectId = projectId_example; // String
    let deleteDependents = true; // Boolean

    let mut context = DataSourceOperationsApi::Context::default();
    let result = client.deleteDataSourceV2(id, projectId, deleteDependents, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
String
Required
projectId*
String
Required
Query parameters
Name Description
delete_dependents
Boolean

Responses


getDataSourceInProjectByIdV2

Retrieves a data source in the specified project by its id.


/api/v2/projects/{projectId}/data-sources/{id}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/api/v2/projects/{projectId}/data-sources/{id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DataSourceOperationsApi;

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

public class DataSourceOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        DataSourceOperationsApi apiInstance = new DataSourceOperationsApi();
        String id = id_example; // String | 
        String projectId = projectId_example; // String | 

        try {
            DataSourceDto result = apiInstance.getDataSourceInProjectByIdV2(id, projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataSourceOperationsApi#getDataSourceInProjectByIdV2");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String id = new String(); // String | 
final String projectId = new String(); // String | 

try {
    final result = await api_instance.getDataSourceInProjectByIdV2(id, projectId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getDataSourceInProjectByIdV2: $e\n');
}

import org.openapitools.client.api.DataSourceOperationsApi;

public class DataSourceOperationsApiExample {
    public static void main(String[] args) {
        DataSourceOperationsApi apiInstance = new DataSourceOperationsApi();
        String id = id_example; // String | 
        String projectId = projectId_example; // String | 

        try {
            DataSourceDto result = apiInstance.getDataSourceInProjectByIdV2(id, projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataSourceOperationsApi#getDataSourceInProjectByIdV2");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DataSourceOperationsApi *apiInstance = [[DataSourceOperationsApi alloc] init];
String *id = id_example; //  (default to null)
String *projectId = projectId_example; //  (default to null)

// Retrieves a data source in the specified project by its id.
[apiInstance getDataSourceInProjectByIdV2With:id
    projectId:projectId
              completionHandler: ^(DataSourceDto output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.DataSourceOperationsApi()
var id = id_example; // {String} 
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.getDataSourceInProjectByIdV2(id, projectId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new DataSourceOperationsApi();
            var id = id_example;  // String |  (default to null)
            var projectId = projectId_example;  // String |  (default to null)

            try {
                // Retrieves a data source in the specified project by its id.
                DataSourceDto result = apiInstance.getDataSourceInProjectByIdV2(id, projectId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DataSourceOperationsApi.getDataSourceInProjectByIdV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DataSourceOperationsApi();
$id = id_example; // String | 
$projectId = projectId_example; // String | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DataSourceOperationsApi->new();
my $id = id_example; # String | 
my $projectId = projectId_example; # String | 

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

# Create an instance of the API class
api_instance = openapi_client.DataSourceOperationsApi()
id = id_example # String |  (default to null)
projectId = projectId_example # String |  (default to null)

try:
    # Retrieves a data source in the specified project by its id.
    api_response = api_instance.get_data_source_in_project_by_id_v2(id, projectId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataSourceOperationsApi->getDataSourceInProjectByIdV2: %s\n" % e)
extern crate DataSourceOperationsApi;

pub fn main() {
    let id = id_example; // String
    let projectId = projectId_example; // String

    let mut context = DataSourceOperationsApi::Context::default();
    let result = client.getDataSourceInProjectByIdV2(id, projectId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
String
Required
projectId*
String
Required

Responses


getDataSourcesInProjectV2

Retrieves all data sources in the specified project.


/api/v2/projects/{projectId}/data-sources

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/api/v2/projects/{projectId}/data-sources"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DataSourceOperationsApi;

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

public class DataSourceOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        DataSourceOperationsApi apiInstance = new DataSourceOperationsApi();
        String projectId = projectId_example; // String | 

        try {
            array[DataSourceDto] result = apiInstance.getDataSourcesInProjectV2(projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataSourceOperationsApi#getDataSourcesInProjectV2");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String projectId = new String(); // String | 

try {
    final result = await api_instance.getDataSourcesInProjectV2(projectId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getDataSourcesInProjectV2: $e\n');
}

import org.openapitools.client.api.DataSourceOperationsApi;

public class DataSourceOperationsApiExample {
    public static void main(String[] args) {
        DataSourceOperationsApi apiInstance = new DataSourceOperationsApi();
        String projectId = projectId_example; // String | 

        try {
            array[DataSourceDto] result = apiInstance.getDataSourcesInProjectV2(projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataSourceOperationsApi#getDataSourcesInProjectV2");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DataSourceOperationsApi *apiInstance = [[DataSourceOperationsApi alloc] init];
String *projectId = projectId_example; //  (default to null)

// Retrieves all data sources in the specified project.
[apiInstance getDataSourcesInProjectV2With:projectId
              completionHandler: ^(array[DataSourceDto] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.DataSourceOperationsApi()
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.getDataSourcesInProjectV2(projectId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new DataSourceOperationsApi();
            var projectId = projectId_example;  // String |  (default to null)

            try {
                // Retrieves all data sources in the specified project.
                array[DataSourceDto] result = apiInstance.getDataSourcesInProjectV2(projectId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DataSourceOperationsApi.getDataSourcesInProjectV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DataSourceOperationsApi();
$projectId = projectId_example; // String | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DataSourceOperationsApi->new();
my $projectId = projectId_example; # String | 

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

# Create an instance of the API class
api_instance = openapi_client.DataSourceOperationsApi()
projectId = projectId_example # String |  (default to null)

try:
    # Retrieves all data sources in the specified project.
    api_response = api_instance.get_data_sources_in_project_v2(projectId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataSourceOperationsApi->getDataSourcesInProjectV2: %s\n" % e)
extern crate DataSourceOperationsApi;

pub fn main() {
    let projectId = projectId_example; // String

    let mut context = DataSourceOperationsApi::Context::default();
    let result = client.getDataSourcesInProjectV2(projectId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
projectId*
String
Required

Responses


getKafkaSourcesInProjectV2

Retrieves Kafka data sources in the specified project.


/api/v2/projects/{projectId}/data-sources/kafka

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/api/v2/projects/{projectId}/data-sources/kafka"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DataSourceOperationsApi;

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

public class DataSourceOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        DataSourceOperationsApi apiInstance = new DataSourceOperationsApi();
        String projectId = projectId_example; // String | 

        try {
            array[DataSourceDto] result = apiInstance.getKafkaSourcesInProjectV2(projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataSourceOperationsApi#getKafkaSourcesInProjectV2");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String projectId = new String(); // String | 

try {
    final result = await api_instance.getKafkaSourcesInProjectV2(projectId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getKafkaSourcesInProjectV2: $e\n');
}

import org.openapitools.client.api.DataSourceOperationsApi;

public class DataSourceOperationsApiExample {
    public static void main(String[] args) {
        DataSourceOperationsApi apiInstance = new DataSourceOperationsApi();
        String projectId = projectId_example; // String | 

        try {
            array[DataSourceDto] result = apiInstance.getKafkaSourcesInProjectV2(projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataSourceOperationsApi#getKafkaSourcesInProjectV2");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DataSourceOperationsApi *apiInstance = [[DataSourceOperationsApi alloc] init];
String *projectId = projectId_example; //  (default to null)

// Retrieves Kafka data sources in the specified project.
[apiInstance getKafkaSourcesInProjectV2With:projectId
              completionHandler: ^(array[DataSourceDto] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.DataSourceOperationsApi()
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.getKafkaSourcesInProjectV2(projectId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new DataSourceOperationsApi();
            var projectId = projectId_example;  // String |  (default to null)

            try {
                // Retrieves Kafka data sources in the specified project.
                array[DataSourceDto] result = apiInstance.getKafkaSourcesInProjectV2(projectId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DataSourceOperationsApi.getKafkaSourcesInProjectV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DataSourceOperationsApi();
$projectId = projectId_example; // String | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DataSourceOperationsApi->new();
my $projectId = projectId_example; # String | 

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

# Create an instance of the API class
api_instance = openapi_client.DataSourceOperationsApi()
projectId = projectId_example # String |  (default to null)

try:
    # Retrieves Kafka data sources in the specified project.
    api_response = api_instance.get_kafka_sources_in_project_v2(projectId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataSourceOperationsApi->getKafkaSourcesInProjectV2: %s\n" % e)
extern crate DataSourceOperationsApi;

pub fn main() {
    let projectId = projectId_example; // String

    let mut context = DataSourceOperationsApi::Context::default();
    let result = client.getKafkaSourcesInProjectV2(projectId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
projectId*
String
Required

Responses


updateDataSourceV2

Updates an existing data source in the specified project.


/api/v2/projects/{projectId}/data-sources/{id}

Usage and SDK Samples

curl -X PUT \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost/api/v2/projects/{projectId}/data-sources/{id}" \
 -d '{
  "custom_truststore" : true,
  "name" : "name",
  "id" : "id",
  "type" : "type",
  "properties" : ""
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DataSourceOperationsApi;

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

public class DataSourceOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        DataSourceOperationsApi apiInstance = new DataSourceOperationsApi();
        String id = id_example; // String | 
        String projectId = projectId_example; // String | 
        DataSourceSyncDto dataSourceSyncDto = ; // DataSourceSyncDto | 

        try {
            DataSourceDto result = apiInstance.updateDataSourceV2(id, projectId, dataSourceSyncDto);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataSourceOperationsApi#updateDataSourceV2");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String id = new String(); // String | 
final String projectId = new String(); // String | 
final DataSourceSyncDto dataSourceSyncDto = new DataSourceSyncDto(); // DataSourceSyncDto | 

try {
    final result = await api_instance.updateDataSourceV2(id, projectId, dataSourceSyncDto);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateDataSourceV2: $e\n');
}

import org.openapitools.client.api.DataSourceOperationsApi;

public class DataSourceOperationsApiExample {
    public static void main(String[] args) {
        DataSourceOperationsApi apiInstance = new DataSourceOperationsApi();
        String id = id_example; // String | 
        String projectId = projectId_example; // String | 
        DataSourceSyncDto dataSourceSyncDto = ; // DataSourceSyncDto | 

        try {
            DataSourceDto result = apiInstance.updateDataSourceV2(id, projectId, dataSourceSyncDto);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataSourceOperationsApi#updateDataSourceV2");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DataSourceOperationsApi *apiInstance = [[DataSourceOperationsApi alloc] init];
String *id = id_example; //  (default to null)
String *projectId = projectId_example; //  (default to null)
DataSourceSyncDto *dataSourceSyncDto = ; // 

// Updates an existing data source in the specified project.
[apiInstance updateDataSourceV2With:id
    projectId:projectId
    dataSourceSyncDto:dataSourceSyncDto
              completionHandler: ^(DataSourceDto output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.DataSourceOperationsApi()
var id = id_example; // {String} 
var projectId = projectId_example; // {String} 
var dataSourceSyncDto = ; // {DataSourceSyncDto} 

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

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

            // Create an instance of the API class
            var apiInstance = new DataSourceOperationsApi();
            var id = id_example;  // String |  (default to null)
            var projectId = projectId_example;  // String |  (default to null)
            var dataSourceSyncDto = new DataSourceSyncDto(); // DataSourceSyncDto | 

            try {
                // Updates an existing data source in the specified project.
                DataSourceDto result = apiInstance.updateDataSourceV2(id, projectId, dataSourceSyncDto);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DataSourceOperationsApi.updateDataSourceV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DataSourceOperationsApi();
$id = id_example; // String | 
$projectId = projectId_example; // String | 
$dataSourceSyncDto = ; // DataSourceSyncDto | 

try {
    $result = $api_instance->updateDataSourceV2($id, $projectId, $dataSourceSyncDto);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataSourceOperationsApi->updateDataSourceV2: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DataSourceOperationsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DataSourceOperationsApi->new();
my $id = id_example; # String | 
my $projectId = projectId_example; # String | 
my $dataSourceSyncDto = WWW::OPenAPIClient::Object::DataSourceSyncDto->new(); # DataSourceSyncDto | 

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

# Create an instance of the API class
api_instance = openapi_client.DataSourceOperationsApi()
id = id_example # String |  (default to null)
projectId = projectId_example # String |  (default to null)
dataSourceSyncDto =  # DataSourceSyncDto | 

try:
    # Updates an existing data source in the specified project.
    api_response = api_instance.update_data_source_v2(id, projectId, dataSourceSyncDto)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataSourceOperationsApi->updateDataSourceV2: %s\n" % e)
extern crate DataSourceOperationsApi;

pub fn main() {
    let id = id_example; // String
    let projectId = projectId_example; // String
    let dataSourceSyncDto = ; // DataSourceSyncDto

    let mut context = DataSourceOperationsApi::Context::default();
    let result = client.updateDataSourceV2(id, projectId, dataSourceSyncDto, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
String
Required
projectId*
String
Required
Body parameters
Name Description
dataSourceSyncDto *

Responses


validateDataSourceV2

Validates a data source as a Flink catalog in the active project.


/api/v2/projects/{projectId}/data-sources/validate

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost/api/v2/projects/{projectId}/data-sources/validate" \
 -d '{
  "custom_truststore" : true,
  "name" : "name",
  "id" : "id",
  "type" : "type",
  "properties" : ""
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DataSourceOperationsApi;

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

public class DataSourceOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        DataSourceOperationsApi apiInstance = new DataSourceOperationsApi();
        String projectId = projectId_example; // String | 
        DataSourceSyncDto dataSourceSyncDto = ; // DataSourceSyncDto | 

        try {
            ValidateDataSourceResponse result = apiInstance.validateDataSourceV2(projectId, dataSourceSyncDto);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataSourceOperationsApi#validateDataSourceV2");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String projectId = new String(); // String | 
final DataSourceSyncDto dataSourceSyncDto = new DataSourceSyncDto(); // DataSourceSyncDto | 

try {
    final result = await api_instance.validateDataSourceV2(projectId, dataSourceSyncDto);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->validateDataSourceV2: $e\n');
}

import org.openapitools.client.api.DataSourceOperationsApi;

public class DataSourceOperationsApiExample {
    public static void main(String[] args) {
        DataSourceOperationsApi apiInstance = new DataSourceOperationsApi();
        String projectId = projectId_example; // String | 
        DataSourceSyncDto dataSourceSyncDto = ; // DataSourceSyncDto | 

        try {
            ValidateDataSourceResponse result = apiInstance.validateDataSourceV2(projectId, dataSourceSyncDto);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataSourceOperationsApi#validateDataSourceV2");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DataSourceOperationsApi *apiInstance = [[DataSourceOperationsApi alloc] init];
String *projectId = projectId_example; //  (default to null)
DataSourceSyncDto *dataSourceSyncDto = ; // 

// Validates a data source as a Flink catalog in the active project.
[apiInstance validateDataSourceV2With:projectId
    dataSourceSyncDto:dataSourceSyncDto
              completionHandler: ^(ValidateDataSourceResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.DataSourceOperationsApi()
var projectId = projectId_example; // {String} 
var dataSourceSyncDto = ; // {DataSourceSyncDto} 

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

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

            // Create an instance of the API class
            var apiInstance = new DataSourceOperationsApi();
            var projectId = projectId_example;  // String |  (default to null)
            var dataSourceSyncDto = new DataSourceSyncDto(); // DataSourceSyncDto | 

            try {
                // Validates a data source as a Flink catalog in the active project.
                ValidateDataSourceResponse result = apiInstance.validateDataSourceV2(projectId, dataSourceSyncDto);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DataSourceOperationsApi.validateDataSourceV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DataSourceOperationsApi();
$projectId = projectId_example; // String | 
$dataSourceSyncDto = ; // DataSourceSyncDto | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DataSourceOperationsApi->new();
my $projectId = projectId_example; # String | 
my $dataSourceSyncDto = WWW::OPenAPIClient::Object::DataSourceSyncDto->new(); # DataSourceSyncDto | 

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

# Create an instance of the API class
api_instance = openapi_client.DataSourceOperationsApi()
projectId = projectId_example # String |  (default to null)
dataSourceSyncDto =  # DataSourceSyncDto | 

try:
    # Validates a data source as a Flink catalog in the active project.
    api_response = api_instance.validate_data_source_v2(projectId, dataSourceSyncDto)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataSourceOperationsApi->validateDataSourceV2: %s\n" % e)
extern crate DataSourceOperationsApi;

pub fn main() {
    let projectId = projectId_example; // String
    let dataSourceSyncDto = ; // DataSourceSyncDto

    let mut context = DataSourceOperationsApi::Context::default();
    let result = client.validateDataSourceV2(projectId, dataSourceSyncDto, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
projectId*
String
Required
Body parameters
Name Description
dataSourceSyncDto *

Responses


DatabaseInfo

connectString


/internal/database/connect-string

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/internal/database/connect-string"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DatabaseInfoApi;

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

public class DatabaseInfoApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        DatabaseInfoApi apiInstance = new DatabaseInfoApi();

        try {
            DatabaseConnectStringResponse result = apiInstance.connectString();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DatabaseInfoApi#connectString");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();


try {
    final result = await api_instance.connectString();
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->connectString: $e\n');
}

import org.openapitools.client.api.DatabaseInfoApi;

public class DatabaseInfoApiExample {
    public static void main(String[] args) {
        DatabaseInfoApi apiInstance = new DatabaseInfoApi();

        try {
            DatabaseConnectStringResponse result = apiInstance.connectString();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DatabaseInfoApi#connectString");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DatabaseInfoApi *apiInstance = [[DatabaseInfoApi alloc] init];

[apiInstance connectStringWithCompletionHandler: 
              ^(DatabaseConnectStringResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.DatabaseInfoApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.connectString(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new DatabaseInfoApi();

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DatabaseInfoApi();

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DatabaseInfoApi->new();

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

# Create an instance of the API class
api_instance = openapi_client.DatabaseInfoApi()

try:
    api_response = api_instance.connect_string()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatabaseInfoApi->connectString: %s\n" % e)
extern crate DatabaseInfoApi;

pub fn main() {

    let mut context = DatabaseInfoApi::Context::default();
    let result = client.connectString(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


info


/internal/database/info

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/internal/database/info"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DatabaseInfoApi;

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

public class DatabaseInfoApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        DatabaseInfoApi apiInstance = new DatabaseInfoApi();

        try {
            DatabaseInfoResponse result = apiInstance.info();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DatabaseInfoApi#info");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();


try {
    final result = await api_instance.info();
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->info: $e\n');
}

import org.openapitools.client.api.DatabaseInfoApi;

public class DatabaseInfoApiExample {
    public static void main(String[] args) {
        DatabaseInfoApi apiInstance = new DatabaseInfoApi();

        try {
            DatabaseInfoResponse result = apiInstance.info();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DatabaseInfoApi#info");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DatabaseInfoApi *apiInstance = [[DatabaseInfoApi alloc] init];

[apiInstance infoWithCompletionHandler: 
              ^(DatabaseInfoResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.DatabaseInfoApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.info(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new DatabaseInfoApi();

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DatabaseInfoApi();

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DatabaseInfoApi->new();

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

# Create an instance of the API class
api_instance = openapi_client.DatabaseInfoApi()

try:
    api_response = api_instance.info()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatabaseInfoApi->info: %s\n" % e)
extern crate DatabaseInfoApi;

pub fn main() {

    let mut context = DatabaseInfoApi::Context::default();
    let result = client.info(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


version


/internal/database/version

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/internal/database/version"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DatabaseInfoApi;

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

public class DatabaseInfoApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        DatabaseInfoApi apiInstance = new DatabaseInfoApi();

        try {
            DatabaseVersionResponse result = apiInstance.version();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DatabaseInfoApi#version");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();


try {
    final result = await api_instance.version();
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->version: $e\n');
}

import org.openapitools.client.api.DatabaseInfoApi;

public class DatabaseInfoApiExample {
    public static void main(String[] args) {
        DatabaseInfoApi apiInstance = new DatabaseInfoApi();

        try {
            DatabaseVersionResponse result = apiInstance.version();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DatabaseInfoApi#version");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DatabaseInfoApi *apiInstance = [[DatabaseInfoApi alloc] init];

[apiInstance versionWithCompletionHandler: 
              ^(DatabaseVersionResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.DatabaseInfoApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.version(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new DatabaseInfoApi();

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DatabaseInfoApi();

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DatabaseInfoApi->new();

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

# Create an instance of the API class
api_instance = openapi_client.DatabaseInfoApi()

try:
    api_response = api_instance.version()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatabaseInfoApi->version: %s\n" % e)
extern crate DatabaseInfoApi;

pub fn main() {

    let mut context = DatabaseInfoApi::Context::default();
    let result = client.version(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


EventStreamTypeOperations

emitSampleStream

Polls job sample results in a streaming manner.


/api/v2/event-stream/samples/{sampleId}

Usage and SDK Samples

curl -X GET \
 -H "Accept: text/event-stream" \
 "http://localhost/api/v2/event-stream/samples/{sampleId}?kafkaPollTimeoutMillis=789"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.EventStreamTypeOperationsApi;

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

public class EventStreamTypeOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        EventStreamTypeOperationsApi apiInstance = new EventStreamTypeOperationsApi();
        String sampleId = sampleId_example; // String | 
        Long kafkaPollTimeoutMillis = 789; // Long | Kafka poll timeout in ms.

        try {
            SseEmitter result = apiInstance.emitSampleStream(sampleId, kafkaPollTimeoutMillis);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EventStreamTypeOperationsApi#emitSampleStream");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String sampleId = new String(); // String | 
final Long kafkaPollTimeoutMillis = new Long(); // Long | Kafka poll timeout in ms.

try {
    final result = await api_instance.emitSampleStream(sampleId, kafkaPollTimeoutMillis);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->emitSampleStream: $e\n');
}

import org.openapitools.client.api.EventStreamTypeOperationsApi;

public class EventStreamTypeOperationsApiExample {
    public static void main(String[] args) {
        EventStreamTypeOperationsApi apiInstance = new EventStreamTypeOperationsApi();
        String sampleId = sampleId_example; // String | 
        Long kafkaPollTimeoutMillis = 789; // Long | Kafka poll timeout in ms.

        try {
            SseEmitter result = apiInstance.emitSampleStream(sampleId, kafkaPollTimeoutMillis);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EventStreamTypeOperationsApi#emitSampleStream");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
EventStreamTypeOperationsApi *apiInstance = [[EventStreamTypeOperationsApi alloc] init];
String *sampleId = sampleId_example; //  (default to null)
Long *kafkaPollTimeoutMillis = 789; // Kafka poll timeout in ms. (optional) (default to 1000)

// Polls job sample results in a streaming manner.
[apiInstance emitSampleStreamWith:sampleId
    kafkaPollTimeoutMillis:kafkaPollTimeoutMillis
              completionHandler: ^(SseEmitter output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.EventStreamTypeOperationsApi()
var sampleId = sampleId_example; // {String} 
var opts = {
  'kafkaPollTimeoutMillis': 789 // {Long} Kafka poll timeout in ms.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.emitSampleStream(sampleId, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new EventStreamTypeOperationsApi();
            var sampleId = sampleId_example;  // String |  (default to null)
            var kafkaPollTimeoutMillis = 789;  // Long | Kafka poll timeout in ms. (optional)  (default to 1000)

            try {
                // Polls job sample results in a streaming manner.
                SseEmitter result = apiInstance.emitSampleStream(sampleId, kafkaPollTimeoutMillis);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling EventStreamTypeOperationsApi.emitSampleStream: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\EventStreamTypeOperationsApi();
$sampleId = sampleId_example; // String | 
$kafkaPollTimeoutMillis = 789; // Long | Kafka poll timeout in ms.

try {
    $result = $api_instance->emitSampleStream($sampleId, $kafkaPollTimeoutMillis);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EventStreamTypeOperationsApi->emitSampleStream: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::EventStreamTypeOperationsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::EventStreamTypeOperationsApi->new();
my $sampleId = sampleId_example; # String | 
my $kafkaPollTimeoutMillis = 789; # Long | Kafka poll timeout in ms.

eval {
    my $result = $api_instance->emitSampleStream(sampleId => $sampleId, kafkaPollTimeoutMillis => $kafkaPollTimeoutMillis);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EventStreamTypeOperationsApi->emitSampleStream: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.EventStreamTypeOperationsApi()
sampleId = sampleId_example # String |  (default to null)
kafkaPollTimeoutMillis = 789 # Long | Kafka poll timeout in ms. (optional) (default to 1000)

try:
    # Polls job sample results in a streaming manner.
    api_response = api_instance.emit_sample_stream(sampleId, kafkaPollTimeoutMillis=kafkaPollTimeoutMillis)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EventStreamTypeOperationsApi->emitSampleStream: %s\n" % e)
extern crate EventStreamTypeOperationsApi;

pub fn main() {
    let sampleId = sampleId_example; // String
    let kafkaPollTimeoutMillis = 789; // Long

    let mut context = EventStreamTypeOperationsApi::Context::default();
    let result = client.emitSampleStream(sampleId, kafkaPollTimeoutMillis, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
sampleId*
String
Required
Query parameters
Name Description
kafkaPollTimeoutMillis
Long (int64)
Kafka poll timeout in ms.

Responses


FlinkController

getCatalogConnectors

Retrieves all available Flink catalog connectors on the class path


/internal/flink/catalogs

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/internal/flink/catalogs"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FlinkControllerApi;

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

public class FlinkControllerApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        FlinkControllerApi apiInstance = new FlinkControllerApi();

        try {
            array['String'] result = apiInstance.getCatalogConnectors();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FlinkControllerApi#getCatalogConnectors");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();


try {
    final result = await api_instance.getCatalogConnectors();
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getCatalogConnectors: $e\n');
}

import org.openapitools.client.api.FlinkControllerApi;

public class FlinkControllerApiExample {
    public static void main(String[] args) {
        FlinkControllerApi apiInstance = new FlinkControllerApi();

        try {
            array['String'] result = apiInstance.getCatalogConnectors();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FlinkControllerApi#getCatalogConnectors");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
FlinkControllerApi *apiInstance = [[FlinkControllerApi alloc] init];

// Retrieves all available Flink catalog connectors on the class path
[apiInstance getCatalogConnectorsWithCompletionHandler: 
              ^(array['String'] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.FlinkControllerApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCatalogConnectors(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new FlinkControllerApi();

            try {
                // Retrieves all available Flink catalog connectors on the class path
                array['String'] result = apiInstance.getCatalogConnectors();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FlinkControllerApi.getCatalogConnectors: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FlinkControllerApi();

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FlinkControllerApi->new();

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

# Create an instance of the API class
api_instance = openapi_client.FlinkControllerApi()

try:
    # Retrieves all available Flink catalog connectors on the class path
    api_response = api_instance.get_catalog_connectors()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FlinkControllerApi->getCatalogConnectors: %s\n" % e)
extern crate FlinkControllerApi;

pub fn main() {

    let mut context = FlinkControllerApi::Context::default();
    let result = client.getCatalogConnectors(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


FlinkDashboard

getAllJobsOverview


/ui/flink/jobs/overview

Usage and SDK Samples

curl -X GET \
 -H "Accept: */*" \
 "http://localhost/ui/flink/jobs/overview"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FlinkDashboardApi;

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

public class FlinkDashboardApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        FlinkDashboardApi apiInstance = new FlinkDashboardApi();

        try {
            'String' result = apiInstance.getAllJobsOverview();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FlinkDashboardApi#getAllJobsOverview");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();


try {
    final result = await api_instance.getAllJobsOverview();
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getAllJobsOverview: $e\n');
}

import org.openapitools.client.api.FlinkDashboardApi;

public class FlinkDashboardApiExample {
    public static void main(String[] args) {
        FlinkDashboardApi apiInstance = new FlinkDashboardApi();

        try {
            'String' result = apiInstance.getAllJobsOverview();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FlinkDashboardApi#getAllJobsOverview");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
FlinkDashboardApi *apiInstance = [[FlinkDashboardApi alloc] init];

[apiInstance getAllJobsOverviewWithCompletionHandler: 
              ^('String' output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.FlinkDashboardApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAllJobsOverview(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new FlinkDashboardApi();

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FlinkDashboardApi();

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FlinkDashboardApi->new();

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

# Create an instance of the API class
api_instance = openapi_client.FlinkDashboardApi()

try:
    api_response = api_instance.get_all_jobs_overview()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FlinkDashboardApi->getAllJobsOverview: %s\n" % e)
extern crate FlinkDashboardApi;

pub fn main() {

    let mut context = FlinkDashboardApi::Context::default();
    let result = client.getAllJobsOverview(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


getAllOverview


/ui/flink/overview

Usage and SDK Samples

curl -X GET \
 -H "Accept: */*" \
 "http://localhost/ui/flink/overview"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FlinkDashboardApi;

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

public class FlinkDashboardApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        FlinkDashboardApi apiInstance = new FlinkDashboardApi();

        try {
            'String' result = apiInstance.getAllOverview();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FlinkDashboardApi#getAllOverview");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();


try {
    final result = await api_instance.getAllOverview();
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getAllOverview: $e\n');
}

import org.openapitools.client.api.FlinkDashboardApi;

public class FlinkDashboardApiExample {
    public static void main(String[] args) {
        FlinkDashboardApi apiInstance = new FlinkDashboardApi();

        try {
            'String' result = apiInstance.getAllOverview();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FlinkDashboardApi#getAllOverview");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
FlinkDashboardApi *apiInstance = [[FlinkDashboardApi alloc] init];

[apiInstance getAllOverviewWithCompletionHandler: 
              ^('String' output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.FlinkDashboardApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAllOverview(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new FlinkDashboardApi();

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FlinkDashboardApi();

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FlinkDashboardApi->new();

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

# Create an instance of the API class
api_instance = openapi_client.FlinkDashboardApi()

try:
    api_response = api_instance.get_all_overview()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FlinkDashboardApi->getAllOverview: %s\n" % e)
extern crate FlinkDashboardApi;

pub fn main() {

    let mut context = FlinkDashboardApi::Context::default();
    let result = client.getAllOverview(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


getConfig


/ui/flink/config

Usage and SDK Samples

curl -X GET \
 -H "Accept: */*" \
 "http://localhost/ui/flink/config"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FlinkDashboardApi;

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

public class FlinkDashboardApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        FlinkDashboardApi apiInstance = new FlinkDashboardApi();

        try {
            'String' result = apiInstance.getConfig();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FlinkDashboardApi#getConfig");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();


try {
    final result = await api_instance.getConfig();
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getConfig: $e\n');
}

import org.openapitools.client.api.FlinkDashboardApi;

public class FlinkDashboardApiExample {
    public static void main(String[] args) {
        FlinkDashboardApi apiInstance = new FlinkDashboardApi();

        try {
            'String' result = apiInstance.getConfig();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FlinkDashboardApi#getConfig");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
FlinkDashboardApi *apiInstance = [[FlinkDashboardApi alloc] init];

[apiInstance getConfigWithCompletionHandler: 
              ^('String' output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.FlinkDashboardApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getConfig(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new FlinkDashboardApi();

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FlinkDashboardApi();

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FlinkDashboardApi->new();

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

# Create an instance of the API class
api_instance = openapi_client.FlinkDashboardApi()

try:
    api_response = api_instance.get_config()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FlinkDashboardApi->getConfig: %s\n" % e)
extern crate FlinkDashboardApi;

pub fn main() {

    let mut context = FlinkDashboardApi::Context::default();
    let result = client.getConfig(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


redirectToIndex


/ui/flink

Usage and SDK Samples

curl -X GET \
 -H "Accept: */*" \
 "http://localhost/ui/flink"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FlinkDashboardApi;

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

public class FlinkDashboardApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        FlinkDashboardApi apiInstance = new FlinkDashboardApi();

        try {
            RedirectView result = apiInstance.redirectToIndex();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FlinkDashboardApi#redirectToIndex");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();


try {
    final result = await api_instance.redirectToIndex();
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->redirectToIndex: $e\n');
}

import org.openapitools.client.api.FlinkDashboardApi;

public class FlinkDashboardApiExample {
    public static void main(String[] args) {
        FlinkDashboardApi apiInstance = new FlinkDashboardApi();

        try {
            RedirectView result = apiInstance.redirectToIndex();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FlinkDashboardApi#redirectToIndex");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
FlinkDashboardApi *apiInstance = [[FlinkDashboardApi alloc] init];

[apiInstance redirectToIndexWithCompletionHandler: 
              ^(RedirectView output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.FlinkDashboardApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.redirectToIndex(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new FlinkDashboardApi();

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FlinkDashboardApi();

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FlinkDashboardApi->new();

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

# Create an instance of the API class
api_instance = openapi_client.FlinkDashboardApi()

try:
    api_response = api_instance.redirect_to_index()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FlinkDashboardApi->redirectToIndex: %s\n" % e)
extern crate FlinkDashboardApi;

pub fn main() {

    let mut context = FlinkDashboardApi::Context::default();
    let result = client.redirectToIndex(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


routeJobRequest


/ui/flink/jobs/{jobId}/**

Usage and SDK Samples

curl -X GET \
 -H "Accept: */*" \
 -H "Content-Type: application/json" \
 "http://localhost/ui/flink/jobs/{jobId}/**" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FlinkDashboardApi;

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

public class FlinkDashboardApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        FlinkDashboardApi apiInstance = new FlinkDashboardApi();
        String jobId = jobId_example; // String | 
        String body = body_example; // String | 

        try {
            'String' result = apiInstance.routeJobRequest(jobId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FlinkDashboardApi#routeJobRequest");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String jobId = new String(); // String | 
final String body = new String(); // String | 

try {
    final result = await api_instance.routeJobRequest(jobId, body);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->routeJobRequest: $e\n');
}

import org.openapitools.client.api.FlinkDashboardApi;

public class FlinkDashboardApiExample {
    public static void main(String[] args) {
        FlinkDashboardApi apiInstance = new FlinkDashboardApi();
        String jobId = jobId_example; // String | 
        String body = body_example; // String | 

        try {
            'String' result = apiInstance.routeJobRequest(jobId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FlinkDashboardApi#routeJobRequest");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
FlinkDashboardApi *apiInstance = [[FlinkDashboardApi alloc] init];
String *jobId = jobId_example; //  (default to null)
String *body = body_example; //  (optional)

[apiInstance routeJobRequestWith:jobId
    body:body
              completionHandler: ^('String' output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.FlinkDashboardApi()
var jobId = jobId_example; // {String} 
var opts = {
  'body': body_example // {String} 
};

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

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

            // Create an instance of the API class
            var apiInstance = new FlinkDashboardApi();
            var jobId = jobId_example;  // String |  (default to null)
            var body = body_example;  // String |  (optional) 

            try {
                'String' result = apiInstance.routeJobRequest(jobId, body);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FlinkDashboardApi.routeJobRequest: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FlinkDashboardApi();
$jobId = jobId_example; // String | 
$body = body_example; // String | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FlinkDashboardApi->new();
my $jobId = jobId_example; # String | 
my $body = WWW::OPenAPIClient::Object::String->new(); # String | 

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

# Create an instance of the API class
api_instance = openapi_client.FlinkDashboardApi()
jobId = jobId_example # String |  (default to null)
body = body_example # String |  (optional)

try:
    api_response = api_instance.route_job_request(jobId, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FlinkDashboardApi->routeJobRequest: %s\n" % e)
extern crate FlinkDashboardApi;

pub fn main() {
    let jobId = jobId_example; // String
    let body = body_example; // String

    let mut context = FlinkDashboardApi::Context::default();
    let result = client.routeJobRequest(jobId, body, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

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

Responses


routeJobRequest1


/ui/flink/jobs/{jobId}/**

Usage and SDK Samples

curl -X POST \
 -H "Accept: */*" \
 -H "Content-Type: application/json" \
 "http://localhost/ui/flink/jobs/{jobId}/**" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FlinkDashboardApi;

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

public class FlinkDashboardApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        FlinkDashboardApi apiInstance = new FlinkDashboardApi();
        String jobId = jobId_example; // String | 
        String body = body_example; // String | 

        try {
            'String' result = apiInstance.routeJobRequest1(jobId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FlinkDashboardApi#routeJobRequest1");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String jobId = new String(); // String | 
final String body = new String(); // String | 

try {
    final result = await api_instance.routeJobRequest1(jobId, body);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->routeJobRequest1: $e\n');
}

import org.openapitools.client.api.FlinkDashboardApi;

public class FlinkDashboardApiExample {
    public static void main(String[] args) {
        FlinkDashboardApi apiInstance = new FlinkDashboardApi();
        String jobId = jobId_example; // String | 
        String body = body_example; // String | 

        try {
            'String' result = apiInstance.routeJobRequest1(jobId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FlinkDashboardApi#routeJobRequest1");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
FlinkDashboardApi *apiInstance = [[FlinkDashboardApi alloc] init];
String *jobId = jobId_example; //  (default to null)
String *body = body_example; //  (optional)

[apiInstance routeJobRequest1With:jobId
    body:body
              completionHandler: ^('String' output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.FlinkDashboardApi()
var jobId = jobId_example; // {String} 
var opts = {
  'body': body_example // {String} 
};

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

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

            // Create an instance of the API class
            var apiInstance = new FlinkDashboardApi();
            var jobId = jobId_example;  // String |  (default to null)
            var body = body_example;  // String |  (optional) 

            try {
                'String' result = apiInstance.routeJobRequest1(jobId, body);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FlinkDashboardApi.routeJobRequest1: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FlinkDashboardApi();
$jobId = jobId_example; // String | 
$body = body_example; // String | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FlinkDashboardApi->new();
my $jobId = jobId_example; # String | 
my $body = WWW::OPenAPIClient::Object::String->new(); # String | 

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

# Create an instance of the API class
api_instance = openapi_client.FlinkDashboardApi()
jobId = jobId_example # String |  (default to null)
body = body_example # String |  (optional)

try:
    api_response = api_instance.route_job_request1(jobId, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FlinkDashboardApi->routeJobRequest1: %s\n" % e)
extern crate FlinkDashboardApi;

pub fn main() {
    let jobId = jobId_example; // String
    let body = body_example; // String

    let mut context = FlinkDashboardApi::Context::default();
    let result = client.routeJobRequest1(jobId, body, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

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

Responses


routeJobRequest2


/ui/flink/jobs/{jobId}/**

Usage and SDK Samples

curl -X PUT \
 -H "Accept: */*" \
 -H "Content-Type: application/json" \
 "http://localhost/ui/flink/jobs/{jobId}/**" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FlinkDashboardApi;

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

public class FlinkDashboardApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        FlinkDashboardApi apiInstance = new FlinkDashboardApi();
        String jobId = jobId_example; // String | 
        String body = body_example; // String | 

        try {
            'String' result = apiInstance.routeJobRequest2(jobId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FlinkDashboardApi#routeJobRequest2");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String jobId = new String(); // String | 
final String body = new String(); // String | 

try {
    final result = await api_instance.routeJobRequest2(jobId, body);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->routeJobRequest2: $e\n');
}

import org.openapitools.client.api.FlinkDashboardApi;

public class FlinkDashboardApiExample {
    public static void main(String[] args) {
        FlinkDashboardApi apiInstance = new FlinkDashboardApi();
        String jobId = jobId_example; // String | 
        String body = body_example; // String | 

        try {
            'String' result = apiInstance.routeJobRequest2(jobId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FlinkDashboardApi#routeJobRequest2");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
FlinkDashboardApi *apiInstance = [[FlinkDashboardApi alloc] init];
String *jobId = jobId_example; //  (default to null)
String *body = body_example; //  (optional)

[apiInstance routeJobRequest2With:jobId
    body:body
              completionHandler: ^('String' output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.FlinkDashboardApi()
var jobId = jobId_example; // {String} 
var opts = {
  'body': body_example // {String} 
};

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

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

            // Create an instance of the API class
            var apiInstance = new FlinkDashboardApi();
            var jobId = jobId_example;  // String |  (default to null)
            var body = body_example;  // String |  (optional) 

            try {
                'String' result = apiInstance.routeJobRequest2(jobId, body);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FlinkDashboardApi.routeJobRequest2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FlinkDashboardApi();
$jobId = jobId_example; // String | 
$body = body_example; // String | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FlinkDashboardApi->new();
my $jobId = jobId_example; # String | 
my $body = WWW::OPenAPIClient::Object::String->new(); # String | 

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

# Create an instance of the API class
api_instance = openapi_client.FlinkDashboardApi()
jobId = jobId_example # String |  (default to null)
body = body_example # String |  (optional)

try:
    api_response = api_instance.route_job_request2(jobId, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FlinkDashboardApi->routeJobRequest2: %s\n" % e)
extern crate FlinkDashboardApi;

pub fn main() {
    let jobId = jobId_example; // String
    let body = body_example; // String

    let mut context = FlinkDashboardApi::Context::default();
    let result = client.routeJobRequest2(jobId, body, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

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

Responses


routeJobRequest3


/ui/flink/jobs/{jobId}/**

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: */*" \
 -H "Content-Type: application/json" \
 "http://localhost/ui/flink/jobs/{jobId}/**" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FlinkDashboardApi;

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

public class FlinkDashboardApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        FlinkDashboardApi apiInstance = new FlinkDashboardApi();
        String jobId = jobId_example; // String | 
        String body = body_example; // String | 

        try {
            'String' result = apiInstance.routeJobRequest3(jobId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FlinkDashboardApi#routeJobRequest3");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String jobId = new String(); // String | 
final String body = new String(); // String | 

try {
    final result = await api_instance.routeJobRequest3(jobId, body);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->routeJobRequest3: $e\n');
}

import org.openapitools.client.api.FlinkDashboardApi;

public class FlinkDashboardApiExample {
    public static void main(String[] args) {
        FlinkDashboardApi apiInstance = new FlinkDashboardApi();
        String jobId = jobId_example; // String | 
        String body = body_example; // String | 

        try {
            'String' result = apiInstance.routeJobRequest3(jobId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FlinkDashboardApi#routeJobRequest3");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
FlinkDashboardApi *apiInstance = [[FlinkDashboardApi alloc] init];
String *jobId = jobId_example; //  (default to null)
String *body = body_example; //  (optional)

[apiInstance routeJobRequest3With:jobId
    body:body
              completionHandler: ^('String' output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.FlinkDashboardApi()
var jobId = jobId_example; // {String} 
var opts = {
  'body': body_example // {String} 
};

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

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

            // Create an instance of the API class
            var apiInstance = new FlinkDashboardApi();
            var jobId = jobId_example;  // String |  (default to null)
            var body = body_example;  // String |  (optional) 

            try {
                'String' result = apiInstance.routeJobRequest3(jobId, body);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FlinkDashboardApi.routeJobRequest3: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FlinkDashboardApi();
$jobId = jobId_example; // String | 
$body = body_example; // String | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FlinkDashboardApi->new();
my $jobId = jobId_example; # String | 
my $body = WWW::OPenAPIClient::Object::String->new(); # String | 

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

# Create an instance of the API class
api_instance = openapi_client.FlinkDashboardApi()
jobId = jobId_example # String |  (default to null)
body = body_example # String |  (optional)

try:
    api_response = api_instance.route_job_request3(jobId, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FlinkDashboardApi->routeJobRequest3: %s\n" % e)
extern crate FlinkDashboardApi;

pub fn main() {
    let jobId = jobId_example; // String
    let body = body_example; // String

    let mut context = FlinkDashboardApi::Context::default();
    let result = client.routeJobRequest3(jobId, body, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

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

Responses


routeJobRequest4


/ui/flink/jobs/{jobId}/**

Usage and SDK Samples

curl -X PATCH \
 -H "Accept: */*" \
 -H "Content-Type: application/json" \
 "http://localhost/ui/flink/jobs/{jobId}/**" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FlinkDashboardApi;

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

public class FlinkDashboardApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        FlinkDashboardApi apiInstance = new FlinkDashboardApi();
        String jobId = jobId_example; // String | 
        String body = body_example; // String | 

        try {
            'String' result = apiInstance.routeJobRequest4(jobId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FlinkDashboardApi#routeJobRequest4");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String jobId = new String(); // String | 
final String body = new String(); // String | 

try {
    final result = await api_instance.routeJobRequest4(jobId, body);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->routeJobRequest4: $e\n');
}

import org.openapitools.client.api.FlinkDashboardApi;

public class FlinkDashboardApiExample {
    public static void main(String[] args) {
        FlinkDashboardApi apiInstance = new FlinkDashboardApi();
        String jobId = jobId_example; // String | 
        String body = body_example; // String | 

        try {
            'String' result = apiInstance.routeJobRequest4(jobId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FlinkDashboardApi#routeJobRequest4");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
FlinkDashboardApi *apiInstance = [[FlinkDashboardApi alloc] init];
String *jobId = jobId_example; //  (default to null)
String *body = body_example; //  (optional)

[apiInstance routeJobRequest4With:jobId
    body:body
              completionHandler: ^('String' output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.FlinkDashboardApi()
var jobId = jobId_example; // {String} 
var opts = {
  'body': body_example // {String} 
};

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

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

            // Create an instance of the API class
            var apiInstance = new FlinkDashboardApi();
            var jobId = jobId_example;  // String |  (default to null)
            var body = body_example;  // String |  (optional) 

            try {
                'String' result = apiInstance.routeJobRequest4(jobId, body);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FlinkDashboardApi.routeJobRequest4: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FlinkDashboardApi();
$jobId = jobId_example; // String | 
$body = body_example; // String | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FlinkDashboardApi->new();
my $jobId = jobId_example; # String | 
my $body = WWW::OPenAPIClient::Object::String->new(); # String | 

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

# Create an instance of the API class
api_instance = openapi_client.FlinkDashboardApi()
jobId = jobId_example # String |  (default to null)
body = body_example # String |  (optional)

try:
    api_response = api_instance.route_job_request4(jobId, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FlinkDashboardApi->routeJobRequest4: %s\n" % e)
extern crate FlinkDashboardApi;

pub fn main() {
    let jobId = jobId_example; // String
    let body = body_example; // String

    let mut context = FlinkDashboardApi::Context::default();
    let result = client.routeJobRequest4(jobId, body, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

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

Responses


routeJobRequest5


/ui/flink/jobs/{jobId}/**

Usage and SDK Samples

curl -X HEAD \
 -H "Accept: */*" \
 -H "Content-Type: application/json" \
 "http://localhost/ui/flink/jobs/{jobId}/**" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FlinkDashboardApi;

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

public class FlinkDashboardApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        FlinkDashboardApi apiInstance = new FlinkDashboardApi();
        String jobId = jobId_example; // String | 
        String body = body_example; // String | 

        try {
            'String' result = apiInstance.routeJobRequest5(jobId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FlinkDashboardApi#routeJobRequest5");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String jobId = new String(); // String | 
final String body = new String(); // String | 

try {
    final result = await api_instance.routeJobRequest5(jobId, body);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->routeJobRequest5: $e\n');
}

import org.openapitools.client.api.FlinkDashboardApi;

public class FlinkDashboardApiExample {
    public static void main(String[] args) {
        FlinkDashboardApi apiInstance = new FlinkDashboardApi();
        String jobId = jobId_example; // String | 
        String body = body_example; // String | 

        try {
            'String' result = apiInstance.routeJobRequest5(jobId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FlinkDashboardApi#routeJobRequest5");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
FlinkDashboardApi *apiInstance = [[FlinkDashboardApi alloc] init];
String *jobId = jobId_example; //  (default to null)
String *body = body_example; //  (optional)

[apiInstance routeJobRequest5With:jobId
    body:body
              completionHandler: ^('String' output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.FlinkDashboardApi()
var jobId = jobId_example; // {String} 
var opts = {
  'body': body_example // {String} 
};

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

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

            // Create an instance of the API class
            var apiInstance = new FlinkDashboardApi();
            var jobId = jobId_example;  // String |  (default to null)
            var body = body_example;  // String |  (optional) 

            try {
                'String' result = apiInstance.routeJobRequest5(jobId, body);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FlinkDashboardApi.routeJobRequest5: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FlinkDashboardApi();
$jobId = jobId_example; // String | 
$body = body_example; // String | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FlinkDashboardApi->new();
my $jobId = jobId_example; # String | 
my $body = WWW::OPenAPIClient::Object::String->new(); # String | 

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

# Create an instance of the API class
api_instance = openapi_client.FlinkDashboardApi()
jobId = jobId_example # String |  (default to null)
body = body_example # String |  (optional)

try:
    api_response = api_instance.route_job_request5(jobId, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FlinkDashboardApi->routeJobRequest5: %s\n" % e)
extern crate FlinkDashboardApi;

pub fn main() {
    let jobId = jobId_example; // String
    let body = body_example; // String

    let mut context = FlinkDashboardApi::Context::default();
    let result = client.routeJobRequest5(jobId, body, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

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

Responses


routeJobRequest6


/ui/flink/jobs/{jobId}/**

Usage and SDK Samples

curl -X OPTIONS \
 -H "Accept: */*" \
 -H "Content-Type: application/json" \
 "http://localhost/ui/flink/jobs/{jobId}/**" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FlinkDashboardApi;

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

public class FlinkDashboardApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        FlinkDashboardApi apiInstance = new FlinkDashboardApi();
        String jobId = jobId_example; // String | 
        String body = body_example; // String | 

        try {
            'String' result = apiInstance.routeJobRequest6(jobId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FlinkDashboardApi#routeJobRequest6");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String jobId = new String(); // String | 
final String body = new String(); // String | 

try {
    final result = await api_instance.routeJobRequest6(jobId, body);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->routeJobRequest6: $e\n');
}

import org.openapitools.client.api.FlinkDashboardApi;

public class FlinkDashboardApiExample {
    public static void main(String[] args) {
        FlinkDashboardApi apiInstance = new FlinkDashboardApi();
        String jobId = jobId_example; // String | 
        String body = body_example; // String | 

        try {
            'String' result = apiInstance.routeJobRequest6(jobId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FlinkDashboardApi#routeJobRequest6");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
FlinkDashboardApi *apiInstance = [[FlinkDashboardApi alloc] init];
String *jobId = jobId_example; //  (default to null)
String *body = body_example; //  (optional)

[apiInstance routeJobRequest6With:jobId
    body:body
              completionHandler: ^('String' output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.FlinkDashboardApi()
var jobId = jobId_example; // {String} 
var opts = {
  'body': body_example // {String} 
};

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

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

            // Create an instance of the API class
            var apiInstance = new FlinkDashboardApi();
            var jobId = jobId_example;  // String |  (default to null)
            var body = body_example;  // String |  (optional) 

            try {
                'String' result = apiInstance.routeJobRequest6(jobId, body);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FlinkDashboardApi.routeJobRequest6: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FlinkDashboardApi();
$jobId = jobId_example; // String | 
$body = body_example; // String | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FlinkDashboardApi->new();
my $jobId = jobId_example; # String | 
my $body = WWW::OPenAPIClient::Object::String->new(); # String | 

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

# Create an instance of the API class
api_instance = openapi_client.FlinkDashboardApi()
jobId = jobId_example # String |  (default to null)
body = body_example # String |  (optional)

try:
    api_response = api_instance.route_job_request6(jobId, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FlinkDashboardApi->routeJobRequest6: %s\n" % e)
extern crate FlinkDashboardApi;

pub fn main() {
    let jobId = jobId_example; // String
    let body = body_example; // String

    let mut context = FlinkDashboardApi::Context::default();
    let result = client.routeJobRequest6(jobId, body, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

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

Responses


routeTaskRequest


/ui/flink/taskmanagers/{tmId}/**

Usage and SDK Samples

curl -X GET \
 -H "Accept: */*" \
 "http://localhost/ui/flink/taskmanagers/{tmId}/**"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FlinkDashboardApi;

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

public class FlinkDashboardApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        FlinkDashboardApi apiInstance = new FlinkDashboardApi();
        String tmId = tmId_example; // String | 

        try {
            'String' result = apiInstance.routeTaskRequest(tmId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FlinkDashboardApi#routeTaskRequest");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String tmId = new String(); // String | 

try {
    final result = await api_instance.routeTaskRequest(tmId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->routeTaskRequest: $e\n');
}

import org.openapitools.client.api.FlinkDashboardApi;

public class FlinkDashboardApiExample {
    public static void main(String[] args) {
        FlinkDashboardApi apiInstance = new FlinkDashboardApi();
        String tmId = tmId_example; // String | 

        try {
            'String' result = apiInstance.routeTaskRequest(tmId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FlinkDashboardApi#routeTaskRequest");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
FlinkDashboardApi *apiInstance = [[FlinkDashboardApi alloc] init];
String *tmId = tmId_example; //  (default to null)

[apiInstance routeTaskRequestWith:tmId
              completionHandler: ^('String' output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.FlinkDashboardApi()
var tmId = tmId_example; // {String} 

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

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

            // Create an instance of the API class
            var apiInstance = new FlinkDashboardApi();
            var tmId = tmId_example;  // String |  (default to null)

            try {
                'String' result = apiInstance.routeTaskRequest(tmId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FlinkDashboardApi.routeTaskRequest: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FlinkDashboardApi();
$tmId = tmId_example; // String | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FlinkDashboardApi->new();
my $tmId = tmId_example; # String | 

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

# Create an instance of the API class
api_instance = openapi_client.FlinkDashboardApi()
tmId = tmId_example # String |  (default to null)

try:
    api_response = api_instance.route_task_request(tmId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FlinkDashboardApi->routeTaskRequest: %s\n" % e)
extern crate FlinkDashboardApi;

pub fn main() {
    let tmId = tmId_example; // String

    let mut context = FlinkDashboardApi::Context::default();
    let result = client.routeTaskRequest(tmId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
tmId*
String
Required

Responses


routeTaskRequest1


/ui/flink/taskmanagers/{tmId}/**

Usage and SDK Samples

curl -X POST \
 -H "Accept: */*" \
 "http://localhost/ui/flink/taskmanagers/{tmId}/**"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FlinkDashboardApi;

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

public class FlinkDashboardApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        FlinkDashboardApi apiInstance = new FlinkDashboardApi();
        String tmId = tmId_example; // String | 

        try {
            'String' result = apiInstance.routeTaskRequest1(tmId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FlinkDashboardApi#routeTaskRequest1");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String tmId = new String(); // String | 

try {
    final result = await api_instance.routeTaskRequest1(tmId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->routeTaskRequest1: $e\n');
}

import org.openapitools.client.api.FlinkDashboardApi;

public class FlinkDashboardApiExample {
    public static void main(String[] args) {
        FlinkDashboardApi apiInstance = new FlinkDashboardApi();
        String tmId = tmId_example; // String | 

        try {
            'String' result = apiInstance.routeTaskRequest1(tmId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FlinkDashboardApi#routeTaskRequest1");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
FlinkDashboardApi *apiInstance = [[FlinkDashboardApi alloc] init];
String *tmId = tmId_example; //  (default to null)

[apiInstance routeTaskRequest1With:tmId
              completionHandler: ^('String' output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.FlinkDashboardApi()
var tmId = tmId_example; // {String} 

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

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

            // Create an instance of the API class
            var apiInstance = new FlinkDashboardApi();
            var tmId = tmId_example;  // String |  (default to null)

            try {
                'String' result = apiInstance.routeTaskRequest1(tmId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FlinkDashboardApi.routeTaskRequest1: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FlinkDashboardApi();
$tmId = tmId_example; // String | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FlinkDashboardApi->new();
my $tmId = tmId_example; # String | 

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

# Create an instance of the API class
api_instance = openapi_client.FlinkDashboardApi()
tmId = tmId_example # String |  (default to null)

try:
    api_response = api_instance.route_task_request1(tmId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FlinkDashboardApi->routeTaskRequest1: %s\n" % e)
extern crate FlinkDashboardApi;

pub fn main() {
    let tmId = tmId_example; // String

    let mut context = FlinkDashboardApi::Context::default();
    let result = client.routeTaskRequest1(tmId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
tmId*
String
Required

Responses


routeTaskRequest2


/ui/flink/taskmanagers/{tmId}/**

Usage and SDK Samples

curl -X PUT \
 -H "Accept: */*" \
 "http://localhost/ui/flink/taskmanagers/{tmId}/**"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FlinkDashboardApi;

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

public class FlinkDashboardApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        FlinkDashboardApi apiInstance = new FlinkDashboardApi();
        String tmId = tmId_example; // String | 

        try {
            'String' result = apiInstance.routeTaskRequest2(tmId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FlinkDashboardApi#routeTaskRequest2");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String tmId = new String(); // String | 

try {
    final result = await api_instance.routeTaskRequest2(tmId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->routeTaskRequest2: $e\n');
}

import org.openapitools.client.api.FlinkDashboardApi;

public class FlinkDashboardApiExample {
    public static void main(String[] args) {
        FlinkDashboardApi apiInstance = new FlinkDashboardApi();
        String tmId = tmId_example; // String | 

        try {
            'String' result = apiInstance.routeTaskRequest2(tmId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FlinkDashboardApi#routeTaskRequest2");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
FlinkDashboardApi *apiInstance = [[FlinkDashboardApi alloc] init];
String *tmId = tmId_example; //  (default to null)

[apiInstance routeTaskRequest2With:tmId
              completionHandler: ^('String' output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.FlinkDashboardApi()
var tmId = tmId_example; // {String} 

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

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

            // Create an instance of the API class
            var apiInstance = new FlinkDashboardApi();
            var tmId = tmId_example;  // String |  (default to null)

            try {
                'String' result = apiInstance.routeTaskRequest2(tmId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FlinkDashboardApi.routeTaskRequest2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FlinkDashboardApi();
$tmId = tmId_example; // String | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FlinkDashboardApi->new();
my $tmId = tmId_example; # String | 

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

# Create an instance of the API class
api_instance = openapi_client.FlinkDashboardApi()
tmId = tmId_example # String |  (default to null)

try:
    api_response = api_instance.route_task_request2(tmId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FlinkDashboardApi->routeTaskRequest2: %s\n" % e)
extern crate FlinkDashboardApi;

pub fn main() {
    let tmId = tmId_example; // String

    let mut context = FlinkDashboardApi::Context::default();
    let result = client.routeTaskRequest2(tmId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
tmId*
String
Required

Responses


routeTaskRequest3


/ui/flink/taskmanagers/{tmId}/**

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: */*" \
 "http://localhost/ui/flink/taskmanagers/{tmId}/**"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FlinkDashboardApi;

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

public class FlinkDashboardApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        FlinkDashboardApi apiInstance = new FlinkDashboardApi();
        String tmId = tmId_example; // String | 

        try {
            'String' result = apiInstance.routeTaskRequest3(tmId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FlinkDashboardApi#routeTaskRequest3");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String tmId = new String(); // String | 

try {
    final result = await api_instance.routeTaskRequest3(tmId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->routeTaskRequest3: $e\n');
}

import org.openapitools.client.api.FlinkDashboardApi;

public class FlinkDashboardApiExample {
    public static void main(String[] args) {
        FlinkDashboardApi apiInstance = new FlinkDashboardApi();
        String tmId = tmId_example; // String | 

        try {
            'String' result = apiInstance.routeTaskRequest3(tmId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FlinkDashboardApi#routeTaskRequest3");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
FlinkDashboardApi *apiInstance = [[FlinkDashboardApi alloc] init];
String *tmId = tmId_example; //  (default to null)

[apiInstance routeTaskRequest3With:tmId
              completionHandler: ^('String' output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.FlinkDashboardApi()
var tmId = tmId_example; // {String} 

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

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

            // Create an instance of the API class
            var apiInstance = new FlinkDashboardApi();
            var tmId = tmId_example;  // String |  (default to null)

            try {
                'String' result = apiInstance.routeTaskRequest3(tmId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FlinkDashboardApi.routeTaskRequest3: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FlinkDashboardApi();
$tmId = tmId_example; // String | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FlinkDashboardApi->new();
my $tmId = tmId_example; # String | 

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

# Create an instance of the API class
api_instance = openapi_client.FlinkDashboardApi()
tmId = tmId_example # String |  (default to null)

try:
    api_response = api_instance.route_task_request3(tmId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FlinkDashboardApi->routeTaskRequest3: %s\n" % e)
extern crate FlinkDashboardApi;

pub fn main() {
    let tmId = tmId_example; // String

    let mut context = FlinkDashboardApi::Context::default();
    let result = client.routeTaskRequest3(tmId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
tmId*
String
Required

Responses


routeTaskRequest4


/ui/flink/taskmanagers/{tmId}/**

Usage and SDK Samples

curl -X PATCH \
 -H "Accept: */*" \
 "http://localhost/ui/flink/taskmanagers/{tmId}/**"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FlinkDashboardApi;

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

public class FlinkDashboardApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        FlinkDashboardApi apiInstance = new FlinkDashboardApi();
        String tmId = tmId_example; // String | 

        try {
            'String' result = apiInstance.routeTaskRequest4(tmId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FlinkDashboardApi#routeTaskRequest4");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String tmId = new String(); // String | 

try {
    final result = await api_instance.routeTaskRequest4(tmId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->routeTaskRequest4: $e\n');
}

import org.openapitools.client.api.FlinkDashboardApi;

public class FlinkDashboardApiExample {
    public static void main(String[] args) {
        FlinkDashboardApi apiInstance = new FlinkDashboardApi();
        String tmId = tmId_example; // String | 

        try {
            'String' result = apiInstance.routeTaskRequest4(tmId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FlinkDashboardApi#routeTaskRequest4");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
FlinkDashboardApi *apiInstance = [[FlinkDashboardApi alloc] init];
String *tmId = tmId_example; //  (default to null)

[apiInstance routeTaskRequest4With:tmId
              completionHandler: ^('String' output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.FlinkDashboardApi()
var tmId = tmId_example; // {String} 

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

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

            // Create an instance of the API class
            var apiInstance = new FlinkDashboardApi();
            var tmId = tmId_example;  // String |  (default to null)

            try {
                'String' result = apiInstance.routeTaskRequest4(tmId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FlinkDashboardApi.routeTaskRequest4: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FlinkDashboardApi();
$tmId = tmId_example; // String | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FlinkDashboardApi->new();
my $tmId = tmId_example; # String | 

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

# Create an instance of the API class
api_instance = openapi_client.FlinkDashboardApi()
tmId = tmId_example # String |  (default to null)

try:
    api_response = api_instance.route_task_request4(tmId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FlinkDashboardApi->routeTaskRequest4: %s\n" % e)
extern crate FlinkDashboardApi;

pub fn main() {
    let tmId = tmId_example; // String

    let mut context = FlinkDashboardApi::Context::default();
    let result = client.routeTaskRequest4(tmId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
tmId*
String
Required

Responses


routeTaskRequest5


/ui/flink/taskmanagers/{tmId}/**

Usage and SDK Samples

curl -X HEAD \
 -H "Accept: */*" \
 "http://localhost/ui/flink/taskmanagers/{tmId}/**"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FlinkDashboardApi;

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

public class FlinkDashboardApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        FlinkDashboardApi apiInstance = new FlinkDashboardApi();
        String tmId = tmId_example; // String | 

        try {
            'String' result = apiInstance.routeTaskRequest5(tmId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FlinkDashboardApi#routeTaskRequest5");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String tmId = new String(); // String | 

try {
    final result = await api_instance.routeTaskRequest5(tmId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->routeTaskRequest5: $e\n');
}

import org.openapitools.client.api.FlinkDashboardApi;

public class FlinkDashboardApiExample {
    public static void main(String[] args) {
        FlinkDashboardApi apiInstance = new FlinkDashboardApi();
        String tmId = tmId_example; // String | 

        try {
            'String' result = apiInstance.routeTaskRequest5(tmId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FlinkDashboardApi#routeTaskRequest5");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
FlinkDashboardApi *apiInstance = [[FlinkDashboardApi alloc] init];
String *tmId = tmId_example; //  (default to null)

[apiInstance routeTaskRequest5With:tmId
              completionHandler: ^('String' output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.FlinkDashboardApi()
var tmId = tmId_example; // {String} 

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

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

            // Create an instance of the API class
            var apiInstance = new FlinkDashboardApi();
            var tmId = tmId_example;  // String |  (default to null)

            try {
                'String' result = apiInstance.routeTaskRequest5(tmId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FlinkDashboardApi.routeTaskRequest5: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FlinkDashboardApi();
$tmId = tmId_example; // String | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FlinkDashboardApi->new();
my $tmId = tmId_example; # String | 

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

# Create an instance of the API class
api_instance = openapi_client.FlinkDashboardApi()
tmId = tmId_example # String |  (default to null)

try:
    api_response = api_instance.route_task_request5(tmId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FlinkDashboardApi->routeTaskRequest5: %s\n" % e)
extern crate FlinkDashboardApi;

pub fn main() {
    let tmId = tmId_example; // String

    let mut context = FlinkDashboardApi::Context::default();
    let result = client.routeTaskRequest5(tmId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
tmId*
String
Required

Responses


routeTaskRequest6


/ui/flink/taskmanagers/{tmId}/**

Usage and SDK Samples

curl -X OPTIONS \
 -H "Accept: */*" \
 "http://localhost/ui/flink/taskmanagers/{tmId}/**"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FlinkDashboardApi;

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

public class FlinkDashboardApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        FlinkDashboardApi apiInstance = new FlinkDashboardApi();
        String tmId = tmId_example; // String | 

        try {
            'String' result = apiInstance.routeTaskRequest6(tmId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FlinkDashboardApi#routeTaskRequest6");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String tmId = new String(); // String | 

try {
    final result = await api_instance.routeTaskRequest6(tmId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->routeTaskRequest6: $e\n');
}

import org.openapitools.client.api.FlinkDashboardApi;

public class FlinkDashboardApiExample {
    public static void main(String[] args) {
        FlinkDashboardApi apiInstance = new FlinkDashboardApi();
        String tmId = tmId_example; // String | 

        try {
            'String' result = apiInstance.routeTaskRequest6(tmId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FlinkDashboardApi#routeTaskRequest6");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
FlinkDashboardApi *apiInstance = [[FlinkDashboardApi alloc] init];
String *tmId = tmId_example; //  (default to null)

[apiInstance routeTaskRequest6With:tmId
              completionHandler: ^('String' output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.FlinkDashboardApi()
var tmId = tmId_example; // {String} 

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

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

            // Create an instance of the API class
            var apiInstance = new FlinkDashboardApi();
            var tmId = tmId_example;  // String |  (default to null)

            try {
                'String' result = apiInstance.routeTaskRequest6(tmId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FlinkDashboardApi.routeTaskRequest6: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FlinkDashboardApi();
$tmId = tmId_example; // String | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FlinkDashboardApi->new();
my $tmId = tmId_example; # String | 

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

# Create an instance of the API class
api_instance = openapi_client.FlinkDashboardApi()
tmId = tmId_example # String |  (default to null)

try:
    api_response = api_instance.route_task_request6(tmId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FlinkDashboardApi->routeTaskRequest6: %s\n" % e)
extern crate FlinkDashboardApi;

pub fn main() {
    let tmId = tmId_example; // String

    let mut context = FlinkDashboardApi::Context::default();
    let result = client.routeTaskRequest6(tmId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
tmId*
String
Required

Responses


FlinkJobOperations

run

Run a Flink job from an uploaded artifact.


/api/v2/projects/{projectId}/flink/run

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost/api/v2/projects/{projectId}/flink/run" \
 -d '{
  "configuration" : {
    "key" : "configuration"
  },
  "run_parameters" : "",
  "artifacts" : [ "artifacts", "artifacts", "artifacts", "artifacts", "artifacts" ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FlinkJobOperationsApi;

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

public class FlinkJobOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        FlinkJobOperationsApi apiInstance = new FlinkJobOperationsApi();
        String projectId = projectId_example; // String | 
        FlinkRunRequest flinkRunRequest = ; // FlinkRunRequest | 

        try {
            JarRunResponse result = apiInstance.run(projectId, flinkRunRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FlinkJobOperationsApi#run");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String projectId = new String(); // String | 
final FlinkRunRequest flinkRunRequest = new FlinkRunRequest(); // FlinkRunRequest | 

try {
    final result = await api_instance.run(projectId, flinkRunRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->run: $e\n');
}

import org.openapitools.client.api.FlinkJobOperationsApi;

public class FlinkJobOperationsApiExample {
    public static void main(String[] args) {
        FlinkJobOperationsApi apiInstance = new FlinkJobOperationsApi();
        String projectId = projectId_example; // String | 
        FlinkRunRequest flinkRunRequest = ; // FlinkRunRequest | 

        try {
            JarRunResponse result = apiInstance.run(projectId, flinkRunRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FlinkJobOperationsApi#run");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
FlinkJobOperationsApi *apiInstance = [[FlinkJobOperationsApi alloc] init];
String *projectId = projectId_example; //  (default to null)
FlinkRunRequest *flinkRunRequest = ; // 

// Run a Flink job from an uploaded artifact.
[apiInstance runWith:projectId
    flinkRunRequest:flinkRunRequest
              completionHandler: ^(JarRunResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.FlinkJobOperationsApi()
var projectId = projectId_example; // {String} 
var flinkRunRequest = ; // {FlinkRunRequest} 

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

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

            // Create an instance of the API class
            var apiInstance = new FlinkJobOperationsApi();
            var projectId = projectId_example;  // String |  (default to null)
            var flinkRunRequest = new FlinkRunRequest(); // FlinkRunRequest | 

            try {
                // Run a Flink job from an uploaded artifact.
                JarRunResponse result = apiInstance.run(projectId, flinkRunRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FlinkJobOperationsApi.run: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FlinkJobOperationsApi();
$projectId = projectId_example; // String | 
$flinkRunRequest = ; // FlinkRunRequest | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FlinkJobOperationsApi->new();
my $projectId = projectId_example; # String | 
my $flinkRunRequest = WWW::OPenAPIClient::Object::FlinkRunRequest->new(); # FlinkRunRequest | 

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

# Create an instance of the API class
api_instance = openapi_client.FlinkJobOperationsApi()
projectId = projectId_example # String |  (default to null)
flinkRunRequest =  # FlinkRunRequest | 

try:
    # Run a Flink job from an uploaded artifact.
    api_response = api_instance.run(projectId, flinkRunRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FlinkJobOperationsApi->run: %s\n" % e)
extern crate FlinkJobOperationsApi;

pub fn main() {
    let projectId = projectId_example; // String
    let flinkRunRequest = ; // FlinkRunRequest

    let mut context = FlinkJobOperationsApi::Context::default();
    let result = client.run(projectId, flinkRunRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
projectId*
String
Required
Body parameters
Name Description
flinkRunRequest *

Responses


FlinkSessionClusterOperations

getFlinkSessionByUserV2

Returns Flink session properties.


/api/v2/flink/session-cluster

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/api/v2/flink/session-cluster"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FlinkSessionClusterOperationsApi;

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

public class FlinkSessionClusterOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        FlinkSessionClusterOperationsApi apiInstance = new FlinkSessionClusterOperationsApi();

        try {
            FlinkSession result = apiInstance.getFlinkSessionByUserV2();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FlinkSessionClusterOperationsApi#getFlinkSessionByUserV2");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();


try {
    final result = await api_instance.getFlinkSessionByUserV2();
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getFlinkSessionByUserV2: $e\n');
}

import org.openapitools.client.api.FlinkSessionClusterOperationsApi;

public class FlinkSessionClusterOperationsApiExample {
    public static void main(String[] args) {
        FlinkSessionClusterOperationsApi apiInstance = new FlinkSessionClusterOperationsApi();

        try {
            FlinkSession result = apiInstance.getFlinkSessionByUserV2();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FlinkSessionClusterOperationsApi#getFlinkSessionByUserV2");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
FlinkSessionClusterOperationsApi *apiInstance = [[FlinkSessionClusterOperationsApi alloc] init];

// Returns Flink session properties.
[apiInstance getFlinkSessionByUserV2WithCompletionHandler: 
              ^(FlinkSession output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.FlinkSessionClusterOperationsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getFlinkSessionByUserV2(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new FlinkSessionClusterOperationsApi();

            try {
                // Returns Flink session properties.
                FlinkSession result = apiInstance.getFlinkSessionByUserV2();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FlinkSessionClusterOperationsApi.getFlinkSessionByUserV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FlinkSessionClusterOperationsApi();

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FlinkSessionClusterOperationsApi->new();

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

# Create an instance of the API class
api_instance = openapi_client.FlinkSessionClusterOperationsApi()

try:
    # Returns Flink session properties.
    api_response = api_instance.get_flink_session_by_user_v2()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FlinkSessionClusterOperationsApi->getFlinkSessionByUserV2: %s\n" % e)
extern crate FlinkSessionClusterOperationsApi;

pub fn main() {

    let mut context = FlinkSessionClusterOperationsApi::Context::default();
    let result = client.getFlinkSessionByUserV2(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


provideFlinkSessionV2

Ensures the Flink session exists and returns session properties.


/api/v2/flink/session-cluster

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 "http://localhost/api/v2/flink/session-cluster"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FlinkSessionClusterOperationsApi;

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

public class FlinkSessionClusterOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        FlinkSessionClusterOperationsApi apiInstance = new FlinkSessionClusterOperationsApi();

        try {
            FlinkStatusDto result = apiInstance.provideFlinkSessionV2();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FlinkSessionClusterOperationsApi#provideFlinkSessionV2");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();


try {
    final result = await api_instance.provideFlinkSessionV2();
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->provideFlinkSessionV2: $e\n');
}

import org.openapitools.client.api.FlinkSessionClusterOperationsApi;

public class FlinkSessionClusterOperationsApiExample {
    public static void main(String[] args) {
        FlinkSessionClusterOperationsApi apiInstance = new FlinkSessionClusterOperationsApi();

        try {
            FlinkStatusDto result = apiInstance.provideFlinkSessionV2();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FlinkSessionClusterOperationsApi#provideFlinkSessionV2");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
FlinkSessionClusterOperationsApi *apiInstance = [[FlinkSessionClusterOperationsApi alloc] init];

// Ensures the Flink session exists and returns session properties.
[apiInstance provideFlinkSessionV2WithCompletionHandler: 
              ^(FlinkStatusDto output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.FlinkSessionClusterOperationsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.provideFlinkSessionV2(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new FlinkSessionClusterOperationsApi();

            try {
                // Ensures the Flink session exists and returns session properties.
                FlinkStatusDto result = apiInstance.provideFlinkSessionV2();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FlinkSessionClusterOperationsApi.provideFlinkSessionV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FlinkSessionClusterOperationsApi();

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FlinkSessionClusterOperationsApi->new();

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

# Create an instance of the API class
api_instance = openapi_client.FlinkSessionClusterOperationsApi()

try:
    # Ensures the Flink session exists and returns session properties.
    api_response = api_instance.provide_flink_session_v2()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FlinkSessionClusterOperationsApi->provideFlinkSessionV2: %s\n" % e)
extern crate FlinkSessionClusterOperationsApi;

pub fn main() {

    let mut context = FlinkSessionClusterOperationsApi::Context::default();
    let result = client.provideFlinkSessionV2(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


stopSessionCluster

Stops the running Flink Session Cluster of the user.


/api/v2/flink/session-cluster/stop

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 "http://localhost/api/v2/flink/session-cluster/stop"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FlinkSessionClusterOperationsApi;

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

public class FlinkSessionClusterOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        FlinkSessionClusterOperationsApi apiInstance = new FlinkSessionClusterOperationsApi();

        try {
            apiInstance.stopSessionCluster();
        } catch (ApiException e) {
            System.err.println("Exception when calling FlinkSessionClusterOperationsApi#stopSessionCluster");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();


try {
    final result = await api_instance.stopSessionCluster();
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->stopSessionCluster: $e\n');
}

import org.openapitools.client.api.FlinkSessionClusterOperationsApi;

public class FlinkSessionClusterOperationsApiExample {
    public static void main(String[] args) {
        FlinkSessionClusterOperationsApi apiInstance = new FlinkSessionClusterOperationsApi();

        try {
            apiInstance.stopSessionCluster();
        } catch (ApiException e) {
            System.err.println("Exception when calling FlinkSessionClusterOperationsApi#stopSessionCluster");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
FlinkSessionClusterOperationsApi *apiInstance = [[FlinkSessionClusterOperationsApi alloc] init];

// Stops the running Flink Session Cluster of the user.
[apiInstance stopSessionClusterWithCompletionHandler: 
              ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.FlinkSessionClusterOperationsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.stopSessionCluster(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new FlinkSessionClusterOperationsApi();

            try {
                // Stops the running Flink Session Cluster of the user.
                apiInstance.stopSessionCluster();
            } catch (Exception e) {
                Debug.Print("Exception when calling FlinkSessionClusterOperationsApi.stopSessionCluster: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FlinkSessionClusterOperationsApi();

try {
    $api_instance->stopSessionCluster();
} catch (Exception $e) {
    echo 'Exception when calling FlinkSessionClusterOperationsApi->stopSessionCluster: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FlinkSessionClusterOperationsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FlinkSessionClusterOperationsApi->new();

eval {
    $api_instance->stopSessionCluster();
};
if ($@) {
    warn "Exception when calling FlinkSessionClusterOperationsApi->stopSessionCluster: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.FlinkSessionClusterOperationsApi()

try:
    # Stops the running Flink Session Cluster of the user.
    api_instance.stop_session_cluster()
except ApiException as e:
    print("Exception when calling FlinkSessionClusterOperationsApi->stopSessionCluster: %s\n" % e)
extern crate FlinkSessionClusterOperationsApi;

pub fn main() {

    let mut context = FlinkSessionClusterOperationsApi::Context::default();
    let result = client.stopSessionCluster(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


GlobalConfigurationOperations

bulkUpdateGlobalConfig

Bulk updates global configurations.


/api/v1/global-configs/bulk-update

Usage and SDK Samples

curl -X PUT \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost/api/v1/global-configs/bulk-update" \
 -d '{
  "config_value" : "config_value",
  "config_key" : "config_key"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.GlobalConfigurationOperationsApi;

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

public class GlobalConfigurationOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        GlobalConfigurationOperationsApi apiInstance = new GlobalConfigurationOperationsApi();
        array[GlobalConfigUpdateDto] globalConfigUpdateDto = ; // array[GlobalConfigUpdateDto] | 

        try {
            array[GlobalConfigUpdateDto] result = apiInstance.bulkUpdateGlobalConfig(globalConfigUpdateDto);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GlobalConfigurationOperationsApi#bulkUpdateGlobalConfig");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final array[GlobalConfigUpdateDto] globalConfigUpdateDto = new array[GlobalConfigUpdateDto](); // array[GlobalConfigUpdateDto] | 

try {
    final result = await api_instance.bulkUpdateGlobalConfig(globalConfigUpdateDto);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->bulkUpdateGlobalConfig: $e\n');
}

import org.openapitools.client.api.GlobalConfigurationOperationsApi;

public class GlobalConfigurationOperationsApiExample {
    public static void main(String[] args) {
        GlobalConfigurationOperationsApi apiInstance = new GlobalConfigurationOperationsApi();
        array[GlobalConfigUpdateDto] globalConfigUpdateDto = ; // array[GlobalConfigUpdateDto] | 

        try {
            array[GlobalConfigUpdateDto] result = apiInstance.bulkUpdateGlobalConfig(globalConfigUpdateDto);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GlobalConfigurationOperationsApi#bulkUpdateGlobalConfig");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
GlobalConfigurationOperationsApi *apiInstance = [[GlobalConfigurationOperationsApi alloc] init];
array[GlobalConfigUpdateDto] *globalConfigUpdateDto = ; // 

// Bulk updates global configurations.
[apiInstance bulkUpdateGlobalConfigWith:globalConfigUpdateDto
              completionHandler: ^(array[GlobalConfigUpdateDto] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.GlobalConfigurationOperationsApi()
var globalConfigUpdateDto = ; // {array[GlobalConfigUpdateDto]} 

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

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

            // Create an instance of the API class
            var apiInstance = new GlobalConfigurationOperationsApi();
            var globalConfigUpdateDto = new array[GlobalConfigUpdateDto](); // array[GlobalConfigUpdateDto] | 

            try {
                // Bulk updates global configurations.
                array[GlobalConfigUpdateDto] result = apiInstance.bulkUpdateGlobalConfig(globalConfigUpdateDto);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling GlobalConfigurationOperationsApi.bulkUpdateGlobalConfig: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\GlobalConfigurationOperationsApi();
$globalConfigUpdateDto = ; // array[GlobalConfigUpdateDto] | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::GlobalConfigurationOperationsApi->new();
my $globalConfigUpdateDto = [WWW::OPenAPIClient::Object::array[GlobalConfigUpdateDto]->new()]; # array[GlobalConfigUpdateDto] | 

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

# Create an instance of the API class
api_instance = openapi_client.GlobalConfigurationOperationsApi()
globalConfigUpdateDto =  # array[GlobalConfigUpdateDto] | 

try:
    # Bulk updates global configurations.
    api_response = api_instance.bulk_update_global_config(globalConfigUpdateDto)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GlobalConfigurationOperationsApi->bulkUpdateGlobalConfig: %s\n" % e)
extern crate GlobalConfigurationOperationsApi;

pub fn main() {
    let globalConfigUpdateDto = ; // array[GlobalConfigUpdateDto]

    let mut context = GlobalConfigurationOperationsApi::Context::default();
    let result = client.bulkUpdateGlobalConfig(globalConfigUpdateDto, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
globalConfigUpdateDto *

Responses


bulkUpdateGlobalConfig1

Bulk updates global configurations.


/api/v2/global-configs/bulk-update

Usage and SDK Samples

curl -X PUT \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost/api/v2/global-configs/bulk-update" \
 -d '{
  "config_value" : "config_value",
  "config_key" : "config_key"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.GlobalConfigurationOperationsApi;

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

public class GlobalConfigurationOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        GlobalConfigurationOperationsApi apiInstance = new GlobalConfigurationOperationsApi();
        array[GlobalConfigUpdateDto] globalConfigUpdateDto = ; // array[GlobalConfigUpdateDto] | 

        try {
            array[GlobalConfigUpdateDto] result = apiInstance.bulkUpdateGlobalConfig1(globalConfigUpdateDto);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GlobalConfigurationOperationsApi#bulkUpdateGlobalConfig1");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final array[GlobalConfigUpdateDto] globalConfigUpdateDto = new array[GlobalConfigUpdateDto](); // array[GlobalConfigUpdateDto] | 

try {
    final result = await api_instance.bulkUpdateGlobalConfig1(globalConfigUpdateDto);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->bulkUpdateGlobalConfig1: $e\n');
}

import org.openapitools.client.api.GlobalConfigurationOperationsApi;

public class GlobalConfigurationOperationsApiExample {
    public static void main(String[] args) {
        GlobalConfigurationOperationsApi apiInstance = new GlobalConfigurationOperationsApi();
        array[GlobalConfigUpdateDto] globalConfigUpdateDto = ; // array[GlobalConfigUpdateDto] | 

        try {
            array[GlobalConfigUpdateDto] result = apiInstance.bulkUpdateGlobalConfig1(globalConfigUpdateDto);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GlobalConfigurationOperationsApi#bulkUpdateGlobalConfig1");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
GlobalConfigurationOperationsApi *apiInstance = [[GlobalConfigurationOperationsApi alloc] init];
array[GlobalConfigUpdateDto] *globalConfigUpdateDto = ; // 

// Bulk updates global configurations.
[apiInstance bulkUpdateGlobalConfig1With:globalConfigUpdateDto
              completionHandler: ^(array[GlobalConfigUpdateDto] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.GlobalConfigurationOperationsApi()
var globalConfigUpdateDto = ; // {array[GlobalConfigUpdateDto]} 

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

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

            // Create an instance of the API class
            var apiInstance = new GlobalConfigurationOperationsApi();
            var globalConfigUpdateDto = new array[GlobalConfigUpdateDto](); // array[GlobalConfigUpdateDto] | 

            try {
                // Bulk updates global configurations.
                array[GlobalConfigUpdateDto] result = apiInstance.bulkUpdateGlobalConfig1(globalConfigUpdateDto);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling GlobalConfigurationOperationsApi.bulkUpdateGlobalConfig1: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\GlobalConfigurationOperationsApi();
$globalConfigUpdateDto = ; // array[GlobalConfigUpdateDto] | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::GlobalConfigurationOperationsApi->new();
my $globalConfigUpdateDto = [WWW::OPenAPIClient::Object::array[GlobalConfigUpdateDto]->new()]; # array[GlobalConfigUpdateDto] | 

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

# Create an instance of the API class
api_instance = openapi_client.GlobalConfigurationOperationsApi()
globalConfigUpdateDto =  # array[GlobalConfigUpdateDto] | 

try:
    # Bulk updates global configurations.
    api_response = api_instance.bulk_update_global_config1(globalConfigUpdateDto)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GlobalConfigurationOperationsApi->bulkUpdateGlobalConfig1: %s\n" % e)
extern crate GlobalConfigurationOperationsApi;

pub fn main() {
    let globalConfigUpdateDto = ; // array[GlobalConfigUpdateDto]

    let mut context = GlobalConfigurationOperationsApi::Context::default();
    let result = client.bulkUpdateGlobalConfig1(globalConfigUpdateDto, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
globalConfigUpdateDto *

Responses


getAllGlobalConfig

Retrieves all global configurations.


/api/v2/global-configs

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/api/v2/global-configs?prefix=prefix_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.GlobalConfigurationOperationsApi;

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

public class GlobalConfigurationOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        GlobalConfigurationOperationsApi apiInstance = new GlobalConfigurationOperationsApi();
        String prefix = prefix_example; // String | 

        try {
            array[GlobalConfigDto] result = apiInstance.getAllGlobalConfig(prefix);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GlobalConfigurationOperationsApi#getAllGlobalConfig");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String prefix = new String(); // String | 

try {
    final result = await api_instance.getAllGlobalConfig(prefix);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getAllGlobalConfig: $e\n');
}

import org.openapitools.client.api.GlobalConfigurationOperationsApi;

public class GlobalConfigurationOperationsApiExample {
    public static void main(String[] args) {
        GlobalConfigurationOperationsApi apiInstance = new GlobalConfigurationOperationsApi();
        String prefix = prefix_example; // String | 

        try {
            array[GlobalConfigDto] result = apiInstance.getAllGlobalConfig(prefix);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GlobalConfigurationOperationsApi#getAllGlobalConfig");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
GlobalConfigurationOperationsApi *apiInstance = [[GlobalConfigurationOperationsApi alloc] init];
String *prefix = prefix_example; //  (optional) (default to null)

// Retrieves all global configurations.
[apiInstance getAllGlobalConfigWith:prefix
              completionHandler: ^(array[GlobalConfigDto] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.GlobalConfigurationOperationsApi()
var opts = {
  'prefix': prefix_example // {String} 
};

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

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

            // Create an instance of the API class
            var apiInstance = new GlobalConfigurationOperationsApi();
            var prefix = prefix_example;  // String |  (optional)  (default to null)

            try {
                // Retrieves all global configurations.
                array[GlobalConfigDto] result = apiInstance.getAllGlobalConfig(prefix);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling GlobalConfigurationOperationsApi.getAllGlobalConfig: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\GlobalConfigurationOperationsApi();
$prefix = prefix_example; // String | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::GlobalConfigurationOperationsApi->new();
my $prefix = prefix_example; # String | 

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

# Create an instance of the API class
api_instance = openapi_client.GlobalConfigurationOperationsApi()
prefix = prefix_example # String |  (optional) (default to null)

try:
    # Retrieves all global configurations.
    api_response = api_instance.get_all_global_config(prefix=prefix)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GlobalConfigurationOperationsApi->getAllGlobalConfig: %s\n" % e)
extern crate GlobalConfigurationOperationsApi;

pub fn main() {
    let prefix = prefix_example; // String

    let mut context = GlobalConfigurationOperationsApi::Context::default();
    let result = client.getAllGlobalConfig(prefix, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
prefix
String

Responses


getAllGlobalConfig1

Retrieves all global configurations.


/api/v1/global-configs

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/api/v1/global-configs?prefix=prefix_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.GlobalConfigurationOperationsApi;

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

public class GlobalConfigurationOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        GlobalConfigurationOperationsApi apiInstance = new GlobalConfigurationOperationsApi();
        String prefix = prefix_example; // String | 

        try {
            array[GlobalConfigDto] result = apiInstance.getAllGlobalConfig1(prefix);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GlobalConfigurationOperationsApi#getAllGlobalConfig1");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String prefix = new String(); // String | 

try {
    final result = await api_instance.getAllGlobalConfig1(prefix);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getAllGlobalConfig1: $e\n');
}

import org.openapitools.client.api.GlobalConfigurationOperationsApi;

public class GlobalConfigurationOperationsApiExample {
    public static void main(String[] args) {
        GlobalConfigurationOperationsApi apiInstance = new GlobalConfigurationOperationsApi();
        String prefix = prefix_example; // String | 

        try {
            array[GlobalConfigDto] result = apiInstance.getAllGlobalConfig1(prefix);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GlobalConfigurationOperationsApi#getAllGlobalConfig1");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
GlobalConfigurationOperationsApi *apiInstance = [[GlobalConfigurationOperationsApi alloc] init];
String *prefix = prefix_example; //  (optional) (default to null)

// Retrieves all global configurations.
[apiInstance getAllGlobalConfig1With:prefix
              completionHandler: ^(array[GlobalConfigDto] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.GlobalConfigurationOperationsApi()
var opts = {
  'prefix': prefix_example // {String} 
};

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

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

            // Create an instance of the API class
            var apiInstance = new GlobalConfigurationOperationsApi();
            var prefix = prefix_example;  // String |  (optional)  (default to null)

            try {
                // Retrieves all global configurations.
                array[GlobalConfigDto] result = apiInstance.getAllGlobalConfig1(prefix);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling GlobalConfigurationOperationsApi.getAllGlobalConfig1: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\GlobalConfigurationOperationsApi();
$prefix = prefix_example; // String | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::GlobalConfigurationOperationsApi->new();
my $prefix = prefix_example; # String | 

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

# Create an instance of the API class
api_instance = openapi_client.GlobalConfigurationOperationsApi()
prefix = prefix_example # String |  (optional) (default to null)

try:
    # Retrieves all global configurations.
    api_response = api_instance.get_all_global_config1(prefix=prefix)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GlobalConfigurationOperationsApi->getAllGlobalConfig1: %s\n" % e)
extern crate GlobalConfigurationOperationsApi;

pub fn main() {
    let prefix = prefix_example; // String

    let mut context = GlobalConfigurationOperationsApi::Context::default();
    let result = client.getAllGlobalConfig1(prefix, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
prefix
String

Responses


getGlobalConfigValue

Retrieves the global configuration of the given config key.


/api/v1/global-configs/{key}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/api/v1/global-configs/{key}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.GlobalConfigurationOperationsApi;

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

public class GlobalConfigurationOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        GlobalConfigurationOperationsApi apiInstance = new GlobalConfigurationOperationsApi();
        String key = key_example; // String | 

        try {
            GlobalConfigDto result = apiInstance.getGlobalConfigValue(key);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GlobalConfigurationOperationsApi#getGlobalConfigValue");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String key = new String(); // String | 

try {
    final result = await api_instance.getGlobalConfigValue(key);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getGlobalConfigValue: $e\n');
}

import org.openapitools.client.api.GlobalConfigurationOperationsApi;

public class GlobalConfigurationOperationsApiExample {
    public static void main(String[] args) {
        GlobalConfigurationOperationsApi apiInstance = new GlobalConfigurationOperationsApi();
        String key = key_example; // String | 

        try {
            GlobalConfigDto result = apiInstance.getGlobalConfigValue(key);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GlobalConfigurationOperationsApi#getGlobalConfigValue");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
GlobalConfigurationOperationsApi *apiInstance = [[GlobalConfigurationOperationsApi alloc] init];
String *key = key_example; //  (default to null)

// Retrieves the global configuration of the given config key.
[apiInstance getGlobalConfigValueWith:key
              completionHandler: ^(GlobalConfigDto output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.GlobalConfigurationOperationsApi()
var key = key_example; // {String} 

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

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

            // Create an instance of the API class
            var apiInstance = new GlobalConfigurationOperationsApi();
            var key = key_example;  // String |  (default to null)

            try {
                // Retrieves the global configuration of the given config key.
                GlobalConfigDto result = apiInstance.getGlobalConfigValue(key);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling GlobalConfigurationOperationsApi.getGlobalConfigValue: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\GlobalConfigurationOperationsApi();
$key = key_example; // String | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::GlobalConfigurationOperationsApi->new();
my $key = key_example; # String | 

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

# Create an instance of the API class
api_instance = openapi_client.GlobalConfigurationOperationsApi()
key = key_example # String |  (default to null)

try:
    # Retrieves the global configuration of the given config key.
    api_response = api_instance.get_global_config_value(key)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GlobalConfigurationOperationsApi->getGlobalConfigValue: %s\n" % e)
extern crate GlobalConfigurationOperationsApi;

pub fn main() {
    let key = key_example; // String

    let mut context = GlobalConfigurationOperationsApi::Context::default();
    let result = client.getGlobalConfigValue(key, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
key*
String
Required

Responses


getGlobalConfigValue1

Retrieves the global configuration of the given config key.


/api/v2/global-configs/{key}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/api/v2/global-configs/{key}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.GlobalConfigurationOperationsApi;

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

public class GlobalConfigurationOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        GlobalConfigurationOperationsApi apiInstance = new GlobalConfigurationOperationsApi();
        String key = key_example; // String | 

        try {
            GlobalConfigDto result = apiInstance.getGlobalConfigValue1(key);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GlobalConfigurationOperationsApi#getGlobalConfigValue1");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String key = new String(); // String | 

try {
    final result = await api_instance.getGlobalConfigValue1(key);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getGlobalConfigValue1: $e\n');
}

import org.openapitools.client.api.GlobalConfigurationOperationsApi;

public class GlobalConfigurationOperationsApiExample {
    public static void main(String[] args) {
        GlobalConfigurationOperationsApi apiInstance = new GlobalConfigurationOperationsApi();
        String key = key_example; // String | 

        try {
            GlobalConfigDto result = apiInstance.getGlobalConfigValue1(key);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GlobalConfigurationOperationsApi#getGlobalConfigValue1");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
GlobalConfigurationOperationsApi *apiInstance = [[GlobalConfigurationOperationsApi alloc] init];
String *key = key_example; //  (default to null)

// Retrieves the global configuration of the given config key.
[apiInstance getGlobalConfigValue1With:key
              completionHandler: ^(GlobalConfigDto output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.GlobalConfigurationOperationsApi()
var key = key_example; // {String} 

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

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

            // Create an instance of the API class
            var apiInstance = new GlobalConfigurationOperationsApi();
            var key = key_example;  // String |  (default to null)

            try {
                // Retrieves the global configuration of the given config key.
                GlobalConfigDto result = apiInstance.getGlobalConfigValue1(key);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling GlobalConfigurationOperationsApi.getGlobalConfigValue1: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\GlobalConfigurationOperationsApi();
$key = key_example; // String | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::GlobalConfigurationOperationsApi->new();
my $key = key_example; # String | 

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

# Create an instance of the API class
api_instance = openapi_client.GlobalConfigurationOperationsApi()
key = key_example # String |  (default to null)

try:
    # Retrieves the global configuration of the given config key.
    api_response = api_instance.get_global_config_value1(key)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GlobalConfigurationOperationsApi->getGlobalConfigValue1: %s\n" % e)
extern crate GlobalConfigurationOperationsApi;

pub fn main() {
    let key = key_example; // String

    let mut context = GlobalConfigurationOperationsApi::Context::default();
    let result = client.getGlobalConfigValue1(key, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
key*
String
Required

Responses


updateGlobalConfig

Updates a global configuration.


/api/v2/global-configs

Usage and SDK Samples

curl -X PUT \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost/api/v2/global-configs" \
 -d '{
  "config_value" : "config_value",
  "config_key" : "config_key"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.GlobalConfigurationOperationsApi;

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

public class GlobalConfigurationOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        GlobalConfigurationOperationsApi apiInstance = new GlobalConfigurationOperationsApi();
        GlobalConfigUpdateDto globalConfigUpdateDto = ; // GlobalConfigUpdateDto | 

        try {
            GlobalConfigUpdateDto result = apiInstance.updateGlobalConfig(globalConfigUpdateDto);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GlobalConfigurationOperationsApi#updateGlobalConfig");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final GlobalConfigUpdateDto globalConfigUpdateDto = new GlobalConfigUpdateDto(); // GlobalConfigUpdateDto | 

try {
    final result = await api_instance.updateGlobalConfig(globalConfigUpdateDto);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateGlobalConfig: $e\n');
}

import org.openapitools.client.api.GlobalConfigurationOperationsApi;

public class GlobalConfigurationOperationsApiExample {
    public static void main(String[] args) {
        GlobalConfigurationOperationsApi apiInstance = new GlobalConfigurationOperationsApi();
        GlobalConfigUpdateDto globalConfigUpdateDto = ; // GlobalConfigUpdateDto | 

        try {
            GlobalConfigUpdateDto result = apiInstance.updateGlobalConfig(globalConfigUpdateDto);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GlobalConfigurationOperationsApi#updateGlobalConfig");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
GlobalConfigurationOperationsApi *apiInstance = [[GlobalConfigurationOperationsApi alloc] init];
GlobalConfigUpdateDto *globalConfigUpdateDto = ; // 

// Updates a global configuration.
[apiInstance updateGlobalConfigWith:globalConfigUpdateDto
              completionHandler: ^(GlobalConfigUpdateDto output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.GlobalConfigurationOperationsApi()
var globalConfigUpdateDto = ; // {GlobalConfigUpdateDto} 

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

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

            // Create an instance of the API class
            var apiInstance = new GlobalConfigurationOperationsApi();
            var globalConfigUpdateDto = new GlobalConfigUpdateDto(); // GlobalConfigUpdateDto | 

            try {
                // Updates a global configuration.
                GlobalConfigUpdateDto result = apiInstance.updateGlobalConfig(globalConfigUpdateDto);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling GlobalConfigurationOperationsApi.updateGlobalConfig: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\GlobalConfigurationOperationsApi();
$globalConfigUpdateDto = ; // GlobalConfigUpdateDto | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::GlobalConfigurationOperationsApi->new();
my $globalConfigUpdateDto = WWW::OPenAPIClient::Object::GlobalConfigUpdateDto->new(); # GlobalConfigUpdateDto | 

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

# Create an instance of the API class
api_instance = openapi_client.GlobalConfigurationOperationsApi()
globalConfigUpdateDto =  # GlobalConfigUpdateDto | 

try:
    # Updates a global configuration.
    api_response = api_instance.update_global_config(globalConfigUpdateDto)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GlobalConfigurationOperationsApi->updateGlobalConfig: %s\n" % e)
extern crate GlobalConfigurationOperationsApi;

pub fn main() {
    let globalConfigUpdateDto = ; // GlobalConfigUpdateDto

    let mut context = GlobalConfigurationOperationsApi::Context::default();
    let result = client.updateGlobalConfig(globalConfigUpdateDto, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
globalConfigUpdateDto *

Responses


updateGlobalConfig1

Updates a global configuration.


/api/v1/global-configs

Usage and SDK Samples

curl -X PUT \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost/api/v1/global-configs" \
 -d '{
  "config_value" : "config_value",
  "config_key" : "config_key"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.GlobalConfigurationOperationsApi;

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

public class GlobalConfigurationOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        GlobalConfigurationOperationsApi apiInstance = new GlobalConfigurationOperationsApi();
        GlobalConfigUpdateDto globalConfigUpdateDto = ; // GlobalConfigUpdateDto | 

        try {
            GlobalConfigUpdateDto result = apiInstance.updateGlobalConfig1(globalConfigUpdateDto);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GlobalConfigurationOperationsApi#updateGlobalConfig1");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final GlobalConfigUpdateDto globalConfigUpdateDto = new GlobalConfigUpdateDto(); // GlobalConfigUpdateDto | 

try {
    final result = await api_instance.updateGlobalConfig1(globalConfigUpdateDto);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateGlobalConfig1: $e\n');
}

import org.openapitools.client.api.GlobalConfigurationOperationsApi;

public class GlobalConfigurationOperationsApiExample {
    public static void main(String[] args) {
        GlobalConfigurationOperationsApi apiInstance = new GlobalConfigurationOperationsApi();
        GlobalConfigUpdateDto globalConfigUpdateDto = ; // GlobalConfigUpdateDto | 

        try {
            GlobalConfigUpdateDto result = apiInstance.updateGlobalConfig1(globalConfigUpdateDto);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GlobalConfigurationOperationsApi#updateGlobalConfig1");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
GlobalConfigurationOperationsApi *apiInstance = [[GlobalConfigurationOperationsApi alloc] init];
GlobalConfigUpdateDto *globalConfigUpdateDto = ; // 

// Updates a global configuration.
[apiInstance updateGlobalConfig1With:globalConfigUpdateDto
              completionHandler: ^(GlobalConfigUpdateDto output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.GlobalConfigurationOperationsApi()
var globalConfigUpdateDto = ; // {GlobalConfigUpdateDto} 

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

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

            // Create an instance of the API class
            var apiInstance = new GlobalConfigurationOperationsApi();
            var globalConfigUpdateDto = new GlobalConfigUpdateDto(); // GlobalConfigUpdateDto | 

            try {
                // Updates a global configuration.
                GlobalConfigUpdateDto result = apiInstance.updateGlobalConfig1(globalConfigUpdateDto);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling GlobalConfigurationOperationsApi.updateGlobalConfig1: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\GlobalConfigurationOperationsApi();
$globalConfigUpdateDto = ; // GlobalConfigUpdateDto | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::GlobalConfigurationOperationsApi->new();
my $globalConfigUpdateDto = WWW::OPenAPIClient::Object::GlobalConfigUpdateDto->new(); # GlobalConfigUpdateDto | 

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

# Create an instance of the API class
api_instance = openapi_client.GlobalConfigurationOperationsApi()
globalConfigUpdateDto =  # GlobalConfigUpdateDto | 

try:
    # Updates a global configuration.
    api_response = api_instance.update_global_config1(globalConfigUpdateDto)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GlobalConfigurationOperationsApi->updateGlobalConfig1: %s\n" % e)
extern crate GlobalConfigurationOperationsApi;

pub fn main() {
    let globalConfigUpdateDto = ; // GlobalConfigUpdateDto

    let mut context = GlobalConfigurationOperationsApi::Context::default();
    let result = client.updateGlobalConfig1(globalConfigUpdateDto, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
globalConfigUpdateDto *

Responses


validateSamplingGlobalConfig

Validates sampling Kafka global configurations.


/api/v2/global-configs/validate-sampling

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost/api/v2/global-configs/validate-sampling" \
 -d '{
  "config_value" : "config_value",
  "config_key" : "config_key"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.GlobalConfigurationOperationsApi;

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

public class GlobalConfigurationOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        GlobalConfigurationOperationsApi apiInstance = new GlobalConfigurationOperationsApi();
        array[GlobalConfigUpdateDto] globalConfigUpdateDto = ; // array[GlobalConfigUpdateDto] | 

        try {
            ValidateSamplingResponse result = apiInstance.validateSamplingGlobalConfig(globalConfigUpdateDto);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GlobalConfigurationOperationsApi#validateSamplingGlobalConfig");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final array[GlobalConfigUpdateDto] globalConfigUpdateDto = new array[GlobalConfigUpdateDto](); // array[GlobalConfigUpdateDto] | 

try {
    final result = await api_instance.validateSamplingGlobalConfig(globalConfigUpdateDto);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->validateSamplingGlobalConfig: $e\n');
}

import org.openapitools.client.api.GlobalConfigurationOperationsApi;

public class GlobalConfigurationOperationsApiExample {
    public static void main(String[] args) {
        GlobalConfigurationOperationsApi apiInstance = new GlobalConfigurationOperationsApi();
        array[GlobalConfigUpdateDto] globalConfigUpdateDto = ; // array[GlobalConfigUpdateDto] | 

        try {
            ValidateSamplingResponse result = apiInstance.validateSamplingGlobalConfig(globalConfigUpdateDto);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GlobalConfigurationOperationsApi#validateSamplingGlobalConfig");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
GlobalConfigurationOperationsApi *apiInstance = [[GlobalConfigurationOperationsApi alloc] init];
array[GlobalConfigUpdateDto] *globalConfigUpdateDto = ; // 

// Validates sampling Kafka global configurations.
[apiInstance validateSamplingGlobalConfigWith:globalConfigUpdateDto
              completionHandler: ^(ValidateSamplingResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.GlobalConfigurationOperationsApi()
var globalConfigUpdateDto = ; // {array[GlobalConfigUpdateDto]} 

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

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

            // Create an instance of the API class
            var apiInstance = new GlobalConfigurationOperationsApi();
            var globalConfigUpdateDto = new array[GlobalConfigUpdateDto](); // array[GlobalConfigUpdateDto] | 

            try {
                // Validates sampling Kafka global configurations.
                ValidateSamplingResponse result = apiInstance.validateSamplingGlobalConfig(globalConfigUpdateDto);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling GlobalConfigurationOperationsApi.validateSamplingGlobalConfig: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\GlobalConfigurationOperationsApi();
$globalConfigUpdateDto = ; // array[GlobalConfigUpdateDto] | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::GlobalConfigurationOperationsApi->new();
my $globalConfigUpdateDto = [WWW::OPenAPIClient::Object::array[GlobalConfigUpdateDto]->new()]; # array[GlobalConfigUpdateDto] | 

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

# Create an instance of the API class
api_instance = openapi_client.GlobalConfigurationOperationsApi()
globalConfigUpdateDto =  # array[GlobalConfigUpdateDto] | 

try:
    # Validates sampling Kafka global configurations.
    api_response = api_instance.validate_sampling_global_config(globalConfigUpdateDto)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GlobalConfigurationOperationsApi->validateSamplingGlobalConfig: %s\n" % e)
extern crate GlobalConfigurationOperationsApi;

pub fn main() {
    let globalConfigUpdateDto = ; // array[GlobalConfigUpdateDto]

    let mut context = GlobalConfigurationOperationsApi::Context::default();
    let result = client.validateSamplingGlobalConfig(globalConfigUpdateDto, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
globalConfigUpdateDto *

Responses


validateSamplingGlobalConfig1

Validates sampling Kafka global configurations.


/api/v1/global-configs/validate-sampling

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost/api/v1/global-configs/validate-sampling" \
 -d '{
  "config_value" : "config_value",
  "config_key" : "config_key"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.GlobalConfigurationOperationsApi;

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

public class GlobalConfigurationOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        GlobalConfigurationOperationsApi apiInstance = new GlobalConfigurationOperationsApi();
        array[GlobalConfigUpdateDto] globalConfigUpdateDto = ; // array[GlobalConfigUpdateDto] | 

        try {
            ValidateSamplingResponse result = apiInstance.validateSamplingGlobalConfig1(globalConfigUpdateDto);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GlobalConfigurationOperationsApi#validateSamplingGlobalConfig1");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final array[GlobalConfigUpdateDto] globalConfigUpdateDto = new array[GlobalConfigUpdateDto](); // array[GlobalConfigUpdateDto] | 

try {
    final result = await api_instance.validateSamplingGlobalConfig1(globalConfigUpdateDto);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->validateSamplingGlobalConfig1: $e\n');
}

import org.openapitools.client.api.GlobalConfigurationOperationsApi;

public class GlobalConfigurationOperationsApiExample {
    public static void main(String[] args) {
        GlobalConfigurationOperationsApi apiInstance = new GlobalConfigurationOperationsApi();
        array[GlobalConfigUpdateDto] globalConfigUpdateDto = ; // array[GlobalConfigUpdateDto] | 

        try {
            ValidateSamplingResponse result = apiInstance.validateSamplingGlobalConfig1(globalConfigUpdateDto);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GlobalConfigurationOperationsApi#validateSamplingGlobalConfig1");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
GlobalConfigurationOperationsApi *apiInstance = [[GlobalConfigurationOperationsApi alloc] init];
array[GlobalConfigUpdateDto] *globalConfigUpdateDto = ; // 

// Validates sampling Kafka global configurations.
[apiInstance validateSamplingGlobalConfig1With:globalConfigUpdateDto
              completionHandler: ^(ValidateSamplingResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.GlobalConfigurationOperationsApi()
var globalConfigUpdateDto = ; // {array[GlobalConfigUpdateDto]} 

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

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

            // Create an instance of the API class
            var apiInstance = new GlobalConfigurationOperationsApi();
            var globalConfigUpdateDto = new array[GlobalConfigUpdateDto](); // array[GlobalConfigUpdateDto] | 

            try {
                // Validates sampling Kafka global configurations.
                ValidateSamplingResponse result = apiInstance.validateSamplingGlobalConfig1(globalConfigUpdateDto);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling GlobalConfigurationOperationsApi.validateSamplingGlobalConfig1: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\GlobalConfigurationOperationsApi();
$globalConfigUpdateDto = ; // array[GlobalConfigUpdateDto] | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::GlobalConfigurationOperationsApi->new();
my $globalConfigUpdateDto = [WWW::OPenAPIClient::Object::array[GlobalConfigUpdateDto]->new()]; # array[GlobalConfigUpdateDto] | 

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

# Create an instance of the API class
api_instance = openapi_client.GlobalConfigurationOperationsApi()
globalConfigUpdateDto =  # array[GlobalConfigUpdateDto] | 

try:
    # Validates sampling Kafka global configurations.
    api_response = api_instance.validate_sampling_global_config1(globalConfigUpdateDto)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GlobalConfigurationOperationsApi->validateSamplingGlobalConfig1: %s\n" % e)
extern crate GlobalConfigurationOperationsApi;

pub fn main() {
    let globalConfigUpdateDto = ; // array[GlobalConfigUpdateDto]

    let mut context = GlobalConfigurationOperationsApi::Context::default();
    let result = client.validateSamplingGlobalConfig1(globalConfigUpdateDto, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
globalConfigUpdateDto *

Responses


Heartbeat

heartbeat


/api/v2/heartbeat

Usage and SDK Samples

curl -X GET \
 "http://localhost/api/v2/heartbeat"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.HeartbeatApi;

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

public class HeartbeatApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        HeartbeatApi apiInstance = new HeartbeatApi();

        try {
            apiInstance.heartbeat();
        } catch (ApiException e) {
            System.err.println("Exception when calling HeartbeatApi#heartbeat");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();


try {
    final result = await api_instance.heartbeat();
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->heartbeat: $e\n');
}

import org.openapitools.client.api.HeartbeatApi;

public class HeartbeatApiExample {
    public static void main(String[] args) {
        HeartbeatApi apiInstance = new HeartbeatApi();

        try {
            apiInstance.heartbeat();
        } catch (ApiException e) {
            System.err.println("Exception when calling HeartbeatApi#heartbeat");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
HeartbeatApi *apiInstance = [[HeartbeatApi alloc] init];

[apiInstance heartbeatWithCompletionHandler: 
              ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.HeartbeatApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.heartbeat(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new HeartbeatApi();

            try {
                apiInstance.heartbeat();
            } catch (Exception e) {
                Debug.Print("Exception when calling HeartbeatApi.heartbeat: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\HeartbeatApi();

try {
    $api_instance->heartbeat();
} catch (Exception $e) {
    echo 'Exception when calling HeartbeatApi->heartbeat: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::HeartbeatApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::HeartbeatApi->new();

eval {
    $api_instance->heartbeat();
};
if ($@) {
    warn "Exception when calling HeartbeatApi->heartbeat: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.HeartbeatApi()

try:
    api_instance.heartbeat()
except ApiException as e:
    print("Exception when calling HeartbeatApi->heartbeat: %s\n" % e)
extern crate HeartbeatApi;

pub fn main() {

    let mut context = HeartbeatApi::Context::default();
    let result = client.heartbeat(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


HistoryController

deleteHistoryAllByProjectId


/internal/history

Usage and SDK Samples

curl -X DELETE \
 "http://localhost/internal/history?project_id=projectId_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.HistoryControllerApi;

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

public class HistoryControllerApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        HistoryControllerApi apiInstance = new HistoryControllerApi();
        String projectId = projectId_example; // String | 

        try {
            apiInstance.deleteHistoryAllByProjectId(projectId);
        } catch (ApiException e) {
            System.err.println("Exception when calling HistoryControllerApi#deleteHistoryAllByProjectId");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String projectId = new String(); // String | 

try {
    final result = await api_instance.deleteHistoryAllByProjectId(projectId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteHistoryAllByProjectId: $e\n');
}

import org.openapitools.client.api.HistoryControllerApi;

public class HistoryControllerApiExample {
    public static void main(String[] args) {
        HistoryControllerApi apiInstance = new HistoryControllerApi();
        String projectId = projectId_example; // String | 

        try {
            apiInstance.deleteHistoryAllByProjectId(projectId);
        } catch (ApiException e) {
            System.err.println("Exception when calling HistoryControllerApi#deleteHistoryAllByProjectId");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
HistoryControllerApi *apiInstance = [[HistoryControllerApi alloc] init];
String *projectId = projectId_example; //  (default to null)

[apiInstance deleteHistoryAllByProjectIdWith:projectId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.HistoryControllerApi()
var projectId = projectId_example; // {String} 

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

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

            // Create an instance of the API class
            var apiInstance = new HistoryControllerApi();
            var projectId = projectId_example;  // String |  (default to null)

            try {
                apiInstance.deleteHistoryAllByProjectId(projectId);
            } catch (Exception e) {
                Debug.Print("Exception when calling HistoryControllerApi.deleteHistoryAllByProjectId: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\HistoryControllerApi();
$projectId = projectId_example; // String | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::HistoryControllerApi->new();
my $projectId = projectId_example; # String | 

eval {
    $api_instance->deleteHistoryAllByProjectId(projectId => $projectId);
};
if ($@) {
    warn "Exception when calling HistoryControllerApi->deleteHistoryAllByProjectId: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.HistoryControllerApi()
projectId = projectId_example # String |  (default to null)

try:
    api_instance.delete_history_all_by_project_id(projectId)
except ApiException as e:
    print("Exception when calling HistoryControllerApi->deleteHistoryAllByProjectId: %s\n" % e)
extern crate HistoryControllerApi;

pub fn main() {
    let projectId = projectId_example; // String

    let mut context = HistoryControllerApi::Context::default();
    let result = client.deleteHistoryAllByProjectId(projectId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
project_id*
String
Required

Responses


deleteHistoryById


/internal/history/{id}

Usage and SDK Samples

curl -X DELETE \
 "http://localhost/internal/history/{id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.HistoryControllerApi;

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

public class HistoryControllerApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        HistoryControllerApi apiInstance = new HistoryControllerApi();
        Integer id = 56; // Integer | 

        try {
            apiInstance.deleteHistoryById(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling HistoryControllerApi#deleteHistoryById");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 

try {
    final result = await api_instance.deleteHistoryById(id);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteHistoryById: $e\n');
}

import org.openapitools.client.api.HistoryControllerApi;

public class HistoryControllerApiExample {
    public static void main(String[] args) {
        HistoryControllerApi apiInstance = new HistoryControllerApi();
        Integer id = 56; // Integer | 

        try {
            apiInstance.deleteHistoryById(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling HistoryControllerApi#deleteHistoryById");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
HistoryControllerApi *apiInstance = [[HistoryControllerApi alloc] init];
Integer *id = 56; //  (default to null)

[apiInstance deleteHistoryByIdWith:id
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.HistoryControllerApi()
var id = 56; // {Integer} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteHistoryById(id, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new HistoryControllerApi();
            var id = 56;  // Integer |  (default to null)

            try {
                apiInstance.deleteHistoryById(id);
            } catch (Exception e) {
                Debug.Print("Exception when calling HistoryControllerApi.deleteHistoryById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\HistoryControllerApi();
$id = 56; // Integer | 

try {
    $api_instance->deleteHistoryById($id);
} catch (Exception $e) {
    echo 'Exception when calling HistoryControllerApi->deleteHistoryById: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::HistoryControllerApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::HistoryControllerApi->new();
my $id = 56; # Integer | 

eval {
    $api_instance->deleteHistoryById(id => $id);
};
if ($@) {
    warn "Exception when calling HistoryControllerApi->deleteHistoryById: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.HistoryControllerApi()
id = 56 # Integer |  (default to null)

try:
    api_instance.delete_history_by_id(id)
except ApiException as e:
    print("Exception when calling HistoryControllerApi->deleteHistoryById: %s\n" % e)
extern crate HistoryControllerApi;

pub fn main() {
    let id = 56; // Integer

    let mut context = HistoryControllerApi::Context::default();
    let result = client.deleteHistoryById(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required

Responses


getItemsForProject


/internal/history

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/internal/history"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.HistoryControllerApi;

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

public class HistoryControllerApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        HistoryControllerApi apiInstance = new HistoryControllerApi();

        try {
            array[HistoryItemDto] result = apiInstance.getItemsForProject();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HistoryControllerApi#getItemsForProject");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();


try {
    final result = await api_instance.getItemsForProject();
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getItemsForProject: $e\n');
}

import org.openapitools.client.api.HistoryControllerApi;

public class HistoryControllerApiExample {
    public static void main(String[] args) {
        HistoryControllerApi apiInstance = new HistoryControllerApi();

        try {
            array[HistoryItemDto] result = apiInstance.getItemsForProject();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HistoryControllerApi#getItemsForProject");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
HistoryControllerApi *apiInstance = [[HistoryControllerApi alloc] init];

[apiInstance getItemsForProjectWithCompletionHandler: 
              ^(array[HistoryItemDto] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.HistoryControllerApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getItemsForProject(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new HistoryControllerApi();

            try {
                array[HistoryItemDto] result = apiInstance.getItemsForProject();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling HistoryControllerApi.getItemsForProject: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\HistoryControllerApi();

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::HistoryControllerApi->new();

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

# Create an instance of the API class
api_instance = openapi_client.HistoryControllerApi()

try:
    api_response = api_instance.get_items_for_project()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling HistoryControllerApi->getItemsForProject: %s\n" % e)
extern crate HistoryControllerApi;

pub fn main() {

    let mut context = HistoryControllerApi::Context::default();
    let result = client.getItemsForProject(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


JobNotificationActionOperations

addToJobNotificationGroupV2

Adds a Notification Action or Group to a Notification Group


/api/v2/projects/{projectId}/notification-actions/groups/{groupId}/child/{childId}

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 "http://localhost/api/v2/projects/{projectId}/notification-actions/groups/{groupId}/child/{childId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.JobNotificationActionOperationsApi;

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

public class JobNotificationActionOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        JobNotificationActionOperationsApi apiInstance = new JobNotificationActionOperationsApi();
        Integer groupId = 56; // Integer | 
        Integer childId = 56; // Integer | 
        String projectId = projectId_example; // String | 

        try {
            NotificationGroupResponse result = apiInstance.addToJobNotificationGroupV2(groupId, childId, projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobNotificationActionOperationsApi#addToJobNotificationGroupV2");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer groupId = new Integer(); // Integer | 
final Integer childId = new Integer(); // Integer | 
final String projectId = new String(); // String | 

try {
    final result = await api_instance.addToJobNotificationGroupV2(groupId, childId, projectId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->addToJobNotificationGroupV2: $e\n');
}

import org.openapitools.client.api.JobNotificationActionOperationsApi;

public class JobNotificationActionOperationsApiExample {
    public static void main(String[] args) {
        JobNotificationActionOperationsApi apiInstance = new JobNotificationActionOperationsApi();
        Integer groupId = 56; // Integer | 
        Integer childId = 56; // Integer | 
        String projectId = projectId_example; // String | 

        try {
            NotificationGroupResponse result = apiInstance.addToJobNotificationGroupV2(groupId, childId, projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobNotificationActionOperationsApi#addToJobNotificationGroupV2");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
JobNotificationActionOperationsApi *apiInstance = [[JobNotificationActionOperationsApi alloc] init];
Integer *groupId = 56; //  (default to null)
Integer *childId = 56; //  (default to null)
String *projectId = projectId_example; //  (default to null)

// Adds a Notification Action or Group to a Notification Group
[apiInstance addToJobNotificationGroupV2With:groupId
    childId:childId
    projectId:projectId
              completionHandler: ^(NotificationGroupResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.JobNotificationActionOperationsApi()
var groupId = 56; // {Integer} 
var childId = 56; // {Integer} 
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.addToJobNotificationGroupV2(groupId, childId, projectId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new JobNotificationActionOperationsApi();
            var groupId = 56;  // Integer |  (default to null)
            var childId = 56;  // Integer |  (default to null)
            var projectId = projectId_example;  // String |  (default to null)

            try {
                // Adds a Notification Action or Group to a Notification Group
                NotificationGroupResponse result = apiInstance.addToJobNotificationGroupV2(groupId, childId, projectId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling JobNotificationActionOperationsApi.addToJobNotificationGroupV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\JobNotificationActionOperationsApi();
$groupId = 56; // Integer | 
$childId = 56; // Integer | 
$projectId = projectId_example; // String | 

try {
    $result = $api_instance->addToJobNotificationGroupV2($groupId, $childId, $projectId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling JobNotificationActionOperationsApi->addToJobNotificationGroupV2: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::JobNotificationActionOperationsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::JobNotificationActionOperationsApi->new();
my $groupId = 56; # Integer | 
my $childId = 56; # Integer | 
my $projectId = projectId_example; # String | 

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

# Create an instance of the API class
api_instance = openapi_client.JobNotificationActionOperationsApi()
groupId = 56 # Integer |  (default to null)
childId = 56 # Integer |  (default to null)
projectId = projectId_example # String |  (default to null)

try:
    # Adds a Notification Action or Group to a Notification Group
    api_response = api_instance.add_to_job_notification_group_v2(groupId, childId, projectId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling JobNotificationActionOperationsApi->addToJobNotificationGroupV2: %s\n" % e)
extern crate JobNotificationActionOperationsApi;

pub fn main() {
    let groupId = 56; // Integer
    let childId = 56; // Integer
    let projectId = projectId_example; // String

    let mut context = JobNotificationActionOperationsApi::Context::default();
    let result = client.addToJobNotificationGroupV2(groupId, childId, projectId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
groupId*
Integer (int32)
Required
childId*
Integer (int32)
Required
projectId*
String
Required

Responses


createJobNotificationGroupV2

Creates a new Job Notification Group.


/api/v2/projects/{projectId}/notification-actions/groups

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost/api/v2/projects/{projectId}/notification-actions/groups" \
 -d '{
  "children" : [ 0, 0 ],
  "name" : "name"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.JobNotificationActionOperationsApi;

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

public class JobNotificationActionOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        JobNotificationActionOperationsApi apiInstance = new JobNotificationActionOperationsApi();
        String projectId = projectId_example; // String | 
        CreateNotificationGroupRequest createNotificationGroupRequest = ; // CreateNotificationGroupRequest | 

        try {
            NotificationGroupResponse result = apiInstance.createJobNotificationGroupV2(projectId, createNotificationGroupRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobNotificationActionOperationsApi#createJobNotificationGroupV2");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String projectId = new String(); // String | 
final CreateNotificationGroupRequest createNotificationGroupRequest = new CreateNotificationGroupRequest(); // CreateNotificationGroupRequest | 

try {
    final result = await api_instance.createJobNotificationGroupV2(projectId, createNotificationGroupRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->createJobNotificationGroupV2: $e\n');
}

import org.openapitools.client.api.JobNotificationActionOperationsApi;

public class JobNotificationActionOperationsApiExample {
    public static void main(String[] args) {
        JobNotificationActionOperationsApi apiInstance = new JobNotificationActionOperationsApi();
        String projectId = projectId_example; // String | 
        CreateNotificationGroupRequest createNotificationGroupRequest = ; // CreateNotificationGroupRequest | 

        try {
            NotificationGroupResponse result = apiInstance.createJobNotificationGroupV2(projectId, createNotificationGroupRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobNotificationActionOperationsApi#createJobNotificationGroupV2");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
JobNotificationActionOperationsApi *apiInstance = [[JobNotificationActionOperationsApi alloc] init];
String *projectId = projectId_example; //  (default to null)
CreateNotificationGroupRequest *createNotificationGroupRequest = ; // 

// Creates a new Job Notification Group.
[apiInstance createJobNotificationGroupV2With:projectId
    createNotificationGroupRequest:createNotificationGroupRequest
              completionHandler: ^(NotificationGroupResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.JobNotificationActionOperationsApi()
var projectId = projectId_example; // {String} 
var createNotificationGroupRequest = ; // {CreateNotificationGroupRequest} 

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

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

            // Create an instance of the API class
            var apiInstance = new JobNotificationActionOperationsApi();
            var projectId = projectId_example;  // String |  (default to null)
            var createNotificationGroupRequest = new CreateNotificationGroupRequest(); // CreateNotificationGroupRequest | 

            try {
                // Creates a new Job Notification Group.
                NotificationGroupResponse result = apiInstance.createJobNotificationGroupV2(projectId, createNotificationGroupRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling JobNotificationActionOperationsApi.createJobNotificationGroupV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\JobNotificationActionOperationsApi();
$projectId = projectId_example; // String | 
$createNotificationGroupRequest = ; // CreateNotificationGroupRequest | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::JobNotificationActionOperationsApi->new();
my $projectId = projectId_example; # String | 
my $createNotificationGroupRequest = WWW::OPenAPIClient::Object::CreateNotificationGroupRequest->new(); # CreateNotificationGroupRequest | 

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

# Create an instance of the API class
api_instance = openapi_client.JobNotificationActionOperationsApi()
projectId = projectId_example # String |  (default to null)
createNotificationGroupRequest =  # CreateNotificationGroupRequest | 

try:
    # Creates a new Job Notification Group.
    api_response = api_instance.create_job_notification_group_v2(projectId, createNotificationGroupRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling JobNotificationActionOperationsApi->createJobNotificationGroupV2: %s\n" % e)
extern crate JobNotificationActionOperationsApi;

pub fn main() {
    let projectId = projectId_example; // String
    let createNotificationGroupRequest = ; // CreateNotificationGroupRequest

    let mut context = JobNotificationActionOperationsApi::Context::default();
    let result = client.createJobNotificationGroupV2(projectId, createNotificationGroupRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
projectId*
String
Required
Body parameters
Name Description
createNotificationGroupRequest *

Responses


createJobNotificationV2

Creates a new Job Notification Action.


/api/v2/projects/{projectId}/notification-actions

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost/api/v2/projects/{projectId}/notification-actions" \
 -d '{
  "metadata" : {
    "type" : "type"
  },
  "name" : "name"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.JobNotificationActionOperationsApi;

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

public class JobNotificationActionOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        JobNotificationActionOperationsApi apiInstance = new JobNotificationActionOperationsApi();
        String projectId = projectId_example; // String | 
        CreateNotificationActionRequest createNotificationActionRequest = ; // CreateNotificationActionRequest | 

        try {
            NotificationActionResponse result = apiInstance.createJobNotificationV2(projectId, createNotificationActionRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobNotificationActionOperationsApi#createJobNotificationV2");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String projectId = new String(); // String | 
final CreateNotificationActionRequest createNotificationActionRequest = new CreateNotificationActionRequest(); // CreateNotificationActionRequest | 

try {
    final result = await api_instance.createJobNotificationV2(projectId, createNotificationActionRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->createJobNotificationV2: $e\n');
}

import org.openapitools.client.api.JobNotificationActionOperationsApi;

public class JobNotificationActionOperationsApiExample {
    public static void main(String[] args) {
        JobNotificationActionOperationsApi apiInstance = new JobNotificationActionOperationsApi();
        String projectId = projectId_example; // String | 
        CreateNotificationActionRequest createNotificationActionRequest = ; // CreateNotificationActionRequest | 

        try {
            NotificationActionResponse result = apiInstance.createJobNotificationV2(projectId, createNotificationActionRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobNotificationActionOperationsApi#createJobNotificationV2");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
JobNotificationActionOperationsApi *apiInstance = [[JobNotificationActionOperationsApi alloc] init];
String *projectId = projectId_example; //  (default to null)
CreateNotificationActionRequest *createNotificationActionRequest = ; // 

// Creates a new Job Notification Action.
[apiInstance createJobNotificationV2With:projectId
    createNotificationActionRequest:createNotificationActionRequest
              completionHandler: ^(NotificationActionResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.JobNotificationActionOperationsApi()
var projectId = projectId_example; // {String} 
var createNotificationActionRequest = ; // {CreateNotificationActionRequest} 

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

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

            // Create an instance of the API class
            var apiInstance = new JobNotificationActionOperationsApi();
            var projectId = projectId_example;  // String |  (default to null)
            var createNotificationActionRequest = new CreateNotificationActionRequest(); // CreateNotificationActionRequest | 

            try {
                // Creates a new Job Notification Action.
                NotificationActionResponse result = apiInstance.createJobNotificationV2(projectId, createNotificationActionRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling JobNotificationActionOperationsApi.createJobNotificationV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\JobNotificationActionOperationsApi();
$projectId = projectId_example; // String | 
$createNotificationActionRequest = ; // CreateNotificationActionRequest | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::JobNotificationActionOperationsApi->new();
my $projectId = projectId_example; # String | 
my $createNotificationActionRequest = WWW::OPenAPIClient::Object::CreateNotificationActionRequest->new(); # CreateNotificationActionRequest | 

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

# Create an instance of the API class
api_instance = openapi_client.JobNotificationActionOperationsApi()
projectId = projectId_example # String |  (default to null)
createNotificationActionRequest =  # CreateNotificationActionRequest | 

try:
    # Creates a new Job Notification Action.
    api_response = api_instance.create_job_notification_v2(projectId, createNotificationActionRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling JobNotificationActionOperationsApi->createJobNotificationV2: %s\n" % e)
extern crate JobNotificationActionOperationsApi;

pub fn main() {
    let projectId = projectId_example; // String
    let createNotificationActionRequest = ; // CreateNotificationActionRequest

    let mut context = JobNotificationActionOperationsApi::Context::default();
    let result = client.createJobNotificationV2(projectId, createNotificationActionRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
projectId*
String
Required
Body parameters
Name Description
createNotificationActionRequest *

Responses


deleteJobNotificationV2

Removes the given Job Notification Action.


/api/v2/projects/{projectId}/notification-actions/{id}

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: application/json" \
 "http://localhost/api/v2/projects/{projectId}/notification-actions/{id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.JobNotificationActionOperationsApi;

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

public class JobNotificationActionOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        JobNotificationActionOperationsApi apiInstance = new JobNotificationActionOperationsApi();
        Integer id = 56; // Integer | 
        String projectId = projectId_example; // String | 

        try {
            apiInstance.deleteJobNotificationV2(id, projectId);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobNotificationActionOperationsApi#deleteJobNotificationV2");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 
final String projectId = new String(); // String | 

try {
    final result = await api_instance.deleteJobNotificationV2(id, projectId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteJobNotificationV2: $e\n');
}

import org.openapitools.client.api.JobNotificationActionOperationsApi;

public class JobNotificationActionOperationsApiExample {
    public static void main(String[] args) {
        JobNotificationActionOperationsApi apiInstance = new JobNotificationActionOperationsApi();
        Integer id = 56; // Integer | 
        String projectId = projectId_example; // String | 

        try {
            apiInstance.deleteJobNotificationV2(id, projectId);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobNotificationActionOperationsApi#deleteJobNotificationV2");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
JobNotificationActionOperationsApi *apiInstance = [[JobNotificationActionOperationsApi alloc] init];
Integer *id = 56; //  (default to null)
String *projectId = projectId_example; //  (default to null)

// Removes the given Job Notification Action.
[apiInstance deleteJobNotificationV2With:id
    projectId:projectId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.JobNotificationActionOperationsApi()
var id = 56; // {Integer} 
var projectId = projectId_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteJobNotificationV2(id, projectId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new JobNotificationActionOperationsApi();
            var id = 56;  // Integer |  (default to null)
            var projectId = projectId_example;  // String |  (default to null)

            try {
                // Removes the given Job Notification Action.
                apiInstance.deleteJobNotificationV2(id, projectId);
            } catch (Exception e) {
                Debug.Print("Exception when calling JobNotificationActionOperationsApi.deleteJobNotificationV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\JobNotificationActionOperationsApi();
$id = 56; // Integer | 
$projectId = projectId_example; // String | 

try {
    $api_instance->deleteJobNotificationV2($id, $projectId);
} catch (Exception $e) {
    echo 'Exception when calling JobNotificationActionOperationsApi->deleteJobNotificationV2: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::JobNotificationActionOperationsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::JobNotificationActionOperationsApi->new();
my $id = 56; # Integer | 
my $projectId = projectId_example; # String | 

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

# Create an instance of the API class
api_instance = openapi_client.JobNotificationActionOperationsApi()
id = 56 # Integer |  (default to null)
projectId = projectId_example # String |  (default to null)

try:
    # Removes the given Job Notification Action.
    api_instance.delete_job_notification_v2(id, projectId)
except ApiException as e:
    print("Exception when calling JobNotificationActionOperationsApi->deleteJobNotificationV2: %s\n" % e)
extern crate JobNotificationActionOperationsApi;

pub fn main() {
    let id = 56; // Integer
    let projectId = projectId_example; // String

    let mut context = JobNotificationActionOperationsApi::Context::default();
    let result = client.deleteJobNotificationV2(id, projectId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required
projectId*
String
Required

Responses


findAllJobNotificationByJobIdV2

Retrieves Job Notification Actions for the given job


/api/v2/projects/{projectId}/notification-actions/job/{jobId}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/api/v2/projects/{projectId}/notification-actions/job/{jobId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.JobNotificationActionOperationsApi;

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

public class JobNotificationActionOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        JobNotificationActionOperationsApi apiInstance = new JobNotificationActionOperationsApi();
        Integer jobId = 56; // Integer | 
        String projectId = projectId_example; // String | 

        try {
            array[NotificationActionResponse] result = apiInstance.findAllJobNotificationByJobIdV2(jobId, projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobNotificationActionOperationsApi#findAllJobNotificationByJobIdV2");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer jobId = new Integer(); // Integer | 
final String projectId = new String(); // String | 

try {
    final result = await api_instance.findAllJobNotificationByJobIdV2(jobId, projectId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->findAllJobNotificationByJobIdV2: $e\n');
}

import org.openapitools.client.api.JobNotificationActionOperationsApi;

public class JobNotificationActionOperationsApiExample {
    public static void main(String[] args) {
        JobNotificationActionOperationsApi apiInstance = new JobNotificationActionOperationsApi();
        Integer jobId = 56; // Integer | 
        String projectId = projectId_example; // String | 

        try {
            array[NotificationActionResponse] result = apiInstance.findAllJobNotificationByJobIdV2(jobId, projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobNotificationActionOperationsApi#findAllJobNotificationByJobIdV2");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
JobNotificationActionOperationsApi *apiInstance = [[JobNotificationActionOperationsApi alloc] init];
Integer *jobId = 56; //  (default to null)
String *projectId = projectId_example; //  (default to null)

// Retrieves Job Notification Actions for the given job
[apiInstance findAllJobNotificationByJobIdV2With:jobId
    projectId:projectId
              completionHandler: ^(array[NotificationActionResponse] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.JobNotificationActionOperationsApi()
var jobId = 56; // {Integer} 
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.findAllJobNotificationByJobIdV2(jobId, projectId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new JobNotificationActionOperationsApi();
            var jobId = 56;  // Integer |  (default to null)
            var projectId = projectId_example;  // String |  (default to null)

            try {
                // Retrieves Job Notification Actions for the given job
                array[NotificationActionResponse] result = apiInstance.findAllJobNotificationByJobIdV2(jobId, projectId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling JobNotificationActionOperationsApi.findAllJobNotificationByJobIdV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\JobNotificationActionOperationsApi();
$jobId = 56; // Integer | 
$projectId = projectId_example; // String | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::JobNotificationActionOperationsApi->new();
my $jobId = 56; # Integer | 
my $projectId = projectId_example; # String | 

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

# Create an instance of the API class
api_instance = openapi_client.JobNotificationActionOperationsApi()
jobId = 56 # Integer |  (default to null)
projectId = projectId_example # String |  (default to null)

try:
    # Retrieves Job Notification Actions for the given job
    api_response = api_instance.find_all_job_notification_by_job_id_v2(jobId, projectId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling JobNotificationActionOperationsApi->findAllJobNotificationByJobIdV2: %s\n" % e)
extern crate JobNotificationActionOperationsApi;

pub fn main() {
    let jobId = 56; // Integer
    let projectId = projectId_example; // String

    let mut context = JobNotificationActionOperationsApi::Context::default();
    let result = client.findAllJobNotificationByJobIdV2(jobId, projectId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
jobId*
Integer (int32)
Required
projectId*
String
Required

Responses


getJobNotificationGroupChildrenV2

Retrieves the Notification Actions and Groups in a group.


/api/v2/projects/{projectId}/notification-actions/groups/{id}/children

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/api/v2/projects/{projectId}/notification-actions/groups/{id}/children"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.JobNotificationActionOperationsApi;

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

public class JobNotificationActionOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        JobNotificationActionOperationsApi apiInstance = new JobNotificationActionOperationsApi();
        Integer id = 56; // Integer | 
        String projectId = projectId_example; // String | 

        try {
            array[NotificationActionResponse] result = apiInstance.getJobNotificationGroupChildrenV2(id, projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobNotificationActionOperationsApi#getJobNotificationGroupChildrenV2");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 
final String projectId = new String(); // String | 

try {
    final result = await api_instance.getJobNotificationGroupChildrenV2(id, projectId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getJobNotificationGroupChildrenV2: $e\n');
}

import org.openapitools.client.api.JobNotificationActionOperationsApi;

public class JobNotificationActionOperationsApiExample {
    public static void main(String[] args) {
        JobNotificationActionOperationsApi apiInstance = new JobNotificationActionOperationsApi();
        Integer id = 56; // Integer | 
        String projectId = projectId_example; // String | 

        try {
            array[NotificationActionResponse] result = apiInstance.getJobNotificationGroupChildrenV2(id, projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobNotificationActionOperationsApi#getJobNotificationGroupChildrenV2");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
JobNotificationActionOperationsApi *apiInstance = [[JobNotificationActionOperationsApi alloc] init];
Integer *id = 56; //  (default to null)
String *projectId = projectId_example; //  (default to null)

// Retrieves the Notification Actions and Groups in a group.
[apiInstance getJobNotificationGroupChildrenV2With:id
    projectId:projectId
              completionHandler: ^(array[NotificationActionResponse] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.JobNotificationActionOperationsApi()
var id = 56; // {Integer} 
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.getJobNotificationGroupChildrenV2(id, projectId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new JobNotificationActionOperationsApi();
            var id = 56;  // Integer |  (default to null)
            var projectId = projectId_example;  // String |  (default to null)

            try {
                // Retrieves the Notification Actions and Groups in a group.
                array[NotificationActionResponse] result = apiInstance.getJobNotificationGroupChildrenV2(id, projectId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling JobNotificationActionOperationsApi.getJobNotificationGroupChildrenV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\JobNotificationActionOperationsApi();
$id = 56; // Integer | 
$projectId = projectId_example; // String | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::JobNotificationActionOperationsApi->new();
my $id = 56; # Integer | 
my $projectId = projectId_example; # String | 

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

# Create an instance of the API class
api_instance = openapi_client.JobNotificationActionOperationsApi()
id = 56 # Integer |  (default to null)
projectId = projectId_example # String |  (default to null)

try:
    # Retrieves the Notification Actions and Groups in a group.
    api_response = api_instance.get_job_notification_group_children_v2(id, projectId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling JobNotificationActionOperationsApi->getJobNotificationGroupChildrenV2: %s\n" % e)
extern crate JobNotificationActionOperationsApi;

pub fn main() {
    let id = 56; // Integer
    let projectId = projectId_example; // String

    let mut context = JobNotificationActionOperationsApi::Context::default();
    let result = client.getJobNotificationGroupChildrenV2(id, projectId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required
projectId*
String
Required

Responses


getJobNotificationGroupV2

Retrieves the given Job Notification Group.


/api/v2/projects/{projectId}/notification-actions/groups/{id}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/api/v2/projects/{projectId}/notification-actions/groups/{id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.JobNotificationActionOperationsApi;

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

public class JobNotificationActionOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        JobNotificationActionOperationsApi apiInstance = new JobNotificationActionOperationsApi();
        Integer id = 56; // Integer | 
        String projectId = projectId_example; // String | 

        try {
            NotificationGroupResponse result = apiInstance.getJobNotificationGroupV2(id, projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobNotificationActionOperationsApi#getJobNotificationGroupV2");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 
final String projectId = new String(); // String | 

try {
    final result = await api_instance.getJobNotificationGroupV2(id, projectId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getJobNotificationGroupV2: $e\n');
}

import org.openapitools.client.api.JobNotificationActionOperationsApi;

public class JobNotificationActionOperationsApiExample {
    public static void main(String[] args) {
        JobNotificationActionOperationsApi apiInstance = new JobNotificationActionOperationsApi();
        Integer id = 56; // Integer | 
        String projectId = projectId_example; // String | 

        try {
            NotificationGroupResponse result = apiInstance.getJobNotificationGroupV2(id, projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobNotificationActionOperationsApi#getJobNotificationGroupV2");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
JobNotificationActionOperationsApi *apiInstance = [[JobNotificationActionOperationsApi alloc] init];
Integer *id = 56; //  (default to null)
String *projectId = projectId_example; //  (default to null)

// Retrieves the given Job Notification Group.
[apiInstance getJobNotificationGroupV2With:id
    projectId:projectId
              completionHandler: ^(NotificationGroupResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.JobNotificationActionOperationsApi()
var id = 56; // {Integer} 
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.getJobNotificationGroupV2(id, projectId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new JobNotificationActionOperationsApi();
            var id = 56;  // Integer |  (default to null)
            var projectId = projectId_example;  // String |  (default to null)

            try {
                // Retrieves the given Job Notification Group.
                NotificationGroupResponse result = apiInstance.getJobNotificationGroupV2(id, projectId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling JobNotificationActionOperationsApi.getJobNotificationGroupV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\JobNotificationActionOperationsApi();
$id = 56; // Integer | 
$projectId = projectId_example; // String | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::JobNotificationActionOperationsApi->new();
my $id = 56; # Integer | 
my $projectId = projectId_example; # String | 

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

# Create an instance of the API class
api_instance = openapi_client.JobNotificationActionOperationsApi()
id = 56 # Integer |  (default to null)
projectId = projectId_example # String |  (default to null)

try:
    # Retrieves the given Job Notification Group.
    api_response = api_instance.get_job_notification_group_v2(id, projectId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling JobNotificationActionOperationsApi->getJobNotificationGroupV2: %s\n" % e)
extern crate JobNotificationActionOperationsApi;

pub fn main() {
    let id = 56; // Integer
    let projectId = projectId_example; // String

    let mut context = JobNotificationActionOperationsApi::Context::default();
    let result = client.getJobNotificationGroupV2(id, projectId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required
projectId*
String
Required

Responses


getJobNotificationV2

Retrieves the given Job Notification Action.


/api/v2/projects/{projectId}/notification-actions/{id}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/api/v2/projects/{projectId}/notification-actions/{id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.JobNotificationActionOperationsApi;

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

public class JobNotificationActionOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        JobNotificationActionOperationsApi apiInstance = new JobNotificationActionOperationsApi();
        Integer id = 56; // Integer | 
        String projectId = projectId_example; // String | 

        try {
            NotificationActionResponse result = apiInstance.getJobNotificationV2(id, projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobNotificationActionOperationsApi#getJobNotificationV2");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 
final String projectId = new String(); // String | 

try {
    final result = await api_instance.getJobNotificationV2(id, projectId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getJobNotificationV2: $e\n');
}

import org.openapitools.client.api.JobNotificationActionOperationsApi;

public class JobNotificationActionOperationsApiExample {
    public static void main(String[] args) {
        JobNotificationActionOperationsApi apiInstance = new JobNotificationActionOperationsApi();
        Integer id = 56; // Integer | 
        String projectId = projectId_example; // String | 

        try {
            NotificationActionResponse result = apiInstance.getJobNotificationV2(id, projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobNotificationActionOperationsApi#getJobNotificationV2");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
JobNotificationActionOperationsApi *apiInstance = [[JobNotificationActionOperationsApi alloc] init];
Integer *id = 56; //  (default to null)
String *projectId = projectId_example; //  (default to null)

// Retrieves the given Job Notification Action.
[apiInstance getJobNotificationV2With:id
    projectId:projectId
              completionHandler: ^(NotificationActionResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.JobNotificationActionOperationsApi()
var id = 56; // {Integer} 
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.getJobNotificationV2(id, projectId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new JobNotificationActionOperationsApi();
            var id = 56;  // Integer |  (default to null)
            var projectId = projectId_example;  // String |  (default to null)

            try {
                // Retrieves the given Job Notification Action.
                NotificationActionResponse result = apiInstance.getJobNotificationV2(id, projectId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling JobNotificationActionOperationsApi.getJobNotificationV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\JobNotificationActionOperationsApi();
$id = 56; // Integer | 
$projectId = projectId_example; // String | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::JobNotificationActionOperationsApi->new();
my $id = 56; # Integer | 
my $projectId = projectId_example; # String | 

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

# Create an instance of the API class
api_instance = openapi_client.JobNotificationActionOperationsApi()
id = 56 # Integer |  (default to null)
projectId = projectId_example # String |  (default to null)

try:
    # Retrieves the given Job Notification Action.
    api_response = api_instance.get_job_notification_v2(id, projectId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling JobNotificationActionOperationsApi->getJobNotificationV2: %s\n" % e)
extern crate JobNotificationActionOperationsApi;

pub fn main() {
    let id = 56; // Integer
    let projectId = projectId_example; // String

    let mut context = JobNotificationActionOperationsApi::Context::default();
    let result = client.getJobNotificationV2(id, projectId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required
projectId*
String
Required

Responses


getNotificationTemplateVariablesV2

Retrieves the available template variables that are usable in notification templates


/api/v2/projects/{projectId}/notification-actions/template-variables

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/api/v2/projects/{projectId}/notification-actions/template-variables"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.JobNotificationActionOperationsApi;

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

public class JobNotificationActionOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        JobNotificationActionOperationsApi apiInstance = new JobNotificationActionOperationsApi();
        String projectId = projectId_example; // String | 

        try {
            array['String'] result = apiInstance.getNotificationTemplateVariablesV2(projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobNotificationActionOperationsApi#getNotificationTemplateVariablesV2");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String projectId = new String(); // String | 

try {
    final result = await api_instance.getNotificationTemplateVariablesV2(projectId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getNotificationTemplateVariablesV2: $e\n');
}

import org.openapitools.client.api.JobNotificationActionOperationsApi;

public class JobNotificationActionOperationsApiExample {
    public static void main(String[] args) {
        JobNotificationActionOperationsApi apiInstance = new JobNotificationActionOperationsApi();
        String projectId = projectId_example; // String | 

        try {
            array['String'] result = apiInstance.getNotificationTemplateVariablesV2(projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobNotificationActionOperationsApi#getNotificationTemplateVariablesV2");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
JobNotificationActionOperationsApi *apiInstance = [[JobNotificationActionOperationsApi alloc] init];
String *projectId = projectId_example; //  (default to null)

// Retrieves the available template variables that are usable in notification templates
[apiInstance getNotificationTemplateVariablesV2With:projectId
              completionHandler: ^(array['String'] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.JobNotificationActionOperationsApi()
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.getNotificationTemplateVariablesV2(projectId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new JobNotificationActionOperationsApi();
            var projectId = projectId_example;  // String |  (default to null)

            try {
                // Retrieves the available template variables that are usable in notification templates
                array['String'] result = apiInstance.getNotificationTemplateVariablesV2(projectId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling JobNotificationActionOperationsApi.getNotificationTemplateVariablesV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\JobNotificationActionOperationsApi();
$projectId = projectId_example; // String | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::JobNotificationActionOperationsApi->new();
my $projectId = projectId_example; # String | 

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

# Create an instance of the API class
api_instance = openapi_client.JobNotificationActionOperationsApi()
projectId = projectId_example # String |  (default to null)

try:
    # Retrieves the available template variables that are usable in notification templates
    api_response = api_instance.get_notification_template_variables_v2(projectId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling JobNotificationActionOperationsApi->getNotificationTemplateVariablesV2: %s\n" % e)
extern crate JobNotificationActionOperationsApi;

pub fn main() {
    let projectId = projectId_example; // String

    let mut context = JobNotificationActionOperationsApi::Context::default();
    let result = client.getNotificationTemplateVariablesV2(projectId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
projectId*
String
Required

Responses


listAllJobNotificationActionsV2

Retrieves Job Notification Actions.


/api/v2/projects/{projectId}/notification-actions

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/api/v2/projects/{projectId}/notification-actions"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.JobNotificationActionOperationsApi;

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

public class JobNotificationActionOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        JobNotificationActionOperationsApi apiInstance = new JobNotificationActionOperationsApi();
        String projectId = projectId_example; // String | 

        try {
            array[NotificationActionResponse] result = apiInstance.listAllJobNotificationActionsV2(projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobNotificationActionOperationsApi#listAllJobNotificationActionsV2");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String projectId = new String(); // String | 

try {
    final result = await api_instance.listAllJobNotificationActionsV2(projectId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->listAllJobNotificationActionsV2: $e\n');
}

import org.openapitools.client.api.JobNotificationActionOperationsApi;

public class JobNotificationActionOperationsApiExample {
    public static void main(String[] args) {
        JobNotificationActionOperationsApi apiInstance = new JobNotificationActionOperationsApi();
        String projectId = projectId_example; // String | 

        try {
            array[NotificationActionResponse] result = apiInstance.listAllJobNotificationActionsV2(projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobNotificationActionOperationsApi#listAllJobNotificationActionsV2");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
JobNotificationActionOperationsApi *apiInstance = [[JobNotificationActionOperationsApi alloc] init];
String *projectId = projectId_example; //  (default to null)

// Retrieves Job Notification Actions.
[apiInstance listAllJobNotificationActionsV2With:projectId
              completionHandler: ^(array[NotificationActionResponse] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.JobNotificationActionOperationsApi()
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.listAllJobNotificationActionsV2(projectId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new JobNotificationActionOperationsApi();
            var projectId = projectId_example;  // String |  (default to null)

            try {
                // Retrieves Job Notification Actions.
                array[NotificationActionResponse] result = apiInstance.listAllJobNotificationActionsV2(projectId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling JobNotificationActionOperationsApi.listAllJobNotificationActionsV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\JobNotificationActionOperationsApi();
$projectId = projectId_example; // String | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::JobNotificationActionOperationsApi->new();
my $projectId = projectId_example; # String | 

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

# Create an instance of the API class
api_instance = openapi_client.JobNotificationActionOperationsApi()
projectId = projectId_example # String |  (default to null)

try:
    # Retrieves Job Notification Actions.
    api_response = api_instance.list_all_job_notification_actions_v2(projectId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling JobNotificationActionOperationsApi->listAllJobNotificationActionsV2: %s\n" % e)
extern crate JobNotificationActionOperationsApi;

pub fn main() {
    let projectId = projectId_example; // String

    let mut context = JobNotificationActionOperationsApi::Context::default();
    let result = client.listAllJobNotificationActionsV2(projectId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
projectId*
String
Required

Responses


removeFromJobNotificationGroupV2

Deletes a Notification Action or Group from a Notification Group


/api/v2/projects/{projectId}/notification-actions/groups/{groupId}/child/{childId}

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: application/json" \
 "http://localhost/api/v2/projects/{projectId}/notification-actions/groups/{groupId}/child/{childId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.JobNotificationActionOperationsApi;

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

public class JobNotificationActionOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        JobNotificationActionOperationsApi apiInstance = new JobNotificationActionOperationsApi();
        Integer groupId = 56; // Integer | 
        Integer childId = 56; // Integer | 
        String projectId = projectId_example; // String | 

        try {
            apiInstance.removeFromJobNotificationGroupV2(groupId, childId, projectId);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobNotificationActionOperationsApi#removeFromJobNotificationGroupV2");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer groupId = new Integer(); // Integer | 
final Integer childId = new Integer(); // Integer | 
final String projectId = new String(); // String | 

try {
    final result = await api_instance.removeFromJobNotificationGroupV2(groupId, childId, projectId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->removeFromJobNotificationGroupV2: $e\n');
}

import org.openapitools.client.api.JobNotificationActionOperationsApi;

public class JobNotificationActionOperationsApiExample {
    public static void main(String[] args) {
        JobNotificationActionOperationsApi apiInstance = new JobNotificationActionOperationsApi();
        Integer groupId = 56; // Integer | 
        Integer childId = 56; // Integer | 
        String projectId = projectId_example; // String | 

        try {
            apiInstance.removeFromJobNotificationGroupV2(groupId, childId, projectId);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobNotificationActionOperationsApi#removeFromJobNotificationGroupV2");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
JobNotificationActionOperationsApi *apiInstance = [[JobNotificationActionOperationsApi alloc] init];
Integer *groupId = 56; //  (default to null)
Integer *childId = 56; //  (default to null)
String *projectId = projectId_example; //  (default to null)

// Deletes a Notification Action or Group from a Notification Group
[apiInstance removeFromJobNotificationGroupV2With:groupId
    childId:childId
    projectId:projectId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.JobNotificationActionOperationsApi()
var groupId = 56; // {Integer} 
var childId = 56; // {Integer} 
var projectId = projectId_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.removeFromJobNotificationGroupV2(groupId, childId, projectId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new JobNotificationActionOperationsApi();
            var groupId = 56;  // Integer |  (default to null)
            var childId = 56;  // Integer |  (default to null)
            var projectId = projectId_example;  // String |  (default to null)

            try {
                // Deletes a Notification Action or Group from a Notification Group
                apiInstance.removeFromJobNotificationGroupV2(groupId, childId, projectId);
            } catch (Exception e) {
                Debug.Print("Exception when calling JobNotificationActionOperationsApi.removeFromJobNotificationGroupV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\JobNotificationActionOperationsApi();
$groupId = 56; // Integer | 
$childId = 56; // Integer | 
$projectId = projectId_example; // String | 

try {
    $api_instance->removeFromJobNotificationGroupV2($groupId, $childId, $projectId);
} catch (Exception $e) {
    echo 'Exception when calling JobNotificationActionOperationsApi->removeFromJobNotificationGroupV2: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::JobNotificationActionOperationsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::JobNotificationActionOperationsApi->new();
my $groupId = 56; # Integer | 
my $childId = 56; # Integer | 
my $projectId = projectId_example; # String | 

eval {
    $api_instance->removeFromJobNotificationGroupV2(groupId => $groupId, childId => $childId, projectId => $projectId);
};
if ($@) {
    warn "Exception when calling JobNotificationActionOperationsApi->removeFromJobNotificationGroupV2: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.JobNotificationActionOperationsApi()
groupId = 56 # Integer |  (default to null)
childId = 56 # Integer |  (default to null)
projectId = projectId_example # String |  (default to null)

try:
    # Deletes a Notification Action or Group from a Notification Group
    api_instance.remove_from_job_notification_group_v2(groupId, childId, projectId)
except ApiException as e:
    print("Exception when calling JobNotificationActionOperationsApi->removeFromJobNotificationGroupV2: %s\n" % e)
extern crate JobNotificationActionOperationsApi;

pub fn main() {
    let groupId = 56; // Integer
    let childId = 56; // Integer
    let projectId = projectId_example; // String

    let mut context = JobNotificationActionOperationsApi::Context::default();
    let result = client.removeFromJobNotificationGroupV2(groupId, childId, projectId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
groupId*
Integer (int32)
Required
childId*
Integer (int32)
Required
projectId*
String
Required

Responses


resolveJobNotificationGroupActionsV2

Retrieves all the Notification Actions in a group, including every children the inner groups


/api/v2/projects/{projectId}/notification-actions/groups/{id}/resolve-actions

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/api/v2/projects/{projectId}/notification-actions/groups/{id}/resolve-actions"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.JobNotificationActionOperationsApi;

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

public class JobNotificationActionOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        JobNotificationActionOperationsApi apiInstance = new JobNotificationActionOperationsApi();
        Integer id = 56; // Integer | 
        String projectId = projectId_example; // String | 

        try {
            array[NotificationActionResponse] result = apiInstance.resolveJobNotificationGroupActionsV2(id, projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobNotificationActionOperationsApi#resolveJobNotificationGroupActionsV2");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 
final String projectId = new String(); // String | 

try {
    final result = await api_instance.resolveJobNotificationGroupActionsV2(id, projectId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->resolveJobNotificationGroupActionsV2: $e\n');
}

import org.openapitools.client.api.JobNotificationActionOperationsApi;

public class JobNotificationActionOperationsApiExample {
    public static void main(String[] args) {
        JobNotificationActionOperationsApi apiInstance = new JobNotificationActionOperationsApi();
        Integer id = 56; // Integer | 
        String projectId = projectId_example; // String | 

        try {
            array[NotificationActionResponse] result = apiInstance.resolveJobNotificationGroupActionsV2(id, projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobNotificationActionOperationsApi#resolveJobNotificationGroupActionsV2");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
JobNotificationActionOperationsApi *apiInstance = [[JobNotificationActionOperationsApi alloc] init];
Integer *id = 56; //  (default to null)
String *projectId = projectId_example; //  (default to null)

// Retrieves all the Notification Actions in a group, including every children the inner groups
[apiInstance resolveJobNotificationGroupActionsV2With:id
    projectId:projectId
              completionHandler: ^(array[NotificationActionResponse] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.JobNotificationActionOperationsApi()
var id = 56; // {Integer} 
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.resolveJobNotificationGroupActionsV2(id, projectId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new JobNotificationActionOperationsApi();
            var id = 56;  // Integer |  (default to null)
            var projectId = projectId_example;  // String |  (default to null)

            try {
                // Retrieves all the Notification Actions in a group, including every children the inner groups
                array[NotificationActionResponse] result = apiInstance.resolveJobNotificationGroupActionsV2(id, projectId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling JobNotificationActionOperationsApi.resolveJobNotificationGroupActionsV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\JobNotificationActionOperationsApi();
$id = 56; // Integer | 
$projectId = projectId_example; // String | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::JobNotificationActionOperationsApi->new();
my $id = 56; # Integer | 
my $projectId = projectId_example; # String | 

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

# Create an instance of the API class
api_instance = openapi_client.JobNotificationActionOperationsApi()
id = 56 # Integer |  (default to null)
projectId = projectId_example # String |  (default to null)

try:
    # Retrieves all the Notification Actions in a group, including every children the inner groups
    api_response = api_instance.resolve_job_notification_group_actions_v2(id, projectId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling JobNotificationActionOperationsApi->resolveJobNotificationGroupActionsV2: %s\n" % e)
extern crate JobNotificationActionOperationsApi;

pub fn main() {
    let id = 56; // Integer
    let projectId = projectId_example; // String

    let mut context = JobNotificationActionOperationsApi::Context::default();
    let result = client.resolveJobNotificationGroupActionsV2(id, projectId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required
projectId*
String
Required

Responses


updateJobNotificationGroupV2

Updates the given Job Notification Group.


/api/v2/projects/{projectId}/notification-actions/groups/{id}

Usage and SDK Samples

curl -X PUT \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost/api/v2/projects/{projectId}/notification-actions/groups/{id}" \
 -d '{
  "children" : [ 0, 0 ],
  "name" : "name"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.JobNotificationActionOperationsApi;

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

public class JobNotificationActionOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        JobNotificationActionOperationsApi apiInstance = new JobNotificationActionOperationsApi();
        Integer id = 56; // Integer | 
        String projectId = projectId_example; // String | 
        CreateNotificationGroupRequest createNotificationGroupRequest = ; // CreateNotificationGroupRequest | 

        try {
            NotificationGroupResponse result = apiInstance.updateJobNotificationGroupV2(id, projectId, createNotificationGroupRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobNotificationActionOperationsApi#updateJobNotificationGroupV2");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 
final String projectId = new String(); // String | 
final CreateNotificationGroupRequest createNotificationGroupRequest = new CreateNotificationGroupRequest(); // CreateNotificationGroupRequest | 

try {
    final result = await api_instance.updateJobNotificationGroupV2(id, projectId, createNotificationGroupRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateJobNotificationGroupV2: $e\n');
}

import org.openapitools.client.api.JobNotificationActionOperationsApi;

public class JobNotificationActionOperationsApiExample {
    public static void main(String[] args) {
        JobNotificationActionOperationsApi apiInstance = new JobNotificationActionOperationsApi();
        Integer id = 56; // Integer | 
        String projectId = projectId_example; // String | 
        CreateNotificationGroupRequest createNotificationGroupRequest = ; // CreateNotificationGroupRequest | 

        try {
            NotificationGroupResponse result = apiInstance.updateJobNotificationGroupV2(id, projectId, createNotificationGroupRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobNotificationActionOperationsApi#updateJobNotificationGroupV2");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
JobNotificationActionOperationsApi *apiInstance = [[JobNotificationActionOperationsApi alloc] init];
Integer *id = 56; //  (default to null)
String *projectId = projectId_example; //  (default to null)
CreateNotificationGroupRequest *createNotificationGroupRequest = ; // 

// Updates the given Job Notification Group.
[apiInstance updateJobNotificationGroupV2With:id
    projectId:projectId
    createNotificationGroupRequest:createNotificationGroupRequest
              completionHandler: ^(NotificationGroupResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.JobNotificationActionOperationsApi()
var id = 56; // {Integer} 
var projectId = projectId_example; // {String} 
var createNotificationGroupRequest = ; // {CreateNotificationGroupRequest} 

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

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

            // Create an instance of the API class
            var apiInstance = new JobNotificationActionOperationsApi();
            var id = 56;  // Integer |  (default to null)
            var projectId = projectId_example;  // String |  (default to null)
            var createNotificationGroupRequest = new CreateNotificationGroupRequest(); // CreateNotificationGroupRequest | 

            try {
                // Updates the given Job Notification Group.
                NotificationGroupResponse result = apiInstance.updateJobNotificationGroupV2(id, projectId, createNotificationGroupRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling JobNotificationActionOperationsApi.updateJobNotificationGroupV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\JobNotificationActionOperationsApi();
$id = 56; // Integer | 
$projectId = projectId_example; // String | 
$createNotificationGroupRequest = ; // CreateNotificationGroupRequest | 

try {
    $result = $api_instance->updateJobNotificationGroupV2($id, $projectId, $createNotificationGroupRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling JobNotificationActionOperationsApi->updateJobNotificationGroupV2: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::JobNotificationActionOperationsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::JobNotificationActionOperationsApi->new();
my $id = 56; # Integer | 
my $projectId = projectId_example; # String | 
my $createNotificationGroupRequest = WWW::OPenAPIClient::Object::CreateNotificationGroupRequest->new(); # CreateNotificationGroupRequest | 

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

# Create an instance of the API class
api_instance = openapi_client.JobNotificationActionOperationsApi()
id = 56 # Integer |  (default to null)
projectId = projectId_example # String |  (default to null)
createNotificationGroupRequest =  # CreateNotificationGroupRequest | 

try:
    # Updates the given Job Notification Group.
    api_response = api_instance.update_job_notification_group_v2(id, projectId, createNotificationGroupRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling JobNotificationActionOperationsApi->updateJobNotificationGroupV2: %s\n" % e)
extern crate JobNotificationActionOperationsApi;

pub fn main() {
    let id = 56; // Integer
    let projectId = projectId_example; // String
    let createNotificationGroupRequest = ; // CreateNotificationGroupRequest

    let mut context = JobNotificationActionOperationsApi::Context::default();
    let result = client.updateJobNotificationGroupV2(id, projectId, createNotificationGroupRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required
projectId*
String
Required
Body parameters
Name Description
createNotificationGroupRequest *

Responses


updateJobNotificationV2

Updates the given Job Notification Action.


/api/v2/projects/{projectId}/notification-actions/{id}

Usage and SDK Samples

curl -X PUT \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost/api/v2/projects/{projectId}/notification-actions/{id}" \
 -d '{
  "metadata" : {
    "type" : "type"
  },
  "name" : "name"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.JobNotificationActionOperationsApi;

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

public class JobNotificationActionOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        JobNotificationActionOperationsApi apiInstance = new JobNotificationActionOperationsApi();
        Integer id = 56; // Integer | 
        String projectId = projectId_example; // String | 
        CreateNotificationActionRequest createNotificationActionRequest = ; // CreateNotificationActionRequest | 

        try {
            NotificationActionResponse result = apiInstance.updateJobNotificationV2(id, projectId, createNotificationActionRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobNotificationActionOperationsApi#updateJobNotificationV2");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 
final String projectId = new String(); // String | 
final CreateNotificationActionRequest createNotificationActionRequest = new CreateNotificationActionRequest(); // CreateNotificationActionRequest | 

try {
    final result = await api_instance.updateJobNotificationV2(id, projectId, createNotificationActionRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateJobNotificationV2: $e\n');
}

import org.openapitools.client.api.JobNotificationActionOperationsApi;

public class JobNotificationActionOperationsApiExample {
    public static void main(String[] args) {
        JobNotificationActionOperationsApi apiInstance = new JobNotificationActionOperationsApi();
        Integer id = 56; // Integer | 
        String projectId = projectId_example; // String | 
        CreateNotificationActionRequest createNotificationActionRequest = ; // CreateNotificationActionRequest | 

        try {
            NotificationActionResponse result = apiInstance.updateJobNotificationV2(id, projectId, createNotificationActionRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobNotificationActionOperationsApi#updateJobNotificationV2");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
JobNotificationActionOperationsApi *apiInstance = [[JobNotificationActionOperationsApi alloc] init];
Integer *id = 56; //  (default to null)
String *projectId = projectId_example; //  (default to null)
CreateNotificationActionRequest *createNotificationActionRequest = ; // 

// Updates the given Job Notification Action.
[apiInstance updateJobNotificationV2With:id
    projectId:projectId
    createNotificationActionRequest:createNotificationActionRequest
              completionHandler: ^(NotificationActionResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.JobNotificationActionOperationsApi()
var id = 56; // {Integer} 
var projectId = projectId_example; // {String} 
var createNotificationActionRequest = ; // {CreateNotificationActionRequest} 

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

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

            // Create an instance of the API class
            var apiInstance = new JobNotificationActionOperationsApi();
            var id = 56;  // Integer |  (default to null)
            var projectId = projectId_example;  // String |  (default to null)
            var createNotificationActionRequest = new CreateNotificationActionRequest(); // CreateNotificationActionRequest | 

            try {
                // Updates the given Job Notification Action.
                NotificationActionResponse result = apiInstance.updateJobNotificationV2(id, projectId, createNotificationActionRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling JobNotificationActionOperationsApi.updateJobNotificationV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\JobNotificationActionOperationsApi();
$id = 56; // Integer | 
$projectId = projectId_example; // String | 
$createNotificationActionRequest = ; // CreateNotificationActionRequest | 

try {
    $result = $api_instance->updateJobNotificationV2($id, $projectId, $createNotificationActionRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling JobNotificationActionOperationsApi->updateJobNotificationV2: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::JobNotificationActionOperationsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::JobNotificationActionOperationsApi->new();
my $id = 56; # Integer | 
my $projectId = projectId_example; # String | 
my $createNotificationActionRequest = WWW::OPenAPIClient::Object::CreateNotificationActionRequest->new(); # CreateNotificationActionRequest | 

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

# Create an instance of the API class
api_instance = openapi_client.JobNotificationActionOperationsApi()
id = 56 # Integer |  (default to null)
projectId = projectId_example # String |  (default to null)
createNotificationActionRequest =  # CreateNotificationActionRequest | 

try:
    # Updates the given Job Notification Action.
    api_response = api_instance.update_job_notification_v2(id, projectId, createNotificationActionRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling JobNotificationActionOperationsApi->updateJobNotificationV2: %s\n" % e)
extern crate JobNotificationActionOperationsApi;

pub fn main() {
    let id = 56; // Integer
    let projectId = projectId_example; // String
    let createNotificationActionRequest = ; // CreateNotificationActionRequest

    let mut context = JobNotificationActionOperationsApi::Context::default();
    let result = client.updateJobNotificationV2(id, projectId, createNotificationActionRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required
projectId*
String
Required
Body parameters
Name Description
createNotificationActionRequest *

Responses


validateWebhookBodyV2

Validates the Webhook body


/api/v2/projects/{projectId}/notification-actions/validate

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost/api/v2/projects/{projectId}/notification-actions/validate" \
 -d '{
  "metadata" : {
    "type" : "type"
  },
  "name" : "name"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.JobNotificationActionOperationsApi;

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

public class JobNotificationActionOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        JobNotificationActionOperationsApi apiInstance = new JobNotificationActionOperationsApi();
        String projectId = projectId_example; // String | 
        CreateNotificationActionRequest createNotificationActionRequest = ; // CreateNotificationActionRequest | 

        try {
            apiInstance.validateWebhookBodyV2(projectId, createNotificationActionRequest);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobNotificationActionOperationsApi#validateWebhookBodyV2");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String projectId = new String(); // String | 
final CreateNotificationActionRequest createNotificationActionRequest = new CreateNotificationActionRequest(); // CreateNotificationActionRequest | 

try {
    final result = await api_instance.validateWebhookBodyV2(projectId, createNotificationActionRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->validateWebhookBodyV2: $e\n');
}

import org.openapitools.client.api.JobNotificationActionOperationsApi;

public class JobNotificationActionOperationsApiExample {
    public static void main(String[] args) {
        JobNotificationActionOperationsApi apiInstance = new JobNotificationActionOperationsApi();
        String projectId = projectId_example; // String | 
        CreateNotificationActionRequest createNotificationActionRequest = ; // CreateNotificationActionRequest | 

        try {
            apiInstance.validateWebhookBodyV2(projectId, createNotificationActionRequest);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobNotificationActionOperationsApi#validateWebhookBodyV2");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
JobNotificationActionOperationsApi *apiInstance = [[JobNotificationActionOperationsApi alloc] init];
String *projectId = projectId_example; //  (default to null)
CreateNotificationActionRequest *createNotificationActionRequest = ; // 

// Validates the Webhook body
[apiInstance validateWebhookBodyV2With:projectId
    createNotificationActionRequest:createNotificationActionRequest
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.JobNotificationActionOperationsApi()
var projectId = projectId_example; // {String} 
var createNotificationActionRequest = ; // {CreateNotificationActionRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.validateWebhookBodyV2(projectId, createNotificationActionRequest, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new JobNotificationActionOperationsApi();
            var projectId = projectId_example;  // String |  (default to null)
            var createNotificationActionRequest = new CreateNotificationActionRequest(); // CreateNotificationActionRequest | 

            try {
                // Validates the Webhook body
                apiInstance.validateWebhookBodyV2(projectId, createNotificationActionRequest);
            } catch (Exception e) {
                Debug.Print("Exception when calling JobNotificationActionOperationsApi.validateWebhookBodyV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\JobNotificationActionOperationsApi();
$projectId = projectId_example; // String | 
$createNotificationActionRequest = ; // CreateNotificationActionRequest | 

try {
    $api_instance->validateWebhookBodyV2($projectId, $createNotificationActionRequest);
} catch (Exception $e) {
    echo 'Exception when calling JobNotificationActionOperationsApi->validateWebhookBodyV2: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::JobNotificationActionOperationsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::JobNotificationActionOperationsApi->new();
my $projectId = projectId_example; # String | 
my $createNotificationActionRequest = WWW::OPenAPIClient::Object::CreateNotificationActionRequest->new(); # CreateNotificationActionRequest | 

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

# Create an instance of the API class
api_instance = openapi_client.JobNotificationActionOperationsApi()
projectId = projectId_example # String |  (default to null)
createNotificationActionRequest =  # CreateNotificationActionRequest | 

try:
    # Validates the Webhook body
    api_instance.validate_webhook_body_v2(projectId, createNotificationActionRequest)
except ApiException as e:
    print("Exception when calling JobNotificationActionOperationsApi->validateWebhookBodyV2: %s\n" % e)
extern crate JobNotificationActionOperationsApi;

pub fn main() {
    let projectId = projectId_example; // String
    let createNotificationActionRequest = ; // CreateNotificationActionRequest

    let mut context = JobNotificationActionOperationsApi::Context::default();
    let result = client.validateWebhookBodyV2(projectId, createNotificationActionRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
projectId*
String
Required
Body parameters
Name Description
createNotificationActionRequest *

Responses


JobNotificationRuleController

createJobNotificationRule


/internal/job-notification-rules

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost/internal/job-notification-rules" \
 -d '{
  "notification_action_id" : 0,
  "job_id" : 6
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.JobNotificationRuleControllerApi;

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

public class JobNotificationRuleControllerApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        JobNotificationRuleControllerApi apiInstance = new JobNotificationRuleControllerApi();
        CreateJobNotificationRuleRequest createJobNotificationRuleRequest = ; // CreateJobNotificationRuleRequest | 

        try {
            JobNotificationRuleResponse result = apiInstance.createJobNotificationRule(createJobNotificationRuleRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobNotificationRuleControllerApi#createJobNotificationRule");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final CreateJobNotificationRuleRequest createJobNotificationRuleRequest = new CreateJobNotificationRuleRequest(); // CreateJobNotificationRuleRequest | 

try {
    final result = await api_instance.createJobNotificationRule(createJobNotificationRuleRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->createJobNotificationRule: $e\n');
}

import org.openapitools.client.api.JobNotificationRuleControllerApi;

public class JobNotificationRuleControllerApiExample {
    public static void main(String[] args) {
        JobNotificationRuleControllerApi apiInstance = new JobNotificationRuleControllerApi();
        CreateJobNotificationRuleRequest createJobNotificationRuleRequest = ; // CreateJobNotificationRuleRequest | 

        try {
            JobNotificationRuleResponse result = apiInstance.createJobNotificationRule(createJobNotificationRuleRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobNotificationRuleControllerApi#createJobNotificationRule");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
JobNotificationRuleControllerApi *apiInstance = [[JobNotificationRuleControllerApi alloc] init];
CreateJobNotificationRuleRequest *createJobNotificationRuleRequest = ; // 

[apiInstance createJobNotificationRuleWith:createJobNotificationRuleRequest
              completionHandler: ^(JobNotificationRuleResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.JobNotificationRuleControllerApi()
var createJobNotificationRuleRequest = ; // {CreateJobNotificationRuleRequest} 

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

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

            // Create an instance of the API class
            var apiInstance = new JobNotificationRuleControllerApi();
            var createJobNotificationRuleRequest = new CreateJobNotificationRuleRequest(); // CreateJobNotificationRuleRequest | 

            try {
                JobNotificationRuleResponse result = apiInstance.createJobNotificationRule(createJobNotificationRuleRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling JobNotificationRuleControllerApi.createJobNotificationRule: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\JobNotificationRuleControllerApi();
$createJobNotificationRuleRequest = ; // CreateJobNotificationRuleRequest | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::JobNotificationRuleControllerApi->new();
my $createJobNotificationRuleRequest = WWW::OPenAPIClient::Object::CreateJobNotificationRuleRequest->new(); # CreateJobNotificationRuleRequest | 

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

# Create an instance of the API class
api_instance = openapi_client.JobNotificationRuleControllerApi()
createJobNotificationRuleRequest =  # CreateJobNotificationRuleRequest | 

try:
    api_response = api_instance.create_job_notification_rule(createJobNotificationRuleRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling JobNotificationRuleControllerApi->createJobNotificationRule: %s\n" % e)
extern crate JobNotificationRuleControllerApi;

pub fn main() {
    let createJobNotificationRuleRequest = ; // CreateJobNotificationRuleRequest

    let mut context = JobNotificationRuleControllerApi::Context::default();
    let result = client.createJobNotificationRule(createJobNotificationRuleRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
createJobNotificationRuleRequest *

Responses


deleteJobNotificationRule


/internal/job-notification-rules/{notificationRuleId}

Usage and SDK Samples

curl -X DELETE \
 "http://localhost/internal/job-notification-rules/{notificationRuleId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.JobNotificationRuleControllerApi;

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

public class JobNotificationRuleControllerApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        JobNotificationRuleControllerApi apiInstance = new JobNotificationRuleControllerApi();
        Integer notificationRuleId = 56; // Integer | 

        try {
            apiInstance.deleteJobNotificationRule(notificationRuleId);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobNotificationRuleControllerApi#deleteJobNotificationRule");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer notificationRuleId = new Integer(); // Integer | 

try {
    final result = await api_instance.deleteJobNotificationRule(notificationRuleId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteJobNotificationRule: $e\n');
}

import org.openapitools.client.api.JobNotificationRuleControllerApi;

public class JobNotificationRuleControllerApiExample {
    public static void main(String[] args) {
        JobNotificationRuleControllerApi apiInstance = new JobNotificationRuleControllerApi();
        Integer notificationRuleId = 56; // Integer | 

        try {
            apiInstance.deleteJobNotificationRule(notificationRuleId);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobNotificationRuleControllerApi#deleteJobNotificationRule");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
JobNotificationRuleControllerApi *apiInstance = [[JobNotificationRuleControllerApi alloc] init];
Integer *notificationRuleId = 56; //  (default to null)

[apiInstance deleteJobNotificationRuleWith:notificationRuleId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.JobNotificationRuleControllerApi()
var notificationRuleId = 56; // {Integer} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteJobNotificationRule(notificationRuleId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new JobNotificationRuleControllerApi();
            var notificationRuleId = 56;  // Integer |  (default to null)

            try {
                apiInstance.deleteJobNotificationRule(notificationRuleId);
            } catch (Exception e) {
                Debug.Print("Exception when calling JobNotificationRuleControllerApi.deleteJobNotificationRule: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\JobNotificationRuleControllerApi();
$notificationRuleId = 56; // Integer | 

try {
    $api_instance->deleteJobNotificationRule($notificationRuleId);
} catch (Exception $e) {
    echo 'Exception when calling JobNotificationRuleControllerApi->deleteJobNotificationRule: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::JobNotificationRuleControllerApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::JobNotificationRuleControllerApi->new();
my $notificationRuleId = 56; # Integer | 

eval {
    $api_instance->deleteJobNotificationRule(notificationRuleId => $notificationRuleId);
};
if ($@) {
    warn "Exception when calling JobNotificationRuleControllerApi->deleteJobNotificationRule: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.JobNotificationRuleControllerApi()
notificationRuleId = 56 # Integer |  (default to null)

try:
    api_instance.delete_job_notification_rule(notificationRuleId)
except ApiException as e:
    print("Exception when calling JobNotificationRuleControllerApi->deleteJobNotificationRule: %s\n" % e)
extern crate JobNotificationRuleControllerApi;

pub fn main() {
    let notificationRuleId = 56; // Integer

    let mut context = JobNotificationRuleControllerApi::Context::default();
    let result = client.deleteJobNotificationRule(notificationRuleId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
notificationRuleId*
Integer (int32)
Required

Responses


deleteJobNotificationRuleByJobIdAndNotificationActionId


/internal/job-notification-rules/job/{jobId}/notification-action/{notificationActionId}

Usage and SDK Samples

curl -X DELETE \
 "http://localhost/internal/job-notification-rules/job/{jobId}/notification-action/{notificationActionId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.JobNotificationRuleControllerApi;

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

public class JobNotificationRuleControllerApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        JobNotificationRuleControllerApi apiInstance = new JobNotificationRuleControllerApi();
        Integer jobId = 56; // Integer | 
        Integer notificationActionId = 56; // Integer | 

        try {
            apiInstance.deleteJobNotificationRuleByJobIdAndNotificationActionId(jobId, notificationActionId);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobNotificationRuleControllerApi#deleteJobNotificationRuleByJobIdAndNotificationActionId");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer jobId = new Integer(); // Integer | 
final Integer notificationActionId = new Integer(); // Integer | 

try {
    final result = await api_instance.deleteJobNotificationRuleByJobIdAndNotificationActionId(jobId, notificationActionId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteJobNotificationRuleByJobIdAndNotificationActionId: $e\n');
}

import org.openapitools.client.api.JobNotificationRuleControllerApi;

public class JobNotificationRuleControllerApiExample {
    public static void main(String[] args) {
        JobNotificationRuleControllerApi apiInstance = new JobNotificationRuleControllerApi();
        Integer jobId = 56; // Integer | 
        Integer notificationActionId = 56; // Integer | 

        try {
            apiInstance.deleteJobNotificationRuleByJobIdAndNotificationActionId(jobId, notificationActionId);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobNotificationRuleControllerApi#deleteJobNotificationRuleByJobIdAndNotificationActionId");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
JobNotificationRuleControllerApi *apiInstance = [[JobNotificationRuleControllerApi alloc] init];
Integer *jobId = 56; //  (default to null)
Integer *notificationActionId = 56; //  (default to null)

[apiInstance deleteJobNotificationRuleByJobIdAndNotificationActionIdWith:jobId
    notificationActionId:notificationActionId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.JobNotificationRuleControllerApi()
var jobId = 56; // {Integer} 
var notificationActionId = 56; // {Integer} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteJobNotificationRuleByJobIdAndNotificationActionId(jobId, notificationActionId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new JobNotificationRuleControllerApi();
            var jobId = 56;  // Integer |  (default to null)
            var notificationActionId = 56;  // Integer |  (default to null)

            try {
                apiInstance.deleteJobNotificationRuleByJobIdAndNotificationActionId(jobId, notificationActionId);
            } catch (Exception e) {
                Debug.Print("Exception when calling JobNotificationRuleControllerApi.deleteJobNotificationRuleByJobIdAndNotificationActionId: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\JobNotificationRuleControllerApi();
$jobId = 56; // Integer | 
$notificationActionId = 56; // Integer | 

try {
    $api_instance->deleteJobNotificationRuleByJobIdAndNotificationActionId($jobId, $notificationActionId);
} catch (Exception $e) {
    echo 'Exception when calling JobNotificationRuleControllerApi->deleteJobNotificationRuleByJobIdAndNotificationActionId: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::JobNotificationRuleControllerApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::JobNotificationRuleControllerApi->new();
my $jobId = 56; # Integer | 
my $notificationActionId = 56; # Integer | 

eval {
    $api_instance->deleteJobNotificationRuleByJobIdAndNotificationActionId(jobId => $jobId, notificationActionId => $notificationActionId);
};
if ($@) {
    warn "Exception when calling JobNotificationRuleControllerApi->deleteJobNotificationRuleByJobIdAndNotificationActionId: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.JobNotificationRuleControllerApi()
jobId = 56 # Integer |  (default to null)
notificationActionId = 56 # Integer |  (default to null)

try:
    api_instance.delete_job_notification_rule_by_job_id_and_notification_action_id(jobId, notificationActionId)
except ApiException as e:
    print("Exception when calling JobNotificationRuleControllerApi->deleteJobNotificationRuleByJobIdAndNotificationActionId: %s\n" % e)
extern crate JobNotificationRuleControllerApi;

pub fn main() {
    let jobId = 56; // Integer
    let notificationActionId = 56; // Integer

    let mut context = JobNotificationRuleControllerApi::Context::default();
    let result = client.deleteJobNotificationRuleByJobIdAndNotificationActionId(jobId, notificationActionId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
jobId*
Integer (int32)
Required
notificationActionId*
Integer (int32)
Required

Responses


findAllJobNotificationsByJobId


/internal/job-notification-rules/{jobId}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/internal/job-notification-rules/{jobId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.JobNotificationRuleControllerApi;

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

public class JobNotificationRuleControllerApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        JobNotificationRuleControllerApi apiInstance = new JobNotificationRuleControllerApi();
        Integer jobId = 56; // Integer | 

        try {
            array[JobNotificationRuleResponse] result = apiInstance.findAllJobNotificationsByJobId(jobId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobNotificationRuleControllerApi#findAllJobNotificationsByJobId");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer jobId = new Integer(); // Integer | 

try {
    final result = await api_instance.findAllJobNotificationsByJobId(jobId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->findAllJobNotificationsByJobId: $e\n');
}

import org.openapitools.client.api.JobNotificationRuleControllerApi;

public class JobNotificationRuleControllerApiExample {
    public static void main(String[] args) {
        JobNotificationRuleControllerApi apiInstance = new JobNotificationRuleControllerApi();
        Integer jobId = 56; // Integer | 

        try {
            array[JobNotificationRuleResponse] result = apiInstance.findAllJobNotificationsByJobId(jobId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobNotificationRuleControllerApi#findAllJobNotificationsByJobId");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
JobNotificationRuleControllerApi *apiInstance = [[JobNotificationRuleControllerApi alloc] init];
Integer *jobId = 56; //  (default to null)

[apiInstance findAllJobNotificationsByJobIdWith:jobId
              completionHandler: ^(array[JobNotificationRuleResponse] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.JobNotificationRuleControllerApi()
var jobId = 56; // {Integer} 

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

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

            // Create an instance of the API class
            var apiInstance = new JobNotificationRuleControllerApi();
            var jobId = 56;  // Integer |  (default to null)

            try {
                array[JobNotificationRuleResponse] result = apiInstance.findAllJobNotificationsByJobId(jobId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling JobNotificationRuleControllerApi.findAllJobNotificationsByJobId: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\JobNotificationRuleControllerApi();
$jobId = 56; // Integer | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::JobNotificationRuleControllerApi->new();
my $jobId = 56; # Integer | 

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

# Create an instance of the API class
api_instance = openapi_client.JobNotificationRuleControllerApi()
jobId = 56 # Integer |  (default to null)

try:
    api_response = api_instance.find_all_job_notifications_by_job_id(jobId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling JobNotificationRuleControllerApi->findAllJobNotificationsByJobId: %s\n" % e)
extern crate JobNotificationRuleControllerApi;

pub fn main() {
    let jobId = 56; // Integer

    let mut context = JobNotificationRuleControllerApi::Context::default();
    let result = client.findAllJobNotificationsByJobId(jobId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
jobId*
Integer (int32)
Required

Responses


JobNotificationRuleOperations

createJobNotificationRuleV2

Links a Job Notification Action to a Group.


/api/v2/projects/{projectId}/job-notification-rules

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost/api/v2/projects/{projectId}/job-notification-rules" \
 -d '{
  "notification_action_id" : 0,
  "job_id" : 6
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.JobNotificationRuleOperationsApi;

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

public class JobNotificationRuleOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        JobNotificationRuleOperationsApi apiInstance = new JobNotificationRuleOperationsApi();
        String projectId = projectId_example; // String | 
        CreateJobNotificationRuleRequest createJobNotificationRuleRequest = ; // CreateJobNotificationRuleRequest | 

        try {
            JobNotificationRuleResponse result = apiInstance.createJobNotificationRuleV2(projectId, createJobNotificationRuleRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobNotificationRuleOperationsApi#createJobNotificationRuleV2");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String projectId = new String(); // String | 
final CreateJobNotificationRuleRequest createJobNotificationRuleRequest = new CreateJobNotificationRuleRequest(); // CreateJobNotificationRuleRequest | 

try {
    final result = await api_instance.createJobNotificationRuleV2(projectId, createJobNotificationRuleRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->createJobNotificationRuleV2: $e\n');
}

import org.openapitools.client.api.JobNotificationRuleOperationsApi;

public class JobNotificationRuleOperationsApiExample {
    public static void main(String[] args) {
        JobNotificationRuleOperationsApi apiInstance = new JobNotificationRuleOperationsApi();
        String projectId = projectId_example; // String | 
        CreateJobNotificationRuleRequest createJobNotificationRuleRequest = ; // CreateJobNotificationRuleRequest | 

        try {
            JobNotificationRuleResponse result = apiInstance.createJobNotificationRuleV2(projectId, createJobNotificationRuleRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobNotificationRuleOperationsApi#createJobNotificationRuleV2");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
JobNotificationRuleOperationsApi *apiInstance = [[JobNotificationRuleOperationsApi alloc] init];
String *projectId = projectId_example; //  (default to null)
CreateJobNotificationRuleRequest *createJobNotificationRuleRequest = ; // 

// Links a Job Notification Action to a Group.
[apiInstance createJobNotificationRuleV2With:projectId
    createJobNotificationRuleRequest:createJobNotificationRuleRequest
              completionHandler: ^(JobNotificationRuleResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.JobNotificationRuleOperationsApi()
var projectId = projectId_example; // {String} 
var createJobNotificationRuleRequest = ; // {CreateJobNotificationRuleRequest} 

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

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

            // Create an instance of the API class
            var apiInstance = new JobNotificationRuleOperationsApi();
            var projectId = projectId_example;  // String |  (default to null)
            var createJobNotificationRuleRequest = new CreateJobNotificationRuleRequest(); // CreateJobNotificationRuleRequest | 

            try {
                // Links a Job Notification Action to a Group.
                JobNotificationRuleResponse result = apiInstance.createJobNotificationRuleV2(projectId, createJobNotificationRuleRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling JobNotificationRuleOperationsApi.createJobNotificationRuleV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\JobNotificationRuleOperationsApi();
$projectId = projectId_example; // String | 
$createJobNotificationRuleRequest = ; // CreateJobNotificationRuleRequest | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::JobNotificationRuleOperationsApi->new();
my $projectId = projectId_example; # String | 
my $createJobNotificationRuleRequest = WWW::OPenAPIClient::Object::CreateJobNotificationRuleRequest->new(); # CreateJobNotificationRuleRequest | 

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

# Create an instance of the API class
api_instance = openapi_client.JobNotificationRuleOperationsApi()
projectId = projectId_example # String |  (default to null)
createJobNotificationRuleRequest =  # CreateJobNotificationRuleRequest | 

try:
    # Links a Job Notification Action to a Group.
    api_response = api_instance.create_job_notification_rule_v2(projectId, createJobNotificationRuleRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling JobNotificationRuleOperationsApi->createJobNotificationRuleV2: %s\n" % e)
extern crate JobNotificationRuleOperationsApi;

pub fn main() {
    let projectId = projectId_example; // String
    let createJobNotificationRuleRequest = ; // CreateJobNotificationRuleRequest

    let mut context = JobNotificationRuleOperationsApi::Context::default();
    let result = client.createJobNotificationRuleV2(projectId, createJobNotificationRuleRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
projectId*
String
Required
Body parameters
Name Description
createJobNotificationRuleRequest *

Responses


deleteJobNotificationRuleByJobIdAndNotificationActionIdV2

Removes the given Job Notification Action from the job.


/api/v2/projects/{projectId}/job-notification-rules/job/{jobId}/notification-action/{notificationActionId}

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: application/json" \
 "http://localhost/api/v2/projects/{projectId}/job-notification-rules/job/{jobId}/notification-action/{notificationActionId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.JobNotificationRuleOperationsApi;

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

public class JobNotificationRuleOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        JobNotificationRuleOperationsApi apiInstance = new JobNotificationRuleOperationsApi();
        Integer jobId = 56; // Integer | 
        Integer notificationActionId = 56; // Integer | 
        String projectId = projectId_example; // String | 

        try {
            apiInstance.deleteJobNotificationRuleByJobIdAndNotificationActionIdV2(jobId, notificationActionId, projectId);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobNotificationRuleOperationsApi#deleteJobNotificationRuleByJobIdAndNotificationActionIdV2");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer jobId = new Integer(); // Integer | 
final Integer notificationActionId = new Integer(); // Integer | 
final String projectId = new String(); // String | 

try {
    final result = await api_instance.deleteJobNotificationRuleByJobIdAndNotificationActionIdV2(jobId, notificationActionId, projectId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteJobNotificationRuleByJobIdAndNotificationActionIdV2: $e\n');
}

import org.openapitools.client.api.JobNotificationRuleOperationsApi;

public class JobNotificationRuleOperationsApiExample {
    public static void main(String[] args) {
        JobNotificationRuleOperationsApi apiInstance = new JobNotificationRuleOperationsApi();
        Integer jobId = 56; // Integer | 
        Integer notificationActionId = 56; // Integer | 
        String projectId = projectId_example; // String | 

        try {
            apiInstance.deleteJobNotificationRuleByJobIdAndNotificationActionIdV2(jobId, notificationActionId, projectId);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobNotificationRuleOperationsApi#deleteJobNotificationRuleByJobIdAndNotificationActionIdV2");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
JobNotificationRuleOperationsApi *apiInstance = [[JobNotificationRuleOperationsApi alloc] init];
Integer *jobId = 56; //  (default to null)
Integer *notificationActionId = 56; //  (default to null)
String *projectId = projectId_example; //  (default to null)

// Removes the given Job Notification Action from the job.
[apiInstance deleteJobNotificationRuleByJobIdAndNotificationActionIdV2With:jobId
    notificationActionId:notificationActionId
    projectId:projectId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.JobNotificationRuleOperationsApi()
var jobId = 56; // {Integer} 
var notificationActionId = 56; // {Integer} 
var projectId = projectId_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteJobNotificationRuleByJobIdAndNotificationActionIdV2(jobId, notificationActionId, projectId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new JobNotificationRuleOperationsApi();
            var jobId = 56;  // Integer |  (default to null)
            var notificationActionId = 56;  // Integer |  (default to null)
            var projectId = projectId_example;  // String |  (default to null)

            try {
                // Removes the given Job Notification Action from the job.
                apiInstance.deleteJobNotificationRuleByJobIdAndNotificationActionIdV2(jobId, notificationActionId, projectId);
            } catch (Exception e) {
                Debug.Print("Exception when calling JobNotificationRuleOperationsApi.deleteJobNotificationRuleByJobIdAndNotificationActionIdV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\JobNotificationRuleOperationsApi();
$jobId = 56; // Integer | 
$notificationActionId = 56; // Integer | 
$projectId = projectId_example; // String | 

try {
    $api_instance->deleteJobNotificationRuleByJobIdAndNotificationActionIdV2($jobId, $notificationActionId, $projectId);
} catch (Exception $e) {
    echo 'Exception when calling JobNotificationRuleOperationsApi->deleteJobNotificationRuleByJobIdAndNotificationActionIdV2: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::JobNotificationRuleOperationsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::JobNotificationRuleOperationsApi->new();
my $jobId = 56; # Integer | 
my $notificationActionId = 56; # Integer | 
my $projectId = projectId_example; # String | 

eval {
    $api_instance->deleteJobNotificationRuleByJobIdAndNotificationActionIdV2(jobId => $jobId, notificationActionId => $notificationActionId, projectId => $projectId);
};
if ($@) {
    warn "Exception when calling JobNotificationRuleOperationsApi->deleteJobNotificationRuleByJobIdAndNotificationActionIdV2: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.JobNotificationRuleOperationsApi()
jobId = 56 # Integer |  (default to null)
notificationActionId = 56 # Integer |  (default to null)
projectId = projectId_example # String |  (default to null)

try:
    # Removes the given Job Notification Action from the job.
    api_instance.delete_job_notification_rule_by_job_id_and_notification_action_id_v2(jobId, notificationActionId, projectId)
except ApiException as e:
    print("Exception when calling JobNotificationRuleOperationsApi->deleteJobNotificationRuleByJobIdAndNotificationActionIdV2: %s\n" % e)
extern crate JobNotificationRuleOperationsApi;

pub fn main() {
    let jobId = 56; // Integer
    let notificationActionId = 56; // Integer
    let projectId = projectId_example; // String

    let mut context = JobNotificationRuleOperationsApi::Context::default();
    let result = client.deleteJobNotificationRuleByJobIdAndNotificationActionIdV2(jobId, notificationActionId, projectId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
jobId*
Integer (int32)
Required
notificationActionId*
Integer (int32)
Required
projectId*
String
Required

Responses


deleteJobNotificationRuleV2

Removes the given Job Notification Rule.


/api/v2/projects/{projectId}/job-notification-rules/{notificationRuleId}

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: application/json" \
 "http://localhost/api/v2/projects/{projectId}/job-notification-rules/{notificationRuleId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.JobNotificationRuleOperationsApi;

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

public class JobNotificationRuleOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        JobNotificationRuleOperationsApi apiInstance = new JobNotificationRuleOperationsApi();
        Integer notificationRuleId = 56; // Integer | 
        String projectId = projectId_example; // String | 

        try {
            apiInstance.deleteJobNotificationRuleV2(notificationRuleId, projectId);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobNotificationRuleOperationsApi#deleteJobNotificationRuleV2");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer notificationRuleId = new Integer(); // Integer | 
final String projectId = new String(); // String | 

try {
    final result = await api_instance.deleteJobNotificationRuleV2(notificationRuleId, projectId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteJobNotificationRuleV2: $e\n');
}

import org.openapitools.client.api.JobNotificationRuleOperationsApi;

public class JobNotificationRuleOperationsApiExample {
    public static void main(String[] args) {
        JobNotificationRuleOperationsApi apiInstance = new JobNotificationRuleOperationsApi();
        Integer notificationRuleId = 56; // Integer | 
        String projectId = projectId_example; // String | 

        try {
            apiInstance.deleteJobNotificationRuleV2(notificationRuleId, projectId);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobNotificationRuleOperationsApi#deleteJobNotificationRuleV2");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
JobNotificationRuleOperationsApi *apiInstance = [[JobNotificationRuleOperationsApi alloc] init];
Integer *notificationRuleId = 56; //  (default to null)
String *projectId = projectId_example; //  (default to null)

// Removes the given Job Notification Rule.
[apiInstance deleteJobNotificationRuleV2With:notificationRuleId
    projectId:projectId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.JobNotificationRuleOperationsApi()
var notificationRuleId = 56; // {Integer} 
var projectId = projectId_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteJobNotificationRuleV2(notificationRuleId, projectId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new JobNotificationRuleOperationsApi();
            var notificationRuleId = 56;  // Integer |  (default to null)
            var projectId = projectId_example;  // String |  (default to null)

            try {
                // Removes the given Job Notification Rule.
                apiInstance.deleteJobNotificationRuleV2(notificationRuleId, projectId);
            } catch (Exception e) {
                Debug.Print("Exception when calling JobNotificationRuleOperationsApi.deleteJobNotificationRuleV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\JobNotificationRuleOperationsApi();
$notificationRuleId = 56; // Integer | 
$projectId = projectId_example; // String | 

try {
    $api_instance->deleteJobNotificationRuleV2($notificationRuleId, $projectId);
} catch (Exception $e) {
    echo 'Exception when calling JobNotificationRuleOperationsApi->deleteJobNotificationRuleV2: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::JobNotificationRuleOperationsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::JobNotificationRuleOperationsApi->new();
my $notificationRuleId = 56; # Integer | 
my $projectId = projectId_example; # String | 

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

# Create an instance of the API class
api_instance = openapi_client.JobNotificationRuleOperationsApi()
notificationRuleId = 56 # Integer |  (default to null)
projectId = projectId_example # String |  (default to null)

try:
    # Removes the given Job Notification Rule.
    api_instance.delete_job_notification_rule_v2(notificationRuleId, projectId)
except ApiException as e:
    print("Exception when calling JobNotificationRuleOperationsApi->deleteJobNotificationRuleV2: %s\n" % e)
extern crate JobNotificationRuleOperationsApi;

pub fn main() {
    let notificationRuleId = 56; // Integer
    let projectId = projectId_example; // String

    let mut context = JobNotificationRuleOperationsApi::Context::default();
    let result = client.deleteJobNotificationRuleV2(notificationRuleId, projectId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
notificationRuleId*
Integer (int32)
Required
projectId*
String
Required

Responses


findAllJobNotificationsByJobIdV2

Retrieves Job Notification Actions for the given job.


/api/v2/projects/{projectId}/job-notification-rules/{jobId}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/api/v2/projects/{projectId}/job-notification-rules/{jobId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.JobNotificationRuleOperationsApi;

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

public class JobNotificationRuleOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        JobNotificationRuleOperationsApi apiInstance = new JobNotificationRuleOperationsApi();
        Integer jobId = 56; // Integer | 
        String projectId = projectId_example; // String | 

        try {
            array[JobNotificationRuleResponse] result = apiInstance.findAllJobNotificationsByJobIdV2(jobId, projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobNotificationRuleOperationsApi#findAllJobNotificationsByJobIdV2");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer jobId = new Integer(); // Integer | 
final String projectId = new String(); // String | 

try {
    final result = await api_instance.findAllJobNotificationsByJobIdV2(jobId, projectId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->findAllJobNotificationsByJobIdV2: $e\n');
}

import org.openapitools.client.api.JobNotificationRuleOperationsApi;

public class JobNotificationRuleOperationsApiExample {
    public static void main(String[] args) {
        JobNotificationRuleOperationsApi apiInstance = new JobNotificationRuleOperationsApi();
        Integer jobId = 56; // Integer | 
        String projectId = projectId_example; // String | 

        try {
            array[JobNotificationRuleResponse] result = apiInstance.findAllJobNotificationsByJobIdV2(jobId, projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobNotificationRuleOperationsApi#findAllJobNotificationsByJobIdV2");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
JobNotificationRuleOperationsApi *apiInstance = [[JobNotificationRuleOperationsApi alloc] init];
Integer *jobId = 56; //  (default to null)
String *projectId = projectId_example; //  (default to null)

// Retrieves Job Notification Actions for the given job.
[apiInstance findAllJobNotificationsByJobIdV2With:jobId
    projectId:projectId
              completionHandler: ^(array[JobNotificationRuleResponse] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.JobNotificationRuleOperationsApi()
var jobId = 56; // {Integer} 
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.findAllJobNotificationsByJobIdV2(jobId, projectId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new JobNotificationRuleOperationsApi();
            var jobId = 56;  // Integer |  (default to null)
            var projectId = projectId_example;  // String |  (default to null)

            try {
                // Retrieves Job Notification Actions for the given job.
                array[JobNotificationRuleResponse] result = apiInstance.findAllJobNotificationsByJobIdV2(jobId, projectId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling JobNotificationRuleOperationsApi.findAllJobNotificationsByJobIdV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\JobNotificationRuleOperationsApi();
$jobId = 56; // Integer | 
$projectId = projectId_example; // String | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::JobNotificationRuleOperationsApi->new();
my $jobId = 56; # Integer | 
my $projectId = projectId_example; # String | 

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

# Create an instance of the API class
api_instance = openapi_client.JobNotificationRuleOperationsApi()
jobId = 56 # Integer |  (default to null)
projectId = projectId_example # String |  (default to null)

try:
    # Retrieves Job Notification Actions for the given job.
    api_response = api_instance.find_all_job_notifications_by_job_id_v2(jobId, projectId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling JobNotificationRuleOperationsApi->findAllJobNotificationsByJobIdV2: %s\n" % e)
extern crate JobNotificationRuleOperationsApi;

pub fn main() {
    let jobId = 56; // Integer
    let projectId = projectId_example; // String

    let mut context = JobNotificationRuleOperationsApi::Context::default();
    let result = client.findAllJobNotificationsByJobIdV2(jobId, projectId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
jobId*
Integer (int32)
Required
projectId*
String
Required

Responses


JobOperations

copySsbJobV2

Creates a copy of a given SSB job.


/api/v2/projects/{projectId}/jobs/{id}/copy

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost/api/v2/projects/{projectId}/jobs/{id}/copy" \
 -d '{
  "copied_name" : "copied_name"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.JobOperationsApi;

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

public class JobOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        JobOperationsApi apiInstance = new JobOperationsApi();
        Integer id = 56; // Integer | 
        String projectId = projectId_example; // String | 
        JobCopyRequest jobCopyRequest = ; // JobCopyRequest | 

        try {
            FlinkResponseDto result = apiInstance.copySsbJobV2(id, projectId, jobCopyRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobOperationsApi#copySsbJobV2");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 
final String projectId = new String(); // String | 
final JobCopyRequest jobCopyRequest = new JobCopyRequest(); // JobCopyRequest | 

try {
    final result = await api_instance.copySsbJobV2(id, projectId, jobCopyRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->copySsbJobV2: $e\n');
}

import org.openapitools.client.api.JobOperationsApi;

public class JobOperationsApiExample {
    public static void main(String[] args) {
        JobOperationsApi apiInstance = new JobOperationsApi();
        Integer id = 56; // Integer | 
        String projectId = projectId_example; // String | 
        JobCopyRequest jobCopyRequest = ; // JobCopyRequest | 

        try {
            FlinkResponseDto result = apiInstance.copySsbJobV2(id, projectId, jobCopyRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobOperationsApi#copySsbJobV2");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
JobOperationsApi *apiInstance = [[JobOperationsApi alloc] init];
Integer *id = 56; //  (default to null)
String *projectId = projectId_example; //  (default to null)
JobCopyRequest *jobCopyRequest = ; // 

// Creates a copy of a given SSB job.
[apiInstance copySsbJobV2With:id
    projectId:projectId
    jobCopyRequest:jobCopyRequest
              completionHandler: ^(FlinkResponseDto output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.JobOperationsApi()
var id = 56; // {Integer} 
var projectId = projectId_example; // {String} 
var jobCopyRequest = ; // {JobCopyRequest} 

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

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

            // Create an instance of the API class
            var apiInstance = new JobOperationsApi();
            var id = 56;  // Integer |  (default to null)
            var projectId = projectId_example;  // String |  (default to null)
            var jobCopyRequest = new JobCopyRequest(); // JobCopyRequest | 

            try {
                // Creates a copy of a given SSB job.
                FlinkResponseDto result = apiInstance.copySsbJobV2(id, projectId, jobCopyRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling JobOperationsApi.copySsbJobV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\JobOperationsApi();
$id = 56; // Integer | 
$projectId = projectId_example; // String | 
$jobCopyRequest = ; // JobCopyRequest | 

try {
    $result = $api_instance->copySsbJobV2($id, $projectId, $jobCopyRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling JobOperationsApi->copySsbJobV2: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::JobOperationsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::JobOperationsApi->new();
my $id = 56; # Integer | 
my $projectId = projectId_example; # String | 
my $jobCopyRequest = WWW::OPenAPIClient::Object::JobCopyRequest->new(); # JobCopyRequest | 

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

# Create an instance of the API class
api_instance = openapi_client.JobOperationsApi()
id = 56 # Integer |  (default to null)
projectId = projectId_example # String |  (default to null)
jobCopyRequest =  # JobCopyRequest | 

try:
    # Creates a copy of a given SSB job.
    api_response = api_instance.copy_ssb_job_v2(id, projectId, jobCopyRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling JobOperationsApi->copySsbJobV2: %s\n" % e)
extern crate JobOperationsApi;

pub fn main() {
    let id = 56; // Integer
    let projectId = projectId_example; // String
    let jobCopyRequest = ; // JobCopyRequest

    let mut context = JobOperationsApi::Context::default();
    let result = client.copySsbJobV2(id, projectId, jobCopyRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required
projectId*
String
Required
Body parameters
Name Description
jobCopyRequest *

Responses


createSsbJobV2

Creates a new SSB job.


/api/v2/projects/{projectId}/jobs

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost/api/v2/projects/{projectId}/jobs" \
 -d '{
  "job_config" : "",
  "add_to_history" : true,
  "mv_endpoints" : [ {
    "endpoint" : "endpoint",
    "code" : "code",
    "dynamic_parameters" : [ "dynamic_parameters", "dynamic_parameters" ],
    "description" : "description",
    "bind_values" : [ "bind_values", "bind_values" ],
    "builder_data" : ""
  }, {
    "endpoint" : "endpoint",
    "code" : "code",
    "dynamic_parameters" : [ "dynamic_parameters", "dynamic_parameters" ],
    "description" : "description",
    "bind_values" : [ "bind_values", "bind_values" ],
    "builder_data" : ""
  } ],
  "selection" : false,
  "sql" : "sql"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.JobOperationsApi;

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

public class JobOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        JobOperationsApi apiInstance = new JobOperationsApi();
        String projectId = projectId_example; // String | 
        SqlExecuteRequest sqlExecuteRequest = ; // SqlExecuteRequest | 

        try {
            FlinkResponseDto result = apiInstance.createSsbJobV2(projectId, sqlExecuteRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobOperationsApi#createSsbJobV2");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String projectId = new String(); // String | 
final SqlExecuteRequest sqlExecuteRequest = new SqlExecuteRequest(); // SqlExecuteRequest | 

try {
    final result = await api_instance.createSsbJobV2(projectId, sqlExecuteRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->createSsbJobV2: $e\n');
}

import org.openapitools.client.api.JobOperationsApi;

public class JobOperationsApiExample {
    public static void main(String[] args) {
        JobOperationsApi apiInstance = new JobOperationsApi();
        String projectId = projectId_example; // String | 
        SqlExecuteRequest sqlExecuteRequest = ; // SqlExecuteRequest | 

        try {
            FlinkResponseDto result = apiInstance.createSsbJobV2(projectId, sqlExecuteRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobOperationsApi#createSsbJobV2");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
JobOperationsApi *apiInstance = [[JobOperationsApi alloc] init];
String *projectId = projectId_example; //  (default to null)
SqlExecuteRequest *sqlExecuteRequest = ; // 

// Creates a new SSB job.
[apiInstance createSsbJobV2With:projectId
    sqlExecuteRequest:sqlExecuteRequest
              completionHandler: ^(FlinkResponseDto output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.JobOperationsApi()
var projectId = projectId_example; // {String} 
var sqlExecuteRequest = ; // {SqlExecuteRequest} 

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

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

            // Create an instance of the API class
            var apiInstance = new JobOperationsApi();
            var projectId = projectId_example;  // String |  (default to null)
            var sqlExecuteRequest = new SqlExecuteRequest(); // SqlExecuteRequest | 

            try {
                // Creates a new SSB job.
                FlinkResponseDto result = apiInstance.createSsbJobV2(projectId, sqlExecuteRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling JobOperationsApi.createSsbJobV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\JobOperationsApi();
$projectId = projectId_example; // String | 
$sqlExecuteRequest = ; // SqlExecuteRequest | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::JobOperationsApi->new();
my $projectId = projectId_example; # String | 
my $sqlExecuteRequest = WWW::OPenAPIClient::Object::SqlExecuteRequest->new(); # SqlExecuteRequest | 

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

# Create an instance of the API class
api_instance = openapi_client.JobOperationsApi()
projectId = projectId_example # String |  (default to null)
sqlExecuteRequest =  # SqlExecuteRequest | 

try:
    # Creates a new SSB job.
    api_response = api_instance.create_ssb_job_v2(projectId, sqlExecuteRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling JobOperationsApi->createSsbJobV2: %s\n" % e)
extern crate JobOperationsApi;

pub fn main() {
    let projectId = projectId_example; // String
    let sqlExecuteRequest = ; // SqlExecuteRequest

    let mut context = JobOperationsApi::Context::default();
    let result = client.createSsbJobV2(projectId, sqlExecuteRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
projectId*
String
Required
Body parameters
Name Description
sqlExecuteRequest *

Responses


deleteMvApiEndpointV2

Removes a Materialized View of a given SSB job.


/api/v2/projects/{projectId}/jobs/{id}/mv

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: application/json" \
 "http://localhost/api/v2/projects/{projectId}/jobs/{id}/mv?endpoint=endpoint_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.JobOperationsApi;

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

public class JobOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        JobOperationsApi apiInstance = new JobOperationsApi();
        Integer id = 56; // Integer | 
        String endpoint = endpoint_example; // String | 
        String projectId = projectId_example; // String | 

        try {
            apiInstance.deleteMvApiEndpointV2(id, endpoint, projectId);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobOperationsApi#deleteMvApiEndpointV2");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 
final String endpoint = new String(); // String | 
final String projectId = new String(); // String | 

try {
    final result = await api_instance.deleteMvApiEndpointV2(id, endpoint, projectId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteMvApiEndpointV2: $e\n');
}

import org.openapitools.client.api.JobOperationsApi;

public class JobOperationsApiExample {
    public static void main(String[] args) {
        JobOperationsApi apiInstance = new JobOperationsApi();
        Integer id = 56; // Integer | 
        String endpoint = endpoint_example; // String | 
        String projectId = projectId_example; // String | 

        try {
            apiInstance.deleteMvApiEndpointV2(id, endpoint, projectId);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobOperationsApi#deleteMvApiEndpointV2");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
JobOperationsApi *apiInstance = [[JobOperationsApi alloc] init];
Integer *id = 56; //  (default to null)
String *endpoint = endpoint_example; //  (default to null)
String *projectId = projectId_example; //  (default to null)

// Removes a Materialized View of a given SSB job.
[apiInstance deleteMvApiEndpointV2With:id
    endpoint:endpoint
    projectId:projectId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.JobOperationsApi()
var id = 56; // {Integer} 
var endpoint = endpoint_example; // {String} 
var projectId = projectId_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteMvApiEndpointV2(id, endpoint, projectId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new JobOperationsApi();
            var id = 56;  // Integer |  (default to null)
            var endpoint = endpoint_example;  // String |  (default to null)
            var projectId = projectId_example;  // String |  (default to null)

            try {
                // Removes a Materialized View of a given SSB job.
                apiInstance.deleteMvApiEndpointV2(id, endpoint, projectId);
            } catch (Exception e) {
                Debug.Print("Exception when calling JobOperationsApi.deleteMvApiEndpointV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\JobOperationsApi();
$id = 56; // Integer | 
$endpoint = endpoint_example; // String | 
$projectId = projectId_example; // String | 

try {
    $api_instance->deleteMvApiEndpointV2($id, $endpoint, $projectId);
} catch (Exception $e) {
    echo 'Exception when calling JobOperationsApi->deleteMvApiEndpointV2: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::JobOperationsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::JobOperationsApi->new();
my $id = 56; # Integer | 
my $endpoint = endpoint_example; # String | 
my $projectId = projectId_example; # String | 

eval {
    $api_instance->deleteMvApiEndpointV2(id => $id, endpoint => $endpoint, projectId => $projectId);
};
if ($@) {
    warn "Exception when calling JobOperationsApi->deleteMvApiEndpointV2: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.JobOperationsApi()
id = 56 # Integer |  (default to null)
endpoint = endpoint_example # String |  (default to null)
projectId = projectId_example # String |  (default to null)

try:
    # Removes a Materialized View of a given SSB job.
    api_instance.delete_mv_api_endpoint_v2(id, endpoint, projectId)
except ApiException as e:
    print("Exception when calling JobOperationsApi->deleteMvApiEndpointV2: %s\n" % e)
extern crate JobOperationsApi;

pub fn main() {
    let id = 56; // Integer
    let endpoint = endpoint_example; // String
    let projectId = projectId_example; // String

    let mut context = JobOperationsApi::Context::default();
    let result = client.deleteMvApiEndpointV2(id, endpoint, projectId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required
projectId*
String
Required
Query parameters
Name Description
endpoint*
String
Required

Responses


deleteSsbJobV2

Removes the given job.


/api/v2/projects/{projectId}/jobs/{id}

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: application/json" \
 "http://localhost/api/v2/projects/{projectId}/jobs/{id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.JobOperationsApi;

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

public class JobOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        JobOperationsApi apiInstance = new JobOperationsApi();
        Integer id = 56; // Integer | 
        String projectId = projectId_example; // String | 

        try {
            apiInstance.deleteSsbJobV2(id, projectId);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobOperationsApi#deleteSsbJobV2");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 
final String projectId = new String(); // String | 

try {
    final result = await api_instance.deleteSsbJobV2(id, projectId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteSsbJobV2: $e\n');
}

import org.openapitools.client.api.JobOperationsApi;

public class JobOperationsApiExample {
    public static void main(String[] args) {
        JobOperationsApi apiInstance = new JobOperationsApi();
        Integer id = 56; // Integer | 
        String projectId = projectId_example; // String | 

        try {
            apiInstance.deleteSsbJobV2(id, projectId);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobOperationsApi#deleteSsbJobV2");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
JobOperationsApi *apiInstance = [[JobOperationsApi alloc] init];
Integer *id = 56; //  (default to null)
String *projectId = projectId_example; //  (default to null)

// Removes the given job.
[apiInstance deleteSsbJobV2With:id
    projectId:projectId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.JobOperationsApi()
var id = 56; // {Integer} 
var projectId = projectId_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteSsbJobV2(id, projectId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new JobOperationsApi();
            var id = 56;  // Integer |  (default to null)
            var projectId = projectId_example;  // String |  (default to null)

            try {
                // Removes the given job.
                apiInstance.deleteSsbJobV2(id, projectId);
            } catch (Exception e) {
                Debug.Print("Exception when calling JobOperationsApi.deleteSsbJobV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\JobOperationsApi();
$id = 56; // Integer | 
$projectId = projectId_example; // String | 

try {
    $api_instance->deleteSsbJobV2($id, $projectId);
} catch (Exception $e) {
    echo 'Exception when calling JobOperationsApi->deleteSsbJobV2: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::JobOperationsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::JobOperationsApi->new();
my $id = 56; # Integer | 
my $projectId = projectId_example; # String | 

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

# Create an instance of the API class
api_instance = openapi_client.JobOperationsApi()
id = 56 # Integer |  (default to null)
projectId = projectId_example # String |  (default to null)

try:
    # Removes the given job.
    api_instance.delete_ssb_job_v2(id, projectId)
except ApiException as e:
    print("Exception when calling JobOperationsApi->deleteSsbJobV2: %s\n" % e)
extern crate JobOperationsApi;

pub fn main() {
    let id = 56; // Integer
    let projectId = projectId_example; // String

    let mut context = JobOperationsApi::Context::default();
    let result = client.deleteSsbJobV2(id, projectId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required
projectId*
String
Required

Responses


executeV2

Executes the given SSB job. In case of a changed configuration, the job will be updated before execution.


/api/v2/projects/{projectId}/jobs/{id}/execute

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost/api/v2/projects/{projectId}/jobs/{id}/execute" \
 -d '{
  "job_config" : "",
  "add_to_history" : true,
  "mv_endpoints" : [ {
    "endpoint" : "endpoint",
    "code" : "code",
    "dynamic_parameters" : [ "dynamic_parameters", "dynamic_parameters" ],
    "description" : "description",
    "bind_values" : [ "bind_values", "bind_values" ],
    "builder_data" : ""
  }, {
    "endpoint" : "endpoint",
    "code" : "code",
    "dynamic_parameters" : [ "dynamic_parameters", "dynamic_parameters" ],
    "description" : "description",
    "bind_values" : [ "bind_values", "bind_values" ],
    "builder_data" : ""
  } ],
  "selection" : false,
  "sql" : "sql"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.JobOperationsApi;

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

public class JobOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        JobOperationsApi apiInstance = new JobOperationsApi();
        Integer id = 56; // Integer | 
        String projectId = projectId_example; // String | 
        SqlExecuteRequest sqlExecuteRequest = ; // SqlExecuteRequest | 

        try {
            SqlExecuteResponses result = apiInstance.executeV2(id, projectId, sqlExecuteRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobOperationsApi#executeV2");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 
final String projectId = new String(); // String | 
final SqlExecuteRequest sqlExecuteRequest = new SqlExecuteRequest(); // SqlExecuteRequest | 

try {
    final result = await api_instance.executeV2(id, projectId, sqlExecuteRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->executeV2: $e\n');
}

import org.openapitools.client.api.JobOperationsApi;

public class JobOperationsApiExample {
    public static void main(String[] args) {
        JobOperationsApi apiInstance = new JobOperationsApi();
        Integer id = 56; // Integer | 
        String projectId = projectId_example; // String | 
        SqlExecuteRequest sqlExecuteRequest = ; // SqlExecuteRequest | 

        try {
            SqlExecuteResponses result = apiInstance.executeV2(id, projectId, sqlExecuteRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobOperationsApi#executeV2");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
JobOperationsApi *apiInstance = [[JobOperationsApi alloc] init];
Integer *id = 56; //  (default to null)
String *projectId = projectId_example; //  (default to null)
SqlExecuteRequest *sqlExecuteRequest = ; //  (optional)

// Executes the given SSB job. In case of a changed configuration, the job will be updated before execution.
[apiInstance executeV2With:id
    projectId:projectId
    sqlExecuteRequest:sqlExecuteRequest
              completionHandler: ^(SqlExecuteResponses output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.JobOperationsApi()
var id = 56; // {Integer} 
var projectId = projectId_example; // {String} 
var opts = {
  'sqlExecuteRequest':  // {SqlExecuteRequest} 
};

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

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

            // Create an instance of the API class
            var apiInstance = new JobOperationsApi();
            var id = 56;  // Integer |  (default to null)
            var projectId = projectId_example;  // String |  (default to null)
            var sqlExecuteRequest = new SqlExecuteRequest(); // SqlExecuteRequest |  (optional) 

            try {
                // Executes the given SSB job. In case of a changed configuration, the job will be updated before execution.
                SqlExecuteResponses result = apiInstance.executeV2(id, projectId, sqlExecuteRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling JobOperationsApi.executeV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\JobOperationsApi();
$id = 56; // Integer | 
$projectId = projectId_example; // String | 
$sqlExecuteRequest = ; // SqlExecuteRequest | 

try {
    $result = $api_instance->executeV2($id, $projectId, $sqlExecuteRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling JobOperationsApi->executeV2: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::JobOperationsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::JobOperationsApi->new();
my $id = 56; # Integer | 
my $projectId = projectId_example; # String | 
my $sqlExecuteRequest = WWW::OPenAPIClient::Object::SqlExecuteRequest->new(); # SqlExecuteRequest | 

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

# Create an instance of the API class
api_instance = openapi_client.JobOperationsApi()
id = 56 # Integer |  (default to null)
projectId = projectId_example # String |  (default to null)
sqlExecuteRequest =  # SqlExecuteRequest |  (optional)

try:
    # Executes the given SSB job. In case of a changed configuration, the job will be updated before execution.
    api_response = api_instance.execute_v2(id, projectId, sqlExecuteRequest=sqlExecuteRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling JobOperationsApi->executeV2: %s\n" % e)
extern crate JobOperationsApi;

pub fn main() {
    let id = 56; // Integer
    let projectId = projectId_example; // String
    let sqlExecuteRequest = ; // SqlExecuteRequest

    let mut context = JobOperationsApi::Context::default();
    let result = client.executeV2(id, projectId, sqlExecuteRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required
projectId*
String
Required
Body parameters
Name Description
sqlExecuteRequest

Responses


getJobLogItemsV2

Retrieves the events of a given SSB job.


/api/v2/projects/{projectId}/jobs/{id}/events

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/api/v2/projects/{projectId}/jobs/{id}/events"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.JobOperationsApi;

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

public class JobOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        JobOperationsApi apiInstance = new JobOperationsApi();
        Integer id = 56; // Integer | 
        String projectId = projectId_example; // String | 

        try {
            array[JobLogItemDto] result = apiInstance.getJobLogItemsV2(id, projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobOperationsApi#getJobLogItemsV2");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 
final String projectId = new String(); // String | 

try {
    final result = await api_instance.getJobLogItemsV2(id, projectId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getJobLogItemsV2: $e\n');
}

import org.openapitools.client.api.JobOperationsApi;

public class JobOperationsApiExample {
    public static void main(String[] args) {
        JobOperationsApi apiInstance = new JobOperationsApi();
        Integer id = 56; // Integer | 
        String projectId = projectId_example; // String | 

        try {
            array[JobLogItemDto] result = apiInstance.getJobLogItemsV2(id, projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobOperationsApi#getJobLogItemsV2");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
JobOperationsApi *apiInstance = [[JobOperationsApi alloc] init];
Integer *id = 56; //  (default to null)
String *projectId = projectId_example; //  (default to null)

// Retrieves the events of a given SSB job.
[apiInstance getJobLogItemsV2With:id
    projectId:projectId
              completionHandler: ^(array[JobLogItemDto] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.JobOperationsApi()
var id = 56; // {Integer} 
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.getJobLogItemsV2(id, projectId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new JobOperationsApi();
            var id = 56;  // Integer |  (default to null)
            var projectId = projectId_example;  // String |  (default to null)

            try {
                // Retrieves the events of a given SSB job.
                array[JobLogItemDto] result = apiInstance.getJobLogItemsV2(id, projectId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling JobOperationsApi.getJobLogItemsV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\JobOperationsApi();
$id = 56; // Integer | 
$projectId = projectId_example; // String | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::JobOperationsApi->new();
my $id = 56; # Integer | 
my $projectId = projectId_example; # String | 

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

# Create an instance of the API class
api_instance = openapi_client.JobOperationsApi()
id = 56 # Integer |  (default to null)
projectId = projectId_example # String |  (default to null)

try:
    # Retrieves the events of a given SSB job.
    api_response = api_instance.get_job_log_items_v2(id, projectId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling JobOperationsApi->getJobLogItemsV2: %s\n" % e)
extern crate JobOperationsApi;

pub fn main() {
    let id = 56; // Integer
    let projectId = projectId_example; // String

    let mut context = JobOperationsApi::Context::default();
    let result = client.getJobLogItemsV2(id, projectId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required
projectId*
String
Required

Responses


getJobStateV2

Retrieves the state of a given SSB job.


/api/v2/projects/{projectId}/jobs/{id}/state

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/api/v2/projects/{projectId}/jobs/{id}/state"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.JobOperationsApi;

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

public class JobOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        JobOperationsApi apiInstance = new JobOperationsApi();
        Integer id = 56; // Integer | 
        String projectId = projectId_example; // String | 

        try {
            JobStateResponse result = apiInstance.getJobStateV2(id, projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobOperationsApi#getJobStateV2");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 
final String projectId = new String(); // String | 

try {
    final result = await api_instance.getJobStateV2(id, projectId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getJobStateV2: $e\n');
}

import org.openapitools.client.api.JobOperationsApi;

public class JobOperationsApiExample {
    public static void main(String[] args) {
        JobOperationsApi apiInstance = new JobOperationsApi();
        Integer id = 56; // Integer | 
        String projectId = projectId_example; // String | 

        try {
            JobStateResponse result = apiInstance.getJobStateV2(id, projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobOperationsApi#getJobStateV2");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
JobOperationsApi *apiInstance = [[JobOperationsApi alloc] init];
Integer *id = 56; //  (default to null)
String *projectId = projectId_example; //  (default to null)

// Retrieves the state of a given SSB job.
[apiInstance getJobStateV2With:id
    projectId:projectId
              completionHandler: ^(JobStateResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.JobOperationsApi()
var id = 56; // {Integer} 
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.getJobStateV2(id, projectId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new JobOperationsApi();
            var id = 56;  // Integer |  (default to null)
            var projectId = projectId_example;  // String |  (default to null)

            try {
                // Retrieves the state of a given SSB job.
                JobStateResponse result = apiInstance.getJobStateV2(id, projectId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling JobOperationsApi.getJobStateV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\JobOperationsApi();
$id = 56; // Integer | 
$projectId = projectId_example; // String | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::JobOperationsApi->new();
my $id = 56; # Integer | 
my $projectId = projectId_example; # String | 

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

# Create an instance of the API class
api_instance = openapi_client.JobOperationsApi()
id = 56 # Integer |  (default to null)
projectId = projectId_example # String |  (default to null)

try:
    # Retrieves the state of a given SSB job.
    api_response = api_instance.get_job_state_v2(id, projectId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling JobOperationsApi->getJobStateV2: %s\n" % e)
extern crate JobOperationsApi;

pub fn main() {
    let id = 56; // Integer
    let projectId = projectId_example; // String

    let mut context = JobOperationsApi::Context::default();
    let result = client.getJobStateV2(id, projectId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required
projectId*
String
Required

Responses


getSsbJobV2

Retrieves the given SSB job.


/api/v2/projects/{projectId}/jobs/{id}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/api/v2/projects/{projectId}/jobs/{id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.JobOperationsApi;

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

public class JobOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        JobOperationsApi apiInstance = new JobOperationsApi();
        Integer id = 56; // Integer | 
        String projectId = projectId_example; // String | 

        try {
            FlinkResponseDto result = apiInstance.getSsbJobV2(id, projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobOperationsApi#getSsbJobV2");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 
final String projectId = new String(); // String | 

try {
    final result = await api_instance.getSsbJobV2(id, projectId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getSsbJobV2: $e\n');
}

import org.openapitools.client.api.JobOperationsApi;

public class JobOperationsApiExample {
    public static void main(String[] args) {
        JobOperationsApi apiInstance = new JobOperationsApi();
        Integer id = 56; // Integer | 
        String projectId = projectId_example; // String | 

        try {
            FlinkResponseDto result = apiInstance.getSsbJobV2(id, projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobOperationsApi#getSsbJobV2");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
JobOperationsApi *apiInstance = [[JobOperationsApi alloc] init];
Integer *id = 56; //  (default to null)
String *projectId = projectId_example; //  (default to null)

// Retrieves the given SSB job.
[apiInstance getSsbJobV2With:id
    projectId:projectId
              completionHandler: ^(FlinkResponseDto output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.JobOperationsApi()
var id = 56; // {Integer} 
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.getSsbJobV2(id, projectId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new JobOperationsApi();
            var id = 56;  // Integer |  (default to null)
            var projectId = projectId_example;  // String |  (default to null)

            try {
                // Retrieves the given SSB job.
                FlinkResponseDto result = apiInstance.getSsbJobV2(id, projectId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling JobOperationsApi.getSsbJobV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\JobOperationsApi();
$id = 56; // Integer | 
$projectId = projectId_example; // String | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::JobOperationsApi->new();
my $id = 56; # Integer | 
my $projectId = projectId_example; # String | 

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

# Create an instance of the API class
api_instance = openapi_client.JobOperationsApi()
id = 56 # Integer |  (default to null)
projectId = projectId_example # String |  (default to null)

try:
    # Retrieves the given SSB job.
    api_response = api_instance.get_ssb_job_v2(id, projectId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling JobOperationsApi->getSsbJobV2: %s\n" % e)
extern crate JobOperationsApi;

pub fn main() {
    let id = 56; // Integer
    let projectId = projectId_example; // String

    let mut context = JobOperationsApi::Context::default();
    let result = client.getSsbJobV2(id, projectId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required
projectId*
String
Required

Responses


getSsbJobsV2

Retrieves SSB jobs.


/api/v2/projects/{projectId}/jobs

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/api/v2/projects/{projectId}/jobs?state=state_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.JobOperationsApi;

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

public class JobOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        JobOperationsApi apiInstance = new JobOperationsApi();
        String projectId = projectId_example; // String | 
        String state = state_example; // String | Filters jobs by state.

        try {
            FlinkJobsResponse result = apiInstance.getSsbJobsV2(projectId, state);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobOperationsApi#getSsbJobsV2");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String projectId = new String(); // String | 
final String state = new String(); // String | Filters jobs by state.

try {
    final result = await api_instance.getSsbJobsV2(projectId, state);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getSsbJobsV2: $e\n');
}

import org.openapitools.client.api.JobOperationsApi;

public class JobOperationsApiExample {
    public static void main(String[] args) {
        JobOperationsApi apiInstance = new JobOperationsApi();
        String projectId = projectId_example; // String | 
        String state = state_example; // String | Filters jobs by state.

        try {
            FlinkJobsResponse result = apiInstance.getSsbJobsV2(projectId, state);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobOperationsApi#getSsbJobsV2");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
JobOperationsApi *apiInstance = [[JobOperationsApi alloc] init];
String *projectId = projectId_example; //  (default to null)
String *state = state_example; // Filters jobs by state. (optional) (default to null)

// Retrieves SSB jobs.
[apiInstance getSsbJobsV2With:projectId
    state:state
              completionHandler: ^(FlinkJobsResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.JobOperationsApi()
var projectId = projectId_example; // {String} 
var opts = {
  'state': state_example // {String} Filters jobs by state.
};

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

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

            // Create an instance of the API class
            var apiInstance = new JobOperationsApi();
            var projectId = projectId_example;  // String |  (default to null)
            var state = state_example;  // String | Filters jobs by state. (optional)  (default to null)

            try {
                // Retrieves SSB jobs.
                FlinkJobsResponse result = apiInstance.getSsbJobsV2(projectId, state);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling JobOperationsApi.getSsbJobsV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\JobOperationsApi();
$projectId = projectId_example; // String | 
$state = state_example; // String | Filters jobs by state.

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::JobOperationsApi->new();
my $projectId = projectId_example; # String | 
my $state = state_example; # String | Filters jobs by state.

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

# Create an instance of the API class
api_instance = openapi_client.JobOperationsApi()
projectId = projectId_example # String |  (default to null)
state = state_example # String | Filters jobs by state. (optional) (default to null)

try:
    # Retrieves SSB jobs.
    api_response = api_instance.get_ssb_jobs_v2(projectId, state=state)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling JobOperationsApi->getSsbJobsV2: %s\n" % e)
extern crate JobOperationsApi;

pub fn main() {
    let projectId = projectId_example; // String
    let state = state_example; // String

    let mut context = JobOperationsApi::Context::default();
    let result = client.getSsbJobsV2(projectId, state, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
projectId*
String
Required
Query parameters
Name Description
state
String
Filters jobs by state.

Responses


stopJobV2

Stops the given SSB job.


/api/v2/projects/{projectId}/jobs/{id}/stop

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost/api/v2/projects/{projectId}/jobs/{id}/stop" \
 -d '{
  "savepoint" : true,
  "savepoint_path" : "savepoint_path",
  "timeout" : 0
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.JobOperationsApi;

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

public class JobOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        JobOperationsApi apiInstance = new JobOperationsApi();
        Integer id = 56; // Integer | 
        String projectId = projectId_example; // String | 
        JobStopRequest jobStopRequest = ; // JobStopRequest | 

        try {
            JobStopResponse result = apiInstance.stopJobV2(id, projectId, jobStopRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobOperationsApi#stopJobV2");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 
final String projectId = new String(); // String | 
final JobStopRequest jobStopRequest = new JobStopRequest(); // JobStopRequest | 

try {
    final result = await api_instance.stopJobV2(id, projectId, jobStopRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->stopJobV2: $e\n');
}

import org.openapitools.client.api.JobOperationsApi;

public class JobOperationsApiExample {
    public static void main(String[] args) {
        JobOperationsApi apiInstance = new JobOperationsApi();
        Integer id = 56; // Integer | 
        String projectId = projectId_example; // String | 
        JobStopRequest jobStopRequest = ; // JobStopRequest | 

        try {
            JobStopResponse result = apiInstance.stopJobV2(id, projectId, jobStopRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobOperationsApi#stopJobV2");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
JobOperationsApi *apiInstance = [[JobOperationsApi alloc] init];
Integer *id = 56; //  (default to null)
String *projectId = projectId_example; //  (default to null)
JobStopRequest *jobStopRequest = ; // 

// Stops the given SSB job.
[apiInstance stopJobV2With:id
    projectId:projectId
    jobStopRequest:jobStopRequest
              completionHandler: ^(JobStopResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.JobOperationsApi()
var id = 56; // {Integer} 
var projectId = projectId_example; // {String} 
var jobStopRequest = ; // {JobStopRequest} 

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

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

            // Create an instance of the API class
            var apiInstance = new JobOperationsApi();
            var id = 56;  // Integer |  (default to null)
            var projectId = projectId_example;  // String |  (default to null)
            var jobStopRequest = new JobStopRequest(); // JobStopRequest | 

            try {
                // Stops the given SSB job.
                JobStopResponse result = apiInstance.stopJobV2(id, projectId, jobStopRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling JobOperationsApi.stopJobV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\JobOperationsApi();
$id = 56; // Integer | 
$projectId = projectId_example; // String | 
$jobStopRequest = ; // JobStopRequest | 

try {
    $result = $api_instance->stopJobV2($id, $projectId, $jobStopRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling JobOperationsApi->stopJobV2: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::JobOperationsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::JobOperationsApi->new();
my $id = 56; # Integer | 
my $projectId = projectId_example; # String | 
my $jobStopRequest = WWW::OPenAPIClient::Object::JobStopRequest->new(); # JobStopRequest | 

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

# Create an instance of the API class
api_instance = openapi_client.JobOperationsApi()
id = 56 # Integer |  (default to null)
projectId = projectId_example # String |  (default to null)
jobStopRequest =  # JobStopRequest | 

try:
    # Stops the given SSB job.
    api_response = api_instance.stop_job_v2(id, projectId, jobStopRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling JobOperationsApi->stopJobV2: %s\n" % e)
extern crate JobOperationsApi;

pub fn main() {
    let id = 56; // Integer
    let projectId = projectId_example; // String
    let jobStopRequest = ; // JobStopRequest

    let mut context = JobOperationsApi::Context::default();
    let result = client.stopJobV2(id, projectId, jobStopRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required
projectId*
String
Required
Body parameters
Name Description
jobStopRequest *

Responses


updateSsbJobV2

Updates the given SSB job.


/api/v2/projects/{projectId}/jobs/{id}

Usage and SDK Samples

curl -X PUT \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost/api/v2/projects/{projectId}/jobs/{id}" \
 -d '{
  "job_config" : "",
  "add_to_history" : true,
  "mv_endpoints" : [ {
    "endpoint" : "endpoint",
    "code" : "code",
    "dynamic_parameters" : [ "dynamic_parameters", "dynamic_parameters" ],
    "description" : "description",
    "bind_values" : [ "bind_values", "bind_values" ],
    "builder_data" : ""
  }, {
    "endpoint" : "endpoint",
    "code" : "code",
    "dynamic_parameters" : [ "dynamic_parameters", "dynamic_parameters" ],
    "description" : "description",
    "bind_values" : [ "bind_values", "bind_values" ],
    "builder_data" : ""
  } ],
  "selection" : false,
  "sql" : "sql"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.JobOperationsApi;

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

public class JobOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        JobOperationsApi apiInstance = new JobOperationsApi();
        Integer id = 56; // Integer | 
        String projectId = projectId_example; // String | 
        SqlExecuteRequest sqlExecuteRequest = ; // SqlExecuteRequest | 

        try {
            FlinkResponseDto result = apiInstance.updateSsbJobV2(id, projectId, sqlExecuteRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobOperationsApi#updateSsbJobV2");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 
final String projectId = new String(); // String | 
final SqlExecuteRequest sqlExecuteRequest = new SqlExecuteRequest(); // SqlExecuteRequest | 

try {
    final result = await api_instance.updateSsbJobV2(id, projectId, sqlExecuteRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateSsbJobV2: $e\n');
}

import org.openapitools.client.api.JobOperationsApi;

public class JobOperationsApiExample {
    public static void main(String[] args) {
        JobOperationsApi apiInstance = new JobOperationsApi();
        Integer id = 56; // Integer | 
        String projectId = projectId_example; // String | 
        SqlExecuteRequest sqlExecuteRequest = ; // SqlExecuteRequest | 

        try {
            FlinkResponseDto result = apiInstance.updateSsbJobV2(id, projectId, sqlExecuteRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobOperationsApi#updateSsbJobV2");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
JobOperationsApi *apiInstance = [[JobOperationsApi alloc] init];
Integer *id = 56; //  (default to null)
String *projectId = projectId_example; //  (default to null)
SqlExecuteRequest *sqlExecuteRequest = ; // 

// Updates the given SSB job.
[apiInstance updateSsbJobV2With:id
    projectId:projectId
    sqlExecuteRequest:sqlExecuteRequest
              completionHandler: ^(FlinkResponseDto output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.JobOperationsApi()
var id = 56; // {Integer} 
var projectId = projectId_example; // {String} 
var sqlExecuteRequest = ; // {SqlExecuteRequest} 

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

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

            // Create an instance of the API class
            var apiInstance = new JobOperationsApi();
            var id = 56;  // Integer |  (default to null)
            var projectId = projectId_example;  // String |  (default to null)
            var sqlExecuteRequest = new SqlExecuteRequest(); // SqlExecuteRequest | 

            try {
                // Updates the given SSB job.
                FlinkResponseDto result = apiInstance.updateSsbJobV2(id, projectId, sqlExecuteRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling JobOperationsApi.updateSsbJobV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\JobOperationsApi();
$id = 56; // Integer | 
$projectId = projectId_example; // String | 
$sqlExecuteRequest = ; // SqlExecuteRequest | 

try {
    $result = $api_instance->updateSsbJobV2($id, $projectId, $sqlExecuteRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling JobOperationsApi->updateSsbJobV2: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::JobOperationsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::JobOperationsApi->new();
my $id = 56; # Integer | 
my $projectId = projectId_example; # String | 
my $sqlExecuteRequest = WWW::OPenAPIClient::Object::SqlExecuteRequest->new(); # SqlExecuteRequest | 

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

# Create an instance of the API class
api_instance = openapi_client.JobOperationsApi()
id = 56 # Integer |  (default to null)
projectId = projectId_example # String |  (default to null)
sqlExecuteRequest =  # SqlExecuteRequest | 

try:
    # Updates the given SSB job.
    api_response = api_instance.update_ssb_job_v2(id, projectId, sqlExecuteRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling JobOperationsApi->updateSsbJobV2: %s\n" % e)
extern crate JobOperationsApi;

pub fn main() {
    let id = 56; // Integer
    let projectId = projectId_example; // String
    let sqlExecuteRequest = ; // SqlExecuteRequest

    let mut context = JobOperationsApi::Context::default();
    let result = client.updateSsbJobV2(id, projectId, sqlExecuteRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required
projectId*
String
Required
Body parameters
Name Description
sqlExecuteRequest *

Responses


upsertMvApiEndpointV2

Creates or updates a Materialized View of a given job.


/api/v2/projects/{projectId}/jobs/{id}/mv

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost/api/v2/projects/{projectId}/jobs/{id}/mv" \
 -d '{
  "endpoint" : "endpoint",
  "code" : "code",
  "dynamic_parameters" : [ "dynamic_parameters", "dynamic_parameters" ],
  "description" : "description",
  "bind_values" : [ "bind_values", "bind_values" ],
  "builder_data" : ""
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.JobOperationsApi;

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

public class JobOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        JobOperationsApi apiInstance = new JobOperationsApi();
        Integer id = 56; // Integer | 
        String projectId = projectId_example; // String | 
        ApiEndpointDto apiEndpointDto = ; // ApiEndpointDto | 

        try {
            ApiEndpointDto result = apiInstance.upsertMvApiEndpointV2(id, projectId, apiEndpointDto);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobOperationsApi#upsertMvApiEndpointV2");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 
final String projectId = new String(); // String | 
final ApiEndpointDto apiEndpointDto = new ApiEndpointDto(); // ApiEndpointDto | 

try {
    final result = await api_instance.upsertMvApiEndpointV2(id, projectId, apiEndpointDto);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->upsertMvApiEndpointV2: $e\n');
}

import org.openapitools.client.api.JobOperationsApi;

public class JobOperationsApiExample {
    public static void main(String[] args) {
        JobOperationsApi apiInstance = new JobOperationsApi();
        Integer id = 56; // Integer | 
        String projectId = projectId_example; // String | 
        ApiEndpointDto apiEndpointDto = ; // ApiEndpointDto | 

        try {
            ApiEndpointDto result = apiInstance.upsertMvApiEndpointV2(id, projectId, apiEndpointDto);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobOperationsApi#upsertMvApiEndpointV2");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
JobOperationsApi *apiInstance = [[JobOperationsApi alloc] init];
Integer *id = 56; //  (default to null)
String *projectId = projectId_example; //  (default to null)
ApiEndpointDto *apiEndpointDto = ; // 

// Creates or updates a Materialized View of a given job.
[apiInstance upsertMvApiEndpointV2With:id
    projectId:projectId
    apiEndpointDto:apiEndpointDto
              completionHandler: ^(ApiEndpointDto output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.JobOperationsApi()
var id = 56; // {Integer} 
var projectId = projectId_example; // {String} 
var apiEndpointDto = ; // {ApiEndpointDto} 

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

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

            // Create an instance of the API class
            var apiInstance = new JobOperationsApi();
            var id = 56;  // Integer |  (default to null)
            var projectId = projectId_example;  // String |  (default to null)
            var apiEndpointDto = new ApiEndpointDto(); // ApiEndpointDto | 

            try {
                // Creates or updates a Materialized View of a given job.
                ApiEndpointDto result = apiInstance.upsertMvApiEndpointV2(id, projectId, apiEndpointDto);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling JobOperationsApi.upsertMvApiEndpointV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\JobOperationsApi();
$id = 56; // Integer | 
$projectId = projectId_example; // String | 
$apiEndpointDto = ; // ApiEndpointDto | 

try {
    $result = $api_instance->upsertMvApiEndpointV2($id, $projectId, $apiEndpointDto);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling JobOperationsApi->upsertMvApiEndpointV2: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::JobOperationsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::JobOperationsApi->new();
my $id = 56; # Integer | 
my $projectId = projectId_example; # String | 
my $apiEndpointDto = WWW::OPenAPIClient::Object::ApiEndpointDto->new(); # ApiEndpointDto | 

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

# Create an instance of the API class
api_instance = openapi_client.JobOperationsApi()
id = 56 # Integer |  (default to null)
projectId = projectId_example # String |  (default to null)
apiEndpointDto =  # ApiEndpointDto | 

try:
    # Creates or updates a Materialized View of a given job.
    api_response = api_instance.upsert_mv_api_endpoint_v2(id, projectId, apiEndpointDto)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling JobOperationsApi->upsertMvApiEndpointV2: %s\n" % e)
extern crate JobOperationsApi;

pub fn main() {
    let id = 56; // Integer
    let projectId = projectId_example; // String
    let apiEndpointDto = ; // ApiEndpointDto

    let mut context = JobOperationsApi::Context::default();
    let result = client.upsertMvApiEndpointV2(id, projectId, apiEndpointDto, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required
projectId*
String
Required
Body parameters
Name Description
apiEndpointDto *

Responses


KafkaController

getDependentCatalogs


/internal/kafka/{providerId}/dependent-catalogs

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/internal/kafka/{providerId}/dependent-catalogs"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.KafkaControllerApi;

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

public class KafkaControllerApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        KafkaControllerApi apiInstance = new KafkaControllerApi();
        String providerId = providerId_example; // String | 

        try {
            array['String'] result = apiInstance.getDependentCatalogs(providerId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KafkaControllerApi#getDependentCatalogs");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String providerId = new String(); // String | 

try {
    final result = await api_instance.getDependentCatalogs(providerId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getDependentCatalogs: $e\n');
}

import org.openapitools.client.api.KafkaControllerApi;

public class KafkaControllerApiExample {
    public static void main(String[] args) {
        KafkaControllerApi apiInstance = new KafkaControllerApi();
        String providerId = providerId_example; // String | 

        try {
            array['String'] result = apiInstance.getDependentCatalogs(providerId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KafkaControllerApi#getDependentCatalogs");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
KafkaControllerApi *apiInstance = [[KafkaControllerApi alloc] init];
String *providerId = providerId_example; //  (default to null)

[apiInstance getDependentCatalogsWith:providerId
              completionHandler: ^(array['String'] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.KafkaControllerApi()
var providerId = providerId_example; // {String} 

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

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

            // Create an instance of the API class
            var apiInstance = new KafkaControllerApi();
            var providerId = providerId_example;  // String |  (default to null)

            try {
                array['String'] result = apiInstance.getDependentCatalogs(providerId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling KafkaControllerApi.getDependentCatalogs: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\KafkaControllerApi();
$providerId = providerId_example; // String | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::KafkaControllerApi->new();
my $providerId = providerId_example; # String | 

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

# Create an instance of the API class
api_instance = openapi_client.KafkaControllerApi()
providerId = providerId_example # String |  (default to null)

try:
    api_response = api_instance.get_dependent_catalogs(providerId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling KafkaControllerApi->getDependentCatalogs: %s\n" % e)
extern crate KafkaControllerApi;

pub fn main() {
    let providerId = providerId_example; // String

    let mut context = KafkaControllerApi::Context::default();
    let result = client.getDependentCatalogs(providerId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
providerId*
String
Required

Responses


getSchema


/internal/kafka/{providerId}/schema

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/internal/kafka/{providerId}/schema?topic_name=topicName_example&transformation=transformation_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.KafkaControllerApi;

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

public class KafkaControllerApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        KafkaControllerApi apiInstance = new KafkaControllerApi();
        String providerId = providerId_example; // String | 
        String topicName = topicName_example; // String | 
        String transformation = transformation_example; // String | 

        try {
            oas_any_type_not_mapped result = apiInstance.getSchema(providerId, topicName, transformation);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KafkaControllerApi#getSchema");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String providerId = new String(); // String | 
final String topicName = new String(); // String | 
final String transformation = new String(); // String | 

try {
    final result = await api_instance.getSchema(providerId, topicName, transformation);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getSchema: $e\n');
}

import org.openapitools.client.api.KafkaControllerApi;

public class KafkaControllerApiExample {
    public static void main(String[] args) {
        KafkaControllerApi apiInstance = new KafkaControllerApi();
        String providerId = providerId_example; // String | 
        String topicName = topicName_example; // String | 
        String transformation = transformation_example; // String | 

        try {
            oas_any_type_not_mapped result = apiInstance.getSchema(providerId, topicName, transformation);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KafkaControllerApi#getSchema");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
KafkaControllerApi *apiInstance = [[KafkaControllerApi alloc] init];
String *providerId = providerId_example; //  (default to null)
String *topicName = topicName_example; //  (default to null)
String *transformation = transformation_example; //  (optional) (default to null)

[apiInstance getSchemaWith:providerId
    topicName:topicName
    transformation:transformation
              completionHandler: ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.KafkaControllerApi()
var providerId = providerId_example; // {String} 
var topicName = topicName_example; // {String} 
var opts = {
  'transformation': transformation_example // {String} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getSchema(providerId, topicName, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new KafkaControllerApi();
            var providerId = providerId_example;  // String |  (default to null)
            var topicName = topicName_example;  // String |  (default to null)
            var transformation = transformation_example;  // String |  (optional)  (default to null)

            try {
                oas_any_type_not_mapped result = apiInstance.getSchema(providerId, topicName, transformation);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling KafkaControllerApi.getSchema: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\KafkaControllerApi();
$providerId = providerId_example; // String | 
$topicName = topicName_example; // String | 
$transformation = transformation_example; // String | 

try {
    $result = $api_instance->getSchema($providerId, $topicName, $transformation);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling KafkaControllerApi->getSchema: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::KafkaControllerApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::KafkaControllerApi->new();
my $providerId = providerId_example; # String | 
my $topicName = topicName_example; # String | 
my $transformation = transformation_example; # String | 

eval {
    my $result = $api_instance->getSchema(providerId => $providerId, topicName => $topicName, transformation => $transformation);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling KafkaControllerApi->getSchema: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.KafkaControllerApi()
providerId = providerId_example # String |  (default to null)
topicName = topicName_example # String |  (default to null)
transformation = transformation_example # String |  (optional) (default to null)

try:
    api_response = api_instance.get_schema(providerId, topicName, transformation=transformation)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling KafkaControllerApi->getSchema: %s\n" % e)
extern crate KafkaControllerApi;

pub fn main() {
    let providerId = providerId_example; // String
    let topicName = topicName_example; // String
    let transformation = transformation_example; // String

    let mut context = KafkaControllerApi::Context::default();
    let result = client.getSchema(providerId, topicName, transformation, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
providerId*
String
Required
Query parameters
Name Description
topic_name*
String
Required
transformation
String

Responses


getTopics


/internal/kafka/{providerId}/topics

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/internal/kafka/{providerId}/topics"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.KafkaControllerApi;

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

public class KafkaControllerApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        KafkaControllerApi apiInstance = new KafkaControllerApi();
        String providerId = providerId_example; // String | 

        try {
            KafkaTopicsResponse result = apiInstance.getTopics(providerId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KafkaControllerApi#getTopics");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String providerId = new String(); // String | 

try {
    final result = await api_instance.getTopics(providerId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getTopics: $e\n');
}

import org.openapitools.client.api.KafkaControllerApi;

public class KafkaControllerApiExample {
    public static void main(String[] args) {
        KafkaControllerApi apiInstance = new KafkaControllerApi();
        String providerId = providerId_example; // String | 

        try {
            KafkaTopicsResponse result = apiInstance.getTopics(providerId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KafkaControllerApi#getTopics");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
KafkaControllerApi *apiInstance = [[KafkaControllerApi alloc] init];
String *providerId = providerId_example; //  (default to null)

[apiInstance getTopicsWith:providerId
              completionHandler: ^(KafkaTopicsResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.KafkaControllerApi()
var providerId = providerId_example; // {String} 

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

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

            // Create an instance of the API class
            var apiInstance = new KafkaControllerApi();
            var providerId = providerId_example;  // String |  (default to null)

            try {
                KafkaTopicsResponse result = apiInstance.getTopics(providerId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling KafkaControllerApi.getTopics: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\KafkaControllerApi();
$providerId = providerId_example; // String | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::KafkaControllerApi->new();
my $providerId = providerId_example; # String | 

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

# Create an instance of the API class
api_instance = openapi_client.KafkaControllerApi()
providerId = providerId_example # String |  (default to null)

try:
    api_response = api_instance.get_topics(providerId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling KafkaControllerApi->getTopics: %s\n" % e)
extern crate KafkaControllerApi;

pub fn main() {
    let providerId = providerId_example; // String

    let mut context = KafkaControllerApi::Context::default();
    let result = client.getTopics(providerId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
providerId*
String
Required

Responses


KubernetesCustomResourceOperations

deleteJobResource

Removes the kubernetes custom resource associated with the given job.


/api/v2/kubernetes/resources/jobs/{id}

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: application/json" \
 "http://localhost/api/v2/kubernetes/resources/jobs/{id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.KubernetesCustomResourceOperationsApi;

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

public class KubernetesCustomResourceOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        KubernetesCustomResourceOperationsApi apiInstance = new KubernetesCustomResourceOperationsApi();
        Integer id = 56; // Integer | 

        try {
            apiInstance.deleteJobResource(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling KubernetesCustomResourceOperationsApi#deleteJobResource");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 

try {
    final result = await api_instance.deleteJobResource(id);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteJobResource: $e\n');
}

import org.openapitools.client.api.KubernetesCustomResourceOperationsApi;

public class KubernetesCustomResourceOperationsApiExample {
    public static void main(String[] args) {
        KubernetesCustomResourceOperationsApi apiInstance = new KubernetesCustomResourceOperationsApi();
        Integer id = 56; // Integer | 

        try {
            apiInstance.deleteJobResource(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling KubernetesCustomResourceOperationsApi#deleteJobResource");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
KubernetesCustomResourceOperationsApi *apiInstance = [[KubernetesCustomResourceOperationsApi alloc] init];
Integer *id = 56; //  (default to null)

// Removes the kubernetes custom resource associated with the given job.
[apiInstance deleteJobResourceWith:id
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.KubernetesCustomResourceOperationsApi()
var id = 56; // {Integer} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteJobResource(id, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new KubernetesCustomResourceOperationsApi();
            var id = 56;  // Integer |  (default to null)

            try {
                // Removes the kubernetes custom resource associated with the given job.
                apiInstance.deleteJobResource(id);
            } catch (Exception e) {
                Debug.Print("Exception when calling KubernetesCustomResourceOperationsApi.deleteJobResource: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\KubernetesCustomResourceOperationsApi();
$id = 56; // Integer | 

try {
    $api_instance->deleteJobResource($id);
} catch (Exception $e) {
    echo 'Exception when calling KubernetesCustomResourceOperationsApi->deleteJobResource: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::KubernetesCustomResourceOperationsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::KubernetesCustomResourceOperationsApi->new();
my $id = 56; # Integer | 

eval {
    $api_instance->deleteJobResource(id => $id);
};
if ($@) {
    warn "Exception when calling KubernetesCustomResourceOperationsApi->deleteJobResource: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.KubernetesCustomResourceOperationsApi()
id = 56 # Integer |  (default to null)

try:
    # Removes the kubernetes custom resource associated with the given job.
    api_instance.delete_job_resource(id)
except ApiException as e:
    print("Exception when calling KubernetesCustomResourceOperationsApi->deleteJobResource: %s\n" % e)
extern crate KubernetesCustomResourceOperationsApi;

pub fn main() {
    let id = 56; // Integer

    let mut context = KubernetesCustomResourceOperationsApi::Context::default();
    let result = client.deleteJobResource(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required

Responses


KubernetesFlinkDashboardProxyControllerV2

proxyFlinkDashboard


/flink-dashboard/{jobId}/**

Usage and SDK Samples

curl -X GET \
 -H "Accept: */*" \
 "http://localhost/flink-dashboard/{jobId}/**"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.KubernetesFlinkDashboardProxyControllerV2Api;

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

public class KubernetesFlinkDashboardProxyControllerV2ApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        KubernetesFlinkDashboardProxyControllerV2Api apiInstance = new KubernetesFlinkDashboardProxyControllerV2Api();
        Integer jobId = 56; // Integer | 

        try {
            Object result = apiInstance.proxyFlinkDashboard(jobId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KubernetesFlinkDashboardProxyControllerV2Api#proxyFlinkDashboard");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer jobId = new Integer(); // Integer | 

try {
    final result = await api_instance.proxyFlinkDashboard(jobId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->proxyFlinkDashboard: $e\n');
}

import org.openapitools.client.api.KubernetesFlinkDashboardProxyControllerV2Api;

public class KubernetesFlinkDashboardProxyControllerV2ApiExample {
    public static void main(String[] args) {
        KubernetesFlinkDashboardProxyControllerV2Api apiInstance = new KubernetesFlinkDashboardProxyControllerV2Api();
        Integer jobId = 56; // Integer | 

        try {
            Object result = apiInstance.proxyFlinkDashboard(jobId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KubernetesFlinkDashboardProxyControllerV2Api#proxyFlinkDashboard");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
KubernetesFlinkDashboardProxyControllerV2Api *apiInstance = [[KubernetesFlinkDashboardProxyControllerV2Api alloc] init];
Integer *jobId = 56; //  (default to null)

[apiInstance proxyFlinkDashboardWith:jobId
              completionHandler: ^(Object output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.KubernetesFlinkDashboardProxyControllerV2Api()
var jobId = 56; // {Integer} 

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

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

            // Create an instance of the API class
            var apiInstance = new KubernetesFlinkDashboardProxyControllerV2Api();
            var jobId = 56;  // Integer |  (default to null)

            try {
                Object result = apiInstance.proxyFlinkDashboard(jobId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling KubernetesFlinkDashboardProxyControllerV2Api.proxyFlinkDashboard: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\KubernetesFlinkDashboardProxyControllerV2Api();
$jobId = 56; // Integer | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::KubernetesFlinkDashboardProxyControllerV2Api->new();
my $jobId = 56; # Integer | 

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

# Create an instance of the API class
api_instance = openapi_client.KubernetesFlinkDashboardProxyControllerV2Api()
jobId = 56 # Integer |  (default to null)

try:
    api_response = api_instance.proxy_flink_dashboard(jobId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling KubernetesFlinkDashboardProxyControllerV2Api->proxyFlinkDashboard: %s\n" % e)
extern crate KubernetesFlinkDashboardProxyControllerV2Api;

pub fn main() {
    let jobId = 56; // Integer

    let mut context = KubernetesFlinkDashboardProxyControllerV2Api::Context::default();
    let result = client.proxyFlinkDashboard(jobId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
jobId*
Integer (int32)
Required

Responses


proxyFlinkDashboard1


/flink-dashboard/{jobId}/**

Usage and SDK Samples

curl -X POST \
 -H "Accept: */*" \
 "http://localhost/flink-dashboard/{jobId}/**"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.KubernetesFlinkDashboardProxyControllerV2Api;

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

public class KubernetesFlinkDashboardProxyControllerV2ApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        KubernetesFlinkDashboardProxyControllerV2Api apiInstance = new KubernetesFlinkDashboardProxyControllerV2Api();
        Integer jobId = 56; // Integer | 

        try {
            Object result = apiInstance.proxyFlinkDashboard1(jobId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KubernetesFlinkDashboardProxyControllerV2Api#proxyFlinkDashboard1");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer jobId = new Integer(); // Integer | 

try {
    final result = await api_instance.proxyFlinkDashboard1(jobId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->proxyFlinkDashboard1: $e\n');
}

import org.openapitools.client.api.KubernetesFlinkDashboardProxyControllerV2Api;

public class KubernetesFlinkDashboardProxyControllerV2ApiExample {
    public static void main(String[] args) {
        KubernetesFlinkDashboardProxyControllerV2Api apiInstance = new KubernetesFlinkDashboardProxyControllerV2Api();
        Integer jobId = 56; // Integer | 

        try {
            Object result = apiInstance.proxyFlinkDashboard1(jobId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KubernetesFlinkDashboardProxyControllerV2Api#proxyFlinkDashboard1");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
KubernetesFlinkDashboardProxyControllerV2Api *apiInstance = [[KubernetesFlinkDashboardProxyControllerV2Api alloc] init];
Integer *jobId = 56; //  (default to null)

[apiInstance proxyFlinkDashboard1With:jobId
              completionHandler: ^(Object output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.KubernetesFlinkDashboardProxyControllerV2Api()
var jobId = 56; // {Integer} 

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

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

            // Create an instance of the API class
            var apiInstance = new KubernetesFlinkDashboardProxyControllerV2Api();
            var jobId = 56;  // Integer |  (default to null)

            try {
                Object result = apiInstance.proxyFlinkDashboard1(jobId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling KubernetesFlinkDashboardProxyControllerV2Api.proxyFlinkDashboard1: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\KubernetesFlinkDashboardProxyControllerV2Api();
$jobId = 56; // Integer | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::KubernetesFlinkDashboardProxyControllerV2Api->new();
my $jobId = 56; # Integer | 

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

# Create an instance of the API class
api_instance = openapi_client.KubernetesFlinkDashboardProxyControllerV2Api()
jobId = 56 # Integer |  (default to null)

try:
    api_response = api_instance.proxy_flink_dashboard1(jobId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling KubernetesFlinkDashboardProxyControllerV2Api->proxyFlinkDashboard1: %s\n" % e)
extern crate KubernetesFlinkDashboardProxyControllerV2Api;

pub fn main() {
    let jobId = 56; // Integer

    let mut context = KubernetesFlinkDashboardProxyControllerV2Api::Context::default();
    let result = client.proxyFlinkDashboard1(jobId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
jobId*
Integer (int32)
Required

Responses


proxyFlinkDashboard2


/flink-dashboard/{jobId}/**

Usage and SDK Samples

curl -X PUT \
 -H "Accept: */*" \
 "http://localhost/flink-dashboard/{jobId}/**"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.KubernetesFlinkDashboardProxyControllerV2Api;

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

public class KubernetesFlinkDashboardProxyControllerV2ApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        KubernetesFlinkDashboardProxyControllerV2Api apiInstance = new KubernetesFlinkDashboardProxyControllerV2Api();
        Integer jobId = 56; // Integer | 

        try {
            Object result = apiInstance.proxyFlinkDashboard2(jobId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KubernetesFlinkDashboardProxyControllerV2Api#proxyFlinkDashboard2");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer jobId = new Integer(); // Integer | 

try {
    final result = await api_instance.proxyFlinkDashboard2(jobId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->proxyFlinkDashboard2: $e\n');
}

import org.openapitools.client.api.KubernetesFlinkDashboardProxyControllerV2Api;

public class KubernetesFlinkDashboardProxyControllerV2ApiExample {
    public static void main(String[] args) {
        KubernetesFlinkDashboardProxyControllerV2Api apiInstance = new KubernetesFlinkDashboardProxyControllerV2Api();
        Integer jobId = 56; // Integer | 

        try {
            Object result = apiInstance.proxyFlinkDashboard2(jobId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KubernetesFlinkDashboardProxyControllerV2Api#proxyFlinkDashboard2");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
KubernetesFlinkDashboardProxyControllerV2Api *apiInstance = [[KubernetesFlinkDashboardProxyControllerV2Api alloc] init];
Integer *jobId = 56; //  (default to null)

[apiInstance proxyFlinkDashboard2With:jobId
              completionHandler: ^(Object output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.KubernetesFlinkDashboardProxyControllerV2Api()
var jobId = 56; // {Integer} 

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

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

            // Create an instance of the API class
            var apiInstance = new KubernetesFlinkDashboardProxyControllerV2Api();
            var jobId = 56;  // Integer |  (default to null)

            try {
                Object result = apiInstance.proxyFlinkDashboard2(jobId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling KubernetesFlinkDashboardProxyControllerV2Api.proxyFlinkDashboard2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\KubernetesFlinkDashboardProxyControllerV2Api();
$jobId = 56; // Integer | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::KubernetesFlinkDashboardProxyControllerV2Api->new();
my $jobId = 56; # Integer | 

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

# Create an instance of the API class
api_instance = openapi_client.KubernetesFlinkDashboardProxyControllerV2Api()
jobId = 56 # Integer |  (default to null)

try:
    api_response = api_instance.proxy_flink_dashboard2(jobId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling KubernetesFlinkDashboardProxyControllerV2Api->proxyFlinkDashboard2: %s\n" % e)
extern crate KubernetesFlinkDashboardProxyControllerV2Api;

pub fn main() {
    let jobId = 56; // Integer

    let mut context = KubernetesFlinkDashboardProxyControllerV2Api::Context::default();
    let result = client.proxyFlinkDashboard2(jobId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
jobId*
Integer (int32)
Required

Responses


proxyFlinkDashboard3


/flink-dashboard/{jobId}/**

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: */*" \
 "http://localhost/flink-dashboard/{jobId}/**"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.KubernetesFlinkDashboardProxyControllerV2Api;

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

public class KubernetesFlinkDashboardProxyControllerV2ApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        KubernetesFlinkDashboardProxyControllerV2Api apiInstance = new KubernetesFlinkDashboardProxyControllerV2Api();
        Integer jobId = 56; // Integer | 

        try {
            Object result = apiInstance.proxyFlinkDashboard3(jobId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KubernetesFlinkDashboardProxyControllerV2Api#proxyFlinkDashboard3");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer jobId = new Integer(); // Integer | 

try {
    final result = await api_instance.proxyFlinkDashboard3(jobId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->proxyFlinkDashboard3: $e\n');
}

import org.openapitools.client.api.KubernetesFlinkDashboardProxyControllerV2Api;

public class KubernetesFlinkDashboardProxyControllerV2ApiExample {
    public static void main(String[] args) {
        KubernetesFlinkDashboardProxyControllerV2Api apiInstance = new KubernetesFlinkDashboardProxyControllerV2Api();
        Integer jobId = 56; // Integer | 

        try {
            Object result = apiInstance.proxyFlinkDashboard3(jobId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KubernetesFlinkDashboardProxyControllerV2Api#proxyFlinkDashboard3");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
KubernetesFlinkDashboardProxyControllerV2Api *apiInstance = [[KubernetesFlinkDashboardProxyControllerV2Api alloc] init];
Integer *jobId = 56; //  (default to null)

[apiInstance proxyFlinkDashboard3With:jobId
              completionHandler: ^(Object output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.KubernetesFlinkDashboardProxyControllerV2Api()
var jobId = 56; // {Integer} 

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

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

            // Create an instance of the API class
            var apiInstance = new KubernetesFlinkDashboardProxyControllerV2Api();
            var jobId = 56;  // Integer |  (default to null)

            try {
                Object result = apiInstance.proxyFlinkDashboard3(jobId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling KubernetesFlinkDashboardProxyControllerV2Api.proxyFlinkDashboard3: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\KubernetesFlinkDashboardProxyControllerV2Api();
$jobId = 56; // Integer | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::KubernetesFlinkDashboardProxyControllerV2Api->new();
my $jobId = 56; # Integer | 

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

# Create an instance of the API class
api_instance = openapi_client.KubernetesFlinkDashboardProxyControllerV2Api()
jobId = 56 # Integer |  (default to null)

try:
    api_response = api_instance.proxy_flink_dashboard3(jobId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling KubernetesFlinkDashboardProxyControllerV2Api->proxyFlinkDashboard3: %s\n" % e)
extern crate KubernetesFlinkDashboardProxyControllerV2Api;

pub fn main() {
    let jobId = 56; // Integer

    let mut context = KubernetesFlinkDashboardProxyControllerV2Api::Context::default();
    let result = client.proxyFlinkDashboard3(jobId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
jobId*
Integer (int32)
Required

Responses


proxyFlinkDashboard4


/flink-dashboard/{jobId}/**

Usage and SDK Samples

curl -X PATCH \
 -H "Accept: */*" \
 "http://localhost/flink-dashboard/{jobId}/**"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.KubernetesFlinkDashboardProxyControllerV2Api;

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

public class KubernetesFlinkDashboardProxyControllerV2ApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        KubernetesFlinkDashboardProxyControllerV2Api apiInstance = new KubernetesFlinkDashboardProxyControllerV2Api();
        Integer jobId = 56; // Integer | 

        try {
            Object result = apiInstance.proxyFlinkDashboard4(jobId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KubernetesFlinkDashboardProxyControllerV2Api#proxyFlinkDashboard4");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer jobId = new Integer(); // Integer | 

try {
    final result = await api_instance.proxyFlinkDashboard4(jobId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->proxyFlinkDashboard4: $e\n');
}

import org.openapitools.client.api.KubernetesFlinkDashboardProxyControllerV2Api;

public class KubernetesFlinkDashboardProxyControllerV2ApiExample {
    public static void main(String[] args) {
        KubernetesFlinkDashboardProxyControllerV2Api apiInstance = new KubernetesFlinkDashboardProxyControllerV2Api();
        Integer jobId = 56; // Integer | 

        try {
            Object result = apiInstance.proxyFlinkDashboard4(jobId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KubernetesFlinkDashboardProxyControllerV2Api#proxyFlinkDashboard4");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
KubernetesFlinkDashboardProxyControllerV2Api *apiInstance = [[KubernetesFlinkDashboardProxyControllerV2Api alloc] init];
Integer *jobId = 56; //  (default to null)

[apiInstance proxyFlinkDashboard4With:jobId
              completionHandler: ^(Object output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.KubernetesFlinkDashboardProxyControllerV2Api()
var jobId = 56; // {Integer} 

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

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

            // Create an instance of the API class
            var apiInstance = new KubernetesFlinkDashboardProxyControllerV2Api();
            var jobId = 56;  // Integer |  (default to null)

            try {
                Object result = apiInstance.proxyFlinkDashboard4(jobId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling KubernetesFlinkDashboardProxyControllerV2Api.proxyFlinkDashboard4: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\KubernetesFlinkDashboardProxyControllerV2Api();
$jobId = 56; // Integer | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::KubernetesFlinkDashboardProxyControllerV2Api->new();
my $jobId = 56; # Integer | 

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

# Create an instance of the API class
api_instance = openapi_client.KubernetesFlinkDashboardProxyControllerV2Api()
jobId = 56 # Integer |  (default to null)

try:
    api_response = api_instance.proxy_flink_dashboard4(jobId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling KubernetesFlinkDashboardProxyControllerV2Api->proxyFlinkDashboard4: %s\n" % e)
extern crate KubernetesFlinkDashboardProxyControllerV2Api;

pub fn main() {
    let jobId = 56; // Integer

    let mut context = KubernetesFlinkDashboardProxyControllerV2Api::Context::default();
    let result = client.proxyFlinkDashboard4(jobId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
jobId*
Integer (int32)
Required

Responses


proxyFlinkDashboard5


/flink-dashboard/{jobId}/**

Usage and SDK Samples

curl -X HEAD \
 -H "Accept: */*" \
 "http://localhost/flink-dashboard/{jobId}/**"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.KubernetesFlinkDashboardProxyControllerV2Api;

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

public class KubernetesFlinkDashboardProxyControllerV2ApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        KubernetesFlinkDashboardProxyControllerV2Api apiInstance = new KubernetesFlinkDashboardProxyControllerV2Api();
        Integer jobId = 56; // Integer | 

        try {
            Object result = apiInstance.proxyFlinkDashboard5(jobId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KubernetesFlinkDashboardProxyControllerV2Api#proxyFlinkDashboard5");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer jobId = new Integer(); // Integer | 

try {
    final result = await api_instance.proxyFlinkDashboard5(jobId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->proxyFlinkDashboard5: $e\n');
}

import org.openapitools.client.api.KubernetesFlinkDashboardProxyControllerV2Api;

public class KubernetesFlinkDashboardProxyControllerV2ApiExample {
    public static void main(String[] args) {
        KubernetesFlinkDashboardProxyControllerV2Api apiInstance = new KubernetesFlinkDashboardProxyControllerV2Api();
        Integer jobId = 56; // Integer | 

        try {
            Object result = apiInstance.proxyFlinkDashboard5(jobId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KubernetesFlinkDashboardProxyControllerV2Api#proxyFlinkDashboard5");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
KubernetesFlinkDashboardProxyControllerV2Api *apiInstance = [[KubernetesFlinkDashboardProxyControllerV2Api alloc] init];
Integer *jobId = 56; //  (default to null)

[apiInstance proxyFlinkDashboard5With:jobId
              completionHandler: ^(Object output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.KubernetesFlinkDashboardProxyControllerV2Api()
var jobId = 56; // {Integer} 

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

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

            // Create an instance of the API class
            var apiInstance = new KubernetesFlinkDashboardProxyControllerV2Api();
            var jobId = 56;  // Integer |  (default to null)

            try {
                Object result = apiInstance.proxyFlinkDashboard5(jobId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling KubernetesFlinkDashboardProxyControllerV2Api.proxyFlinkDashboard5: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\KubernetesFlinkDashboardProxyControllerV2Api();
$jobId = 56; // Integer | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::KubernetesFlinkDashboardProxyControllerV2Api->new();
my $jobId = 56; # Integer | 

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

# Create an instance of the API class
api_instance = openapi_client.KubernetesFlinkDashboardProxyControllerV2Api()
jobId = 56 # Integer |  (default to null)

try:
    api_response = api_instance.proxy_flink_dashboard5(jobId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling KubernetesFlinkDashboardProxyControllerV2Api->proxyFlinkDashboard5: %s\n" % e)
extern crate KubernetesFlinkDashboardProxyControllerV2Api;

pub fn main() {
    let jobId = 56; // Integer

    let mut context = KubernetesFlinkDashboardProxyControllerV2Api::Context::default();
    let result = client.proxyFlinkDashboard5(jobId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
jobId*
Integer (int32)
Required

Responses


proxyFlinkDashboard6


/flink-dashboard/{jobId}/**

Usage and SDK Samples

curl -X OPTIONS \
 -H "Accept: */*" \
 "http://localhost/flink-dashboard/{jobId}/**"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.KubernetesFlinkDashboardProxyControllerV2Api;

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

public class KubernetesFlinkDashboardProxyControllerV2ApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        KubernetesFlinkDashboardProxyControllerV2Api apiInstance = new KubernetesFlinkDashboardProxyControllerV2Api();
        Integer jobId = 56; // Integer | 

        try {
            Object result = apiInstance.proxyFlinkDashboard6(jobId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KubernetesFlinkDashboardProxyControllerV2Api#proxyFlinkDashboard6");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer jobId = new Integer(); // Integer | 

try {
    final result = await api_instance.proxyFlinkDashboard6(jobId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->proxyFlinkDashboard6: $e\n');
}

import org.openapitools.client.api.KubernetesFlinkDashboardProxyControllerV2Api;

public class KubernetesFlinkDashboardProxyControllerV2ApiExample {
    public static void main(String[] args) {
        KubernetesFlinkDashboardProxyControllerV2Api apiInstance = new KubernetesFlinkDashboardProxyControllerV2Api();
        Integer jobId = 56; // Integer | 

        try {
            Object result = apiInstance.proxyFlinkDashboard6(jobId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KubernetesFlinkDashboardProxyControllerV2Api#proxyFlinkDashboard6");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
KubernetesFlinkDashboardProxyControllerV2Api *apiInstance = [[KubernetesFlinkDashboardProxyControllerV2Api alloc] init];
Integer *jobId = 56; //  (default to null)

[apiInstance proxyFlinkDashboard6With:jobId
              completionHandler: ^(Object output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.KubernetesFlinkDashboardProxyControllerV2Api()
var jobId = 56; // {Integer} 

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

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

            // Create an instance of the API class
            var apiInstance = new KubernetesFlinkDashboardProxyControllerV2Api();
            var jobId = 56;  // Integer |  (default to null)

            try {
                Object result = apiInstance.proxyFlinkDashboard6(jobId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling KubernetesFlinkDashboardProxyControllerV2Api.proxyFlinkDashboard6: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\KubernetesFlinkDashboardProxyControllerV2Api();
$jobId = 56; // Integer | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::KubernetesFlinkDashboardProxyControllerV2Api->new();
my $jobId = 56; # Integer | 

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

# Create an instance of the API class
api_instance = openapi_client.KubernetesFlinkDashboardProxyControllerV2Api()
jobId = 56 # Integer |  (default to null)

try:
    api_response = api_instance.proxy_flink_dashboard6(jobId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling KubernetesFlinkDashboardProxyControllerV2Api->proxyFlinkDashboard6: %s\n" % e)
extern crate KubernetesFlinkDashboardProxyControllerV2Api;

pub fn main() {
    let jobId = 56; // Integer

    let mut context = KubernetesFlinkDashboardProxyControllerV2Api::Context::default();
    let result = client.proxyFlinkDashboard6(jobId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
jobId*
Integer (int32)
Required

Responses


NotificationActionController

addToJobNotificationGroup


/internal/notification-actions/groups/{groupId}/child/{childId}

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 "http://localhost/internal/notification-actions/groups/{groupId}/child/{childId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.NotificationActionControllerApi;

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

public class NotificationActionControllerApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        NotificationActionControllerApi apiInstance = new NotificationActionControllerApi();
        Integer groupId = 56; // Integer | 
        Integer childId = 56; // Integer | 

        try {
            NotificationGroupResponse result = apiInstance.addToJobNotificationGroup(groupId, childId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NotificationActionControllerApi#addToJobNotificationGroup");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer groupId = new Integer(); // Integer | 
final Integer childId = new Integer(); // Integer | 

try {
    final result = await api_instance.addToJobNotificationGroup(groupId, childId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->addToJobNotificationGroup: $e\n');
}

import org.openapitools.client.api.NotificationActionControllerApi;

public class NotificationActionControllerApiExample {
    public static void main(String[] args) {
        NotificationActionControllerApi apiInstance = new NotificationActionControllerApi();
        Integer groupId = 56; // Integer | 
        Integer childId = 56; // Integer | 

        try {
            NotificationGroupResponse result = apiInstance.addToJobNotificationGroup(groupId, childId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NotificationActionControllerApi#addToJobNotificationGroup");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
NotificationActionControllerApi *apiInstance = [[NotificationActionControllerApi alloc] init];
Integer *groupId = 56; //  (default to null)
Integer *childId = 56; //  (default to null)

[apiInstance addToJobNotificationGroupWith:groupId
    childId:childId
              completionHandler: ^(NotificationGroupResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.NotificationActionControllerApi()
var groupId = 56; // {Integer} 
var childId = 56; // {Integer} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addToJobNotificationGroup(groupId, childId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new NotificationActionControllerApi();
            var groupId = 56;  // Integer |  (default to null)
            var childId = 56;  // Integer |  (default to null)

            try {
                NotificationGroupResponse result = apiInstance.addToJobNotificationGroup(groupId, childId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling NotificationActionControllerApi.addToJobNotificationGroup: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\NotificationActionControllerApi();
$groupId = 56; // Integer | 
$childId = 56; // Integer | 

try {
    $result = $api_instance->addToJobNotificationGroup($groupId, $childId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling NotificationActionControllerApi->addToJobNotificationGroup: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::NotificationActionControllerApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::NotificationActionControllerApi->new();
my $groupId = 56; # Integer | 
my $childId = 56; # Integer | 

eval {
    my $result = $api_instance->addToJobNotificationGroup(groupId => $groupId, childId => $childId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling NotificationActionControllerApi->addToJobNotificationGroup: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.NotificationActionControllerApi()
groupId = 56 # Integer |  (default to null)
childId = 56 # Integer |  (default to null)

try:
    api_response = api_instance.add_to_job_notification_group(groupId, childId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling NotificationActionControllerApi->addToJobNotificationGroup: %s\n" % e)
extern crate NotificationActionControllerApi;

pub fn main() {
    let groupId = 56; // Integer
    let childId = 56; // Integer

    let mut context = NotificationActionControllerApi::Context::default();
    let result = client.addToJobNotificationGroup(groupId, childId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
groupId*
Integer (int32)
Required
childId*
Integer (int32)
Required

Responses


createJobNotification


/internal/notification-actions

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost/internal/notification-actions" \
 -d '{
  "metadata" : {
    "type" : "type"
  },
  "name" : "name"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.NotificationActionControllerApi;

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

public class NotificationActionControllerApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        NotificationActionControllerApi apiInstance = new NotificationActionControllerApi();
        CreateNotificationActionRequest createNotificationActionRequest = ; // CreateNotificationActionRequest | 

        try {
            NotificationActionResponse result = apiInstance.createJobNotification(createNotificationActionRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NotificationActionControllerApi#createJobNotification");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final CreateNotificationActionRequest createNotificationActionRequest = new CreateNotificationActionRequest(); // CreateNotificationActionRequest | 

try {
    final result = await api_instance.createJobNotification(createNotificationActionRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->createJobNotification: $e\n');
}

import org.openapitools.client.api.NotificationActionControllerApi;

public class NotificationActionControllerApiExample {
    public static void main(String[] args) {
        NotificationActionControllerApi apiInstance = new NotificationActionControllerApi();
        CreateNotificationActionRequest createNotificationActionRequest = ; // CreateNotificationActionRequest | 

        try {
            NotificationActionResponse result = apiInstance.createJobNotification(createNotificationActionRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NotificationActionControllerApi#createJobNotification");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
NotificationActionControllerApi *apiInstance = [[NotificationActionControllerApi alloc] init];
CreateNotificationActionRequest *createNotificationActionRequest = ; // 

[apiInstance createJobNotificationWith:createNotificationActionRequest
              completionHandler: ^(NotificationActionResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.NotificationActionControllerApi()
var createNotificationActionRequest = ; // {CreateNotificationActionRequest} 

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

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

            // Create an instance of the API class
            var apiInstance = new NotificationActionControllerApi();
            var createNotificationActionRequest = new CreateNotificationActionRequest(); // CreateNotificationActionRequest | 

            try {
                NotificationActionResponse result = apiInstance.createJobNotification(createNotificationActionRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling NotificationActionControllerApi.createJobNotification: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\NotificationActionControllerApi();
$createNotificationActionRequest = ; // CreateNotificationActionRequest | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::NotificationActionControllerApi->new();
my $createNotificationActionRequest = WWW::OPenAPIClient::Object::CreateNotificationActionRequest->new(); # CreateNotificationActionRequest | 

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

# Create an instance of the API class
api_instance = openapi_client.NotificationActionControllerApi()
createNotificationActionRequest =  # CreateNotificationActionRequest | 

try:
    api_response = api_instance.create_job_notification(createNotificationActionRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling NotificationActionControllerApi->createJobNotification: %s\n" % e)
extern crate NotificationActionControllerApi;

pub fn main() {
    let createNotificationActionRequest = ; // CreateNotificationActionRequest

    let mut context = NotificationActionControllerApi::Context::default();
    let result = client.createJobNotification(createNotificationActionRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
createNotificationActionRequest *

Responses


createJobNotificationGroup


/internal/notification-actions/groups

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost/internal/notification-actions/groups" \
 -d '{
  "children" : [ 0, 0 ],
  "name" : "name"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.NotificationActionControllerApi;

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

public class NotificationActionControllerApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        NotificationActionControllerApi apiInstance = new NotificationActionControllerApi();
        CreateNotificationGroupRequest createNotificationGroupRequest = ; // CreateNotificationGroupRequest | 

        try {
            NotificationGroupResponse result = apiInstance.createJobNotificationGroup(createNotificationGroupRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NotificationActionControllerApi#createJobNotificationGroup");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final CreateNotificationGroupRequest createNotificationGroupRequest = new CreateNotificationGroupRequest(); // CreateNotificationGroupRequest | 

try {
    final result = await api_instance.createJobNotificationGroup(createNotificationGroupRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->createJobNotificationGroup: $e\n');
}

import org.openapitools.client.api.NotificationActionControllerApi;

public class NotificationActionControllerApiExample {
    public static void main(String[] args) {
        NotificationActionControllerApi apiInstance = new NotificationActionControllerApi();
        CreateNotificationGroupRequest createNotificationGroupRequest = ; // CreateNotificationGroupRequest | 

        try {
            NotificationGroupResponse result = apiInstance.createJobNotificationGroup(createNotificationGroupRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NotificationActionControllerApi#createJobNotificationGroup");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
NotificationActionControllerApi *apiInstance = [[NotificationActionControllerApi alloc] init];
CreateNotificationGroupRequest *createNotificationGroupRequest = ; // 

[apiInstance createJobNotificationGroupWith:createNotificationGroupRequest
              completionHandler: ^(NotificationGroupResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.NotificationActionControllerApi()
var createNotificationGroupRequest = ; // {CreateNotificationGroupRequest} 

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

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

            // Create an instance of the API class
            var apiInstance = new NotificationActionControllerApi();
            var createNotificationGroupRequest = new CreateNotificationGroupRequest(); // CreateNotificationGroupRequest | 

            try {
                NotificationGroupResponse result = apiInstance.createJobNotificationGroup(createNotificationGroupRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling NotificationActionControllerApi.createJobNotificationGroup: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\NotificationActionControllerApi();
$createNotificationGroupRequest = ; // CreateNotificationGroupRequest | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::NotificationActionControllerApi->new();
my $createNotificationGroupRequest = WWW::OPenAPIClient::Object::CreateNotificationGroupRequest->new(); # CreateNotificationGroupRequest | 

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

# Create an instance of the API class
api_instance = openapi_client.NotificationActionControllerApi()
createNotificationGroupRequest =  # CreateNotificationGroupRequest | 

try:
    api_response = api_instance.create_job_notification_group(createNotificationGroupRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling NotificationActionControllerApi->createJobNotificationGroup: %s\n" % e)
extern crate NotificationActionControllerApi;

pub fn main() {
    let createNotificationGroupRequest = ; // CreateNotificationGroupRequest

    let mut context = NotificationActionControllerApi::Context::default();
    let result = client.createJobNotificationGroup(createNotificationGroupRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
createNotificationGroupRequest *

Responses


deleteJobNotification


/internal/notification-actions/{id}

Usage and SDK Samples

curl -X DELETE \
 "http://localhost/internal/notification-actions/{id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.NotificationActionControllerApi;

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

public class NotificationActionControllerApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        NotificationActionControllerApi apiInstance = new NotificationActionControllerApi();
        Integer id = 56; // Integer | 

        try {
            apiInstance.deleteJobNotification(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling NotificationActionControllerApi#deleteJobNotification");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 

try {
    final result = await api_instance.deleteJobNotification(id);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteJobNotification: $e\n');
}

import org.openapitools.client.api.NotificationActionControllerApi;

public class NotificationActionControllerApiExample {
    public static void main(String[] args) {
        NotificationActionControllerApi apiInstance = new NotificationActionControllerApi();
        Integer id = 56; // Integer | 

        try {
            apiInstance.deleteJobNotification(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling NotificationActionControllerApi#deleteJobNotification");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
NotificationActionControllerApi *apiInstance = [[NotificationActionControllerApi alloc] init];
Integer *id = 56; //  (default to null)

[apiInstance deleteJobNotificationWith:id
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.NotificationActionControllerApi()
var id = 56; // {Integer} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteJobNotification(id, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new NotificationActionControllerApi();
            var id = 56;  // Integer |  (default to null)

            try {
                apiInstance.deleteJobNotification(id);
            } catch (Exception e) {
                Debug.Print("Exception when calling NotificationActionControllerApi.deleteJobNotification: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\NotificationActionControllerApi();
$id = 56; // Integer | 

try {
    $api_instance->deleteJobNotification($id);
} catch (Exception $e) {
    echo 'Exception when calling NotificationActionControllerApi->deleteJobNotification: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::NotificationActionControllerApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::NotificationActionControllerApi->new();
my $id = 56; # Integer | 

eval {
    $api_instance->deleteJobNotification(id => $id);
};
if ($@) {
    warn "Exception when calling NotificationActionControllerApi->deleteJobNotification: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.NotificationActionControllerApi()
id = 56 # Integer |  (default to null)

try:
    api_instance.delete_job_notification(id)
except ApiException as e:
    print("Exception when calling NotificationActionControllerApi->deleteJobNotification: %s\n" % e)
extern crate NotificationActionControllerApi;

pub fn main() {
    let id = 56; // Integer

    let mut context = NotificationActionControllerApi::Context::default();
    let result = client.deleteJobNotification(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required

Responses


findAllJobNotificationByJobId


/internal/notification-actions/job/{jobId}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/internal/notification-actions/job/{jobId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.NotificationActionControllerApi;

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

public class NotificationActionControllerApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        NotificationActionControllerApi apiInstance = new NotificationActionControllerApi();
        Integer jobId = 56; // Integer | 

        try {
            array[NotificationActionResponse] result = apiInstance.findAllJobNotificationByJobId(jobId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NotificationActionControllerApi#findAllJobNotificationByJobId");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer jobId = new Integer(); // Integer | 

try {
    final result = await api_instance.findAllJobNotificationByJobId(jobId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->findAllJobNotificationByJobId: $e\n');
}

import org.openapitools.client.api.NotificationActionControllerApi;

public class NotificationActionControllerApiExample {
    public static void main(String[] args) {
        NotificationActionControllerApi apiInstance = new NotificationActionControllerApi();
        Integer jobId = 56; // Integer | 

        try {
            array[NotificationActionResponse] result = apiInstance.findAllJobNotificationByJobId(jobId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NotificationActionControllerApi#findAllJobNotificationByJobId");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
NotificationActionControllerApi *apiInstance = [[NotificationActionControllerApi alloc] init];
Integer *jobId = 56; //  (default to null)

[apiInstance findAllJobNotificationByJobIdWith:jobId
              completionHandler: ^(array[NotificationActionResponse] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.NotificationActionControllerApi()
var jobId = 56; // {Integer} 

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

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

            // Create an instance of the API class
            var apiInstance = new NotificationActionControllerApi();
            var jobId = 56;  // Integer |  (default to null)

            try {
                array[NotificationActionResponse] result = apiInstance.findAllJobNotificationByJobId(jobId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling NotificationActionControllerApi.findAllJobNotificationByJobId: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\NotificationActionControllerApi();
$jobId = 56; // Integer | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::NotificationActionControllerApi->new();
my $jobId = 56; # Integer | 

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

# Create an instance of the API class
api_instance = openapi_client.NotificationActionControllerApi()
jobId = 56 # Integer |  (default to null)

try:
    api_response = api_instance.find_all_job_notification_by_job_id(jobId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling NotificationActionControllerApi->findAllJobNotificationByJobId: %s\n" % e)
extern crate NotificationActionControllerApi;

pub fn main() {
    let jobId = 56; // Integer

    let mut context = NotificationActionControllerApi::Context::default();
    let result = client.findAllJobNotificationByJobId(jobId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
jobId*
Integer (int32)
Required

Responses


getJobNotification


/internal/notification-actions/{id}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/internal/notification-actions/{id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.NotificationActionControllerApi;

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

public class NotificationActionControllerApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        NotificationActionControllerApi apiInstance = new NotificationActionControllerApi();
        Integer id = 56; // Integer | 

        try {
            NotificationActionResponse result = apiInstance.getJobNotification(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NotificationActionControllerApi#getJobNotification");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 

try {
    final result = await api_instance.getJobNotification(id);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getJobNotification: $e\n');
}

import org.openapitools.client.api.NotificationActionControllerApi;

public class NotificationActionControllerApiExample {
    public static void main(String[] args) {
        NotificationActionControllerApi apiInstance = new NotificationActionControllerApi();
        Integer id = 56; // Integer | 

        try {
            NotificationActionResponse result = apiInstance.getJobNotification(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NotificationActionControllerApi#getJobNotification");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
NotificationActionControllerApi *apiInstance = [[NotificationActionControllerApi alloc] init];
Integer *id = 56; //  (default to null)

[apiInstance getJobNotificationWith:id
              completionHandler: ^(NotificationActionResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.NotificationActionControllerApi()
var id = 56; // {Integer} 

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

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

            // Create an instance of the API class
            var apiInstance = new NotificationActionControllerApi();
            var id = 56;  // Integer |  (default to null)

            try {
                NotificationActionResponse result = apiInstance.getJobNotification(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling NotificationActionControllerApi.getJobNotification: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\NotificationActionControllerApi();
$id = 56; // Integer | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::NotificationActionControllerApi->new();
my $id = 56; # Integer | 

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

# Create an instance of the API class
api_instance = openapi_client.NotificationActionControllerApi()
id = 56 # Integer |  (default to null)

try:
    api_response = api_instance.get_job_notification(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling NotificationActionControllerApi->getJobNotification: %s\n" % e)
extern crate NotificationActionControllerApi;

pub fn main() {
    let id = 56; // Integer

    let mut context = NotificationActionControllerApi::Context::default();
    let result = client.getJobNotification(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required

Responses


getJobNotificationGroup


/internal/notification-actions/groups/{id}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/internal/notification-actions/groups/{id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.NotificationActionControllerApi;

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

public class NotificationActionControllerApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        NotificationActionControllerApi apiInstance = new NotificationActionControllerApi();
        Integer id = 56; // Integer | 

        try {
            NotificationGroupResponse result = apiInstance.getJobNotificationGroup(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NotificationActionControllerApi#getJobNotificationGroup");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 

try {
    final result = await api_instance.getJobNotificationGroup(id);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getJobNotificationGroup: $e\n');
}

import org.openapitools.client.api.NotificationActionControllerApi;

public class NotificationActionControllerApiExample {
    public static void main(String[] args) {
        NotificationActionControllerApi apiInstance = new NotificationActionControllerApi();
        Integer id = 56; // Integer | 

        try {
            NotificationGroupResponse result = apiInstance.getJobNotificationGroup(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NotificationActionControllerApi#getJobNotificationGroup");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
NotificationActionControllerApi *apiInstance = [[NotificationActionControllerApi alloc] init];
Integer *id = 56; //  (default to null)

[apiInstance getJobNotificationGroupWith:id
              completionHandler: ^(NotificationGroupResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.NotificationActionControllerApi()
var id = 56; // {Integer} 

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

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

            // Create an instance of the API class
            var apiInstance = new NotificationActionControllerApi();
            var id = 56;  // Integer |  (default to null)

            try {
                NotificationGroupResponse result = apiInstance.getJobNotificationGroup(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling NotificationActionControllerApi.getJobNotificationGroup: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\NotificationActionControllerApi();
$id = 56; // Integer | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::NotificationActionControllerApi->new();
my $id = 56; # Integer | 

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

# Create an instance of the API class
api_instance = openapi_client.NotificationActionControllerApi()
id = 56 # Integer |  (default to null)

try:
    api_response = api_instance.get_job_notification_group(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling NotificationActionControllerApi->getJobNotificationGroup: %s\n" % e)
extern crate NotificationActionControllerApi;

pub fn main() {
    let id = 56; // Integer

    let mut context = NotificationActionControllerApi::Context::default();
    let result = client.getJobNotificationGroup(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required

Responses


getJobNotificationGroupChildren


/internal/notification-actions/groups/{id}/children

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/internal/notification-actions/groups/{id}/children"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.NotificationActionControllerApi;

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

public class NotificationActionControllerApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        NotificationActionControllerApi apiInstance = new NotificationActionControllerApi();
        Integer id = 56; // Integer | 

        try {
            array[NotificationActionResponse] result = apiInstance.getJobNotificationGroupChildren(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NotificationActionControllerApi#getJobNotificationGroupChildren");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 

try {
    final result = await api_instance.getJobNotificationGroupChildren(id);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getJobNotificationGroupChildren: $e\n');
}

import org.openapitools.client.api.NotificationActionControllerApi;

public class NotificationActionControllerApiExample {
    public static void main(String[] args) {
        NotificationActionControllerApi apiInstance = new NotificationActionControllerApi();
        Integer id = 56; // Integer | 

        try {
            array[NotificationActionResponse] result = apiInstance.getJobNotificationGroupChildren(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NotificationActionControllerApi#getJobNotificationGroupChildren");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
NotificationActionControllerApi *apiInstance = [[NotificationActionControllerApi alloc] init];
Integer *id = 56; //  (default to null)

[apiInstance getJobNotificationGroupChildrenWith:id
              completionHandler: ^(array[NotificationActionResponse] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.NotificationActionControllerApi()
var id = 56; // {Integer} 

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

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

            // Create an instance of the API class
            var apiInstance = new NotificationActionControllerApi();
            var id = 56;  // Integer |  (default to null)

            try {
                array[NotificationActionResponse] result = apiInstance.getJobNotificationGroupChildren(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling NotificationActionControllerApi.getJobNotificationGroupChildren: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\NotificationActionControllerApi();
$id = 56; // Integer | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::NotificationActionControllerApi->new();
my $id = 56; # Integer | 

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

# Create an instance of the API class
api_instance = openapi_client.NotificationActionControllerApi()
id = 56 # Integer |  (default to null)

try:
    api_response = api_instance.get_job_notification_group_children(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling NotificationActionControllerApi->getJobNotificationGroupChildren: %s\n" % e)
extern crate NotificationActionControllerApi;

pub fn main() {
    let id = 56; // Integer

    let mut context = NotificationActionControllerApi::Context::default();
    let result = client.getJobNotificationGroupChildren(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required

Responses


getNotificationTemplateVariables


/internal/notification-actions/template-variables

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/internal/notification-actions/template-variables"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.NotificationActionControllerApi;

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

public class NotificationActionControllerApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        NotificationActionControllerApi apiInstance = new NotificationActionControllerApi();

        try {
            array['String'] result = apiInstance.getNotificationTemplateVariables();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NotificationActionControllerApi#getNotificationTemplateVariables");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();


try {
    final result = await api_instance.getNotificationTemplateVariables();
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getNotificationTemplateVariables: $e\n');
}

import org.openapitools.client.api.NotificationActionControllerApi;

public class NotificationActionControllerApiExample {
    public static void main(String[] args) {
        NotificationActionControllerApi apiInstance = new NotificationActionControllerApi();

        try {
            array['String'] result = apiInstance.getNotificationTemplateVariables();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NotificationActionControllerApi#getNotificationTemplateVariables");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
NotificationActionControllerApi *apiInstance = [[NotificationActionControllerApi alloc] init];

[apiInstance getNotificationTemplateVariablesWithCompletionHandler: 
              ^(array['String'] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.NotificationActionControllerApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getNotificationTemplateVariables(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new NotificationActionControllerApi();

            try {
                array['String'] result = apiInstance.getNotificationTemplateVariables();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling NotificationActionControllerApi.getNotificationTemplateVariables: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\NotificationActionControllerApi();

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::NotificationActionControllerApi->new();

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

# Create an instance of the API class
api_instance = openapi_client.NotificationActionControllerApi()

try:
    api_response = api_instance.get_notification_template_variables()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling NotificationActionControllerApi->getNotificationTemplateVariables: %s\n" % e)
extern crate NotificationActionControllerApi;

pub fn main() {

    let mut context = NotificationActionControllerApi::Context::default();
    let result = client.getNotificationTemplateVariables(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


listAllJobNotificationActions


/internal/notification-actions

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/internal/notification-actions"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.NotificationActionControllerApi;

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

public class NotificationActionControllerApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        NotificationActionControllerApi apiInstance = new NotificationActionControllerApi();

        try {
            array[NotificationActionResponse] result = apiInstance.listAllJobNotificationActions();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NotificationActionControllerApi#listAllJobNotificationActions");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();


try {
    final result = await api_instance.listAllJobNotificationActions();
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->listAllJobNotificationActions: $e\n');
}

import org.openapitools.client.api.NotificationActionControllerApi;

public class NotificationActionControllerApiExample {
    public static void main(String[] args) {
        NotificationActionControllerApi apiInstance = new NotificationActionControllerApi();

        try {
            array[NotificationActionResponse] result = apiInstance.listAllJobNotificationActions();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NotificationActionControllerApi#listAllJobNotificationActions");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
NotificationActionControllerApi *apiInstance = [[NotificationActionControllerApi alloc] init];

[apiInstance listAllJobNotificationActionsWithCompletionHandler: 
              ^(array[NotificationActionResponse] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.NotificationActionControllerApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listAllJobNotificationActions(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new NotificationActionControllerApi();

            try {
                array[NotificationActionResponse] result = apiInstance.listAllJobNotificationActions();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling NotificationActionControllerApi.listAllJobNotificationActions: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\NotificationActionControllerApi();

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::NotificationActionControllerApi->new();

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

# Create an instance of the API class
api_instance = openapi_client.NotificationActionControllerApi()

try:
    api_response = api_instance.list_all_job_notification_actions()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling NotificationActionControllerApi->listAllJobNotificationActions: %s\n" % e)
extern crate NotificationActionControllerApi;

pub fn main() {

    let mut context = NotificationActionControllerApi::Context::default();
    let result = client.listAllJobNotificationActions(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


removeFromJobNotificationGroup


/internal/notification-actions/groups/{groupId}/child/{childId}

Usage and SDK Samples

curl -X DELETE \
 "http://localhost/internal/notification-actions/groups/{groupId}/child/{childId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.NotificationActionControllerApi;

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

public class NotificationActionControllerApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        NotificationActionControllerApi apiInstance = new NotificationActionControllerApi();
        Integer groupId = 56; // Integer | 
        Integer childId = 56; // Integer | 

        try {
            apiInstance.removeFromJobNotificationGroup(groupId, childId);
        } catch (ApiException e) {
            System.err.println("Exception when calling NotificationActionControllerApi#removeFromJobNotificationGroup");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer groupId = new Integer(); // Integer | 
final Integer childId = new Integer(); // Integer | 

try {
    final result = await api_instance.removeFromJobNotificationGroup(groupId, childId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->removeFromJobNotificationGroup: $e\n');
}

import org.openapitools.client.api.NotificationActionControllerApi;

public class NotificationActionControllerApiExample {
    public static void main(String[] args) {
        NotificationActionControllerApi apiInstance = new NotificationActionControllerApi();
        Integer groupId = 56; // Integer | 
        Integer childId = 56; // Integer | 

        try {
            apiInstance.removeFromJobNotificationGroup(groupId, childId);
        } catch (ApiException e) {
            System.err.println("Exception when calling NotificationActionControllerApi#removeFromJobNotificationGroup");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
NotificationActionControllerApi *apiInstance = [[NotificationActionControllerApi alloc] init];
Integer *groupId = 56; //  (default to null)
Integer *childId = 56; //  (default to null)

[apiInstance removeFromJobNotificationGroupWith:groupId
    childId:childId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.NotificationActionControllerApi()
var groupId = 56; // {Integer} 
var childId = 56; // {Integer} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.removeFromJobNotificationGroup(groupId, childId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new NotificationActionControllerApi();
            var groupId = 56;  // Integer |  (default to null)
            var childId = 56;  // Integer |  (default to null)

            try {
                apiInstance.removeFromJobNotificationGroup(groupId, childId);
            } catch (Exception e) {
                Debug.Print("Exception when calling NotificationActionControllerApi.removeFromJobNotificationGroup: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\NotificationActionControllerApi();
$groupId = 56; // Integer | 
$childId = 56; // Integer | 

try {
    $api_instance->removeFromJobNotificationGroup($groupId, $childId);
} catch (Exception $e) {
    echo 'Exception when calling NotificationActionControllerApi->removeFromJobNotificationGroup: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::NotificationActionControllerApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::NotificationActionControllerApi->new();
my $groupId = 56; # Integer | 
my $childId = 56; # Integer | 

eval {
    $api_instance->removeFromJobNotificationGroup(groupId => $groupId, childId => $childId);
};
if ($@) {
    warn "Exception when calling NotificationActionControllerApi->removeFromJobNotificationGroup: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.NotificationActionControllerApi()
groupId = 56 # Integer |  (default to null)
childId = 56 # Integer |  (default to null)

try:
    api_instance.remove_from_job_notification_group(groupId, childId)
except ApiException as e:
    print("Exception when calling NotificationActionControllerApi->removeFromJobNotificationGroup: %s\n" % e)
extern crate NotificationActionControllerApi;

pub fn main() {
    let groupId = 56; // Integer
    let childId = 56; // Integer

    let mut context = NotificationActionControllerApi::Context::default();
    let result = client.removeFromJobNotificationGroup(groupId, childId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
groupId*
Integer (int32)
Required
childId*
Integer (int32)
Required

Responses


resolveJobNotificationGroupActions


/internal/notification-actions/groups/{id}/resolve-actions

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/internal/notification-actions/groups/{id}/resolve-actions"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.NotificationActionControllerApi;

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

public class NotificationActionControllerApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        NotificationActionControllerApi apiInstance = new NotificationActionControllerApi();
        Integer id = 56; // Integer | 

        try {
            array[NotificationActionResponse] result = apiInstance.resolveJobNotificationGroupActions(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NotificationActionControllerApi#resolveJobNotificationGroupActions");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 

try {
    final result = await api_instance.resolveJobNotificationGroupActions(id);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->resolveJobNotificationGroupActions: $e\n');
}

import org.openapitools.client.api.NotificationActionControllerApi;

public class NotificationActionControllerApiExample {
    public static void main(String[] args) {
        NotificationActionControllerApi apiInstance = new NotificationActionControllerApi();
        Integer id = 56; // Integer | 

        try {
            array[NotificationActionResponse] result = apiInstance.resolveJobNotificationGroupActions(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NotificationActionControllerApi#resolveJobNotificationGroupActions");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
NotificationActionControllerApi *apiInstance = [[NotificationActionControllerApi alloc] init];
Integer *id = 56; //  (default to null)

[apiInstance resolveJobNotificationGroupActionsWith:id
              completionHandler: ^(array[NotificationActionResponse] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.NotificationActionControllerApi()
var id = 56; // {Integer} 

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

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

            // Create an instance of the API class
            var apiInstance = new NotificationActionControllerApi();
            var id = 56;  // Integer |  (default to null)

            try {
                array[NotificationActionResponse] result = apiInstance.resolveJobNotificationGroupActions(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling NotificationActionControllerApi.resolveJobNotificationGroupActions: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\NotificationActionControllerApi();
$id = 56; // Integer | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::NotificationActionControllerApi->new();
my $id = 56; # Integer | 

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

# Create an instance of the API class
api_instance = openapi_client.NotificationActionControllerApi()
id = 56 # Integer |  (default to null)

try:
    api_response = api_instance.resolve_job_notification_group_actions(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling NotificationActionControllerApi->resolveJobNotificationGroupActions: %s\n" % e)
extern crate NotificationActionControllerApi;

pub fn main() {
    let id = 56; // Integer

    let mut context = NotificationActionControllerApi::Context::default();
    let result = client.resolveJobNotificationGroupActions(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required

Responses


updateJobNotification


/internal/notification-actions/{id}

Usage and SDK Samples

curl -X PUT \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost/internal/notification-actions/{id}" \
 -d '{
  "metadata" : {
    "type" : "type"
  },
  "name" : "name"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.NotificationActionControllerApi;

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

public class NotificationActionControllerApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        NotificationActionControllerApi apiInstance = new NotificationActionControllerApi();
        Integer id = 56; // Integer | 
        CreateNotificationActionRequest createNotificationActionRequest = ; // CreateNotificationActionRequest | 

        try {
            NotificationActionResponse result = apiInstance.updateJobNotification(id, createNotificationActionRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NotificationActionControllerApi#updateJobNotification");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 
final CreateNotificationActionRequest createNotificationActionRequest = new CreateNotificationActionRequest(); // CreateNotificationActionRequest | 

try {
    final result = await api_instance.updateJobNotification(id, createNotificationActionRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateJobNotification: $e\n');
}

import org.openapitools.client.api.NotificationActionControllerApi;

public class NotificationActionControllerApiExample {
    public static void main(String[] args) {
        NotificationActionControllerApi apiInstance = new NotificationActionControllerApi();
        Integer id = 56; // Integer | 
        CreateNotificationActionRequest createNotificationActionRequest = ; // CreateNotificationActionRequest | 

        try {
            NotificationActionResponse result = apiInstance.updateJobNotification(id, createNotificationActionRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NotificationActionControllerApi#updateJobNotification");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
NotificationActionControllerApi *apiInstance = [[NotificationActionControllerApi alloc] init];
Integer *id = 56; //  (default to null)
CreateNotificationActionRequest *createNotificationActionRequest = ; // 

[apiInstance updateJobNotificationWith:id
    createNotificationActionRequest:createNotificationActionRequest
              completionHandler: ^(NotificationActionResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.NotificationActionControllerApi()
var id = 56; // {Integer} 
var createNotificationActionRequest = ; // {CreateNotificationActionRequest} 

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

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

            // Create an instance of the API class
            var apiInstance = new NotificationActionControllerApi();
            var id = 56;  // Integer |  (default to null)
            var createNotificationActionRequest = new CreateNotificationActionRequest(); // CreateNotificationActionRequest | 

            try {
                NotificationActionResponse result = apiInstance.updateJobNotification(id, createNotificationActionRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling NotificationActionControllerApi.updateJobNotification: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\NotificationActionControllerApi();
$id = 56; // Integer | 
$createNotificationActionRequest = ; // CreateNotificationActionRequest | 

try {
    $result = $api_instance->updateJobNotification($id, $createNotificationActionRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling NotificationActionControllerApi->updateJobNotification: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::NotificationActionControllerApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::NotificationActionControllerApi->new();
my $id = 56; # Integer | 
my $createNotificationActionRequest = WWW::OPenAPIClient::Object::CreateNotificationActionRequest->new(); # CreateNotificationActionRequest | 

eval {
    my $result = $api_instance->updateJobNotification(id => $id, createNotificationActionRequest => $createNotificationActionRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling NotificationActionControllerApi->updateJobNotification: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.NotificationActionControllerApi()
id = 56 # Integer |  (default to null)
createNotificationActionRequest =  # CreateNotificationActionRequest | 

try:
    api_response = api_instance.update_job_notification(id, createNotificationActionRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling NotificationActionControllerApi->updateJobNotification: %s\n" % e)
extern crate NotificationActionControllerApi;

pub fn main() {
    let id = 56; // Integer
    let createNotificationActionRequest = ; // CreateNotificationActionRequest

    let mut context = NotificationActionControllerApi::Context::default();
    let result = client.updateJobNotification(id, createNotificationActionRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required
Body parameters
Name Description
createNotificationActionRequest *

Responses


updateJobNotificationGroup


/internal/notification-actions/groups/{id}

Usage and SDK Samples

curl -X PUT \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost/internal/notification-actions/groups/{id}" \
 -d '{
  "children" : [ 0, 0 ],
  "name" : "name"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.NotificationActionControllerApi;

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

public class NotificationActionControllerApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        NotificationActionControllerApi apiInstance = new NotificationActionControllerApi();
        Integer id = 56; // Integer | 
        CreateNotificationGroupRequest createNotificationGroupRequest = ; // CreateNotificationGroupRequest | 

        try {
            NotificationGroupResponse result = apiInstance.updateJobNotificationGroup(id, createNotificationGroupRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NotificationActionControllerApi#updateJobNotificationGroup");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 
final CreateNotificationGroupRequest createNotificationGroupRequest = new CreateNotificationGroupRequest(); // CreateNotificationGroupRequest | 

try {
    final result = await api_instance.updateJobNotificationGroup(id, createNotificationGroupRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateJobNotificationGroup: $e\n');
}

import org.openapitools.client.api.NotificationActionControllerApi;

public class NotificationActionControllerApiExample {
    public static void main(String[] args) {
        NotificationActionControllerApi apiInstance = new NotificationActionControllerApi();
        Integer id = 56; // Integer | 
        CreateNotificationGroupRequest createNotificationGroupRequest = ; // CreateNotificationGroupRequest | 

        try {
            NotificationGroupResponse result = apiInstance.updateJobNotificationGroup(id, createNotificationGroupRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NotificationActionControllerApi#updateJobNotificationGroup");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
NotificationActionControllerApi *apiInstance = [[NotificationActionControllerApi alloc] init];
Integer *id = 56; //  (default to null)
CreateNotificationGroupRequest *createNotificationGroupRequest = ; // 

[apiInstance updateJobNotificationGroupWith:id
    createNotificationGroupRequest:createNotificationGroupRequest
              completionHandler: ^(NotificationGroupResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.NotificationActionControllerApi()
var id = 56; // {Integer} 
var createNotificationGroupRequest = ; // {CreateNotificationGroupRequest} 

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

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

            // Create an instance of the API class
            var apiInstance = new NotificationActionControllerApi();
            var id = 56;  // Integer |  (default to null)
            var createNotificationGroupRequest = new CreateNotificationGroupRequest(); // CreateNotificationGroupRequest | 

            try {
                NotificationGroupResponse result = apiInstance.updateJobNotificationGroup(id, createNotificationGroupRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling NotificationActionControllerApi.updateJobNotificationGroup: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\NotificationActionControllerApi();
$id = 56; // Integer | 
$createNotificationGroupRequest = ; // CreateNotificationGroupRequest | 

try {
    $result = $api_instance->updateJobNotificationGroup($id, $createNotificationGroupRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling NotificationActionControllerApi->updateJobNotificationGroup: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::NotificationActionControllerApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::NotificationActionControllerApi->new();
my $id = 56; # Integer | 
my $createNotificationGroupRequest = WWW::OPenAPIClient::Object::CreateNotificationGroupRequest->new(); # CreateNotificationGroupRequest | 

eval {
    my $result = $api_instance->updateJobNotificationGroup(id => $id, createNotificationGroupRequest => $createNotificationGroupRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling NotificationActionControllerApi->updateJobNotificationGroup: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.NotificationActionControllerApi()
id = 56 # Integer |  (default to null)
createNotificationGroupRequest =  # CreateNotificationGroupRequest | 

try:
    api_response = api_instance.update_job_notification_group(id, createNotificationGroupRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling NotificationActionControllerApi->updateJobNotificationGroup: %s\n" % e)
extern crate NotificationActionControllerApi;

pub fn main() {
    let id = 56; // Integer
    let createNotificationGroupRequest = ; // CreateNotificationGroupRequest

    let mut context = NotificationActionControllerApi::Context::default();
    let result = client.updateJobNotificationGroup(id, createNotificationGroupRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required
Body parameters
Name Description
createNotificationGroupRequest *

Responses


validateWebhookBody


/internal/notification-actions/validate

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost/internal/notification-actions/validate" \
 -d '{
  "metadata" : {
    "type" : "type"
  },
  "name" : "name"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.NotificationActionControllerApi;

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

public class NotificationActionControllerApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        NotificationActionControllerApi apiInstance = new NotificationActionControllerApi();
        CreateNotificationActionRequest createNotificationActionRequest = ; // CreateNotificationActionRequest | 

        try {
            apiInstance.validateWebhookBody(createNotificationActionRequest);
        } catch (ApiException e) {
            System.err.println("Exception when calling NotificationActionControllerApi#validateWebhookBody");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final CreateNotificationActionRequest createNotificationActionRequest = new CreateNotificationActionRequest(); // CreateNotificationActionRequest | 

try {
    final result = await api_instance.validateWebhookBody(createNotificationActionRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->validateWebhookBody: $e\n');
}

import org.openapitools.client.api.NotificationActionControllerApi;

public class NotificationActionControllerApiExample {
    public static void main(String[] args) {
        NotificationActionControllerApi apiInstance = new NotificationActionControllerApi();
        CreateNotificationActionRequest createNotificationActionRequest = ; // CreateNotificationActionRequest | 

        try {
            apiInstance.validateWebhookBody(createNotificationActionRequest);
        } catch (ApiException e) {
            System.err.println("Exception when calling NotificationActionControllerApi#validateWebhookBody");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
NotificationActionControllerApi *apiInstance = [[NotificationActionControllerApi alloc] init];
CreateNotificationActionRequest *createNotificationActionRequest = ; // 

[apiInstance validateWebhookBodyWith:createNotificationActionRequest
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.NotificationActionControllerApi()
var createNotificationActionRequest = ; // {CreateNotificationActionRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.validateWebhookBody(createNotificationActionRequest, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new NotificationActionControllerApi();
            var createNotificationActionRequest = new CreateNotificationActionRequest(); // CreateNotificationActionRequest | 

            try {
                apiInstance.validateWebhookBody(createNotificationActionRequest);
            } catch (Exception e) {
                Debug.Print("Exception when calling NotificationActionControllerApi.validateWebhookBody: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\NotificationActionControllerApi();
$createNotificationActionRequest = ; // CreateNotificationActionRequest | 

try {
    $api_instance->validateWebhookBody($createNotificationActionRequest);
} catch (Exception $e) {
    echo 'Exception when calling NotificationActionControllerApi->validateWebhookBody: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::NotificationActionControllerApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::NotificationActionControllerApi->new();
my $createNotificationActionRequest = WWW::OPenAPIClient::Object::CreateNotificationActionRequest->new(); # CreateNotificationActionRequest | 

eval {
    $api_instance->validateWebhookBody(createNotificationActionRequest => $createNotificationActionRequest);
};
if ($@) {
    warn "Exception when calling NotificationActionControllerApi->validateWebhookBody: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.NotificationActionControllerApi()
createNotificationActionRequest =  # CreateNotificationActionRequest | 

try:
    api_instance.validate_webhook_body(createNotificationActionRequest)
except ApiException as e:
    print("Exception when calling NotificationActionControllerApi->validateWebhookBody: %s\n" % e)
extern crate NotificationActionControllerApi;

pub fn main() {
    let createNotificationActionRequest = ; // CreateNotificationActionRequest

    let mut context = NotificationActionControllerApi::Context::default();
    let result = client.validateWebhookBody(createNotificationActionRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
createNotificationActionRequest *

Responses


ProjectEnvironmentOperations

activateV2

Activates an environment in the specified project.


/api/v2/projects/{projectId}/environments/{id}/activate

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 "http://localhost/api/v2/projects/{projectId}/environments/{id}/activate"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ProjectEnvironmentOperationsApi;

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

public class ProjectEnvironmentOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ProjectEnvironmentOperationsApi apiInstance = new ProjectEnvironmentOperationsApi();
        Integer id = 56; // Integer | 
        String projectId = projectId_example; // String | 

        try {
            apiInstance.activateV2(id, projectId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectEnvironmentOperationsApi#activateV2");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 
final String projectId = new String(); // String | 

try {
    final result = await api_instance.activateV2(id, projectId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->activateV2: $e\n');
}

import org.openapitools.client.api.ProjectEnvironmentOperationsApi;

public class ProjectEnvironmentOperationsApiExample {
    public static void main(String[] args) {
        ProjectEnvironmentOperationsApi apiInstance = new ProjectEnvironmentOperationsApi();
        Integer id = 56; // Integer | 
        String projectId = projectId_example; // String | 

        try {
            apiInstance.activateV2(id, projectId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectEnvironmentOperationsApi#activateV2");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ProjectEnvironmentOperationsApi *apiInstance = [[ProjectEnvironmentOperationsApi alloc] init];
Integer *id = 56; //  (default to null)
String *projectId = projectId_example; //  (default to null)

// Activates an environment in the specified project.
[apiInstance activateV2With:id
    projectId:projectId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.ProjectEnvironmentOperationsApi()
var id = 56; // {Integer} 
var projectId = projectId_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.activateV2(id, projectId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ProjectEnvironmentOperationsApi();
            var id = 56;  // Integer |  (default to null)
            var projectId = projectId_example;  // String |  (default to null)

            try {
                // Activates an environment in the specified project.
                apiInstance.activateV2(id, projectId);
            } catch (Exception e) {
                Debug.Print("Exception when calling ProjectEnvironmentOperationsApi.activateV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ProjectEnvironmentOperationsApi();
$id = 56; // Integer | 
$projectId = projectId_example; // String | 

try {
    $api_instance->activateV2($id, $projectId);
} catch (Exception $e) {
    echo 'Exception when calling ProjectEnvironmentOperationsApi->activateV2: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ProjectEnvironmentOperationsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ProjectEnvironmentOperationsApi->new();
my $id = 56; # Integer | 
my $projectId = projectId_example; # String | 

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

# Create an instance of the API class
api_instance = openapi_client.ProjectEnvironmentOperationsApi()
id = 56 # Integer |  (default to null)
projectId = projectId_example # String |  (default to null)

try:
    # Activates an environment in the specified project.
    api_instance.activate_v2(id, projectId)
except ApiException as e:
    print("Exception when calling ProjectEnvironmentOperationsApi->activateV2: %s\n" % e)
extern crate ProjectEnvironmentOperationsApi;

pub fn main() {
    let id = 56; // Integer
    let projectId = projectId_example; // String

    let mut context = ProjectEnvironmentOperationsApi::Context::default();
    let result = client.activateV2(id, projectId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required
projectId*
String
Required

Responses


createEnvironmentV2

Create a new environment in the specified project.


/api/v2/projects/{projectId}/environments

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost/api/v2/projects/{projectId}/environments" \
 -d '{
  "name" : "name",
  "properties" : {
    "key" : {
      "sensitive" : true,
      "value" : "value"
    }
  }
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ProjectEnvironmentOperationsApi;

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

public class ProjectEnvironmentOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ProjectEnvironmentOperationsApi apiInstance = new ProjectEnvironmentOperationsApi();
        String projectId = projectId_example; // String | 
        CreateEnvironmentRequest createEnvironmentRequest = ; // CreateEnvironmentRequest | 

        try {
            EnvironmentDto result = apiInstance.createEnvironmentV2(projectId, createEnvironmentRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectEnvironmentOperationsApi#createEnvironmentV2");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String projectId = new String(); // String | 
final CreateEnvironmentRequest createEnvironmentRequest = new CreateEnvironmentRequest(); // CreateEnvironmentRequest | 

try {
    final result = await api_instance.createEnvironmentV2(projectId, createEnvironmentRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->createEnvironmentV2: $e\n');
}

import org.openapitools.client.api.ProjectEnvironmentOperationsApi;

public class ProjectEnvironmentOperationsApiExample {
    public static void main(String[] args) {
        ProjectEnvironmentOperationsApi apiInstance = new ProjectEnvironmentOperationsApi();
        String projectId = projectId_example; // String | 
        CreateEnvironmentRequest createEnvironmentRequest = ; // CreateEnvironmentRequest | 

        try {
            EnvironmentDto result = apiInstance.createEnvironmentV2(projectId, createEnvironmentRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectEnvironmentOperationsApi#createEnvironmentV2");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ProjectEnvironmentOperationsApi *apiInstance = [[ProjectEnvironmentOperationsApi alloc] init];
String *projectId = projectId_example; //  (default to null)
CreateEnvironmentRequest *createEnvironmentRequest = ; // 

// Create a new environment in the specified project.
[apiInstance createEnvironmentV2With:projectId
    createEnvironmentRequest:createEnvironmentRequest
              completionHandler: ^(EnvironmentDto output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.ProjectEnvironmentOperationsApi()
var projectId = projectId_example; // {String} 
var createEnvironmentRequest = ; // {CreateEnvironmentRequest} 

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

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

            // Create an instance of the API class
            var apiInstance = new ProjectEnvironmentOperationsApi();
            var projectId = projectId_example;  // String |  (default to null)
            var createEnvironmentRequest = new CreateEnvironmentRequest(); // CreateEnvironmentRequest | 

            try {
                // Create a new environment in the specified project.
                EnvironmentDto result = apiInstance.createEnvironmentV2(projectId, createEnvironmentRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ProjectEnvironmentOperationsApi.createEnvironmentV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ProjectEnvironmentOperationsApi();
$projectId = projectId_example; // String | 
$createEnvironmentRequest = ; // CreateEnvironmentRequest | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ProjectEnvironmentOperationsApi->new();
my $projectId = projectId_example; # String | 
my $createEnvironmentRequest = WWW::OPenAPIClient::Object::CreateEnvironmentRequest->new(); # CreateEnvironmentRequest | 

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

# Create an instance of the API class
api_instance = openapi_client.ProjectEnvironmentOperationsApi()
projectId = projectId_example # String |  (default to null)
createEnvironmentRequest =  # CreateEnvironmentRequest | 

try:
    # Create a new environment in the specified project.
    api_response = api_instance.create_environment_v2(projectId, createEnvironmentRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectEnvironmentOperationsApi->createEnvironmentV2: %s\n" % e)
extern crate ProjectEnvironmentOperationsApi;

pub fn main() {
    let projectId = projectId_example; // String
    let createEnvironmentRequest = ; // CreateEnvironmentRequest

    let mut context = ProjectEnvironmentOperationsApi::Context::default();
    let result = client.createEnvironmentV2(projectId, createEnvironmentRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
projectId*
String
Required
Body parameters
Name Description
createEnvironmentRequest *

Responses


deactivateV2

Deactivates the active environment in the specified project.


/api/v2/projects/{projectId}/environments/deactivate

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 "http://localhost/api/v2/projects/{projectId}/environments/deactivate"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ProjectEnvironmentOperationsApi;

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

public class ProjectEnvironmentOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ProjectEnvironmentOperationsApi apiInstance = new ProjectEnvironmentOperationsApi();
        String projectId = projectId_example; // String | 

        try {
            apiInstance.deactivateV2(projectId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectEnvironmentOperationsApi#deactivateV2");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String projectId = new String(); // String | 

try {
    final result = await api_instance.deactivateV2(projectId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deactivateV2: $e\n');
}

import org.openapitools.client.api.ProjectEnvironmentOperationsApi;

public class ProjectEnvironmentOperationsApiExample {
    public static void main(String[] args) {
        ProjectEnvironmentOperationsApi apiInstance = new ProjectEnvironmentOperationsApi();
        String projectId = projectId_example; // String | 

        try {
            apiInstance.deactivateV2(projectId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectEnvironmentOperationsApi#deactivateV2");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ProjectEnvironmentOperationsApi *apiInstance = [[ProjectEnvironmentOperationsApi alloc] init];
String *projectId = projectId_example; //  (default to null)

// Deactivates the active environment in the specified project.
[apiInstance deactivateV2With:projectId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.ProjectEnvironmentOperationsApi()
var projectId = projectId_example; // {String} 

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

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

            // Create an instance of the API class
            var apiInstance = new ProjectEnvironmentOperationsApi();
            var projectId = projectId_example;  // String |  (default to null)

            try {
                // Deactivates the active environment in the specified project.
                apiInstance.deactivateV2(projectId);
            } catch (Exception e) {
                Debug.Print("Exception when calling ProjectEnvironmentOperationsApi.deactivateV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ProjectEnvironmentOperationsApi();
$projectId = projectId_example; // String | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ProjectEnvironmentOperationsApi->new();
my $projectId = projectId_example; # String | 

eval {
    $api_instance->deactivateV2(projectId => $projectId);
};
if ($@) {
    warn "Exception when calling ProjectEnvironmentOperationsApi->deactivateV2: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ProjectEnvironmentOperationsApi()
projectId = projectId_example # String |  (default to null)

try:
    # Deactivates the active environment in the specified project.
    api_instance.deactivate_v2(projectId)
except ApiException as e:
    print("Exception when calling ProjectEnvironmentOperationsApi->deactivateV2: %s\n" % e)
extern crate ProjectEnvironmentOperationsApi;

pub fn main() {
    let projectId = projectId_example; // String

    let mut context = ProjectEnvironmentOperationsApi::Context::default();
    let result = client.deactivateV2(projectId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
projectId*
String
Required

Responses


deleteEnvironmentV2

Delete an environment from the specified project.


/api/v2/projects/{projectId}/environments/{id}

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: application/json" \
 "http://localhost/api/v2/projects/{projectId}/environments/{id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ProjectEnvironmentOperationsApi;

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

public class ProjectEnvironmentOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ProjectEnvironmentOperationsApi apiInstance = new ProjectEnvironmentOperationsApi();
        Integer id = 56; // Integer | 
        String projectId = projectId_example; // String | 

        try {
            apiInstance.deleteEnvironmentV2(id, projectId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectEnvironmentOperationsApi#deleteEnvironmentV2");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 
final String projectId = new String(); // String | 

try {
    final result = await api_instance.deleteEnvironmentV2(id, projectId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteEnvironmentV2: $e\n');
}

import org.openapitools.client.api.ProjectEnvironmentOperationsApi;

public class ProjectEnvironmentOperationsApiExample {
    public static void main(String[] args) {
        ProjectEnvironmentOperationsApi apiInstance = new ProjectEnvironmentOperationsApi();
        Integer id = 56; // Integer | 
        String projectId = projectId_example; // String | 

        try {
            apiInstance.deleteEnvironmentV2(id, projectId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectEnvironmentOperationsApi#deleteEnvironmentV2");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ProjectEnvironmentOperationsApi *apiInstance = [[ProjectEnvironmentOperationsApi alloc] init];
Integer *id = 56; //  (default to null)
String *projectId = projectId_example; //  (default to null)

// Delete an environment from the specified project.
[apiInstance deleteEnvironmentV2With:id
    projectId:projectId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.ProjectEnvironmentOperationsApi()
var id = 56; // {Integer} 
var projectId = projectId_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteEnvironmentV2(id, projectId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ProjectEnvironmentOperationsApi();
            var id = 56;  // Integer |  (default to null)
            var projectId = projectId_example;  // String |  (default to null)

            try {
                // Delete an environment from the specified project.
                apiInstance.deleteEnvironmentV2(id, projectId);
            } catch (Exception e) {
                Debug.Print("Exception when calling ProjectEnvironmentOperationsApi.deleteEnvironmentV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ProjectEnvironmentOperationsApi();
$id = 56; // Integer | 
$projectId = projectId_example; // String | 

try {
    $api_instance->deleteEnvironmentV2($id, $projectId);
} catch (Exception $e) {
    echo 'Exception when calling ProjectEnvironmentOperationsApi->deleteEnvironmentV2: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ProjectEnvironmentOperationsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ProjectEnvironmentOperationsApi->new();
my $id = 56; # Integer | 
my $projectId = projectId_example; # String | 

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

# Create an instance of the API class
api_instance = openapi_client.ProjectEnvironmentOperationsApi()
id = 56 # Integer |  (default to null)
projectId = projectId_example # String |  (default to null)

try:
    # Delete an environment from the specified project.
    api_instance.delete_environment_v2(id, projectId)
except ApiException as e:
    print("Exception when calling ProjectEnvironmentOperationsApi->deleteEnvironmentV2: %s\n" % e)
extern crate ProjectEnvironmentOperationsApi;

pub fn main() {
    let id = 56; // Integer
    let projectId = projectId_example; // String

    let mut context = ProjectEnvironmentOperationsApi::Context::default();
    let result = client.deleteEnvironmentV2(id, projectId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required
projectId*
String
Required

Responses


exportEnvironmentFileV2

Export an environment to a JSON file.


/api/v2/projects/{projectId}/environments/file/{id}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/api/v2/projects/{projectId}/environments/file/{id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ProjectEnvironmentOperationsApi;

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

public class ProjectEnvironmentOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ProjectEnvironmentOperationsApi apiInstance = new ProjectEnvironmentOperationsApi();
        Integer id = 56; // Integer | 
        String projectId = projectId_example; // String | 

        try {
            EnvironmentFileDto result = apiInstance.exportEnvironmentFileV2(id, projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectEnvironmentOperationsApi#exportEnvironmentFileV2");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 
final String projectId = new String(); // String | 

try {
    final result = await api_instance.exportEnvironmentFileV2(id, projectId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->exportEnvironmentFileV2: $e\n');
}

import org.openapitools.client.api.ProjectEnvironmentOperationsApi;

public class ProjectEnvironmentOperationsApiExample {
    public static void main(String[] args) {
        ProjectEnvironmentOperationsApi apiInstance = new ProjectEnvironmentOperationsApi();
        Integer id = 56; // Integer | 
        String projectId = projectId_example; // String | 

        try {
            EnvironmentFileDto result = apiInstance.exportEnvironmentFileV2(id, projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectEnvironmentOperationsApi#exportEnvironmentFileV2");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ProjectEnvironmentOperationsApi *apiInstance = [[ProjectEnvironmentOperationsApi alloc] init];
Integer *id = 56; //  (default to null)
String *projectId = projectId_example; //  (default to null)

// Export an environment to a JSON file.
[apiInstance exportEnvironmentFileV2With:id
    projectId:projectId
              completionHandler: ^(EnvironmentFileDto output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.ProjectEnvironmentOperationsApi()
var id = 56; // {Integer} 
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.exportEnvironmentFileV2(id, projectId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ProjectEnvironmentOperationsApi();
            var id = 56;  // Integer |  (default to null)
            var projectId = projectId_example;  // String |  (default to null)

            try {
                // Export an environment to a JSON file.
                EnvironmentFileDto result = apiInstance.exportEnvironmentFileV2(id, projectId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ProjectEnvironmentOperationsApi.exportEnvironmentFileV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ProjectEnvironmentOperationsApi();
$id = 56; // Integer | 
$projectId = projectId_example; // String | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ProjectEnvironmentOperationsApi->new();
my $id = 56; # Integer | 
my $projectId = projectId_example; # String | 

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

# Create an instance of the API class
api_instance = openapi_client.ProjectEnvironmentOperationsApi()
id = 56 # Integer |  (default to null)
projectId = projectId_example # String |  (default to null)

try:
    # Export an environment to a JSON file.
    api_response = api_instance.export_environment_file_v2(id, projectId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectEnvironmentOperationsApi->exportEnvironmentFileV2: %s\n" % e)
extern crate ProjectEnvironmentOperationsApi;

pub fn main() {
    let id = 56; // Integer
    let projectId = projectId_example; // String

    let mut context = ProjectEnvironmentOperationsApi::Context::default();
    let result = client.exportEnvironmentFileV2(id, projectId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required
projectId*
String
Required

Responses


getAllEnvironmentsByProjectV2

Get all environments of the specified project


/api/v2/projects/{projectId}/environments

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/api/v2/projects/{projectId}/environments"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ProjectEnvironmentOperationsApi;

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

public class ProjectEnvironmentOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ProjectEnvironmentOperationsApi apiInstance = new ProjectEnvironmentOperationsApi();
        String projectId = projectId_example; // String | 

        try {
            array[EnvironmentDto] result = apiInstance.getAllEnvironmentsByProjectV2(projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectEnvironmentOperationsApi#getAllEnvironmentsByProjectV2");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String projectId = new String(); // String | 

try {
    final result = await api_instance.getAllEnvironmentsByProjectV2(projectId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getAllEnvironmentsByProjectV2: $e\n');
}

import org.openapitools.client.api.ProjectEnvironmentOperationsApi;

public class ProjectEnvironmentOperationsApiExample {
    public static void main(String[] args) {
        ProjectEnvironmentOperationsApi apiInstance = new ProjectEnvironmentOperationsApi();
        String projectId = projectId_example; // String | 

        try {
            array[EnvironmentDto] result = apiInstance.getAllEnvironmentsByProjectV2(projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectEnvironmentOperationsApi#getAllEnvironmentsByProjectV2");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ProjectEnvironmentOperationsApi *apiInstance = [[ProjectEnvironmentOperationsApi alloc] init];
String *projectId = projectId_example; //  (default to null)

// Get all environments of the specified project
[apiInstance getAllEnvironmentsByProjectV2With:projectId
              completionHandler: ^(array[EnvironmentDto] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.ProjectEnvironmentOperationsApi()
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.getAllEnvironmentsByProjectV2(projectId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ProjectEnvironmentOperationsApi();
            var projectId = projectId_example;  // String |  (default to null)

            try {
                // Get all environments of the specified project
                array[EnvironmentDto] result = apiInstance.getAllEnvironmentsByProjectV2(projectId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ProjectEnvironmentOperationsApi.getAllEnvironmentsByProjectV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ProjectEnvironmentOperationsApi();
$projectId = projectId_example; // String | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ProjectEnvironmentOperationsApi->new();
my $projectId = projectId_example; # String | 

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

# Create an instance of the API class
api_instance = openapi_client.ProjectEnvironmentOperationsApi()
projectId = projectId_example # String |  (default to null)

try:
    # Get all environments of the specified project
    api_response = api_instance.get_all_environments_by_project_v2(projectId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectEnvironmentOperationsApi->getAllEnvironmentsByProjectV2: %s\n" % e)
extern crate ProjectEnvironmentOperationsApi;

pub fn main() {
    let projectId = projectId_example; // String

    let mut context = ProjectEnvironmentOperationsApi::Context::default();
    let result = client.getAllEnvironmentsByProjectV2(projectId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
projectId*
String
Required

Responses


getEnvironmentByIdV2

Get an environment in the specified project


/api/v2/projects/{projectId}/environments/{id}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/api/v2/projects/{projectId}/environments/{id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ProjectEnvironmentOperationsApi;

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

public class ProjectEnvironmentOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ProjectEnvironmentOperationsApi apiInstance = new ProjectEnvironmentOperationsApi();
        Integer id = 56; // Integer | 
        String projectId = projectId_example; // String | 

        try {
            EnvironmentDto result = apiInstance.getEnvironmentByIdV2(id, projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectEnvironmentOperationsApi#getEnvironmentByIdV2");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 
final String projectId = new String(); // String | 

try {
    final result = await api_instance.getEnvironmentByIdV2(id, projectId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getEnvironmentByIdV2: $e\n');
}

import org.openapitools.client.api.ProjectEnvironmentOperationsApi;

public class ProjectEnvironmentOperationsApiExample {
    public static void main(String[] args) {
        ProjectEnvironmentOperationsApi apiInstance = new ProjectEnvironmentOperationsApi();
        Integer id = 56; // Integer | 
        String projectId = projectId_example; // String | 

        try {
            EnvironmentDto result = apiInstance.getEnvironmentByIdV2(id, projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectEnvironmentOperationsApi#getEnvironmentByIdV2");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ProjectEnvironmentOperationsApi *apiInstance = [[ProjectEnvironmentOperationsApi alloc] init];
Integer *id = 56; //  (default to null)
String *projectId = projectId_example; //  (default to null)

// Get an environment in the specified project
[apiInstance getEnvironmentByIdV2With:id
    projectId:projectId
              completionHandler: ^(EnvironmentDto output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.ProjectEnvironmentOperationsApi()
var id = 56; // {Integer} 
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.getEnvironmentByIdV2(id, projectId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ProjectEnvironmentOperationsApi();
            var id = 56;  // Integer |  (default to null)
            var projectId = projectId_example;  // String |  (default to null)

            try {
                // Get an environment in the specified project
                EnvironmentDto result = apiInstance.getEnvironmentByIdV2(id, projectId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ProjectEnvironmentOperationsApi.getEnvironmentByIdV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ProjectEnvironmentOperationsApi();
$id = 56; // Integer | 
$projectId = projectId_example; // String | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ProjectEnvironmentOperationsApi->new();
my $id = 56; # Integer | 
my $projectId = projectId_example; # String | 

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

# Create an instance of the API class
api_instance = openapi_client.ProjectEnvironmentOperationsApi()
id = 56 # Integer |  (default to null)
projectId = projectId_example # String |  (default to null)

try:
    # Get an environment in the specified project
    api_response = api_instance.get_environment_by_id_v2(id, projectId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectEnvironmentOperationsApi->getEnvironmentByIdV2: %s\n" % e)
extern crate ProjectEnvironmentOperationsApi;

pub fn main() {
    let id = 56; // Integer
    let projectId = projectId_example; // String

    let mut context = ProjectEnvironmentOperationsApi::Context::default();
    let result = client.getEnvironmentByIdV2(id, projectId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required
projectId*
String
Required

Responses


importEnvironmentFileV2

Import an environment from a JSON file.


/api/v2/projects/{projectId}/environments/file

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: multipart/form-data" \
 "http://localhost/api/v2/projects/{projectId}/environments/file"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ProjectEnvironmentOperationsApi;

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

public class ProjectEnvironmentOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ProjectEnvironmentOperationsApi apiInstance = new ProjectEnvironmentOperationsApi();
        String projectId = projectId_example; // String | 
        File file = BINARY_DATA_HERE; // File | 

        try {
            EnvironmentDto result = apiInstance.importEnvironmentFileV2(projectId, file);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectEnvironmentOperationsApi#importEnvironmentFileV2");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String projectId = new String(); // String | 
final File file = new File(); // File | 

try {
    final result = await api_instance.importEnvironmentFileV2(projectId, file);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->importEnvironmentFileV2: $e\n');
}

import org.openapitools.client.api.ProjectEnvironmentOperationsApi;

public class ProjectEnvironmentOperationsApiExample {
    public static void main(String[] args) {
        ProjectEnvironmentOperationsApi apiInstance = new ProjectEnvironmentOperationsApi();
        String projectId = projectId_example; // String | 
        File file = BINARY_DATA_HERE; // File | 

        try {
            EnvironmentDto result = apiInstance.importEnvironmentFileV2(projectId, file);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectEnvironmentOperationsApi#importEnvironmentFileV2");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ProjectEnvironmentOperationsApi *apiInstance = [[ProjectEnvironmentOperationsApi alloc] init];
String *projectId = projectId_example; //  (default to null)
File *file = BINARY_DATA_HERE; //  (default to null)

// Import an environment from a JSON file.
[apiInstance importEnvironmentFileV2With:projectId
    file:file
              completionHandler: ^(EnvironmentDto output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.ProjectEnvironmentOperationsApi()
var projectId = projectId_example; // {String} 
var file = BINARY_DATA_HERE; // {File} 

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

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

            // Create an instance of the API class
            var apiInstance = new ProjectEnvironmentOperationsApi();
            var projectId = projectId_example;  // String |  (default to null)
            var file = BINARY_DATA_HERE;  // File |  (default to null)

            try {
                // Import an environment from a JSON file.
                EnvironmentDto result = apiInstance.importEnvironmentFileV2(projectId, file);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ProjectEnvironmentOperationsApi.importEnvironmentFileV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ProjectEnvironmentOperationsApi();
$projectId = projectId_example; // String | 
$file = BINARY_DATA_HERE; // File | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ProjectEnvironmentOperationsApi->new();
my $projectId = projectId_example; # String | 
my $file = BINARY_DATA_HERE; # File | 

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

# Create an instance of the API class
api_instance = openapi_client.ProjectEnvironmentOperationsApi()
projectId = projectId_example # String |  (default to null)
file = BINARY_DATA_HERE # File |  (default to null)

try:
    # Import an environment from a JSON file.
    api_response = api_instance.import_environment_file_v2(projectId, file)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectEnvironmentOperationsApi->importEnvironmentFileV2: %s\n" % e)
extern crate ProjectEnvironmentOperationsApi;

pub fn main() {
    let projectId = projectId_example; // String
    let file = BINARY_DATA_HERE; // File

    let mut context = ProjectEnvironmentOperationsApi::Context::default();
    let result = client.importEnvironmentFileV2(projectId, file, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
projectId*
String
Required
Form parameters
Name Description
file*
File (binary)
Required

Responses


updateEnvironmentV2

Update an environment in the specified project.


/api/v2/projects/{projectId}/environments/{id}

Usage and SDK Samples

curl -X PUT \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost/api/v2/projects/{projectId}/environments/{id}" \
 -d '{
  "name" : "name",
  "properties" : {
    "key" : {
      "sensitive" : true,
      "value" : "value"
    }
  }
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ProjectEnvironmentOperationsApi;

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

public class ProjectEnvironmentOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ProjectEnvironmentOperationsApi apiInstance = new ProjectEnvironmentOperationsApi();
        Integer id = 56; // Integer | 
        String projectId = projectId_example; // String | 
        CreateEnvironmentRequest createEnvironmentRequest = ; // CreateEnvironmentRequest | 

        try {
            EnvironmentDto result = apiInstance.updateEnvironmentV2(id, projectId, createEnvironmentRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectEnvironmentOperationsApi#updateEnvironmentV2");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 
final String projectId = new String(); // String | 
final CreateEnvironmentRequest createEnvironmentRequest = new CreateEnvironmentRequest(); // CreateEnvironmentRequest | 

try {
    final result = await api_instance.updateEnvironmentV2(id, projectId, createEnvironmentRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateEnvironmentV2: $e\n');
}

import org.openapitools.client.api.ProjectEnvironmentOperationsApi;

public class ProjectEnvironmentOperationsApiExample {
    public static void main(String[] args) {
        ProjectEnvironmentOperationsApi apiInstance = new ProjectEnvironmentOperationsApi();
        Integer id = 56; // Integer | 
        String projectId = projectId_example; // String | 
        CreateEnvironmentRequest createEnvironmentRequest = ; // CreateEnvironmentRequest | 

        try {
            EnvironmentDto result = apiInstance.updateEnvironmentV2(id, projectId, createEnvironmentRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectEnvironmentOperationsApi#updateEnvironmentV2");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ProjectEnvironmentOperationsApi *apiInstance = [[ProjectEnvironmentOperationsApi alloc] init];
Integer *id = 56; //  (default to null)
String *projectId = projectId_example; //  (default to null)
CreateEnvironmentRequest *createEnvironmentRequest = ; // 

// Update an environment in the specified project.
[apiInstance updateEnvironmentV2With:id
    projectId:projectId
    createEnvironmentRequest:createEnvironmentRequest
              completionHandler: ^(EnvironmentDto output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.ProjectEnvironmentOperationsApi()
var id = 56; // {Integer} 
var projectId = projectId_example; // {String} 
var createEnvironmentRequest = ; // {CreateEnvironmentRequest} 

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

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

            // Create an instance of the API class
            var apiInstance = new ProjectEnvironmentOperationsApi();
            var id = 56;  // Integer |  (default to null)
            var projectId = projectId_example;  // String |  (default to null)
            var createEnvironmentRequest = new CreateEnvironmentRequest(); // CreateEnvironmentRequest | 

            try {
                // Update an environment in the specified project.
                EnvironmentDto result = apiInstance.updateEnvironmentV2(id, projectId, createEnvironmentRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ProjectEnvironmentOperationsApi.updateEnvironmentV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ProjectEnvironmentOperationsApi();
$id = 56; // Integer | 
$projectId = projectId_example; // String | 
$createEnvironmentRequest = ; // CreateEnvironmentRequest | 

try {
    $result = $api_instance->updateEnvironmentV2($id, $projectId, $createEnvironmentRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectEnvironmentOperationsApi->updateEnvironmentV2: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ProjectEnvironmentOperationsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ProjectEnvironmentOperationsApi->new();
my $id = 56; # Integer | 
my $projectId = projectId_example; # String | 
my $createEnvironmentRequest = WWW::OPenAPIClient::Object::CreateEnvironmentRequest->new(); # CreateEnvironmentRequest | 

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

# Create an instance of the API class
api_instance = openapi_client.ProjectEnvironmentOperationsApi()
id = 56 # Integer |  (default to null)
projectId = projectId_example # String |  (default to null)
createEnvironmentRequest =  # CreateEnvironmentRequest | 

try:
    # Update an environment in the specified project.
    api_response = api_instance.update_environment_v2(id, projectId, createEnvironmentRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectEnvironmentOperationsApi->updateEnvironmentV2: %s\n" % e)
extern crate ProjectEnvironmentOperationsApi;

pub fn main() {
    let id = 56; // Integer
    let projectId = projectId_example; // String
    let createEnvironmentRequest = ; // CreateEnvironmentRequest

    let mut context = ProjectEnvironmentOperationsApi::Context::default();
    let result = client.updateEnvironmentV2(id, projectId, createEnvironmentRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required
projectId*
String
Required
Body parameters
Name Description
createEnvironmentRequest *

Responses


ProjectInvitationOperations

acceptProjectInvitationV2

Accepts Project Invitation for the provided project id.


/api/v2/project-invitations/accept/{projectId}

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 "http://localhost/api/v2/project-invitations/accept/{projectId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ProjectInvitationOperationsApi;

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

public class ProjectInvitationOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ProjectInvitationOperationsApi apiInstance = new ProjectInvitationOperationsApi();
        String projectId = projectId_example; // String | 

        try {
            apiInstance.acceptProjectInvitationV2(projectId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectInvitationOperationsApi#acceptProjectInvitationV2");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String projectId = new String(); // String | 

try {
    final result = await api_instance.acceptProjectInvitationV2(projectId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->acceptProjectInvitationV2: $e\n');
}

import org.openapitools.client.api.ProjectInvitationOperationsApi;

public class ProjectInvitationOperationsApiExample {
    public static void main(String[] args) {
        ProjectInvitationOperationsApi apiInstance = new ProjectInvitationOperationsApi();
        String projectId = projectId_example; // String | 

        try {
            apiInstance.acceptProjectInvitationV2(projectId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectInvitationOperationsApi#acceptProjectInvitationV2");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ProjectInvitationOperationsApi *apiInstance = [[ProjectInvitationOperationsApi alloc] init];
String *projectId = projectId_example; //  (default to null)

// Accepts Project Invitation for the provided project id.
[apiInstance acceptProjectInvitationV2With:projectId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.ProjectInvitationOperationsApi()
var projectId = projectId_example; // {String} 

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

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

            // Create an instance of the API class
            var apiInstance = new ProjectInvitationOperationsApi();
            var projectId = projectId_example;  // String |  (default to null)

            try {
                // Accepts Project Invitation for the provided project id.
                apiInstance.acceptProjectInvitationV2(projectId);
            } catch (Exception e) {
                Debug.Print("Exception when calling ProjectInvitationOperationsApi.acceptProjectInvitationV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ProjectInvitationOperationsApi();
$projectId = projectId_example; // String | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ProjectInvitationOperationsApi->new();
my $projectId = projectId_example; # String | 

eval {
    $api_instance->acceptProjectInvitationV2(projectId => $projectId);
};
if ($@) {
    warn "Exception when calling ProjectInvitationOperationsApi->acceptProjectInvitationV2: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ProjectInvitationOperationsApi()
projectId = projectId_example # String |  (default to null)

try:
    # Accepts Project Invitation for the provided project id.
    api_instance.accept_project_invitation_v2(projectId)
except ApiException as e:
    print("Exception when calling ProjectInvitationOperationsApi->acceptProjectInvitationV2: %s\n" % e)
extern crate ProjectInvitationOperationsApi;

pub fn main() {
    let projectId = projectId_example; // String

    let mut context = ProjectInvitationOperationsApi::Context::default();
    let result = client.acceptProjectInvitationV2(projectId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
projectId*
String
Required

Responses


createProjectInvitationV2

Creates a new Project Invitation.


/api/v2/project-invitations

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost/api/v2/project-invitations" \
 -d '{
  "access_level" : "access_level",
  "project_id" : "project_id",
  "username" : "username"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ProjectInvitationOperationsApi;

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

public class ProjectInvitationOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ProjectInvitationOperationsApi apiInstance = new ProjectInvitationOperationsApi();
        ProjectInvitationDtoV2 projectInvitationDtoV2 = ; // ProjectInvitationDtoV2 | 

        try {
            ProjectInvitationDto result = apiInstance.createProjectInvitationV2(projectInvitationDtoV2);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectInvitationOperationsApi#createProjectInvitationV2");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final ProjectInvitationDtoV2 projectInvitationDtoV2 = new ProjectInvitationDtoV2(); // ProjectInvitationDtoV2 | 

try {
    final result = await api_instance.createProjectInvitationV2(projectInvitationDtoV2);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->createProjectInvitationV2: $e\n');
}

import org.openapitools.client.api.ProjectInvitationOperationsApi;

public class ProjectInvitationOperationsApiExample {
    public static void main(String[] args) {
        ProjectInvitationOperationsApi apiInstance = new ProjectInvitationOperationsApi();
        ProjectInvitationDtoV2 projectInvitationDtoV2 = ; // ProjectInvitationDtoV2 | 

        try {
            ProjectInvitationDto result = apiInstance.createProjectInvitationV2(projectInvitationDtoV2);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectInvitationOperationsApi#createProjectInvitationV2");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ProjectInvitationOperationsApi *apiInstance = [[ProjectInvitationOperationsApi alloc] init];
ProjectInvitationDtoV2 *projectInvitationDtoV2 = ; // 

// Creates a new Project Invitation.
[apiInstance createProjectInvitationV2With:projectInvitationDtoV2
              completionHandler: ^(ProjectInvitationDto output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.ProjectInvitationOperationsApi()
var projectInvitationDtoV2 = ; // {ProjectInvitationDtoV2} 

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

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

            // Create an instance of the API class
            var apiInstance = new ProjectInvitationOperationsApi();
            var projectInvitationDtoV2 = new ProjectInvitationDtoV2(); // ProjectInvitationDtoV2 | 

            try {
                // Creates a new Project Invitation.
                ProjectInvitationDto result = apiInstance.createProjectInvitationV2(projectInvitationDtoV2);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ProjectInvitationOperationsApi.createProjectInvitationV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ProjectInvitationOperationsApi();
$projectInvitationDtoV2 = ; // ProjectInvitationDtoV2 | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ProjectInvitationOperationsApi->new();
my $projectInvitationDtoV2 = WWW::OPenAPIClient::Object::ProjectInvitationDtoV2->new(); # ProjectInvitationDtoV2 | 

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

# Create an instance of the API class
api_instance = openapi_client.ProjectInvitationOperationsApi()
projectInvitationDtoV2 =  # ProjectInvitationDtoV2 | 

try:
    # Creates a new Project Invitation.
    api_response = api_instance.create_project_invitation_v2(projectInvitationDtoV2)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectInvitationOperationsApi->createProjectInvitationV2: %s\n" % e)
extern crate ProjectInvitationOperationsApi;

pub fn main() {
    let projectInvitationDtoV2 = ; // ProjectInvitationDtoV2

    let mut context = ProjectInvitationOperationsApi::Context::default();
    let result = client.createProjectInvitationV2(projectInvitationDtoV2, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
projectInvitationDtoV2 *

Responses


deleteProjectInvitationV2

Deletes a Project Invitation by user id and project id.


/api/v2/project-invitations

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: application/json" \
 "http://localhost/api/v2/project-invitations?user_id=userId_example&project_id=projectId_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ProjectInvitationOperationsApi;

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

public class ProjectInvitationOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ProjectInvitationOperationsApi apiInstance = new ProjectInvitationOperationsApi();
        String userId = userId_example; // String | 
        String projectId = projectId_example; // String | 

        try {
            apiInstance.deleteProjectInvitationV2(userId, projectId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectInvitationOperationsApi#deleteProjectInvitationV2");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String userId = new String(); // String | 
final String projectId = new String(); // String | 

try {
    final result = await api_instance.deleteProjectInvitationV2(userId, projectId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteProjectInvitationV2: $e\n');
}

import org.openapitools.client.api.ProjectInvitationOperationsApi;

public class ProjectInvitationOperationsApiExample {
    public static void main(String[] args) {
        ProjectInvitationOperationsApi apiInstance = new ProjectInvitationOperationsApi();
        String userId = userId_example; // String | 
        String projectId = projectId_example; // String | 

        try {
            apiInstance.deleteProjectInvitationV2(userId, projectId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectInvitationOperationsApi#deleteProjectInvitationV2");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ProjectInvitationOperationsApi *apiInstance = [[ProjectInvitationOperationsApi alloc] init];
String *userId = userId_example; //  (default to null)
String *projectId = projectId_example; //  (default to null)

// Deletes a Project Invitation by user id and project id.
[apiInstance deleteProjectInvitationV2With:userId
    projectId:projectId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.ProjectInvitationOperationsApi()
var userId = userId_example; // {String} 
var projectId = projectId_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteProjectInvitationV2(userId, projectId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ProjectInvitationOperationsApi();
            var userId = userId_example;  // String |  (default to null)
            var projectId = projectId_example;  // String |  (default to null)

            try {
                // Deletes a Project Invitation by user id and project id.
                apiInstance.deleteProjectInvitationV2(userId, projectId);
            } catch (Exception e) {
                Debug.Print("Exception when calling ProjectInvitationOperationsApi.deleteProjectInvitationV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ProjectInvitationOperationsApi();
$userId = userId_example; // String | 
$projectId = projectId_example; // String | 

try {
    $api_instance->deleteProjectInvitationV2($userId, $projectId);
} catch (Exception $e) {
    echo 'Exception when calling ProjectInvitationOperationsApi->deleteProjectInvitationV2: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ProjectInvitationOperationsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ProjectInvitationOperationsApi->new();
my $userId = userId_example; # String | 
my $projectId = projectId_example; # String | 

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

# Create an instance of the API class
api_instance = openapi_client.ProjectInvitationOperationsApi()
userId = userId_example # String |  (default to null)
projectId = projectId_example # String |  (default to null)

try:
    # Deletes a Project Invitation by user id and project id.
    api_instance.delete_project_invitation_v2(userId, projectId)
except ApiException as e:
    print("Exception when calling ProjectInvitationOperationsApi->deleteProjectInvitationV2: %s\n" % e)
extern crate ProjectInvitationOperationsApi;

pub fn main() {
    let userId = userId_example; // String
    let projectId = projectId_example; // String

    let mut context = ProjectInvitationOperationsApi::Context::default();
    let result = client.deleteProjectInvitationV2(userId, projectId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
user_id*
String
Required
project_id*
String
Required

Responses


getProjectInvitationsV2

Retrieves Project Invitations by user id and / or project id.


/api/v2/project-invitations

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/api/v2/project-invitations?user_id=userId_example&project_id=projectId_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ProjectInvitationOperationsApi;

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

public class ProjectInvitationOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ProjectInvitationOperationsApi apiInstance = new ProjectInvitationOperationsApi();
        String userId = userId_example; // String | 
        String projectId = projectId_example; // String | 

        try {
            ProjectInvitationsResponse result = apiInstance.getProjectInvitationsV2(userId, projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectInvitationOperationsApi#getProjectInvitationsV2");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String userId = new String(); // String | 
final String projectId = new String(); // String | 

try {
    final result = await api_instance.getProjectInvitationsV2(userId, projectId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getProjectInvitationsV2: $e\n');
}

import org.openapitools.client.api.ProjectInvitationOperationsApi;

public class ProjectInvitationOperationsApiExample {
    public static void main(String[] args) {
        ProjectInvitationOperationsApi apiInstance = new ProjectInvitationOperationsApi();
        String userId = userId_example; // String | 
        String projectId = projectId_example; // String | 

        try {
            ProjectInvitationsResponse result = apiInstance.getProjectInvitationsV2(userId, projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectInvitationOperationsApi#getProjectInvitationsV2");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ProjectInvitationOperationsApi *apiInstance = [[ProjectInvitationOperationsApi alloc] init];
String *userId = userId_example; //  (optional) (default to null)
String *projectId = projectId_example; //  (optional) (default to null)

// Retrieves Project Invitations by user id and / or project id.
[apiInstance getProjectInvitationsV2With:userId
    projectId:projectId
              completionHandler: ^(ProjectInvitationsResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.ProjectInvitationOperationsApi()
var opts = {
  'userId': userId_example, // {String} 
  '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.getProjectInvitationsV2(opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ProjectInvitationOperationsApi();
            var userId = userId_example;  // String |  (optional)  (default to null)
            var projectId = projectId_example;  // String |  (optional)  (default to null)

            try {
                // Retrieves Project Invitations by user id and / or project id.
                ProjectInvitationsResponse result = apiInstance.getProjectInvitationsV2(userId, projectId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ProjectInvitationOperationsApi.getProjectInvitationsV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ProjectInvitationOperationsApi();
$userId = userId_example; // String | 
$projectId = projectId_example; // String | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ProjectInvitationOperationsApi->new();
my $userId = userId_example; # String | 
my $projectId = projectId_example; # String | 

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

# Create an instance of the API class
api_instance = openapi_client.ProjectInvitationOperationsApi()
userId = userId_example # String |  (optional) (default to null)
projectId = projectId_example # String |  (optional) (default to null)

try:
    # Retrieves Project Invitations by user id and / or project id.
    api_response = api_instance.get_project_invitations_v2(userId=userId, projectId=projectId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectInvitationOperationsApi->getProjectInvitationsV2: %s\n" % e)
extern crate ProjectInvitationOperationsApi;

pub fn main() {
    let userId = userId_example; // String
    let projectId = projectId_example; // String

    let mut context = ProjectInvitationOperationsApi::Context::default();
    let result = client.getProjectInvitationsV2(userId, projectId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
user_id
String
project_id
String

Responses


ProjectOperations

createProjectV2

Creates a new project.


/api/v2/projects

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost/api/v2/projects" \
 -d '{
  "sync_source_config" : {
    "type" : "type",
    "allow_deletions" : true
  },
  "name" : "name",
  "description" : "description",
  "mv_prefix" : "mv_prefix",
  "id" : "id"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ProjectOperationsApi;

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

public class ProjectOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ProjectOperationsApi apiInstance = new ProjectOperationsApi();
        CreateProjectRequest createProjectRequest = ; // CreateProjectRequest | 

        try {
            ProjectDto result = apiInstance.createProjectV2(createProjectRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectOperationsApi#createProjectV2");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final CreateProjectRequest createProjectRequest = new CreateProjectRequest(); // CreateProjectRequest | 

try {
    final result = await api_instance.createProjectV2(createProjectRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->createProjectV2: $e\n');
}

import org.openapitools.client.api.ProjectOperationsApi;

public class ProjectOperationsApiExample {
    public static void main(String[] args) {
        ProjectOperationsApi apiInstance = new ProjectOperationsApi();
        CreateProjectRequest createProjectRequest = ; // CreateProjectRequest | 

        try {
            ProjectDto result = apiInstance.createProjectV2(createProjectRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectOperationsApi#createProjectV2");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ProjectOperationsApi *apiInstance = [[ProjectOperationsApi alloc] init];
CreateProjectRequest *createProjectRequest = ; // 

// Creates a new project.
[apiInstance createProjectV2With:createProjectRequest
              completionHandler: ^(ProjectDto output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.ProjectOperationsApi()
var createProjectRequest = ; // {CreateProjectRequest} 

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

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

            // Create an instance of the API class
            var apiInstance = new ProjectOperationsApi();
            var createProjectRequest = new CreateProjectRequest(); // CreateProjectRequest | 

            try {
                // Creates a new project.
                ProjectDto result = apiInstance.createProjectV2(createProjectRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ProjectOperationsApi.createProjectV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ProjectOperationsApi();
$createProjectRequest = ; // CreateProjectRequest | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ProjectOperationsApi->new();
my $createProjectRequest = WWW::OPenAPIClient::Object::CreateProjectRequest->new(); # CreateProjectRequest | 

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

# Create an instance of the API class
api_instance = openapi_client.ProjectOperationsApi()
createProjectRequest =  # CreateProjectRequest | 

try:
    # Creates a new project.
    api_response = api_instance.create_project_v2(createProjectRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectOperationsApi->createProjectV2: %s\n" % e)
extern crate ProjectOperationsApi;

pub fn main() {
    let createProjectRequest = ; // CreateProjectRequest

    let mut context = ProjectOperationsApi::Context::default();
    let result = client.createProjectV2(createProjectRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
createProjectRequest *

Responses


deleteProjectV2

Deletes a project by its id.


/api/v2/projects/{projectId}

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: application/json" \
 "http://localhost/api/v2/projects/{projectId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ProjectOperationsApi;

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

public class ProjectOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ProjectOperationsApi apiInstance = new ProjectOperationsApi();
        String projectId = projectId_example; // String | 

        try {
            apiInstance.deleteProjectV2(projectId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectOperationsApi#deleteProjectV2");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String projectId = new String(); // String | 

try {
    final result = await api_instance.deleteProjectV2(projectId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteProjectV2: $e\n');
}

import org.openapitools.client.api.ProjectOperationsApi;

public class ProjectOperationsApiExample {
    public static void main(String[] args) {
        ProjectOperationsApi apiInstance = new ProjectOperationsApi();
        String projectId = projectId_example; // String | 

        try {
            apiInstance.deleteProjectV2(projectId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectOperationsApi#deleteProjectV2");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ProjectOperationsApi *apiInstance = [[ProjectOperationsApi alloc] init];
String *projectId = projectId_example; //  (default to null)

// Deletes a project by its id.
[apiInstance deleteProjectV2With:projectId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.ProjectOperationsApi()
var projectId = projectId_example; // {String} 

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

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

            // Create an instance of the API class
            var apiInstance = new ProjectOperationsApi();
            var projectId = projectId_example;  // String |  (default to null)

            try {
                // Deletes a project by its id.
                apiInstance.deleteProjectV2(projectId);
            } catch (Exception e) {
                Debug.Print("Exception when calling ProjectOperationsApi.deleteProjectV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ProjectOperationsApi();
$projectId = projectId_example; // String | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ProjectOperationsApi->new();
my $projectId = projectId_example; # String | 

eval {
    $api_instance->deleteProjectV2(projectId => $projectId);
};
if ($@) {
    warn "Exception when calling ProjectOperationsApi->deleteProjectV2: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ProjectOperationsApi()
projectId = projectId_example # String |  (default to null)

try:
    # Deletes a project by its id.
    api_instance.delete_project_v2(projectId)
except ApiException as e:
    print("Exception when calling ProjectOperationsApi->deleteProjectV2: %s\n" % e)
extern crate ProjectOperationsApi;

pub fn main() {
    let projectId = projectId_example; // String

    let mut context = ProjectOperationsApi::Context::default();
    let result = client.deleteProjectV2(projectId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
projectId*
String
Required

Responses


findProjectByIdV2

Retrieves a project by its id.


/api/v2/projects/{projectId}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/api/v2/projects/{projectId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ProjectOperationsApi;

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

public class ProjectOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ProjectOperationsApi apiInstance = new ProjectOperationsApi();
        String projectId = projectId_example; // String | 

        try {
            ProjectDto result = apiInstance.findProjectByIdV2(projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectOperationsApi#findProjectByIdV2");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String projectId = new String(); // String | 

try {
    final result = await api_instance.findProjectByIdV2(projectId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->findProjectByIdV2: $e\n');
}

import org.openapitools.client.api.ProjectOperationsApi;

public class ProjectOperationsApiExample {
    public static void main(String[] args) {
        ProjectOperationsApi apiInstance = new ProjectOperationsApi();
        String projectId = projectId_example; // String | 

        try {
            ProjectDto result = apiInstance.findProjectByIdV2(projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectOperationsApi#findProjectByIdV2");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ProjectOperationsApi *apiInstance = [[ProjectOperationsApi alloc] init];
String *projectId = projectId_example; //  (default to null)

// Retrieves a project by its id.
[apiInstance findProjectByIdV2With:projectId
              completionHandler: ^(ProjectDto output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.ProjectOperationsApi()
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.findProjectByIdV2(projectId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ProjectOperationsApi();
            var projectId = projectId_example;  // String |  (default to null)

            try {
                // Retrieves a project by its id.
                ProjectDto result = apiInstance.findProjectByIdV2(projectId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ProjectOperationsApi.findProjectByIdV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ProjectOperationsApi();
$projectId = projectId_example; // String | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ProjectOperationsApi->new();
my $projectId = projectId_example; # String | 

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

# Create an instance of the API class
api_instance = openapi_client.ProjectOperationsApi()
projectId = projectId_example # String |  (default to null)

try:
    # Retrieves a project by its id.
    api_response = api_instance.find_project_by_id_v2(projectId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectOperationsApi->findProjectByIdV2: %s\n" % e)
extern crate ProjectOperationsApi;

pub fn main() {
    let projectId = projectId_example; // String

    let mut context = ProjectOperationsApi::Context::default();
    let result = client.findProjectByIdV2(projectId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
projectId*
String
Required

Responses


getAllProjectsWithAccessV2

Retrieves all projects the user has access to.


/api/v2/projects

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/api/v2/projects"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ProjectOperationsApi;

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

public class ProjectOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ProjectOperationsApi apiInstance = new ProjectOperationsApi();

        try {
            array[ProjectDto] result = apiInstance.getAllProjectsWithAccessV2();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectOperationsApi#getAllProjectsWithAccessV2");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();


try {
    final result = await api_instance.getAllProjectsWithAccessV2();
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getAllProjectsWithAccessV2: $e\n');
}

import org.openapitools.client.api.ProjectOperationsApi;

public class ProjectOperationsApiExample {
    public static void main(String[] args) {
        ProjectOperationsApi apiInstance = new ProjectOperationsApi();

        try {
            array[ProjectDto] result = apiInstance.getAllProjectsWithAccessV2();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectOperationsApi#getAllProjectsWithAccessV2");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ProjectOperationsApi *apiInstance = [[ProjectOperationsApi alloc] init];

// Retrieves all projects the user has access to.
[apiInstance getAllProjectsWithAccessV2WithCompletionHandler: 
              ^(array[ProjectDto] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.ProjectOperationsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAllProjectsWithAccessV2(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ProjectOperationsApi();

            try {
                // Retrieves all projects the user has access to.
                array[ProjectDto] result = apiInstance.getAllProjectsWithAccessV2();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ProjectOperationsApi.getAllProjectsWithAccessV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ProjectOperationsApi();

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ProjectOperationsApi->new();

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

# Create an instance of the API class
api_instance = openapi_client.ProjectOperationsApi()

try:
    # Retrieves all projects the user has access to.
    api_response = api_instance.get_all_projects_with_access_v2()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectOperationsApi->getAllProjectsWithAccessV2: %s\n" % e)
extern crate ProjectOperationsApi;

pub fn main() {

    let mut context = ProjectOperationsApi::Context::default();
    let result = client.getAllProjectsWithAccessV2(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


importProjectV21

Import a new project to SSB from a specified sync source.


/api/v2/projects/import

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost/api/v2/projects/import" \
 -d '{
  "sync_source_config" : {
    "type" : "type",
    "allow_deletions" : true
  },
  "mv_prefix" : "mv_prefix",
  "project_name" : "project_name"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ProjectOperationsApi;

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

public class ProjectOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ProjectOperationsApi apiInstance = new ProjectOperationsApi();
        ImportNewProjectRequest importNewProjectRequest = ; // ImportNewProjectRequest | 

        try {
            SyncResponse result = apiInstance.importProjectV21(importNewProjectRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectOperationsApi#importProjectV21");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final ImportNewProjectRequest importNewProjectRequest = new ImportNewProjectRequest(); // ImportNewProjectRequest | 

try {
    final result = await api_instance.importProjectV21(importNewProjectRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->importProjectV21: $e\n');
}

import org.openapitools.client.api.ProjectOperationsApi;

public class ProjectOperationsApiExample {
    public static void main(String[] args) {
        ProjectOperationsApi apiInstance = new ProjectOperationsApi();
        ImportNewProjectRequest importNewProjectRequest = ; // ImportNewProjectRequest | 

        try {
            SyncResponse result = apiInstance.importProjectV21(importNewProjectRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectOperationsApi#importProjectV21");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ProjectOperationsApi *apiInstance = [[ProjectOperationsApi alloc] init];
ImportNewProjectRequest *importNewProjectRequest = ; // 

// Import a new project to SSB from a specified sync source.
[apiInstance importProjectV21With:importNewProjectRequest
              completionHandler: ^(SyncResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.ProjectOperationsApi()
var importNewProjectRequest = ; // {ImportNewProjectRequest} 

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

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

            // Create an instance of the API class
            var apiInstance = new ProjectOperationsApi();
            var importNewProjectRequest = new ImportNewProjectRequest(); // ImportNewProjectRequest | 

            try {
                // Import a new project to SSB from a specified sync source.
                SyncResponse result = apiInstance.importProjectV21(importNewProjectRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ProjectOperationsApi.importProjectV21: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ProjectOperationsApi();
$importNewProjectRequest = ; // ImportNewProjectRequest | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ProjectOperationsApi->new();
my $importNewProjectRequest = WWW::OPenAPIClient::Object::ImportNewProjectRequest->new(); # ImportNewProjectRequest | 

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

# Create an instance of the API class
api_instance = openapi_client.ProjectOperationsApi()
importNewProjectRequest =  # ImportNewProjectRequest | 

try:
    # Import a new project to SSB from a specified sync source.
    api_response = api_instance.import_project_v21(importNewProjectRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectOperationsApi->importProjectV21: %s\n" % e)
extern crate ProjectOperationsApi;

pub fn main() {
    let importNewProjectRequest = ; // ImportNewProjectRequest

    let mut context = ProjectOperationsApi::Context::default();
    let result = client.importProjectV21(importNewProjectRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
importNewProjectRequest *

Responses


ProjectPermissionOperations

deleteProjectPermission

Deletes a Project Permission by user id and project id.


/api/v2/project-permissions

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: application/json" \
 "http://localhost/api/v2/project-permissions?user_id=userId_example&project_id=projectId_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ProjectPermissionOperationsApi;

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

public class ProjectPermissionOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ProjectPermissionOperationsApi apiInstance = new ProjectPermissionOperationsApi();
        String userId = userId_example; // String | 
        String projectId = projectId_example; // String | 

        try {
            apiInstance.deleteProjectPermission(userId, projectId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectPermissionOperationsApi#deleteProjectPermission");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String userId = new String(); // String | 
final String projectId = new String(); // String | 

try {
    final result = await api_instance.deleteProjectPermission(userId, projectId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteProjectPermission: $e\n');
}

import org.openapitools.client.api.ProjectPermissionOperationsApi;

public class ProjectPermissionOperationsApiExample {
    public static void main(String[] args) {
        ProjectPermissionOperationsApi apiInstance = new ProjectPermissionOperationsApi();
        String userId = userId_example; // String | 
        String projectId = projectId_example; // String | 

        try {
            apiInstance.deleteProjectPermission(userId, projectId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectPermissionOperationsApi#deleteProjectPermission");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ProjectPermissionOperationsApi *apiInstance = [[ProjectPermissionOperationsApi alloc] init];
String *userId = userId_example; //  (default to null)
String *projectId = projectId_example; //  (default to null)

// Deletes a Project Permission by user id and project id.
[apiInstance deleteProjectPermissionWith:userId
    projectId:projectId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.ProjectPermissionOperationsApi()
var userId = userId_example; // {String} 
var projectId = projectId_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteProjectPermission(userId, projectId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ProjectPermissionOperationsApi();
            var userId = userId_example;  // String |  (default to null)
            var projectId = projectId_example;  // String |  (default to null)

            try {
                // Deletes a Project Permission by user id and project id.
                apiInstance.deleteProjectPermission(userId, projectId);
            } catch (Exception e) {
                Debug.Print("Exception when calling ProjectPermissionOperationsApi.deleteProjectPermission: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ProjectPermissionOperationsApi();
$userId = userId_example; // String | 
$projectId = projectId_example; // String | 

try {
    $api_instance->deleteProjectPermission($userId, $projectId);
} catch (Exception $e) {
    echo 'Exception when calling ProjectPermissionOperationsApi->deleteProjectPermission: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ProjectPermissionOperationsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ProjectPermissionOperationsApi->new();
my $userId = userId_example; # String | 
my $projectId = projectId_example; # String | 

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

# Create an instance of the API class
api_instance = openapi_client.ProjectPermissionOperationsApi()
userId = userId_example # String |  (default to null)
projectId = projectId_example # String |  (default to null)

try:
    # Deletes a Project Permission by user id and project id.
    api_instance.delete_project_permission(userId, projectId)
except ApiException as e:
    print("Exception when calling ProjectPermissionOperationsApi->deleteProjectPermission: %s\n" % e)
extern crate ProjectPermissionOperationsApi;

pub fn main() {
    let userId = userId_example; // String
    let projectId = projectId_example; // String

    let mut context = ProjectPermissionOperationsApi::Context::default();
    let result = client.deleteProjectPermission(userId, projectId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
user_id*
String
Required
project_id*
String
Required

Responses


getProjectPermissions

Retrieves project Permissions by user id and project id.


/api/v2/project-permissions

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/api/v2/project-permissions?user_id=userId_example&project_id=projectId_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ProjectPermissionOperationsApi;

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

public class ProjectPermissionOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ProjectPermissionOperationsApi apiInstance = new ProjectPermissionOperationsApi();
        String userId = userId_example; // String | 
        String projectId = projectId_example; // String | 

        try {
            ProjectPermissionsResponse result = apiInstance.getProjectPermissions(userId, projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectPermissionOperationsApi#getProjectPermissions");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String userId = new String(); // String | 
final String projectId = new String(); // String | 

try {
    final result = await api_instance.getProjectPermissions(userId, projectId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getProjectPermissions: $e\n');
}

import org.openapitools.client.api.ProjectPermissionOperationsApi;

public class ProjectPermissionOperationsApiExample {
    public static void main(String[] args) {
        ProjectPermissionOperationsApi apiInstance = new ProjectPermissionOperationsApi();
        String userId = userId_example; // String | 
        String projectId = projectId_example; // String | 

        try {
            ProjectPermissionsResponse result = apiInstance.getProjectPermissions(userId, projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectPermissionOperationsApi#getProjectPermissions");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ProjectPermissionOperationsApi *apiInstance = [[ProjectPermissionOperationsApi alloc] init];
String *userId = userId_example; //  (optional) (default to null)
String *projectId = projectId_example; //  (optional) (default to null)

// Retrieves project Permissions by user id and project id.
[apiInstance getProjectPermissionsWith:userId
    projectId:projectId
              completionHandler: ^(ProjectPermissionsResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.ProjectPermissionOperationsApi()
var opts = {
  'userId': userId_example, // {String} 
  '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.getProjectPermissions(opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new ProjectPermissionOperationsApi();
            var userId = userId_example;  // String |  (optional)  (default to null)
            var projectId = projectId_example;  // String |  (optional)  (default to null)

            try {
                // Retrieves project Permissions by user id and project id.
                ProjectPermissionsResponse result = apiInstance.getProjectPermissions(userId, projectId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ProjectPermissionOperationsApi.getProjectPermissions: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ProjectPermissionOperationsApi();
$userId = userId_example; // String | 
$projectId = projectId_example; // String | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ProjectPermissionOperationsApi->new();
my $userId = userId_example; # String | 
my $projectId = projectId_example; # String | 

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

# Create an instance of the API class
api_instance = openapi_client.ProjectPermissionOperationsApi()
userId = userId_example # String |  (optional) (default to null)
projectId = projectId_example # String |  (optional) (default to null)

try:
    # Retrieves project Permissions by user id and project id.
    api_response = api_instance.get_project_permissions(userId=userId, projectId=projectId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectPermissionOperationsApi->getProjectPermissions: %s\n" % e)
extern crate ProjectPermissionOperationsApi;

pub fn main() {
    let userId = userId_example; // String
    let projectId = projectId_example; // String

    let mut context = ProjectPermissionOperationsApi::Context::default();
    let result = client.getProjectPermissions(userId, projectId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
user_id
String
project_id
String

Responses


updateProjectPermission

Updates a Project Permission.


/api/v2/project-permissions

Usage and SDK Samples

curl -X PUT \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost/api/v2/project-permissions" \
 -d '{
  "access_level" : "access_level",
  "user_id" : "user_id",
  "project_id" : "project_id"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ProjectPermissionOperationsApi;

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

public class ProjectPermissionOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ProjectPermissionOperationsApi apiInstance = new ProjectPermissionOperationsApi();
        ProjectPermissionUpdateRequest projectPermissionUpdateRequest = ; // ProjectPermissionUpdateRequest | 

        try {
            ProjectPermissionDto result = apiInstance.updateProjectPermission(projectPermissionUpdateRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectPermissionOperationsApi#updateProjectPermission");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final ProjectPermissionUpdateRequest projectPermissionUpdateRequest = new ProjectPermissionUpdateRequest(); // ProjectPermissionUpdateRequest | 

try {
    final result = await api_instance.updateProjectPermission(projectPermissionUpdateRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateProjectPermission: $e\n');
}

import org.openapitools.client.api.ProjectPermissionOperationsApi;

public class ProjectPermissionOperationsApiExample {
    public static void main(String[] args) {
        ProjectPermissionOperationsApi apiInstance = new ProjectPermissionOperationsApi();
        ProjectPermissionUpdateRequest projectPermissionUpdateRequest = ; // ProjectPermissionUpdateRequest | 

        try {
            ProjectPermissionDto result = apiInstance.updateProjectPermission(projectPermissionUpdateRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectPermissionOperationsApi#updateProjectPermission");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ProjectPermissionOperationsApi *apiInstance = [[ProjectPermissionOperationsApi alloc] init];
ProjectPermissionUpdateRequest *projectPermissionUpdateRequest = ; // 

// Updates a Project Permission.
[apiInstance updateProjectPermissionWith:projectPermissionUpdateRequest
              completionHandler: ^(ProjectPermissionDto output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.ProjectPermissionOperationsApi()
var projectPermissionUpdateRequest = ; // {ProjectPermissionUpdateRequest} 

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

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

            // Create an instance of the API class
            var apiInstance = new ProjectPermissionOperationsApi();
            var projectPermissionUpdateRequest = new ProjectPermissionUpdateRequest(); // ProjectPermissionUpdateRequest | 

            try {
                // Updates a Project Permission.
                ProjectPermissionDto result = apiInstance.updateProjectPermission(projectPermissionUpdateRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ProjectPermissionOperationsApi.updateProjectPermission: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ProjectPermissionOperationsApi();
$projectPermissionUpdateRequest = ; // ProjectPermissionUpdateRequest | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ProjectPermissionOperationsApi->new();
my $projectPermissionUpdateRequest = WWW::OPenAPIClient::Object::ProjectPermissionUpdateRequest->new(); # ProjectPermissionUpdateRequest | 

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

# Create an instance of the API class
api_instance = openapi_client.ProjectPermissionOperationsApi()
projectPermissionUpdateRequest =  # ProjectPermissionUpdateRequest | 

try:
    # Updates a Project Permission.
    api_response = api_instance.update_project_permission(projectPermissionUpdateRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectPermissionOperationsApi->updateProjectPermission: %s\n" % e)
extern crate ProjectPermissionOperationsApi;

pub fn main() {
    let projectPermissionUpdateRequest = ; // ProjectPermissionUpdateRequest

    let mut context = ProjectPermissionOperationsApi::Context::default();
    let result = client.updateProjectPermission(projectPermissionUpdateRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
projectPermissionUpdateRequest *

Responses


RegisterOperations

registerUser

Registers a new user.


/internal/register

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost/internal/register" \
 -d '{
  "password" : "password",
  "last_name" : "last_name",
  "first_name" : "first_name",
  "username" : "username"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.RegisterOperationsApi;

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

public class RegisterOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        RegisterOperationsApi apiInstance = new RegisterOperationsApi();
        RegisterRequest registerRequest = ; // RegisterRequest | 

        try {
            UserDto result = apiInstance.registerUser(registerRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RegisterOperationsApi#registerUser");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final RegisterRequest registerRequest = new RegisterRequest(); // RegisterRequest | 

try {
    final result = await api_instance.registerUser(registerRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->registerUser: $e\n');
}

import org.openapitools.client.api.RegisterOperationsApi;

public class RegisterOperationsApiExample {
    public static void main(String[] args) {
        RegisterOperationsApi apiInstance = new RegisterOperationsApi();
        RegisterRequest registerRequest = ; // RegisterRequest | 

        try {
            UserDto result = apiInstance.registerUser(registerRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RegisterOperationsApi#registerUser");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
RegisterOperationsApi *apiInstance = [[RegisterOperationsApi alloc] init];
RegisterRequest *registerRequest = ; // 

// Registers a new user.
[apiInstance registerUserWith:registerRequest
              completionHandler: ^(UserDto output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.RegisterOperationsApi()
var registerRequest = ; // {RegisterRequest} 

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

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

            // Create an instance of the API class
            var apiInstance = new RegisterOperationsApi();
            var registerRequest = new RegisterRequest(); // RegisterRequest | 

            try {
                // Registers a new user.
                UserDto result = apiInstance.registerUser(registerRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling RegisterOperationsApi.registerUser: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\RegisterOperationsApi();
$registerRequest = ; // RegisterRequest | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::RegisterOperationsApi->new();
my $registerRequest = WWW::OPenAPIClient::Object::RegisterRequest->new(); # RegisterRequest | 

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

# Create an instance of the API class
api_instance = openapi_client.RegisterOperationsApi()
registerRequest =  # RegisterRequest | 

try:
    # Registers a new user.
    api_response = api_instance.register_user(registerRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RegisterOperationsApi->registerUser: %s\n" % e)
extern crate RegisterOperationsApi;

pub fn main() {
    let registerRequest = ; // RegisterRequest

    let mut context = RegisterOperationsApi::Context::default();
    let result = client.registerUser(registerRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
registerRequest *

Responses


SQLHistoryOperations

deleteAllByProjectIdAndUserIdV2

Deletes all history items of the given user in the specified project. Only available for admins/owners.


/api/v2/projects/{projectId}/history/user/{userId}

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: application/json" \
 "http://localhost/api/v2/projects/{projectId}/history/user/{userId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SQLHistoryOperationsApi;

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

public class SQLHistoryOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        SQLHistoryOperationsApi apiInstance = new SQLHistoryOperationsApi();
        String projectId = projectId_example; // String | 
        String userId = userId_example; // String | 

        try {
            apiInstance.deleteAllByProjectIdAndUserIdV2(projectId, userId);
        } catch (ApiException e) {
            System.err.println("Exception when calling SQLHistoryOperationsApi#deleteAllByProjectIdAndUserIdV2");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String projectId = new String(); // String | 
final String userId = new String(); // String | 

try {
    final result = await api_instance.deleteAllByProjectIdAndUserIdV2(projectId, userId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteAllByProjectIdAndUserIdV2: $e\n');
}

import org.openapitools.client.api.SQLHistoryOperationsApi;

public class SQLHistoryOperationsApiExample {
    public static void main(String[] args) {
        SQLHistoryOperationsApi apiInstance = new SQLHistoryOperationsApi();
        String projectId = projectId_example; // String | 
        String userId = userId_example; // String | 

        try {
            apiInstance.deleteAllByProjectIdAndUserIdV2(projectId, userId);
        } catch (ApiException e) {
            System.err.println("Exception when calling SQLHistoryOperationsApi#deleteAllByProjectIdAndUserIdV2");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
SQLHistoryOperationsApi *apiInstance = [[SQLHistoryOperationsApi alloc] init];
String *projectId = projectId_example; //  (default to null)
String *userId = userId_example; //  (default to null)

// Deletes all history items of the given user in the specified project. Only available for admins/owners.
[apiInstance deleteAllByProjectIdAndUserIdV2With:projectId
    userId:userId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.SQLHistoryOperationsApi()
var projectId = projectId_example; // {String} 
var userId = userId_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteAllByProjectIdAndUserIdV2(projectId, userId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new SQLHistoryOperationsApi();
            var projectId = projectId_example;  // String |  (default to null)
            var userId = userId_example;  // String |  (default to null)

            try {
                // Deletes all history items of the given user in the specified project. Only available for admins/owners.
                apiInstance.deleteAllByProjectIdAndUserIdV2(projectId, userId);
            } catch (Exception e) {
                Debug.Print("Exception when calling SQLHistoryOperationsApi.deleteAllByProjectIdAndUserIdV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SQLHistoryOperationsApi();
$projectId = projectId_example; // String | 
$userId = userId_example; // String | 

try {
    $api_instance->deleteAllByProjectIdAndUserIdV2($projectId, $userId);
} catch (Exception $e) {
    echo 'Exception when calling SQLHistoryOperationsApi->deleteAllByProjectIdAndUserIdV2: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SQLHistoryOperationsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SQLHistoryOperationsApi->new();
my $projectId = projectId_example; # String | 
my $userId = userId_example; # String | 

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

# Create an instance of the API class
api_instance = openapi_client.SQLHistoryOperationsApi()
projectId = projectId_example # String |  (default to null)
userId = userId_example # String |  (default to null)

try:
    # Deletes all history items of the given user in the specified project. Only available for admins/owners.
    api_instance.delete_all_by_project_id_and_user_id_v2(projectId, userId)
except ApiException as e:
    print("Exception when calling SQLHistoryOperationsApi->deleteAllByProjectIdAndUserIdV2: %s\n" % e)
extern crate SQLHistoryOperationsApi;

pub fn main() {
    let projectId = projectId_example; // String
    let userId = userId_example; // String

    let mut context = SQLHistoryOperationsApi::Context::default();
    let result = client.deleteAllByProjectIdAndUserIdV2(projectId, userId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
projectId*
String
Required
userId*
String
Required

Responses


deleteAllByProjectIdV2

Deletes all history items of the current user in the specified project.


/api/v2/projects/{projectId}/history

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: application/json" \
 "http://localhost/api/v2/projects/{projectId}/history"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SQLHistoryOperationsApi;

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

public class SQLHistoryOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        SQLHistoryOperationsApi apiInstance = new SQLHistoryOperationsApi();
        String projectId = projectId_example; // String | 

        try {
            apiInstance.deleteAllByProjectIdV2(projectId);
        } catch (ApiException e) {
            System.err.println("Exception when calling SQLHistoryOperationsApi#deleteAllByProjectIdV2");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String projectId = new String(); // String | 

try {
    final result = await api_instance.deleteAllByProjectIdV2(projectId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteAllByProjectIdV2: $e\n');
}

import org.openapitools.client.api.SQLHistoryOperationsApi;

public class SQLHistoryOperationsApiExample {
    public static void main(String[] args) {
        SQLHistoryOperationsApi apiInstance = new SQLHistoryOperationsApi();
        String projectId = projectId_example; // String | 

        try {
            apiInstance.deleteAllByProjectIdV2(projectId);
        } catch (ApiException e) {
            System.err.println("Exception when calling SQLHistoryOperationsApi#deleteAllByProjectIdV2");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
SQLHistoryOperationsApi *apiInstance = [[SQLHistoryOperationsApi alloc] init];
String *projectId = projectId_example; //  (default to null)

// Deletes all history items of the current user in the specified project.
[apiInstance deleteAllByProjectIdV2With:projectId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.SQLHistoryOperationsApi()
var projectId = projectId_example; // {String} 

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

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

            // Create an instance of the API class
            var apiInstance = new SQLHistoryOperationsApi();
            var projectId = projectId_example;  // String |  (default to null)

            try {
                // Deletes all history items of the current user in the specified project.
                apiInstance.deleteAllByProjectIdV2(projectId);
            } catch (Exception e) {
                Debug.Print("Exception when calling SQLHistoryOperationsApi.deleteAllByProjectIdV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SQLHistoryOperationsApi();
$projectId = projectId_example; // String | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SQLHistoryOperationsApi->new();
my $projectId = projectId_example; # String | 

eval {
    $api_instance->deleteAllByProjectIdV2(projectId => $projectId);
};
if ($@) {
    warn "Exception when calling SQLHistoryOperationsApi->deleteAllByProjectIdV2: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.SQLHistoryOperationsApi()
projectId = projectId_example # String |  (default to null)

try:
    # Deletes all history items of the current user in the specified project.
    api_instance.delete_all_by_project_id_v2(projectId)
except ApiException as e:
    print("Exception when calling SQLHistoryOperationsApi->deleteAllByProjectIdV2: %s\n" % e)
extern crate SQLHistoryOperationsApi;

pub fn main() {
    let projectId = projectId_example; // String

    let mut context = SQLHistoryOperationsApi::Context::default();
    let result = client.deleteAllByProjectIdV2(projectId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
projectId*
String
Required

Responses


deleteByIdAndProjectV2

Deletes a given history item from the specified project.


/api/v2/projects/{projectId}/history/{id}

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: application/json" \
 "http://localhost/api/v2/projects/{projectId}/history/{id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SQLHistoryOperationsApi;

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

public class SQLHistoryOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        SQLHistoryOperationsApi apiInstance = new SQLHistoryOperationsApi();
        String projectId = projectId_example; // String | 
        Integer id = 56; // Integer | 

        try {
            apiInstance.deleteByIdAndProjectV2(projectId, id);
        } catch (ApiException e) {
            System.err.println("Exception when calling SQLHistoryOperationsApi#deleteByIdAndProjectV2");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String projectId = new String(); // String | 
final Integer id = new Integer(); // Integer | 

try {
    final result = await api_instance.deleteByIdAndProjectV2(projectId, id);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteByIdAndProjectV2: $e\n');
}

import org.openapitools.client.api.SQLHistoryOperationsApi;

public class SQLHistoryOperationsApiExample {
    public static void main(String[] args) {
        SQLHistoryOperationsApi apiInstance = new SQLHistoryOperationsApi();
        String projectId = projectId_example; // String | 
        Integer id = 56; // Integer | 

        try {
            apiInstance.deleteByIdAndProjectV2(projectId, id);
        } catch (ApiException e) {
            System.err.println("Exception when calling SQLHistoryOperationsApi#deleteByIdAndProjectV2");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
SQLHistoryOperationsApi *apiInstance = [[SQLHistoryOperationsApi alloc] init];
String *projectId = projectId_example; //  (default to null)
Integer *id = 56; //  (default to null)

// Deletes a given history item from the specified project.
[apiInstance deleteByIdAndProjectV2With:projectId
    id:id
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.SQLHistoryOperationsApi()
var projectId = projectId_example; // {String} 
var id = 56; // {Integer} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteByIdAndProjectV2(projectId, id, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new SQLHistoryOperationsApi();
            var projectId = projectId_example;  // String |  (default to null)
            var id = 56;  // Integer |  (default to null)

            try {
                // Deletes a given history item from the specified project.
                apiInstance.deleteByIdAndProjectV2(projectId, id);
            } catch (Exception e) {
                Debug.Print("Exception when calling SQLHistoryOperationsApi.deleteByIdAndProjectV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SQLHistoryOperationsApi();
$projectId = projectId_example; // String | 
$id = 56; // Integer | 

try {
    $api_instance->deleteByIdAndProjectV2($projectId, $id);
} catch (Exception $e) {
    echo 'Exception when calling SQLHistoryOperationsApi->deleteByIdAndProjectV2: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SQLHistoryOperationsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SQLHistoryOperationsApi->new();
my $projectId = projectId_example; # String | 
my $id = 56; # Integer | 

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

# Create an instance of the API class
api_instance = openapi_client.SQLHistoryOperationsApi()
projectId = projectId_example # String |  (default to null)
id = 56 # Integer |  (default to null)

try:
    # Deletes a given history item from the specified project.
    api_instance.delete_by_id_and_project_v2(projectId, id)
except ApiException as e:
    print("Exception when calling SQLHistoryOperationsApi->deleteByIdAndProjectV2: %s\n" % e)
extern crate SQLHistoryOperationsApi;

pub fn main() {
    let projectId = projectId_example; // String
    let id = 56; // Integer

    let mut context = SQLHistoryOperationsApi::Context::default();
    let result = client.deleteByIdAndProjectV2(projectId, id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
projectId*
String
Required
id*
Integer (int32)
Required

Responses


getAllByCurrentUserV2

Retrieves all history items of the current user from the specified project.


/api/v2/projects/{projectId}/history/user

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/api/v2/projects/{projectId}/history/user"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SQLHistoryOperationsApi;

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

public class SQLHistoryOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        SQLHistoryOperationsApi apiInstance = new SQLHistoryOperationsApi();
        String projectId = projectId_example; // String | 

        try {
            array[HistoryItemDto] result = apiInstance.getAllByCurrentUserV2(projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SQLHistoryOperationsApi#getAllByCurrentUserV2");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String projectId = new String(); // String | 

try {
    final result = await api_instance.getAllByCurrentUserV2(projectId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getAllByCurrentUserV2: $e\n');
}

import org.openapitools.client.api.SQLHistoryOperationsApi;

public class SQLHistoryOperationsApiExample {
    public static void main(String[] args) {
        SQLHistoryOperationsApi apiInstance = new SQLHistoryOperationsApi();
        String projectId = projectId_example; // String | 

        try {
            array[HistoryItemDto] result = apiInstance.getAllByCurrentUserV2(projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SQLHistoryOperationsApi#getAllByCurrentUserV2");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
SQLHistoryOperationsApi *apiInstance = [[SQLHistoryOperationsApi alloc] init];
String *projectId = projectId_example; //  (default to null)

// Retrieves all history items of the current user from the specified project.
[apiInstance getAllByCurrentUserV2With:projectId
              completionHandler: ^(array[HistoryItemDto] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.SQLHistoryOperationsApi()
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.getAllByCurrentUserV2(projectId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new SQLHistoryOperationsApi();
            var projectId = projectId_example;  // String |  (default to null)

            try {
                // Retrieves all history items of the current user from the specified project.
                array[HistoryItemDto] result = apiInstance.getAllByCurrentUserV2(projectId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SQLHistoryOperationsApi.getAllByCurrentUserV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SQLHistoryOperationsApi();
$projectId = projectId_example; // String | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SQLHistoryOperationsApi->new();
my $projectId = projectId_example; # String | 

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

# Create an instance of the API class
api_instance = openapi_client.SQLHistoryOperationsApi()
projectId = projectId_example # String |  (default to null)

try:
    # Retrieves all history items of the current user from the specified project.
    api_response = api_instance.get_all_by_current_user_v2(projectId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SQLHistoryOperationsApi->getAllByCurrentUserV2: %s\n" % e)
extern crate SQLHistoryOperationsApi;

pub fn main() {
    let projectId = projectId_example; // String

    let mut context = SQLHistoryOperationsApi::Context::default();
    let result = client.getAllByCurrentUserV2(projectId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
projectId*
String
Required

Responses


getAllByOtherUserV2

Retrieves all history items of the given user from the specified project. Only available for admins/owners.


/api/v2/projects/{projectId}/history/user/{userId}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/api/v2/projects/{projectId}/history/user/{userId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SQLHistoryOperationsApi;

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

public class SQLHistoryOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        SQLHistoryOperationsApi apiInstance = new SQLHistoryOperationsApi();
        String projectId = projectId_example; // String | 
        String userId = userId_example; // String | 

        try {
            array[HistoryItemDto] result = apiInstance.getAllByOtherUserV2(projectId, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SQLHistoryOperationsApi#getAllByOtherUserV2");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String projectId = new String(); // String | 
final String userId = new String(); // String | 

try {
    final result = await api_instance.getAllByOtherUserV2(projectId, userId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getAllByOtherUserV2: $e\n');
}

import org.openapitools.client.api.SQLHistoryOperationsApi;

public class SQLHistoryOperationsApiExample {
    public static void main(String[] args) {
        SQLHistoryOperationsApi apiInstance = new SQLHistoryOperationsApi();
        String projectId = projectId_example; // String | 
        String userId = userId_example; // String | 

        try {
            array[HistoryItemDto] result = apiInstance.getAllByOtherUserV2(projectId, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SQLHistoryOperationsApi#getAllByOtherUserV2");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
SQLHistoryOperationsApi *apiInstance = [[SQLHistoryOperationsApi alloc] init];
String *projectId = projectId_example; //  (default to null)
String *userId = userId_example; //  (default to null)

// Retrieves all history items of the given user from the specified project. Only available for admins/owners.
[apiInstance getAllByOtherUserV2With:projectId
    userId:userId
              completionHandler: ^(array[HistoryItemDto] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.SQLHistoryOperationsApi()
var projectId = projectId_example; // {String} 
var userId = userId_example; // {String} 

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

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

            // Create an instance of the API class
            var apiInstance = new SQLHistoryOperationsApi();
            var projectId = projectId_example;  // String |  (default to null)
            var userId = userId_example;  // String |  (default to null)

            try {
                // Retrieves all history items of the given user from the specified project. Only available for admins/owners.
                array[HistoryItemDto] result = apiInstance.getAllByOtherUserV2(projectId, userId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SQLHistoryOperationsApi.getAllByOtherUserV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SQLHistoryOperationsApi();
$projectId = projectId_example; // String | 
$userId = userId_example; // String | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SQLHistoryOperationsApi->new();
my $projectId = projectId_example; # String | 
my $userId = userId_example; # String | 

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

# Create an instance of the API class
api_instance = openapi_client.SQLHistoryOperationsApi()
projectId = projectId_example # String |  (default to null)
userId = userId_example # String |  (default to null)

try:
    # Retrieves all history items of the given user from the specified project. Only available for admins/owners.
    api_response = api_instance.get_all_by_other_user_v2(projectId, userId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SQLHistoryOperationsApi->getAllByOtherUserV2: %s\n" % e)
extern crate SQLHistoryOperationsApi;

pub fn main() {
    let projectId = projectId_example; // String
    let userId = userId_example; // String

    let mut context = SQLHistoryOperationsApi::Context::default();
    let result = client.getAllByOtherUserV2(projectId, userId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
projectId*
String
Required
userId*
String
Required

Responses


getAllByProjectV2

Retrieves all history items in the specified project.


/api/v2/projects/{projectId}/history

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/api/v2/projects/{projectId}/history"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SQLHistoryOperationsApi;

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

public class SQLHistoryOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        SQLHistoryOperationsApi apiInstance = new SQLHistoryOperationsApi();
        String projectId = projectId_example; // String | 

        try {
            array[HistoryItemDto] result = apiInstance.getAllByProjectV2(projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SQLHistoryOperationsApi#getAllByProjectV2");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String projectId = new String(); // String | 

try {
    final result = await api_instance.getAllByProjectV2(projectId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getAllByProjectV2: $e\n');
}

import org.openapitools.client.api.SQLHistoryOperationsApi;

public class SQLHistoryOperationsApiExample {
    public static void main(String[] args) {
        SQLHistoryOperationsApi apiInstance = new SQLHistoryOperationsApi();
        String projectId = projectId_example; // String | 

        try {
            array[HistoryItemDto] result = apiInstance.getAllByProjectV2(projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SQLHistoryOperationsApi#getAllByProjectV2");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
SQLHistoryOperationsApi *apiInstance = [[SQLHistoryOperationsApi alloc] init];
String *projectId = projectId_example; //  (default to null)

// Retrieves all history items in the specified project.
[apiInstance getAllByProjectV2With:projectId
              completionHandler: ^(array[HistoryItemDto] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.SQLHistoryOperationsApi()
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.getAllByProjectV2(projectId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new SQLHistoryOperationsApi();
            var projectId = projectId_example;  // String |  (default to null)

            try {
                // Retrieves all history items in the specified project.
                array[HistoryItemDto] result = apiInstance.getAllByProjectV2(projectId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SQLHistoryOperationsApi.getAllByProjectV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SQLHistoryOperationsApi();
$projectId = projectId_example; // String | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SQLHistoryOperationsApi->new();
my $projectId = projectId_example; # String | 

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

# Create an instance of the API class
api_instance = openapi_client.SQLHistoryOperationsApi()
projectId = projectId_example # String |  (default to null)

try:
    # Retrieves all history items in the specified project.
    api_response = api_instance.get_all_by_project_v2(projectId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SQLHistoryOperationsApi->getAllByProjectV2: %s\n" % e)
extern crate SQLHistoryOperationsApi;

pub fn main() {
    let projectId = projectId_example; // String

    let mut context = SQLHistoryOperationsApi::Context::default();
    let result = client.getAllByProjectV2(projectId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
projectId*
String
Required

Responses


SQLOperations

analyzeSqlV2

Execute SQL analyze query.


/api/v2/projects/{projectId}/sql/analyze

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost/api/v2/projects/{projectId}/sql/analyze" \
 -d '{
  "sql" : "sql"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SQLOperationsApi;

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

public class SQLOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        SQLOperationsApi apiInstance = new SQLOperationsApi();
        String projectId = projectId_example; // String | 
        SqlAnalyzeRequest sqlAnalyzeRequest = ; // SqlAnalyzeRequest | 

        try {
            SqlAnalyzeResponse result = apiInstance.analyzeSqlV2(projectId, sqlAnalyzeRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SQLOperationsApi#analyzeSqlV2");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String projectId = new String(); // String | 
final SqlAnalyzeRequest sqlAnalyzeRequest = new SqlAnalyzeRequest(); // SqlAnalyzeRequest | 

try {
    final result = await api_instance.analyzeSqlV2(projectId, sqlAnalyzeRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->analyzeSqlV2: $e\n');
}

import org.openapitools.client.api.SQLOperationsApi;

public class SQLOperationsApiExample {
    public static void main(String[] args) {
        SQLOperationsApi apiInstance = new SQLOperationsApi();
        String projectId = projectId_example; // String | 
        SqlAnalyzeRequest sqlAnalyzeRequest = ; // SqlAnalyzeRequest | 

        try {
            SqlAnalyzeResponse result = apiInstance.analyzeSqlV2(projectId, sqlAnalyzeRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SQLOperationsApi#analyzeSqlV2");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
SQLOperationsApi *apiInstance = [[SQLOperationsApi alloc] init];
String *projectId = projectId_example; //  (default to null)
SqlAnalyzeRequest *sqlAnalyzeRequest = ; // 

// Execute SQL analyze query.
[apiInstance analyzeSqlV2With:projectId
    sqlAnalyzeRequest:sqlAnalyzeRequest
              completionHandler: ^(SqlAnalyzeResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.SQLOperationsApi()
var projectId = projectId_example; // {String} 
var sqlAnalyzeRequest = ; // {SqlAnalyzeRequest} 

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

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

            // Create an instance of the API class
            var apiInstance = new SQLOperationsApi();
            var projectId = projectId_example;  // String |  (default to null)
            var sqlAnalyzeRequest = new SqlAnalyzeRequest(); // SqlAnalyzeRequest | 

            try {
                // Execute SQL analyze query.
                SqlAnalyzeResponse result = apiInstance.analyzeSqlV2(projectId, sqlAnalyzeRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SQLOperationsApi.analyzeSqlV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SQLOperationsApi();
$projectId = projectId_example; // String | 
$sqlAnalyzeRequest = ; // SqlAnalyzeRequest | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SQLOperationsApi->new();
my $projectId = projectId_example; # String | 
my $sqlAnalyzeRequest = WWW::OPenAPIClient::Object::SqlAnalyzeRequest->new(); # SqlAnalyzeRequest | 

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

# Create an instance of the API class
api_instance = openapi_client.SQLOperationsApi()
projectId = projectId_example # String |  (default to null)
sqlAnalyzeRequest =  # SqlAnalyzeRequest | 

try:
    # Execute SQL analyze query.
    api_response = api_instance.analyze_sql_v2(projectId, sqlAnalyzeRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SQLOperationsApi->analyzeSqlV2: %s\n" % e)
extern crate SQLOperationsApi;

pub fn main() {
    let projectId = projectId_example; // String
    let sqlAnalyzeRequest = ; // SqlAnalyzeRequest

    let mut context = SQLOperationsApi::Context::default();
    let result = client.analyzeSqlV2(projectId, sqlAnalyzeRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
projectId*
String
Required
Body parameters
Name Description
sqlAnalyzeRequest *

Responses


executeSqlV2

Execute SQL query.


/api/v2/projects/{projectId}/sql/execute

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost/api/v2/projects/{projectId}/sql/execute" \
 -d '{
  "job_config" : "",
  "add_to_history" : true,
  "mv_endpoints" : [ {
    "endpoint" : "endpoint",
    "code" : "code",
    "dynamic_parameters" : [ "dynamic_parameters", "dynamic_parameters" ],
    "description" : "description",
    "bind_values" : [ "bind_values", "bind_values" ],
    "builder_data" : ""
  }, {
    "endpoint" : "endpoint",
    "code" : "code",
    "dynamic_parameters" : [ "dynamic_parameters", "dynamic_parameters" ],
    "description" : "description",
    "bind_values" : [ "bind_values", "bind_values" ],
    "builder_data" : ""
  } ],
  "selection" : false,
  "sql" : "sql"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SQLOperationsApi;

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

public class SQLOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        SQLOperationsApi apiInstance = new SQLOperationsApi();
        String projectId = projectId_example; // String | 
        SqlExecuteRequest sqlExecuteRequest = ; // SqlExecuteRequest | 

        try {
            SqlExecuteResponse result = apiInstance.executeSqlV2(projectId, sqlExecuteRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SQLOperationsApi#executeSqlV2");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String projectId = new String(); // String | 
final SqlExecuteRequest sqlExecuteRequest = new SqlExecuteRequest(); // SqlExecuteRequest | 

try {
    final result = await api_instance.executeSqlV2(projectId, sqlExecuteRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->executeSqlV2: $e\n');
}

import org.openapitools.client.api.SQLOperationsApi;

public class SQLOperationsApiExample {
    public static void main(String[] args) {
        SQLOperationsApi apiInstance = new SQLOperationsApi();
        String projectId = projectId_example; // String | 
        SqlExecuteRequest sqlExecuteRequest = ; // SqlExecuteRequest | 

        try {
            SqlExecuteResponse result = apiInstance.executeSqlV2(projectId, sqlExecuteRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SQLOperationsApi#executeSqlV2");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
SQLOperationsApi *apiInstance = [[SQLOperationsApi alloc] init];
String *projectId = projectId_example; //  (default to null)
SqlExecuteRequest *sqlExecuteRequest = ; // 

// Execute SQL query.
[apiInstance executeSqlV2With:projectId
    sqlExecuteRequest:sqlExecuteRequest
              completionHandler: ^(SqlExecuteResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.SQLOperationsApi()
var projectId = projectId_example; // {String} 
var sqlExecuteRequest = ; // {SqlExecuteRequest} 

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

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

            // Create an instance of the API class
            var apiInstance = new SQLOperationsApi();
            var projectId = projectId_example;  // String |  (default to null)
            var sqlExecuteRequest = new SqlExecuteRequest(); // SqlExecuteRequest | 

            try {
                // Execute SQL query.
                SqlExecuteResponse result = apiInstance.executeSqlV2(projectId, sqlExecuteRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SQLOperationsApi.executeSqlV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SQLOperationsApi();
$projectId = projectId_example; // String | 
$sqlExecuteRequest = ; // SqlExecuteRequest | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SQLOperationsApi->new();
my $projectId = projectId_example; # String | 
my $sqlExecuteRequest = WWW::OPenAPIClient::Object::SqlExecuteRequest->new(); # SqlExecuteRequest | 

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

# Create an instance of the API class
api_instance = openapi_client.SQLOperationsApi()
projectId = projectId_example # String |  (default to null)
sqlExecuteRequest =  # SqlExecuteRequest | 

try:
    # Execute SQL query.
    api_response = api_instance.execute_sql_v2(projectId, sqlExecuteRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SQLOperationsApi->executeSqlV2: %s\n" % e)
extern crate SQLOperationsApi;

pub fn main() {
    let projectId = projectId_example; // String
    let sqlExecuteRequest = ; // SqlExecuteRequest

    let mut context = SQLOperationsApi::Context::default();
    let result = client.executeSqlV2(projectId, sqlExecuteRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
projectId*
String
Required
Body parameters
Name Description
sqlExecuteRequest *

Responses


SSBSessionOperations

ensureSession

Ensures the session exists and returns session properties.


/internal/session

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 "http://localhost/internal/session"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SSBSessionOperationsApi;

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

public class SSBSessionOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        SSBSessionOperationsApi apiInstance = new SSBSessionOperationsApi();

        try {
            SessionDto result = apiInstance.ensureSession();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SSBSessionOperationsApi#ensureSession");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();


try {
    final result = await api_instance.ensureSession();
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->ensureSession: $e\n');
}

import org.openapitools.client.api.SSBSessionOperationsApi;

public class SSBSessionOperationsApiExample {
    public static void main(String[] args) {
        SSBSessionOperationsApi apiInstance = new SSBSessionOperationsApi();

        try {
            SessionDto result = apiInstance.ensureSession();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SSBSessionOperationsApi#ensureSession");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
SSBSessionOperationsApi *apiInstance = [[SSBSessionOperationsApi alloc] init];

// Ensures the session exists and returns session properties.
[apiInstance ensureSessionWithCompletionHandler: 
              ^(SessionDto output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.SSBSessionOperationsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.ensureSession(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new SSBSessionOperationsApi();

            try {
                // Ensures the session exists and returns session properties.
                SessionDto result = apiInstance.ensureSession();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SSBSessionOperationsApi.ensureSession: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SSBSessionOperationsApi();

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SSBSessionOperationsApi->new();

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

# Create an instance of the API class
api_instance = openapi_client.SSBSessionOperationsApi()

try:
    # Ensures the session exists and returns session properties.
    api_response = api_instance.ensure_session()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SSBSessionOperationsApi->ensureSession: %s\n" % e)
extern crate SSBSessionOperationsApi;

pub fn main() {

    let mut context = SSBSessionOperationsApi::Context::default();
    let result = client.ensureSession(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


resetSession

Resets the session and returns the newly created session properties.


/internal/session/reset

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 "http://localhost/internal/session/reset"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SSBSessionOperationsApi;

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

public class SSBSessionOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        SSBSessionOperationsApi apiInstance = new SSBSessionOperationsApi();

        try {
            SessionDto result = apiInstance.resetSession();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SSBSessionOperationsApi#resetSession");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();


try {
    final result = await api_instance.resetSession();
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->resetSession: $e\n');
}

import org.openapitools.client.api.SSBSessionOperationsApi;

public class SSBSessionOperationsApiExample {
    public static void main(String[] args) {
        SSBSessionOperationsApi apiInstance = new SSBSessionOperationsApi();

        try {
            SessionDto result = apiInstance.resetSession();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SSBSessionOperationsApi#resetSession");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
SSBSessionOperationsApi *apiInstance = [[SSBSessionOperationsApi alloc] init];

// Resets the session and returns the newly created session properties.
[apiInstance resetSessionWithCompletionHandler: 
              ^(SessionDto output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.SSBSessionOperationsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.resetSession(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new SSBSessionOperationsApi();

            try {
                // Resets the session and returns the newly created session properties.
                SessionDto result = apiInstance.resetSession();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SSBSessionOperationsApi.resetSession: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SSBSessionOperationsApi();

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SSBSessionOperationsApi->new();

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

# Create an instance of the API class
api_instance = openapi_client.SSBSessionOperationsApi()

try:
    # Resets the session and returns the newly created session properties.
    api_response = api_instance.reset_session()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SSBSessionOperationsApi->resetSession: %s\n" % e)
extern crate SSBSessionOperationsApi;

pub fn main() {

    let mut context = SSBSessionOperationsApi::Context::default();
    let result = client.resetSession(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


SamplingOperations

configure

Configures sampling.


/api/v2/samples/{sampleId}/configure

Usage and SDK Samples

curl -X POST \
 -H "Accept: */*" \
 -H "Content-Type: application/json" \
 "http://localhost/api/v2/samples/{sampleId}/configure" \
 -d '{
  "position" : "position"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SamplingOperationsApi;

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

public class SamplingOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        SamplingOperationsApi apiInstance = new SamplingOperationsApi();
        String sampleId = sampleId_example; // String | 
        ConfigureSampleRequest configureSampleRequest = ; // ConfigureSampleRequest | 

        try {
            apiInstance.configure(sampleId, configureSampleRequest);
        } catch (ApiException e) {
            System.err.println("Exception when calling SamplingOperationsApi#configure");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String sampleId = new String(); // String | 
final ConfigureSampleRequest configureSampleRequest = new ConfigureSampleRequest(); // ConfigureSampleRequest | 

try {
    final result = await api_instance.configure(sampleId, configureSampleRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->configure: $e\n');
}

import org.openapitools.client.api.SamplingOperationsApi;

public class SamplingOperationsApiExample {
    public static void main(String[] args) {
        SamplingOperationsApi apiInstance = new SamplingOperationsApi();
        String sampleId = sampleId_example; // String | 
        ConfigureSampleRequest configureSampleRequest = ; // ConfigureSampleRequest | 

        try {
            apiInstance.configure(sampleId, configureSampleRequest);
        } catch (ApiException e) {
            System.err.println("Exception when calling SamplingOperationsApi#configure");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
SamplingOperationsApi *apiInstance = [[SamplingOperationsApi alloc] init];
String *sampleId = sampleId_example; //  (default to null)
ConfigureSampleRequest *configureSampleRequest = ; // 

// Configures sampling.
[apiInstance configureWith:sampleId
    configureSampleRequest:configureSampleRequest
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.SamplingOperationsApi()
var sampleId = sampleId_example; // {String} 
var configureSampleRequest = ; // {ConfigureSampleRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.configure(sampleId, configureSampleRequest, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new SamplingOperationsApi();
            var sampleId = sampleId_example;  // String |  (default to null)
            var configureSampleRequest = new ConfigureSampleRequest(); // ConfigureSampleRequest | 

            try {
                // Configures sampling.
                apiInstance.configure(sampleId, configureSampleRequest);
            } catch (Exception e) {
                Debug.Print("Exception when calling SamplingOperationsApi.configure: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SamplingOperationsApi();
$sampleId = sampleId_example; // String | 
$configureSampleRequest = ; // ConfigureSampleRequest | 

try {
    $api_instance->configure($sampleId, $configureSampleRequest);
} catch (Exception $e) {
    echo 'Exception when calling SamplingOperationsApi->configure: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SamplingOperationsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SamplingOperationsApi->new();
my $sampleId = sampleId_example; # String | 
my $configureSampleRequest = WWW::OPenAPIClient::Object::ConfigureSampleRequest->new(); # ConfigureSampleRequest | 

eval {
    $api_instance->configure(sampleId => $sampleId, configureSampleRequest => $configureSampleRequest);
};
if ($@) {
    warn "Exception when calling SamplingOperationsApi->configure: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.SamplingOperationsApi()
sampleId = sampleId_example # String |  (default to null)
configureSampleRequest =  # ConfigureSampleRequest | 

try:
    # Configures sampling.
    api_instance.configure(sampleId, configureSampleRequest)
except ApiException as e:
    print("Exception when calling SamplingOperationsApi->configure: %s\n" % e)
extern crate SamplingOperationsApi;

pub fn main() {
    let sampleId = sampleId_example; // String
    let configureSampleRequest = ; // ConfigureSampleRequest

    let mut context = SamplingOperationsApi::Context::default();
    let result = client.configure(sampleId, configureSampleRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
sampleId*
String
Required
Body parameters
Name Description
configureSampleRequest *

Responses


pollResult

Polls sample results.


/api/v2/samples/{sampleId}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/api/v2/samples/{sampleId}?kafkaPollTimeoutMillis=789"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SamplingOperationsApi;

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

public class SamplingOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        SamplingOperationsApi apiInstance = new SamplingOperationsApi();
        String sampleId = sampleId_example; // String | 
        Long kafkaPollTimeoutMillis = 789; // Long | Kafka poll timeout in ms.

        try {
            PollSampleResult result = apiInstance.pollResult(sampleId, kafkaPollTimeoutMillis);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SamplingOperationsApi#pollResult");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String sampleId = new String(); // String | 
final Long kafkaPollTimeoutMillis = new Long(); // Long | Kafka poll timeout in ms.

try {
    final result = await api_instance.pollResult(sampleId, kafkaPollTimeoutMillis);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->pollResult: $e\n');
}

import org.openapitools.client.api.SamplingOperationsApi;

public class SamplingOperationsApiExample {
    public static void main(String[] args) {
        SamplingOperationsApi apiInstance = new SamplingOperationsApi();
        String sampleId = sampleId_example; // String | 
        Long kafkaPollTimeoutMillis = 789; // Long | Kafka poll timeout in ms.

        try {
            PollSampleResult result = apiInstance.pollResult(sampleId, kafkaPollTimeoutMillis);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SamplingOperationsApi#pollResult");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
SamplingOperationsApi *apiInstance = [[SamplingOperationsApi alloc] init];
String *sampleId = sampleId_example; //  (default to null)
Long *kafkaPollTimeoutMillis = 789; // Kafka poll timeout in ms. (optional) (default to 1000)

// Polls sample results.
[apiInstance pollResultWith:sampleId
    kafkaPollTimeoutMillis:kafkaPollTimeoutMillis
              completionHandler: ^(PollSampleResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.SamplingOperationsApi()
var sampleId = sampleId_example; // {String} 
var opts = {
  'kafkaPollTimeoutMillis': 789 // {Long} Kafka poll timeout in ms.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.pollResult(sampleId, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new SamplingOperationsApi();
            var sampleId = sampleId_example;  // String |  (default to null)
            var kafkaPollTimeoutMillis = 789;  // Long | Kafka poll timeout in ms. (optional)  (default to 1000)

            try {
                // Polls sample results.
                PollSampleResult result = apiInstance.pollResult(sampleId, kafkaPollTimeoutMillis);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SamplingOperationsApi.pollResult: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SamplingOperationsApi();
$sampleId = sampleId_example; // String | 
$kafkaPollTimeoutMillis = 789; // Long | Kafka poll timeout in ms.

try {
    $result = $api_instance->pollResult($sampleId, $kafkaPollTimeoutMillis);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SamplingOperationsApi->pollResult: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SamplingOperationsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SamplingOperationsApi->new();
my $sampleId = sampleId_example; # String | 
my $kafkaPollTimeoutMillis = 789; # Long | Kafka poll timeout in ms.

eval {
    my $result = $api_instance->pollResult(sampleId => $sampleId, kafkaPollTimeoutMillis => $kafkaPollTimeoutMillis);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SamplingOperationsApi->pollResult: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.SamplingOperationsApi()
sampleId = sampleId_example # String |  (default to null)
kafkaPollTimeoutMillis = 789 # Long | Kafka poll timeout in ms. (optional) (default to 1000)

try:
    # Polls sample results.
    api_response = api_instance.poll_result(sampleId, kafkaPollTimeoutMillis=kafkaPollTimeoutMillis)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SamplingOperationsApi->pollResult: %s\n" % e)
extern crate SamplingOperationsApi;

pub fn main() {
    let sampleId = sampleId_example; // String
    let kafkaPollTimeoutMillis = 789; // Long

    let mut context = SamplingOperationsApi::Context::default();
    let result = client.pollResult(sampleId, kafkaPollTimeoutMillis, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
sampleId*
String
Required
Query parameters
Name Description
kafkaPollTimeoutMillis
Long (int64)
Kafka poll timeout in ms.

Responses


ServiceDiscoveryController

registerAvailableProviders


/internal/service-discovery

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost/internal/service-discovery" \
 -d '{
  "cloudbreak_access_key" : "cloudbreak_access_key",
  "cloudbreak_base_url" : "cloudbreak_base_url",
  "cm_password" : "cm_password",
  "cloudbreak_access_key_id" : "cloudbreak_access_key_id",
  "cloudbreak_env_name" : "cloudbreak_env_name",
  "cm_user" : "cm_user"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ServiceDiscoveryControllerApi;

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

public class ServiceDiscoveryControllerApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ServiceDiscoveryControllerApi apiInstance = new ServiceDiscoveryControllerApi();
        ServiceDiscoveryRequest serviceDiscoveryRequest = ; // ServiceDiscoveryRequest | 

        try {
            set[DataSourceDto] result = apiInstance.registerAvailableProviders(serviceDiscoveryRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ServiceDiscoveryControllerApi#registerAvailableProviders");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final ServiceDiscoveryRequest serviceDiscoveryRequest = new ServiceDiscoveryRequest(); // ServiceDiscoveryRequest | 

try {
    final result = await api_instance.registerAvailableProviders(serviceDiscoveryRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->registerAvailableProviders: $e\n');
}

import org.openapitools.client.api.ServiceDiscoveryControllerApi;

public class ServiceDiscoveryControllerApiExample {
    public static void main(String[] args) {
        ServiceDiscoveryControllerApi apiInstance = new ServiceDiscoveryControllerApi();
        ServiceDiscoveryRequest serviceDiscoveryRequest = ; // ServiceDiscoveryRequest | 

        try {
            set[DataSourceDto] result = apiInstance.registerAvailableProviders(serviceDiscoveryRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ServiceDiscoveryControllerApi#registerAvailableProviders");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ServiceDiscoveryControllerApi *apiInstance = [[ServiceDiscoveryControllerApi alloc] init];
ServiceDiscoveryRequest *serviceDiscoveryRequest = ; // 

[apiInstance registerAvailableProvidersWith:serviceDiscoveryRequest
              completionHandler: ^(set[DataSourceDto] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.ServiceDiscoveryControllerApi()
var serviceDiscoveryRequest = ; // {ServiceDiscoveryRequest} 

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

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

            // Create an instance of the API class
            var apiInstance = new ServiceDiscoveryControllerApi();
            var serviceDiscoveryRequest = new ServiceDiscoveryRequest(); // ServiceDiscoveryRequest | 

            try {
                set[DataSourceDto] result = apiInstance.registerAvailableProviders(serviceDiscoveryRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ServiceDiscoveryControllerApi.registerAvailableProviders: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ServiceDiscoveryControllerApi();
$serviceDiscoveryRequest = ; // ServiceDiscoveryRequest | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ServiceDiscoveryControllerApi->new();
my $serviceDiscoveryRequest = WWW::OPenAPIClient::Object::ServiceDiscoveryRequest->new(); # ServiceDiscoveryRequest | 

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

# Create an instance of the API class
api_instance = openapi_client.ServiceDiscoveryControllerApi()
serviceDiscoveryRequest =  # ServiceDiscoveryRequest | 

try:
    api_response = api_instance.register_available_providers(serviceDiscoveryRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServiceDiscoveryControllerApi->registerAvailableProviders: %s\n" % e)
extern crate ServiceDiscoveryControllerApi;

pub fn main() {
    let serviceDiscoveryRequest = ; // ServiceDiscoveryRequest

    let mut context = ServiceDiscoveryControllerApi::Context::default();
    let result = client.registerAvailableProviders(serviceDiscoveryRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
serviceDiscoveryRequest *

Responses


SynchronizingAnExistingProject

deleteSyncSourceV2

Delete the specified project's sync source configuration.


/api/v2/projects/{projectId}/sync/config

Usage and SDK Samples

curl -X DELETE \
 "http://localhost/api/v2/projects/{projectId}/sync/config"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SynchronizingAnExistingProjectApi;

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

public class SynchronizingAnExistingProjectApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        SynchronizingAnExistingProjectApi apiInstance = new SynchronizingAnExistingProjectApi();
        String projectId = projectId_example; // String | 

        try {
            apiInstance.deleteSyncSourceV2(projectId);
        } catch (ApiException e) {
            System.err.println("Exception when calling SynchronizingAnExistingProjectApi#deleteSyncSourceV2");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String projectId = new String(); // String | 

try {
    final result = await api_instance.deleteSyncSourceV2(projectId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteSyncSourceV2: $e\n');
}

import org.openapitools.client.api.SynchronizingAnExistingProjectApi;

public class SynchronizingAnExistingProjectApiExample {
    public static void main(String[] args) {
        SynchronizingAnExistingProjectApi apiInstance = new SynchronizingAnExistingProjectApi();
        String projectId = projectId_example; // String | 

        try {
            apiInstance.deleteSyncSourceV2(projectId);
        } catch (ApiException e) {
            System.err.println("Exception when calling SynchronizingAnExistingProjectApi#deleteSyncSourceV2");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
SynchronizingAnExistingProjectApi *apiInstance = [[SynchronizingAnExistingProjectApi alloc] init];
String *projectId = projectId_example; //  (default to null)

// Delete the specified project's sync source configuration.
[apiInstance deleteSyncSourceV2With:projectId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.SynchronizingAnExistingProjectApi()
var projectId = projectId_example; // {String} 

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

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

            // Create an instance of the API class
            var apiInstance = new SynchronizingAnExistingProjectApi();
            var projectId = projectId_example;  // String |  (default to null)

            try {
                // Delete the specified project's sync source configuration.
                apiInstance.deleteSyncSourceV2(projectId);
            } catch (Exception e) {
                Debug.Print("Exception when calling SynchronizingAnExistingProjectApi.deleteSyncSourceV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SynchronizingAnExistingProjectApi();
$projectId = projectId_example; // String | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SynchronizingAnExistingProjectApi->new();
my $projectId = projectId_example; # String | 

eval {
    $api_instance->deleteSyncSourceV2(projectId => $projectId);
};
if ($@) {
    warn "Exception when calling SynchronizingAnExistingProjectApi->deleteSyncSourceV2: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.SynchronizingAnExistingProjectApi()
projectId = projectId_example # String |  (default to null)

try:
    # Delete the specified project's sync source configuration.
    api_instance.delete_sync_source_v2(projectId)
except ApiException as e:
    print("Exception when calling SynchronizingAnExistingProjectApi->deleteSyncSourceV2: %s\n" % e)
extern crate SynchronizingAnExistingProjectApi;

pub fn main() {
    let projectId = projectId_example; // String

    let mut context = SynchronizingAnExistingProjectApi::Context::default();
    let result = client.deleteSyncSourceV2(projectId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
projectId*
String
Required

Responses


exportProjectV2

Commit the specified project's changes and push it to a specified sync source. If a sync source config is provided, it will overwrite the project's existing one. If not, the project's saved sync source config will be used


/api/v2/projects/{projectId}/sync/export

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost/api/v2/projects/{projectId}/sync/export" \
 -d '{
  "export_sensitive" : false,
  "sync_source_config" : {
    "type" : "type",
    "allow_deletions" : true
  },
  "commit_message" : "commit_message"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SynchronizingAnExistingProjectApi;

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

public class SynchronizingAnExistingProjectApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        SynchronizingAnExistingProjectApi apiInstance = new SynchronizingAnExistingProjectApi();
        String projectId = projectId_example; // String | 
        ExportProjectRequest exportProjectRequest = ; // ExportProjectRequest | 

        try {
            ProjectExportResponse result = apiInstance.exportProjectV2(projectId, exportProjectRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SynchronizingAnExistingProjectApi#exportProjectV2");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String projectId = new String(); // String | 
final ExportProjectRequest exportProjectRequest = new ExportProjectRequest(); // ExportProjectRequest | 

try {
    final result = await api_instance.exportProjectV2(projectId, exportProjectRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->exportProjectV2: $e\n');
}

import org.openapitools.client.api.SynchronizingAnExistingProjectApi;

public class SynchronizingAnExistingProjectApiExample {
    public static void main(String[] args) {
        SynchronizingAnExistingProjectApi apiInstance = new SynchronizingAnExistingProjectApi();
        String projectId = projectId_example; // String | 
        ExportProjectRequest exportProjectRequest = ; // ExportProjectRequest | 

        try {
            ProjectExportResponse result = apiInstance.exportProjectV2(projectId, exportProjectRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SynchronizingAnExistingProjectApi#exportProjectV2");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
SynchronizingAnExistingProjectApi *apiInstance = [[SynchronizingAnExistingProjectApi alloc] init];
String *projectId = projectId_example; //  (default to null)
ExportProjectRequest *exportProjectRequest = ; // 

// Commit the specified project's changes and push it to a specified sync source. If a sync source config is provided, it will overwrite the project's existing one. If not, the project's saved sync source config will be used
[apiInstance exportProjectV2With:projectId
    exportProjectRequest:exportProjectRequest
              completionHandler: ^(ProjectExportResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.SynchronizingAnExistingProjectApi()
var projectId = projectId_example; // {String} 
var exportProjectRequest = ; // {ExportProjectRequest} 

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

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

            // Create an instance of the API class
            var apiInstance = new SynchronizingAnExistingProjectApi();
            var projectId = projectId_example;  // String |  (default to null)
            var exportProjectRequest = new ExportProjectRequest(); // ExportProjectRequest | 

            try {
                // Commit the specified project's changes and push it to a specified sync source. If a sync source config is provided, it will overwrite the project's existing one. If not, the project's saved sync source config will be used
                ProjectExportResponse result = apiInstance.exportProjectV2(projectId, exportProjectRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SynchronizingAnExistingProjectApi.exportProjectV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SynchronizingAnExistingProjectApi();
$projectId = projectId_example; // String | 
$exportProjectRequest = ; // ExportProjectRequest | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SynchronizingAnExistingProjectApi->new();
my $projectId = projectId_example; # String | 
my $exportProjectRequest = WWW::OPenAPIClient::Object::ExportProjectRequest->new(); # ExportProjectRequest | 

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

# Create an instance of the API class
api_instance = openapi_client.SynchronizingAnExistingProjectApi()
projectId = projectId_example # String |  (default to null)
exportProjectRequest =  # ExportProjectRequest | 

try:
    # Commit the specified project's changes and push it to a specified sync source. If a sync source config is provided, it will overwrite the project's existing one. If not, the project's saved sync source config will be used
    api_response = api_instance.export_project_v2(projectId, exportProjectRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SynchronizingAnExistingProjectApi->exportProjectV2: %s\n" % e)
extern crate SynchronizingAnExistingProjectApi;

pub fn main() {
    let projectId = projectId_example; // String
    let exportProjectRequest = ; // ExportProjectRequest

    let mut context = SynchronizingAnExistingProjectApi::Context::default();
    let result = client.exportProjectV2(projectId, exportProjectRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
projectId*
String
Required
Body parameters
Name Description
exportProjectRequest *

Responses


getSyncSourceV2

Get the specified project's sync source configuration.


/api/v2/projects/{projectId}/sync/config

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/api/v2/projects/{projectId}/sync/config"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SynchronizingAnExistingProjectApi;

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

public class SynchronizingAnExistingProjectApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        SynchronizingAnExistingProjectApi apiInstance = new SynchronizingAnExistingProjectApi();
        String projectId = projectId_example; // String | 

        try {
            SyncSourceDto result = apiInstance.getSyncSourceV2(projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SynchronizingAnExistingProjectApi#getSyncSourceV2");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String projectId = new String(); // String | 

try {
    final result = await api_instance.getSyncSourceV2(projectId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getSyncSourceV2: $e\n');
}

import org.openapitools.client.api.SynchronizingAnExistingProjectApi;

public class SynchronizingAnExistingProjectApiExample {
    public static void main(String[] args) {
        SynchronizingAnExistingProjectApi apiInstance = new SynchronizingAnExistingProjectApi();
        String projectId = projectId_example; // String | 

        try {
            SyncSourceDto result = apiInstance.getSyncSourceV2(projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SynchronizingAnExistingProjectApi#getSyncSourceV2");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
SynchronizingAnExistingProjectApi *apiInstance = [[SynchronizingAnExistingProjectApi alloc] init];
String *projectId = projectId_example; //  (default to null)

// Get the specified project's sync source configuration.
[apiInstance getSyncSourceV2With:projectId
              completionHandler: ^(SyncSourceDto output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.SynchronizingAnExistingProjectApi()
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.getSyncSourceV2(projectId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new SynchronizingAnExistingProjectApi();
            var projectId = projectId_example;  // String |  (default to null)

            try {
                // Get the specified project's sync source configuration.
                SyncSourceDto result = apiInstance.getSyncSourceV2(projectId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SynchronizingAnExistingProjectApi.getSyncSourceV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SynchronizingAnExistingProjectApi();
$projectId = projectId_example; // String | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SynchronizingAnExistingProjectApi->new();
my $projectId = projectId_example; # String | 

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

# Create an instance of the API class
api_instance = openapi_client.SynchronizingAnExistingProjectApi()
projectId = projectId_example # String |  (default to null)

try:
    # Get the specified project's sync source configuration.
    api_response = api_instance.get_sync_source_v2(projectId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SynchronizingAnExistingProjectApi->getSyncSourceV2: %s\n" % e)
extern crate SynchronizingAnExistingProjectApi;

pub fn main() {
    let projectId = projectId_example; // String

    let mut context = SynchronizingAnExistingProjectApi::Context::default();
    let result = client.getSyncSourceV2(projectId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
projectId*
String
Required

Responses


importProjectV2

Import (update) an existing project from a specified sync source. If a sync source config is provided, it will overwrite the project's existing one. If not, the project's saved sync source config will be used.


/api/v2/projects/{projectId}/sync/import

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost/api/v2/projects/{projectId}/sync/import" \
 -d '{
  "sync_source_config" : {
    "type" : "type",
    "allow_deletions" : true
  }
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SynchronizingAnExistingProjectApi;

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

public class SynchronizingAnExistingProjectApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        SynchronizingAnExistingProjectApi apiInstance = new SynchronizingAnExistingProjectApi();
        String projectId = projectId_example; // String | 
        SyncSourceDto syncSourceDto = ; // SyncSourceDto | 

        try {
            SyncResponse result = apiInstance.importProjectV2(projectId, syncSourceDto);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SynchronizingAnExistingProjectApi#importProjectV2");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String projectId = new String(); // String | 
final SyncSourceDto syncSourceDto = new SyncSourceDto(); // SyncSourceDto | 

try {
    final result = await api_instance.importProjectV2(projectId, syncSourceDto);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->importProjectV2: $e\n');
}

import org.openapitools.client.api.SynchronizingAnExistingProjectApi;

public class SynchronizingAnExistingProjectApiExample {
    public static void main(String[] args) {
        SynchronizingAnExistingProjectApi apiInstance = new SynchronizingAnExistingProjectApi();
        String projectId = projectId_example; // String | 
        SyncSourceDto syncSourceDto = ; // SyncSourceDto | 

        try {
            SyncResponse result = apiInstance.importProjectV2(projectId, syncSourceDto);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SynchronizingAnExistingProjectApi#importProjectV2");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
SynchronizingAnExistingProjectApi *apiInstance = [[SynchronizingAnExistingProjectApi alloc] init];
String *projectId = projectId_example; //  (default to null)
SyncSourceDto *syncSourceDto = ; //  (optional)

// Import (update) an existing project from a specified sync source. If a sync source config is provided, it will overwrite the project's existing one. If not, the project's saved sync source config will be used.
[apiInstance importProjectV2With:projectId
    syncSourceDto:syncSourceDto
              completionHandler: ^(SyncResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.SynchronizingAnExistingProjectApi()
var projectId = projectId_example; // {String} 
var opts = {
  'syncSourceDto':  // {SyncSourceDto} 
};

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

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

            // Create an instance of the API class
            var apiInstance = new SynchronizingAnExistingProjectApi();
            var projectId = projectId_example;  // String |  (default to null)
            var syncSourceDto = new SyncSourceDto(); // SyncSourceDto |  (optional) 

            try {
                // Import (update) an existing project from a specified sync source. If a sync source config is provided, it will overwrite the project's existing one. If not, the project's saved sync source config will be used.
                SyncResponse result = apiInstance.importProjectV2(projectId, syncSourceDto);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SynchronizingAnExistingProjectApi.importProjectV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SynchronizingAnExistingProjectApi();
$projectId = projectId_example; // String | 
$syncSourceDto = ; // SyncSourceDto | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SynchronizingAnExistingProjectApi->new();
my $projectId = projectId_example; # String | 
my $syncSourceDto = WWW::OPenAPIClient::Object::SyncSourceDto->new(); # SyncSourceDto | 

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

# Create an instance of the API class
api_instance = openapi_client.SynchronizingAnExistingProjectApi()
projectId = projectId_example # String |  (default to null)
syncSourceDto =  # SyncSourceDto |  (optional)

try:
    # Import (update) an existing project from a specified sync source. If a sync source config is provided, it will overwrite the project's existing one. If not, the project's saved sync source config will be used.
    api_response = api_instance.import_project_v2(projectId, syncSourceDto=syncSourceDto)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SynchronizingAnExistingProjectApi->importProjectV2: %s\n" % e)
extern crate SynchronizingAnExistingProjectApi;

pub fn main() {
    let projectId = projectId_example; // String
    let syncSourceDto = ; // SyncSourceDto

    let mut context = SynchronizingAnExistingProjectApi::Context::default();
    let result = client.importProjectV2(projectId, syncSourceDto, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
projectId*
String
Required
Body parameters
Name Description
syncSourceDto

Responses


setSyncSourceV2

Update the specified project's sync source configuration.


/api/v2/projects/{projectId}/sync/config

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost/api/v2/projects/{projectId}/sync/config" \
 -d '{
  "sync_source_config" : {
    "type" : "type",
    "allow_deletions" : true
  }
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SynchronizingAnExistingProjectApi;

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

public class SynchronizingAnExistingProjectApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        SynchronizingAnExistingProjectApi apiInstance = new SynchronizingAnExistingProjectApi();
        String projectId = projectId_example; // String | 
        SyncSourceDto syncSourceDto = ; // SyncSourceDto | 

        try {
            SyncSourceDto result = apiInstance.setSyncSourceV2(projectId, syncSourceDto);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SynchronizingAnExistingProjectApi#setSyncSourceV2");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String projectId = new String(); // String | 
final SyncSourceDto syncSourceDto = new SyncSourceDto(); // SyncSourceDto | 

try {
    final result = await api_instance.setSyncSourceV2(projectId, syncSourceDto);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->setSyncSourceV2: $e\n');
}

import org.openapitools.client.api.SynchronizingAnExistingProjectApi;

public class SynchronizingAnExistingProjectApiExample {
    public static void main(String[] args) {
        SynchronizingAnExistingProjectApi apiInstance = new SynchronizingAnExistingProjectApi();
        String projectId = projectId_example; // String | 
        SyncSourceDto syncSourceDto = ; // SyncSourceDto | 

        try {
            SyncSourceDto result = apiInstance.setSyncSourceV2(projectId, syncSourceDto);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SynchronizingAnExistingProjectApi#setSyncSourceV2");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
SynchronizingAnExistingProjectApi *apiInstance = [[SynchronizingAnExistingProjectApi alloc] init];
String *projectId = projectId_example; //  (default to null)
SyncSourceDto *syncSourceDto = ; // 

// Update the specified project's sync source configuration.
[apiInstance setSyncSourceV2With:projectId
    syncSourceDto:syncSourceDto
              completionHandler: ^(SyncSourceDto output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.SynchronizingAnExistingProjectApi()
var projectId = projectId_example; // {String} 
var syncSourceDto = ; // {SyncSourceDto} 

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

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

            // Create an instance of the API class
            var apiInstance = new SynchronizingAnExistingProjectApi();
            var projectId = projectId_example;  // String |  (default to null)
            var syncSourceDto = new SyncSourceDto(); // SyncSourceDto | 

            try {
                // Update the specified project's sync source configuration.
                SyncSourceDto result = apiInstance.setSyncSourceV2(projectId, syncSourceDto);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SynchronizingAnExistingProjectApi.setSyncSourceV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SynchronizingAnExistingProjectApi();
$projectId = projectId_example; // String | 
$syncSourceDto = ; // SyncSourceDto | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SynchronizingAnExistingProjectApi->new();
my $projectId = projectId_example; # String | 
my $syncSourceDto = WWW::OPenAPIClient::Object::SyncSourceDto->new(); # SyncSourceDto | 

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

# Create an instance of the API class
api_instance = openapi_client.SynchronizingAnExistingProjectApi()
projectId = projectId_example # String |  (default to null)
syncSourceDto =  # SyncSourceDto | 

try:
    # Update the specified project's sync source configuration.
    api_response = api_instance.set_sync_source_v2(projectId, syncSourceDto)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SynchronizingAnExistingProjectApi->setSyncSourceV2: %s\n" % e)
extern crate SynchronizingAnExistingProjectApi;

pub fn main() {
    let projectId = projectId_example; // String
    let syncSourceDto = ; // SyncSourceDto

    let mut context = SynchronizingAnExistingProjectApi::Context::default();
    let result = client.setSyncSourceV2(projectId, syncSourceDto, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
projectId*
String
Required
Body parameters
Name Description
syncSourceDto *

Responses


validateSyncSourceV2

Validate a sync source configuration for a given project. Checks whether it is possible to import and export the project.


/api/v2/projects/{projectId}/sync/config/validate

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost/api/v2/projects/{projectId}/sync/config/validate" \
 -d '{
  "sync_source_config" : {
    "type" : "type",
    "allow_deletions" : true
  }
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SynchronizingAnExistingProjectApi;

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

public class SynchronizingAnExistingProjectApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        SynchronizingAnExistingProjectApi apiInstance = new SynchronizingAnExistingProjectApi();
        String projectId = projectId_example; // String | 
        SyncSourceDto syncSourceDto = ; // SyncSourceDto | 

        try {
            apiInstance.validateSyncSourceV2(projectId, syncSourceDto);
        } catch (ApiException e) {
            System.err.println("Exception when calling SynchronizingAnExistingProjectApi#validateSyncSourceV2");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String projectId = new String(); // String | 
final SyncSourceDto syncSourceDto = new SyncSourceDto(); // SyncSourceDto | 

try {
    final result = await api_instance.validateSyncSourceV2(projectId, syncSourceDto);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->validateSyncSourceV2: $e\n');
}

import org.openapitools.client.api.SynchronizingAnExistingProjectApi;

public class SynchronizingAnExistingProjectApiExample {
    public static void main(String[] args) {
        SynchronizingAnExistingProjectApi apiInstance = new SynchronizingAnExistingProjectApi();
        String projectId = projectId_example; // String | 
        SyncSourceDto syncSourceDto = ; // SyncSourceDto | 

        try {
            apiInstance.validateSyncSourceV2(projectId, syncSourceDto);
        } catch (ApiException e) {
            System.err.println("Exception when calling SynchronizingAnExistingProjectApi#validateSyncSourceV2");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
SynchronizingAnExistingProjectApi *apiInstance = [[SynchronizingAnExistingProjectApi alloc] init];
String *projectId = projectId_example; //  (default to null)
SyncSourceDto *syncSourceDto = ; // 

// Validate a sync source configuration for a given project. Checks whether it is possible to import and export the project.
[apiInstance validateSyncSourceV2With:projectId
    syncSourceDto:syncSourceDto
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.SynchronizingAnExistingProjectApi()
var projectId = projectId_example; // {String} 
var syncSourceDto = ; // {SyncSourceDto} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.validateSyncSourceV2(projectId, syncSourceDto, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new SynchronizingAnExistingProjectApi();
            var projectId = projectId_example;  // String |  (default to null)
            var syncSourceDto = new SyncSourceDto(); // SyncSourceDto | 

            try {
                // Validate a sync source configuration for a given project. Checks whether it is possible to import and export the project.
                apiInstance.validateSyncSourceV2(projectId, syncSourceDto);
            } catch (Exception e) {
                Debug.Print("Exception when calling SynchronizingAnExistingProjectApi.validateSyncSourceV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SynchronizingAnExistingProjectApi();
$projectId = projectId_example; // String | 
$syncSourceDto = ; // SyncSourceDto | 

try {
    $api_instance->validateSyncSourceV2($projectId, $syncSourceDto);
} catch (Exception $e) {
    echo 'Exception when calling SynchronizingAnExistingProjectApi->validateSyncSourceV2: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SynchronizingAnExistingProjectApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SynchronizingAnExistingProjectApi->new();
my $projectId = projectId_example; # String | 
my $syncSourceDto = WWW::OPenAPIClient::Object::SyncSourceDto->new(); # SyncSourceDto | 

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

# Create an instance of the API class
api_instance = openapi_client.SynchronizingAnExistingProjectApi()
projectId = projectId_example # String |  (default to null)
syncSourceDto =  # SyncSourceDto | 

try:
    # Validate a sync source configuration for a given project. Checks whether it is possible to import and export the project.
    api_instance.validate_sync_source_v2(projectId, syncSourceDto)
except ApiException as e:
    print("Exception when calling SynchronizingAnExistingProjectApi->validateSyncSourceV2: %s\n" % e)
extern crate SynchronizingAnExistingProjectApi;

pub fn main() {
    let projectId = projectId_example; // String
    let syncSourceDto = ; // SyncSourceDto

    let mut context = SynchronizingAnExistingProjectApi::Context::default();
    let result = client.validateSyncSourceV2(projectId, syncSourceDto, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
projectId*
String
Required
Body parameters
Name Description
syncSourceDto *

Responses


TableOperations

deleteTableByProjectIdAndIdV2

Delete a table in the specified project by its id.


/api/v2/projects/{projectId}/tables/{id}

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: application/json" \
 "http://localhost/api/v2/projects/{projectId}/tables/{id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TableOperationsApi;

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

public class TableOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        TableOperationsApi apiInstance = new TableOperationsApi();
        Integer id = 56; // Integer | 
        String projectId = projectId_example; // String | 

        try {
            TableDto result = apiInstance.deleteTableByProjectIdAndIdV2(id, projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TableOperationsApi#deleteTableByProjectIdAndIdV2");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 
final String projectId = new String(); // String | 

try {
    final result = await api_instance.deleteTableByProjectIdAndIdV2(id, projectId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteTableByProjectIdAndIdV2: $e\n');
}

import org.openapitools.client.api.TableOperationsApi;

public class TableOperationsApiExample {
    public static void main(String[] args) {
        TableOperationsApi apiInstance = new TableOperationsApi();
        Integer id = 56; // Integer | 
        String projectId = projectId_example; // String | 

        try {
            TableDto result = apiInstance.deleteTableByProjectIdAndIdV2(id, projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TableOperationsApi#deleteTableByProjectIdAndIdV2");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
TableOperationsApi *apiInstance = [[TableOperationsApi alloc] init];
Integer *id = 56; //  (default to null)
String *projectId = projectId_example; //  (default to null)

// Delete a table in the specified project by its id.
[apiInstance deleteTableByProjectIdAndIdV2With:id
    projectId:projectId
              completionHandler: ^(TableDto output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.TableOperationsApi()
var id = 56; // {Integer} 
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.deleteTableByProjectIdAndIdV2(id, projectId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new TableOperationsApi();
            var id = 56;  // Integer |  (default to null)
            var projectId = projectId_example;  // String |  (default to null)

            try {
                // Delete a table in the specified project by its id.
                TableDto result = apiInstance.deleteTableByProjectIdAndIdV2(id, projectId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling TableOperationsApi.deleteTableByProjectIdAndIdV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TableOperationsApi();
$id = 56; // Integer | 
$projectId = projectId_example; // String | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TableOperationsApi->new();
my $id = 56; # Integer | 
my $projectId = projectId_example; # String | 

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

# Create an instance of the API class
api_instance = openapi_client.TableOperationsApi()
id = 56 # Integer |  (default to null)
projectId = projectId_example # String |  (default to null)

try:
    # Delete a table in the specified project by its id.
    api_response = api_instance.delete_table_by_project_id_and_id_v2(id, projectId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TableOperationsApi->deleteTableByProjectIdAndIdV2: %s\n" % e)
extern crate TableOperationsApi;

pub fn main() {
    let id = 56; // Integer
    let projectId = projectId_example; // String

    let mut context = TableOperationsApi::Context::default();
    let result = client.deleteTableByProjectIdAndIdV2(id, projectId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required
projectId*
String
Required

Responses


getTableByIdV2

Retrieve a table in the specified project by its id.


/api/v2/projects/{projectId}/tables/{id}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/api/v2/projects/{projectId}/tables/{id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TableOperationsApi;

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

public class TableOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        TableOperationsApi apiInstance = new TableOperationsApi();
        Integer id = 56; // Integer | 
        String projectId = projectId_example; // String | 

        try {
            TableDto result = apiInstance.getTableByIdV2(id, projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TableOperationsApi#getTableByIdV2");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 
final String projectId = new String(); // String | 

try {
    final result = await api_instance.getTableByIdV2(id, projectId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getTableByIdV2: $e\n');
}

import org.openapitools.client.api.TableOperationsApi;

public class TableOperationsApiExample {
    public static void main(String[] args) {
        TableOperationsApi apiInstance = new TableOperationsApi();
        Integer id = 56; // Integer | 
        String projectId = projectId_example; // String | 

        try {
            TableDto result = apiInstance.getTableByIdV2(id, projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TableOperationsApi#getTableByIdV2");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
TableOperationsApi *apiInstance = [[TableOperationsApi alloc] init];
Integer *id = 56; //  (default to null)
String *projectId = projectId_example; //  (default to null)

// Retrieve a table in the specified project by its id.
[apiInstance getTableByIdV2With:id
    projectId:projectId
              completionHandler: ^(TableDto output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.TableOperationsApi()
var id = 56; // {Integer} 
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.getTableByIdV2(id, projectId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new TableOperationsApi();
            var id = 56;  // Integer |  (default to null)
            var projectId = projectId_example;  // String |  (default to null)

            try {
                // Retrieve a table in the specified project by its id.
                TableDto result = apiInstance.getTableByIdV2(id, projectId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling TableOperationsApi.getTableByIdV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TableOperationsApi();
$id = 56; // Integer | 
$projectId = projectId_example; // String | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TableOperationsApi->new();
my $id = 56; # Integer | 
my $projectId = projectId_example; # String | 

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

# Create an instance of the API class
api_instance = openapi_client.TableOperationsApi()
id = 56 # Integer |  (default to null)
projectId = projectId_example # String |  (default to null)

try:
    # Retrieve a table in the specified project by its id.
    api_response = api_instance.get_table_by_id_v2(id, projectId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TableOperationsApi->getTableByIdV2: %s\n" % e)
extern crate TableOperationsApi;

pub fn main() {
    let id = 56; // Integer
    let projectId = projectId_example; // String

    let mut context = TableOperationsApi::Context::default();
    let result = client.getTableByIdV2(id, projectId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required
projectId*
String
Required

Responses


getTablesInProjectV2

Retrieve all tables in the specified project.


/api/v2/projects/{projectId}/tables

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/api/v2/projects/{projectId}/tables"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TableOperationsApi;

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

public class TableOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        TableOperationsApi apiInstance = new TableOperationsApi();
        String projectId = projectId_example; // String | 

        try {
            array[TableDto] result = apiInstance.getTablesInProjectV2(projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TableOperationsApi#getTablesInProjectV2");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String projectId = new String(); // String | 

try {
    final result = await api_instance.getTablesInProjectV2(projectId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getTablesInProjectV2: $e\n');
}

import org.openapitools.client.api.TableOperationsApi;

public class TableOperationsApiExample {
    public static void main(String[] args) {
        TableOperationsApi apiInstance = new TableOperationsApi();
        String projectId = projectId_example; // String | 

        try {
            array[TableDto] result = apiInstance.getTablesInProjectV2(projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TableOperationsApi#getTablesInProjectV2");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
TableOperationsApi *apiInstance = [[TableOperationsApi alloc] init];
String *projectId = projectId_example; //  (default to null)

// Retrieve all tables in the specified project.
[apiInstance getTablesInProjectV2With:projectId
              completionHandler: ^(array[TableDto] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.TableOperationsApi()
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.getTablesInProjectV2(projectId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new TableOperationsApi();
            var projectId = projectId_example;  // String |  (default to null)

            try {
                // Retrieve all tables in the specified project.
                array[TableDto] result = apiInstance.getTablesInProjectV2(projectId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling TableOperationsApi.getTablesInProjectV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TableOperationsApi();
$projectId = projectId_example; // String | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TableOperationsApi->new();
my $projectId = projectId_example; # String | 

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

# Create an instance of the API class
api_instance = openapi_client.TableOperationsApi()
projectId = projectId_example # String |  (default to null)

try:
    # Retrieve all tables in the specified project.
    api_response = api_instance.get_tables_in_project_v2(projectId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TableOperationsApi->getTablesInProjectV2: %s\n" % e)
extern crate TableOperationsApi;

pub fn main() {
    let projectId = projectId_example; // String

    let mut context = TableOperationsApi::Context::default();
    let result = client.getTablesInProjectV2(projectId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
projectId*
String
Required

Responses


getTablesTree

Retrieves a list of tables in hierarchical form organized by catalog.


/api/v2/projects/{projectId}/tables/tree

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/api/v2/projects/{projectId}/tables/tree"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TableOperationsApi;

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

public class TableOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        TableOperationsApi apiInstance = new TableOperationsApi();
        String projectId = projectId_example; // String | 

        try {
            TablesTreeResponse result = apiInstance.getTablesTree(projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TableOperationsApi#getTablesTree");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String projectId = new String(); // String | 

try {
    final result = await api_instance.getTablesTree(projectId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getTablesTree: $e\n');
}

import org.openapitools.client.api.TableOperationsApi;

public class TableOperationsApiExample {
    public static void main(String[] args) {
        TableOperationsApi apiInstance = new TableOperationsApi();
        String projectId = projectId_example; // String | 

        try {
            TablesTreeResponse result = apiInstance.getTablesTree(projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TableOperationsApi#getTablesTree");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
TableOperationsApi *apiInstance = [[TableOperationsApi alloc] init];
String *projectId = projectId_example; //  (default to null)

// Retrieves a list of tables in hierarchical form organized by catalog.
[apiInstance getTablesTreeWith:projectId
              completionHandler: ^(TablesTreeResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.TableOperationsApi()
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.getTablesTree(projectId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new TableOperationsApi();
            var projectId = projectId_example;  // String |  (default to null)

            try {
                // Retrieves a list of tables in hierarchical form organized by catalog.
                TablesTreeResponse result = apiInstance.getTablesTree(projectId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling TableOperationsApi.getTablesTree: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TableOperationsApi();
$projectId = projectId_example; // String | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TableOperationsApi->new();
my $projectId = projectId_example; # String | 

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

# Create an instance of the API class
api_instance = openapi_client.TableOperationsApi()
projectId = projectId_example # String |  (default to null)

try:
    # Retrieves a list of tables in hierarchical form organized by catalog.
    api_response = api_instance.get_tables_tree(projectId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TableOperationsApi->getTablesTree: %s\n" % e)
extern crate TableOperationsApi;

pub fn main() {
    let projectId = projectId_example; // String

    let mut context = TableOperationsApi::Context::default();
    let result = client.getTablesTree(projectId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
projectId*
String
Required

Responses


upsertTable

Create or update a table in the specified project.


/api/v2/projects/{projectId}/tables

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost/api/v2/projects/{projectId}/tables" \
 -d '{
  "transform_code" : "transform_code",
  "metadata" : "",
  "transform_code_b64_encoded" : true,
  "type" : "type",
  "table_name" : "table_name"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TableOperationsApi;

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

public class TableOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        TableOperationsApi apiInstance = new TableOperationsApi();
        String projectId = projectId_example; // String | 
        TableSyncDto tableSyncDto = ; // TableSyncDto | 

        try {
            TableDto result = apiInstance.upsertTable(projectId, tableSyncDto);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TableOperationsApi#upsertTable");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String projectId = new String(); // String | 
final TableSyncDto tableSyncDto = new TableSyncDto(); // TableSyncDto | 

try {
    final result = await api_instance.upsertTable(projectId, tableSyncDto);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->upsertTable: $e\n');
}

import org.openapitools.client.api.TableOperationsApi;

public class TableOperationsApiExample {
    public static void main(String[] args) {
        TableOperationsApi apiInstance = new TableOperationsApi();
        String projectId = projectId_example; // String | 
        TableSyncDto tableSyncDto = ; // TableSyncDto | 

        try {
            TableDto result = apiInstance.upsertTable(projectId, tableSyncDto);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TableOperationsApi#upsertTable");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
TableOperationsApi *apiInstance = [[TableOperationsApi alloc] init];
String *projectId = projectId_example; //  (default to null)
TableSyncDto *tableSyncDto = ; // 

// Create or update a table in the specified project.
[apiInstance upsertTableWith:projectId
    tableSyncDto:tableSyncDto
              completionHandler: ^(TableDto output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.TableOperationsApi()
var projectId = projectId_example; // {String} 
var tableSyncDto = ; // {TableSyncDto} 

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

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

            // Create an instance of the API class
            var apiInstance = new TableOperationsApi();
            var projectId = projectId_example;  // String |  (default to null)
            var tableSyncDto = new TableSyncDto(); // TableSyncDto | 

            try {
                // Create or update a table in the specified project.
                TableDto result = apiInstance.upsertTable(projectId, tableSyncDto);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling TableOperationsApi.upsertTable: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TableOperationsApi();
$projectId = projectId_example; // String | 
$tableSyncDto = ; // TableSyncDto | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TableOperationsApi->new();
my $projectId = projectId_example; # String | 
my $tableSyncDto = WWW::OPenAPIClient::Object::TableSyncDto->new(); # TableSyncDto | 

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

# Create an instance of the API class
api_instance = openapi_client.TableOperationsApi()
projectId = projectId_example # String |  (default to null)
tableSyncDto =  # TableSyncDto | 

try:
    # Create or update a table in the specified project.
    api_response = api_instance.upsert_table(projectId, tableSyncDto)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TableOperationsApi->upsertTable: %s\n" % e)
extern crate TableOperationsApi;

pub fn main() {
    let projectId = projectId_example; // String
    let tableSyncDto = ; // TableSyncDto

    let mut context = TableOperationsApi::Context::default();
    let result = client.upsertTable(projectId, tableSyncDto, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
projectId*
String
Required
Body parameters
Name Description
tableSyncDto *

Responses


UDFArtifactOperations

deleteJarWithUdfsV2

Deletes and Artifact along with all of its associated UDFs.


/api/v2/projects/{projectId}/udfs/artifact/{id}

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: application/json" \
 "http://localhost/api/v2/projects/{projectId}/udfs/artifact/{id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UDFArtifactOperationsApi;

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

public class UDFArtifactOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        UDFArtifactOperationsApi apiInstance = new UDFArtifactOperationsApi();
        Integer id = 56; // Integer | 
        String projectId = projectId_example; // String | 

        try {
            apiInstance.deleteJarWithUdfsV2(id, projectId);
        } catch (ApiException e) {
            System.err.println("Exception when calling UDFArtifactOperationsApi#deleteJarWithUdfsV2");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer id = new Integer(); // Integer | 
final String projectId = new String(); // String | 

try {
    final result = await api_instance.deleteJarWithUdfsV2(id, projectId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteJarWithUdfsV2: $e\n');
}

import org.openapitools.client.api.UDFArtifactOperationsApi;

public class UDFArtifactOperationsApiExample {
    public static void main(String[] args) {
        UDFArtifactOperationsApi apiInstance = new UDFArtifactOperationsApi();
        Integer id = 56; // Integer | 
        String projectId = projectId_example; // String | 

        try {
            apiInstance.deleteJarWithUdfsV2(id, projectId);
        } catch (ApiException e) {
            System.err.println("Exception when calling UDFArtifactOperationsApi#deleteJarWithUdfsV2");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
UDFArtifactOperationsApi *apiInstance = [[UDFArtifactOperationsApi alloc] init];
Integer *id = 56; //  (default to null)
String *projectId = projectId_example; //  (default to null)

// Deletes and Artifact along with all of its associated UDFs.
[apiInstance deleteJarWithUdfsV2With:id
    projectId:projectId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.UDFArtifactOperationsApi()
var id = 56; // {Integer} 
var projectId = projectId_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteJarWithUdfsV2(id, projectId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new UDFArtifactOperationsApi();
            var id = 56;  // Integer |  (default to null)
            var projectId = projectId_example;  // String |  (default to null)

            try {
                // Deletes and Artifact along with all of its associated UDFs.
                apiInstance.deleteJarWithUdfsV2(id, projectId);
            } catch (Exception e) {
                Debug.Print("Exception when calling UDFArtifactOperationsApi.deleteJarWithUdfsV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UDFArtifactOperationsApi();
$id = 56; // Integer | 
$projectId = projectId_example; // String | 

try {
    $api_instance->deleteJarWithUdfsV2($id, $projectId);
} catch (Exception $e) {
    echo 'Exception when calling UDFArtifactOperationsApi->deleteJarWithUdfsV2: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UDFArtifactOperationsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UDFArtifactOperationsApi->new();
my $id = 56; # Integer | 
my $projectId = projectId_example; # String | 

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

# Create an instance of the API class
api_instance = openapi_client.UDFArtifactOperationsApi()
id = 56 # Integer |  (default to null)
projectId = projectId_example # String |  (default to null)

try:
    # Deletes and Artifact along with all of its associated UDFs.
    api_instance.delete_jar_with_udfs_v2(id, projectId)
except ApiException as e:
    print("Exception when calling UDFArtifactOperationsApi->deleteJarWithUdfsV2: %s\n" % e)
extern crate UDFArtifactOperationsApi;

pub fn main() {
    let id = 56; // Integer
    let projectId = projectId_example; // String

    let mut context = UDFArtifactOperationsApi::Context::default();
    let result = client.deleteJarWithUdfsV2(id, projectId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required
projectId*
String
Required

Responses


getJarBasedUdfsInProjectV2

List all JAR-based UDFs in the specified project.


/api/v2/projects/{projectId}/udfs/artifact

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/api/v2/projects/{projectId}/udfs/artifact"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UDFArtifactOperationsApi;

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

public class UDFArtifactOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        UDFArtifactOperationsApi apiInstance = new UDFArtifactOperationsApi();
        String projectId = projectId_example; // String | 

        try {
            array[UdfDto] result = apiInstance.getJarBasedUdfsInProjectV2(projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UDFArtifactOperationsApi#getJarBasedUdfsInProjectV2");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String projectId = new String(); // String | 

try {
    final result = await api_instance.getJarBasedUdfsInProjectV2(projectId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getJarBasedUdfsInProjectV2: $e\n');
}

import org.openapitools.client.api.UDFArtifactOperationsApi;

public class UDFArtifactOperationsApiExample {
    public static void main(String[] args) {
        UDFArtifactOperationsApi apiInstance = new UDFArtifactOperationsApi();
        String projectId = projectId_example; // String | 

        try {
            array[UdfDto] result = apiInstance.getJarBasedUdfsInProjectV2(projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UDFArtifactOperationsApi#getJarBasedUdfsInProjectV2");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
UDFArtifactOperationsApi *apiInstance = [[UDFArtifactOperationsApi alloc] init];
String *projectId = projectId_example; //  (default to null)

// List all JAR-based UDFs in the specified project.
[apiInstance getJarBasedUdfsInProjectV2With:projectId
              completionHandler: ^(array[UdfDto] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.UDFArtifactOperationsApi()
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.getJarBasedUdfsInProjectV2(projectId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new UDFArtifactOperationsApi();
            var projectId = projectId_example;  // String |  (default to null)

            try {
                // List all JAR-based UDFs in the specified project.
                array[UdfDto] result = apiInstance.getJarBasedUdfsInProjectV2(projectId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UDFArtifactOperationsApi.getJarBasedUdfsInProjectV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UDFArtifactOperationsApi();
$projectId = projectId_example; // String | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UDFArtifactOperationsApi->new();
my $projectId = projectId_example; # String | 

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

# Create an instance of the API class
api_instance = openapi_client.UDFArtifactOperationsApi()
projectId = projectId_example # String |  (default to null)

try:
    # List all JAR-based UDFs in the specified project.
    api_response = api_instance.get_jar_based_udfs_in_project_v2(projectId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UDFArtifactOperationsApi->getJarBasedUdfsInProjectV2: %s\n" % e)
extern crate UDFArtifactOperationsApi;

pub fn main() {
    let projectId = projectId_example; // String

    let mut context = UDFArtifactOperationsApi::Context::default();
    let result = client.getJarBasedUdfsInProjectV2(projectId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
projectId*
String
Required

Responses


uploadUdfJarV2

Upload a JAR and create UDFs from the contained classes.


/api/v2/projects/{projectId}/udfs/artifact

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: multipart/form-data" \
 "http://localhost/api/v2/projects/{projectId}/udfs/artifact"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UDFArtifactOperationsApi;

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

public class UDFArtifactOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        UDFArtifactOperationsApi apiInstance = new UDFArtifactOperationsApi();
        String projectId = projectId_example; // String | 
        File file = BINARY_DATA_HERE; // File | 

        try {
            array[UdfDto] result = apiInstance.uploadUdfJarV2(projectId, file);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UDFArtifactOperationsApi#uploadUdfJarV2");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String projectId = new String(); // String | 
final File file = new File(); // File | 

try {
    final result = await api_instance.uploadUdfJarV2(projectId, file);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->uploadUdfJarV2: $e\n');
}

import org.openapitools.client.api.UDFArtifactOperationsApi;

public class UDFArtifactOperationsApiExample {
    public static void main(String[] args) {
        UDFArtifactOperationsApi apiInstance = new UDFArtifactOperationsApi();
        String projectId = projectId_example; // String | 
        File file = BINARY_DATA_HERE; // File | 

        try {
            array[UdfDto] result = apiInstance.uploadUdfJarV2(projectId, file);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UDFArtifactOperationsApi#uploadUdfJarV2");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
UDFArtifactOperationsApi *apiInstance = [[UDFArtifactOperationsApi alloc] init];
String *projectId = projectId_example; //  (default to null)
File *file = BINARY_DATA_HERE; //  (default to null)

// Upload a JAR and create UDFs from the contained classes.
[apiInstance uploadUdfJarV2With:projectId
    file:file
              completionHandler: ^(array[UdfDto] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.UDFArtifactOperationsApi()
var projectId = projectId_example; // {String} 
var file = BINARY_DATA_HERE; // {File} 

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

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

            // Create an instance of the API class
            var apiInstance = new UDFArtifactOperationsApi();
            var projectId = projectId_example;  // String |  (default to null)
            var file = BINARY_DATA_HERE;  // File |  (default to null)

            try {
                // Upload a JAR and create UDFs from the contained classes.
                array[UdfDto] result = apiInstance.uploadUdfJarV2(projectId, file);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UDFArtifactOperationsApi.uploadUdfJarV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UDFArtifactOperationsApi();
$projectId = projectId_example; // String | 
$file = BINARY_DATA_HERE; // File | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UDFArtifactOperationsApi->new();
my $projectId = projectId_example; # String | 
my $file = BINARY_DATA_HERE; # File | 

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

# Create an instance of the API class
api_instance = openapi_client.UDFArtifactOperationsApi()
projectId = projectId_example # String |  (default to null)
file = BINARY_DATA_HERE # File |  (default to null)

try:
    # Upload a JAR and create UDFs from the contained classes.
    api_response = api_instance.upload_udf_jar_v2(projectId, file)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UDFArtifactOperationsApi->uploadUdfJarV2: %s\n" % e)
extern crate UDFArtifactOperationsApi;

pub fn main() {
    let projectId = projectId_example; // String
    let file = BINARY_DATA_HERE; // File

    let mut context = UDFArtifactOperationsApi::Context::default();
    let result = client.uploadUdfJarV2(projectId, file, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
projectId*
String
Required
Form parameters
Name Description
file*
File (binary)
Required

Responses


UDFOperations

createUdfV2

Creates a UDF.


/api/v2/projects/{projectId}/udfs

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost/api/v2/projects/{projectId}/udfs" \
 -d '{
  "code" : "code",
  "output_type" : "output_type",
  "input_types" : [ "input_types", "input_types" ],
  "file_name" : "file_name",
  "description" : "description",
  "java_class_name" : "java_class_name",
  "created_at" : "created_at",
  "language" : "language",
  "udf_artifact" : "",
  "jar_file" : {
    "storage_path" : "storage_path",
    "user_id" : "user_id",
    "project_id" : "project_id",
    "scope" : "USER",
    "name" : "name",
    "created_at" : "2000-01-23T04:56:07.000+00:00",
    "id" : 6
  },
  "updated_at" : "updated_at",
  "project_id" : "project_id",
  "name" : "name",
  "id" : 0
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UDFOperationsApi;

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

public class UDFOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        UDFOperationsApi apiInstance = new UDFOperationsApi();
        String projectId = projectId_example; // String | 
        UdfDto udfDto = ; // UdfDto | 

        try {
            UdfDto result = apiInstance.createUdfV2(projectId, udfDto);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UDFOperationsApi#createUdfV2");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String projectId = new String(); // String | 
final UdfDto udfDto = new UdfDto(); // UdfDto | 

try {
    final result = await api_instance.createUdfV2(projectId, udfDto);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->createUdfV2: $e\n');
}

import org.openapitools.client.api.UDFOperationsApi;

public class UDFOperationsApiExample {
    public static void main(String[] args) {
        UDFOperationsApi apiInstance = new UDFOperationsApi();
        String projectId = projectId_example; // String | 
        UdfDto udfDto = ; // UdfDto | 

        try {
            UdfDto result = apiInstance.createUdfV2(projectId, udfDto);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UDFOperationsApi#createUdfV2");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
UDFOperationsApi *apiInstance = [[UDFOperationsApi alloc] init];
String *projectId = projectId_example; //  (default to null)
UdfDto *udfDto = ; // 

// Creates a UDF.
[apiInstance createUdfV2With:projectId
    udfDto:udfDto
              completionHandler: ^(UdfDto output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.UDFOperationsApi()
var projectId = projectId_example; // {String} 
var udfDto = ; // {UdfDto} 

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

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

            // Create an instance of the API class
            var apiInstance = new UDFOperationsApi();
            var projectId = projectId_example;  // String |  (default to null)
            var udfDto = new UdfDto(); // UdfDto | 

            try {
                // Creates a UDF.
                UdfDto result = apiInstance.createUdfV2(projectId, udfDto);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UDFOperationsApi.createUdfV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UDFOperationsApi();
$projectId = projectId_example; // String | 
$udfDto = ; // UdfDto | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UDFOperationsApi->new();
my $projectId = projectId_example; # String | 
my $udfDto = WWW::OPenAPIClient::Object::UdfDto->new(); # UdfDto | 

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

# Create an instance of the API class
api_instance = openapi_client.UDFOperationsApi()
projectId = projectId_example # String |  (default to null)
udfDto =  # UdfDto | 

try:
    # Creates a UDF.
    api_response = api_instance.create_udf_v2(projectId, udfDto)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UDFOperationsApi->createUdfV2: %s\n" % e)
extern crate UDFOperationsApi;

pub fn main() {
    let projectId = projectId_example; // String
    let udfDto = ; // UdfDto

    let mut context = UDFOperationsApi::Context::default();
    let result = client.createUdfV2(projectId, udfDto, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
projectId*
String
Required
Body parameters
Name Description
udfDto *

Responses


deleteUdfV2

Deletes a UDF by its id.


/api/v2/projects/{projectId}/udfs/{id}

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: application/json" \
 "http://localhost/api/v2/projects/{projectId}/udfs/{id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UDFOperationsApi;

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

public class UDFOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        UDFOperationsApi apiInstance = new UDFOperationsApi();
        Long id = 789; // Long | 
        String projectId = projectId_example; // String | 

        try {
            apiInstance.deleteUdfV2(id, projectId);
        } catch (ApiException e) {
            System.err.println("Exception when calling UDFOperationsApi#deleteUdfV2");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long id = new Long(); // Long | 
final String projectId = new String(); // String | 

try {
    final result = await api_instance.deleteUdfV2(id, projectId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteUdfV2: $e\n');
}

import org.openapitools.client.api.UDFOperationsApi;

public class UDFOperationsApiExample {
    public static void main(String[] args) {
        UDFOperationsApi apiInstance = new UDFOperationsApi();
        Long id = 789; // Long | 
        String projectId = projectId_example; // String | 

        try {
            apiInstance.deleteUdfV2(id, projectId);
        } catch (ApiException e) {
            System.err.println("Exception when calling UDFOperationsApi#deleteUdfV2");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
UDFOperationsApi *apiInstance = [[UDFOperationsApi alloc] init];
Long *id = 789; //  (default to null)
String *projectId = projectId_example; //  (default to null)

// Deletes a UDF by its id.
[apiInstance deleteUdfV2With:id
    projectId:projectId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.UDFOperationsApi()
var id = 789; // {Long} 
var projectId = projectId_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteUdfV2(id, projectId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new UDFOperationsApi();
            var id = 789;  // Long |  (default to null)
            var projectId = projectId_example;  // String |  (default to null)

            try {
                // Deletes a UDF by its id.
                apiInstance.deleteUdfV2(id, projectId);
            } catch (Exception e) {
                Debug.Print("Exception when calling UDFOperationsApi.deleteUdfV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UDFOperationsApi();
$id = 789; // Long | 
$projectId = projectId_example; // String | 

try {
    $api_instance->deleteUdfV2($id, $projectId);
} catch (Exception $e) {
    echo 'Exception when calling UDFOperationsApi->deleteUdfV2: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UDFOperationsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UDFOperationsApi->new();
my $id = 789; # Long | 
my $projectId = projectId_example; # String | 

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

# Create an instance of the API class
api_instance = openapi_client.UDFOperationsApi()
id = 789 # Long |  (default to null)
projectId = projectId_example # String |  (default to null)

try:
    # Deletes a UDF by its id.
    api_instance.delete_udf_v2(id, projectId)
except ApiException as e:
    print("Exception when calling UDFOperationsApi->deleteUdfV2: %s\n" % e)
extern crate UDFOperationsApi;

pub fn main() {
    let id = 789; // Long
    let projectId = projectId_example; // String

    let mut context = UDFOperationsApi::Context::default();
    let result = client.deleteUdfV2(id, projectId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Long (int64)
Required
projectId*
String
Required

Responses


getAllUdfsInProjectV2

Retrieves all UDFs in the specified project.


/api/v2/projects/{projectId}/udfs

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/api/v2/projects/{projectId}/udfs"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UDFOperationsApi;

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

public class UDFOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        UDFOperationsApi apiInstance = new UDFOperationsApi();
        String projectId = projectId_example; // String | 

        try {
            array[UdfDto] result = apiInstance.getAllUdfsInProjectV2(projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UDFOperationsApi#getAllUdfsInProjectV2");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String projectId = new String(); // String | 

try {
    final result = await api_instance.getAllUdfsInProjectV2(projectId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getAllUdfsInProjectV2: $e\n');
}

import org.openapitools.client.api.UDFOperationsApi;

public class UDFOperationsApiExample {
    public static void main(String[] args) {
        UDFOperationsApi apiInstance = new UDFOperationsApi();
        String projectId = projectId_example; // String | 

        try {
            array[UdfDto] result = apiInstance.getAllUdfsInProjectV2(projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UDFOperationsApi#getAllUdfsInProjectV2");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
UDFOperationsApi *apiInstance = [[UDFOperationsApi alloc] init];
String *projectId = projectId_example; //  (default to null)

// Retrieves all UDFs in the specified project.
[apiInstance getAllUdfsInProjectV2With:projectId
              completionHandler: ^(array[UdfDto] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.UDFOperationsApi()
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.getAllUdfsInProjectV2(projectId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new UDFOperationsApi();
            var projectId = projectId_example;  // String |  (default to null)

            try {
                // Retrieves all UDFs in the specified project.
                array[UdfDto] result = apiInstance.getAllUdfsInProjectV2(projectId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UDFOperationsApi.getAllUdfsInProjectV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UDFOperationsApi();
$projectId = projectId_example; // String | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UDFOperationsApi->new();
my $projectId = projectId_example; # String | 

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

# Create an instance of the API class
api_instance = openapi_client.UDFOperationsApi()
projectId = projectId_example # String |  (default to null)

try:
    # Retrieves all UDFs in the specified project.
    api_response = api_instance.get_all_udfs_in_project_v2(projectId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UDFOperationsApi->getAllUdfsInProjectV2: %s\n" % e)
extern crate UDFOperationsApi;

pub fn main() {
    let projectId = projectId_example; // String

    let mut context = UDFOperationsApi::Context::default();
    let result = client.getAllUdfsInProjectV2(projectId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
projectId*
String
Required

Responses


getUdfByIdV2

Retrieves a UDF by its id.


/api/v2/projects/{projectId}/udfs/{id}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/api/v2/projects/{projectId}/udfs/{id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UDFOperationsApi;

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

public class UDFOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        UDFOperationsApi apiInstance = new UDFOperationsApi();
        Long id = 789; // Long | 
        String projectId = projectId_example; // String | 

        try {
            UdfDto result = apiInstance.getUdfByIdV2(id, projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UDFOperationsApi#getUdfByIdV2");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long id = new Long(); // Long | 
final String projectId = new String(); // String | 

try {
    final result = await api_instance.getUdfByIdV2(id, projectId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getUdfByIdV2: $e\n');
}

import org.openapitools.client.api.UDFOperationsApi;

public class UDFOperationsApiExample {
    public static void main(String[] args) {
        UDFOperationsApi apiInstance = new UDFOperationsApi();
        Long id = 789; // Long | 
        String projectId = projectId_example; // String | 

        try {
            UdfDto result = apiInstance.getUdfByIdV2(id, projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UDFOperationsApi#getUdfByIdV2");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
UDFOperationsApi *apiInstance = [[UDFOperationsApi alloc] init];
Long *id = 789; //  (default to null)
String *projectId = projectId_example; //  (default to null)

// Retrieves a UDF by its id.
[apiInstance getUdfByIdV2With:id
    projectId:projectId
              completionHandler: ^(UdfDto output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.UDFOperationsApi()
var id = 789; // {Long} 
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.getUdfByIdV2(id, projectId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new UDFOperationsApi();
            var id = 789;  // Long |  (default to null)
            var projectId = projectId_example;  // String |  (default to null)

            try {
                // Retrieves a UDF by its id.
                UdfDto result = apiInstance.getUdfByIdV2(id, projectId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UDFOperationsApi.getUdfByIdV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UDFOperationsApi();
$id = 789; // Long | 
$projectId = projectId_example; // String | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UDFOperationsApi->new();
my $id = 789; # Long | 
my $projectId = projectId_example; # String | 

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

# Create an instance of the API class
api_instance = openapi_client.UDFOperationsApi()
id = 789 # Long |  (default to null)
projectId = projectId_example # String |  (default to null)

try:
    # Retrieves a UDF by its id.
    api_response = api_instance.get_udf_by_id_v2(id, projectId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UDFOperationsApi->getUdfByIdV2: %s\n" % e)
extern crate UDFOperationsApi;

pub fn main() {
    let id = 789; // Long
    let projectId = projectId_example; // String

    let mut context = UDFOperationsApi::Context::default();
    let result = client.getUdfByIdV2(id, projectId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Long (int64)
Required
projectId*
String
Required

Responses


updateUdfV2

Updates a UDF.


/api/v2/projects/{projectId}/udfs

Usage and SDK Samples

curl -X PUT \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost/api/v2/projects/{projectId}/udfs" \
 -d '{
  "code" : "code",
  "output_type" : "output_type",
  "input_types" : [ "input_types", "input_types" ],
  "file_name" : "file_name",
  "description" : "description",
  "java_class_name" : "java_class_name",
  "created_at" : "created_at",
  "language" : "language",
  "udf_artifact" : "",
  "jar_file" : {
    "storage_path" : "storage_path",
    "user_id" : "user_id",
    "project_id" : "project_id",
    "scope" : "USER",
    "name" : "name",
    "created_at" : "2000-01-23T04:56:07.000+00:00",
    "id" : 6
  },
  "updated_at" : "updated_at",
  "project_id" : "project_id",
  "name" : "name",
  "id" : 0
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UDFOperationsApi;

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

public class UDFOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        UDFOperationsApi apiInstance = new UDFOperationsApi();
        String projectId = projectId_example; // String | 
        UdfDto udfDto = ; // UdfDto | 

        try {
            UdfDto result = apiInstance.updateUdfV2(projectId, udfDto);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UDFOperationsApi#updateUdfV2");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String projectId = new String(); // String | 
final UdfDto udfDto = new UdfDto(); // UdfDto | 

try {
    final result = await api_instance.updateUdfV2(projectId, udfDto);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateUdfV2: $e\n');
}

import org.openapitools.client.api.UDFOperationsApi;

public class UDFOperationsApiExample {
    public static void main(String[] args) {
        UDFOperationsApi apiInstance = new UDFOperationsApi();
        String projectId = projectId_example; // String | 
        UdfDto udfDto = ; // UdfDto | 

        try {
            UdfDto result = apiInstance.updateUdfV2(projectId, udfDto);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UDFOperationsApi#updateUdfV2");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
UDFOperationsApi *apiInstance = [[UDFOperationsApi alloc] init];
String *projectId = projectId_example; //  (default to null)
UdfDto *udfDto = ; // 

// Updates a UDF.
[apiInstance updateUdfV2With:projectId
    udfDto:udfDto
              completionHandler: ^(UdfDto output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.UDFOperationsApi()
var projectId = projectId_example; // {String} 
var udfDto = ; // {UdfDto} 

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

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

            // Create an instance of the API class
            var apiInstance = new UDFOperationsApi();
            var projectId = projectId_example;  // String |  (default to null)
            var udfDto = new UdfDto(); // UdfDto | 

            try {
                // Updates a UDF.
                UdfDto result = apiInstance.updateUdfV2(projectId, udfDto);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UDFOperationsApi.updateUdfV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UDFOperationsApi();
$projectId = projectId_example; // String | 
$udfDto = ; // UdfDto | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UDFOperationsApi->new();
my $projectId = projectId_example; # String | 
my $udfDto = WWW::OPenAPIClient::Object::UdfDto->new(); # UdfDto | 

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

# Create an instance of the API class
api_instance = openapi_client.UDFOperationsApi()
projectId = projectId_example # String |  (default to null)
udfDto =  # UdfDto | 

try:
    # Updates a UDF.
    api_response = api_instance.update_udf_v2(projectId, udfDto)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UDFOperationsApi->updateUdfV2: %s\n" % e)
extern crate UDFOperationsApi;

pub fn main() {
    let projectId = projectId_example; // String
    let udfDto = ; // UdfDto

    let mut context = UDFOperationsApi::Context::default();
    let result = client.updateUdfV2(projectId, udfDto, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
projectId*
String
Required
Body parameters
Name Description
udfDto *

Responses


UIJobOperations

executeInSession

Can execute the given SSB job in both session and per_job execution mode. In case of a changed configuration, the job will be updated before execution.


/internal/job/{jobId}/execute

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost/internal/job/{jobId}/execute" \
 -d '{
  "job_config" : "",
  "add_to_history" : true,
  "mv_endpoints" : [ {
    "endpoint" : "endpoint",
    "code" : "code",
    "dynamic_parameters" : [ "dynamic_parameters", "dynamic_parameters" ],
    "description" : "description",
    "bind_values" : [ "bind_values", "bind_values" ],
    "builder_data" : ""
  }, {
    "endpoint" : "endpoint",
    "code" : "code",
    "dynamic_parameters" : [ "dynamic_parameters", "dynamic_parameters" ],
    "description" : "description",
    "bind_values" : [ "bind_values", "bind_values" ],
    "builder_data" : ""
  } ],
  "selection" : false,
  "sql" : "sql"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UIJobOperationsApi;

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

public class UIJobOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        UIJobOperationsApi apiInstance = new UIJobOperationsApi();
        Integer jobId = 56; // Integer | 
        SqlExecuteRequest sqlExecuteRequest = ; // SqlExecuteRequest | 

        try {
            SqlExecuteResponses result = apiInstance.executeInSession(jobId, sqlExecuteRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UIJobOperationsApi#executeInSession");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer jobId = new Integer(); // Integer | 
final SqlExecuteRequest sqlExecuteRequest = new SqlExecuteRequest(); // SqlExecuteRequest | 

try {
    final result = await api_instance.executeInSession(jobId, sqlExecuteRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->executeInSession: $e\n');
}

import org.openapitools.client.api.UIJobOperationsApi;

public class UIJobOperationsApiExample {
    public static void main(String[] args) {
        UIJobOperationsApi apiInstance = new UIJobOperationsApi();
        Integer jobId = 56; // Integer | 
        SqlExecuteRequest sqlExecuteRequest = ; // SqlExecuteRequest | 

        try {
            SqlExecuteResponses result = apiInstance.executeInSession(jobId, sqlExecuteRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UIJobOperationsApi#executeInSession");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
UIJobOperationsApi *apiInstance = [[UIJobOperationsApi alloc] init];
Integer *jobId = 56; //  (default to null)
SqlExecuteRequest *sqlExecuteRequest = ; //  (optional)

// Can execute the given SSB job in both session and per_job execution mode. In case of a changed configuration, the job will be updated before execution.
[apiInstance executeInSessionWith:jobId
    sqlExecuteRequest:sqlExecuteRequest
              completionHandler: ^(SqlExecuteResponses output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.UIJobOperationsApi()
var jobId = 56; // {Integer} 
var opts = {
  'sqlExecuteRequest':  // {SqlExecuteRequest} 
};

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

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

            // Create an instance of the API class
            var apiInstance = new UIJobOperationsApi();
            var jobId = 56;  // Integer |  (default to null)
            var sqlExecuteRequest = new SqlExecuteRequest(); // SqlExecuteRequest |  (optional) 

            try {
                // Can execute the given SSB job in both session and per_job execution mode. In case of a changed configuration, the job will be updated before execution.
                SqlExecuteResponses result = apiInstance.executeInSession(jobId, sqlExecuteRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UIJobOperationsApi.executeInSession: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UIJobOperationsApi();
$jobId = 56; // Integer | 
$sqlExecuteRequest = ; // SqlExecuteRequest | 

try {
    $result = $api_instance->executeInSession($jobId, $sqlExecuteRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UIJobOperationsApi->executeInSession: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UIJobOperationsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UIJobOperationsApi->new();
my $jobId = 56; # Integer | 
my $sqlExecuteRequest = WWW::OPenAPIClient::Object::SqlExecuteRequest->new(); # SqlExecuteRequest | 

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

# Create an instance of the API class
api_instance = openapi_client.UIJobOperationsApi()
jobId = 56 # Integer |  (default to null)
sqlExecuteRequest =  # SqlExecuteRequest |  (optional)

try:
    # Can execute the given SSB job in both session and per_job execution mode. In case of a changed configuration, the job will be updated before execution.
    api_response = api_instance.execute_in_session(jobId, sqlExecuteRequest=sqlExecuteRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UIJobOperationsApi->executeInSession: %s\n" % e)
extern crate UIJobOperationsApi;

pub fn main() {
    let jobId = 56; // Integer
    let sqlExecuteRequest = ; // SqlExecuteRequest

    let mut context = UIJobOperationsApi::Context::default();
    let result = client.executeInSession(jobId, sqlExecuteRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
jobId*
Integer (int32)
Required
Body parameters
Name Description
sqlExecuteRequest

Responses


executeSqlInSession

Can execute the given SQL query in both session and per_job execution mode.


/internal/job/execute

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost/internal/job/execute" \
 -d '{
  "job_config" : "",
  "add_to_history" : true,
  "mv_endpoints" : [ {
    "endpoint" : "endpoint",
    "code" : "code",
    "dynamic_parameters" : [ "dynamic_parameters", "dynamic_parameters" ],
    "description" : "description",
    "bind_values" : [ "bind_values", "bind_values" ],
    "builder_data" : ""
  }, {
    "endpoint" : "endpoint",
    "code" : "code",
    "dynamic_parameters" : [ "dynamic_parameters", "dynamic_parameters" ],
    "description" : "description",
    "bind_values" : [ "bind_values", "bind_values" ],
    "builder_data" : ""
  } ],
  "selection" : false,
  "sql" : "sql"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UIJobOperationsApi;

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

public class UIJobOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        UIJobOperationsApi apiInstance = new UIJobOperationsApi();
        SqlExecuteRequest sqlExecuteRequest = ; // SqlExecuteRequest | 

        try {
            SqlExecuteResponse result = apiInstance.executeSqlInSession(sqlExecuteRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UIJobOperationsApi#executeSqlInSession");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final SqlExecuteRequest sqlExecuteRequest = new SqlExecuteRequest(); // SqlExecuteRequest | 

try {
    final result = await api_instance.executeSqlInSession(sqlExecuteRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->executeSqlInSession: $e\n');
}

import org.openapitools.client.api.UIJobOperationsApi;

public class UIJobOperationsApiExample {
    public static void main(String[] args) {
        UIJobOperationsApi apiInstance = new UIJobOperationsApi();
        SqlExecuteRequest sqlExecuteRequest = ; // SqlExecuteRequest | 

        try {
            SqlExecuteResponse result = apiInstance.executeSqlInSession(sqlExecuteRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UIJobOperationsApi#executeSqlInSession");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
UIJobOperationsApi *apiInstance = [[UIJobOperationsApi alloc] init];
SqlExecuteRequest *sqlExecuteRequest = ; // 

// Can execute the given SQL query in both session and per_job execution mode.
[apiInstance executeSqlInSessionWith:sqlExecuteRequest
              completionHandler: ^(SqlExecuteResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.UIJobOperationsApi()
var sqlExecuteRequest = ; // {SqlExecuteRequest} 

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

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

            // Create an instance of the API class
            var apiInstance = new UIJobOperationsApi();
            var sqlExecuteRequest = new SqlExecuteRequest(); // SqlExecuteRequest | 

            try {
                // Can execute the given SQL query in both session and per_job execution mode.
                SqlExecuteResponse result = apiInstance.executeSqlInSession(sqlExecuteRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UIJobOperationsApi.executeSqlInSession: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UIJobOperationsApi();
$sqlExecuteRequest = ; // SqlExecuteRequest | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UIJobOperationsApi->new();
my $sqlExecuteRequest = WWW::OPenAPIClient::Object::SqlExecuteRequest->new(); # SqlExecuteRequest | 

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

# Create an instance of the API class
api_instance = openapi_client.UIJobOperationsApi()
sqlExecuteRequest =  # SqlExecuteRequest | 

try:
    # Can execute the given SQL query in both session and per_job execution mode.
    api_response = api_instance.execute_sql_in_session(sqlExecuteRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UIJobOperationsApi->executeSqlInSession: %s\n" % e)
extern crate UIJobOperationsApi;

pub fn main() {
    let sqlExecuteRequest = ; // SqlExecuteRequest

    let mut context = UIJobOperationsApi::Context::default();
    let result = client.executeSqlInSession(sqlExecuteRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
sqlExecuteRequest *

Responses


UiConfigController

getConfig1


/internal/ui-config

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/internal/ui-config"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UiConfigControllerApi;

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

public class UiConfigControllerApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        UiConfigControllerApi apiInstance = new UiConfigControllerApi();

        try {
            UiConfigDto result = apiInstance.getConfig1();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UiConfigControllerApi#getConfig1");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();


try {
    final result = await api_instance.getConfig1();
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getConfig1: $e\n');
}

import org.openapitools.client.api.UiConfigControllerApi;

public class UiConfigControllerApiExample {
    public static void main(String[] args) {
        UiConfigControllerApi apiInstance = new UiConfigControllerApi();

        try {
            UiConfigDto result = apiInstance.getConfig1();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UiConfigControllerApi#getConfig1");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
UiConfigControllerApi *apiInstance = [[UiConfigControllerApi alloc] init];

[apiInstance getConfig1WithCompletionHandler: 
              ^(UiConfigDto output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.UiConfigControllerApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getConfig1(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new UiConfigControllerApi();

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UiConfigControllerApi();

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UiConfigControllerApi->new();

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

# Create an instance of the API class
api_instance = openapi_client.UiConfigControllerApi()

try:
    api_response = api_instance.get_config1()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UiConfigControllerApi->getConfig1: %s\n" % e)
extern crate UiConfigControllerApi;

pub fn main() {

    let mut context = UiConfigControllerApi::Context::default();
    let result = client.getConfig1(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


UserKeytabOperations

generateKeytab

Generates a keytab for the authenticated user with the given credentials.


/api/v2/user/keytab/generate

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost/api/v2/user/keytab/generate" \
 -d '{
  "principal" : "principal",
  "password" : "password"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserKeytabOperationsApi;

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

public class UserKeytabOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        UserKeytabOperationsApi apiInstance = new UserKeytabOperationsApi();
        GenerateKeytabRequest generateKeytabRequest = ; // GenerateKeytabRequest | 

        try {
            apiInstance.generateKeytab(generateKeytabRequest);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserKeytabOperationsApi#generateKeytab");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final GenerateKeytabRequest generateKeytabRequest = new GenerateKeytabRequest(); // GenerateKeytabRequest | 

try {
    final result = await api_instance.generateKeytab(generateKeytabRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->generateKeytab: $e\n');
}

import org.openapitools.client.api.UserKeytabOperationsApi;

public class UserKeytabOperationsApiExample {
    public static void main(String[] args) {
        UserKeytabOperationsApi apiInstance = new UserKeytabOperationsApi();
        GenerateKeytabRequest generateKeytabRequest = ; // GenerateKeytabRequest | 

        try {
            apiInstance.generateKeytab(generateKeytabRequest);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserKeytabOperationsApi#generateKeytab");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
UserKeytabOperationsApi *apiInstance = [[UserKeytabOperationsApi alloc] init];
GenerateKeytabRequest *generateKeytabRequest = ; // 

// Generates a keytab for the authenticated user with the given credentials.
[apiInstance generateKeytabWith:generateKeytabRequest
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.UserKeytabOperationsApi()
var generateKeytabRequest = ; // {GenerateKeytabRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.generateKeytab(generateKeytabRequest, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new UserKeytabOperationsApi();
            var generateKeytabRequest = new GenerateKeytabRequest(); // GenerateKeytabRequest | 

            try {
                // Generates a keytab for the authenticated user with the given credentials.
                apiInstance.generateKeytab(generateKeytabRequest);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserKeytabOperationsApi.generateKeytab: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserKeytabOperationsApi();
$generateKeytabRequest = ; // GenerateKeytabRequest | 

try {
    $api_instance->generateKeytab($generateKeytabRequest);
} catch (Exception $e) {
    echo 'Exception when calling UserKeytabOperationsApi->generateKeytab: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserKeytabOperationsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserKeytabOperationsApi->new();
my $generateKeytabRequest = WWW::OPenAPIClient::Object::GenerateKeytabRequest->new(); # GenerateKeytabRequest | 

eval {
    $api_instance->generateKeytab(generateKeytabRequest => $generateKeytabRequest);
};
if ($@) {
    warn "Exception when calling UserKeytabOperationsApi->generateKeytab: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.UserKeytabOperationsApi()
generateKeytabRequest =  # GenerateKeytabRequest | 

try:
    # Generates a keytab for the authenticated user with the given credentials.
    api_instance.generate_keytab(generateKeytabRequest)
except ApiException as e:
    print("Exception when calling UserKeytabOperationsApi->generateKeytab: %s\n" % e)
extern crate UserKeytabOperationsApi;

pub fn main() {
    let generateKeytabRequest = ; // GenerateKeytabRequest

    let mut context = UserKeytabOperationsApi::Context::default();
    let result = client.generateKeytab(generateKeytabRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
generateKeytabRequest *

Responses


removeKeytab

Removes the keytab file for the authenticated user.


/api/v2/user/keytab

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: application/json" \
 "http://localhost/api/v2/user/keytab"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserKeytabOperationsApi;

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

public class UserKeytabOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        UserKeytabOperationsApi apiInstance = new UserKeytabOperationsApi();

        try {
            apiInstance.removeKeytab();
        } catch (ApiException e) {
            System.err.println("Exception when calling UserKeytabOperationsApi#removeKeytab");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();


try {
    final result = await api_instance.removeKeytab();
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->removeKeytab: $e\n');
}

import org.openapitools.client.api.UserKeytabOperationsApi;

public class UserKeytabOperationsApiExample {
    public static void main(String[] args) {
        UserKeytabOperationsApi apiInstance = new UserKeytabOperationsApi();

        try {
            apiInstance.removeKeytab();
        } catch (ApiException e) {
            System.err.println("Exception when calling UserKeytabOperationsApi#removeKeytab");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
UserKeytabOperationsApi *apiInstance = [[UserKeytabOperationsApi alloc] init];

// Removes the keytab file for the authenticated user.
[apiInstance removeKeytabWithCompletionHandler: 
              ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.UserKeytabOperationsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.removeKeytab(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new UserKeytabOperationsApi();

            try {
                // Removes the keytab file for the authenticated user.
                apiInstance.removeKeytab();
            } catch (Exception e) {
                Debug.Print("Exception when calling UserKeytabOperationsApi.removeKeytab: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserKeytabOperationsApi();

try {
    $api_instance->removeKeytab();
} catch (Exception $e) {
    echo 'Exception when calling UserKeytabOperationsApi->removeKeytab: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserKeytabOperationsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserKeytabOperationsApi->new();

eval {
    $api_instance->removeKeytab();
};
if ($@) {
    warn "Exception when calling UserKeytabOperationsApi->removeKeytab: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.UserKeytabOperationsApi()

try:
    # Removes the keytab file for the authenticated user.
    api_instance.remove_keytab()
except ApiException as e:
    print("Exception when calling UserKeytabOperationsApi->removeKeytab: %s\n" % e)
extern crate UserKeytabOperationsApi;

pub fn main() {

    let mut context = UserKeytabOperationsApi::Context::default();
    let result = client.removeKeytab(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


uploadKeytab

Uploads a keytab file for the authenticated user with the given credentials.


/api/v2/user/keytab/upload

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: multipart/form-data" \
 "http://localhost/api/v2/user/keytab/upload"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserKeytabOperationsApi;

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

public class UserKeytabOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        UserKeytabOperationsApi apiInstance = new UserKeytabOperationsApi();
        String principal = principal_example; // String | 
        File file = BINARY_DATA_HERE; // File | 

        try {
            apiInstance.uploadKeytab(principal, file);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserKeytabOperationsApi#uploadKeytab");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String principal = new String(); // String | 
final File file = new File(); // File | 

try {
    final result = await api_instance.uploadKeytab(principal, file);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->uploadKeytab: $e\n');
}

import org.openapitools.client.api.UserKeytabOperationsApi;

public class UserKeytabOperationsApiExample {
    public static void main(String[] args) {
        UserKeytabOperationsApi apiInstance = new UserKeytabOperationsApi();
        String principal = principal_example; // String | 
        File file = BINARY_DATA_HERE; // File | 

        try {
            apiInstance.uploadKeytab(principal, file);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserKeytabOperationsApi#uploadKeytab");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
UserKeytabOperationsApi *apiInstance = [[UserKeytabOperationsApi alloc] init];
String *principal = principal_example; //  (default to null)
File *file = BINARY_DATA_HERE; //  (default to null)

// Uploads a keytab file for the authenticated user with the given credentials.
[apiInstance uploadKeytabWith:principal
    file:file
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.UserKeytabOperationsApi()
var principal = principal_example; // {String} 
var file = BINARY_DATA_HERE; // {File} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.uploadKeytab(principal, file, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new UserKeytabOperationsApi();
            var principal = principal_example;  // String |  (default to null)
            var file = BINARY_DATA_HERE;  // File |  (default to null)

            try {
                // Uploads a keytab file for the authenticated user with the given credentials.
                apiInstance.uploadKeytab(principal, file);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserKeytabOperationsApi.uploadKeytab: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserKeytabOperationsApi();
$principal = principal_example; // String | 
$file = BINARY_DATA_HERE; // File | 

try {
    $api_instance->uploadKeytab($principal, $file);
} catch (Exception $e) {
    echo 'Exception when calling UserKeytabOperationsApi->uploadKeytab: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserKeytabOperationsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserKeytabOperationsApi->new();
my $principal = principal_example; # String | 
my $file = BINARY_DATA_HERE; # File | 

eval {
    $api_instance->uploadKeytab(principal => $principal, file => $file);
};
if ($@) {
    warn "Exception when calling UserKeytabOperationsApi->uploadKeytab: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.UserKeytabOperationsApi()
principal = principal_example # String |  (default to null)
file = BINARY_DATA_HERE # File |  (default to null)

try:
    # Uploads a keytab file for the authenticated user with the given credentials.
    api_instance.upload_keytab(principal, file)
except ApiException as e:
    print("Exception when calling UserKeytabOperationsApi->uploadKeytab: %s\n" % e)
extern crate UserKeytabOperationsApi;

pub fn main() {
    let principal = principal_example; // String
    let file = BINARY_DATA_HERE; // File

    let mut context = UserKeytabOperationsApi::Context::default();
    let result = client.uploadKeytab(principal, file, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Form parameters
Name Description
principal*
String
Required
file*
File (binary)
Required

Responses


UserOperations

getCurrentUser

Retrieves the currently authenticated user.


/api/v2/user

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/api/v2/user"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserOperationsApi;

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

public class UserOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        UserOperationsApi apiInstance = new UserOperationsApi();
        String authorization = authorization_example; // String | Basic authentication header

        try {
            UserDto result = apiInstance.getCurrentUser(authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserOperationsApi#getCurrentUser");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String authorization = new String(); // String | Basic authentication header

try {
    final result = await api_instance.getCurrentUser(authorization);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getCurrentUser: $e\n');
}

import org.openapitools.client.api.UserOperationsApi;

public class UserOperationsApiExample {
    public static void main(String[] args) {
        UserOperationsApi apiInstance = new UserOperationsApi();
        String authorization = authorization_example; // String | Basic authentication header

        try {
            UserDto result = apiInstance.getCurrentUser(authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserOperationsApi#getCurrentUser");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
UserOperationsApi *apiInstance = [[UserOperationsApi alloc] init];
String *authorization = authorization_example; // Basic authentication header (optional) (default to null)

// Retrieves the currently authenticated user.
[apiInstance getCurrentUserWith:authorization
              completionHandler: ^(UserDto output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.UserOperationsApi()
var opts = {
  'authorization': authorization_example // {String} Basic authentication header
};

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

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

            // Create an instance of the API class
            var apiInstance = new UserOperationsApi();
            var authorization = authorization_example;  // String | Basic authentication header (optional)  (default to null)

            try {
                // Retrieves the currently authenticated user.
                UserDto result = apiInstance.getCurrentUser(authorization);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserOperationsApi.getCurrentUser: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserOperationsApi();
$authorization = authorization_example; // String | Basic authentication header

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserOperationsApi->new();
my $authorization = authorization_example; # String | Basic authentication header

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

# Create an instance of the API class
api_instance = openapi_client.UserOperationsApi()
authorization = authorization_example # String | Basic authentication header (optional) (default to null)

try:
    # Retrieves the currently authenticated user.
    api_response = api_instance.get_current_user(authorization=authorization)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserOperationsApi->getCurrentUser: %s\n" % e)
extern crate UserOperationsApi;

pub fn main() {
    let authorization = authorization_example; // String

    let mut context = UserOperationsApi::Context::default();
    let result = client.getCurrentUser(authorization, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Header parameters
Name Description
Authorization
String
Basic authentication header

Responses


getUserSettings

Returns the frontend settings of the currently authenticated user.


/api/v2/user/settings

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/api/v2/user/settings"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserOperationsApi;

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

public class UserOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        UserOperationsApi apiInstance = new UserOperationsApi();

        try {
            UserSettingsDto result = apiInstance.getUserSettings();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserOperationsApi#getUserSettings");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();


try {
    final result = await api_instance.getUserSettings();
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getUserSettings: $e\n');
}

import org.openapitools.client.api.UserOperationsApi;

public class UserOperationsApiExample {
    public static void main(String[] args) {
        UserOperationsApi apiInstance = new UserOperationsApi();

        try {
            UserSettingsDto result = apiInstance.getUserSettings();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserOperationsApi#getUserSettings");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
UserOperationsApi *apiInstance = [[UserOperationsApi alloc] init];

// Returns the frontend settings of the currently authenticated user.
[apiInstance getUserSettingsWithCompletionHandler: 
              ^(UserSettingsDto output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.UserOperationsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getUserSettings(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new UserOperationsApi();

            try {
                // Returns the frontend settings of the currently authenticated user.
                UserSettingsDto result = apiInstance.getUserSettings();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserOperationsApi.getUserSettings: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserOperationsApi();

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserOperationsApi->new();

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

# Create an instance of the API class
api_instance = openapi_client.UserOperationsApi()

try:
    # Returns the frontend settings of the currently authenticated user.
    api_response = api_instance.get_user_settings()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserOperationsApi->getUserSettings: %s\n" % e)
extern crate UserOperationsApi;

pub fn main() {

    let mut context = UserOperationsApi::Context::default();
    let result = client.getUserSettings(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


updateActiveProject

Updates the active project for the currently authenticated user.


/api/v2/user/project

Usage and SDK Samples

curl -X PATCH \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost/api/v2/user/project" \
 -d '{
  "project_id" : "project_id"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserOperationsApi;

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

public class UserOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        UserOperationsApi apiInstance = new UserOperationsApi();
        UpdateProjectRequest updateProjectRequest = ; // UpdateProjectRequest | 

        try {
            UserDto result = apiInstance.updateActiveProject(updateProjectRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserOperationsApi#updateActiveProject");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final UpdateProjectRequest updateProjectRequest = new UpdateProjectRequest(); // UpdateProjectRequest | 

try {
    final result = await api_instance.updateActiveProject(updateProjectRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateActiveProject: $e\n');
}

import org.openapitools.client.api.UserOperationsApi;

public class UserOperationsApiExample {
    public static void main(String[] args) {
        UserOperationsApi apiInstance = new UserOperationsApi();
        UpdateProjectRequest updateProjectRequest = ; // UpdateProjectRequest | 

        try {
            UserDto result = apiInstance.updateActiveProject(updateProjectRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserOperationsApi#updateActiveProject");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
UserOperationsApi *apiInstance = [[UserOperationsApi alloc] init];
UpdateProjectRequest *updateProjectRequest = ; // 

// Updates the active project for the currently authenticated user.
[apiInstance updateActiveProjectWith:updateProjectRequest
              completionHandler: ^(UserDto output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.UserOperationsApi()
var updateProjectRequest = ; // {UpdateProjectRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateActiveProject(updateProjectRequest, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class updateActiveProjectExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new UserOperationsApi();
            var updateProjectRequest = new UpdateProjectRequest(); // UpdateProjectRequest | 

            try {
                // Updates the active project for the currently authenticated user.
                UserDto result = apiInstance.updateActiveProject(updateProjectRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserOperationsApi.updateActiveProject: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserOperationsApi();
$updateProjectRequest = ; // UpdateProjectRequest | 

try {
    $result = $api_instance->updateActiveProject($updateProjectRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserOperationsApi->updateActiveProject: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserOperationsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserOperationsApi->new();
my $updateProjectRequest = WWW::OPenAPIClient::Object::UpdateProjectRequest->new(); # UpdateProjectRequest | 

eval {
    my $result = $api_instance->updateActiveProject(updateProjectRequest => $updateProjectRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserOperationsApi->updateActiveProject: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.UserOperationsApi()
updateProjectRequest =  # UpdateProjectRequest | 

try:
    # Updates the active project for the currently authenticated user.
    api_response = api_instance.update_active_project(updateProjectRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserOperationsApi->updateActiveProject: %s\n" % e)
extern crate UserOperationsApi;

pub fn main() {
    let updateProjectRequest = ; // UpdateProjectRequest

    let mut context = UserOperationsApi::Context::default();
    let result = client.updateActiveProject(updateProjectRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
updateProjectRequest *

Responses


updateUserPassword

Updates the password for the currently authenticated user.


/api/v2/user/password

Usage and SDK Samples

curl -X PATCH \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost/api/v2/user/password" \
 -d '{
  "new_password" : "new_password",
  "current_password" : "current_password"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserOperationsApi;

import java.io.File;
import java.util.*;

public class UserOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        UserOperationsApi apiInstance = new UserOperationsApi();
        UpdatePasswordRequest updatePasswordRequest = ; // UpdatePasswordRequest | 

        try {
            apiInstance.updateUserPassword(updatePasswordRequest);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserOperationsApi#updateUserPassword");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final UpdatePasswordRequest updatePasswordRequest = new UpdatePasswordRequest(); // UpdatePasswordRequest | 

try {
    final result = await api_instance.updateUserPassword(updatePasswordRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateUserPassword: $e\n');
}

import org.openapitools.client.api.UserOperationsApi;

public class UserOperationsApiExample {
    public static void main(String[] args) {
        UserOperationsApi apiInstance = new UserOperationsApi();
        UpdatePasswordRequest updatePasswordRequest = ; // UpdatePasswordRequest | 

        try {
            apiInstance.updateUserPassword(updatePasswordRequest);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserOperationsApi#updateUserPassword");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
UserOperationsApi *apiInstance = [[UserOperationsApi alloc] init];
UpdatePasswordRequest *updatePasswordRequest = ; // 

// Updates the password for the currently authenticated user.
[apiInstance updateUserPasswordWith:updatePasswordRequest
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.UserOperationsApi()
var updatePasswordRequest = ; // {UpdatePasswordRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.updateUserPassword(updatePasswordRequest, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class updateUserPasswordExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new UserOperationsApi();
            var updatePasswordRequest = new UpdatePasswordRequest(); // UpdatePasswordRequest | 

            try {
                // Updates the password for the currently authenticated user.
                apiInstance.updateUserPassword(updatePasswordRequest);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserOperationsApi.updateUserPassword: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserOperationsApi();
$updatePasswordRequest = ; // UpdatePasswordRequest | 

try {
    $api_instance->updateUserPassword($updatePasswordRequest);
} catch (Exception $e) {
    echo 'Exception when calling UserOperationsApi->updateUserPassword: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserOperationsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserOperationsApi->new();
my $updatePasswordRequest = WWW::OPenAPIClient::Object::UpdatePasswordRequest->new(); # UpdatePasswordRequest | 

eval {
    $api_instance->updateUserPassword(updatePasswordRequest => $updatePasswordRequest);
};
if ($@) {
    warn "Exception when calling UserOperationsApi->updateUserPassword: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.UserOperationsApi()
updatePasswordRequest =  # UpdatePasswordRequest | 

try:
    # Updates the password for the currently authenticated user.
    api_instance.update_user_password(updatePasswordRequest)
except ApiException as e:
    print("Exception when calling UserOperationsApi->updateUserPassword: %s\n" % e)
extern crate UserOperationsApi;

pub fn main() {
    let updatePasswordRequest = ; // UpdatePasswordRequest

    let mut context = UserOperationsApi::Context::default();
    let result = client.updateUserPassword(updatePasswordRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
updatePasswordRequest *

Responses


updateUserSettings

Updates the frontend settings of the authenticated user.


/api/v2/user/settings

Usage and SDK Samples

curl -X PUT \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost/api/v2/user/settings" \
 -d '{
  "editor_theme" : "editor_theme",
  "console_view_layout" : "VERTICAL",
  "sidebar_collapsed" : true,
  "vim_mode_enabled" : true
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserOperationsApi;

import java.io.File;
import java.util.*;

public class UserOperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        UserOperationsApi apiInstance = new UserOperationsApi();
        UserSettingsDto userSettingsDto = ; // UserSettingsDto | 

        try {
            UserSettingsDto result = apiInstance.updateUserSettings(userSettingsDto);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserOperationsApi#updateUserSettings");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final UserSettingsDto userSettingsDto = new UserSettingsDto(); // UserSettingsDto | 

try {
    final result = await api_instance.updateUserSettings(userSettingsDto);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateUserSettings: $e\n');
}

import org.openapitools.client.api.UserOperationsApi;

public class UserOperationsApiExample {
    public static void main(String[] args) {
        UserOperationsApi apiInstance = new UserOperationsApi();
        UserSettingsDto userSettingsDto = ; // UserSettingsDto | 

        try {
            UserSettingsDto result = apiInstance.updateUserSettings(userSettingsDto);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserOperationsApi#updateUserSettings");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
UserOperationsApi *apiInstance = [[UserOperationsApi alloc] init];
UserSettingsDto *userSettingsDto = ; // 

// Updates the frontend settings of the authenticated user.
[apiInstance updateUserSettingsWith:userSettingsDto
              completionHandler: ^(UserSettingsDto output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.UserOperationsApi()
var userSettingsDto = ; // {UserSettingsDto} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateUserSettings(userSettingsDto, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class updateUserSettingsExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new UserOperationsApi();
            var userSettingsDto = new UserSettingsDto(); // UserSettingsDto | 

            try {
                // Updates the frontend settings of the authenticated user.
                UserSettingsDto result = apiInstance.updateUserSettings(userSettingsDto);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserOperationsApi.updateUserSettings: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserOperationsApi();
$userSettingsDto = ; // UserSettingsDto | 

try {
    $result = $api_instance->updateUserSettings($userSettingsDto);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserOperationsApi->updateUserSettings: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserOperationsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserOperationsApi->new();
my $userSettingsDto = WWW::OPenAPIClient::Object::UserSettingsDto->new(); # UserSettingsDto | 

eval {
    my $result = $api_instance->updateUserSettings(userSettingsDto => $userSettingsDto);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserOperationsApi->updateUserSettings: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.UserOperationsApi()
userSettingsDto =  # UserSettingsDto | 

try:
    # Updates the frontend settings of the authenticated user.
    api_response = api_instance.update_user_settings(userSettingsDto)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserOperationsApi->updateUserSettings: %s\n" % e)
extern crate UserOperationsApi;

pub fn main() {
    let userSettingsDto = ; // UserSettingsDto

    let mut context = UserOperationsApi::Context::default();
    let result = client.updateUserSettings(userSettingsDto, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
userSettingsDto *

Responses